Create cluster policy configuration. This policy is used for task prioritization and + * fair-share allocation of idle compute. This helps prioritize critical workloads and distributes + * idle compute across entities.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, CreateClusterSchedulerConfigCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, CreateClusterSchedulerConfigCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const input = { // CreateClusterSchedulerConfigRequest + * Name: "STRING_VALUE", // required + * ClusterArn: "STRING_VALUE", // required + * SchedulerConfig: { // SchedulerConfig + * PriorityClasses: [ // PriorityClassList + * { // PriorityClass + * Name: "STRING_VALUE", // required + * Weight: Number("int"), // required + * }, + * ], + * FairShare: "Enabled" || "Disabled", + * }, + * Description: "STRING_VALUE", + * Tags: [ // TagList + * { // Tag + * Key: "STRING_VALUE", // required + * Value: "STRING_VALUE", // required + * }, + * ], + * }; + * const command = new CreateClusterSchedulerConfigCommand(input); + * const response = await client.send(command); + * // { // CreateClusterSchedulerConfigResponse + * // ClusterSchedulerConfigArn: "STRING_VALUE", // required + * // ClusterSchedulerConfigId: "STRING_VALUE", // required + * // }; + * + * ``` + * + * @param CreateClusterSchedulerConfigCommandInput - {@link CreateClusterSchedulerConfigCommandInput} + * @returns {@link CreateClusterSchedulerConfigCommandOutput} + * @see {@link CreateClusterSchedulerConfigCommandInput} for command's `input` shape. + * @see {@link CreateClusterSchedulerConfigCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for SageMakerClient's `config` shape. + * + * @throws {@link ConflictException} (client fault) + *There was a conflict when you attempted to modify a SageMaker entity such as an
+ * Experiment or Artifact.
You have exceeded an SageMaker resource limit. For example, you might have too many + * training jobs created.
+ * + * @throws {@link SageMakerServiceException} + *Base exception class for all service exceptions from SageMaker service.
+ * + * @public + */ +export class CreateClusterSchedulerConfigCommand extends $Command + .classBuilder< + CreateClusterSchedulerConfigCommandInput, + CreateClusterSchedulerConfigCommandOutput, + SageMakerClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: SageMakerClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("SageMaker", "CreateClusterSchedulerConfig", {}) + .n("SageMakerClient", "CreateClusterSchedulerConfigCommand") + .f(void 0, void 0) + .ser(se_CreateClusterSchedulerConfigCommand) + .de(de_CreateClusterSchedulerConfigCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: CreateClusterSchedulerConfigRequest; + output: CreateClusterSchedulerConfigResponse; + }; + sdk: { + input: CreateClusterSchedulerConfigCommandInput; + output: CreateClusterSchedulerConfigCommandOutput; + }; + }; +} diff --git a/clients/client-sagemaker/src/commands/CreateComputeQuotaCommand.ts b/clients/client-sagemaker/src/commands/CreateComputeQuotaCommand.ts new file mode 100644 index 000000000000..e99579cb5adc --- /dev/null +++ b/clients/client-sagemaker/src/commands/CreateComputeQuotaCommand.ts @@ -0,0 +1,129 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { commonParams } from "../endpoint/EndpointParameters"; +import { CreateComputeQuotaRequest, CreateComputeQuotaResponse } from "../models/models_1"; +import { de_CreateComputeQuotaCommand, se_CreateComputeQuotaCommand } from "../protocols/Aws_json1_1"; +import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link CreateComputeQuotaCommand}. + */ +export interface CreateComputeQuotaCommandInput extends CreateComputeQuotaRequest {} +/** + * @public + * + * The output of {@link CreateComputeQuotaCommand}. + */ +export interface CreateComputeQuotaCommandOutput extends CreateComputeQuotaResponse, __MetadataBearer {} + +/** + *Create compute allocation definition. This defines how compute is allocated, shared, and + * borrowed for specified entities. Specifically, how to lend and borrow idle compute and + * assign a fair-share weight to the specified entities.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, CreateComputeQuotaCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, CreateComputeQuotaCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const input = { // CreateComputeQuotaRequest + * Name: "STRING_VALUE", // required + * Description: "STRING_VALUE", + * ClusterArn: "STRING_VALUE", // required + * ComputeQuotaConfig: { // ComputeQuotaConfig + * ComputeQuotaResources: [ // ComputeQuotaResourceConfigList + * { // ComputeQuotaResourceConfig + * InstanceType: "ml.p4d.24xlarge" || "ml.p4de.24xlarge" || "ml.p5.48xlarge" || "ml.trn1.32xlarge" || "ml.trn1n.32xlarge" || "ml.g5.xlarge" || "ml.g5.2xlarge" || "ml.g5.4xlarge" || "ml.g5.8xlarge" || "ml.g5.12xlarge" || "ml.g5.16xlarge" || "ml.g5.24xlarge" || "ml.g5.48xlarge" || "ml.c5.large" || "ml.c5.xlarge" || "ml.c5.2xlarge" || "ml.c5.4xlarge" || "ml.c5.9xlarge" || "ml.c5.12xlarge" || "ml.c5.18xlarge" || "ml.c5.24xlarge" || "ml.c5n.large" || "ml.c5n.2xlarge" || "ml.c5n.4xlarge" || "ml.c5n.9xlarge" || "ml.c5n.18xlarge" || "ml.m5.large" || "ml.m5.xlarge" || "ml.m5.2xlarge" || "ml.m5.4xlarge" || "ml.m5.8xlarge" || "ml.m5.12xlarge" || "ml.m5.16xlarge" || "ml.m5.24xlarge" || "ml.t3.medium" || "ml.t3.large" || "ml.t3.xlarge" || "ml.t3.2xlarge" || "ml.g6.xlarge" || "ml.g6.2xlarge" || "ml.g6.4xlarge" || "ml.g6.8xlarge" || "ml.g6.16xlarge" || "ml.g6.12xlarge" || "ml.g6.24xlarge" || "ml.g6.48xlarge" || "ml.gr6.4xlarge" || "ml.gr6.8xlarge" || "ml.g6e.xlarge" || "ml.g6e.2xlarge" || "ml.g6e.4xlarge" || "ml.g6e.8xlarge" || "ml.g6e.16xlarge" || "ml.g6e.12xlarge" || "ml.g6e.24xlarge" || "ml.g6e.48xlarge" || "ml.p5e.48xlarge" || "ml.p5en.48xlarge" || "ml.trn2.48xlarge", // required + * Count: Number("int"), // required + * }, + * ], + * ResourceSharingConfig: { // ResourceSharingConfig + * Strategy: "Lend" || "DontLend" || "LendAndBorrow", // required + * BorrowLimit: Number("int"), + * }, + * PreemptTeamTasks: "Never" || "LowerPriority", + * }, + * ComputeQuotaTarget: { // ComputeQuotaTarget + * TeamName: "STRING_VALUE", // required + * FairShareWeight: Number("int"), + * }, + * ActivationState: "Enabled" || "Disabled", + * Tags: [ // TagList + * { // Tag + * Key: "STRING_VALUE", // required + * Value: "STRING_VALUE", // required + * }, + * ], + * }; + * const command = new CreateComputeQuotaCommand(input); + * const response = await client.send(command); + * // { // CreateComputeQuotaResponse + * // ComputeQuotaArn: "STRING_VALUE", // required + * // ComputeQuotaId: "STRING_VALUE", // required + * // }; + * + * ``` + * + * @param CreateComputeQuotaCommandInput - {@link CreateComputeQuotaCommandInput} + * @returns {@link CreateComputeQuotaCommandOutput} + * @see {@link CreateComputeQuotaCommandInput} for command's `input` shape. + * @see {@link CreateComputeQuotaCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for SageMakerClient's `config` shape. + * + * @throws {@link ConflictException} (client fault) + *There was a conflict when you attempted to modify a SageMaker entity such as an
+ * Experiment or Artifact.
You have exceeded an SageMaker resource limit. For example, you might have too many + * training jobs created.
+ * + * @throws {@link SageMakerServiceException} + *Base exception class for all service exceptions from SageMaker service.
+ * + * @public + */ +export class CreateComputeQuotaCommand extends $Command + .classBuilder< + CreateComputeQuotaCommandInput, + CreateComputeQuotaCommandOutput, + SageMakerClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: SageMakerClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("SageMaker", "CreateComputeQuota", {}) + .n("SageMakerClient", "CreateComputeQuotaCommand") + .f(void 0, void 0) + .ser(se_CreateComputeQuotaCommand) + .de(de_CreateComputeQuotaCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: CreateComputeQuotaRequest; + output: CreateComputeQuotaResponse; + }; + sdk: { + input: CreateComputeQuotaCommandInput; + output: CreateComputeQuotaCommandOutput; + }; + }; +} diff --git a/clients/client-sagemaker/src/commands/CreateDomainCommand.ts b/clients/client-sagemaker/src/commands/CreateDomainCommand.ts index b2847ee7248d..476961ffab3e 100644 --- a/clients/client-sagemaker/src/commands/CreateDomainCommand.ts +++ b/clients/client-sagemaker/src/commands/CreateDomainCommand.ts @@ -271,11 +271,15 @@ export interface CreateDomainCommandOutput extends CreateDomainResponse, __Metad * FileSystemId: "STRING_VALUE", // required * FileSystemPath: "STRING_VALUE", * }, + * FSxLustreFileSystemConfig: { // FSxLustreFileSystemConfig + * FileSystemId: "STRING_VALUE", // required + * FileSystemPath: "STRING_VALUE", + * }, * }, * ], * StudioWebPortalSettings: { // StudioWebPortalSettings * HiddenMlTools: [ // HiddenMlToolsList - * "DataWrangler" || "FeatureStore" || "EmrClusters" || "AutoMl" || "Experiments" || "Training" || "ModelEvaluation" || "Pipelines" || "Models" || "JumpStart" || "InferenceRecommender" || "Endpoints" || "Projects" || "InferenceOptimization" || "PerformanceEvaluation", + * "DataWrangler" || "FeatureStore" || "EmrClusters" || "AutoMl" || "Experiments" || "Training" || "ModelEvaluation" || "Pipelines" || "Models" || "JumpStart" || "InferenceRecommender" || "Endpoints" || "Projects" || "InferenceOptimization" || "PerformanceEvaluation" || "HyperPodClusters" || "LakeraGuard" || "Comet" || "DeepchecksLLMEvaluation" || "Fiddler", * ], * HiddenAppTypes: [ // HiddenAppTypesList * "JupyterServer" || "KernelGateway" || "DetailedProfiler" || "TensorBoard" || "CodeEditor" || "JupyterLab" || "RStudioServerPro" || "RSessionGateway" || "Canvas", @@ -401,6 +405,10 @@ export interface CreateDomainCommandOutput extends CreateDomainResponse, __Metad * FileSystemId: "STRING_VALUE", // required * FileSystemPath: "STRING_VALUE", * }, + * FSxLustreFileSystemConfig: { + * FileSystemId: "STRING_VALUE", // required + * FileSystemPath: "STRING_VALUE", + * }, * }, * ], * }, diff --git a/clients/client-sagemaker/src/commands/CreateHyperParameterTuningJobCommand.ts b/clients/client-sagemaker/src/commands/CreateHyperParameterTuningJobCommand.ts index f140e6854548..b28da0fc604e 100644 --- a/clients/client-sagemaker/src/commands/CreateHyperParameterTuningJobCommand.ts +++ b/clients/client-sagemaker/src/commands/CreateHyperParameterTuningJobCommand.ts @@ -215,28 +215,29 @@ export interface CreateHyperParameterTuningJobCommandOutput * CompressionType: "GZIP" || "NONE", * }, * ResourceConfig: { // ResourceConfig - * InstanceType: "ml.m4.xlarge" || "ml.m4.2xlarge" || "ml.m4.4xlarge" || "ml.m4.10xlarge" || "ml.m4.16xlarge" || "ml.g4dn.xlarge" || "ml.g4dn.2xlarge" || "ml.g4dn.4xlarge" || "ml.g4dn.8xlarge" || "ml.g4dn.12xlarge" || "ml.g4dn.16xlarge" || "ml.m5.large" || "ml.m5.xlarge" || "ml.m5.2xlarge" || "ml.m5.4xlarge" || "ml.m5.12xlarge" || "ml.m5.24xlarge" || "ml.c4.xlarge" || "ml.c4.2xlarge" || "ml.c4.4xlarge" || "ml.c4.8xlarge" || "ml.p2.xlarge" || "ml.p2.8xlarge" || "ml.p2.16xlarge" || "ml.p3.2xlarge" || "ml.p3.8xlarge" || "ml.p3.16xlarge" || "ml.p3dn.24xlarge" || "ml.p4d.24xlarge" || "ml.p4de.24xlarge" || "ml.p5.48xlarge" || "ml.p5e.48xlarge" || "ml.c5.xlarge" || "ml.c5.2xlarge" || "ml.c5.4xlarge" || "ml.c5.9xlarge" || "ml.c5.18xlarge" || "ml.c5n.xlarge" || "ml.c5n.2xlarge" || "ml.c5n.4xlarge" || "ml.c5n.9xlarge" || "ml.c5n.18xlarge" || "ml.g5.xlarge" || "ml.g5.2xlarge" || "ml.g5.4xlarge" || "ml.g5.8xlarge" || "ml.g5.16xlarge" || "ml.g5.12xlarge" || "ml.g5.24xlarge" || "ml.g5.48xlarge" || "ml.g6.xlarge" || "ml.g6.2xlarge" || "ml.g6.4xlarge" || "ml.g6.8xlarge" || "ml.g6.16xlarge" || "ml.g6.12xlarge" || "ml.g6.24xlarge" || "ml.g6.48xlarge" || "ml.g6e.xlarge" || "ml.g6e.2xlarge" || "ml.g6e.4xlarge" || "ml.g6e.8xlarge" || "ml.g6e.16xlarge" || "ml.g6e.12xlarge" || "ml.g6e.24xlarge" || "ml.g6e.48xlarge" || "ml.trn1.2xlarge" || "ml.trn1.32xlarge" || "ml.trn1n.32xlarge" || "ml.m6i.large" || "ml.m6i.xlarge" || "ml.m6i.2xlarge" || "ml.m6i.4xlarge" || "ml.m6i.8xlarge" || "ml.m6i.12xlarge" || "ml.m6i.16xlarge" || "ml.m6i.24xlarge" || "ml.m6i.32xlarge" || "ml.c6i.xlarge" || "ml.c6i.2xlarge" || "ml.c6i.8xlarge" || "ml.c6i.4xlarge" || "ml.c6i.12xlarge" || "ml.c6i.16xlarge" || "ml.c6i.24xlarge" || "ml.c6i.32xlarge" || "ml.r5d.large" || "ml.r5d.xlarge" || "ml.r5d.2xlarge" || "ml.r5d.4xlarge" || "ml.r5d.8xlarge" || "ml.r5d.12xlarge" || "ml.r5d.16xlarge" || "ml.r5d.24xlarge" || "ml.t3.medium" || "ml.t3.large" || "ml.t3.xlarge" || "ml.t3.2xlarge" || "ml.r5.large" || "ml.r5.xlarge" || "ml.r5.2xlarge" || "ml.r5.4xlarge" || "ml.r5.8xlarge" || "ml.r5.12xlarge" || "ml.r5.16xlarge" || "ml.r5.24xlarge", + * InstanceType: "ml.m4.xlarge" || "ml.m4.2xlarge" || "ml.m4.4xlarge" || "ml.m4.10xlarge" || "ml.m4.16xlarge" || "ml.g4dn.xlarge" || "ml.g4dn.2xlarge" || "ml.g4dn.4xlarge" || "ml.g4dn.8xlarge" || "ml.g4dn.12xlarge" || "ml.g4dn.16xlarge" || "ml.m5.large" || "ml.m5.xlarge" || "ml.m5.2xlarge" || "ml.m5.4xlarge" || "ml.m5.12xlarge" || "ml.m5.24xlarge" || "ml.c4.xlarge" || "ml.c4.2xlarge" || "ml.c4.4xlarge" || "ml.c4.8xlarge" || "ml.p2.xlarge" || "ml.p2.8xlarge" || "ml.p2.16xlarge" || "ml.p3.2xlarge" || "ml.p3.8xlarge" || "ml.p3.16xlarge" || "ml.p3dn.24xlarge" || "ml.p4d.24xlarge" || "ml.p4de.24xlarge" || "ml.p5.48xlarge" || "ml.p5e.48xlarge" || "ml.p5en.48xlarge" || "ml.c5.xlarge" || "ml.c5.2xlarge" || "ml.c5.4xlarge" || "ml.c5.9xlarge" || "ml.c5.18xlarge" || "ml.c5n.xlarge" || "ml.c5n.2xlarge" || "ml.c5n.4xlarge" || "ml.c5n.9xlarge" || "ml.c5n.18xlarge" || "ml.g5.xlarge" || "ml.g5.2xlarge" || "ml.g5.4xlarge" || "ml.g5.8xlarge" || "ml.g5.16xlarge" || "ml.g5.12xlarge" || "ml.g5.24xlarge" || "ml.g5.48xlarge" || "ml.g6.xlarge" || "ml.g6.2xlarge" || "ml.g6.4xlarge" || "ml.g6.8xlarge" || "ml.g6.16xlarge" || "ml.g6.12xlarge" || "ml.g6.24xlarge" || "ml.g6.48xlarge" || "ml.g6e.xlarge" || "ml.g6e.2xlarge" || "ml.g6e.4xlarge" || "ml.g6e.8xlarge" || "ml.g6e.16xlarge" || "ml.g6e.12xlarge" || "ml.g6e.24xlarge" || "ml.g6e.48xlarge" || "ml.trn1.2xlarge" || "ml.trn1.32xlarge" || "ml.trn1n.32xlarge" || "ml.trn2.48xlarge" || "ml.m6i.large" || "ml.m6i.xlarge" || "ml.m6i.2xlarge" || "ml.m6i.4xlarge" || "ml.m6i.8xlarge" || "ml.m6i.12xlarge" || "ml.m6i.16xlarge" || "ml.m6i.24xlarge" || "ml.m6i.32xlarge" || "ml.c6i.xlarge" || "ml.c6i.2xlarge" || "ml.c6i.8xlarge" || "ml.c6i.4xlarge" || "ml.c6i.12xlarge" || "ml.c6i.16xlarge" || "ml.c6i.24xlarge" || "ml.c6i.32xlarge" || "ml.r5d.large" || "ml.r5d.xlarge" || "ml.r5d.2xlarge" || "ml.r5d.4xlarge" || "ml.r5d.8xlarge" || "ml.r5d.12xlarge" || "ml.r5d.16xlarge" || "ml.r5d.24xlarge" || "ml.t3.medium" || "ml.t3.large" || "ml.t3.xlarge" || "ml.t3.2xlarge" || "ml.r5.large" || "ml.r5.xlarge" || "ml.r5.2xlarge" || "ml.r5.4xlarge" || "ml.r5.8xlarge" || "ml.r5.12xlarge" || "ml.r5.16xlarge" || "ml.r5.24xlarge", * InstanceCount: Number("int"), * VolumeSizeInGB: Number("int"), // required * VolumeKmsKeyId: "STRING_VALUE", * KeepAlivePeriodInSeconds: Number("int"), * InstanceGroups: [ // InstanceGroups * { // InstanceGroup - * InstanceType: "ml.m4.xlarge" || "ml.m4.2xlarge" || "ml.m4.4xlarge" || "ml.m4.10xlarge" || "ml.m4.16xlarge" || "ml.g4dn.xlarge" || "ml.g4dn.2xlarge" || "ml.g4dn.4xlarge" || "ml.g4dn.8xlarge" || "ml.g4dn.12xlarge" || "ml.g4dn.16xlarge" || "ml.m5.large" || "ml.m5.xlarge" || "ml.m5.2xlarge" || "ml.m5.4xlarge" || "ml.m5.12xlarge" || "ml.m5.24xlarge" || "ml.c4.xlarge" || "ml.c4.2xlarge" || "ml.c4.4xlarge" || "ml.c4.8xlarge" || "ml.p2.xlarge" || "ml.p2.8xlarge" || "ml.p2.16xlarge" || "ml.p3.2xlarge" || "ml.p3.8xlarge" || "ml.p3.16xlarge" || "ml.p3dn.24xlarge" || "ml.p4d.24xlarge" || "ml.p4de.24xlarge" || "ml.p5.48xlarge" || "ml.p5e.48xlarge" || "ml.c5.xlarge" || "ml.c5.2xlarge" || "ml.c5.4xlarge" || "ml.c5.9xlarge" || "ml.c5.18xlarge" || "ml.c5n.xlarge" || "ml.c5n.2xlarge" || "ml.c5n.4xlarge" || "ml.c5n.9xlarge" || "ml.c5n.18xlarge" || "ml.g5.xlarge" || "ml.g5.2xlarge" || "ml.g5.4xlarge" || "ml.g5.8xlarge" || "ml.g5.16xlarge" || "ml.g5.12xlarge" || "ml.g5.24xlarge" || "ml.g5.48xlarge" || "ml.g6.xlarge" || "ml.g6.2xlarge" || "ml.g6.4xlarge" || "ml.g6.8xlarge" || "ml.g6.16xlarge" || "ml.g6.12xlarge" || "ml.g6.24xlarge" || "ml.g6.48xlarge" || "ml.g6e.xlarge" || "ml.g6e.2xlarge" || "ml.g6e.4xlarge" || "ml.g6e.8xlarge" || "ml.g6e.16xlarge" || "ml.g6e.12xlarge" || "ml.g6e.24xlarge" || "ml.g6e.48xlarge" || "ml.trn1.2xlarge" || "ml.trn1.32xlarge" || "ml.trn1n.32xlarge" || "ml.m6i.large" || "ml.m6i.xlarge" || "ml.m6i.2xlarge" || "ml.m6i.4xlarge" || "ml.m6i.8xlarge" || "ml.m6i.12xlarge" || "ml.m6i.16xlarge" || "ml.m6i.24xlarge" || "ml.m6i.32xlarge" || "ml.c6i.xlarge" || "ml.c6i.2xlarge" || "ml.c6i.8xlarge" || "ml.c6i.4xlarge" || "ml.c6i.12xlarge" || "ml.c6i.16xlarge" || "ml.c6i.24xlarge" || "ml.c6i.32xlarge" || "ml.r5d.large" || "ml.r5d.xlarge" || "ml.r5d.2xlarge" || "ml.r5d.4xlarge" || "ml.r5d.8xlarge" || "ml.r5d.12xlarge" || "ml.r5d.16xlarge" || "ml.r5d.24xlarge" || "ml.t3.medium" || "ml.t3.large" || "ml.t3.xlarge" || "ml.t3.2xlarge" || "ml.r5.large" || "ml.r5.xlarge" || "ml.r5.2xlarge" || "ml.r5.4xlarge" || "ml.r5.8xlarge" || "ml.r5.12xlarge" || "ml.r5.16xlarge" || "ml.r5.24xlarge", // required + * InstanceType: "ml.m4.xlarge" || "ml.m4.2xlarge" || "ml.m4.4xlarge" || "ml.m4.10xlarge" || "ml.m4.16xlarge" || "ml.g4dn.xlarge" || "ml.g4dn.2xlarge" || "ml.g4dn.4xlarge" || "ml.g4dn.8xlarge" || "ml.g4dn.12xlarge" || "ml.g4dn.16xlarge" || "ml.m5.large" || "ml.m5.xlarge" || "ml.m5.2xlarge" || "ml.m5.4xlarge" || "ml.m5.12xlarge" || "ml.m5.24xlarge" || "ml.c4.xlarge" || "ml.c4.2xlarge" || "ml.c4.4xlarge" || "ml.c4.8xlarge" || "ml.p2.xlarge" || "ml.p2.8xlarge" || "ml.p2.16xlarge" || "ml.p3.2xlarge" || "ml.p3.8xlarge" || "ml.p3.16xlarge" || "ml.p3dn.24xlarge" || "ml.p4d.24xlarge" || "ml.p4de.24xlarge" || "ml.p5.48xlarge" || "ml.p5e.48xlarge" || "ml.p5en.48xlarge" || "ml.c5.xlarge" || "ml.c5.2xlarge" || "ml.c5.4xlarge" || "ml.c5.9xlarge" || "ml.c5.18xlarge" || "ml.c5n.xlarge" || "ml.c5n.2xlarge" || "ml.c5n.4xlarge" || "ml.c5n.9xlarge" || "ml.c5n.18xlarge" || "ml.g5.xlarge" || "ml.g5.2xlarge" || "ml.g5.4xlarge" || "ml.g5.8xlarge" || "ml.g5.16xlarge" || "ml.g5.12xlarge" || "ml.g5.24xlarge" || "ml.g5.48xlarge" || "ml.g6.xlarge" || "ml.g6.2xlarge" || "ml.g6.4xlarge" || "ml.g6.8xlarge" || "ml.g6.16xlarge" || "ml.g6.12xlarge" || "ml.g6.24xlarge" || "ml.g6.48xlarge" || "ml.g6e.xlarge" || "ml.g6e.2xlarge" || "ml.g6e.4xlarge" || "ml.g6e.8xlarge" || "ml.g6e.16xlarge" || "ml.g6e.12xlarge" || "ml.g6e.24xlarge" || "ml.g6e.48xlarge" || "ml.trn1.2xlarge" || "ml.trn1.32xlarge" || "ml.trn1n.32xlarge" || "ml.trn2.48xlarge" || "ml.m6i.large" || "ml.m6i.xlarge" || "ml.m6i.2xlarge" || "ml.m6i.4xlarge" || "ml.m6i.8xlarge" || "ml.m6i.12xlarge" || "ml.m6i.16xlarge" || "ml.m6i.24xlarge" || "ml.m6i.32xlarge" || "ml.c6i.xlarge" || "ml.c6i.2xlarge" || "ml.c6i.8xlarge" || "ml.c6i.4xlarge" || "ml.c6i.12xlarge" || "ml.c6i.16xlarge" || "ml.c6i.24xlarge" || "ml.c6i.32xlarge" || "ml.r5d.large" || "ml.r5d.xlarge" || "ml.r5d.2xlarge" || "ml.r5d.4xlarge" || "ml.r5d.8xlarge" || "ml.r5d.12xlarge" || "ml.r5d.16xlarge" || "ml.r5d.24xlarge" || "ml.t3.medium" || "ml.t3.large" || "ml.t3.xlarge" || "ml.t3.2xlarge" || "ml.r5.large" || "ml.r5.xlarge" || "ml.r5.2xlarge" || "ml.r5.4xlarge" || "ml.r5.8xlarge" || "ml.r5.12xlarge" || "ml.r5.16xlarge" || "ml.r5.24xlarge", // required * InstanceCount: Number("int"), // required * InstanceGroupName: "STRING_VALUE", // required * }, * ], + * TrainingPlanArn: "STRING_VALUE", * }, * HyperParameterTuningResourceConfig: { // HyperParameterTuningResourceConfig - * InstanceType: "ml.m4.xlarge" || "ml.m4.2xlarge" || "ml.m4.4xlarge" || "ml.m4.10xlarge" || "ml.m4.16xlarge" || "ml.g4dn.xlarge" || "ml.g4dn.2xlarge" || "ml.g4dn.4xlarge" || "ml.g4dn.8xlarge" || "ml.g4dn.12xlarge" || "ml.g4dn.16xlarge" || "ml.m5.large" || "ml.m5.xlarge" || "ml.m5.2xlarge" || "ml.m5.4xlarge" || "ml.m5.12xlarge" || "ml.m5.24xlarge" || "ml.c4.xlarge" || "ml.c4.2xlarge" || "ml.c4.4xlarge" || "ml.c4.8xlarge" || "ml.p2.xlarge" || "ml.p2.8xlarge" || "ml.p2.16xlarge" || "ml.p3.2xlarge" || "ml.p3.8xlarge" || "ml.p3.16xlarge" || "ml.p3dn.24xlarge" || "ml.p4d.24xlarge" || "ml.p4de.24xlarge" || "ml.p5.48xlarge" || "ml.p5e.48xlarge" || "ml.c5.xlarge" || "ml.c5.2xlarge" || "ml.c5.4xlarge" || "ml.c5.9xlarge" || "ml.c5.18xlarge" || "ml.c5n.xlarge" || "ml.c5n.2xlarge" || "ml.c5n.4xlarge" || "ml.c5n.9xlarge" || "ml.c5n.18xlarge" || "ml.g5.xlarge" || "ml.g5.2xlarge" || "ml.g5.4xlarge" || "ml.g5.8xlarge" || "ml.g5.16xlarge" || "ml.g5.12xlarge" || "ml.g5.24xlarge" || "ml.g5.48xlarge" || "ml.g6.xlarge" || "ml.g6.2xlarge" || "ml.g6.4xlarge" || "ml.g6.8xlarge" || "ml.g6.16xlarge" || "ml.g6.12xlarge" || "ml.g6.24xlarge" || "ml.g6.48xlarge" || "ml.g6e.xlarge" || "ml.g6e.2xlarge" || "ml.g6e.4xlarge" || "ml.g6e.8xlarge" || "ml.g6e.16xlarge" || "ml.g6e.12xlarge" || "ml.g6e.24xlarge" || "ml.g6e.48xlarge" || "ml.trn1.2xlarge" || "ml.trn1.32xlarge" || "ml.trn1n.32xlarge" || "ml.m6i.large" || "ml.m6i.xlarge" || "ml.m6i.2xlarge" || "ml.m6i.4xlarge" || "ml.m6i.8xlarge" || "ml.m6i.12xlarge" || "ml.m6i.16xlarge" || "ml.m6i.24xlarge" || "ml.m6i.32xlarge" || "ml.c6i.xlarge" || "ml.c6i.2xlarge" || "ml.c6i.8xlarge" || "ml.c6i.4xlarge" || "ml.c6i.12xlarge" || "ml.c6i.16xlarge" || "ml.c6i.24xlarge" || "ml.c6i.32xlarge" || "ml.r5d.large" || "ml.r5d.xlarge" || "ml.r5d.2xlarge" || "ml.r5d.4xlarge" || "ml.r5d.8xlarge" || "ml.r5d.12xlarge" || "ml.r5d.16xlarge" || "ml.r5d.24xlarge" || "ml.t3.medium" || "ml.t3.large" || "ml.t3.xlarge" || "ml.t3.2xlarge" || "ml.r5.large" || "ml.r5.xlarge" || "ml.r5.2xlarge" || "ml.r5.4xlarge" || "ml.r5.8xlarge" || "ml.r5.12xlarge" || "ml.r5.16xlarge" || "ml.r5.24xlarge", + * InstanceType: "ml.m4.xlarge" || "ml.m4.2xlarge" || "ml.m4.4xlarge" || "ml.m4.10xlarge" || "ml.m4.16xlarge" || "ml.g4dn.xlarge" || "ml.g4dn.2xlarge" || "ml.g4dn.4xlarge" || "ml.g4dn.8xlarge" || "ml.g4dn.12xlarge" || "ml.g4dn.16xlarge" || "ml.m5.large" || "ml.m5.xlarge" || "ml.m5.2xlarge" || "ml.m5.4xlarge" || "ml.m5.12xlarge" || "ml.m5.24xlarge" || "ml.c4.xlarge" || "ml.c4.2xlarge" || "ml.c4.4xlarge" || "ml.c4.8xlarge" || "ml.p2.xlarge" || "ml.p2.8xlarge" || "ml.p2.16xlarge" || "ml.p3.2xlarge" || "ml.p3.8xlarge" || "ml.p3.16xlarge" || "ml.p3dn.24xlarge" || "ml.p4d.24xlarge" || "ml.p4de.24xlarge" || "ml.p5.48xlarge" || "ml.p5e.48xlarge" || "ml.p5en.48xlarge" || "ml.c5.xlarge" || "ml.c5.2xlarge" || "ml.c5.4xlarge" || "ml.c5.9xlarge" || "ml.c5.18xlarge" || "ml.c5n.xlarge" || "ml.c5n.2xlarge" || "ml.c5n.4xlarge" || "ml.c5n.9xlarge" || "ml.c5n.18xlarge" || "ml.g5.xlarge" || "ml.g5.2xlarge" || "ml.g5.4xlarge" || "ml.g5.8xlarge" || "ml.g5.16xlarge" || "ml.g5.12xlarge" || "ml.g5.24xlarge" || "ml.g5.48xlarge" || "ml.g6.xlarge" || "ml.g6.2xlarge" || "ml.g6.4xlarge" || "ml.g6.8xlarge" || "ml.g6.16xlarge" || "ml.g6.12xlarge" || "ml.g6.24xlarge" || "ml.g6.48xlarge" || "ml.g6e.xlarge" || "ml.g6e.2xlarge" || "ml.g6e.4xlarge" || "ml.g6e.8xlarge" || "ml.g6e.16xlarge" || "ml.g6e.12xlarge" || "ml.g6e.24xlarge" || "ml.g6e.48xlarge" || "ml.trn1.2xlarge" || "ml.trn1.32xlarge" || "ml.trn1n.32xlarge" || "ml.trn2.48xlarge" || "ml.m6i.large" || "ml.m6i.xlarge" || "ml.m6i.2xlarge" || "ml.m6i.4xlarge" || "ml.m6i.8xlarge" || "ml.m6i.12xlarge" || "ml.m6i.16xlarge" || "ml.m6i.24xlarge" || "ml.m6i.32xlarge" || "ml.c6i.xlarge" || "ml.c6i.2xlarge" || "ml.c6i.8xlarge" || "ml.c6i.4xlarge" || "ml.c6i.12xlarge" || "ml.c6i.16xlarge" || "ml.c6i.24xlarge" || "ml.c6i.32xlarge" || "ml.r5d.large" || "ml.r5d.xlarge" || "ml.r5d.2xlarge" || "ml.r5d.4xlarge" || "ml.r5d.8xlarge" || "ml.r5d.12xlarge" || "ml.r5d.16xlarge" || "ml.r5d.24xlarge" || "ml.t3.medium" || "ml.t3.large" || "ml.t3.xlarge" || "ml.t3.2xlarge" || "ml.r5.large" || "ml.r5.xlarge" || "ml.r5.2xlarge" || "ml.r5.4xlarge" || "ml.r5.8xlarge" || "ml.r5.12xlarge" || "ml.r5.16xlarge" || "ml.r5.24xlarge", * InstanceCount: Number("int"), * VolumeSizeInGB: Number("int"), * VolumeKmsKeyId: "STRING_VALUE", * AllocationStrategy: "Prioritized", * InstanceConfigs: [ // HyperParameterTuningInstanceConfigs * { // HyperParameterTuningInstanceConfig - * InstanceType: "ml.m4.xlarge" || "ml.m4.2xlarge" || "ml.m4.4xlarge" || "ml.m4.10xlarge" || "ml.m4.16xlarge" || "ml.g4dn.xlarge" || "ml.g4dn.2xlarge" || "ml.g4dn.4xlarge" || "ml.g4dn.8xlarge" || "ml.g4dn.12xlarge" || "ml.g4dn.16xlarge" || "ml.m5.large" || "ml.m5.xlarge" || "ml.m5.2xlarge" || "ml.m5.4xlarge" || "ml.m5.12xlarge" || "ml.m5.24xlarge" || "ml.c4.xlarge" || "ml.c4.2xlarge" || "ml.c4.4xlarge" || "ml.c4.8xlarge" || "ml.p2.xlarge" || "ml.p2.8xlarge" || "ml.p2.16xlarge" || "ml.p3.2xlarge" || "ml.p3.8xlarge" || "ml.p3.16xlarge" || "ml.p3dn.24xlarge" || "ml.p4d.24xlarge" || "ml.p4de.24xlarge" || "ml.p5.48xlarge" || "ml.p5e.48xlarge" || "ml.c5.xlarge" || "ml.c5.2xlarge" || "ml.c5.4xlarge" || "ml.c5.9xlarge" || "ml.c5.18xlarge" || "ml.c5n.xlarge" || "ml.c5n.2xlarge" || "ml.c5n.4xlarge" || "ml.c5n.9xlarge" || "ml.c5n.18xlarge" || "ml.g5.xlarge" || "ml.g5.2xlarge" || "ml.g5.4xlarge" || "ml.g5.8xlarge" || "ml.g5.16xlarge" || "ml.g5.12xlarge" || "ml.g5.24xlarge" || "ml.g5.48xlarge" || "ml.g6.xlarge" || "ml.g6.2xlarge" || "ml.g6.4xlarge" || "ml.g6.8xlarge" || "ml.g6.16xlarge" || "ml.g6.12xlarge" || "ml.g6.24xlarge" || "ml.g6.48xlarge" || "ml.g6e.xlarge" || "ml.g6e.2xlarge" || "ml.g6e.4xlarge" || "ml.g6e.8xlarge" || "ml.g6e.16xlarge" || "ml.g6e.12xlarge" || "ml.g6e.24xlarge" || "ml.g6e.48xlarge" || "ml.trn1.2xlarge" || "ml.trn1.32xlarge" || "ml.trn1n.32xlarge" || "ml.m6i.large" || "ml.m6i.xlarge" || "ml.m6i.2xlarge" || "ml.m6i.4xlarge" || "ml.m6i.8xlarge" || "ml.m6i.12xlarge" || "ml.m6i.16xlarge" || "ml.m6i.24xlarge" || "ml.m6i.32xlarge" || "ml.c6i.xlarge" || "ml.c6i.2xlarge" || "ml.c6i.8xlarge" || "ml.c6i.4xlarge" || "ml.c6i.12xlarge" || "ml.c6i.16xlarge" || "ml.c6i.24xlarge" || "ml.c6i.32xlarge" || "ml.r5d.large" || "ml.r5d.xlarge" || "ml.r5d.2xlarge" || "ml.r5d.4xlarge" || "ml.r5d.8xlarge" || "ml.r5d.12xlarge" || "ml.r5d.16xlarge" || "ml.r5d.24xlarge" || "ml.t3.medium" || "ml.t3.large" || "ml.t3.xlarge" || "ml.t3.2xlarge" || "ml.r5.large" || "ml.r5.xlarge" || "ml.r5.2xlarge" || "ml.r5.4xlarge" || "ml.r5.8xlarge" || "ml.r5.12xlarge" || "ml.r5.16xlarge" || "ml.r5.24xlarge", // required + * InstanceType: "ml.m4.xlarge" || "ml.m4.2xlarge" || "ml.m4.4xlarge" || "ml.m4.10xlarge" || "ml.m4.16xlarge" || "ml.g4dn.xlarge" || "ml.g4dn.2xlarge" || "ml.g4dn.4xlarge" || "ml.g4dn.8xlarge" || "ml.g4dn.12xlarge" || "ml.g4dn.16xlarge" || "ml.m5.large" || "ml.m5.xlarge" || "ml.m5.2xlarge" || "ml.m5.4xlarge" || "ml.m5.12xlarge" || "ml.m5.24xlarge" || "ml.c4.xlarge" || "ml.c4.2xlarge" || "ml.c4.4xlarge" || "ml.c4.8xlarge" || "ml.p2.xlarge" || "ml.p2.8xlarge" || "ml.p2.16xlarge" || "ml.p3.2xlarge" || "ml.p3.8xlarge" || "ml.p3.16xlarge" || "ml.p3dn.24xlarge" || "ml.p4d.24xlarge" || "ml.p4de.24xlarge" || "ml.p5.48xlarge" || "ml.p5e.48xlarge" || "ml.p5en.48xlarge" || "ml.c5.xlarge" || "ml.c5.2xlarge" || "ml.c5.4xlarge" || "ml.c5.9xlarge" || "ml.c5.18xlarge" || "ml.c5n.xlarge" || "ml.c5n.2xlarge" || "ml.c5n.4xlarge" || "ml.c5n.9xlarge" || "ml.c5n.18xlarge" || "ml.g5.xlarge" || "ml.g5.2xlarge" || "ml.g5.4xlarge" || "ml.g5.8xlarge" || "ml.g5.16xlarge" || "ml.g5.12xlarge" || "ml.g5.24xlarge" || "ml.g5.48xlarge" || "ml.g6.xlarge" || "ml.g6.2xlarge" || "ml.g6.4xlarge" || "ml.g6.8xlarge" || "ml.g6.16xlarge" || "ml.g6.12xlarge" || "ml.g6.24xlarge" || "ml.g6.48xlarge" || "ml.g6e.xlarge" || "ml.g6e.2xlarge" || "ml.g6e.4xlarge" || "ml.g6e.8xlarge" || "ml.g6e.16xlarge" || "ml.g6e.12xlarge" || "ml.g6e.24xlarge" || "ml.g6e.48xlarge" || "ml.trn1.2xlarge" || "ml.trn1.32xlarge" || "ml.trn1n.32xlarge" || "ml.trn2.48xlarge" || "ml.m6i.large" || "ml.m6i.xlarge" || "ml.m6i.2xlarge" || "ml.m6i.4xlarge" || "ml.m6i.8xlarge" || "ml.m6i.12xlarge" || "ml.m6i.16xlarge" || "ml.m6i.24xlarge" || "ml.m6i.32xlarge" || "ml.c6i.xlarge" || "ml.c6i.2xlarge" || "ml.c6i.8xlarge" || "ml.c6i.4xlarge" || "ml.c6i.12xlarge" || "ml.c6i.16xlarge" || "ml.c6i.24xlarge" || "ml.c6i.32xlarge" || "ml.r5d.large" || "ml.r5d.xlarge" || "ml.r5d.2xlarge" || "ml.r5d.4xlarge" || "ml.r5d.8xlarge" || "ml.r5d.12xlarge" || "ml.r5d.16xlarge" || "ml.r5d.24xlarge" || "ml.t3.medium" || "ml.t3.large" || "ml.t3.xlarge" || "ml.t3.2xlarge" || "ml.r5.large" || "ml.r5.xlarge" || "ml.r5.2xlarge" || "ml.r5.4xlarge" || "ml.r5.8xlarge" || "ml.r5.12xlarge" || "ml.r5.16xlarge" || "ml.r5.24xlarge", // required * InstanceCount: Number("int"), // required * VolumeSizeInGB: Number("int"), // required * }, @@ -360,28 +361,29 @@ export interface CreateHyperParameterTuningJobCommandOutput * CompressionType: "GZIP" || "NONE", * }, * ResourceConfig: { - * InstanceType: "ml.m4.xlarge" || "ml.m4.2xlarge" || "ml.m4.4xlarge" || "ml.m4.10xlarge" || "ml.m4.16xlarge" || "ml.g4dn.xlarge" || "ml.g4dn.2xlarge" || "ml.g4dn.4xlarge" || "ml.g4dn.8xlarge" || "ml.g4dn.12xlarge" || "ml.g4dn.16xlarge" || "ml.m5.large" || "ml.m5.xlarge" || "ml.m5.2xlarge" || "ml.m5.4xlarge" || "ml.m5.12xlarge" || "ml.m5.24xlarge" || "ml.c4.xlarge" || "ml.c4.2xlarge" || "ml.c4.4xlarge" || "ml.c4.8xlarge" || "ml.p2.xlarge" || "ml.p2.8xlarge" || "ml.p2.16xlarge" || "ml.p3.2xlarge" || "ml.p3.8xlarge" || "ml.p3.16xlarge" || "ml.p3dn.24xlarge" || "ml.p4d.24xlarge" || "ml.p4de.24xlarge" || "ml.p5.48xlarge" || "ml.p5e.48xlarge" || "ml.c5.xlarge" || "ml.c5.2xlarge" || "ml.c5.4xlarge" || "ml.c5.9xlarge" || "ml.c5.18xlarge" || "ml.c5n.xlarge" || "ml.c5n.2xlarge" || "ml.c5n.4xlarge" || "ml.c5n.9xlarge" || "ml.c5n.18xlarge" || "ml.g5.xlarge" || "ml.g5.2xlarge" || "ml.g5.4xlarge" || "ml.g5.8xlarge" || "ml.g5.16xlarge" || "ml.g5.12xlarge" || "ml.g5.24xlarge" || "ml.g5.48xlarge" || "ml.g6.xlarge" || "ml.g6.2xlarge" || "ml.g6.4xlarge" || "ml.g6.8xlarge" || "ml.g6.16xlarge" || "ml.g6.12xlarge" || "ml.g6.24xlarge" || "ml.g6.48xlarge" || "ml.g6e.xlarge" || "ml.g6e.2xlarge" || "ml.g6e.4xlarge" || "ml.g6e.8xlarge" || "ml.g6e.16xlarge" || "ml.g6e.12xlarge" || "ml.g6e.24xlarge" || "ml.g6e.48xlarge" || "ml.trn1.2xlarge" || "ml.trn1.32xlarge" || "ml.trn1n.32xlarge" || "ml.m6i.large" || "ml.m6i.xlarge" || "ml.m6i.2xlarge" || "ml.m6i.4xlarge" || "ml.m6i.8xlarge" || "ml.m6i.12xlarge" || "ml.m6i.16xlarge" || "ml.m6i.24xlarge" || "ml.m6i.32xlarge" || "ml.c6i.xlarge" || "ml.c6i.2xlarge" || "ml.c6i.8xlarge" || "ml.c6i.4xlarge" || "ml.c6i.12xlarge" || "ml.c6i.16xlarge" || "ml.c6i.24xlarge" || "ml.c6i.32xlarge" || "ml.r5d.large" || "ml.r5d.xlarge" || "ml.r5d.2xlarge" || "ml.r5d.4xlarge" || "ml.r5d.8xlarge" || "ml.r5d.12xlarge" || "ml.r5d.16xlarge" || "ml.r5d.24xlarge" || "ml.t3.medium" || "ml.t3.large" || "ml.t3.xlarge" || "ml.t3.2xlarge" || "ml.r5.large" || "ml.r5.xlarge" || "ml.r5.2xlarge" || "ml.r5.4xlarge" || "ml.r5.8xlarge" || "ml.r5.12xlarge" || "ml.r5.16xlarge" || "ml.r5.24xlarge", + * InstanceType: "ml.m4.xlarge" || "ml.m4.2xlarge" || "ml.m4.4xlarge" || "ml.m4.10xlarge" || "ml.m4.16xlarge" || "ml.g4dn.xlarge" || "ml.g4dn.2xlarge" || "ml.g4dn.4xlarge" || "ml.g4dn.8xlarge" || "ml.g4dn.12xlarge" || "ml.g4dn.16xlarge" || "ml.m5.large" || "ml.m5.xlarge" || "ml.m5.2xlarge" || "ml.m5.4xlarge" || "ml.m5.12xlarge" || "ml.m5.24xlarge" || "ml.c4.xlarge" || "ml.c4.2xlarge" || "ml.c4.4xlarge" || "ml.c4.8xlarge" || "ml.p2.xlarge" || "ml.p2.8xlarge" || "ml.p2.16xlarge" || "ml.p3.2xlarge" || "ml.p3.8xlarge" || "ml.p3.16xlarge" || "ml.p3dn.24xlarge" || "ml.p4d.24xlarge" || "ml.p4de.24xlarge" || "ml.p5.48xlarge" || "ml.p5e.48xlarge" || "ml.p5en.48xlarge" || "ml.c5.xlarge" || "ml.c5.2xlarge" || "ml.c5.4xlarge" || "ml.c5.9xlarge" || "ml.c5.18xlarge" || "ml.c5n.xlarge" || "ml.c5n.2xlarge" || "ml.c5n.4xlarge" || "ml.c5n.9xlarge" || "ml.c5n.18xlarge" || "ml.g5.xlarge" || "ml.g5.2xlarge" || "ml.g5.4xlarge" || "ml.g5.8xlarge" || "ml.g5.16xlarge" || "ml.g5.12xlarge" || "ml.g5.24xlarge" || "ml.g5.48xlarge" || "ml.g6.xlarge" || "ml.g6.2xlarge" || "ml.g6.4xlarge" || "ml.g6.8xlarge" || "ml.g6.16xlarge" || "ml.g6.12xlarge" || "ml.g6.24xlarge" || "ml.g6.48xlarge" || "ml.g6e.xlarge" || "ml.g6e.2xlarge" || "ml.g6e.4xlarge" || "ml.g6e.8xlarge" || "ml.g6e.16xlarge" || "ml.g6e.12xlarge" || "ml.g6e.24xlarge" || "ml.g6e.48xlarge" || "ml.trn1.2xlarge" || "ml.trn1.32xlarge" || "ml.trn1n.32xlarge" || "ml.trn2.48xlarge" || "ml.m6i.large" || "ml.m6i.xlarge" || "ml.m6i.2xlarge" || "ml.m6i.4xlarge" || "ml.m6i.8xlarge" || "ml.m6i.12xlarge" || "ml.m6i.16xlarge" || "ml.m6i.24xlarge" || "ml.m6i.32xlarge" || "ml.c6i.xlarge" || "ml.c6i.2xlarge" || "ml.c6i.8xlarge" || "ml.c6i.4xlarge" || "ml.c6i.12xlarge" || "ml.c6i.16xlarge" || "ml.c6i.24xlarge" || "ml.c6i.32xlarge" || "ml.r5d.large" || "ml.r5d.xlarge" || "ml.r5d.2xlarge" || "ml.r5d.4xlarge" || "ml.r5d.8xlarge" || "ml.r5d.12xlarge" || "ml.r5d.16xlarge" || "ml.r5d.24xlarge" || "ml.t3.medium" || "ml.t3.large" || "ml.t3.xlarge" || "ml.t3.2xlarge" || "ml.r5.large" || "ml.r5.xlarge" || "ml.r5.2xlarge" || "ml.r5.4xlarge" || "ml.r5.8xlarge" || "ml.r5.12xlarge" || "ml.r5.16xlarge" || "ml.r5.24xlarge", * InstanceCount: Number("int"), * VolumeSizeInGB: Number("int"), // required * VolumeKmsKeyId: "STRING_VALUE", * KeepAlivePeriodInSeconds: Number("int"), * InstanceGroups: [ * { - * InstanceType: "ml.m4.xlarge" || "ml.m4.2xlarge" || "ml.m4.4xlarge" || "ml.m4.10xlarge" || "ml.m4.16xlarge" || "ml.g4dn.xlarge" || "ml.g4dn.2xlarge" || "ml.g4dn.4xlarge" || "ml.g4dn.8xlarge" || "ml.g4dn.12xlarge" || "ml.g4dn.16xlarge" || "ml.m5.large" || "ml.m5.xlarge" || "ml.m5.2xlarge" || "ml.m5.4xlarge" || "ml.m5.12xlarge" || "ml.m5.24xlarge" || "ml.c4.xlarge" || "ml.c4.2xlarge" || "ml.c4.4xlarge" || "ml.c4.8xlarge" || "ml.p2.xlarge" || "ml.p2.8xlarge" || "ml.p2.16xlarge" || "ml.p3.2xlarge" || "ml.p3.8xlarge" || "ml.p3.16xlarge" || "ml.p3dn.24xlarge" || "ml.p4d.24xlarge" || "ml.p4de.24xlarge" || "ml.p5.48xlarge" || "ml.p5e.48xlarge" || "ml.c5.xlarge" || "ml.c5.2xlarge" || "ml.c5.4xlarge" || "ml.c5.9xlarge" || "ml.c5.18xlarge" || "ml.c5n.xlarge" || "ml.c5n.2xlarge" || "ml.c5n.4xlarge" || "ml.c5n.9xlarge" || "ml.c5n.18xlarge" || "ml.g5.xlarge" || "ml.g5.2xlarge" || "ml.g5.4xlarge" || "ml.g5.8xlarge" || "ml.g5.16xlarge" || "ml.g5.12xlarge" || "ml.g5.24xlarge" || "ml.g5.48xlarge" || "ml.g6.xlarge" || "ml.g6.2xlarge" || "ml.g6.4xlarge" || "ml.g6.8xlarge" || "ml.g6.16xlarge" || "ml.g6.12xlarge" || "ml.g6.24xlarge" || "ml.g6.48xlarge" || "ml.g6e.xlarge" || "ml.g6e.2xlarge" || "ml.g6e.4xlarge" || "ml.g6e.8xlarge" || "ml.g6e.16xlarge" || "ml.g6e.12xlarge" || "ml.g6e.24xlarge" || "ml.g6e.48xlarge" || "ml.trn1.2xlarge" || "ml.trn1.32xlarge" || "ml.trn1n.32xlarge" || "ml.m6i.large" || "ml.m6i.xlarge" || "ml.m6i.2xlarge" || "ml.m6i.4xlarge" || "ml.m6i.8xlarge" || "ml.m6i.12xlarge" || "ml.m6i.16xlarge" || "ml.m6i.24xlarge" || "ml.m6i.32xlarge" || "ml.c6i.xlarge" || "ml.c6i.2xlarge" || "ml.c6i.8xlarge" || "ml.c6i.4xlarge" || "ml.c6i.12xlarge" || "ml.c6i.16xlarge" || "ml.c6i.24xlarge" || "ml.c6i.32xlarge" || "ml.r5d.large" || "ml.r5d.xlarge" || "ml.r5d.2xlarge" || "ml.r5d.4xlarge" || "ml.r5d.8xlarge" || "ml.r5d.12xlarge" || "ml.r5d.16xlarge" || "ml.r5d.24xlarge" || "ml.t3.medium" || "ml.t3.large" || "ml.t3.xlarge" || "ml.t3.2xlarge" || "ml.r5.large" || "ml.r5.xlarge" || "ml.r5.2xlarge" || "ml.r5.4xlarge" || "ml.r5.8xlarge" || "ml.r5.12xlarge" || "ml.r5.16xlarge" || "ml.r5.24xlarge", // required + * InstanceType: "ml.m4.xlarge" || "ml.m4.2xlarge" || "ml.m4.4xlarge" || "ml.m4.10xlarge" || "ml.m4.16xlarge" || "ml.g4dn.xlarge" || "ml.g4dn.2xlarge" || "ml.g4dn.4xlarge" || "ml.g4dn.8xlarge" || "ml.g4dn.12xlarge" || "ml.g4dn.16xlarge" || "ml.m5.large" || "ml.m5.xlarge" || "ml.m5.2xlarge" || "ml.m5.4xlarge" || "ml.m5.12xlarge" || "ml.m5.24xlarge" || "ml.c4.xlarge" || "ml.c4.2xlarge" || "ml.c4.4xlarge" || "ml.c4.8xlarge" || "ml.p2.xlarge" || "ml.p2.8xlarge" || "ml.p2.16xlarge" || "ml.p3.2xlarge" || "ml.p3.8xlarge" || "ml.p3.16xlarge" || "ml.p3dn.24xlarge" || "ml.p4d.24xlarge" || "ml.p4de.24xlarge" || "ml.p5.48xlarge" || "ml.p5e.48xlarge" || "ml.p5en.48xlarge" || "ml.c5.xlarge" || "ml.c5.2xlarge" || "ml.c5.4xlarge" || "ml.c5.9xlarge" || "ml.c5.18xlarge" || "ml.c5n.xlarge" || "ml.c5n.2xlarge" || "ml.c5n.4xlarge" || "ml.c5n.9xlarge" || "ml.c5n.18xlarge" || "ml.g5.xlarge" || "ml.g5.2xlarge" || "ml.g5.4xlarge" || "ml.g5.8xlarge" || "ml.g5.16xlarge" || "ml.g5.12xlarge" || "ml.g5.24xlarge" || "ml.g5.48xlarge" || "ml.g6.xlarge" || "ml.g6.2xlarge" || "ml.g6.4xlarge" || "ml.g6.8xlarge" || "ml.g6.16xlarge" || "ml.g6.12xlarge" || "ml.g6.24xlarge" || "ml.g6.48xlarge" || "ml.g6e.xlarge" || "ml.g6e.2xlarge" || "ml.g6e.4xlarge" || "ml.g6e.8xlarge" || "ml.g6e.16xlarge" || "ml.g6e.12xlarge" || "ml.g6e.24xlarge" || "ml.g6e.48xlarge" || "ml.trn1.2xlarge" || "ml.trn1.32xlarge" || "ml.trn1n.32xlarge" || "ml.trn2.48xlarge" || "ml.m6i.large" || "ml.m6i.xlarge" || "ml.m6i.2xlarge" || "ml.m6i.4xlarge" || "ml.m6i.8xlarge" || "ml.m6i.12xlarge" || "ml.m6i.16xlarge" || "ml.m6i.24xlarge" || "ml.m6i.32xlarge" || "ml.c6i.xlarge" || "ml.c6i.2xlarge" || "ml.c6i.8xlarge" || "ml.c6i.4xlarge" || "ml.c6i.12xlarge" || "ml.c6i.16xlarge" || "ml.c6i.24xlarge" || "ml.c6i.32xlarge" || "ml.r5d.large" || "ml.r5d.xlarge" || "ml.r5d.2xlarge" || "ml.r5d.4xlarge" || "ml.r5d.8xlarge" || "ml.r5d.12xlarge" || "ml.r5d.16xlarge" || "ml.r5d.24xlarge" || "ml.t3.medium" || "ml.t3.large" || "ml.t3.xlarge" || "ml.t3.2xlarge" || "ml.r5.large" || "ml.r5.xlarge" || "ml.r5.2xlarge" || "ml.r5.4xlarge" || "ml.r5.8xlarge" || "ml.r5.12xlarge" || "ml.r5.16xlarge" || "ml.r5.24xlarge", // required * InstanceCount: Number("int"), // required * InstanceGroupName: "STRING_VALUE", // required * }, * ], + * TrainingPlanArn: "STRING_VALUE", * }, * HyperParameterTuningResourceConfig: { - * InstanceType: "ml.m4.xlarge" || "ml.m4.2xlarge" || "ml.m4.4xlarge" || "ml.m4.10xlarge" || "ml.m4.16xlarge" || "ml.g4dn.xlarge" || "ml.g4dn.2xlarge" || "ml.g4dn.4xlarge" || "ml.g4dn.8xlarge" || "ml.g4dn.12xlarge" || "ml.g4dn.16xlarge" || "ml.m5.large" || "ml.m5.xlarge" || "ml.m5.2xlarge" || "ml.m5.4xlarge" || "ml.m5.12xlarge" || "ml.m5.24xlarge" || "ml.c4.xlarge" || "ml.c4.2xlarge" || "ml.c4.4xlarge" || "ml.c4.8xlarge" || "ml.p2.xlarge" || "ml.p2.8xlarge" || "ml.p2.16xlarge" || "ml.p3.2xlarge" || "ml.p3.8xlarge" || "ml.p3.16xlarge" || "ml.p3dn.24xlarge" || "ml.p4d.24xlarge" || "ml.p4de.24xlarge" || "ml.p5.48xlarge" || "ml.p5e.48xlarge" || "ml.c5.xlarge" || "ml.c5.2xlarge" || "ml.c5.4xlarge" || "ml.c5.9xlarge" || "ml.c5.18xlarge" || "ml.c5n.xlarge" || "ml.c5n.2xlarge" || "ml.c5n.4xlarge" || "ml.c5n.9xlarge" || "ml.c5n.18xlarge" || "ml.g5.xlarge" || "ml.g5.2xlarge" || "ml.g5.4xlarge" || "ml.g5.8xlarge" || "ml.g5.16xlarge" || "ml.g5.12xlarge" || "ml.g5.24xlarge" || "ml.g5.48xlarge" || "ml.g6.xlarge" || "ml.g6.2xlarge" || "ml.g6.4xlarge" || "ml.g6.8xlarge" || "ml.g6.16xlarge" || "ml.g6.12xlarge" || "ml.g6.24xlarge" || "ml.g6.48xlarge" || "ml.g6e.xlarge" || "ml.g6e.2xlarge" || "ml.g6e.4xlarge" || "ml.g6e.8xlarge" || "ml.g6e.16xlarge" || "ml.g6e.12xlarge" || "ml.g6e.24xlarge" || "ml.g6e.48xlarge" || "ml.trn1.2xlarge" || "ml.trn1.32xlarge" || "ml.trn1n.32xlarge" || "ml.m6i.large" || "ml.m6i.xlarge" || "ml.m6i.2xlarge" || "ml.m6i.4xlarge" || "ml.m6i.8xlarge" || "ml.m6i.12xlarge" || "ml.m6i.16xlarge" || "ml.m6i.24xlarge" || "ml.m6i.32xlarge" || "ml.c6i.xlarge" || "ml.c6i.2xlarge" || "ml.c6i.8xlarge" || "ml.c6i.4xlarge" || "ml.c6i.12xlarge" || "ml.c6i.16xlarge" || "ml.c6i.24xlarge" || "ml.c6i.32xlarge" || "ml.r5d.large" || "ml.r5d.xlarge" || "ml.r5d.2xlarge" || "ml.r5d.4xlarge" || "ml.r5d.8xlarge" || "ml.r5d.12xlarge" || "ml.r5d.16xlarge" || "ml.r5d.24xlarge" || "ml.t3.medium" || "ml.t3.large" || "ml.t3.xlarge" || "ml.t3.2xlarge" || "ml.r5.large" || "ml.r5.xlarge" || "ml.r5.2xlarge" || "ml.r5.4xlarge" || "ml.r5.8xlarge" || "ml.r5.12xlarge" || "ml.r5.16xlarge" || "ml.r5.24xlarge", + * InstanceType: "ml.m4.xlarge" || "ml.m4.2xlarge" || "ml.m4.4xlarge" || "ml.m4.10xlarge" || "ml.m4.16xlarge" || "ml.g4dn.xlarge" || "ml.g4dn.2xlarge" || "ml.g4dn.4xlarge" || "ml.g4dn.8xlarge" || "ml.g4dn.12xlarge" || "ml.g4dn.16xlarge" || "ml.m5.large" || "ml.m5.xlarge" || "ml.m5.2xlarge" || "ml.m5.4xlarge" || "ml.m5.12xlarge" || "ml.m5.24xlarge" || "ml.c4.xlarge" || "ml.c4.2xlarge" || "ml.c4.4xlarge" || "ml.c4.8xlarge" || "ml.p2.xlarge" || "ml.p2.8xlarge" || "ml.p2.16xlarge" || "ml.p3.2xlarge" || "ml.p3.8xlarge" || "ml.p3.16xlarge" || "ml.p3dn.24xlarge" || "ml.p4d.24xlarge" || "ml.p4de.24xlarge" || "ml.p5.48xlarge" || "ml.p5e.48xlarge" || "ml.p5en.48xlarge" || "ml.c5.xlarge" || "ml.c5.2xlarge" || "ml.c5.4xlarge" || "ml.c5.9xlarge" || "ml.c5.18xlarge" || "ml.c5n.xlarge" || "ml.c5n.2xlarge" || "ml.c5n.4xlarge" || "ml.c5n.9xlarge" || "ml.c5n.18xlarge" || "ml.g5.xlarge" || "ml.g5.2xlarge" || "ml.g5.4xlarge" || "ml.g5.8xlarge" || "ml.g5.16xlarge" || "ml.g5.12xlarge" || "ml.g5.24xlarge" || "ml.g5.48xlarge" || "ml.g6.xlarge" || "ml.g6.2xlarge" || "ml.g6.4xlarge" || "ml.g6.8xlarge" || "ml.g6.16xlarge" || "ml.g6.12xlarge" || "ml.g6.24xlarge" || "ml.g6.48xlarge" || "ml.g6e.xlarge" || "ml.g6e.2xlarge" || "ml.g6e.4xlarge" || "ml.g6e.8xlarge" || "ml.g6e.16xlarge" || "ml.g6e.12xlarge" || "ml.g6e.24xlarge" || "ml.g6e.48xlarge" || "ml.trn1.2xlarge" || "ml.trn1.32xlarge" || "ml.trn1n.32xlarge" || "ml.trn2.48xlarge" || "ml.m6i.large" || "ml.m6i.xlarge" || "ml.m6i.2xlarge" || "ml.m6i.4xlarge" || "ml.m6i.8xlarge" || "ml.m6i.12xlarge" || "ml.m6i.16xlarge" || "ml.m6i.24xlarge" || "ml.m6i.32xlarge" || "ml.c6i.xlarge" || "ml.c6i.2xlarge" || "ml.c6i.8xlarge" || "ml.c6i.4xlarge" || "ml.c6i.12xlarge" || "ml.c6i.16xlarge" || "ml.c6i.24xlarge" || "ml.c6i.32xlarge" || "ml.r5d.large" || "ml.r5d.xlarge" || "ml.r5d.2xlarge" || "ml.r5d.4xlarge" || "ml.r5d.8xlarge" || "ml.r5d.12xlarge" || "ml.r5d.16xlarge" || "ml.r5d.24xlarge" || "ml.t3.medium" || "ml.t3.large" || "ml.t3.xlarge" || "ml.t3.2xlarge" || "ml.r5.large" || "ml.r5.xlarge" || "ml.r5.2xlarge" || "ml.r5.4xlarge" || "ml.r5.8xlarge" || "ml.r5.12xlarge" || "ml.r5.16xlarge" || "ml.r5.24xlarge", * InstanceCount: Number("int"), * VolumeSizeInGB: Number("int"), * VolumeKmsKeyId: "STRING_VALUE", * AllocationStrategy: "Prioritized", * InstanceConfigs: [ * { - * InstanceType: "ml.m4.xlarge" || "ml.m4.2xlarge" || "ml.m4.4xlarge" || "ml.m4.10xlarge" || "ml.m4.16xlarge" || "ml.g4dn.xlarge" || "ml.g4dn.2xlarge" || "ml.g4dn.4xlarge" || "ml.g4dn.8xlarge" || "ml.g4dn.12xlarge" || "ml.g4dn.16xlarge" || "ml.m5.large" || "ml.m5.xlarge" || "ml.m5.2xlarge" || "ml.m5.4xlarge" || "ml.m5.12xlarge" || "ml.m5.24xlarge" || "ml.c4.xlarge" || "ml.c4.2xlarge" || "ml.c4.4xlarge" || "ml.c4.8xlarge" || "ml.p2.xlarge" || "ml.p2.8xlarge" || "ml.p2.16xlarge" || "ml.p3.2xlarge" || "ml.p3.8xlarge" || "ml.p3.16xlarge" || "ml.p3dn.24xlarge" || "ml.p4d.24xlarge" || "ml.p4de.24xlarge" || "ml.p5.48xlarge" || "ml.p5e.48xlarge" || "ml.c5.xlarge" || "ml.c5.2xlarge" || "ml.c5.4xlarge" || "ml.c5.9xlarge" || "ml.c5.18xlarge" || "ml.c5n.xlarge" || "ml.c5n.2xlarge" || "ml.c5n.4xlarge" || "ml.c5n.9xlarge" || "ml.c5n.18xlarge" || "ml.g5.xlarge" || "ml.g5.2xlarge" || "ml.g5.4xlarge" || "ml.g5.8xlarge" || "ml.g5.16xlarge" || "ml.g5.12xlarge" || "ml.g5.24xlarge" || "ml.g5.48xlarge" || "ml.g6.xlarge" || "ml.g6.2xlarge" || "ml.g6.4xlarge" || "ml.g6.8xlarge" || "ml.g6.16xlarge" || "ml.g6.12xlarge" || "ml.g6.24xlarge" || "ml.g6.48xlarge" || "ml.g6e.xlarge" || "ml.g6e.2xlarge" || "ml.g6e.4xlarge" || "ml.g6e.8xlarge" || "ml.g6e.16xlarge" || "ml.g6e.12xlarge" || "ml.g6e.24xlarge" || "ml.g6e.48xlarge" || "ml.trn1.2xlarge" || "ml.trn1.32xlarge" || "ml.trn1n.32xlarge" || "ml.m6i.large" || "ml.m6i.xlarge" || "ml.m6i.2xlarge" || "ml.m6i.4xlarge" || "ml.m6i.8xlarge" || "ml.m6i.12xlarge" || "ml.m6i.16xlarge" || "ml.m6i.24xlarge" || "ml.m6i.32xlarge" || "ml.c6i.xlarge" || "ml.c6i.2xlarge" || "ml.c6i.8xlarge" || "ml.c6i.4xlarge" || "ml.c6i.12xlarge" || "ml.c6i.16xlarge" || "ml.c6i.24xlarge" || "ml.c6i.32xlarge" || "ml.r5d.large" || "ml.r5d.xlarge" || "ml.r5d.2xlarge" || "ml.r5d.4xlarge" || "ml.r5d.8xlarge" || "ml.r5d.12xlarge" || "ml.r5d.16xlarge" || "ml.r5d.24xlarge" || "ml.t3.medium" || "ml.t3.large" || "ml.t3.xlarge" || "ml.t3.2xlarge" || "ml.r5.large" || "ml.r5.xlarge" || "ml.r5.2xlarge" || "ml.r5.4xlarge" || "ml.r5.8xlarge" || "ml.r5.12xlarge" || "ml.r5.16xlarge" || "ml.r5.24xlarge", // required + * InstanceType: "ml.m4.xlarge" || "ml.m4.2xlarge" || "ml.m4.4xlarge" || "ml.m4.10xlarge" || "ml.m4.16xlarge" || "ml.g4dn.xlarge" || "ml.g4dn.2xlarge" || "ml.g4dn.4xlarge" || "ml.g4dn.8xlarge" || "ml.g4dn.12xlarge" || "ml.g4dn.16xlarge" || "ml.m5.large" || "ml.m5.xlarge" || "ml.m5.2xlarge" || "ml.m5.4xlarge" || "ml.m5.12xlarge" || "ml.m5.24xlarge" || "ml.c4.xlarge" || "ml.c4.2xlarge" || "ml.c4.4xlarge" || "ml.c4.8xlarge" || "ml.p2.xlarge" || "ml.p2.8xlarge" || "ml.p2.16xlarge" || "ml.p3.2xlarge" || "ml.p3.8xlarge" || "ml.p3.16xlarge" || "ml.p3dn.24xlarge" || "ml.p4d.24xlarge" || "ml.p4de.24xlarge" || "ml.p5.48xlarge" || "ml.p5e.48xlarge" || "ml.p5en.48xlarge" || "ml.c5.xlarge" || "ml.c5.2xlarge" || "ml.c5.4xlarge" || "ml.c5.9xlarge" || "ml.c5.18xlarge" || "ml.c5n.xlarge" || "ml.c5n.2xlarge" || "ml.c5n.4xlarge" || "ml.c5n.9xlarge" || "ml.c5n.18xlarge" || "ml.g5.xlarge" || "ml.g5.2xlarge" || "ml.g5.4xlarge" || "ml.g5.8xlarge" || "ml.g5.16xlarge" || "ml.g5.12xlarge" || "ml.g5.24xlarge" || "ml.g5.48xlarge" || "ml.g6.xlarge" || "ml.g6.2xlarge" || "ml.g6.4xlarge" || "ml.g6.8xlarge" || "ml.g6.16xlarge" || "ml.g6.12xlarge" || "ml.g6.24xlarge" || "ml.g6.48xlarge" || "ml.g6e.xlarge" || "ml.g6e.2xlarge" || "ml.g6e.4xlarge" || "ml.g6e.8xlarge" || "ml.g6e.16xlarge" || "ml.g6e.12xlarge" || "ml.g6e.24xlarge" || "ml.g6e.48xlarge" || "ml.trn1.2xlarge" || "ml.trn1.32xlarge" || "ml.trn1n.32xlarge" || "ml.trn2.48xlarge" || "ml.m6i.large" || "ml.m6i.xlarge" || "ml.m6i.2xlarge" || "ml.m6i.4xlarge" || "ml.m6i.8xlarge" || "ml.m6i.12xlarge" || "ml.m6i.16xlarge" || "ml.m6i.24xlarge" || "ml.m6i.32xlarge" || "ml.c6i.xlarge" || "ml.c6i.2xlarge" || "ml.c6i.8xlarge" || "ml.c6i.4xlarge" || "ml.c6i.12xlarge" || "ml.c6i.16xlarge" || "ml.c6i.24xlarge" || "ml.c6i.32xlarge" || "ml.r5d.large" || "ml.r5d.xlarge" || "ml.r5d.2xlarge" || "ml.r5d.4xlarge" || "ml.r5d.8xlarge" || "ml.r5d.12xlarge" || "ml.r5d.16xlarge" || "ml.r5d.24xlarge" || "ml.t3.medium" || "ml.t3.large" || "ml.t3.xlarge" || "ml.t3.2xlarge" || "ml.r5.large" || "ml.r5.xlarge" || "ml.r5.2xlarge" || "ml.r5.4xlarge" || "ml.r5.8xlarge" || "ml.r5.12xlarge" || "ml.r5.16xlarge" || "ml.r5.24xlarge", // required * InstanceCount: Number("int"), // required * VolumeSizeInGB: Number("int"), // required * }, diff --git a/clients/client-sagemaker/src/commands/CreateNotebookInstanceCommand.ts b/clients/client-sagemaker/src/commands/CreateNotebookInstanceCommand.ts index 2b5e9d4d852e..727ab4aae16a 100644 --- a/clients/client-sagemaker/src/commands/CreateNotebookInstanceCommand.ts +++ b/clients/client-sagemaker/src/commands/CreateNotebookInstanceCommand.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 { CreateNotebookInstanceInput, CreateNotebookInstanceOutput } from "../models/models_1"; +import { CreateNotebookInstanceInput, CreateNotebookInstanceOutput } from "../models/models_2"; import { de_CreateNotebookInstanceCommand, se_CreateNotebookInstanceCommand } from "../protocols/Aws_json1_1"; import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; diff --git a/clients/client-sagemaker/src/commands/CreateNotebookInstanceLifecycleConfigCommand.ts b/clients/client-sagemaker/src/commands/CreateNotebookInstanceLifecycleConfigCommand.ts index 92769c852134..7ef0fc6fb12a 100644 --- a/clients/client-sagemaker/src/commands/CreateNotebookInstanceLifecycleConfigCommand.ts +++ b/clients/client-sagemaker/src/commands/CreateNotebookInstanceLifecycleConfigCommand.ts @@ -8,7 +8,7 @@ import { commonParams } from "../endpoint/EndpointParameters"; import { CreateNotebookInstanceLifecycleConfigInput, CreateNotebookInstanceLifecycleConfigOutput, -} from "../models/models_1"; +} from "../models/models_2"; import { de_CreateNotebookInstanceLifecycleConfigCommand, se_CreateNotebookInstanceLifecycleConfigCommand, diff --git a/clients/client-sagemaker/src/commands/CreatePartnerAppCommand.ts b/clients/client-sagemaker/src/commands/CreatePartnerAppCommand.ts new file mode 100644 index 000000000000..706b7b25a255 --- /dev/null +++ b/clients/client-sagemaker/src/commands/CreatePartnerAppCommand.ts @@ -0,0 +1,123 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { commonParams } from "../endpoint/EndpointParameters"; +import { CreatePartnerAppRequest, CreatePartnerAppResponse } from "../models/models_2"; +import { de_CreatePartnerAppCommand, se_CreatePartnerAppCommand } from "../protocols/Aws_json1_1"; +import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link CreatePartnerAppCommand}. + */ +export interface CreatePartnerAppCommandInput extends CreatePartnerAppRequest {} +/** + * @public + * + * The output of {@link CreatePartnerAppCommand}. + */ +export interface CreatePartnerAppCommandOutput extends CreatePartnerAppResponse, __MetadataBearer {} + +/** + *Creates an Amazon SageMaker Partner AI App.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, CreatePartnerAppCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, CreatePartnerAppCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const input = { // CreatePartnerAppRequest + * Name: "STRING_VALUE", // required + * Type: "lakera-guard" || "comet" || "deepchecks-llm-evaluation" || "fiddler", // required + * ExecutionRoleArn: "STRING_VALUE", // required + * MaintenanceConfig: { // PartnerAppMaintenanceConfig + * MaintenanceWindowStart: "STRING_VALUE", + * }, + * Tier: "STRING_VALUE", // required + * ApplicationConfig: { // PartnerAppConfig + * AdminUsers: [ // PartnerAppAdminUserList + * "STRING_VALUE", + * ], + * Arguments: { // PartnerAppArguments + * "There was a conflict when you attempted to modify a SageMaker entity such as an
+ * Experiment or Artifact.
You have exceeded an SageMaker resource limit. For example, you might have too many + * training jobs created.
+ * + * @throws {@link SageMakerServiceException} + *Base exception class for all service exceptions from SageMaker service.
+ * + * @public + */ +export class CreatePartnerAppCommand extends $Command + .classBuilder< + CreatePartnerAppCommandInput, + CreatePartnerAppCommandOutput, + SageMakerClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: SageMakerClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("SageMaker", "CreatePartnerApp", {}) + .n("SageMakerClient", "CreatePartnerAppCommand") + .f(void 0, void 0) + .ser(se_CreatePartnerAppCommand) + .de(de_CreatePartnerAppCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: CreatePartnerAppRequest; + output: CreatePartnerAppResponse; + }; + sdk: { + input: CreatePartnerAppCommandInput; + output: CreatePartnerAppCommandOutput; + }; + }; +} diff --git a/clients/client-sagemaker/src/commands/CreatePartnerAppPresignedUrlCommand.ts b/clients/client-sagemaker/src/commands/CreatePartnerAppPresignedUrlCommand.ts new file mode 100644 index 000000000000..de0360ad9b20 --- /dev/null +++ b/clients/client-sagemaker/src/commands/CreatePartnerAppPresignedUrlCommand.ts @@ -0,0 +1,102 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { commonParams } from "../endpoint/EndpointParameters"; +import { CreatePartnerAppPresignedUrlRequest, CreatePartnerAppPresignedUrlResponse } from "../models/models_2"; +import { + de_CreatePartnerAppPresignedUrlCommand, + se_CreatePartnerAppPresignedUrlCommand, +} from "../protocols/Aws_json1_1"; +import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link CreatePartnerAppPresignedUrlCommand}. + */ +export interface CreatePartnerAppPresignedUrlCommandInput extends CreatePartnerAppPresignedUrlRequest {} +/** + * @public + * + * The output of {@link CreatePartnerAppPresignedUrlCommand}. + */ +export interface CreatePartnerAppPresignedUrlCommandOutput + extends CreatePartnerAppPresignedUrlResponse, + __MetadataBearer {} + +/** + *Creates a presigned URL to access an Amazon SageMaker Partner AI App.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, CreatePartnerAppPresignedUrlCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, CreatePartnerAppPresignedUrlCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const input = { // CreatePartnerAppPresignedUrlRequest + * Arn: "STRING_VALUE", // required + * ExpiresInSeconds: Number("int"), + * SessionExpirationDurationInSeconds: Number("int"), + * }; + * const command = new CreatePartnerAppPresignedUrlCommand(input); + * const response = await client.send(command); + * // { // CreatePartnerAppPresignedUrlResponse + * // Url: "STRING_VALUE", + * // }; + * + * ``` + * + * @param CreatePartnerAppPresignedUrlCommandInput - {@link CreatePartnerAppPresignedUrlCommandInput} + * @returns {@link CreatePartnerAppPresignedUrlCommandOutput} + * @see {@link CreatePartnerAppPresignedUrlCommandInput} for command's `input` shape. + * @see {@link CreatePartnerAppPresignedUrlCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for SageMakerClient's `config` shape. + * + * @throws {@link ResourceNotFound} (client fault) + *Resource being access is not found.
+ * + * @throws {@link SageMakerServiceException} + *Base exception class for all service exceptions from SageMaker service.
+ * + * @public + */ +export class CreatePartnerAppPresignedUrlCommand extends $Command + .classBuilder< + CreatePartnerAppPresignedUrlCommandInput, + CreatePartnerAppPresignedUrlCommandOutput, + SageMakerClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: SageMakerClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("SageMaker", "CreatePartnerAppPresignedUrl", {}) + .n("SageMakerClient", "CreatePartnerAppPresignedUrlCommand") + .f(void 0, void 0) + .ser(se_CreatePartnerAppPresignedUrlCommand) + .de(de_CreatePartnerAppPresignedUrlCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: CreatePartnerAppPresignedUrlRequest; + output: CreatePartnerAppPresignedUrlResponse; + }; + sdk: { + input: CreatePartnerAppPresignedUrlCommandInput; + output: CreatePartnerAppPresignedUrlCommandOutput; + }; + }; +} diff --git a/clients/client-sagemaker/src/commands/CreateSpaceCommand.ts b/clients/client-sagemaker/src/commands/CreateSpaceCommand.ts index e8fee536531d..0e4fa0fdb0a4 100644 --- a/clients/client-sagemaker/src/commands/CreateSpaceCommand.ts +++ b/clients/client-sagemaker/src/commands/CreateSpaceCommand.ts @@ -125,6 +125,9 @@ export interface CreateSpaceCommandOutput extends CreateSpaceResponse, __Metadat * EFSFileSystem: { // EFSFileSystem * FileSystemId: "STRING_VALUE", // required * }, + * FSxLustreFileSystem: { // FSxLustreFileSystem + * FileSystemId: "STRING_VALUE", // required + * }, * }, * ], * }, diff --git a/clients/client-sagemaker/src/commands/CreateTrainingJobCommand.ts b/clients/client-sagemaker/src/commands/CreateTrainingJobCommand.ts index c7eff7bdc18d..342806adb076 100644 --- a/clients/client-sagemaker/src/commands/CreateTrainingJobCommand.ts +++ b/clients/client-sagemaker/src/commands/CreateTrainingJobCommand.ts @@ -179,18 +179,19 @@ export interface CreateTrainingJobCommandOutput extends CreateTrainingJobRespons * CompressionType: "GZIP" || "NONE", * }, * ResourceConfig: { // ResourceConfig - * InstanceType: "ml.m4.xlarge" || "ml.m4.2xlarge" || "ml.m4.4xlarge" || "ml.m4.10xlarge" || "ml.m4.16xlarge" || "ml.g4dn.xlarge" || "ml.g4dn.2xlarge" || "ml.g4dn.4xlarge" || "ml.g4dn.8xlarge" || "ml.g4dn.12xlarge" || "ml.g4dn.16xlarge" || "ml.m5.large" || "ml.m5.xlarge" || "ml.m5.2xlarge" || "ml.m5.4xlarge" || "ml.m5.12xlarge" || "ml.m5.24xlarge" || "ml.c4.xlarge" || "ml.c4.2xlarge" || "ml.c4.4xlarge" || "ml.c4.8xlarge" || "ml.p2.xlarge" || "ml.p2.8xlarge" || "ml.p2.16xlarge" || "ml.p3.2xlarge" || "ml.p3.8xlarge" || "ml.p3.16xlarge" || "ml.p3dn.24xlarge" || "ml.p4d.24xlarge" || "ml.p4de.24xlarge" || "ml.p5.48xlarge" || "ml.p5e.48xlarge" || "ml.c5.xlarge" || "ml.c5.2xlarge" || "ml.c5.4xlarge" || "ml.c5.9xlarge" || "ml.c5.18xlarge" || "ml.c5n.xlarge" || "ml.c5n.2xlarge" || "ml.c5n.4xlarge" || "ml.c5n.9xlarge" || "ml.c5n.18xlarge" || "ml.g5.xlarge" || "ml.g5.2xlarge" || "ml.g5.4xlarge" || "ml.g5.8xlarge" || "ml.g5.16xlarge" || "ml.g5.12xlarge" || "ml.g5.24xlarge" || "ml.g5.48xlarge" || "ml.g6.xlarge" || "ml.g6.2xlarge" || "ml.g6.4xlarge" || "ml.g6.8xlarge" || "ml.g6.16xlarge" || "ml.g6.12xlarge" || "ml.g6.24xlarge" || "ml.g6.48xlarge" || "ml.g6e.xlarge" || "ml.g6e.2xlarge" || "ml.g6e.4xlarge" || "ml.g6e.8xlarge" || "ml.g6e.16xlarge" || "ml.g6e.12xlarge" || "ml.g6e.24xlarge" || "ml.g6e.48xlarge" || "ml.trn1.2xlarge" || "ml.trn1.32xlarge" || "ml.trn1n.32xlarge" || "ml.m6i.large" || "ml.m6i.xlarge" || "ml.m6i.2xlarge" || "ml.m6i.4xlarge" || "ml.m6i.8xlarge" || "ml.m6i.12xlarge" || "ml.m6i.16xlarge" || "ml.m6i.24xlarge" || "ml.m6i.32xlarge" || "ml.c6i.xlarge" || "ml.c6i.2xlarge" || "ml.c6i.8xlarge" || "ml.c6i.4xlarge" || "ml.c6i.12xlarge" || "ml.c6i.16xlarge" || "ml.c6i.24xlarge" || "ml.c6i.32xlarge" || "ml.r5d.large" || "ml.r5d.xlarge" || "ml.r5d.2xlarge" || "ml.r5d.4xlarge" || "ml.r5d.8xlarge" || "ml.r5d.12xlarge" || "ml.r5d.16xlarge" || "ml.r5d.24xlarge" || "ml.t3.medium" || "ml.t3.large" || "ml.t3.xlarge" || "ml.t3.2xlarge" || "ml.r5.large" || "ml.r5.xlarge" || "ml.r5.2xlarge" || "ml.r5.4xlarge" || "ml.r5.8xlarge" || "ml.r5.12xlarge" || "ml.r5.16xlarge" || "ml.r5.24xlarge", + * InstanceType: "ml.m4.xlarge" || "ml.m4.2xlarge" || "ml.m4.4xlarge" || "ml.m4.10xlarge" || "ml.m4.16xlarge" || "ml.g4dn.xlarge" || "ml.g4dn.2xlarge" || "ml.g4dn.4xlarge" || "ml.g4dn.8xlarge" || "ml.g4dn.12xlarge" || "ml.g4dn.16xlarge" || "ml.m5.large" || "ml.m5.xlarge" || "ml.m5.2xlarge" || "ml.m5.4xlarge" || "ml.m5.12xlarge" || "ml.m5.24xlarge" || "ml.c4.xlarge" || "ml.c4.2xlarge" || "ml.c4.4xlarge" || "ml.c4.8xlarge" || "ml.p2.xlarge" || "ml.p2.8xlarge" || "ml.p2.16xlarge" || "ml.p3.2xlarge" || "ml.p3.8xlarge" || "ml.p3.16xlarge" || "ml.p3dn.24xlarge" || "ml.p4d.24xlarge" || "ml.p4de.24xlarge" || "ml.p5.48xlarge" || "ml.p5e.48xlarge" || "ml.p5en.48xlarge" || "ml.c5.xlarge" || "ml.c5.2xlarge" || "ml.c5.4xlarge" || "ml.c5.9xlarge" || "ml.c5.18xlarge" || "ml.c5n.xlarge" || "ml.c5n.2xlarge" || "ml.c5n.4xlarge" || "ml.c5n.9xlarge" || "ml.c5n.18xlarge" || "ml.g5.xlarge" || "ml.g5.2xlarge" || "ml.g5.4xlarge" || "ml.g5.8xlarge" || "ml.g5.16xlarge" || "ml.g5.12xlarge" || "ml.g5.24xlarge" || "ml.g5.48xlarge" || "ml.g6.xlarge" || "ml.g6.2xlarge" || "ml.g6.4xlarge" || "ml.g6.8xlarge" || "ml.g6.16xlarge" || "ml.g6.12xlarge" || "ml.g6.24xlarge" || "ml.g6.48xlarge" || "ml.g6e.xlarge" || "ml.g6e.2xlarge" || "ml.g6e.4xlarge" || "ml.g6e.8xlarge" || "ml.g6e.16xlarge" || "ml.g6e.12xlarge" || "ml.g6e.24xlarge" || "ml.g6e.48xlarge" || "ml.trn1.2xlarge" || "ml.trn1.32xlarge" || "ml.trn1n.32xlarge" || "ml.trn2.48xlarge" || "ml.m6i.large" || "ml.m6i.xlarge" || "ml.m6i.2xlarge" || "ml.m6i.4xlarge" || "ml.m6i.8xlarge" || "ml.m6i.12xlarge" || "ml.m6i.16xlarge" || "ml.m6i.24xlarge" || "ml.m6i.32xlarge" || "ml.c6i.xlarge" || "ml.c6i.2xlarge" || "ml.c6i.8xlarge" || "ml.c6i.4xlarge" || "ml.c6i.12xlarge" || "ml.c6i.16xlarge" || "ml.c6i.24xlarge" || "ml.c6i.32xlarge" || "ml.r5d.large" || "ml.r5d.xlarge" || "ml.r5d.2xlarge" || "ml.r5d.4xlarge" || "ml.r5d.8xlarge" || "ml.r5d.12xlarge" || "ml.r5d.16xlarge" || "ml.r5d.24xlarge" || "ml.t3.medium" || "ml.t3.large" || "ml.t3.xlarge" || "ml.t3.2xlarge" || "ml.r5.large" || "ml.r5.xlarge" || "ml.r5.2xlarge" || "ml.r5.4xlarge" || "ml.r5.8xlarge" || "ml.r5.12xlarge" || "ml.r5.16xlarge" || "ml.r5.24xlarge", * InstanceCount: Number("int"), * VolumeSizeInGB: Number("int"), // required * VolumeKmsKeyId: "STRING_VALUE", * KeepAlivePeriodInSeconds: Number("int"), * InstanceGroups: [ // InstanceGroups * { // InstanceGroup - * InstanceType: "ml.m4.xlarge" || "ml.m4.2xlarge" || "ml.m4.4xlarge" || "ml.m4.10xlarge" || "ml.m4.16xlarge" || "ml.g4dn.xlarge" || "ml.g4dn.2xlarge" || "ml.g4dn.4xlarge" || "ml.g4dn.8xlarge" || "ml.g4dn.12xlarge" || "ml.g4dn.16xlarge" || "ml.m5.large" || "ml.m5.xlarge" || "ml.m5.2xlarge" || "ml.m5.4xlarge" || "ml.m5.12xlarge" || "ml.m5.24xlarge" || "ml.c4.xlarge" || "ml.c4.2xlarge" || "ml.c4.4xlarge" || "ml.c4.8xlarge" || "ml.p2.xlarge" || "ml.p2.8xlarge" || "ml.p2.16xlarge" || "ml.p3.2xlarge" || "ml.p3.8xlarge" || "ml.p3.16xlarge" || "ml.p3dn.24xlarge" || "ml.p4d.24xlarge" || "ml.p4de.24xlarge" || "ml.p5.48xlarge" || "ml.p5e.48xlarge" || "ml.c5.xlarge" || "ml.c5.2xlarge" || "ml.c5.4xlarge" || "ml.c5.9xlarge" || "ml.c5.18xlarge" || "ml.c5n.xlarge" || "ml.c5n.2xlarge" || "ml.c5n.4xlarge" || "ml.c5n.9xlarge" || "ml.c5n.18xlarge" || "ml.g5.xlarge" || "ml.g5.2xlarge" || "ml.g5.4xlarge" || "ml.g5.8xlarge" || "ml.g5.16xlarge" || "ml.g5.12xlarge" || "ml.g5.24xlarge" || "ml.g5.48xlarge" || "ml.g6.xlarge" || "ml.g6.2xlarge" || "ml.g6.4xlarge" || "ml.g6.8xlarge" || "ml.g6.16xlarge" || "ml.g6.12xlarge" || "ml.g6.24xlarge" || "ml.g6.48xlarge" || "ml.g6e.xlarge" || "ml.g6e.2xlarge" || "ml.g6e.4xlarge" || "ml.g6e.8xlarge" || "ml.g6e.16xlarge" || "ml.g6e.12xlarge" || "ml.g6e.24xlarge" || "ml.g6e.48xlarge" || "ml.trn1.2xlarge" || "ml.trn1.32xlarge" || "ml.trn1n.32xlarge" || "ml.m6i.large" || "ml.m6i.xlarge" || "ml.m6i.2xlarge" || "ml.m6i.4xlarge" || "ml.m6i.8xlarge" || "ml.m6i.12xlarge" || "ml.m6i.16xlarge" || "ml.m6i.24xlarge" || "ml.m6i.32xlarge" || "ml.c6i.xlarge" || "ml.c6i.2xlarge" || "ml.c6i.8xlarge" || "ml.c6i.4xlarge" || "ml.c6i.12xlarge" || "ml.c6i.16xlarge" || "ml.c6i.24xlarge" || "ml.c6i.32xlarge" || "ml.r5d.large" || "ml.r5d.xlarge" || "ml.r5d.2xlarge" || "ml.r5d.4xlarge" || "ml.r5d.8xlarge" || "ml.r5d.12xlarge" || "ml.r5d.16xlarge" || "ml.r5d.24xlarge" || "ml.t3.medium" || "ml.t3.large" || "ml.t3.xlarge" || "ml.t3.2xlarge" || "ml.r5.large" || "ml.r5.xlarge" || "ml.r5.2xlarge" || "ml.r5.4xlarge" || "ml.r5.8xlarge" || "ml.r5.12xlarge" || "ml.r5.16xlarge" || "ml.r5.24xlarge", // required + * InstanceType: "ml.m4.xlarge" || "ml.m4.2xlarge" || "ml.m4.4xlarge" || "ml.m4.10xlarge" || "ml.m4.16xlarge" || "ml.g4dn.xlarge" || "ml.g4dn.2xlarge" || "ml.g4dn.4xlarge" || "ml.g4dn.8xlarge" || "ml.g4dn.12xlarge" || "ml.g4dn.16xlarge" || "ml.m5.large" || "ml.m5.xlarge" || "ml.m5.2xlarge" || "ml.m5.4xlarge" || "ml.m5.12xlarge" || "ml.m5.24xlarge" || "ml.c4.xlarge" || "ml.c4.2xlarge" || "ml.c4.4xlarge" || "ml.c4.8xlarge" || "ml.p2.xlarge" || "ml.p2.8xlarge" || "ml.p2.16xlarge" || "ml.p3.2xlarge" || "ml.p3.8xlarge" || "ml.p3.16xlarge" || "ml.p3dn.24xlarge" || "ml.p4d.24xlarge" || "ml.p4de.24xlarge" || "ml.p5.48xlarge" || "ml.p5e.48xlarge" || "ml.p5en.48xlarge" || "ml.c5.xlarge" || "ml.c5.2xlarge" || "ml.c5.4xlarge" || "ml.c5.9xlarge" || "ml.c5.18xlarge" || "ml.c5n.xlarge" || "ml.c5n.2xlarge" || "ml.c5n.4xlarge" || "ml.c5n.9xlarge" || "ml.c5n.18xlarge" || "ml.g5.xlarge" || "ml.g5.2xlarge" || "ml.g5.4xlarge" || "ml.g5.8xlarge" || "ml.g5.16xlarge" || "ml.g5.12xlarge" || "ml.g5.24xlarge" || "ml.g5.48xlarge" || "ml.g6.xlarge" || "ml.g6.2xlarge" || "ml.g6.4xlarge" || "ml.g6.8xlarge" || "ml.g6.16xlarge" || "ml.g6.12xlarge" || "ml.g6.24xlarge" || "ml.g6.48xlarge" || "ml.g6e.xlarge" || "ml.g6e.2xlarge" || "ml.g6e.4xlarge" || "ml.g6e.8xlarge" || "ml.g6e.16xlarge" || "ml.g6e.12xlarge" || "ml.g6e.24xlarge" || "ml.g6e.48xlarge" || "ml.trn1.2xlarge" || "ml.trn1.32xlarge" || "ml.trn1n.32xlarge" || "ml.trn2.48xlarge" || "ml.m6i.large" || "ml.m6i.xlarge" || "ml.m6i.2xlarge" || "ml.m6i.4xlarge" || "ml.m6i.8xlarge" || "ml.m6i.12xlarge" || "ml.m6i.16xlarge" || "ml.m6i.24xlarge" || "ml.m6i.32xlarge" || "ml.c6i.xlarge" || "ml.c6i.2xlarge" || "ml.c6i.8xlarge" || "ml.c6i.4xlarge" || "ml.c6i.12xlarge" || "ml.c6i.16xlarge" || "ml.c6i.24xlarge" || "ml.c6i.32xlarge" || "ml.r5d.large" || "ml.r5d.xlarge" || "ml.r5d.2xlarge" || "ml.r5d.4xlarge" || "ml.r5d.8xlarge" || "ml.r5d.12xlarge" || "ml.r5d.16xlarge" || "ml.r5d.24xlarge" || "ml.t3.medium" || "ml.t3.large" || "ml.t3.xlarge" || "ml.t3.2xlarge" || "ml.r5.large" || "ml.r5.xlarge" || "ml.r5.2xlarge" || "ml.r5.4xlarge" || "ml.r5.8xlarge" || "ml.r5.12xlarge" || "ml.r5.16xlarge" || "ml.r5.24xlarge", // required * InstanceCount: Number("int"), // required * InstanceGroupName: "STRING_VALUE", // required * }, * ], + * TrainingPlanArn: "STRING_VALUE", * }, * VpcConfig: { // VpcConfig * SecurityGroupIds: [ // VpcSecurityGroupIds // required diff --git a/clients/client-sagemaker/src/commands/CreateTrainingPlanCommand.ts b/clients/client-sagemaker/src/commands/CreateTrainingPlanCommand.ts new file mode 100644 index 000000000000..df97c569cd4b --- /dev/null +++ b/clients/client-sagemaker/src/commands/CreateTrainingPlanCommand.ts @@ -0,0 +1,169 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { commonParams } from "../endpoint/EndpointParameters"; +import { CreateTrainingPlanRequest, CreateTrainingPlanResponse } from "../models/models_2"; +import { de_CreateTrainingPlanCommand, se_CreateTrainingPlanCommand } from "../protocols/Aws_json1_1"; +import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link CreateTrainingPlanCommand}. + */ +export interface CreateTrainingPlanCommandInput extends CreateTrainingPlanRequest {} +/** + * @public + * + * The output of {@link CreateTrainingPlanCommand}. + */ +export interface CreateTrainingPlanCommandOutput extends CreateTrainingPlanResponse, __MetadataBearer {} + +/** + *Creates a new training plan in SageMaker to reserve compute capacity.
+ *Amazon SageMaker Training Plan is a capability within SageMaker that allows customers to reserve and manage GPU + * capacity for large-scale AI model training. It provides a way to secure predictable access + * to computational resources within specific timelines and budgets, without the need to + * manage underlying infrastructure.
+ *+ * How it works + *
+ *Plans can be created for specific resources such as SageMaker Training Jobs or SageMaker HyperPod + * clusters, automatically provisioning resources, setting up infrastructure, executing + * workloads, and handling infrastructure failures.
+ *+ * Plan creation workflow + *
+ *Users search for available plan offerings based on their requirements (e.g.,
+ * instance type, count, start time, duration) using the
+ * SearchTrainingPlanOfferings
+ * API operation.
They create a plan that best matches their needs using the ID of the plan offering + * they want to use.
+ *After successful upfront payment, the plan's status becomes
+ * Scheduled.
The plan can be used to:
+ *Queue training jobs.
+ *Allocate to an instance group of a SageMaker HyperPod cluster.
+ *When the plan start date arrives, it becomes Active. Based on
+ * available reserved capacity:
Training jobs are launched.
+ *Instance groups are provisioned.
+ *+ * Plan composition + *
+ *A plan can consist of one or more Reserved Capacities, each defined by a specific
+ * instance type, quantity, Availability Zone, duration, and start and end times. For more
+ * information about Reserved Capacity, see
+ * ReservedCapacitySummary
+ * .
Resource being accessed is in use.
+ * + * @throws {@link ResourceLimitExceeded} (client fault) + *You have exceeded an SageMaker resource limit. For example, you might have too many + * training jobs created.
+ * + * @throws {@link ResourceNotFound} (client fault) + *Resource being access is not found.
+ * + * @throws {@link SageMakerServiceException} + *Base exception class for all service exceptions from SageMaker service.
+ * + * @public + */ +export class CreateTrainingPlanCommand extends $Command + .classBuilder< + CreateTrainingPlanCommandInput, + CreateTrainingPlanCommandOutput, + SageMakerClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: SageMakerClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("SageMaker", "CreateTrainingPlan", {}) + .n("SageMakerClient", "CreateTrainingPlanCommand") + .f(void 0, void 0) + .ser(se_CreateTrainingPlanCommand) + .de(de_CreateTrainingPlanCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: CreateTrainingPlanRequest; + output: CreateTrainingPlanResponse; + }; + sdk: { + input: CreateTrainingPlanCommandInput; + output: CreateTrainingPlanCommandOutput; + }; + }; +} diff --git a/clients/client-sagemaker/src/commands/CreateUserProfileCommand.ts b/clients/client-sagemaker/src/commands/CreateUserProfileCommand.ts index f7b9734ddb83..73d2eafc179e 100644 --- a/clients/client-sagemaker/src/commands/CreateUserProfileCommand.ts +++ b/clients/client-sagemaker/src/commands/CreateUserProfileCommand.ts @@ -242,11 +242,15 @@ export interface CreateUserProfileCommandOutput extends CreateUserProfileRespons * FileSystemId: "STRING_VALUE", // required * FileSystemPath: "STRING_VALUE", * }, + * FSxLustreFileSystemConfig: { // FSxLustreFileSystemConfig + * FileSystemId: "STRING_VALUE", // required + * FileSystemPath: "STRING_VALUE", + * }, * }, * ], * StudioWebPortalSettings: { // StudioWebPortalSettings * HiddenMlTools: [ // HiddenMlToolsList - * "DataWrangler" || "FeatureStore" || "EmrClusters" || "AutoMl" || "Experiments" || "Training" || "ModelEvaluation" || "Pipelines" || "Models" || "JumpStart" || "InferenceRecommender" || "Endpoints" || "Projects" || "InferenceOptimization" || "PerformanceEvaluation", + * "DataWrangler" || "FeatureStore" || "EmrClusters" || "AutoMl" || "Experiments" || "Training" || "ModelEvaluation" || "Pipelines" || "Models" || "JumpStart" || "InferenceRecommender" || "Endpoints" || "Projects" || "InferenceOptimization" || "PerformanceEvaluation" || "HyperPodClusters" || "LakeraGuard" || "Comet" || "DeepchecksLLMEvaluation" || "Fiddler", * ], * HiddenAppTypes: [ // HiddenAppTypesList * "JupyterServer" || "KernelGateway" || "DetailedProfiler" || "TensorBoard" || "CodeEditor" || "JupyterLab" || "RStudioServerPro" || "RSessionGateway" || "Canvas", diff --git a/clients/client-sagemaker/src/commands/DeleteClusterSchedulerConfigCommand.ts b/clients/client-sagemaker/src/commands/DeleteClusterSchedulerConfigCommand.ts new file mode 100644 index 000000000000..ac15f5b4698f --- /dev/null +++ b/clients/client-sagemaker/src/commands/DeleteClusterSchedulerConfigCommand.ts @@ -0,0 +1,96 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { commonParams } from "../endpoint/EndpointParameters"; +import { DeleteClusterSchedulerConfigRequest } from "../models/models_2"; +import { + de_DeleteClusterSchedulerConfigCommand, + se_DeleteClusterSchedulerConfigCommand, +} from "../protocols/Aws_json1_1"; +import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link DeleteClusterSchedulerConfigCommand}. + */ +export interface DeleteClusterSchedulerConfigCommandInput extends DeleteClusterSchedulerConfigRequest {} +/** + * @public + * + * The output of {@link DeleteClusterSchedulerConfigCommand}. + */ +export interface DeleteClusterSchedulerConfigCommandOutput extends __MetadataBearer {} + +/** + *Deletes the cluster policy of the cluster.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, DeleteClusterSchedulerConfigCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, DeleteClusterSchedulerConfigCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const input = { // DeleteClusterSchedulerConfigRequest + * ClusterSchedulerConfigId: "STRING_VALUE", // required + * }; + * const command = new DeleteClusterSchedulerConfigCommand(input); + * const response = await client.send(command); + * // {}; + * + * ``` + * + * @param DeleteClusterSchedulerConfigCommandInput - {@link DeleteClusterSchedulerConfigCommandInput} + * @returns {@link DeleteClusterSchedulerConfigCommandOutput} + * @see {@link DeleteClusterSchedulerConfigCommandInput} for command's `input` shape. + * @see {@link DeleteClusterSchedulerConfigCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for SageMakerClient's `config` shape. + * + * @throws {@link ResourceNotFound} (client fault) + *Resource being access is not found.
+ * + * @throws {@link SageMakerServiceException} + *Base exception class for all service exceptions from SageMaker service.
+ * + * @public + */ +export class DeleteClusterSchedulerConfigCommand extends $Command + .classBuilder< + DeleteClusterSchedulerConfigCommandInput, + DeleteClusterSchedulerConfigCommandOutput, + SageMakerClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: SageMakerClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("SageMaker", "DeleteClusterSchedulerConfig", {}) + .n("SageMakerClient", "DeleteClusterSchedulerConfigCommand") + .f(void 0, void 0) + .ser(se_DeleteClusterSchedulerConfigCommand) + .de(de_DeleteClusterSchedulerConfigCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: DeleteClusterSchedulerConfigRequest; + output: {}; + }; + sdk: { + input: DeleteClusterSchedulerConfigCommandInput; + output: DeleteClusterSchedulerConfigCommandOutput; + }; + }; +} diff --git a/clients/client-sagemaker/src/commands/DeleteComputeQuotaCommand.ts b/clients/client-sagemaker/src/commands/DeleteComputeQuotaCommand.ts new file mode 100644 index 000000000000..904f3a7aeb60 --- /dev/null +++ b/clients/client-sagemaker/src/commands/DeleteComputeQuotaCommand.ts @@ -0,0 +1,93 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { commonParams } from "../endpoint/EndpointParameters"; +import { DeleteComputeQuotaRequest } from "../models/models_2"; +import { de_DeleteComputeQuotaCommand, se_DeleteComputeQuotaCommand } from "../protocols/Aws_json1_1"; +import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link DeleteComputeQuotaCommand}. + */ +export interface DeleteComputeQuotaCommandInput extends DeleteComputeQuotaRequest {} +/** + * @public + * + * The output of {@link DeleteComputeQuotaCommand}. + */ +export interface DeleteComputeQuotaCommandOutput extends __MetadataBearer {} + +/** + *Deletes the compute allocation from the cluster.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, DeleteComputeQuotaCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, DeleteComputeQuotaCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const input = { // DeleteComputeQuotaRequest + * ComputeQuotaId: "STRING_VALUE", // required + * }; + * const command = new DeleteComputeQuotaCommand(input); + * const response = await client.send(command); + * // {}; + * + * ``` + * + * @param DeleteComputeQuotaCommandInput - {@link DeleteComputeQuotaCommandInput} + * @returns {@link DeleteComputeQuotaCommandOutput} + * @see {@link DeleteComputeQuotaCommandInput} for command's `input` shape. + * @see {@link DeleteComputeQuotaCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for SageMakerClient's `config` shape. + * + * @throws {@link ResourceNotFound} (client fault) + *Resource being access is not found.
+ * + * @throws {@link SageMakerServiceException} + *Base exception class for all service exceptions from SageMaker service.
+ * + * @public + */ +export class DeleteComputeQuotaCommand extends $Command + .classBuilder< + DeleteComputeQuotaCommandInput, + DeleteComputeQuotaCommandOutput, + SageMakerClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: SageMakerClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("SageMaker", "DeleteComputeQuota", {}) + .n("SageMakerClient", "DeleteComputeQuotaCommand") + .f(void 0, void 0) + .ser(se_DeleteComputeQuotaCommand) + .de(de_DeleteComputeQuotaCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: DeleteComputeQuotaRequest; + output: {}; + }; + sdk: { + input: DeleteComputeQuotaCommandInput; + output: DeleteComputeQuotaCommandOutput; + }; + }; +} diff --git a/clients/client-sagemaker/src/commands/DeletePartnerAppCommand.ts b/clients/client-sagemaker/src/commands/DeletePartnerAppCommand.ts new file mode 100644 index 000000000000..df445cfb2971 --- /dev/null +++ b/clients/client-sagemaker/src/commands/DeletePartnerAppCommand.ts @@ -0,0 +1,100 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { commonParams } from "../endpoint/EndpointParameters"; +import { DeletePartnerAppRequest, DeletePartnerAppResponse } from "../models/models_2"; +import { de_DeletePartnerAppCommand, se_DeletePartnerAppCommand } from "../protocols/Aws_json1_1"; +import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link DeletePartnerAppCommand}. + */ +export interface DeletePartnerAppCommandInput extends DeletePartnerAppRequest {} +/** + * @public + * + * The output of {@link DeletePartnerAppCommand}. + */ +export interface DeletePartnerAppCommandOutput extends DeletePartnerAppResponse, __MetadataBearer {} + +/** + *Deletes a SageMaker Partner AI App.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, DeletePartnerAppCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, DeletePartnerAppCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const input = { // DeletePartnerAppRequest + * Arn: "STRING_VALUE", // required + * ClientToken: "STRING_VALUE", + * }; + * const command = new DeletePartnerAppCommand(input); + * const response = await client.send(command); + * // { // DeletePartnerAppResponse + * // Arn: "STRING_VALUE", + * // }; + * + * ``` + * + * @param DeletePartnerAppCommandInput - {@link DeletePartnerAppCommandInput} + * @returns {@link DeletePartnerAppCommandOutput} + * @see {@link DeletePartnerAppCommandInput} for command's `input` shape. + * @see {@link DeletePartnerAppCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for SageMakerClient's `config` shape. + * + * @throws {@link ConflictException} (client fault) + *There was a conflict when you attempted to modify a SageMaker entity such as an
+ * Experiment or Artifact.
Resource being access is not found.
+ * + * @throws {@link SageMakerServiceException} + *Base exception class for all service exceptions from SageMaker service.
+ * + * @public + */ +export class DeletePartnerAppCommand extends $Command + .classBuilder< + DeletePartnerAppCommandInput, + DeletePartnerAppCommandOutput, + SageMakerClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: SageMakerClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("SageMaker", "DeletePartnerApp", {}) + .n("SageMakerClient", "DeletePartnerAppCommand") + .f(void 0, void 0) + .ser(se_DeletePartnerAppCommand) + .de(de_DeletePartnerAppCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: DeletePartnerAppRequest; + output: DeletePartnerAppResponse; + }; + sdk: { + input: DeletePartnerAppCommandInput; + output: DeletePartnerAppCommandOutput; + }; + }; +} diff --git a/clients/client-sagemaker/src/commands/DescribeAlgorithmCommand.ts b/clients/client-sagemaker/src/commands/DescribeAlgorithmCommand.ts index ca9d87c1ea88..502b25ef485e 100644 --- a/clients/client-sagemaker/src/commands/DescribeAlgorithmCommand.ts +++ b/clients/client-sagemaker/src/commands/DescribeAlgorithmCommand.ts @@ -74,7 +74,7 @@ export interface DescribeAlgorithmCommandOutput extends DescribeAlgorithmOutput, * // }, * // ], * // SupportedTrainingInstanceTypes: [ // TrainingInstanceTypes // required - * // "ml.m4.xlarge" || "ml.m4.2xlarge" || "ml.m4.4xlarge" || "ml.m4.10xlarge" || "ml.m4.16xlarge" || "ml.g4dn.xlarge" || "ml.g4dn.2xlarge" || "ml.g4dn.4xlarge" || "ml.g4dn.8xlarge" || "ml.g4dn.12xlarge" || "ml.g4dn.16xlarge" || "ml.m5.large" || "ml.m5.xlarge" || "ml.m5.2xlarge" || "ml.m5.4xlarge" || "ml.m5.12xlarge" || "ml.m5.24xlarge" || "ml.c4.xlarge" || "ml.c4.2xlarge" || "ml.c4.4xlarge" || "ml.c4.8xlarge" || "ml.p2.xlarge" || "ml.p2.8xlarge" || "ml.p2.16xlarge" || "ml.p3.2xlarge" || "ml.p3.8xlarge" || "ml.p3.16xlarge" || "ml.p3dn.24xlarge" || "ml.p4d.24xlarge" || "ml.p4de.24xlarge" || "ml.p5.48xlarge" || "ml.p5e.48xlarge" || "ml.c5.xlarge" || "ml.c5.2xlarge" || "ml.c5.4xlarge" || "ml.c5.9xlarge" || "ml.c5.18xlarge" || "ml.c5n.xlarge" || "ml.c5n.2xlarge" || "ml.c5n.4xlarge" || "ml.c5n.9xlarge" || "ml.c5n.18xlarge" || "ml.g5.xlarge" || "ml.g5.2xlarge" || "ml.g5.4xlarge" || "ml.g5.8xlarge" || "ml.g5.16xlarge" || "ml.g5.12xlarge" || "ml.g5.24xlarge" || "ml.g5.48xlarge" || "ml.g6.xlarge" || "ml.g6.2xlarge" || "ml.g6.4xlarge" || "ml.g6.8xlarge" || "ml.g6.16xlarge" || "ml.g6.12xlarge" || "ml.g6.24xlarge" || "ml.g6.48xlarge" || "ml.g6e.xlarge" || "ml.g6e.2xlarge" || "ml.g6e.4xlarge" || "ml.g6e.8xlarge" || "ml.g6e.16xlarge" || "ml.g6e.12xlarge" || "ml.g6e.24xlarge" || "ml.g6e.48xlarge" || "ml.trn1.2xlarge" || "ml.trn1.32xlarge" || "ml.trn1n.32xlarge" || "ml.m6i.large" || "ml.m6i.xlarge" || "ml.m6i.2xlarge" || "ml.m6i.4xlarge" || "ml.m6i.8xlarge" || "ml.m6i.12xlarge" || "ml.m6i.16xlarge" || "ml.m6i.24xlarge" || "ml.m6i.32xlarge" || "ml.c6i.xlarge" || "ml.c6i.2xlarge" || "ml.c6i.8xlarge" || "ml.c6i.4xlarge" || "ml.c6i.12xlarge" || "ml.c6i.16xlarge" || "ml.c6i.24xlarge" || "ml.c6i.32xlarge" || "ml.r5d.large" || "ml.r5d.xlarge" || "ml.r5d.2xlarge" || "ml.r5d.4xlarge" || "ml.r5d.8xlarge" || "ml.r5d.12xlarge" || "ml.r5d.16xlarge" || "ml.r5d.24xlarge" || "ml.t3.medium" || "ml.t3.large" || "ml.t3.xlarge" || "ml.t3.2xlarge" || "ml.r5.large" || "ml.r5.xlarge" || "ml.r5.2xlarge" || "ml.r5.4xlarge" || "ml.r5.8xlarge" || "ml.r5.12xlarge" || "ml.r5.16xlarge" || "ml.r5.24xlarge", + * // "ml.m4.xlarge" || "ml.m4.2xlarge" || "ml.m4.4xlarge" || "ml.m4.10xlarge" || "ml.m4.16xlarge" || "ml.g4dn.xlarge" || "ml.g4dn.2xlarge" || "ml.g4dn.4xlarge" || "ml.g4dn.8xlarge" || "ml.g4dn.12xlarge" || "ml.g4dn.16xlarge" || "ml.m5.large" || "ml.m5.xlarge" || "ml.m5.2xlarge" || "ml.m5.4xlarge" || "ml.m5.12xlarge" || "ml.m5.24xlarge" || "ml.c4.xlarge" || "ml.c4.2xlarge" || "ml.c4.4xlarge" || "ml.c4.8xlarge" || "ml.p2.xlarge" || "ml.p2.8xlarge" || "ml.p2.16xlarge" || "ml.p3.2xlarge" || "ml.p3.8xlarge" || "ml.p3.16xlarge" || "ml.p3dn.24xlarge" || "ml.p4d.24xlarge" || "ml.p4de.24xlarge" || "ml.p5.48xlarge" || "ml.p5e.48xlarge" || "ml.p5en.48xlarge" || "ml.c5.xlarge" || "ml.c5.2xlarge" || "ml.c5.4xlarge" || "ml.c5.9xlarge" || "ml.c5.18xlarge" || "ml.c5n.xlarge" || "ml.c5n.2xlarge" || "ml.c5n.4xlarge" || "ml.c5n.9xlarge" || "ml.c5n.18xlarge" || "ml.g5.xlarge" || "ml.g5.2xlarge" || "ml.g5.4xlarge" || "ml.g5.8xlarge" || "ml.g5.16xlarge" || "ml.g5.12xlarge" || "ml.g5.24xlarge" || "ml.g5.48xlarge" || "ml.g6.xlarge" || "ml.g6.2xlarge" || "ml.g6.4xlarge" || "ml.g6.8xlarge" || "ml.g6.16xlarge" || "ml.g6.12xlarge" || "ml.g6.24xlarge" || "ml.g6.48xlarge" || "ml.g6e.xlarge" || "ml.g6e.2xlarge" || "ml.g6e.4xlarge" || "ml.g6e.8xlarge" || "ml.g6e.16xlarge" || "ml.g6e.12xlarge" || "ml.g6e.24xlarge" || "ml.g6e.48xlarge" || "ml.trn1.2xlarge" || "ml.trn1.32xlarge" || "ml.trn1n.32xlarge" || "ml.trn2.48xlarge" || "ml.m6i.large" || "ml.m6i.xlarge" || "ml.m6i.2xlarge" || "ml.m6i.4xlarge" || "ml.m6i.8xlarge" || "ml.m6i.12xlarge" || "ml.m6i.16xlarge" || "ml.m6i.24xlarge" || "ml.m6i.32xlarge" || "ml.c6i.xlarge" || "ml.c6i.2xlarge" || "ml.c6i.8xlarge" || "ml.c6i.4xlarge" || "ml.c6i.12xlarge" || "ml.c6i.16xlarge" || "ml.c6i.24xlarge" || "ml.c6i.32xlarge" || "ml.r5d.large" || "ml.r5d.xlarge" || "ml.r5d.2xlarge" || "ml.r5d.4xlarge" || "ml.r5d.8xlarge" || "ml.r5d.12xlarge" || "ml.r5d.16xlarge" || "ml.r5d.24xlarge" || "ml.t3.medium" || "ml.t3.large" || "ml.t3.xlarge" || "ml.t3.2xlarge" || "ml.r5.large" || "ml.r5.xlarge" || "ml.r5.2xlarge" || "ml.r5.4xlarge" || "ml.r5.8xlarge" || "ml.r5.12xlarge" || "ml.r5.16xlarge" || "ml.r5.24xlarge", * // ], * // SupportsDistributedTraining: true || false, * // MetricDefinitions: [ // MetricDefinitionList @@ -209,18 +209,19 @@ export interface DescribeAlgorithmCommandOutput extends DescribeAlgorithmOutput, * // CompressionType: "GZIP" || "NONE", * // }, * // ResourceConfig: { // ResourceConfig - * // InstanceType: "ml.m4.xlarge" || "ml.m4.2xlarge" || "ml.m4.4xlarge" || "ml.m4.10xlarge" || "ml.m4.16xlarge" || "ml.g4dn.xlarge" || "ml.g4dn.2xlarge" || "ml.g4dn.4xlarge" || "ml.g4dn.8xlarge" || "ml.g4dn.12xlarge" || "ml.g4dn.16xlarge" || "ml.m5.large" || "ml.m5.xlarge" || "ml.m5.2xlarge" || "ml.m5.4xlarge" || "ml.m5.12xlarge" || "ml.m5.24xlarge" || "ml.c4.xlarge" || "ml.c4.2xlarge" || "ml.c4.4xlarge" || "ml.c4.8xlarge" || "ml.p2.xlarge" || "ml.p2.8xlarge" || "ml.p2.16xlarge" || "ml.p3.2xlarge" || "ml.p3.8xlarge" || "ml.p3.16xlarge" || "ml.p3dn.24xlarge" || "ml.p4d.24xlarge" || "ml.p4de.24xlarge" || "ml.p5.48xlarge" || "ml.p5e.48xlarge" || "ml.c5.xlarge" || "ml.c5.2xlarge" || "ml.c5.4xlarge" || "ml.c5.9xlarge" || "ml.c5.18xlarge" || "ml.c5n.xlarge" || "ml.c5n.2xlarge" || "ml.c5n.4xlarge" || "ml.c5n.9xlarge" || "ml.c5n.18xlarge" || "ml.g5.xlarge" || "ml.g5.2xlarge" || "ml.g5.4xlarge" || "ml.g5.8xlarge" || "ml.g5.16xlarge" || "ml.g5.12xlarge" || "ml.g5.24xlarge" || "ml.g5.48xlarge" || "ml.g6.xlarge" || "ml.g6.2xlarge" || "ml.g6.4xlarge" || "ml.g6.8xlarge" || "ml.g6.16xlarge" || "ml.g6.12xlarge" || "ml.g6.24xlarge" || "ml.g6.48xlarge" || "ml.g6e.xlarge" || "ml.g6e.2xlarge" || "ml.g6e.4xlarge" || "ml.g6e.8xlarge" || "ml.g6e.16xlarge" || "ml.g6e.12xlarge" || "ml.g6e.24xlarge" || "ml.g6e.48xlarge" || "ml.trn1.2xlarge" || "ml.trn1.32xlarge" || "ml.trn1n.32xlarge" || "ml.m6i.large" || "ml.m6i.xlarge" || "ml.m6i.2xlarge" || "ml.m6i.4xlarge" || "ml.m6i.8xlarge" || "ml.m6i.12xlarge" || "ml.m6i.16xlarge" || "ml.m6i.24xlarge" || "ml.m6i.32xlarge" || "ml.c6i.xlarge" || "ml.c6i.2xlarge" || "ml.c6i.8xlarge" || "ml.c6i.4xlarge" || "ml.c6i.12xlarge" || "ml.c6i.16xlarge" || "ml.c6i.24xlarge" || "ml.c6i.32xlarge" || "ml.r5d.large" || "ml.r5d.xlarge" || "ml.r5d.2xlarge" || "ml.r5d.4xlarge" || "ml.r5d.8xlarge" || "ml.r5d.12xlarge" || "ml.r5d.16xlarge" || "ml.r5d.24xlarge" || "ml.t3.medium" || "ml.t3.large" || "ml.t3.xlarge" || "ml.t3.2xlarge" || "ml.r5.large" || "ml.r5.xlarge" || "ml.r5.2xlarge" || "ml.r5.4xlarge" || "ml.r5.8xlarge" || "ml.r5.12xlarge" || "ml.r5.16xlarge" || "ml.r5.24xlarge", + * // InstanceType: "ml.m4.xlarge" || "ml.m4.2xlarge" || "ml.m4.4xlarge" || "ml.m4.10xlarge" || "ml.m4.16xlarge" || "ml.g4dn.xlarge" || "ml.g4dn.2xlarge" || "ml.g4dn.4xlarge" || "ml.g4dn.8xlarge" || "ml.g4dn.12xlarge" || "ml.g4dn.16xlarge" || "ml.m5.large" || "ml.m5.xlarge" || "ml.m5.2xlarge" || "ml.m5.4xlarge" || "ml.m5.12xlarge" || "ml.m5.24xlarge" || "ml.c4.xlarge" || "ml.c4.2xlarge" || "ml.c4.4xlarge" || "ml.c4.8xlarge" || "ml.p2.xlarge" || "ml.p2.8xlarge" || "ml.p2.16xlarge" || "ml.p3.2xlarge" || "ml.p3.8xlarge" || "ml.p3.16xlarge" || "ml.p3dn.24xlarge" || "ml.p4d.24xlarge" || "ml.p4de.24xlarge" || "ml.p5.48xlarge" || "ml.p5e.48xlarge" || "ml.p5en.48xlarge" || "ml.c5.xlarge" || "ml.c5.2xlarge" || "ml.c5.4xlarge" || "ml.c5.9xlarge" || "ml.c5.18xlarge" || "ml.c5n.xlarge" || "ml.c5n.2xlarge" || "ml.c5n.4xlarge" || "ml.c5n.9xlarge" || "ml.c5n.18xlarge" || "ml.g5.xlarge" || "ml.g5.2xlarge" || "ml.g5.4xlarge" || "ml.g5.8xlarge" || "ml.g5.16xlarge" || "ml.g5.12xlarge" || "ml.g5.24xlarge" || "ml.g5.48xlarge" || "ml.g6.xlarge" || "ml.g6.2xlarge" || "ml.g6.4xlarge" || "ml.g6.8xlarge" || "ml.g6.16xlarge" || "ml.g6.12xlarge" || "ml.g6.24xlarge" || "ml.g6.48xlarge" || "ml.g6e.xlarge" || "ml.g6e.2xlarge" || "ml.g6e.4xlarge" || "ml.g6e.8xlarge" || "ml.g6e.16xlarge" || "ml.g6e.12xlarge" || "ml.g6e.24xlarge" || "ml.g6e.48xlarge" || "ml.trn1.2xlarge" || "ml.trn1.32xlarge" || "ml.trn1n.32xlarge" || "ml.trn2.48xlarge" || "ml.m6i.large" || "ml.m6i.xlarge" || "ml.m6i.2xlarge" || "ml.m6i.4xlarge" || "ml.m6i.8xlarge" || "ml.m6i.12xlarge" || "ml.m6i.16xlarge" || "ml.m6i.24xlarge" || "ml.m6i.32xlarge" || "ml.c6i.xlarge" || "ml.c6i.2xlarge" || "ml.c6i.8xlarge" || "ml.c6i.4xlarge" || "ml.c6i.12xlarge" || "ml.c6i.16xlarge" || "ml.c6i.24xlarge" || "ml.c6i.32xlarge" || "ml.r5d.large" || "ml.r5d.xlarge" || "ml.r5d.2xlarge" || "ml.r5d.4xlarge" || "ml.r5d.8xlarge" || "ml.r5d.12xlarge" || "ml.r5d.16xlarge" || "ml.r5d.24xlarge" || "ml.t3.medium" || "ml.t3.large" || "ml.t3.xlarge" || "ml.t3.2xlarge" || "ml.r5.large" || "ml.r5.xlarge" || "ml.r5.2xlarge" || "ml.r5.4xlarge" || "ml.r5.8xlarge" || "ml.r5.12xlarge" || "ml.r5.16xlarge" || "ml.r5.24xlarge", * // InstanceCount: Number("int"), * // VolumeSizeInGB: Number("int"), // required * // VolumeKmsKeyId: "STRING_VALUE", * // KeepAlivePeriodInSeconds: Number("int"), * // InstanceGroups: [ // InstanceGroups * // { // InstanceGroup - * // InstanceType: "ml.m4.xlarge" || "ml.m4.2xlarge" || "ml.m4.4xlarge" || "ml.m4.10xlarge" || "ml.m4.16xlarge" || "ml.g4dn.xlarge" || "ml.g4dn.2xlarge" || "ml.g4dn.4xlarge" || "ml.g4dn.8xlarge" || "ml.g4dn.12xlarge" || "ml.g4dn.16xlarge" || "ml.m5.large" || "ml.m5.xlarge" || "ml.m5.2xlarge" || "ml.m5.4xlarge" || "ml.m5.12xlarge" || "ml.m5.24xlarge" || "ml.c4.xlarge" || "ml.c4.2xlarge" || "ml.c4.4xlarge" || "ml.c4.8xlarge" || "ml.p2.xlarge" || "ml.p2.8xlarge" || "ml.p2.16xlarge" || "ml.p3.2xlarge" || "ml.p3.8xlarge" || "ml.p3.16xlarge" || "ml.p3dn.24xlarge" || "ml.p4d.24xlarge" || "ml.p4de.24xlarge" || "ml.p5.48xlarge" || "ml.p5e.48xlarge" || "ml.c5.xlarge" || "ml.c5.2xlarge" || "ml.c5.4xlarge" || "ml.c5.9xlarge" || "ml.c5.18xlarge" || "ml.c5n.xlarge" || "ml.c5n.2xlarge" || "ml.c5n.4xlarge" || "ml.c5n.9xlarge" || "ml.c5n.18xlarge" || "ml.g5.xlarge" || "ml.g5.2xlarge" || "ml.g5.4xlarge" || "ml.g5.8xlarge" || "ml.g5.16xlarge" || "ml.g5.12xlarge" || "ml.g5.24xlarge" || "ml.g5.48xlarge" || "ml.g6.xlarge" || "ml.g6.2xlarge" || "ml.g6.4xlarge" || "ml.g6.8xlarge" || "ml.g6.16xlarge" || "ml.g6.12xlarge" || "ml.g6.24xlarge" || "ml.g6.48xlarge" || "ml.g6e.xlarge" || "ml.g6e.2xlarge" || "ml.g6e.4xlarge" || "ml.g6e.8xlarge" || "ml.g6e.16xlarge" || "ml.g6e.12xlarge" || "ml.g6e.24xlarge" || "ml.g6e.48xlarge" || "ml.trn1.2xlarge" || "ml.trn1.32xlarge" || "ml.trn1n.32xlarge" || "ml.m6i.large" || "ml.m6i.xlarge" || "ml.m6i.2xlarge" || "ml.m6i.4xlarge" || "ml.m6i.8xlarge" || "ml.m6i.12xlarge" || "ml.m6i.16xlarge" || "ml.m6i.24xlarge" || "ml.m6i.32xlarge" || "ml.c6i.xlarge" || "ml.c6i.2xlarge" || "ml.c6i.8xlarge" || "ml.c6i.4xlarge" || "ml.c6i.12xlarge" || "ml.c6i.16xlarge" || "ml.c6i.24xlarge" || "ml.c6i.32xlarge" || "ml.r5d.large" || "ml.r5d.xlarge" || "ml.r5d.2xlarge" || "ml.r5d.4xlarge" || "ml.r5d.8xlarge" || "ml.r5d.12xlarge" || "ml.r5d.16xlarge" || "ml.r5d.24xlarge" || "ml.t3.medium" || "ml.t3.large" || "ml.t3.xlarge" || "ml.t3.2xlarge" || "ml.r5.large" || "ml.r5.xlarge" || "ml.r5.2xlarge" || "ml.r5.4xlarge" || "ml.r5.8xlarge" || "ml.r5.12xlarge" || "ml.r5.16xlarge" || "ml.r5.24xlarge", // required + * // InstanceType: "ml.m4.xlarge" || "ml.m4.2xlarge" || "ml.m4.4xlarge" || "ml.m4.10xlarge" || "ml.m4.16xlarge" || "ml.g4dn.xlarge" || "ml.g4dn.2xlarge" || "ml.g4dn.4xlarge" || "ml.g4dn.8xlarge" || "ml.g4dn.12xlarge" || "ml.g4dn.16xlarge" || "ml.m5.large" || "ml.m5.xlarge" || "ml.m5.2xlarge" || "ml.m5.4xlarge" || "ml.m5.12xlarge" || "ml.m5.24xlarge" || "ml.c4.xlarge" || "ml.c4.2xlarge" || "ml.c4.4xlarge" || "ml.c4.8xlarge" || "ml.p2.xlarge" || "ml.p2.8xlarge" || "ml.p2.16xlarge" || "ml.p3.2xlarge" || "ml.p3.8xlarge" || "ml.p3.16xlarge" || "ml.p3dn.24xlarge" || "ml.p4d.24xlarge" || "ml.p4de.24xlarge" || "ml.p5.48xlarge" || "ml.p5e.48xlarge" || "ml.p5en.48xlarge" || "ml.c5.xlarge" || "ml.c5.2xlarge" || "ml.c5.4xlarge" || "ml.c5.9xlarge" || "ml.c5.18xlarge" || "ml.c5n.xlarge" || "ml.c5n.2xlarge" || "ml.c5n.4xlarge" || "ml.c5n.9xlarge" || "ml.c5n.18xlarge" || "ml.g5.xlarge" || "ml.g5.2xlarge" || "ml.g5.4xlarge" || "ml.g5.8xlarge" || "ml.g5.16xlarge" || "ml.g5.12xlarge" || "ml.g5.24xlarge" || "ml.g5.48xlarge" || "ml.g6.xlarge" || "ml.g6.2xlarge" || "ml.g6.4xlarge" || "ml.g6.8xlarge" || "ml.g6.16xlarge" || "ml.g6.12xlarge" || "ml.g6.24xlarge" || "ml.g6.48xlarge" || "ml.g6e.xlarge" || "ml.g6e.2xlarge" || "ml.g6e.4xlarge" || "ml.g6e.8xlarge" || "ml.g6e.16xlarge" || "ml.g6e.12xlarge" || "ml.g6e.24xlarge" || "ml.g6e.48xlarge" || "ml.trn1.2xlarge" || "ml.trn1.32xlarge" || "ml.trn1n.32xlarge" || "ml.trn2.48xlarge" || "ml.m6i.large" || "ml.m6i.xlarge" || "ml.m6i.2xlarge" || "ml.m6i.4xlarge" || "ml.m6i.8xlarge" || "ml.m6i.12xlarge" || "ml.m6i.16xlarge" || "ml.m6i.24xlarge" || "ml.m6i.32xlarge" || "ml.c6i.xlarge" || "ml.c6i.2xlarge" || "ml.c6i.8xlarge" || "ml.c6i.4xlarge" || "ml.c6i.12xlarge" || "ml.c6i.16xlarge" || "ml.c6i.24xlarge" || "ml.c6i.32xlarge" || "ml.r5d.large" || "ml.r5d.xlarge" || "ml.r5d.2xlarge" || "ml.r5d.4xlarge" || "ml.r5d.8xlarge" || "ml.r5d.12xlarge" || "ml.r5d.16xlarge" || "ml.r5d.24xlarge" || "ml.t3.medium" || "ml.t3.large" || "ml.t3.xlarge" || "ml.t3.2xlarge" || "ml.r5.large" || "ml.r5.xlarge" || "ml.r5.2xlarge" || "ml.r5.4xlarge" || "ml.r5.8xlarge" || "ml.r5.12xlarge" || "ml.r5.16xlarge" || "ml.r5.24xlarge", // required * // InstanceCount: Number("int"), // required * // InstanceGroupName: "STRING_VALUE", // required * // }, * // ], + * // TrainingPlanArn: "STRING_VALUE", * // }, * // StoppingCondition: { // StoppingCondition * // MaxRuntimeInSeconds: Number("int"), diff --git a/clients/client-sagemaker/src/commands/DescribeClusterCommand.ts b/clients/client-sagemaker/src/commands/DescribeClusterCommand.ts index 3009938f0d30..f562aaf36eb4 100644 --- a/clients/client-sagemaker/src/commands/DescribeClusterCommand.ts +++ b/clients/client-sagemaker/src/commands/DescribeClusterCommand.ts @@ -51,7 +51,7 @@ export interface DescribeClusterCommandOutput extends DescribeClusterResponse, _ * // CurrentCount: Number("int"), * // TargetCount: Number("int"), * // InstanceGroupName: "STRING_VALUE", - * // InstanceType: "ml.p4d.24xlarge" || "ml.p4de.24xlarge" || "ml.p5.48xlarge" || "ml.trn1.32xlarge" || "ml.trn1n.32xlarge" || "ml.g5.xlarge" || "ml.g5.2xlarge" || "ml.g5.4xlarge" || "ml.g5.8xlarge" || "ml.g5.12xlarge" || "ml.g5.16xlarge" || "ml.g5.24xlarge" || "ml.g5.48xlarge" || "ml.c5.large" || "ml.c5.xlarge" || "ml.c5.2xlarge" || "ml.c5.4xlarge" || "ml.c5.9xlarge" || "ml.c5.12xlarge" || "ml.c5.18xlarge" || "ml.c5.24xlarge" || "ml.c5n.large" || "ml.c5n.2xlarge" || "ml.c5n.4xlarge" || "ml.c5n.9xlarge" || "ml.c5n.18xlarge" || "ml.m5.large" || "ml.m5.xlarge" || "ml.m5.2xlarge" || "ml.m5.4xlarge" || "ml.m5.8xlarge" || "ml.m5.12xlarge" || "ml.m5.16xlarge" || "ml.m5.24xlarge" || "ml.t3.medium" || "ml.t3.large" || "ml.t3.xlarge" || "ml.t3.2xlarge" || "ml.g6.xlarge" || "ml.g6.2xlarge" || "ml.g6.4xlarge" || "ml.g6.8xlarge" || "ml.g6.16xlarge" || "ml.g6.12xlarge" || "ml.g6.24xlarge" || "ml.g6.48xlarge" || "ml.gr6.4xlarge" || "ml.gr6.8xlarge" || "ml.g6e.xlarge" || "ml.g6e.2xlarge" || "ml.g6e.4xlarge" || "ml.g6e.8xlarge" || "ml.g6e.16xlarge" || "ml.g6e.12xlarge" || "ml.g6e.24xlarge" || "ml.g6e.48xlarge" || "ml.p5e.48xlarge", + * // InstanceType: "ml.p4d.24xlarge" || "ml.p4de.24xlarge" || "ml.p5.48xlarge" || "ml.trn1.32xlarge" || "ml.trn1n.32xlarge" || "ml.g5.xlarge" || "ml.g5.2xlarge" || "ml.g5.4xlarge" || "ml.g5.8xlarge" || "ml.g5.12xlarge" || "ml.g5.16xlarge" || "ml.g5.24xlarge" || "ml.g5.48xlarge" || "ml.c5.large" || "ml.c5.xlarge" || "ml.c5.2xlarge" || "ml.c5.4xlarge" || "ml.c5.9xlarge" || "ml.c5.12xlarge" || "ml.c5.18xlarge" || "ml.c5.24xlarge" || "ml.c5n.large" || "ml.c5n.2xlarge" || "ml.c5n.4xlarge" || "ml.c5n.9xlarge" || "ml.c5n.18xlarge" || "ml.m5.large" || "ml.m5.xlarge" || "ml.m5.2xlarge" || "ml.m5.4xlarge" || "ml.m5.8xlarge" || "ml.m5.12xlarge" || "ml.m5.16xlarge" || "ml.m5.24xlarge" || "ml.t3.medium" || "ml.t3.large" || "ml.t3.xlarge" || "ml.t3.2xlarge" || "ml.g6.xlarge" || "ml.g6.2xlarge" || "ml.g6.4xlarge" || "ml.g6.8xlarge" || "ml.g6.16xlarge" || "ml.g6.12xlarge" || "ml.g6.24xlarge" || "ml.g6.48xlarge" || "ml.gr6.4xlarge" || "ml.gr6.8xlarge" || "ml.g6e.xlarge" || "ml.g6e.2xlarge" || "ml.g6e.4xlarge" || "ml.g6e.8xlarge" || "ml.g6e.16xlarge" || "ml.g6e.12xlarge" || "ml.g6e.24xlarge" || "ml.g6e.48xlarge" || "ml.p5e.48xlarge" || "ml.p5en.48xlarge" || "ml.trn2.48xlarge", * // LifeCycleConfig: { // ClusterLifeCycleConfig * // SourceS3Uri: "STRING_VALUE", // required * // OnCreate: "STRING_VALUE", // required @@ -68,6 +68,9 @@ export interface DescribeClusterCommandOutput extends DescribeClusterResponse, _ * // OnStartDeepHealthChecks: [ // OnStartDeepHealthChecks * // "InstanceStress" || "InstanceConnectivity", * // ], + * // Status: "InService" || "Creating" || "Updating" || "Failed" || "Degraded" || "SystemUpdating" || "Deleting", + * // TrainingPlanArn: "STRING_VALUE", + * // TrainingPlanStatus: "STRING_VALUE", * // OverrideVpcConfig: { // VpcConfig * // SecurityGroupIds: [ // VpcSecurityGroupIds // required * // "STRING_VALUE", diff --git a/clients/client-sagemaker/src/commands/DescribeClusterNodeCommand.ts b/clients/client-sagemaker/src/commands/DescribeClusterNodeCommand.ts index 0c45fe3746eb..225a36e4103a 100644 --- a/clients/client-sagemaker/src/commands/DescribeClusterNodeCommand.ts +++ b/clients/client-sagemaker/src/commands/DescribeClusterNodeCommand.ts @@ -50,7 +50,7 @@ export interface DescribeClusterNodeCommandOutput extends DescribeClusterNodeRes * // Status: "Running" || "Failure" || "Pending" || "ShuttingDown" || "SystemUpdating" || "DeepHealthCheckInProgress", // required * // Message: "STRING_VALUE", * // }, - * // InstanceType: "ml.p4d.24xlarge" || "ml.p4de.24xlarge" || "ml.p5.48xlarge" || "ml.trn1.32xlarge" || "ml.trn1n.32xlarge" || "ml.g5.xlarge" || "ml.g5.2xlarge" || "ml.g5.4xlarge" || "ml.g5.8xlarge" || "ml.g5.12xlarge" || "ml.g5.16xlarge" || "ml.g5.24xlarge" || "ml.g5.48xlarge" || "ml.c5.large" || "ml.c5.xlarge" || "ml.c5.2xlarge" || "ml.c5.4xlarge" || "ml.c5.9xlarge" || "ml.c5.12xlarge" || "ml.c5.18xlarge" || "ml.c5.24xlarge" || "ml.c5n.large" || "ml.c5n.2xlarge" || "ml.c5n.4xlarge" || "ml.c5n.9xlarge" || "ml.c5n.18xlarge" || "ml.m5.large" || "ml.m5.xlarge" || "ml.m5.2xlarge" || "ml.m5.4xlarge" || "ml.m5.8xlarge" || "ml.m5.12xlarge" || "ml.m5.16xlarge" || "ml.m5.24xlarge" || "ml.t3.medium" || "ml.t3.large" || "ml.t3.xlarge" || "ml.t3.2xlarge" || "ml.g6.xlarge" || "ml.g6.2xlarge" || "ml.g6.4xlarge" || "ml.g6.8xlarge" || "ml.g6.16xlarge" || "ml.g6.12xlarge" || "ml.g6.24xlarge" || "ml.g6.48xlarge" || "ml.gr6.4xlarge" || "ml.gr6.8xlarge" || "ml.g6e.xlarge" || "ml.g6e.2xlarge" || "ml.g6e.4xlarge" || "ml.g6e.8xlarge" || "ml.g6e.16xlarge" || "ml.g6e.12xlarge" || "ml.g6e.24xlarge" || "ml.g6e.48xlarge" || "ml.p5e.48xlarge", + * // InstanceType: "ml.p4d.24xlarge" || "ml.p4de.24xlarge" || "ml.p5.48xlarge" || "ml.trn1.32xlarge" || "ml.trn1n.32xlarge" || "ml.g5.xlarge" || "ml.g5.2xlarge" || "ml.g5.4xlarge" || "ml.g5.8xlarge" || "ml.g5.12xlarge" || "ml.g5.16xlarge" || "ml.g5.24xlarge" || "ml.g5.48xlarge" || "ml.c5.large" || "ml.c5.xlarge" || "ml.c5.2xlarge" || "ml.c5.4xlarge" || "ml.c5.9xlarge" || "ml.c5.12xlarge" || "ml.c5.18xlarge" || "ml.c5.24xlarge" || "ml.c5n.large" || "ml.c5n.2xlarge" || "ml.c5n.4xlarge" || "ml.c5n.9xlarge" || "ml.c5n.18xlarge" || "ml.m5.large" || "ml.m5.xlarge" || "ml.m5.2xlarge" || "ml.m5.4xlarge" || "ml.m5.8xlarge" || "ml.m5.12xlarge" || "ml.m5.16xlarge" || "ml.m5.24xlarge" || "ml.t3.medium" || "ml.t3.large" || "ml.t3.xlarge" || "ml.t3.2xlarge" || "ml.g6.xlarge" || "ml.g6.2xlarge" || "ml.g6.4xlarge" || "ml.g6.8xlarge" || "ml.g6.16xlarge" || "ml.g6.12xlarge" || "ml.g6.24xlarge" || "ml.g6.48xlarge" || "ml.gr6.4xlarge" || "ml.gr6.8xlarge" || "ml.g6e.xlarge" || "ml.g6e.2xlarge" || "ml.g6e.4xlarge" || "ml.g6e.8xlarge" || "ml.g6e.16xlarge" || "ml.g6e.12xlarge" || "ml.g6e.24xlarge" || "ml.g6e.48xlarge" || "ml.p5e.48xlarge" || "ml.p5en.48xlarge" || "ml.trn2.48xlarge", * // LaunchTime: new Date("TIMESTAMP"), * // LifeCycleConfig: { // ClusterLifeCycleConfig * // SourceS3Uri: "STRING_VALUE", // required diff --git a/clients/client-sagemaker/src/commands/DescribeClusterSchedulerConfigCommand.ts b/clients/client-sagemaker/src/commands/DescribeClusterSchedulerConfigCommand.ts new file mode 100644 index 000000000000..5efdcdb7d50f --- /dev/null +++ b/clients/client-sagemaker/src/commands/DescribeClusterSchedulerConfigCommand.ts @@ -0,0 +1,141 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { commonParams } from "../endpoint/EndpointParameters"; +import { DescribeClusterSchedulerConfigRequest, DescribeClusterSchedulerConfigResponse } from "../models/models_2"; +import { + de_DescribeClusterSchedulerConfigCommand, + se_DescribeClusterSchedulerConfigCommand, +} from "../protocols/Aws_json1_1"; +import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link DescribeClusterSchedulerConfigCommand}. + */ +export interface DescribeClusterSchedulerConfigCommandInput extends DescribeClusterSchedulerConfigRequest {} +/** + * @public + * + * The output of {@link DescribeClusterSchedulerConfigCommand}. + */ +export interface DescribeClusterSchedulerConfigCommandOutput + extends DescribeClusterSchedulerConfigResponse, + __MetadataBearer {} + +/** + *Description of the cluster policy. This policy is used for task prioritization and + * fair-share allocation. This helps prioritize critical workloads and distributes + * idle compute across entities.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, DescribeClusterSchedulerConfigCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, DescribeClusterSchedulerConfigCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const input = { // DescribeClusterSchedulerConfigRequest + * ClusterSchedulerConfigId: "STRING_VALUE", // required + * ClusterSchedulerConfigVersion: Number("int"), + * }; + * const command = new DescribeClusterSchedulerConfigCommand(input); + * const response = await client.send(command); + * // { // DescribeClusterSchedulerConfigResponse + * // ClusterSchedulerConfigArn: "STRING_VALUE", // required + * // ClusterSchedulerConfigId: "STRING_VALUE", // required + * // Name: "STRING_VALUE", // required + * // ClusterSchedulerConfigVersion: Number("int"), // required + * // Status: "Creating" || "CreateFailed" || "CreateRollbackFailed" || "Created" || "Updating" || "UpdateFailed" || "UpdateRollbackFailed" || "Updated" || "Deleting" || "DeleteFailed" || "DeleteRollbackFailed" || "Deleted", // required + * // FailureReason: "STRING_VALUE", + * // ClusterArn: "STRING_VALUE", + * // SchedulerConfig: { // SchedulerConfig + * // PriorityClasses: [ // PriorityClassList + * // { // PriorityClass + * // Name: "STRING_VALUE", // required + * // Weight: Number("int"), // required + * // }, + * // ], + * // FairShare: "Enabled" || "Disabled", + * // }, + * // Description: "STRING_VALUE", + * // CreationTime: new Date("TIMESTAMP"), // required + * // CreatedBy: { // UserContext + * // UserProfileArn: "STRING_VALUE", + * // UserProfileName: "STRING_VALUE", + * // DomainId: "STRING_VALUE", + * // IamIdentity: { // IamIdentity + * // Arn: "STRING_VALUE", + * // PrincipalId: "STRING_VALUE", + * // SourceIdentity: "STRING_VALUE", + * // }, + * // }, + * // LastModifiedTime: new Date("TIMESTAMP"), + * // LastModifiedBy: { + * // UserProfileArn: "STRING_VALUE", + * // UserProfileName: "STRING_VALUE", + * // DomainId: "STRING_VALUE", + * // IamIdentity: { + * // Arn: "STRING_VALUE", + * // PrincipalId: "STRING_VALUE", + * // SourceIdentity: "STRING_VALUE", + * // }, + * // }, + * // }; + * + * ``` + * + * @param DescribeClusterSchedulerConfigCommandInput - {@link DescribeClusterSchedulerConfigCommandInput} + * @returns {@link DescribeClusterSchedulerConfigCommandOutput} + * @see {@link DescribeClusterSchedulerConfigCommandInput} for command's `input` shape. + * @see {@link DescribeClusterSchedulerConfigCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for SageMakerClient's `config` shape. + * + * @throws {@link ResourceNotFound} (client fault) + *Resource being access is not found.
+ * + * @throws {@link SageMakerServiceException} + *Base exception class for all service exceptions from SageMaker service.
+ * + * @public + */ +export class DescribeClusterSchedulerConfigCommand extends $Command + .classBuilder< + DescribeClusterSchedulerConfigCommandInput, + DescribeClusterSchedulerConfigCommandOutput, + SageMakerClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: SageMakerClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("SageMaker", "DescribeClusterSchedulerConfig", {}) + .n("SageMakerClient", "DescribeClusterSchedulerConfigCommand") + .f(void 0, void 0) + .ser(se_DescribeClusterSchedulerConfigCommand) + .de(de_DescribeClusterSchedulerConfigCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: DescribeClusterSchedulerConfigRequest; + output: DescribeClusterSchedulerConfigResponse; + }; + sdk: { + input: DescribeClusterSchedulerConfigCommandInput; + output: DescribeClusterSchedulerConfigCommandOutput; + }; + }; +} diff --git a/clients/client-sagemaker/src/commands/DescribeComputeQuotaCommand.ts b/clients/client-sagemaker/src/commands/DescribeComputeQuotaCommand.ts new file mode 100644 index 000000000000..ccafe6497616 --- /dev/null +++ b/clients/client-sagemaker/src/commands/DescribeComputeQuotaCommand.ts @@ -0,0 +1,143 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { commonParams } from "../endpoint/EndpointParameters"; +import { DescribeComputeQuotaRequest, DescribeComputeQuotaResponse } from "../models/models_2"; +import { de_DescribeComputeQuotaCommand, se_DescribeComputeQuotaCommand } from "../protocols/Aws_json1_1"; +import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link DescribeComputeQuotaCommand}. + */ +export interface DescribeComputeQuotaCommandInput extends DescribeComputeQuotaRequest {} +/** + * @public + * + * The output of {@link DescribeComputeQuotaCommand}. + */ +export interface DescribeComputeQuotaCommandOutput extends DescribeComputeQuotaResponse, __MetadataBearer {} + +/** + *Description of the compute allocation definition.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, DescribeComputeQuotaCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, DescribeComputeQuotaCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const input = { // DescribeComputeQuotaRequest + * ComputeQuotaId: "STRING_VALUE", // required + * ComputeQuotaVersion: Number("int"), + * }; + * const command = new DescribeComputeQuotaCommand(input); + * const response = await client.send(command); + * // { // DescribeComputeQuotaResponse + * // ComputeQuotaArn: "STRING_VALUE", // required + * // ComputeQuotaId: "STRING_VALUE", // required + * // Name: "STRING_VALUE", // required + * // Description: "STRING_VALUE", + * // ComputeQuotaVersion: Number("int"), // required + * // Status: "Creating" || "CreateFailed" || "CreateRollbackFailed" || "Created" || "Updating" || "UpdateFailed" || "UpdateRollbackFailed" || "Updated" || "Deleting" || "DeleteFailed" || "DeleteRollbackFailed" || "Deleted", // required + * // FailureReason: "STRING_VALUE", + * // ClusterArn: "STRING_VALUE", + * // ComputeQuotaConfig: { // ComputeQuotaConfig + * // ComputeQuotaResources: [ // ComputeQuotaResourceConfigList + * // { // ComputeQuotaResourceConfig + * // InstanceType: "ml.p4d.24xlarge" || "ml.p4de.24xlarge" || "ml.p5.48xlarge" || "ml.trn1.32xlarge" || "ml.trn1n.32xlarge" || "ml.g5.xlarge" || "ml.g5.2xlarge" || "ml.g5.4xlarge" || "ml.g5.8xlarge" || "ml.g5.12xlarge" || "ml.g5.16xlarge" || "ml.g5.24xlarge" || "ml.g5.48xlarge" || "ml.c5.large" || "ml.c5.xlarge" || "ml.c5.2xlarge" || "ml.c5.4xlarge" || "ml.c5.9xlarge" || "ml.c5.12xlarge" || "ml.c5.18xlarge" || "ml.c5.24xlarge" || "ml.c5n.large" || "ml.c5n.2xlarge" || "ml.c5n.4xlarge" || "ml.c5n.9xlarge" || "ml.c5n.18xlarge" || "ml.m5.large" || "ml.m5.xlarge" || "ml.m5.2xlarge" || "ml.m5.4xlarge" || "ml.m5.8xlarge" || "ml.m5.12xlarge" || "ml.m5.16xlarge" || "ml.m5.24xlarge" || "ml.t3.medium" || "ml.t3.large" || "ml.t3.xlarge" || "ml.t3.2xlarge" || "ml.g6.xlarge" || "ml.g6.2xlarge" || "ml.g6.4xlarge" || "ml.g6.8xlarge" || "ml.g6.16xlarge" || "ml.g6.12xlarge" || "ml.g6.24xlarge" || "ml.g6.48xlarge" || "ml.gr6.4xlarge" || "ml.gr6.8xlarge" || "ml.g6e.xlarge" || "ml.g6e.2xlarge" || "ml.g6e.4xlarge" || "ml.g6e.8xlarge" || "ml.g6e.16xlarge" || "ml.g6e.12xlarge" || "ml.g6e.24xlarge" || "ml.g6e.48xlarge" || "ml.p5e.48xlarge" || "ml.p5en.48xlarge" || "ml.trn2.48xlarge", // required + * // Count: Number("int"), // required + * // }, + * // ], + * // ResourceSharingConfig: { // ResourceSharingConfig + * // Strategy: "Lend" || "DontLend" || "LendAndBorrow", // required + * // BorrowLimit: Number("int"), + * // }, + * // PreemptTeamTasks: "Never" || "LowerPriority", + * // }, + * // ComputeQuotaTarget: { // ComputeQuotaTarget + * // TeamName: "STRING_VALUE", // required + * // FairShareWeight: Number("int"), + * // }, + * // ActivationState: "Enabled" || "Disabled", + * // CreationTime: new Date("TIMESTAMP"), // required + * // CreatedBy: { // UserContext + * // UserProfileArn: "STRING_VALUE", + * // UserProfileName: "STRING_VALUE", + * // DomainId: "STRING_VALUE", + * // IamIdentity: { // IamIdentity + * // Arn: "STRING_VALUE", + * // PrincipalId: "STRING_VALUE", + * // SourceIdentity: "STRING_VALUE", + * // }, + * // }, + * // LastModifiedTime: new Date("TIMESTAMP"), + * // LastModifiedBy: { + * // UserProfileArn: "STRING_VALUE", + * // UserProfileName: "STRING_VALUE", + * // DomainId: "STRING_VALUE", + * // IamIdentity: { + * // Arn: "STRING_VALUE", + * // PrincipalId: "STRING_VALUE", + * // SourceIdentity: "STRING_VALUE", + * // }, + * // }, + * // }; + * + * ``` + * + * @param DescribeComputeQuotaCommandInput - {@link DescribeComputeQuotaCommandInput} + * @returns {@link DescribeComputeQuotaCommandOutput} + * @see {@link DescribeComputeQuotaCommandInput} for command's `input` shape. + * @see {@link DescribeComputeQuotaCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for SageMakerClient's `config` shape. + * + * @throws {@link ResourceNotFound} (client fault) + *Resource being access is not found.
+ * + * @throws {@link SageMakerServiceException} + *Base exception class for all service exceptions from SageMaker service.
+ * + * @public + */ +export class DescribeComputeQuotaCommand extends $Command + .classBuilder< + DescribeComputeQuotaCommandInput, + DescribeComputeQuotaCommandOutput, + SageMakerClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: SageMakerClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("SageMaker", "DescribeComputeQuota", {}) + .n("SageMakerClient", "DescribeComputeQuotaCommand") + .f(void 0, void 0) + .ser(se_DescribeComputeQuotaCommand) + .de(de_DescribeComputeQuotaCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: DescribeComputeQuotaRequest; + output: DescribeComputeQuotaResponse; + }; + sdk: { + input: DescribeComputeQuotaCommandInput; + output: DescribeComputeQuotaCommandOutput; + }; + }; +} diff --git a/clients/client-sagemaker/src/commands/DescribeDomainCommand.ts b/clients/client-sagemaker/src/commands/DescribeDomainCommand.ts index 7e424504575a..c5c47c7bb21b 100644 --- a/clients/client-sagemaker/src/commands/DescribeDomainCommand.ts +++ b/clients/client-sagemaker/src/commands/DescribeDomainCommand.ts @@ -243,11 +243,15 @@ export interface DescribeDomainCommandOutput extends DescribeDomainResponse, __M * // FileSystemId: "STRING_VALUE", // required * // FileSystemPath: "STRING_VALUE", * // }, + * // FSxLustreFileSystemConfig: { // FSxLustreFileSystemConfig + * // FileSystemId: "STRING_VALUE", // required + * // FileSystemPath: "STRING_VALUE", + * // }, * // }, * // ], * // StudioWebPortalSettings: { // StudioWebPortalSettings * // HiddenMlTools: [ // HiddenMlToolsList - * // "DataWrangler" || "FeatureStore" || "EmrClusters" || "AutoMl" || "Experiments" || "Training" || "ModelEvaluation" || "Pipelines" || "Models" || "JumpStart" || "InferenceRecommender" || "Endpoints" || "Projects" || "InferenceOptimization" || "PerformanceEvaluation", + * // "DataWrangler" || "FeatureStore" || "EmrClusters" || "AutoMl" || "Experiments" || "Training" || "ModelEvaluation" || "Pipelines" || "Models" || "JumpStart" || "InferenceRecommender" || "Endpoints" || "Projects" || "InferenceOptimization" || "PerformanceEvaluation" || "HyperPodClusters" || "LakeraGuard" || "Comet" || "DeepchecksLLMEvaluation" || "Fiddler", * // ], * // HiddenAppTypes: [ // HiddenAppTypesList * // "JupyterServer" || "KernelGateway" || "DetailedProfiler" || "TensorBoard" || "CodeEditor" || "JupyterLab" || "RStudioServerPro" || "RSessionGateway" || "Canvas", @@ -368,6 +372,10 @@ export interface DescribeDomainCommandOutput extends DescribeDomainResponse, __M * // FileSystemId: "STRING_VALUE", // required * // FileSystemPath: "STRING_VALUE", * // }, + * // FSxLustreFileSystemConfig: { + * // FileSystemId: "STRING_VALUE", // required + * // FileSystemPath: "STRING_VALUE", + * // }, * // }, * // ], * // }, diff --git a/clients/client-sagemaker/src/commands/DescribeHumanTaskUiCommand.ts b/clients/client-sagemaker/src/commands/DescribeHumanTaskUiCommand.ts index cc68fa3c7e73..4b38b8566e42 100644 --- a/clients/client-sagemaker/src/commands/DescribeHumanTaskUiCommand.ts +++ b/clients/client-sagemaker/src/commands/DescribeHumanTaskUiCommand.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 { DescribeHumanTaskUiRequest, DescribeHumanTaskUiResponse } from "../models/models_2"; +import { DescribeHumanTaskUiRequest } from "../models/models_2"; +import { DescribeHumanTaskUiResponse } from "../models/models_3"; import { de_DescribeHumanTaskUiCommand, se_DescribeHumanTaskUiCommand } from "../protocols/Aws_json1_1"; import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; diff --git a/clients/client-sagemaker/src/commands/DescribeHyperParameterTuningJobCommand.ts b/clients/client-sagemaker/src/commands/DescribeHyperParameterTuningJobCommand.ts index 4b59eb08c764..1c1c0bc7f105 100644 --- a/clients/client-sagemaker/src/commands/DescribeHyperParameterTuningJobCommand.ts +++ b/clients/client-sagemaker/src/commands/DescribeHyperParameterTuningJobCommand.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 { DescribeHyperParameterTuningJobRequest, DescribeHyperParameterTuningJobResponse } from "../models/models_2"; +import { DescribeHyperParameterTuningJobRequest, DescribeHyperParameterTuningJobResponse } from "../models/models_3"; import { de_DescribeHyperParameterTuningJobCommand, se_DescribeHyperParameterTuningJobCommand, @@ -209,28 +209,29 @@ export interface DescribeHyperParameterTuningJobCommandOutput * // CompressionType: "GZIP" || "NONE", * // }, * // ResourceConfig: { // ResourceConfig - * // InstanceType: "ml.m4.xlarge" || "ml.m4.2xlarge" || "ml.m4.4xlarge" || "ml.m4.10xlarge" || "ml.m4.16xlarge" || "ml.g4dn.xlarge" || "ml.g4dn.2xlarge" || "ml.g4dn.4xlarge" || "ml.g4dn.8xlarge" || "ml.g4dn.12xlarge" || "ml.g4dn.16xlarge" || "ml.m5.large" || "ml.m5.xlarge" || "ml.m5.2xlarge" || "ml.m5.4xlarge" || "ml.m5.12xlarge" || "ml.m5.24xlarge" || "ml.c4.xlarge" || "ml.c4.2xlarge" || "ml.c4.4xlarge" || "ml.c4.8xlarge" || "ml.p2.xlarge" || "ml.p2.8xlarge" || "ml.p2.16xlarge" || "ml.p3.2xlarge" || "ml.p3.8xlarge" || "ml.p3.16xlarge" || "ml.p3dn.24xlarge" || "ml.p4d.24xlarge" || "ml.p4de.24xlarge" || "ml.p5.48xlarge" || "ml.p5e.48xlarge" || "ml.c5.xlarge" || "ml.c5.2xlarge" || "ml.c5.4xlarge" || "ml.c5.9xlarge" || "ml.c5.18xlarge" || "ml.c5n.xlarge" || "ml.c5n.2xlarge" || "ml.c5n.4xlarge" || "ml.c5n.9xlarge" || "ml.c5n.18xlarge" || "ml.g5.xlarge" || "ml.g5.2xlarge" || "ml.g5.4xlarge" || "ml.g5.8xlarge" || "ml.g5.16xlarge" || "ml.g5.12xlarge" || "ml.g5.24xlarge" || "ml.g5.48xlarge" || "ml.g6.xlarge" || "ml.g6.2xlarge" || "ml.g6.4xlarge" || "ml.g6.8xlarge" || "ml.g6.16xlarge" || "ml.g6.12xlarge" || "ml.g6.24xlarge" || "ml.g6.48xlarge" || "ml.g6e.xlarge" || "ml.g6e.2xlarge" || "ml.g6e.4xlarge" || "ml.g6e.8xlarge" || "ml.g6e.16xlarge" || "ml.g6e.12xlarge" || "ml.g6e.24xlarge" || "ml.g6e.48xlarge" || "ml.trn1.2xlarge" || "ml.trn1.32xlarge" || "ml.trn1n.32xlarge" || "ml.m6i.large" || "ml.m6i.xlarge" || "ml.m6i.2xlarge" || "ml.m6i.4xlarge" || "ml.m6i.8xlarge" || "ml.m6i.12xlarge" || "ml.m6i.16xlarge" || "ml.m6i.24xlarge" || "ml.m6i.32xlarge" || "ml.c6i.xlarge" || "ml.c6i.2xlarge" || "ml.c6i.8xlarge" || "ml.c6i.4xlarge" || "ml.c6i.12xlarge" || "ml.c6i.16xlarge" || "ml.c6i.24xlarge" || "ml.c6i.32xlarge" || "ml.r5d.large" || "ml.r5d.xlarge" || "ml.r5d.2xlarge" || "ml.r5d.4xlarge" || "ml.r5d.8xlarge" || "ml.r5d.12xlarge" || "ml.r5d.16xlarge" || "ml.r5d.24xlarge" || "ml.t3.medium" || "ml.t3.large" || "ml.t3.xlarge" || "ml.t3.2xlarge" || "ml.r5.large" || "ml.r5.xlarge" || "ml.r5.2xlarge" || "ml.r5.4xlarge" || "ml.r5.8xlarge" || "ml.r5.12xlarge" || "ml.r5.16xlarge" || "ml.r5.24xlarge", + * // InstanceType: "ml.m4.xlarge" || "ml.m4.2xlarge" || "ml.m4.4xlarge" || "ml.m4.10xlarge" || "ml.m4.16xlarge" || "ml.g4dn.xlarge" || "ml.g4dn.2xlarge" || "ml.g4dn.4xlarge" || "ml.g4dn.8xlarge" || "ml.g4dn.12xlarge" || "ml.g4dn.16xlarge" || "ml.m5.large" || "ml.m5.xlarge" || "ml.m5.2xlarge" || "ml.m5.4xlarge" || "ml.m5.12xlarge" || "ml.m5.24xlarge" || "ml.c4.xlarge" || "ml.c4.2xlarge" || "ml.c4.4xlarge" || "ml.c4.8xlarge" || "ml.p2.xlarge" || "ml.p2.8xlarge" || "ml.p2.16xlarge" || "ml.p3.2xlarge" || "ml.p3.8xlarge" || "ml.p3.16xlarge" || "ml.p3dn.24xlarge" || "ml.p4d.24xlarge" || "ml.p4de.24xlarge" || "ml.p5.48xlarge" || "ml.p5e.48xlarge" || "ml.p5en.48xlarge" || "ml.c5.xlarge" || "ml.c5.2xlarge" || "ml.c5.4xlarge" || "ml.c5.9xlarge" || "ml.c5.18xlarge" || "ml.c5n.xlarge" || "ml.c5n.2xlarge" || "ml.c5n.4xlarge" || "ml.c5n.9xlarge" || "ml.c5n.18xlarge" || "ml.g5.xlarge" || "ml.g5.2xlarge" || "ml.g5.4xlarge" || "ml.g5.8xlarge" || "ml.g5.16xlarge" || "ml.g5.12xlarge" || "ml.g5.24xlarge" || "ml.g5.48xlarge" || "ml.g6.xlarge" || "ml.g6.2xlarge" || "ml.g6.4xlarge" || "ml.g6.8xlarge" || "ml.g6.16xlarge" || "ml.g6.12xlarge" || "ml.g6.24xlarge" || "ml.g6.48xlarge" || "ml.g6e.xlarge" || "ml.g6e.2xlarge" || "ml.g6e.4xlarge" || "ml.g6e.8xlarge" || "ml.g6e.16xlarge" || "ml.g6e.12xlarge" || "ml.g6e.24xlarge" || "ml.g6e.48xlarge" || "ml.trn1.2xlarge" || "ml.trn1.32xlarge" || "ml.trn1n.32xlarge" || "ml.trn2.48xlarge" || "ml.m6i.large" || "ml.m6i.xlarge" || "ml.m6i.2xlarge" || "ml.m6i.4xlarge" || "ml.m6i.8xlarge" || "ml.m6i.12xlarge" || "ml.m6i.16xlarge" || "ml.m6i.24xlarge" || "ml.m6i.32xlarge" || "ml.c6i.xlarge" || "ml.c6i.2xlarge" || "ml.c6i.8xlarge" || "ml.c6i.4xlarge" || "ml.c6i.12xlarge" || "ml.c6i.16xlarge" || "ml.c6i.24xlarge" || "ml.c6i.32xlarge" || "ml.r5d.large" || "ml.r5d.xlarge" || "ml.r5d.2xlarge" || "ml.r5d.4xlarge" || "ml.r5d.8xlarge" || "ml.r5d.12xlarge" || "ml.r5d.16xlarge" || "ml.r5d.24xlarge" || "ml.t3.medium" || "ml.t3.large" || "ml.t3.xlarge" || "ml.t3.2xlarge" || "ml.r5.large" || "ml.r5.xlarge" || "ml.r5.2xlarge" || "ml.r5.4xlarge" || "ml.r5.8xlarge" || "ml.r5.12xlarge" || "ml.r5.16xlarge" || "ml.r5.24xlarge", * // InstanceCount: Number("int"), * // VolumeSizeInGB: Number("int"), // required * // VolumeKmsKeyId: "STRING_VALUE", * // KeepAlivePeriodInSeconds: Number("int"), * // InstanceGroups: [ // InstanceGroups * // { // InstanceGroup - * // InstanceType: "ml.m4.xlarge" || "ml.m4.2xlarge" || "ml.m4.4xlarge" || "ml.m4.10xlarge" || "ml.m4.16xlarge" || "ml.g4dn.xlarge" || "ml.g4dn.2xlarge" || "ml.g4dn.4xlarge" || "ml.g4dn.8xlarge" || "ml.g4dn.12xlarge" || "ml.g4dn.16xlarge" || "ml.m5.large" || "ml.m5.xlarge" || "ml.m5.2xlarge" || "ml.m5.4xlarge" || "ml.m5.12xlarge" || "ml.m5.24xlarge" || "ml.c4.xlarge" || "ml.c4.2xlarge" || "ml.c4.4xlarge" || "ml.c4.8xlarge" || "ml.p2.xlarge" || "ml.p2.8xlarge" || "ml.p2.16xlarge" || "ml.p3.2xlarge" || "ml.p3.8xlarge" || "ml.p3.16xlarge" || "ml.p3dn.24xlarge" || "ml.p4d.24xlarge" || "ml.p4de.24xlarge" || "ml.p5.48xlarge" || "ml.p5e.48xlarge" || "ml.c5.xlarge" || "ml.c5.2xlarge" || "ml.c5.4xlarge" || "ml.c5.9xlarge" || "ml.c5.18xlarge" || "ml.c5n.xlarge" || "ml.c5n.2xlarge" || "ml.c5n.4xlarge" || "ml.c5n.9xlarge" || "ml.c5n.18xlarge" || "ml.g5.xlarge" || "ml.g5.2xlarge" || "ml.g5.4xlarge" || "ml.g5.8xlarge" || "ml.g5.16xlarge" || "ml.g5.12xlarge" || "ml.g5.24xlarge" || "ml.g5.48xlarge" || "ml.g6.xlarge" || "ml.g6.2xlarge" || "ml.g6.4xlarge" || "ml.g6.8xlarge" || "ml.g6.16xlarge" || "ml.g6.12xlarge" || "ml.g6.24xlarge" || "ml.g6.48xlarge" || "ml.g6e.xlarge" || "ml.g6e.2xlarge" || "ml.g6e.4xlarge" || "ml.g6e.8xlarge" || "ml.g6e.16xlarge" || "ml.g6e.12xlarge" || "ml.g6e.24xlarge" || "ml.g6e.48xlarge" || "ml.trn1.2xlarge" || "ml.trn1.32xlarge" || "ml.trn1n.32xlarge" || "ml.m6i.large" || "ml.m6i.xlarge" || "ml.m6i.2xlarge" || "ml.m6i.4xlarge" || "ml.m6i.8xlarge" || "ml.m6i.12xlarge" || "ml.m6i.16xlarge" || "ml.m6i.24xlarge" || "ml.m6i.32xlarge" || "ml.c6i.xlarge" || "ml.c6i.2xlarge" || "ml.c6i.8xlarge" || "ml.c6i.4xlarge" || "ml.c6i.12xlarge" || "ml.c6i.16xlarge" || "ml.c6i.24xlarge" || "ml.c6i.32xlarge" || "ml.r5d.large" || "ml.r5d.xlarge" || "ml.r5d.2xlarge" || "ml.r5d.4xlarge" || "ml.r5d.8xlarge" || "ml.r5d.12xlarge" || "ml.r5d.16xlarge" || "ml.r5d.24xlarge" || "ml.t3.medium" || "ml.t3.large" || "ml.t3.xlarge" || "ml.t3.2xlarge" || "ml.r5.large" || "ml.r5.xlarge" || "ml.r5.2xlarge" || "ml.r5.4xlarge" || "ml.r5.8xlarge" || "ml.r5.12xlarge" || "ml.r5.16xlarge" || "ml.r5.24xlarge", // required + * // InstanceType: "ml.m4.xlarge" || "ml.m4.2xlarge" || "ml.m4.4xlarge" || "ml.m4.10xlarge" || "ml.m4.16xlarge" || "ml.g4dn.xlarge" || "ml.g4dn.2xlarge" || "ml.g4dn.4xlarge" || "ml.g4dn.8xlarge" || "ml.g4dn.12xlarge" || "ml.g4dn.16xlarge" || "ml.m5.large" || "ml.m5.xlarge" || "ml.m5.2xlarge" || "ml.m5.4xlarge" || "ml.m5.12xlarge" || "ml.m5.24xlarge" || "ml.c4.xlarge" || "ml.c4.2xlarge" || "ml.c4.4xlarge" || "ml.c4.8xlarge" || "ml.p2.xlarge" || "ml.p2.8xlarge" || "ml.p2.16xlarge" || "ml.p3.2xlarge" || "ml.p3.8xlarge" || "ml.p3.16xlarge" || "ml.p3dn.24xlarge" || "ml.p4d.24xlarge" || "ml.p4de.24xlarge" || "ml.p5.48xlarge" || "ml.p5e.48xlarge" || "ml.p5en.48xlarge" || "ml.c5.xlarge" || "ml.c5.2xlarge" || "ml.c5.4xlarge" || "ml.c5.9xlarge" || "ml.c5.18xlarge" || "ml.c5n.xlarge" || "ml.c5n.2xlarge" || "ml.c5n.4xlarge" || "ml.c5n.9xlarge" || "ml.c5n.18xlarge" || "ml.g5.xlarge" || "ml.g5.2xlarge" || "ml.g5.4xlarge" || "ml.g5.8xlarge" || "ml.g5.16xlarge" || "ml.g5.12xlarge" || "ml.g5.24xlarge" || "ml.g5.48xlarge" || "ml.g6.xlarge" || "ml.g6.2xlarge" || "ml.g6.4xlarge" || "ml.g6.8xlarge" || "ml.g6.16xlarge" || "ml.g6.12xlarge" || "ml.g6.24xlarge" || "ml.g6.48xlarge" || "ml.g6e.xlarge" || "ml.g6e.2xlarge" || "ml.g6e.4xlarge" || "ml.g6e.8xlarge" || "ml.g6e.16xlarge" || "ml.g6e.12xlarge" || "ml.g6e.24xlarge" || "ml.g6e.48xlarge" || "ml.trn1.2xlarge" || "ml.trn1.32xlarge" || "ml.trn1n.32xlarge" || "ml.trn2.48xlarge" || "ml.m6i.large" || "ml.m6i.xlarge" || "ml.m6i.2xlarge" || "ml.m6i.4xlarge" || "ml.m6i.8xlarge" || "ml.m6i.12xlarge" || "ml.m6i.16xlarge" || "ml.m6i.24xlarge" || "ml.m6i.32xlarge" || "ml.c6i.xlarge" || "ml.c6i.2xlarge" || "ml.c6i.8xlarge" || "ml.c6i.4xlarge" || "ml.c6i.12xlarge" || "ml.c6i.16xlarge" || "ml.c6i.24xlarge" || "ml.c6i.32xlarge" || "ml.r5d.large" || "ml.r5d.xlarge" || "ml.r5d.2xlarge" || "ml.r5d.4xlarge" || "ml.r5d.8xlarge" || "ml.r5d.12xlarge" || "ml.r5d.16xlarge" || "ml.r5d.24xlarge" || "ml.t3.medium" || "ml.t3.large" || "ml.t3.xlarge" || "ml.t3.2xlarge" || "ml.r5.large" || "ml.r5.xlarge" || "ml.r5.2xlarge" || "ml.r5.4xlarge" || "ml.r5.8xlarge" || "ml.r5.12xlarge" || "ml.r5.16xlarge" || "ml.r5.24xlarge", // required * // InstanceCount: Number("int"), // required * // InstanceGroupName: "STRING_VALUE", // required * // }, * // ], + * // TrainingPlanArn: "STRING_VALUE", * // }, * // HyperParameterTuningResourceConfig: { // HyperParameterTuningResourceConfig - * // InstanceType: "ml.m4.xlarge" || "ml.m4.2xlarge" || "ml.m4.4xlarge" || "ml.m4.10xlarge" || "ml.m4.16xlarge" || "ml.g4dn.xlarge" || "ml.g4dn.2xlarge" || "ml.g4dn.4xlarge" || "ml.g4dn.8xlarge" || "ml.g4dn.12xlarge" || "ml.g4dn.16xlarge" || "ml.m5.large" || "ml.m5.xlarge" || "ml.m5.2xlarge" || "ml.m5.4xlarge" || "ml.m5.12xlarge" || "ml.m5.24xlarge" || "ml.c4.xlarge" || "ml.c4.2xlarge" || "ml.c4.4xlarge" || "ml.c4.8xlarge" || "ml.p2.xlarge" || "ml.p2.8xlarge" || "ml.p2.16xlarge" || "ml.p3.2xlarge" || "ml.p3.8xlarge" || "ml.p3.16xlarge" || "ml.p3dn.24xlarge" || "ml.p4d.24xlarge" || "ml.p4de.24xlarge" || "ml.p5.48xlarge" || "ml.p5e.48xlarge" || "ml.c5.xlarge" || "ml.c5.2xlarge" || "ml.c5.4xlarge" || "ml.c5.9xlarge" || "ml.c5.18xlarge" || "ml.c5n.xlarge" || "ml.c5n.2xlarge" || "ml.c5n.4xlarge" || "ml.c5n.9xlarge" || "ml.c5n.18xlarge" || "ml.g5.xlarge" || "ml.g5.2xlarge" || "ml.g5.4xlarge" || "ml.g5.8xlarge" || "ml.g5.16xlarge" || "ml.g5.12xlarge" || "ml.g5.24xlarge" || "ml.g5.48xlarge" || "ml.g6.xlarge" || "ml.g6.2xlarge" || "ml.g6.4xlarge" || "ml.g6.8xlarge" || "ml.g6.16xlarge" || "ml.g6.12xlarge" || "ml.g6.24xlarge" || "ml.g6.48xlarge" || "ml.g6e.xlarge" || "ml.g6e.2xlarge" || "ml.g6e.4xlarge" || "ml.g6e.8xlarge" || "ml.g6e.16xlarge" || "ml.g6e.12xlarge" || "ml.g6e.24xlarge" || "ml.g6e.48xlarge" || "ml.trn1.2xlarge" || "ml.trn1.32xlarge" || "ml.trn1n.32xlarge" || "ml.m6i.large" || "ml.m6i.xlarge" || "ml.m6i.2xlarge" || "ml.m6i.4xlarge" || "ml.m6i.8xlarge" || "ml.m6i.12xlarge" || "ml.m6i.16xlarge" || "ml.m6i.24xlarge" || "ml.m6i.32xlarge" || "ml.c6i.xlarge" || "ml.c6i.2xlarge" || "ml.c6i.8xlarge" || "ml.c6i.4xlarge" || "ml.c6i.12xlarge" || "ml.c6i.16xlarge" || "ml.c6i.24xlarge" || "ml.c6i.32xlarge" || "ml.r5d.large" || "ml.r5d.xlarge" || "ml.r5d.2xlarge" || "ml.r5d.4xlarge" || "ml.r5d.8xlarge" || "ml.r5d.12xlarge" || "ml.r5d.16xlarge" || "ml.r5d.24xlarge" || "ml.t3.medium" || "ml.t3.large" || "ml.t3.xlarge" || "ml.t3.2xlarge" || "ml.r5.large" || "ml.r5.xlarge" || "ml.r5.2xlarge" || "ml.r5.4xlarge" || "ml.r5.8xlarge" || "ml.r5.12xlarge" || "ml.r5.16xlarge" || "ml.r5.24xlarge", + * // InstanceType: "ml.m4.xlarge" || "ml.m4.2xlarge" || "ml.m4.4xlarge" || "ml.m4.10xlarge" || "ml.m4.16xlarge" || "ml.g4dn.xlarge" || "ml.g4dn.2xlarge" || "ml.g4dn.4xlarge" || "ml.g4dn.8xlarge" || "ml.g4dn.12xlarge" || "ml.g4dn.16xlarge" || "ml.m5.large" || "ml.m5.xlarge" || "ml.m5.2xlarge" || "ml.m5.4xlarge" || "ml.m5.12xlarge" || "ml.m5.24xlarge" || "ml.c4.xlarge" || "ml.c4.2xlarge" || "ml.c4.4xlarge" || "ml.c4.8xlarge" || "ml.p2.xlarge" || "ml.p2.8xlarge" || "ml.p2.16xlarge" || "ml.p3.2xlarge" || "ml.p3.8xlarge" || "ml.p3.16xlarge" || "ml.p3dn.24xlarge" || "ml.p4d.24xlarge" || "ml.p4de.24xlarge" || "ml.p5.48xlarge" || "ml.p5e.48xlarge" || "ml.p5en.48xlarge" || "ml.c5.xlarge" || "ml.c5.2xlarge" || "ml.c5.4xlarge" || "ml.c5.9xlarge" || "ml.c5.18xlarge" || "ml.c5n.xlarge" || "ml.c5n.2xlarge" || "ml.c5n.4xlarge" || "ml.c5n.9xlarge" || "ml.c5n.18xlarge" || "ml.g5.xlarge" || "ml.g5.2xlarge" || "ml.g5.4xlarge" || "ml.g5.8xlarge" || "ml.g5.16xlarge" || "ml.g5.12xlarge" || "ml.g5.24xlarge" || "ml.g5.48xlarge" || "ml.g6.xlarge" || "ml.g6.2xlarge" || "ml.g6.4xlarge" || "ml.g6.8xlarge" || "ml.g6.16xlarge" || "ml.g6.12xlarge" || "ml.g6.24xlarge" || "ml.g6.48xlarge" || "ml.g6e.xlarge" || "ml.g6e.2xlarge" || "ml.g6e.4xlarge" || "ml.g6e.8xlarge" || "ml.g6e.16xlarge" || "ml.g6e.12xlarge" || "ml.g6e.24xlarge" || "ml.g6e.48xlarge" || "ml.trn1.2xlarge" || "ml.trn1.32xlarge" || "ml.trn1n.32xlarge" || "ml.trn2.48xlarge" || "ml.m6i.large" || "ml.m6i.xlarge" || "ml.m6i.2xlarge" || "ml.m6i.4xlarge" || "ml.m6i.8xlarge" || "ml.m6i.12xlarge" || "ml.m6i.16xlarge" || "ml.m6i.24xlarge" || "ml.m6i.32xlarge" || "ml.c6i.xlarge" || "ml.c6i.2xlarge" || "ml.c6i.8xlarge" || "ml.c6i.4xlarge" || "ml.c6i.12xlarge" || "ml.c6i.16xlarge" || "ml.c6i.24xlarge" || "ml.c6i.32xlarge" || "ml.r5d.large" || "ml.r5d.xlarge" || "ml.r5d.2xlarge" || "ml.r5d.4xlarge" || "ml.r5d.8xlarge" || "ml.r5d.12xlarge" || "ml.r5d.16xlarge" || "ml.r5d.24xlarge" || "ml.t3.medium" || "ml.t3.large" || "ml.t3.xlarge" || "ml.t3.2xlarge" || "ml.r5.large" || "ml.r5.xlarge" || "ml.r5.2xlarge" || "ml.r5.4xlarge" || "ml.r5.8xlarge" || "ml.r5.12xlarge" || "ml.r5.16xlarge" || "ml.r5.24xlarge", * // InstanceCount: Number("int"), * // VolumeSizeInGB: Number("int"), * // VolumeKmsKeyId: "STRING_VALUE", * // AllocationStrategy: "Prioritized", * // InstanceConfigs: [ // HyperParameterTuningInstanceConfigs * // { // HyperParameterTuningInstanceConfig - * // InstanceType: "ml.m4.xlarge" || "ml.m4.2xlarge" || "ml.m4.4xlarge" || "ml.m4.10xlarge" || "ml.m4.16xlarge" || "ml.g4dn.xlarge" || "ml.g4dn.2xlarge" || "ml.g4dn.4xlarge" || "ml.g4dn.8xlarge" || "ml.g4dn.12xlarge" || "ml.g4dn.16xlarge" || "ml.m5.large" || "ml.m5.xlarge" || "ml.m5.2xlarge" || "ml.m5.4xlarge" || "ml.m5.12xlarge" || "ml.m5.24xlarge" || "ml.c4.xlarge" || "ml.c4.2xlarge" || "ml.c4.4xlarge" || "ml.c4.8xlarge" || "ml.p2.xlarge" || "ml.p2.8xlarge" || "ml.p2.16xlarge" || "ml.p3.2xlarge" || "ml.p3.8xlarge" || "ml.p3.16xlarge" || "ml.p3dn.24xlarge" || "ml.p4d.24xlarge" || "ml.p4de.24xlarge" || "ml.p5.48xlarge" || "ml.p5e.48xlarge" || "ml.c5.xlarge" || "ml.c5.2xlarge" || "ml.c5.4xlarge" || "ml.c5.9xlarge" || "ml.c5.18xlarge" || "ml.c5n.xlarge" || "ml.c5n.2xlarge" || "ml.c5n.4xlarge" || "ml.c5n.9xlarge" || "ml.c5n.18xlarge" || "ml.g5.xlarge" || "ml.g5.2xlarge" || "ml.g5.4xlarge" || "ml.g5.8xlarge" || "ml.g5.16xlarge" || "ml.g5.12xlarge" || "ml.g5.24xlarge" || "ml.g5.48xlarge" || "ml.g6.xlarge" || "ml.g6.2xlarge" || "ml.g6.4xlarge" || "ml.g6.8xlarge" || "ml.g6.16xlarge" || "ml.g6.12xlarge" || "ml.g6.24xlarge" || "ml.g6.48xlarge" || "ml.g6e.xlarge" || "ml.g6e.2xlarge" || "ml.g6e.4xlarge" || "ml.g6e.8xlarge" || "ml.g6e.16xlarge" || "ml.g6e.12xlarge" || "ml.g6e.24xlarge" || "ml.g6e.48xlarge" || "ml.trn1.2xlarge" || "ml.trn1.32xlarge" || "ml.trn1n.32xlarge" || "ml.m6i.large" || "ml.m6i.xlarge" || "ml.m6i.2xlarge" || "ml.m6i.4xlarge" || "ml.m6i.8xlarge" || "ml.m6i.12xlarge" || "ml.m6i.16xlarge" || "ml.m6i.24xlarge" || "ml.m6i.32xlarge" || "ml.c6i.xlarge" || "ml.c6i.2xlarge" || "ml.c6i.8xlarge" || "ml.c6i.4xlarge" || "ml.c6i.12xlarge" || "ml.c6i.16xlarge" || "ml.c6i.24xlarge" || "ml.c6i.32xlarge" || "ml.r5d.large" || "ml.r5d.xlarge" || "ml.r5d.2xlarge" || "ml.r5d.4xlarge" || "ml.r5d.8xlarge" || "ml.r5d.12xlarge" || "ml.r5d.16xlarge" || "ml.r5d.24xlarge" || "ml.t3.medium" || "ml.t3.large" || "ml.t3.xlarge" || "ml.t3.2xlarge" || "ml.r5.large" || "ml.r5.xlarge" || "ml.r5.2xlarge" || "ml.r5.4xlarge" || "ml.r5.8xlarge" || "ml.r5.12xlarge" || "ml.r5.16xlarge" || "ml.r5.24xlarge", // required + * // InstanceType: "ml.m4.xlarge" || "ml.m4.2xlarge" || "ml.m4.4xlarge" || "ml.m4.10xlarge" || "ml.m4.16xlarge" || "ml.g4dn.xlarge" || "ml.g4dn.2xlarge" || "ml.g4dn.4xlarge" || "ml.g4dn.8xlarge" || "ml.g4dn.12xlarge" || "ml.g4dn.16xlarge" || "ml.m5.large" || "ml.m5.xlarge" || "ml.m5.2xlarge" || "ml.m5.4xlarge" || "ml.m5.12xlarge" || "ml.m5.24xlarge" || "ml.c4.xlarge" || "ml.c4.2xlarge" || "ml.c4.4xlarge" || "ml.c4.8xlarge" || "ml.p2.xlarge" || "ml.p2.8xlarge" || "ml.p2.16xlarge" || "ml.p3.2xlarge" || "ml.p3.8xlarge" || "ml.p3.16xlarge" || "ml.p3dn.24xlarge" || "ml.p4d.24xlarge" || "ml.p4de.24xlarge" || "ml.p5.48xlarge" || "ml.p5e.48xlarge" || "ml.p5en.48xlarge" || "ml.c5.xlarge" || "ml.c5.2xlarge" || "ml.c5.4xlarge" || "ml.c5.9xlarge" || "ml.c5.18xlarge" || "ml.c5n.xlarge" || "ml.c5n.2xlarge" || "ml.c5n.4xlarge" || "ml.c5n.9xlarge" || "ml.c5n.18xlarge" || "ml.g5.xlarge" || "ml.g5.2xlarge" || "ml.g5.4xlarge" || "ml.g5.8xlarge" || "ml.g5.16xlarge" || "ml.g5.12xlarge" || "ml.g5.24xlarge" || "ml.g5.48xlarge" || "ml.g6.xlarge" || "ml.g6.2xlarge" || "ml.g6.4xlarge" || "ml.g6.8xlarge" || "ml.g6.16xlarge" || "ml.g6.12xlarge" || "ml.g6.24xlarge" || "ml.g6.48xlarge" || "ml.g6e.xlarge" || "ml.g6e.2xlarge" || "ml.g6e.4xlarge" || "ml.g6e.8xlarge" || "ml.g6e.16xlarge" || "ml.g6e.12xlarge" || "ml.g6e.24xlarge" || "ml.g6e.48xlarge" || "ml.trn1.2xlarge" || "ml.trn1.32xlarge" || "ml.trn1n.32xlarge" || "ml.trn2.48xlarge" || "ml.m6i.large" || "ml.m6i.xlarge" || "ml.m6i.2xlarge" || "ml.m6i.4xlarge" || "ml.m6i.8xlarge" || "ml.m6i.12xlarge" || "ml.m6i.16xlarge" || "ml.m6i.24xlarge" || "ml.m6i.32xlarge" || "ml.c6i.xlarge" || "ml.c6i.2xlarge" || "ml.c6i.8xlarge" || "ml.c6i.4xlarge" || "ml.c6i.12xlarge" || "ml.c6i.16xlarge" || "ml.c6i.24xlarge" || "ml.c6i.32xlarge" || "ml.r5d.large" || "ml.r5d.xlarge" || "ml.r5d.2xlarge" || "ml.r5d.4xlarge" || "ml.r5d.8xlarge" || "ml.r5d.12xlarge" || "ml.r5d.16xlarge" || "ml.r5d.24xlarge" || "ml.t3.medium" || "ml.t3.large" || "ml.t3.xlarge" || "ml.t3.2xlarge" || "ml.r5.large" || "ml.r5.xlarge" || "ml.r5.2xlarge" || "ml.r5.4xlarge" || "ml.r5.8xlarge" || "ml.r5.12xlarge" || "ml.r5.16xlarge" || "ml.r5.24xlarge", // required * // InstanceCount: Number("int"), // required * // VolumeSizeInGB: Number("int"), // required * // }, @@ -354,28 +355,29 @@ export interface DescribeHyperParameterTuningJobCommandOutput * // CompressionType: "GZIP" || "NONE", * // }, * // ResourceConfig: { - * // InstanceType: "ml.m4.xlarge" || "ml.m4.2xlarge" || "ml.m4.4xlarge" || "ml.m4.10xlarge" || "ml.m4.16xlarge" || "ml.g4dn.xlarge" || "ml.g4dn.2xlarge" || "ml.g4dn.4xlarge" || "ml.g4dn.8xlarge" || "ml.g4dn.12xlarge" || "ml.g4dn.16xlarge" || "ml.m5.large" || "ml.m5.xlarge" || "ml.m5.2xlarge" || "ml.m5.4xlarge" || "ml.m5.12xlarge" || "ml.m5.24xlarge" || "ml.c4.xlarge" || "ml.c4.2xlarge" || "ml.c4.4xlarge" || "ml.c4.8xlarge" || "ml.p2.xlarge" || "ml.p2.8xlarge" || "ml.p2.16xlarge" || "ml.p3.2xlarge" || "ml.p3.8xlarge" || "ml.p3.16xlarge" || "ml.p3dn.24xlarge" || "ml.p4d.24xlarge" || "ml.p4de.24xlarge" || "ml.p5.48xlarge" || "ml.p5e.48xlarge" || "ml.c5.xlarge" || "ml.c5.2xlarge" || "ml.c5.4xlarge" || "ml.c5.9xlarge" || "ml.c5.18xlarge" || "ml.c5n.xlarge" || "ml.c5n.2xlarge" || "ml.c5n.4xlarge" || "ml.c5n.9xlarge" || "ml.c5n.18xlarge" || "ml.g5.xlarge" || "ml.g5.2xlarge" || "ml.g5.4xlarge" || "ml.g5.8xlarge" || "ml.g5.16xlarge" || "ml.g5.12xlarge" || "ml.g5.24xlarge" || "ml.g5.48xlarge" || "ml.g6.xlarge" || "ml.g6.2xlarge" || "ml.g6.4xlarge" || "ml.g6.8xlarge" || "ml.g6.16xlarge" || "ml.g6.12xlarge" || "ml.g6.24xlarge" || "ml.g6.48xlarge" || "ml.g6e.xlarge" || "ml.g6e.2xlarge" || "ml.g6e.4xlarge" || "ml.g6e.8xlarge" || "ml.g6e.16xlarge" || "ml.g6e.12xlarge" || "ml.g6e.24xlarge" || "ml.g6e.48xlarge" || "ml.trn1.2xlarge" || "ml.trn1.32xlarge" || "ml.trn1n.32xlarge" || "ml.m6i.large" || "ml.m6i.xlarge" || "ml.m6i.2xlarge" || "ml.m6i.4xlarge" || "ml.m6i.8xlarge" || "ml.m6i.12xlarge" || "ml.m6i.16xlarge" || "ml.m6i.24xlarge" || "ml.m6i.32xlarge" || "ml.c6i.xlarge" || "ml.c6i.2xlarge" || "ml.c6i.8xlarge" || "ml.c6i.4xlarge" || "ml.c6i.12xlarge" || "ml.c6i.16xlarge" || "ml.c6i.24xlarge" || "ml.c6i.32xlarge" || "ml.r5d.large" || "ml.r5d.xlarge" || "ml.r5d.2xlarge" || "ml.r5d.4xlarge" || "ml.r5d.8xlarge" || "ml.r5d.12xlarge" || "ml.r5d.16xlarge" || "ml.r5d.24xlarge" || "ml.t3.medium" || "ml.t3.large" || "ml.t3.xlarge" || "ml.t3.2xlarge" || "ml.r5.large" || "ml.r5.xlarge" || "ml.r5.2xlarge" || "ml.r5.4xlarge" || "ml.r5.8xlarge" || "ml.r5.12xlarge" || "ml.r5.16xlarge" || "ml.r5.24xlarge", + * // InstanceType: "ml.m4.xlarge" || "ml.m4.2xlarge" || "ml.m4.4xlarge" || "ml.m4.10xlarge" || "ml.m4.16xlarge" || "ml.g4dn.xlarge" || "ml.g4dn.2xlarge" || "ml.g4dn.4xlarge" || "ml.g4dn.8xlarge" || "ml.g4dn.12xlarge" || "ml.g4dn.16xlarge" || "ml.m5.large" || "ml.m5.xlarge" || "ml.m5.2xlarge" || "ml.m5.4xlarge" || "ml.m5.12xlarge" || "ml.m5.24xlarge" || "ml.c4.xlarge" || "ml.c4.2xlarge" || "ml.c4.4xlarge" || "ml.c4.8xlarge" || "ml.p2.xlarge" || "ml.p2.8xlarge" || "ml.p2.16xlarge" || "ml.p3.2xlarge" || "ml.p3.8xlarge" || "ml.p3.16xlarge" || "ml.p3dn.24xlarge" || "ml.p4d.24xlarge" || "ml.p4de.24xlarge" || "ml.p5.48xlarge" || "ml.p5e.48xlarge" || "ml.p5en.48xlarge" || "ml.c5.xlarge" || "ml.c5.2xlarge" || "ml.c5.4xlarge" || "ml.c5.9xlarge" || "ml.c5.18xlarge" || "ml.c5n.xlarge" || "ml.c5n.2xlarge" || "ml.c5n.4xlarge" || "ml.c5n.9xlarge" || "ml.c5n.18xlarge" || "ml.g5.xlarge" || "ml.g5.2xlarge" || "ml.g5.4xlarge" || "ml.g5.8xlarge" || "ml.g5.16xlarge" || "ml.g5.12xlarge" || "ml.g5.24xlarge" || "ml.g5.48xlarge" || "ml.g6.xlarge" || "ml.g6.2xlarge" || "ml.g6.4xlarge" || "ml.g6.8xlarge" || "ml.g6.16xlarge" || "ml.g6.12xlarge" || "ml.g6.24xlarge" || "ml.g6.48xlarge" || "ml.g6e.xlarge" || "ml.g6e.2xlarge" || "ml.g6e.4xlarge" || "ml.g6e.8xlarge" || "ml.g6e.16xlarge" || "ml.g6e.12xlarge" || "ml.g6e.24xlarge" || "ml.g6e.48xlarge" || "ml.trn1.2xlarge" || "ml.trn1.32xlarge" || "ml.trn1n.32xlarge" || "ml.trn2.48xlarge" || "ml.m6i.large" || "ml.m6i.xlarge" || "ml.m6i.2xlarge" || "ml.m6i.4xlarge" || "ml.m6i.8xlarge" || "ml.m6i.12xlarge" || "ml.m6i.16xlarge" || "ml.m6i.24xlarge" || "ml.m6i.32xlarge" || "ml.c6i.xlarge" || "ml.c6i.2xlarge" || "ml.c6i.8xlarge" || "ml.c6i.4xlarge" || "ml.c6i.12xlarge" || "ml.c6i.16xlarge" || "ml.c6i.24xlarge" || "ml.c6i.32xlarge" || "ml.r5d.large" || "ml.r5d.xlarge" || "ml.r5d.2xlarge" || "ml.r5d.4xlarge" || "ml.r5d.8xlarge" || "ml.r5d.12xlarge" || "ml.r5d.16xlarge" || "ml.r5d.24xlarge" || "ml.t3.medium" || "ml.t3.large" || "ml.t3.xlarge" || "ml.t3.2xlarge" || "ml.r5.large" || "ml.r5.xlarge" || "ml.r5.2xlarge" || "ml.r5.4xlarge" || "ml.r5.8xlarge" || "ml.r5.12xlarge" || "ml.r5.16xlarge" || "ml.r5.24xlarge", * // InstanceCount: Number("int"), * // VolumeSizeInGB: Number("int"), // required * // VolumeKmsKeyId: "STRING_VALUE", * // KeepAlivePeriodInSeconds: Number("int"), * // InstanceGroups: [ * // { - * // InstanceType: "ml.m4.xlarge" || "ml.m4.2xlarge" || "ml.m4.4xlarge" || "ml.m4.10xlarge" || "ml.m4.16xlarge" || "ml.g4dn.xlarge" || "ml.g4dn.2xlarge" || "ml.g4dn.4xlarge" || "ml.g4dn.8xlarge" || "ml.g4dn.12xlarge" || "ml.g4dn.16xlarge" || "ml.m5.large" || "ml.m5.xlarge" || "ml.m5.2xlarge" || "ml.m5.4xlarge" || "ml.m5.12xlarge" || "ml.m5.24xlarge" || "ml.c4.xlarge" || "ml.c4.2xlarge" || "ml.c4.4xlarge" || "ml.c4.8xlarge" || "ml.p2.xlarge" || "ml.p2.8xlarge" || "ml.p2.16xlarge" || "ml.p3.2xlarge" || "ml.p3.8xlarge" || "ml.p3.16xlarge" || "ml.p3dn.24xlarge" || "ml.p4d.24xlarge" || "ml.p4de.24xlarge" || "ml.p5.48xlarge" || "ml.p5e.48xlarge" || "ml.c5.xlarge" || "ml.c5.2xlarge" || "ml.c5.4xlarge" || "ml.c5.9xlarge" || "ml.c5.18xlarge" || "ml.c5n.xlarge" || "ml.c5n.2xlarge" || "ml.c5n.4xlarge" || "ml.c5n.9xlarge" || "ml.c5n.18xlarge" || "ml.g5.xlarge" || "ml.g5.2xlarge" || "ml.g5.4xlarge" || "ml.g5.8xlarge" || "ml.g5.16xlarge" || "ml.g5.12xlarge" || "ml.g5.24xlarge" || "ml.g5.48xlarge" || "ml.g6.xlarge" || "ml.g6.2xlarge" || "ml.g6.4xlarge" || "ml.g6.8xlarge" || "ml.g6.16xlarge" || "ml.g6.12xlarge" || "ml.g6.24xlarge" || "ml.g6.48xlarge" || "ml.g6e.xlarge" || "ml.g6e.2xlarge" || "ml.g6e.4xlarge" || "ml.g6e.8xlarge" || "ml.g6e.16xlarge" || "ml.g6e.12xlarge" || "ml.g6e.24xlarge" || "ml.g6e.48xlarge" || "ml.trn1.2xlarge" || "ml.trn1.32xlarge" || "ml.trn1n.32xlarge" || "ml.m6i.large" || "ml.m6i.xlarge" || "ml.m6i.2xlarge" || "ml.m6i.4xlarge" || "ml.m6i.8xlarge" || "ml.m6i.12xlarge" || "ml.m6i.16xlarge" || "ml.m6i.24xlarge" || "ml.m6i.32xlarge" || "ml.c6i.xlarge" || "ml.c6i.2xlarge" || "ml.c6i.8xlarge" || "ml.c6i.4xlarge" || "ml.c6i.12xlarge" || "ml.c6i.16xlarge" || "ml.c6i.24xlarge" || "ml.c6i.32xlarge" || "ml.r5d.large" || "ml.r5d.xlarge" || "ml.r5d.2xlarge" || "ml.r5d.4xlarge" || "ml.r5d.8xlarge" || "ml.r5d.12xlarge" || "ml.r5d.16xlarge" || "ml.r5d.24xlarge" || "ml.t3.medium" || "ml.t3.large" || "ml.t3.xlarge" || "ml.t3.2xlarge" || "ml.r5.large" || "ml.r5.xlarge" || "ml.r5.2xlarge" || "ml.r5.4xlarge" || "ml.r5.8xlarge" || "ml.r5.12xlarge" || "ml.r5.16xlarge" || "ml.r5.24xlarge", // required + * // InstanceType: "ml.m4.xlarge" || "ml.m4.2xlarge" || "ml.m4.4xlarge" || "ml.m4.10xlarge" || "ml.m4.16xlarge" || "ml.g4dn.xlarge" || "ml.g4dn.2xlarge" || "ml.g4dn.4xlarge" || "ml.g4dn.8xlarge" || "ml.g4dn.12xlarge" || "ml.g4dn.16xlarge" || "ml.m5.large" || "ml.m5.xlarge" || "ml.m5.2xlarge" || "ml.m5.4xlarge" || "ml.m5.12xlarge" || "ml.m5.24xlarge" || "ml.c4.xlarge" || "ml.c4.2xlarge" || "ml.c4.4xlarge" || "ml.c4.8xlarge" || "ml.p2.xlarge" || "ml.p2.8xlarge" || "ml.p2.16xlarge" || "ml.p3.2xlarge" || "ml.p3.8xlarge" || "ml.p3.16xlarge" || "ml.p3dn.24xlarge" || "ml.p4d.24xlarge" || "ml.p4de.24xlarge" || "ml.p5.48xlarge" || "ml.p5e.48xlarge" || "ml.p5en.48xlarge" || "ml.c5.xlarge" || "ml.c5.2xlarge" || "ml.c5.4xlarge" || "ml.c5.9xlarge" || "ml.c5.18xlarge" || "ml.c5n.xlarge" || "ml.c5n.2xlarge" || "ml.c5n.4xlarge" || "ml.c5n.9xlarge" || "ml.c5n.18xlarge" || "ml.g5.xlarge" || "ml.g5.2xlarge" || "ml.g5.4xlarge" || "ml.g5.8xlarge" || "ml.g5.16xlarge" || "ml.g5.12xlarge" || "ml.g5.24xlarge" || "ml.g5.48xlarge" || "ml.g6.xlarge" || "ml.g6.2xlarge" || "ml.g6.4xlarge" || "ml.g6.8xlarge" || "ml.g6.16xlarge" || "ml.g6.12xlarge" || "ml.g6.24xlarge" || "ml.g6.48xlarge" || "ml.g6e.xlarge" || "ml.g6e.2xlarge" || "ml.g6e.4xlarge" || "ml.g6e.8xlarge" || "ml.g6e.16xlarge" || "ml.g6e.12xlarge" || "ml.g6e.24xlarge" || "ml.g6e.48xlarge" || "ml.trn1.2xlarge" || "ml.trn1.32xlarge" || "ml.trn1n.32xlarge" || "ml.trn2.48xlarge" || "ml.m6i.large" || "ml.m6i.xlarge" || "ml.m6i.2xlarge" || "ml.m6i.4xlarge" || "ml.m6i.8xlarge" || "ml.m6i.12xlarge" || "ml.m6i.16xlarge" || "ml.m6i.24xlarge" || "ml.m6i.32xlarge" || "ml.c6i.xlarge" || "ml.c6i.2xlarge" || "ml.c6i.8xlarge" || "ml.c6i.4xlarge" || "ml.c6i.12xlarge" || "ml.c6i.16xlarge" || "ml.c6i.24xlarge" || "ml.c6i.32xlarge" || "ml.r5d.large" || "ml.r5d.xlarge" || "ml.r5d.2xlarge" || "ml.r5d.4xlarge" || "ml.r5d.8xlarge" || "ml.r5d.12xlarge" || "ml.r5d.16xlarge" || "ml.r5d.24xlarge" || "ml.t3.medium" || "ml.t3.large" || "ml.t3.xlarge" || "ml.t3.2xlarge" || "ml.r5.large" || "ml.r5.xlarge" || "ml.r5.2xlarge" || "ml.r5.4xlarge" || "ml.r5.8xlarge" || "ml.r5.12xlarge" || "ml.r5.16xlarge" || "ml.r5.24xlarge", // required * // InstanceCount: Number("int"), // required * // InstanceGroupName: "STRING_VALUE", // required * // }, * // ], + * // TrainingPlanArn: "STRING_VALUE", * // }, * // HyperParameterTuningResourceConfig: { - * // InstanceType: "ml.m4.xlarge" || "ml.m4.2xlarge" || "ml.m4.4xlarge" || "ml.m4.10xlarge" || "ml.m4.16xlarge" || "ml.g4dn.xlarge" || "ml.g4dn.2xlarge" || "ml.g4dn.4xlarge" || "ml.g4dn.8xlarge" || "ml.g4dn.12xlarge" || "ml.g4dn.16xlarge" || "ml.m5.large" || "ml.m5.xlarge" || "ml.m5.2xlarge" || "ml.m5.4xlarge" || "ml.m5.12xlarge" || "ml.m5.24xlarge" || "ml.c4.xlarge" || "ml.c4.2xlarge" || "ml.c4.4xlarge" || "ml.c4.8xlarge" || "ml.p2.xlarge" || "ml.p2.8xlarge" || "ml.p2.16xlarge" || "ml.p3.2xlarge" || "ml.p3.8xlarge" || "ml.p3.16xlarge" || "ml.p3dn.24xlarge" || "ml.p4d.24xlarge" || "ml.p4de.24xlarge" || "ml.p5.48xlarge" || "ml.p5e.48xlarge" || "ml.c5.xlarge" || "ml.c5.2xlarge" || "ml.c5.4xlarge" || "ml.c5.9xlarge" || "ml.c5.18xlarge" || "ml.c5n.xlarge" || "ml.c5n.2xlarge" || "ml.c5n.4xlarge" || "ml.c5n.9xlarge" || "ml.c5n.18xlarge" || "ml.g5.xlarge" || "ml.g5.2xlarge" || "ml.g5.4xlarge" || "ml.g5.8xlarge" || "ml.g5.16xlarge" || "ml.g5.12xlarge" || "ml.g5.24xlarge" || "ml.g5.48xlarge" || "ml.g6.xlarge" || "ml.g6.2xlarge" || "ml.g6.4xlarge" || "ml.g6.8xlarge" || "ml.g6.16xlarge" || "ml.g6.12xlarge" || "ml.g6.24xlarge" || "ml.g6.48xlarge" || "ml.g6e.xlarge" || "ml.g6e.2xlarge" || "ml.g6e.4xlarge" || "ml.g6e.8xlarge" || "ml.g6e.16xlarge" || "ml.g6e.12xlarge" || "ml.g6e.24xlarge" || "ml.g6e.48xlarge" || "ml.trn1.2xlarge" || "ml.trn1.32xlarge" || "ml.trn1n.32xlarge" || "ml.m6i.large" || "ml.m6i.xlarge" || "ml.m6i.2xlarge" || "ml.m6i.4xlarge" || "ml.m6i.8xlarge" || "ml.m6i.12xlarge" || "ml.m6i.16xlarge" || "ml.m6i.24xlarge" || "ml.m6i.32xlarge" || "ml.c6i.xlarge" || "ml.c6i.2xlarge" || "ml.c6i.8xlarge" || "ml.c6i.4xlarge" || "ml.c6i.12xlarge" || "ml.c6i.16xlarge" || "ml.c6i.24xlarge" || "ml.c6i.32xlarge" || "ml.r5d.large" || "ml.r5d.xlarge" || "ml.r5d.2xlarge" || "ml.r5d.4xlarge" || "ml.r5d.8xlarge" || "ml.r5d.12xlarge" || "ml.r5d.16xlarge" || "ml.r5d.24xlarge" || "ml.t3.medium" || "ml.t3.large" || "ml.t3.xlarge" || "ml.t3.2xlarge" || "ml.r5.large" || "ml.r5.xlarge" || "ml.r5.2xlarge" || "ml.r5.4xlarge" || "ml.r5.8xlarge" || "ml.r5.12xlarge" || "ml.r5.16xlarge" || "ml.r5.24xlarge", + * // InstanceType: "ml.m4.xlarge" || "ml.m4.2xlarge" || "ml.m4.4xlarge" || "ml.m4.10xlarge" || "ml.m4.16xlarge" || "ml.g4dn.xlarge" || "ml.g4dn.2xlarge" || "ml.g4dn.4xlarge" || "ml.g4dn.8xlarge" || "ml.g4dn.12xlarge" || "ml.g4dn.16xlarge" || "ml.m5.large" || "ml.m5.xlarge" || "ml.m5.2xlarge" || "ml.m5.4xlarge" || "ml.m5.12xlarge" || "ml.m5.24xlarge" || "ml.c4.xlarge" || "ml.c4.2xlarge" || "ml.c4.4xlarge" || "ml.c4.8xlarge" || "ml.p2.xlarge" || "ml.p2.8xlarge" || "ml.p2.16xlarge" || "ml.p3.2xlarge" || "ml.p3.8xlarge" || "ml.p3.16xlarge" || "ml.p3dn.24xlarge" || "ml.p4d.24xlarge" || "ml.p4de.24xlarge" || "ml.p5.48xlarge" || "ml.p5e.48xlarge" || "ml.p5en.48xlarge" || "ml.c5.xlarge" || "ml.c5.2xlarge" || "ml.c5.4xlarge" || "ml.c5.9xlarge" || "ml.c5.18xlarge" || "ml.c5n.xlarge" || "ml.c5n.2xlarge" || "ml.c5n.4xlarge" || "ml.c5n.9xlarge" || "ml.c5n.18xlarge" || "ml.g5.xlarge" || "ml.g5.2xlarge" || "ml.g5.4xlarge" || "ml.g5.8xlarge" || "ml.g5.16xlarge" || "ml.g5.12xlarge" || "ml.g5.24xlarge" || "ml.g5.48xlarge" || "ml.g6.xlarge" || "ml.g6.2xlarge" || "ml.g6.4xlarge" || "ml.g6.8xlarge" || "ml.g6.16xlarge" || "ml.g6.12xlarge" || "ml.g6.24xlarge" || "ml.g6.48xlarge" || "ml.g6e.xlarge" || "ml.g6e.2xlarge" || "ml.g6e.4xlarge" || "ml.g6e.8xlarge" || "ml.g6e.16xlarge" || "ml.g6e.12xlarge" || "ml.g6e.24xlarge" || "ml.g6e.48xlarge" || "ml.trn1.2xlarge" || "ml.trn1.32xlarge" || "ml.trn1n.32xlarge" || "ml.trn2.48xlarge" || "ml.m6i.large" || "ml.m6i.xlarge" || "ml.m6i.2xlarge" || "ml.m6i.4xlarge" || "ml.m6i.8xlarge" || "ml.m6i.12xlarge" || "ml.m6i.16xlarge" || "ml.m6i.24xlarge" || "ml.m6i.32xlarge" || "ml.c6i.xlarge" || "ml.c6i.2xlarge" || "ml.c6i.8xlarge" || "ml.c6i.4xlarge" || "ml.c6i.12xlarge" || "ml.c6i.16xlarge" || "ml.c6i.24xlarge" || "ml.c6i.32xlarge" || "ml.r5d.large" || "ml.r5d.xlarge" || "ml.r5d.2xlarge" || "ml.r5d.4xlarge" || "ml.r5d.8xlarge" || "ml.r5d.12xlarge" || "ml.r5d.16xlarge" || "ml.r5d.24xlarge" || "ml.t3.medium" || "ml.t3.large" || "ml.t3.xlarge" || "ml.t3.2xlarge" || "ml.r5.large" || "ml.r5.xlarge" || "ml.r5.2xlarge" || "ml.r5.4xlarge" || "ml.r5.8xlarge" || "ml.r5.12xlarge" || "ml.r5.16xlarge" || "ml.r5.24xlarge", * // InstanceCount: Number("int"), * // VolumeSizeInGB: Number("int"), * // VolumeKmsKeyId: "STRING_VALUE", * // AllocationStrategy: "Prioritized", * // InstanceConfigs: [ * // { - * // InstanceType: "ml.m4.xlarge" || "ml.m4.2xlarge" || "ml.m4.4xlarge" || "ml.m4.10xlarge" || "ml.m4.16xlarge" || "ml.g4dn.xlarge" || "ml.g4dn.2xlarge" || "ml.g4dn.4xlarge" || "ml.g4dn.8xlarge" || "ml.g4dn.12xlarge" || "ml.g4dn.16xlarge" || "ml.m5.large" || "ml.m5.xlarge" || "ml.m5.2xlarge" || "ml.m5.4xlarge" || "ml.m5.12xlarge" || "ml.m5.24xlarge" || "ml.c4.xlarge" || "ml.c4.2xlarge" || "ml.c4.4xlarge" || "ml.c4.8xlarge" || "ml.p2.xlarge" || "ml.p2.8xlarge" || "ml.p2.16xlarge" || "ml.p3.2xlarge" || "ml.p3.8xlarge" || "ml.p3.16xlarge" || "ml.p3dn.24xlarge" || "ml.p4d.24xlarge" || "ml.p4de.24xlarge" || "ml.p5.48xlarge" || "ml.p5e.48xlarge" || "ml.c5.xlarge" || "ml.c5.2xlarge" || "ml.c5.4xlarge" || "ml.c5.9xlarge" || "ml.c5.18xlarge" || "ml.c5n.xlarge" || "ml.c5n.2xlarge" || "ml.c5n.4xlarge" || "ml.c5n.9xlarge" || "ml.c5n.18xlarge" || "ml.g5.xlarge" || "ml.g5.2xlarge" || "ml.g5.4xlarge" || "ml.g5.8xlarge" || "ml.g5.16xlarge" || "ml.g5.12xlarge" || "ml.g5.24xlarge" || "ml.g5.48xlarge" || "ml.g6.xlarge" || "ml.g6.2xlarge" || "ml.g6.4xlarge" || "ml.g6.8xlarge" || "ml.g6.16xlarge" || "ml.g6.12xlarge" || "ml.g6.24xlarge" || "ml.g6.48xlarge" || "ml.g6e.xlarge" || "ml.g6e.2xlarge" || "ml.g6e.4xlarge" || "ml.g6e.8xlarge" || "ml.g6e.16xlarge" || "ml.g6e.12xlarge" || "ml.g6e.24xlarge" || "ml.g6e.48xlarge" || "ml.trn1.2xlarge" || "ml.trn1.32xlarge" || "ml.trn1n.32xlarge" || "ml.m6i.large" || "ml.m6i.xlarge" || "ml.m6i.2xlarge" || "ml.m6i.4xlarge" || "ml.m6i.8xlarge" || "ml.m6i.12xlarge" || "ml.m6i.16xlarge" || "ml.m6i.24xlarge" || "ml.m6i.32xlarge" || "ml.c6i.xlarge" || "ml.c6i.2xlarge" || "ml.c6i.8xlarge" || "ml.c6i.4xlarge" || "ml.c6i.12xlarge" || "ml.c6i.16xlarge" || "ml.c6i.24xlarge" || "ml.c6i.32xlarge" || "ml.r5d.large" || "ml.r5d.xlarge" || "ml.r5d.2xlarge" || "ml.r5d.4xlarge" || "ml.r5d.8xlarge" || "ml.r5d.12xlarge" || "ml.r5d.16xlarge" || "ml.r5d.24xlarge" || "ml.t3.medium" || "ml.t3.large" || "ml.t3.xlarge" || "ml.t3.2xlarge" || "ml.r5.large" || "ml.r5.xlarge" || "ml.r5.2xlarge" || "ml.r5.4xlarge" || "ml.r5.8xlarge" || "ml.r5.12xlarge" || "ml.r5.16xlarge" || "ml.r5.24xlarge", // required + * // InstanceType: "ml.m4.xlarge" || "ml.m4.2xlarge" || "ml.m4.4xlarge" || "ml.m4.10xlarge" || "ml.m4.16xlarge" || "ml.g4dn.xlarge" || "ml.g4dn.2xlarge" || "ml.g4dn.4xlarge" || "ml.g4dn.8xlarge" || "ml.g4dn.12xlarge" || "ml.g4dn.16xlarge" || "ml.m5.large" || "ml.m5.xlarge" || "ml.m5.2xlarge" || "ml.m5.4xlarge" || "ml.m5.12xlarge" || "ml.m5.24xlarge" || "ml.c4.xlarge" || "ml.c4.2xlarge" || "ml.c4.4xlarge" || "ml.c4.8xlarge" || "ml.p2.xlarge" || "ml.p2.8xlarge" || "ml.p2.16xlarge" || "ml.p3.2xlarge" || "ml.p3.8xlarge" || "ml.p3.16xlarge" || "ml.p3dn.24xlarge" || "ml.p4d.24xlarge" || "ml.p4de.24xlarge" || "ml.p5.48xlarge" || "ml.p5e.48xlarge" || "ml.p5en.48xlarge" || "ml.c5.xlarge" || "ml.c5.2xlarge" || "ml.c5.4xlarge" || "ml.c5.9xlarge" || "ml.c5.18xlarge" || "ml.c5n.xlarge" || "ml.c5n.2xlarge" || "ml.c5n.4xlarge" || "ml.c5n.9xlarge" || "ml.c5n.18xlarge" || "ml.g5.xlarge" || "ml.g5.2xlarge" || "ml.g5.4xlarge" || "ml.g5.8xlarge" || "ml.g5.16xlarge" || "ml.g5.12xlarge" || "ml.g5.24xlarge" || "ml.g5.48xlarge" || "ml.g6.xlarge" || "ml.g6.2xlarge" || "ml.g6.4xlarge" || "ml.g6.8xlarge" || "ml.g6.16xlarge" || "ml.g6.12xlarge" || "ml.g6.24xlarge" || "ml.g6.48xlarge" || "ml.g6e.xlarge" || "ml.g6e.2xlarge" || "ml.g6e.4xlarge" || "ml.g6e.8xlarge" || "ml.g6e.16xlarge" || "ml.g6e.12xlarge" || "ml.g6e.24xlarge" || "ml.g6e.48xlarge" || "ml.trn1.2xlarge" || "ml.trn1.32xlarge" || "ml.trn1n.32xlarge" || "ml.trn2.48xlarge" || "ml.m6i.large" || "ml.m6i.xlarge" || "ml.m6i.2xlarge" || "ml.m6i.4xlarge" || "ml.m6i.8xlarge" || "ml.m6i.12xlarge" || "ml.m6i.16xlarge" || "ml.m6i.24xlarge" || "ml.m6i.32xlarge" || "ml.c6i.xlarge" || "ml.c6i.2xlarge" || "ml.c6i.8xlarge" || "ml.c6i.4xlarge" || "ml.c6i.12xlarge" || "ml.c6i.16xlarge" || "ml.c6i.24xlarge" || "ml.c6i.32xlarge" || "ml.r5d.large" || "ml.r5d.xlarge" || "ml.r5d.2xlarge" || "ml.r5d.4xlarge" || "ml.r5d.8xlarge" || "ml.r5d.12xlarge" || "ml.r5d.16xlarge" || "ml.r5d.24xlarge" || "ml.t3.medium" || "ml.t3.large" || "ml.t3.xlarge" || "ml.t3.2xlarge" || "ml.r5.large" || "ml.r5.xlarge" || "ml.r5.2xlarge" || "ml.r5.4xlarge" || "ml.r5.8xlarge" || "ml.r5.12xlarge" || "ml.r5.16xlarge" || "ml.r5.24xlarge", // required * // InstanceCount: Number("int"), // required * // VolumeSizeInGB: Number("int"), // required * // }, diff --git a/clients/client-sagemaker/src/commands/DescribeImageCommand.ts b/clients/client-sagemaker/src/commands/DescribeImageCommand.ts index 564536cc5d45..10ebbe3d93bd 100644 --- a/clients/client-sagemaker/src/commands/DescribeImageCommand.ts +++ b/clients/client-sagemaker/src/commands/DescribeImageCommand.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 { DescribeImageRequest, DescribeImageResponse } from "../models/models_2"; +import { DescribeImageRequest, DescribeImageResponse } from "../models/models_3"; import { de_DescribeImageCommand, se_DescribeImageCommand } from "../protocols/Aws_json1_1"; import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; diff --git a/clients/client-sagemaker/src/commands/DescribeImageVersionCommand.ts b/clients/client-sagemaker/src/commands/DescribeImageVersionCommand.ts index 549db501882b..723bad2739d4 100644 --- a/clients/client-sagemaker/src/commands/DescribeImageVersionCommand.ts +++ b/clients/client-sagemaker/src/commands/DescribeImageVersionCommand.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 { DescribeImageVersionRequest, DescribeImageVersionResponse } from "../models/models_2"; +import { DescribeImageVersionRequest, DescribeImageVersionResponse } from "../models/models_3"; import { de_DescribeImageVersionCommand, se_DescribeImageVersionCommand } from "../protocols/Aws_json1_1"; import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; diff --git a/clients/client-sagemaker/src/commands/DescribeInferenceComponentCommand.ts b/clients/client-sagemaker/src/commands/DescribeInferenceComponentCommand.ts index 3bac7987c69b..a0a08a710d72 100644 --- a/clients/client-sagemaker/src/commands/DescribeInferenceComponentCommand.ts +++ b/clients/client-sagemaker/src/commands/DescribeInferenceComponentCommand.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 { DescribeInferenceComponentInput, DescribeInferenceComponentOutput } from "../models/models_2"; +import { DescribeInferenceComponentInput, DescribeInferenceComponentOutput } from "../models/models_3"; import { de_DescribeInferenceComponentCommand, se_DescribeInferenceComponentCommand } from "../protocols/Aws_json1_1"; import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; diff --git a/clients/client-sagemaker/src/commands/DescribeInferenceExperimentCommand.ts b/clients/client-sagemaker/src/commands/DescribeInferenceExperimentCommand.ts index f332f164d01a..8b9cedcfcd57 100644 --- a/clients/client-sagemaker/src/commands/DescribeInferenceExperimentCommand.ts +++ b/clients/client-sagemaker/src/commands/DescribeInferenceExperimentCommand.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 { DescribeInferenceExperimentRequest, DescribeInferenceExperimentResponse } from "../models/models_2"; +import { DescribeInferenceExperimentRequest, DescribeInferenceExperimentResponse } from "../models/models_3"; import { de_DescribeInferenceExperimentCommand, se_DescribeInferenceExperimentCommand } from "../protocols/Aws_json1_1"; import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; diff --git a/clients/client-sagemaker/src/commands/DescribeInferenceRecommendationsJobCommand.ts b/clients/client-sagemaker/src/commands/DescribeInferenceRecommendationsJobCommand.ts index 82fa427fb007..0b95bfc2f8c7 100644 --- a/clients/client-sagemaker/src/commands/DescribeInferenceRecommendationsJobCommand.ts +++ b/clients/client-sagemaker/src/commands/DescribeInferenceRecommendationsJobCommand.ts @@ -5,8 +5,10 @@ import { Command as $Command } from "@smithy/smithy-client"; import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { commonParams } from "../endpoint/EndpointParameters"; -import { DescribeInferenceRecommendationsJobRequest } from "../models/models_2"; -import { DescribeInferenceRecommendationsJobResponse } from "../models/models_3"; +import { + DescribeInferenceRecommendationsJobRequest, + DescribeInferenceRecommendationsJobResponse, +} from "../models/models_3"; import { de_DescribeInferenceRecommendationsJobCommand, se_DescribeInferenceRecommendationsJobCommand, diff --git a/clients/client-sagemaker/src/commands/DescribePartnerAppCommand.ts b/clients/client-sagemaker/src/commands/DescribePartnerAppCommand.ts new file mode 100644 index 000000000000..daab2f8e2683 --- /dev/null +++ b/clients/client-sagemaker/src/commands/DescribePartnerAppCommand.ts @@ -0,0 +1,120 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { commonParams } from "../endpoint/EndpointParameters"; +import { DescribePartnerAppRequest, DescribePartnerAppResponse } from "../models/models_3"; +import { de_DescribePartnerAppCommand, se_DescribePartnerAppCommand } from "../protocols/Aws_json1_1"; +import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link DescribePartnerAppCommand}. + */ +export interface DescribePartnerAppCommandInput extends DescribePartnerAppRequest {} +/** + * @public + * + * The output of {@link DescribePartnerAppCommand}. + */ +export interface DescribePartnerAppCommandOutput extends DescribePartnerAppResponse, __MetadataBearer {} + +/** + *Gets information about a SageMaker Partner AI App.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, DescribePartnerAppCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, DescribePartnerAppCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const input = { // DescribePartnerAppRequest + * Arn: "STRING_VALUE", // required + * }; + * const command = new DescribePartnerAppCommand(input); + * const response = await client.send(command); + * // { // DescribePartnerAppResponse + * // Arn: "STRING_VALUE", + * // Name: "STRING_VALUE", + * // Type: "lakera-guard" || "comet" || "deepchecks-llm-evaluation" || "fiddler", + * // Status: "Creating" || "Updating" || "Deleting" || "Available" || "Failed" || "UpdateFailed" || "Deleted", + * // CreationTime: new Date("TIMESTAMP"), + * // ExecutionRoleArn: "STRING_VALUE", + * // BaseUrl: "STRING_VALUE", + * // MaintenanceConfig: { // PartnerAppMaintenanceConfig + * // MaintenanceWindowStart: "STRING_VALUE", + * // }, + * // Tier: "STRING_VALUE", + * // Version: "STRING_VALUE", + * // ApplicationConfig: { // PartnerAppConfig + * // AdminUsers: [ // PartnerAppAdminUserList + * // "STRING_VALUE", + * // ], + * // Arguments: { // PartnerAppArguments + * // "Resource being access is not found.
+ * + * @throws {@link SageMakerServiceException} + *Base exception class for all service exceptions from SageMaker service.
+ * + * @public + */ +export class DescribePartnerAppCommand extends $Command + .classBuilder< + DescribePartnerAppCommandInput, + DescribePartnerAppCommandOutput, + SageMakerClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: SageMakerClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("SageMaker", "DescribePartnerApp", {}) + .n("SageMakerClient", "DescribePartnerAppCommand") + .f(void 0, void 0) + .ser(se_DescribePartnerAppCommand) + .de(de_DescribePartnerAppCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: DescribePartnerAppRequest; + output: DescribePartnerAppResponse; + }; + sdk: { + input: DescribePartnerAppCommandInput; + output: DescribePartnerAppCommandOutput; + }; + }; +} diff --git a/clients/client-sagemaker/src/commands/DescribeSpaceCommand.ts b/clients/client-sagemaker/src/commands/DescribeSpaceCommand.ts index 5f57257ac5bf..98861c25675c 100644 --- a/clients/client-sagemaker/src/commands/DescribeSpaceCommand.ts +++ b/clients/client-sagemaker/src/commands/DescribeSpaceCommand.ts @@ -131,6 +131,9 @@ export interface DescribeSpaceCommandOutput extends DescribeSpaceResponse, __Met * // EFSFileSystem: { // EFSFileSystem * // FileSystemId: "STRING_VALUE", // required * // }, + * // FSxLustreFileSystem: { // FSxLustreFileSystem + * // FileSystemId: "STRING_VALUE", // required + * // }, * // }, * // ], * // }, diff --git a/clients/client-sagemaker/src/commands/DescribeTrainingJobCommand.ts b/clients/client-sagemaker/src/commands/DescribeTrainingJobCommand.ts index c7557e63ca1b..831aa929c718 100644 --- a/clients/client-sagemaker/src/commands/DescribeTrainingJobCommand.ts +++ b/clients/client-sagemaker/src/commands/DescribeTrainingJobCommand.ts @@ -123,18 +123,19 @@ export interface DescribeTrainingJobCommandOutput extends DescribeTrainingJobRes * // CompressionType: "GZIP" || "NONE", * // }, * // ResourceConfig: { // ResourceConfig - * // InstanceType: "ml.m4.xlarge" || "ml.m4.2xlarge" || "ml.m4.4xlarge" || "ml.m4.10xlarge" || "ml.m4.16xlarge" || "ml.g4dn.xlarge" || "ml.g4dn.2xlarge" || "ml.g4dn.4xlarge" || "ml.g4dn.8xlarge" || "ml.g4dn.12xlarge" || "ml.g4dn.16xlarge" || "ml.m5.large" || "ml.m5.xlarge" || "ml.m5.2xlarge" || "ml.m5.4xlarge" || "ml.m5.12xlarge" || "ml.m5.24xlarge" || "ml.c4.xlarge" || "ml.c4.2xlarge" || "ml.c4.4xlarge" || "ml.c4.8xlarge" || "ml.p2.xlarge" || "ml.p2.8xlarge" || "ml.p2.16xlarge" || "ml.p3.2xlarge" || "ml.p3.8xlarge" || "ml.p3.16xlarge" || "ml.p3dn.24xlarge" || "ml.p4d.24xlarge" || "ml.p4de.24xlarge" || "ml.p5.48xlarge" || "ml.p5e.48xlarge" || "ml.c5.xlarge" || "ml.c5.2xlarge" || "ml.c5.4xlarge" || "ml.c5.9xlarge" || "ml.c5.18xlarge" || "ml.c5n.xlarge" || "ml.c5n.2xlarge" || "ml.c5n.4xlarge" || "ml.c5n.9xlarge" || "ml.c5n.18xlarge" || "ml.g5.xlarge" || "ml.g5.2xlarge" || "ml.g5.4xlarge" || "ml.g5.8xlarge" || "ml.g5.16xlarge" || "ml.g5.12xlarge" || "ml.g5.24xlarge" || "ml.g5.48xlarge" || "ml.g6.xlarge" || "ml.g6.2xlarge" || "ml.g6.4xlarge" || "ml.g6.8xlarge" || "ml.g6.16xlarge" || "ml.g6.12xlarge" || "ml.g6.24xlarge" || "ml.g6.48xlarge" || "ml.g6e.xlarge" || "ml.g6e.2xlarge" || "ml.g6e.4xlarge" || "ml.g6e.8xlarge" || "ml.g6e.16xlarge" || "ml.g6e.12xlarge" || "ml.g6e.24xlarge" || "ml.g6e.48xlarge" || "ml.trn1.2xlarge" || "ml.trn1.32xlarge" || "ml.trn1n.32xlarge" || "ml.m6i.large" || "ml.m6i.xlarge" || "ml.m6i.2xlarge" || "ml.m6i.4xlarge" || "ml.m6i.8xlarge" || "ml.m6i.12xlarge" || "ml.m6i.16xlarge" || "ml.m6i.24xlarge" || "ml.m6i.32xlarge" || "ml.c6i.xlarge" || "ml.c6i.2xlarge" || "ml.c6i.8xlarge" || "ml.c6i.4xlarge" || "ml.c6i.12xlarge" || "ml.c6i.16xlarge" || "ml.c6i.24xlarge" || "ml.c6i.32xlarge" || "ml.r5d.large" || "ml.r5d.xlarge" || "ml.r5d.2xlarge" || "ml.r5d.4xlarge" || "ml.r5d.8xlarge" || "ml.r5d.12xlarge" || "ml.r5d.16xlarge" || "ml.r5d.24xlarge" || "ml.t3.medium" || "ml.t3.large" || "ml.t3.xlarge" || "ml.t3.2xlarge" || "ml.r5.large" || "ml.r5.xlarge" || "ml.r5.2xlarge" || "ml.r5.4xlarge" || "ml.r5.8xlarge" || "ml.r5.12xlarge" || "ml.r5.16xlarge" || "ml.r5.24xlarge", + * // InstanceType: "ml.m4.xlarge" || "ml.m4.2xlarge" || "ml.m4.4xlarge" || "ml.m4.10xlarge" || "ml.m4.16xlarge" || "ml.g4dn.xlarge" || "ml.g4dn.2xlarge" || "ml.g4dn.4xlarge" || "ml.g4dn.8xlarge" || "ml.g4dn.12xlarge" || "ml.g4dn.16xlarge" || "ml.m5.large" || "ml.m5.xlarge" || "ml.m5.2xlarge" || "ml.m5.4xlarge" || "ml.m5.12xlarge" || "ml.m5.24xlarge" || "ml.c4.xlarge" || "ml.c4.2xlarge" || "ml.c4.4xlarge" || "ml.c4.8xlarge" || "ml.p2.xlarge" || "ml.p2.8xlarge" || "ml.p2.16xlarge" || "ml.p3.2xlarge" || "ml.p3.8xlarge" || "ml.p3.16xlarge" || "ml.p3dn.24xlarge" || "ml.p4d.24xlarge" || "ml.p4de.24xlarge" || "ml.p5.48xlarge" || "ml.p5e.48xlarge" || "ml.p5en.48xlarge" || "ml.c5.xlarge" || "ml.c5.2xlarge" || "ml.c5.4xlarge" || "ml.c5.9xlarge" || "ml.c5.18xlarge" || "ml.c5n.xlarge" || "ml.c5n.2xlarge" || "ml.c5n.4xlarge" || "ml.c5n.9xlarge" || "ml.c5n.18xlarge" || "ml.g5.xlarge" || "ml.g5.2xlarge" || "ml.g5.4xlarge" || "ml.g5.8xlarge" || "ml.g5.16xlarge" || "ml.g5.12xlarge" || "ml.g5.24xlarge" || "ml.g5.48xlarge" || "ml.g6.xlarge" || "ml.g6.2xlarge" || "ml.g6.4xlarge" || "ml.g6.8xlarge" || "ml.g6.16xlarge" || "ml.g6.12xlarge" || "ml.g6.24xlarge" || "ml.g6.48xlarge" || "ml.g6e.xlarge" || "ml.g6e.2xlarge" || "ml.g6e.4xlarge" || "ml.g6e.8xlarge" || "ml.g6e.16xlarge" || "ml.g6e.12xlarge" || "ml.g6e.24xlarge" || "ml.g6e.48xlarge" || "ml.trn1.2xlarge" || "ml.trn1.32xlarge" || "ml.trn1n.32xlarge" || "ml.trn2.48xlarge" || "ml.m6i.large" || "ml.m6i.xlarge" || "ml.m6i.2xlarge" || "ml.m6i.4xlarge" || "ml.m6i.8xlarge" || "ml.m6i.12xlarge" || "ml.m6i.16xlarge" || "ml.m6i.24xlarge" || "ml.m6i.32xlarge" || "ml.c6i.xlarge" || "ml.c6i.2xlarge" || "ml.c6i.8xlarge" || "ml.c6i.4xlarge" || "ml.c6i.12xlarge" || "ml.c6i.16xlarge" || "ml.c6i.24xlarge" || "ml.c6i.32xlarge" || "ml.r5d.large" || "ml.r5d.xlarge" || "ml.r5d.2xlarge" || "ml.r5d.4xlarge" || "ml.r5d.8xlarge" || "ml.r5d.12xlarge" || "ml.r5d.16xlarge" || "ml.r5d.24xlarge" || "ml.t3.medium" || "ml.t3.large" || "ml.t3.xlarge" || "ml.t3.2xlarge" || "ml.r5.large" || "ml.r5.xlarge" || "ml.r5.2xlarge" || "ml.r5.4xlarge" || "ml.r5.8xlarge" || "ml.r5.12xlarge" || "ml.r5.16xlarge" || "ml.r5.24xlarge", * // InstanceCount: Number("int"), * // VolumeSizeInGB: Number("int"), // required * // VolumeKmsKeyId: "STRING_VALUE", * // KeepAlivePeriodInSeconds: Number("int"), * // InstanceGroups: [ // InstanceGroups * // { // InstanceGroup - * // InstanceType: "ml.m4.xlarge" || "ml.m4.2xlarge" || "ml.m4.4xlarge" || "ml.m4.10xlarge" || "ml.m4.16xlarge" || "ml.g4dn.xlarge" || "ml.g4dn.2xlarge" || "ml.g4dn.4xlarge" || "ml.g4dn.8xlarge" || "ml.g4dn.12xlarge" || "ml.g4dn.16xlarge" || "ml.m5.large" || "ml.m5.xlarge" || "ml.m5.2xlarge" || "ml.m5.4xlarge" || "ml.m5.12xlarge" || "ml.m5.24xlarge" || "ml.c4.xlarge" || "ml.c4.2xlarge" || "ml.c4.4xlarge" || "ml.c4.8xlarge" || "ml.p2.xlarge" || "ml.p2.8xlarge" || "ml.p2.16xlarge" || "ml.p3.2xlarge" || "ml.p3.8xlarge" || "ml.p3.16xlarge" || "ml.p3dn.24xlarge" || "ml.p4d.24xlarge" || "ml.p4de.24xlarge" || "ml.p5.48xlarge" || "ml.p5e.48xlarge" || "ml.c5.xlarge" || "ml.c5.2xlarge" || "ml.c5.4xlarge" || "ml.c5.9xlarge" || "ml.c5.18xlarge" || "ml.c5n.xlarge" || "ml.c5n.2xlarge" || "ml.c5n.4xlarge" || "ml.c5n.9xlarge" || "ml.c5n.18xlarge" || "ml.g5.xlarge" || "ml.g5.2xlarge" || "ml.g5.4xlarge" || "ml.g5.8xlarge" || "ml.g5.16xlarge" || "ml.g5.12xlarge" || "ml.g5.24xlarge" || "ml.g5.48xlarge" || "ml.g6.xlarge" || "ml.g6.2xlarge" || "ml.g6.4xlarge" || "ml.g6.8xlarge" || "ml.g6.16xlarge" || "ml.g6.12xlarge" || "ml.g6.24xlarge" || "ml.g6.48xlarge" || "ml.g6e.xlarge" || "ml.g6e.2xlarge" || "ml.g6e.4xlarge" || "ml.g6e.8xlarge" || "ml.g6e.16xlarge" || "ml.g6e.12xlarge" || "ml.g6e.24xlarge" || "ml.g6e.48xlarge" || "ml.trn1.2xlarge" || "ml.trn1.32xlarge" || "ml.trn1n.32xlarge" || "ml.m6i.large" || "ml.m6i.xlarge" || "ml.m6i.2xlarge" || "ml.m6i.4xlarge" || "ml.m6i.8xlarge" || "ml.m6i.12xlarge" || "ml.m6i.16xlarge" || "ml.m6i.24xlarge" || "ml.m6i.32xlarge" || "ml.c6i.xlarge" || "ml.c6i.2xlarge" || "ml.c6i.8xlarge" || "ml.c6i.4xlarge" || "ml.c6i.12xlarge" || "ml.c6i.16xlarge" || "ml.c6i.24xlarge" || "ml.c6i.32xlarge" || "ml.r5d.large" || "ml.r5d.xlarge" || "ml.r5d.2xlarge" || "ml.r5d.4xlarge" || "ml.r5d.8xlarge" || "ml.r5d.12xlarge" || "ml.r5d.16xlarge" || "ml.r5d.24xlarge" || "ml.t3.medium" || "ml.t3.large" || "ml.t3.xlarge" || "ml.t3.2xlarge" || "ml.r5.large" || "ml.r5.xlarge" || "ml.r5.2xlarge" || "ml.r5.4xlarge" || "ml.r5.8xlarge" || "ml.r5.12xlarge" || "ml.r5.16xlarge" || "ml.r5.24xlarge", // required + * // InstanceType: "ml.m4.xlarge" || "ml.m4.2xlarge" || "ml.m4.4xlarge" || "ml.m4.10xlarge" || "ml.m4.16xlarge" || "ml.g4dn.xlarge" || "ml.g4dn.2xlarge" || "ml.g4dn.4xlarge" || "ml.g4dn.8xlarge" || "ml.g4dn.12xlarge" || "ml.g4dn.16xlarge" || "ml.m5.large" || "ml.m5.xlarge" || "ml.m5.2xlarge" || "ml.m5.4xlarge" || "ml.m5.12xlarge" || "ml.m5.24xlarge" || "ml.c4.xlarge" || "ml.c4.2xlarge" || "ml.c4.4xlarge" || "ml.c4.8xlarge" || "ml.p2.xlarge" || "ml.p2.8xlarge" || "ml.p2.16xlarge" || "ml.p3.2xlarge" || "ml.p3.8xlarge" || "ml.p3.16xlarge" || "ml.p3dn.24xlarge" || "ml.p4d.24xlarge" || "ml.p4de.24xlarge" || "ml.p5.48xlarge" || "ml.p5e.48xlarge" || "ml.p5en.48xlarge" || "ml.c5.xlarge" || "ml.c5.2xlarge" || "ml.c5.4xlarge" || "ml.c5.9xlarge" || "ml.c5.18xlarge" || "ml.c5n.xlarge" || "ml.c5n.2xlarge" || "ml.c5n.4xlarge" || "ml.c5n.9xlarge" || "ml.c5n.18xlarge" || "ml.g5.xlarge" || "ml.g5.2xlarge" || "ml.g5.4xlarge" || "ml.g5.8xlarge" || "ml.g5.16xlarge" || "ml.g5.12xlarge" || "ml.g5.24xlarge" || "ml.g5.48xlarge" || "ml.g6.xlarge" || "ml.g6.2xlarge" || "ml.g6.4xlarge" || "ml.g6.8xlarge" || "ml.g6.16xlarge" || "ml.g6.12xlarge" || "ml.g6.24xlarge" || "ml.g6.48xlarge" || "ml.g6e.xlarge" || "ml.g6e.2xlarge" || "ml.g6e.4xlarge" || "ml.g6e.8xlarge" || "ml.g6e.16xlarge" || "ml.g6e.12xlarge" || "ml.g6e.24xlarge" || "ml.g6e.48xlarge" || "ml.trn1.2xlarge" || "ml.trn1.32xlarge" || "ml.trn1n.32xlarge" || "ml.trn2.48xlarge" || "ml.m6i.large" || "ml.m6i.xlarge" || "ml.m6i.2xlarge" || "ml.m6i.4xlarge" || "ml.m6i.8xlarge" || "ml.m6i.12xlarge" || "ml.m6i.16xlarge" || "ml.m6i.24xlarge" || "ml.m6i.32xlarge" || "ml.c6i.xlarge" || "ml.c6i.2xlarge" || "ml.c6i.8xlarge" || "ml.c6i.4xlarge" || "ml.c6i.12xlarge" || "ml.c6i.16xlarge" || "ml.c6i.24xlarge" || "ml.c6i.32xlarge" || "ml.r5d.large" || "ml.r5d.xlarge" || "ml.r5d.2xlarge" || "ml.r5d.4xlarge" || "ml.r5d.8xlarge" || "ml.r5d.12xlarge" || "ml.r5d.16xlarge" || "ml.r5d.24xlarge" || "ml.t3.medium" || "ml.t3.large" || "ml.t3.xlarge" || "ml.t3.2xlarge" || "ml.r5.large" || "ml.r5.xlarge" || "ml.r5.2xlarge" || "ml.r5.4xlarge" || "ml.r5.8xlarge" || "ml.r5.12xlarge" || "ml.r5.16xlarge" || "ml.r5.24xlarge", // required * // InstanceCount: Number("int"), // required * // InstanceGroupName: "STRING_VALUE", // required * // }, * // ], + * // TrainingPlanArn: "STRING_VALUE", * // }, * // WarmPoolStatus: { // WarmPoolStatus * // Status: "Available" || "Terminated" || "Reused" || "InUse", // required diff --git a/clients/client-sagemaker/src/commands/DescribeTrainingPlanCommand.ts b/clients/client-sagemaker/src/commands/DescribeTrainingPlanCommand.ts new file mode 100644 index 000000000000..ac1a14b760c3 --- /dev/null +++ b/clients/client-sagemaker/src/commands/DescribeTrainingPlanCommand.ts @@ -0,0 +1,123 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { commonParams } from "../endpoint/EndpointParameters"; +import { DescribeTrainingPlanRequest, DescribeTrainingPlanResponse } from "../models/models_3"; +import { de_DescribeTrainingPlanCommand, se_DescribeTrainingPlanCommand } from "../protocols/Aws_json1_1"; +import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link DescribeTrainingPlanCommand}. + */ +export interface DescribeTrainingPlanCommandInput extends DescribeTrainingPlanRequest {} +/** + * @public + * + * The output of {@link DescribeTrainingPlanCommand}. + */ +export interface DescribeTrainingPlanCommandOutput extends DescribeTrainingPlanResponse, __MetadataBearer {} + +/** + *Retrieves detailed information about a specific training plan.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, DescribeTrainingPlanCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, DescribeTrainingPlanCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const input = { // DescribeTrainingPlanRequest + * TrainingPlanName: "STRING_VALUE", // required + * }; + * const command = new DescribeTrainingPlanCommand(input); + * const response = await client.send(command); + * // { // DescribeTrainingPlanResponse + * // TrainingPlanArn: "STRING_VALUE", // required + * // TrainingPlanName: "STRING_VALUE", // required + * // Status: "Pending" || "Active" || "Scheduled" || "Expired" || "Failed", // required + * // StatusMessage: "STRING_VALUE", + * // DurationHours: Number("long"), + * // DurationMinutes: Number("long"), + * // StartTime: new Date("TIMESTAMP"), + * // EndTime: new Date("TIMESTAMP"), + * // UpfrontFee: "STRING_VALUE", + * // CurrencyCode: "STRING_VALUE", + * // TotalInstanceCount: Number("int"), + * // AvailableInstanceCount: Number("int"), + * // InUseInstanceCount: Number("int"), + * // TargetResources: [ // SageMakerResourceNames + * // "training-job" || "hyperpod-cluster", + * // ], + * // ReservedCapacitySummaries: [ // ReservedCapacitySummaries + * // { // ReservedCapacitySummary + * // ReservedCapacityArn: "STRING_VALUE", // required + * // InstanceType: "ml.p4d.24xlarge" || "ml.p5.48xlarge" || "ml.p5e.48xlarge" || "ml.p5en.48xlarge" || "ml.trn2.48xlarge", // required + * // TotalInstanceCount: Number("int"), // required + * // Status: "Pending" || "Active" || "Scheduled" || "Expired" || "Failed", // required + * // AvailabilityZone: "STRING_VALUE", + * // DurationHours: Number("long"), + * // DurationMinutes: Number("long"), + * // StartTime: new Date("TIMESTAMP"), + * // EndTime: new Date("TIMESTAMP"), + * // }, + * // ], + * // }; + * + * ``` + * + * @param DescribeTrainingPlanCommandInput - {@link DescribeTrainingPlanCommandInput} + * @returns {@link DescribeTrainingPlanCommandOutput} + * @see {@link DescribeTrainingPlanCommandInput} for command's `input` shape. + * @see {@link DescribeTrainingPlanCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for SageMakerClient's `config` shape. + * + * @throws {@link ResourceNotFound} (client fault) + *Resource being access is not found.
+ * + * @throws {@link SageMakerServiceException} + *Base exception class for all service exceptions from SageMaker service.
+ * + * @public + */ +export class DescribeTrainingPlanCommand extends $Command + .classBuilder< + DescribeTrainingPlanCommandInput, + DescribeTrainingPlanCommandOutput, + SageMakerClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: SageMakerClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("SageMaker", "DescribeTrainingPlan", {}) + .n("SageMakerClient", "DescribeTrainingPlanCommand") + .f(void 0, void 0) + .ser(se_DescribeTrainingPlanCommand) + .de(de_DescribeTrainingPlanCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: DescribeTrainingPlanRequest; + output: DescribeTrainingPlanResponse; + }; + sdk: { + input: DescribeTrainingPlanCommandInput; + output: DescribeTrainingPlanCommandOutput; + }; + }; +} diff --git a/clients/client-sagemaker/src/commands/DescribeUserProfileCommand.ts b/clients/client-sagemaker/src/commands/DescribeUserProfileCommand.ts index cd1f30d8ff5b..cf7c87122fae 100644 --- a/clients/client-sagemaker/src/commands/DescribeUserProfileCommand.ts +++ b/clients/client-sagemaker/src/commands/DescribeUserProfileCommand.ts @@ -242,11 +242,15 @@ export interface DescribeUserProfileCommandOutput extends DescribeUserProfileRes * // FileSystemId: "STRING_VALUE", // required * // FileSystemPath: "STRING_VALUE", * // }, + * // FSxLustreFileSystemConfig: { // FSxLustreFileSystemConfig + * // FileSystemId: "STRING_VALUE", // required + * // FileSystemPath: "STRING_VALUE", + * // }, * // }, * // ], * // StudioWebPortalSettings: { // StudioWebPortalSettings * // HiddenMlTools: [ // HiddenMlToolsList - * // "DataWrangler" || "FeatureStore" || "EmrClusters" || "AutoMl" || "Experiments" || "Training" || "ModelEvaluation" || "Pipelines" || "Models" || "JumpStart" || "InferenceRecommender" || "Endpoints" || "Projects" || "InferenceOptimization" || "PerformanceEvaluation", + * // "DataWrangler" || "FeatureStore" || "EmrClusters" || "AutoMl" || "Experiments" || "Training" || "ModelEvaluation" || "Pipelines" || "Models" || "JumpStart" || "InferenceRecommender" || "Endpoints" || "Projects" || "InferenceOptimization" || "PerformanceEvaluation" || "HyperPodClusters" || "LakeraGuard" || "Comet" || "DeepchecksLLMEvaluation" || "Fiddler", * // ], * // HiddenAppTypes: [ // HiddenAppTypesList * // "JupyterServer" || "KernelGateway" || "DetailedProfiler" || "TensorBoard" || "CodeEditor" || "JupyterLab" || "RStudioServerPro" || "RSessionGateway" || "Canvas", diff --git a/clients/client-sagemaker/src/commands/ListClusterNodesCommand.ts b/clients/client-sagemaker/src/commands/ListClusterNodesCommand.ts index dcb679420f24..2c607dc3d3e9 100644 --- a/clients/client-sagemaker/src/commands/ListClusterNodesCommand.ts +++ b/clients/client-sagemaker/src/commands/ListClusterNodesCommand.ts @@ -54,7 +54,7 @@ export interface ListClusterNodesCommandOutput extends ListClusterNodesResponse, * // { // ClusterNodeSummary * // InstanceGroupName: "STRING_VALUE", // required * // InstanceId: "STRING_VALUE", // required - * // InstanceType: "ml.p4d.24xlarge" || "ml.p4de.24xlarge" || "ml.p5.48xlarge" || "ml.trn1.32xlarge" || "ml.trn1n.32xlarge" || "ml.g5.xlarge" || "ml.g5.2xlarge" || "ml.g5.4xlarge" || "ml.g5.8xlarge" || "ml.g5.12xlarge" || "ml.g5.16xlarge" || "ml.g5.24xlarge" || "ml.g5.48xlarge" || "ml.c5.large" || "ml.c5.xlarge" || "ml.c5.2xlarge" || "ml.c5.4xlarge" || "ml.c5.9xlarge" || "ml.c5.12xlarge" || "ml.c5.18xlarge" || "ml.c5.24xlarge" || "ml.c5n.large" || "ml.c5n.2xlarge" || "ml.c5n.4xlarge" || "ml.c5n.9xlarge" || "ml.c5n.18xlarge" || "ml.m5.large" || "ml.m5.xlarge" || "ml.m5.2xlarge" || "ml.m5.4xlarge" || "ml.m5.8xlarge" || "ml.m5.12xlarge" || "ml.m5.16xlarge" || "ml.m5.24xlarge" || "ml.t3.medium" || "ml.t3.large" || "ml.t3.xlarge" || "ml.t3.2xlarge" || "ml.g6.xlarge" || "ml.g6.2xlarge" || "ml.g6.4xlarge" || "ml.g6.8xlarge" || "ml.g6.16xlarge" || "ml.g6.12xlarge" || "ml.g6.24xlarge" || "ml.g6.48xlarge" || "ml.gr6.4xlarge" || "ml.gr6.8xlarge" || "ml.g6e.xlarge" || "ml.g6e.2xlarge" || "ml.g6e.4xlarge" || "ml.g6e.8xlarge" || "ml.g6e.16xlarge" || "ml.g6e.12xlarge" || "ml.g6e.24xlarge" || "ml.g6e.48xlarge" || "ml.p5e.48xlarge", // required + * // InstanceType: "ml.p4d.24xlarge" || "ml.p4de.24xlarge" || "ml.p5.48xlarge" || "ml.trn1.32xlarge" || "ml.trn1n.32xlarge" || "ml.g5.xlarge" || "ml.g5.2xlarge" || "ml.g5.4xlarge" || "ml.g5.8xlarge" || "ml.g5.12xlarge" || "ml.g5.16xlarge" || "ml.g5.24xlarge" || "ml.g5.48xlarge" || "ml.c5.large" || "ml.c5.xlarge" || "ml.c5.2xlarge" || "ml.c5.4xlarge" || "ml.c5.9xlarge" || "ml.c5.12xlarge" || "ml.c5.18xlarge" || "ml.c5.24xlarge" || "ml.c5n.large" || "ml.c5n.2xlarge" || "ml.c5n.4xlarge" || "ml.c5n.9xlarge" || "ml.c5n.18xlarge" || "ml.m5.large" || "ml.m5.xlarge" || "ml.m5.2xlarge" || "ml.m5.4xlarge" || "ml.m5.8xlarge" || "ml.m5.12xlarge" || "ml.m5.16xlarge" || "ml.m5.24xlarge" || "ml.t3.medium" || "ml.t3.large" || "ml.t3.xlarge" || "ml.t3.2xlarge" || "ml.g6.xlarge" || "ml.g6.2xlarge" || "ml.g6.4xlarge" || "ml.g6.8xlarge" || "ml.g6.16xlarge" || "ml.g6.12xlarge" || "ml.g6.24xlarge" || "ml.g6.48xlarge" || "ml.gr6.4xlarge" || "ml.gr6.8xlarge" || "ml.g6e.xlarge" || "ml.g6e.2xlarge" || "ml.g6e.4xlarge" || "ml.g6e.8xlarge" || "ml.g6e.16xlarge" || "ml.g6e.12xlarge" || "ml.g6e.24xlarge" || "ml.g6e.48xlarge" || "ml.p5e.48xlarge" || "ml.p5en.48xlarge" || "ml.trn2.48xlarge", // required * // LaunchTime: new Date("TIMESTAMP"), // required * // InstanceStatus: { // ClusterInstanceStatusDetails * // Status: "Running" || "Failure" || "Pending" || "ShuttingDown" || "SystemUpdating" || "DeepHealthCheckInProgress", // required diff --git a/clients/client-sagemaker/src/commands/ListClusterSchedulerConfigsCommand.ts b/clients/client-sagemaker/src/commands/ListClusterSchedulerConfigsCommand.ts new file mode 100644 index 000000000000..df4742733bba --- /dev/null +++ b/clients/client-sagemaker/src/commands/ListClusterSchedulerConfigsCommand.ts @@ -0,0 +1,114 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { commonParams } from "../endpoint/EndpointParameters"; +import { ListClusterSchedulerConfigsRequest, ListClusterSchedulerConfigsResponse } from "../models/models_3"; +import { de_ListClusterSchedulerConfigsCommand, se_ListClusterSchedulerConfigsCommand } from "../protocols/Aws_json1_1"; +import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link ListClusterSchedulerConfigsCommand}. + */ +export interface ListClusterSchedulerConfigsCommandInput extends ListClusterSchedulerConfigsRequest {} +/** + * @public + * + * The output of {@link ListClusterSchedulerConfigsCommand}. + */ +export interface ListClusterSchedulerConfigsCommandOutput + extends ListClusterSchedulerConfigsResponse, + __MetadataBearer {} + +/** + *List the cluster policy configurations.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, ListClusterSchedulerConfigsCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, ListClusterSchedulerConfigsCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const input = { // ListClusterSchedulerConfigsRequest + * CreatedAfter: new Date("TIMESTAMP"), + * CreatedBefore: new Date("TIMESTAMP"), + * NameContains: "STRING_VALUE", + * ClusterArn: "STRING_VALUE", + * Status: "Creating" || "CreateFailed" || "CreateRollbackFailed" || "Created" || "Updating" || "UpdateFailed" || "UpdateRollbackFailed" || "Updated" || "Deleting" || "DeleteFailed" || "DeleteRollbackFailed" || "Deleted", + * SortBy: "Name" || "CreationTime" || "Status", + * SortOrder: "Ascending" || "Descending", + * NextToken: "STRING_VALUE", + * MaxResults: Number("int"), + * }; + * const command = new ListClusterSchedulerConfigsCommand(input); + * const response = await client.send(command); + * // { // ListClusterSchedulerConfigsResponse + * // ClusterSchedulerConfigSummaries: [ // ClusterSchedulerConfigSummaryList + * // { // ClusterSchedulerConfigSummary + * // ClusterSchedulerConfigArn: "STRING_VALUE", // required + * // ClusterSchedulerConfigId: "STRING_VALUE", // required + * // ClusterSchedulerConfigVersion: Number("int"), + * // Name: "STRING_VALUE", // required + * // CreationTime: new Date("TIMESTAMP"), // required + * // LastModifiedTime: new Date("TIMESTAMP"), + * // Status: "Creating" || "CreateFailed" || "CreateRollbackFailed" || "Created" || "Updating" || "UpdateFailed" || "UpdateRollbackFailed" || "Updated" || "Deleting" || "DeleteFailed" || "DeleteRollbackFailed" || "Deleted", // required + * // ClusterArn: "STRING_VALUE", + * // }, + * // ], + * // NextToken: "STRING_VALUE", + * // }; + * + * ``` + * + * @param ListClusterSchedulerConfigsCommandInput - {@link ListClusterSchedulerConfigsCommandInput} + * @returns {@link ListClusterSchedulerConfigsCommandOutput} + * @see {@link ListClusterSchedulerConfigsCommandInput} for command's `input` shape. + * @see {@link ListClusterSchedulerConfigsCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for SageMakerClient's `config` shape. + * + * @throws {@link SageMakerServiceException} + *Base exception class for all service exceptions from SageMaker service.
+ * + * @public + */ +export class ListClusterSchedulerConfigsCommand extends $Command + .classBuilder< + ListClusterSchedulerConfigsCommandInput, + ListClusterSchedulerConfigsCommandOutput, + SageMakerClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: SageMakerClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("SageMaker", "ListClusterSchedulerConfigs", {}) + .n("SageMakerClient", "ListClusterSchedulerConfigsCommand") + .f(void 0, void 0) + .ser(se_ListClusterSchedulerConfigsCommand) + .de(de_ListClusterSchedulerConfigsCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: ListClusterSchedulerConfigsRequest; + output: ListClusterSchedulerConfigsResponse; + }; + sdk: { + input: ListClusterSchedulerConfigsCommandInput; + output: ListClusterSchedulerConfigsCommandOutput; + }; + }; +} diff --git a/clients/client-sagemaker/src/commands/ListClustersCommand.ts b/clients/client-sagemaker/src/commands/ListClustersCommand.ts index a205acaaac22..5bc37aa33a90 100644 --- a/clients/client-sagemaker/src/commands/ListClustersCommand.ts +++ b/clients/client-sagemaker/src/commands/ListClustersCommand.ts @@ -43,6 +43,7 @@ export interface ListClustersCommandOutput extends ListClustersResponse, __Metad * NextToken: "STRING_VALUE", * SortBy: "CREATION_TIME" || "NAME", * SortOrder: "Ascending" || "Descending", + * TrainingPlanArn: "STRING_VALUE", * }; * const command = new ListClustersCommand(input); * const response = await client.send(command); @@ -54,6 +55,9 @@ export interface ListClustersCommandOutput extends ListClustersResponse, __Metad * // ClusterName: "STRING_VALUE", // required * // CreationTime: new Date("TIMESTAMP"), // required * // ClusterStatus: "Creating" || "Deleting" || "Failed" || "InService" || "RollingBack" || "SystemUpdating" || "Updating", // required + * // TrainingPlanArns: [ // TrainingPlanArns + * // "STRING_VALUE", + * // ], * // }, * // ], * // }; diff --git a/clients/client-sagemaker/src/commands/ListComputeQuotasCommand.ts b/clients/client-sagemaker/src/commands/ListComputeQuotasCommand.ts new file mode 100644 index 000000000000..02607ea8c448 --- /dev/null +++ b/clients/client-sagemaker/src/commands/ListComputeQuotasCommand.ts @@ -0,0 +1,130 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { commonParams } from "../endpoint/EndpointParameters"; +import { ListComputeQuotasRequest, ListComputeQuotasResponse } from "../models/models_3"; +import { de_ListComputeQuotasCommand, se_ListComputeQuotasCommand } from "../protocols/Aws_json1_1"; +import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link ListComputeQuotasCommand}. + */ +export interface ListComputeQuotasCommandInput extends ListComputeQuotasRequest {} +/** + * @public + * + * The output of {@link ListComputeQuotasCommand}. + */ +export interface ListComputeQuotasCommandOutput extends ListComputeQuotasResponse, __MetadataBearer {} + +/** + *List the resource allocation definitions.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, ListComputeQuotasCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, ListComputeQuotasCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const input = { // ListComputeQuotasRequest + * CreatedAfter: new Date("TIMESTAMP"), + * CreatedBefore: new Date("TIMESTAMP"), + * NameContains: "STRING_VALUE", + * Status: "Creating" || "CreateFailed" || "CreateRollbackFailed" || "Created" || "Updating" || "UpdateFailed" || "UpdateRollbackFailed" || "Updated" || "Deleting" || "DeleteFailed" || "DeleteRollbackFailed" || "Deleted", + * ClusterArn: "STRING_VALUE", + * SortBy: "Name" || "CreationTime" || "Status" || "ClusterArn", + * SortOrder: "Ascending" || "Descending", + * NextToken: "STRING_VALUE", + * MaxResults: Number("int"), + * }; + * const command = new ListComputeQuotasCommand(input); + * const response = await client.send(command); + * // { // ListComputeQuotasResponse + * // ComputeQuotaSummaries: [ // ComputeQuotaSummaryList + * // { // ComputeQuotaSummary + * // ComputeQuotaArn: "STRING_VALUE", // required + * // ComputeQuotaId: "STRING_VALUE", // required + * // Name: "STRING_VALUE", // required + * // ComputeQuotaVersion: Number("int"), + * // Status: "Creating" || "CreateFailed" || "CreateRollbackFailed" || "Created" || "Updating" || "UpdateFailed" || "UpdateRollbackFailed" || "Updated" || "Deleting" || "DeleteFailed" || "DeleteRollbackFailed" || "Deleted", // required + * // ClusterArn: "STRING_VALUE", + * // ComputeQuotaConfig: { // ComputeQuotaConfig + * // ComputeQuotaResources: [ // ComputeQuotaResourceConfigList + * // { // ComputeQuotaResourceConfig + * // InstanceType: "ml.p4d.24xlarge" || "ml.p4de.24xlarge" || "ml.p5.48xlarge" || "ml.trn1.32xlarge" || "ml.trn1n.32xlarge" || "ml.g5.xlarge" || "ml.g5.2xlarge" || "ml.g5.4xlarge" || "ml.g5.8xlarge" || "ml.g5.12xlarge" || "ml.g5.16xlarge" || "ml.g5.24xlarge" || "ml.g5.48xlarge" || "ml.c5.large" || "ml.c5.xlarge" || "ml.c5.2xlarge" || "ml.c5.4xlarge" || "ml.c5.9xlarge" || "ml.c5.12xlarge" || "ml.c5.18xlarge" || "ml.c5.24xlarge" || "ml.c5n.large" || "ml.c5n.2xlarge" || "ml.c5n.4xlarge" || "ml.c5n.9xlarge" || "ml.c5n.18xlarge" || "ml.m5.large" || "ml.m5.xlarge" || "ml.m5.2xlarge" || "ml.m5.4xlarge" || "ml.m5.8xlarge" || "ml.m5.12xlarge" || "ml.m5.16xlarge" || "ml.m5.24xlarge" || "ml.t3.medium" || "ml.t3.large" || "ml.t3.xlarge" || "ml.t3.2xlarge" || "ml.g6.xlarge" || "ml.g6.2xlarge" || "ml.g6.4xlarge" || "ml.g6.8xlarge" || "ml.g6.16xlarge" || "ml.g6.12xlarge" || "ml.g6.24xlarge" || "ml.g6.48xlarge" || "ml.gr6.4xlarge" || "ml.gr6.8xlarge" || "ml.g6e.xlarge" || "ml.g6e.2xlarge" || "ml.g6e.4xlarge" || "ml.g6e.8xlarge" || "ml.g6e.16xlarge" || "ml.g6e.12xlarge" || "ml.g6e.24xlarge" || "ml.g6e.48xlarge" || "ml.p5e.48xlarge" || "ml.p5en.48xlarge" || "ml.trn2.48xlarge", // required + * // Count: Number("int"), // required + * // }, + * // ], + * // ResourceSharingConfig: { // ResourceSharingConfig + * // Strategy: "Lend" || "DontLend" || "LendAndBorrow", // required + * // BorrowLimit: Number("int"), + * // }, + * // PreemptTeamTasks: "Never" || "LowerPriority", + * // }, + * // ComputeQuotaTarget: { // ComputeQuotaTarget + * // TeamName: "STRING_VALUE", // required + * // FairShareWeight: Number("int"), + * // }, + * // ActivationState: "Enabled" || "Disabled", + * // CreationTime: new Date("TIMESTAMP"), // required + * // LastModifiedTime: new Date("TIMESTAMP"), + * // }, + * // ], + * // NextToken: "STRING_VALUE", + * // }; + * + * ``` + * + * @param ListComputeQuotasCommandInput - {@link ListComputeQuotasCommandInput} + * @returns {@link ListComputeQuotasCommandOutput} + * @see {@link ListComputeQuotasCommandInput} for command's `input` shape. + * @see {@link ListComputeQuotasCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for SageMakerClient's `config` shape. + * + * @throws {@link SageMakerServiceException} + *Base exception class for all service exceptions from SageMaker service.
+ * + * @public + */ +export class ListComputeQuotasCommand extends $Command + .classBuilder< + ListComputeQuotasCommandInput, + ListComputeQuotasCommandOutput, + SageMakerClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: SageMakerClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("SageMaker", "ListComputeQuotas", {}) + .n("SageMakerClient", "ListComputeQuotasCommand") + .f(void 0, void 0) + .ser(se_ListComputeQuotasCommand) + .de(de_ListComputeQuotasCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: ListComputeQuotasRequest; + output: ListComputeQuotasResponse; + }; + sdk: { + input: ListComputeQuotasCommandInput; + output: ListComputeQuotasCommandOutput; + }; + }; +} diff --git a/clients/client-sagemaker/src/commands/ListDeviceFleetsCommand.ts b/clients/client-sagemaker/src/commands/ListDeviceFleetsCommand.ts index 3a83a8798890..b3b185bc66bf 100644 --- a/clients/client-sagemaker/src/commands/ListDeviceFleetsCommand.ts +++ b/clients/client-sagemaker/src/commands/ListDeviceFleetsCommand.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 { ListDeviceFleetsRequest, ListDeviceFleetsResponse } from "../models/models_3"; +import { ListDeviceFleetsRequest } from "../models/models_3"; +import { 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/ListDevicesCommand.ts b/clients/client-sagemaker/src/commands/ListDevicesCommand.ts index f7ba3f54662d..ed6b6625a146 100644 --- a/clients/client-sagemaker/src/commands/ListDevicesCommand.ts +++ b/clients/client-sagemaker/src/commands/ListDevicesCommand.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 { ListDevicesRequest, ListDevicesResponse } from "../models/models_3"; +import { ListDevicesRequest, ListDevicesResponse } from "../models/models_4"; import { de_ListDevicesCommand, se_ListDevicesCommand } from "../protocols/Aws_json1_1"; import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; diff --git a/clients/client-sagemaker/src/commands/ListDomainsCommand.ts b/clients/client-sagemaker/src/commands/ListDomainsCommand.ts index fb7aed0a6e29..f472b5c541dd 100644 --- a/clients/client-sagemaker/src/commands/ListDomainsCommand.ts +++ b/clients/client-sagemaker/src/commands/ListDomainsCommand.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 { ListDomainsRequest, ListDomainsResponse } from "../models/models_3"; +import { ListDomainsRequest, ListDomainsResponse } from "../models/models_4"; import { de_ListDomainsCommand, se_ListDomainsCommand } from "../protocols/Aws_json1_1"; import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; diff --git a/clients/client-sagemaker/src/commands/ListEdgeDeploymentPlansCommand.ts b/clients/client-sagemaker/src/commands/ListEdgeDeploymentPlansCommand.ts index 57150f0ce853..08675207e97d 100644 --- a/clients/client-sagemaker/src/commands/ListEdgeDeploymentPlansCommand.ts +++ b/clients/client-sagemaker/src/commands/ListEdgeDeploymentPlansCommand.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 { ListEdgeDeploymentPlansRequest, ListEdgeDeploymentPlansResponse } from "../models/models_3"; +import { ListEdgeDeploymentPlansRequest, ListEdgeDeploymentPlansResponse } from "../models/models_4"; import { de_ListEdgeDeploymentPlansCommand, se_ListEdgeDeploymentPlansCommand } from "../protocols/Aws_json1_1"; import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; diff --git a/clients/client-sagemaker/src/commands/ListEdgePackagingJobsCommand.ts b/clients/client-sagemaker/src/commands/ListEdgePackagingJobsCommand.ts index ecd38d4e75de..4705ff3f7f34 100644 --- a/clients/client-sagemaker/src/commands/ListEdgePackagingJobsCommand.ts +++ b/clients/client-sagemaker/src/commands/ListEdgePackagingJobsCommand.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 { ListEdgePackagingJobsRequest, ListEdgePackagingJobsResponse } from "../models/models_3"; +import { ListEdgePackagingJobsRequest, ListEdgePackagingJobsResponse } from "../models/models_4"; import { de_ListEdgePackagingJobsCommand, se_ListEdgePackagingJobsCommand } from "../protocols/Aws_json1_1"; import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; diff --git a/clients/client-sagemaker/src/commands/ListEndpointConfigsCommand.ts b/clients/client-sagemaker/src/commands/ListEndpointConfigsCommand.ts index 72ecdaec590d..5b60ffeb2540 100644 --- a/clients/client-sagemaker/src/commands/ListEndpointConfigsCommand.ts +++ b/clients/client-sagemaker/src/commands/ListEndpointConfigsCommand.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 { ListEndpointConfigsInput, ListEndpointConfigsOutput } from "../models/models_3"; +import { ListEndpointConfigsInput, ListEndpointConfigsOutput } from "../models/models_4"; import { de_ListEndpointConfigsCommand, se_ListEndpointConfigsCommand } from "../protocols/Aws_json1_1"; import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; diff --git a/clients/client-sagemaker/src/commands/ListEndpointsCommand.ts b/clients/client-sagemaker/src/commands/ListEndpointsCommand.ts index e3d725168606..018e1577dbbe 100644 --- a/clients/client-sagemaker/src/commands/ListEndpointsCommand.ts +++ b/clients/client-sagemaker/src/commands/ListEndpointsCommand.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 { ListEndpointsInput, ListEndpointsOutput } from "../models/models_3"; +import { ListEndpointsInput, ListEndpointsOutput } from "../models/models_4"; import { de_ListEndpointsCommand, se_ListEndpointsCommand } from "../protocols/Aws_json1_1"; import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; diff --git a/clients/client-sagemaker/src/commands/ListExperimentsCommand.ts b/clients/client-sagemaker/src/commands/ListExperimentsCommand.ts index 22da9d75a7be..c2d7cbebb4f0 100644 --- a/clients/client-sagemaker/src/commands/ListExperimentsCommand.ts +++ b/clients/client-sagemaker/src/commands/ListExperimentsCommand.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 { ListExperimentsRequest, ListExperimentsResponse } from "../models/models_3"; +import { ListExperimentsRequest, ListExperimentsResponse } from "../models/models_4"; import { de_ListExperimentsCommand, se_ListExperimentsCommand } from "../protocols/Aws_json1_1"; import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; diff --git a/clients/client-sagemaker/src/commands/ListFeatureGroupsCommand.ts b/clients/client-sagemaker/src/commands/ListFeatureGroupsCommand.ts index ffc364e7a4d0..d4528c068674 100644 --- a/clients/client-sagemaker/src/commands/ListFeatureGroupsCommand.ts +++ b/clients/client-sagemaker/src/commands/ListFeatureGroupsCommand.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 { ListFeatureGroupsRequest, ListFeatureGroupsResponse } from "../models/models_3"; +import { ListFeatureGroupsRequest, ListFeatureGroupsResponse } from "../models/models_4"; import { de_ListFeatureGroupsCommand, se_ListFeatureGroupsCommand } from "../protocols/Aws_json1_1"; import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; diff --git a/clients/client-sagemaker/src/commands/ListFlowDefinitionsCommand.ts b/clients/client-sagemaker/src/commands/ListFlowDefinitionsCommand.ts index 2e7622ecc10b..291837a63adf 100644 --- a/clients/client-sagemaker/src/commands/ListFlowDefinitionsCommand.ts +++ b/clients/client-sagemaker/src/commands/ListFlowDefinitionsCommand.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 { ListFlowDefinitionsRequest, ListFlowDefinitionsResponse } from "../models/models_3"; +import { ListFlowDefinitionsRequest, ListFlowDefinitionsResponse } from "../models/models_4"; import { de_ListFlowDefinitionsCommand, se_ListFlowDefinitionsCommand } from "../protocols/Aws_json1_1"; import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; diff --git a/clients/client-sagemaker/src/commands/ListHubContentVersionsCommand.ts b/clients/client-sagemaker/src/commands/ListHubContentVersionsCommand.ts index eccbd25b5615..273b23d59aa2 100644 --- a/clients/client-sagemaker/src/commands/ListHubContentVersionsCommand.ts +++ b/clients/client-sagemaker/src/commands/ListHubContentVersionsCommand.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 { ListHubContentVersionsRequest, ListHubContentVersionsResponse } from "../models/models_3"; +import { ListHubContentVersionsRequest, ListHubContentVersionsResponse } from "../models/models_4"; import { de_ListHubContentVersionsCommand, se_ListHubContentVersionsCommand } from "../protocols/Aws_json1_1"; import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; diff --git a/clients/client-sagemaker/src/commands/ListHubContentsCommand.ts b/clients/client-sagemaker/src/commands/ListHubContentsCommand.ts index e9cfac3d800c..a2ab84185185 100644 --- a/clients/client-sagemaker/src/commands/ListHubContentsCommand.ts +++ b/clients/client-sagemaker/src/commands/ListHubContentsCommand.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 { ListHubContentsRequest, ListHubContentsResponse } from "../models/models_3"; +import { ListHubContentsRequest, ListHubContentsResponse } from "../models/models_4"; import { de_ListHubContentsCommand, se_ListHubContentsCommand } from "../protocols/Aws_json1_1"; import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; diff --git a/clients/client-sagemaker/src/commands/ListHubsCommand.ts b/clients/client-sagemaker/src/commands/ListHubsCommand.ts index 78fac36e42ec..f90c40ca0ddb 100644 --- a/clients/client-sagemaker/src/commands/ListHubsCommand.ts +++ b/clients/client-sagemaker/src/commands/ListHubsCommand.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 { ListHubsRequest, ListHubsResponse } from "../models/models_3"; +import { ListHubsRequest, ListHubsResponse } from "../models/models_4"; import { de_ListHubsCommand, se_ListHubsCommand } from "../protocols/Aws_json1_1"; import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; diff --git a/clients/client-sagemaker/src/commands/ListHumanTaskUisCommand.ts b/clients/client-sagemaker/src/commands/ListHumanTaskUisCommand.ts index a5b8b982ec92..04dc8cbfc74c 100644 --- a/clients/client-sagemaker/src/commands/ListHumanTaskUisCommand.ts +++ b/clients/client-sagemaker/src/commands/ListHumanTaskUisCommand.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 { ListHumanTaskUisRequest, ListHumanTaskUisResponse } from "../models/models_3"; +import { ListHumanTaskUisRequest, ListHumanTaskUisResponse } from "../models/models_4"; import { de_ListHumanTaskUisCommand, se_ListHumanTaskUisCommand } from "../protocols/Aws_json1_1"; import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; diff --git a/clients/client-sagemaker/src/commands/ListHyperParameterTuningJobsCommand.ts b/clients/client-sagemaker/src/commands/ListHyperParameterTuningJobsCommand.ts index fc278223f10d..a062d12a04c3 100644 --- a/clients/client-sagemaker/src/commands/ListHyperParameterTuningJobsCommand.ts +++ b/clients/client-sagemaker/src/commands/ListHyperParameterTuningJobsCommand.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 { ListHyperParameterTuningJobsRequest, ListHyperParameterTuningJobsResponse } from "../models/models_3"; +import { ListHyperParameterTuningJobsRequest, ListHyperParameterTuningJobsResponse } from "../models/models_4"; import { de_ListHyperParameterTuningJobsCommand, se_ListHyperParameterTuningJobsCommand, diff --git a/clients/client-sagemaker/src/commands/ListImageVersionsCommand.ts b/clients/client-sagemaker/src/commands/ListImageVersionsCommand.ts index 3fb7a502887f..25d31bf3ad7f 100644 --- a/clients/client-sagemaker/src/commands/ListImageVersionsCommand.ts +++ b/clients/client-sagemaker/src/commands/ListImageVersionsCommand.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 { ListImageVersionsRequest, ListImageVersionsResponse } from "../models/models_3"; +import { ListImageVersionsRequest, ListImageVersionsResponse } from "../models/models_4"; import { de_ListImageVersionsCommand, se_ListImageVersionsCommand } from "../protocols/Aws_json1_1"; import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; diff --git a/clients/client-sagemaker/src/commands/ListImagesCommand.ts b/clients/client-sagemaker/src/commands/ListImagesCommand.ts index ace174969cd7..aae1c8f996b8 100644 --- a/clients/client-sagemaker/src/commands/ListImagesCommand.ts +++ b/clients/client-sagemaker/src/commands/ListImagesCommand.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 { ListImagesRequest, ListImagesResponse } from "../models/models_3"; +import { ListImagesRequest, ListImagesResponse } from "../models/models_4"; import { de_ListImagesCommand, se_ListImagesCommand } from "../protocols/Aws_json1_1"; import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; diff --git a/clients/client-sagemaker/src/commands/ListInferenceComponentsCommand.ts b/clients/client-sagemaker/src/commands/ListInferenceComponentsCommand.ts index 7fa6399acb5e..887ab306e754 100644 --- a/clients/client-sagemaker/src/commands/ListInferenceComponentsCommand.ts +++ b/clients/client-sagemaker/src/commands/ListInferenceComponentsCommand.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 { ListInferenceComponentsInput, ListInferenceComponentsOutput } from "../models/models_3"; +import { ListInferenceComponentsInput, ListInferenceComponentsOutput } from "../models/models_4"; import { de_ListInferenceComponentsCommand, se_ListInferenceComponentsCommand } from "../protocols/Aws_json1_1"; import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; diff --git a/clients/client-sagemaker/src/commands/ListInferenceExperimentsCommand.ts b/clients/client-sagemaker/src/commands/ListInferenceExperimentsCommand.ts index b4763ff02fbe..fe1c8328c7c5 100644 --- a/clients/client-sagemaker/src/commands/ListInferenceExperimentsCommand.ts +++ b/clients/client-sagemaker/src/commands/ListInferenceExperimentsCommand.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 { ListInferenceExperimentsRequest, ListInferenceExperimentsResponse } from "../models/models_3"; +import { ListInferenceExperimentsRequest, ListInferenceExperimentsResponse } from "../models/models_4"; import { de_ListInferenceExperimentsCommand, se_ListInferenceExperimentsCommand } from "../protocols/Aws_json1_1"; import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; diff --git a/clients/client-sagemaker/src/commands/ListInferenceRecommendationsJobStepsCommand.ts b/clients/client-sagemaker/src/commands/ListInferenceRecommendationsJobStepsCommand.ts index 20a8da799050..52c7c3ca2211 100644 --- a/clients/client-sagemaker/src/commands/ListInferenceRecommendationsJobStepsCommand.ts +++ b/clients/client-sagemaker/src/commands/ListInferenceRecommendationsJobStepsCommand.ts @@ -8,7 +8,7 @@ import { commonParams } from "../endpoint/EndpointParameters"; import { ListInferenceRecommendationsJobStepsRequest, ListInferenceRecommendationsJobStepsResponse, -} from "../models/models_3"; +} from "../models/models_4"; import { de_ListInferenceRecommendationsJobStepsCommand, se_ListInferenceRecommendationsJobStepsCommand, diff --git a/clients/client-sagemaker/src/commands/ListInferenceRecommendationsJobsCommand.ts b/clients/client-sagemaker/src/commands/ListInferenceRecommendationsJobsCommand.ts index 67b1c5bdbe32..ea84f10a6586 100644 --- a/clients/client-sagemaker/src/commands/ListInferenceRecommendationsJobsCommand.ts +++ b/clients/client-sagemaker/src/commands/ListInferenceRecommendationsJobsCommand.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 { ListInferenceRecommendationsJobsRequest, ListInferenceRecommendationsJobsResponse } from "../models/models_3"; +import { ListInferenceRecommendationsJobsRequest, ListInferenceRecommendationsJobsResponse } from "../models/models_4"; import { de_ListInferenceRecommendationsJobsCommand, se_ListInferenceRecommendationsJobsCommand, diff --git a/clients/client-sagemaker/src/commands/ListLabelingJobsCommand.ts b/clients/client-sagemaker/src/commands/ListLabelingJobsCommand.ts index 879a751d5618..7744a1e12523 100644 --- a/clients/client-sagemaker/src/commands/ListLabelingJobsCommand.ts +++ b/clients/client-sagemaker/src/commands/ListLabelingJobsCommand.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 { ListLabelingJobsRequest, ListLabelingJobsResponse } from "../models/models_3"; +import { ListLabelingJobsRequest, ListLabelingJobsResponse } from "../models/models_4"; import { de_ListLabelingJobsCommand, se_ListLabelingJobsCommand } from "../protocols/Aws_json1_1"; import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; diff --git a/clients/client-sagemaker/src/commands/ListLabelingJobsForWorkteamCommand.ts b/clients/client-sagemaker/src/commands/ListLabelingJobsForWorkteamCommand.ts index c09e82f20646..3a3783627cb2 100644 --- a/clients/client-sagemaker/src/commands/ListLabelingJobsForWorkteamCommand.ts +++ b/clients/client-sagemaker/src/commands/ListLabelingJobsForWorkteamCommand.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 { ListLabelingJobsForWorkteamRequest, ListLabelingJobsForWorkteamResponse } from "../models/models_3"; +import { ListLabelingJobsForWorkteamRequest, ListLabelingJobsForWorkteamResponse } from "../models/models_4"; import { de_ListLabelingJobsForWorkteamCommand, se_ListLabelingJobsForWorkteamCommand } from "../protocols/Aws_json1_1"; import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; diff --git a/clients/client-sagemaker/src/commands/ListLineageGroupsCommand.ts b/clients/client-sagemaker/src/commands/ListLineageGroupsCommand.ts index 6261b3744c03..121a93ad4c99 100644 --- a/clients/client-sagemaker/src/commands/ListLineageGroupsCommand.ts +++ b/clients/client-sagemaker/src/commands/ListLineageGroupsCommand.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 { ListLineageGroupsRequest } from "../models/models_3"; -import { ListLineageGroupsResponse } from "../models/models_4"; +import { ListLineageGroupsRequest, ListLineageGroupsResponse } from "../models/models_4"; import { de_ListLineageGroupsCommand, se_ListLineageGroupsCommand } from "../protocols/Aws_json1_1"; import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; diff --git a/clients/client-sagemaker/src/commands/ListPartnerAppsCommand.ts b/clients/client-sagemaker/src/commands/ListPartnerAppsCommand.ts new file mode 100644 index 000000000000..347ce8535e14 --- /dev/null +++ b/clients/client-sagemaker/src/commands/ListPartnerAppsCommand.ts @@ -0,0 +1,102 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { commonParams } from "../endpoint/EndpointParameters"; +import { ListPartnerAppsRequest, ListPartnerAppsResponse } from "../models/models_4"; +import { de_ListPartnerAppsCommand, se_ListPartnerAppsCommand } from "../protocols/Aws_json1_1"; +import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link ListPartnerAppsCommand}. + */ +export interface ListPartnerAppsCommandInput extends ListPartnerAppsRequest {} +/** + * @public + * + * The output of {@link ListPartnerAppsCommand}. + */ +export interface ListPartnerAppsCommandOutput extends ListPartnerAppsResponse, __MetadataBearer {} + +/** + *Lists all of the SageMaker Partner AI Apps in an account.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, ListPartnerAppsCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, ListPartnerAppsCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const input = { // ListPartnerAppsRequest + * MaxResults: Number("int"), + * NextToken: "STRING_VALUE", + * }; + * const command = new ListPartnerAppsCommand(input); + * const response = await client.send(command); + * // { // ListPartnerAppsResponse + * // Summaries: [ // PartnerAppSummaries + * // { // PartnerAppSummary + * // Arn: "STRING_VALUE", + * // Name: "STRING_VALUE", + * // Type: "lakera-guard" || "comet" || "deepchecks-llm-evaluation" || "fiddler", + * // Status: "Creating" || "Updating" || "Deleting" || "Available" || "Failed" || "UpdateFailed" || "Deleted", + * // CreationTime: new Date("TIMESTAMP"), + * // }, + * // ], + * // NextToken: "STRING_VALUE", + * // }; + * + * ``` + * + * @param ListPartnerAppsCommandInput - {@link ListPartnerAppsCommandInput} + * @returns {@link ListPartnerAppsCommandOutput} + * @see {@link ListPartnerAppsCommandInput} for command's `input` shape. + * @see {@link ListPartnerAppsCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for SageMakerClient's `config` shape. + * + * @throws {@link SageMakerServiceException} + *Base exception class for all service exceptions from SageMaker service.
+ * + * @public + */ +export class ListPartnerAppsCommand extends $Command + .classBuilder< + ListPartnerAppsCommandInput, + ListPartnerAppsCommandOutput, + SageMakerClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: SageMakerClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("SageMaker", "ListPartnerApps", {}) + .n("SageMakerClient", "ListPartnerAppsCommand") + .f(void 0, void 0) + .ser(se_ListPartnerAppsCommand) + .de(de_ListPartnerAppsCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: ListPartnerAppsRequest; + output: ListPartnerAppsResponse; + }; + sdk: { + input: ListPartnerAppsCommandInput; + output: ListPartnerAppsCommandOutput; + }; + }; +} diff --git a/clients/client-sagemaker/src/commands/ListTrainingJobsCommand.ts b/clients/client-sagemaker/src/commands/ListTrainingJobsCommand.ts index d167615722b6..2c2dec42f8d8 100644 --- a/clients/client-sagemaker/src/commands/ListTrainingJobsCommand.ts +++ b/clients/client-sagemaker/src/commands/ListTrainingJobsCommand.ts @@ -68,6 +68,7 @@ export interface ListTrainingJobsCommandOutput extends ListTrainingJobsResponse, * SortBy: "Name" || "CreationTime" || "Status", * SortOrder: "Ascending" || "Descending", * WarmPoolStatusEquals: "Available" || "Terminated" || "Reused" || "InUse", + * TrainingPlanArnEquals: "STRING_VALUE", * }; * const command = new ListTrainingJobsCommand(input); * const response = await client.send(command); @@ -86,6 +87,7 @@ export interface ListTrainingJobsCommandOutput extends ListTrainingJobsResponse, * // ResourceRetainedBillableTimeInSeconds: Number("int"), * // ReusedByJob: "STRING_VALUE", * // }, + * // TrainingPlanArn: "STRING_VALUE", * // }, * // ], * // NextToken: "STRING_VALUE", diff --git a/clients/client-sagemaker/src/commands/ListTrainingPlansCommand.ts b/clients/client-sagemaker/src/commands/ListTrainingPlansCommand.ts new file mode 100644 index 000000000000..a457e556fea7 --- /dev/null +++ b/clients/client-sagemaker/src/commands/ListTrainingPlansCommand.ts @@ -0,0 +1,136 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { commonParams } from "../endpoint/EndpointParameters"; +import { ListTrainingPlansRequest, ListTrainingPlansResponse } from "../models/models_4"; +import { de_ListTrainingPlansCommand, se_ListTrainingPlansCommand } from "../protocols/Aws_json1_1"; +import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link ListTrainingPlansCommand}. + */ +export interface ListTrainingPlansCommandInput extends ListTrainingPlansRequest {} +/** + * @public + * + * The output of {@link ListTrainingPlansCommand}. + */ +export interface ListTrainingPlansCommandOutput extends ListTrainingPlansResponse, __MetadataBearer {} + +/** + *Retrieves a list of training plans for the current account.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, ListTrainingPlansCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, ListTrainingPlansCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const input = { // ListTrainingPlansRequest + * NextToken: "STRING_VALUE", + * MaxResults: Number("int"), + * StartTimeAfter: new Date("TIMESTAMP"), + * StartTimeBefore: new Date("TIMESTAMP"), + * SortBy: "TrainingPlanName" || "StartTime" || "Status", + * SortOrder: "Ascending" || "Descending", + * Filters: [ // TrainingPlanFilters + * { // TrainingPlanFilter + * Name: "Status", // required + * Value: "STRING_VALUE", // required + * }, + * ], + * }; + * const command = new ListTrainingPlansCommand(input); + * const response = await client.send(command); + * // { // ListTrainingPlansResponse + * // NextToken: "STRING_VALUE", + * // TrainingPlanSummaries: [ // TrainingPlanSummaries // required + * // { // TrainingPlanSummary + * // TrainingPlanArn: "STRING_VALUE", // required + * // TrainingPlanName: "STRING_VALUE", // required + * // Status: "Pending" || "Active" || "Scheduled" || "Expired" || "Failed", // required + * // StatusMessage: "STRING_VALUE", + * // DurationHours: Number("long"), + * // DurationMinutes: Number("long"), + * // StartTime: new Date("TIMESTAMP"), + * // EndTime: new Date("TIMESTAMP"), + * // UpfrontFee: "STRING_VALUE", + * // CurrencyCode: "STRING_VALUE", + * // TotalInstanceCount: Number("int"), + * // AvailableInstanceCount: Number("int"), + * // InUseInstanceCount: Number("int"), + * // TargetResources: [ // SageMakerResourceNames + * // "training-job" || "hyperpod-cluster", + * // ], + * // ReservedCapacitySummaries: [ // ReservedCapacitySummaries + * // { // ReservedCapacitySummary + * // ReservedCapacityArn: "STRING_VALUE", // required + * // InstanceType: "ml.p4d.24xlarge" || "ml.p5.48xlarge" || "ml.p5e.48xlarge" || "ml.p5en.48xlarge" || "ml.trn2.48xlarge", // required + * // TotalInstanceCount: Number("int"), // required + * // Status: "Pending" || "Active" || "Scheduled" || "Expired" || "Failed", // required + * // AvailabilityZone: "STRING_VALUE", + * // DurationHours: Number("long"), + * // DurationMinutes: Number("long"), + * // StartTime: new Date("TIMESTAMP"), + * // EndTime: new Date("TIMESTAMP"), + * // }, + * // ], + * // }, + * // ], + * // }; + * + * ``` + * + * @param ListTrainingPlansCommandInput - {@link ListTrainingPlansCommandInput} + * @returns {@link ListTrainingPlansCommandOutput} + * @see {@link ListTrainingPlansCommandInput} for command's `input` shape. + * @see {@link ListTrainingPlansCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for SageMakerClient's `config` shape. + * + * @throws {@link SageMakerServiceException} + *Base exception class for all service exceptions from SageMaker service.
+ * + * @public + */ +export class ListTrainingPlansCommand extends $Command + .classBuilder< + ListTrainingPlansCommandInput, + ListTrainingPlansCommandOutput, + SageMakerClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: SageMakerClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("SageMaker", "ListTrainingPlans", {}) + .n("SageMakerClient", "ListTrainingPlansCommand") + .f(void 0, void 0) + .ser(se_ListTrainingPlansCommand) + .de(de_ListTrainingPlansCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: ListTrainingPlansRequest; + output: ListTrainingPlansResponse; + }; + sdk: { + input: ListTrainingPlansCommandInput; + output: ListTrainingPlansCommandOutput; + }; + }; +} diff --git a/clients/client-sagemaker/src/commands/SearchCommand.ts b/clients/client-sagemaker/src/commands/SearchCommand.ts index 6fbfdc4fc648..f02c316ea4c3 100644 --- a/clients/client-sagemaker/src/commands/SearchCommand.ts +++ b/clients/client-sagemaker/src/commands/SearchCommand.ts @@ -184,18 +184,19 @@ export interface SearchCommandOutput extends SearchResponse, __MetadataBearer {} * // CompressionType: "GZIP" || "NONE", * // }, * // ResourceConfig: { // ResourceConfig - * // InstanceType: "ml.m4.xlarge" || "ml.m4.2xlarge" || "ml.m4.4xlarge" || "ml.m4.10xlarge" || "ml.m4.16xlarge" || "ml.g4dn.xlarge" || "ml.g4dn.2xlarge" || "ml.g4dn.4xlarge" || "ml.g4dn.8xlarge" || "ml.g4dn.12xlarge" || "ml.g4dn.16xlarge" || "ml.m5.large" || "ml.m5.xlarge" || "ml.m5.2xlarge" || "ml.m5.4xlarge" || "ml.m5.12xlarge" || "ml.m5.24xlarge" || "ml.c4.xlarge" || "ml.c4.2xlarge" || "ml.c4.4xlarge" || "ml.c4.8xlarge" || "ml.p2.xlarge" || "ml.p2.8xlarge" || "ml.p2.16xlarge" || "ml.p3.2xlarge" || "ml.p3.8xlarge" || "ml.p3.16xlarge" || "ml.p3dn.24xlarge" || "ml.p4d.24xlarge" || "ml.p4de.24xlarge" || "ml.p5.48xlarge" || "ml.p5e.48xlarge" || "ml.c5.xlarge" || "ml.c5.2xlarge" || "ml.c5.4xlarge" || "ml.c5.9xlarge" || "ml.c5.18xlarge" || "ml.c5n.xlarge" || "ml.c5n.2xlarge" || "ml.c5n.4xlarge" || "ml.c5n.9xlarge" || "ml.c5n.18xlarge" || "ml.g5.xlarge" || "ml.g5.2xlarge" || "ml.g5.4xlarge" || "ml.g5.8xlarge" || "ml.g5.16xlarge" || "ml.g5.12xlarge" || "ml.g5.24xlarge" || "ml.g5.48xlarge" || "ml.g6.xlarge" || "ml.g6.2xlarge" || "ml.g6.4xlarge" || "ml.g6.8xlarge" || "ml.g6.16xlarge" || "ml.g6.12xlarge" || "ml.g6.24xlarge" || "ml.g6.48xlarge" || "ml.g6e.xlarge" || "ml.g6e.2xlarge" || "ml.g6e.4xlarge" || "ml.g6e.8xlarge" || "ml.g6e.16xlarge" || "ml.g6e.12xlarge" || "ml.g6e.24xlarge" || "ml.g6e.48xlarge" || "ml.trn1.2xlarge" || "ml.trn1.32xlarge" || "ml.trn1n.32xlarge" || "ml.m6i.large" || "ml.m6i.xlarge" || "ml.m6i.2xlarge" || "ml.m6i.4xlarge" || "ml.m6i.8xlarge" || "ml.m6i.12xlarge" || "ml.m6i.16xlarge" || "ml.m6i.24xlarge" || "ml.m6i.32xlarge" || "ml.c6i.xlarge" || "ml.c6i.2xlarge" || "ml.c6i.8xlarge" || "ml.c6i.4xlarge" || "ml.c6i.12xlarge" || "ml.c6i.16xlarge" || "ml.c6i.24xlarge" || "ml.c6i.32xlarge" || "ml.r5d.large" || "ml.r5d.xlarge" || "ml.r5d.2xlarge" || "ml.r5d.4xlarge" || "ml.r5d.8xlarge" || "ml.r5d.12xlarge" || "ml.r5d.16xlarge" || "ml.r5d.24xlarge" || "ml.t3.medium" || "ml.t3.large" || "ml.t3.xlarge" || "ml.t3.2xlarge" || "ml.r5.large" || "ml.r5.xlarge" || "ml.r5.2xlarge" || "ml.r5.4xlarge" || "ml.r5.8xlarge" || "ml.r5.12xlarge" || "ml.r5.16xlarge" || "ml.r5.24xlarge", + * // InstanceType: "ml.m4.xlarge" || "ml.m4.2xlarge" || "ml.m4.4xlarge" || "ml.m4.10xlarge" || "ml.m4.16xlarge" || "ml.g4dn.xlarge" || "ml.g4dn.2xlarge" || "ml.g4dn.4xlarge" || "ml.g4dn.8xlarge" || "ml.g4dn.12xlarge" || "ml.g4dn.16xlarge" || "ml.m5.large" || "ml.m5.xlarge" || "ml.m5.2xlarge" || "ml.m5.4xlarge" || "ml.m5.12xlarge" || "ml.m5.24xlarge" || "ml.c4.xlarge" || "ml.c4.2xlarge" || "ml.c4.4xlarge" || "ml.c4.8xlarge" || "ml.p2.xlarge" || "ml.p2.8xlarge" || "ml.p2.16xlarge" || "ml.p3.2xlarge" || "ml.p3.8xlarge" || "ml.p3.16xlarge" || "ml.p3dn.24xlarge" || "ml.p4d.24xlarge" || "ml.p4de.24xlarge" || "ml.p5.48xlarge" || "ml.p5e.48xlarge" || "ml.p5en.48xlarge" || "ml.c5.xlarge" || "ml.c5.2xlarge" || "ml.c5.4xlarge" || "ml.c5.9xlarge" || "ml.c5.18xlarge" || "ml.c5n.xlarge" || "ml.c5n.2xlarge" || "ml.c5n.4xlarge" || "ml.c5n.9xlarge" || "ml.c5n.18xlarge" || "ml.g5.xlarge" || "ml.g5.2xlarge" || "ml.g5.4xlarge" || "ml.g5.8xlarge" || "ml.g5.16xlarge" || "ml.g5.12xlarge" || "ml.g5.24xlarge" || "ml.g5.48xlarge" || "ml.g6.xlarge" || "ml.g6.2xlarge" || "ml.g6.4xlarge" || "ml.g6.8xlarge" || "ml.g6.16xlarge" || "ml.g6.12xlarge" || "ml.g6.24xlarge" || "ml.g6.48xlarge" || "ml.g6e.xlarge" || "ml.g6e.2xlarge" || "ml.g6e.4xlarge" || "ml.g6e.8xlarge" || "ml.g6e.16xlarge" || "ml.g6e.12xlarge" || "ml.g6e.24xlarge" || "ml.g6e.48xlarge" || "ml.trn1.2xlarge" || "ml.trn1.32xlarge" || "ml.trn1n.32xlarge" || "ml.trn2.48xlarge" || "ml.m6i.large" || "ml.m6i.xlarge" || "ml.m6i.2xlarge" || "ml.m6i.4xlarge" || "ml.m6i.8xlarge" || "ml.m6i.12xlarge" || "ml.m6i.16xlarge" || "ml.m6i.24xlarge" || "ml.m6i.32xlarge" || "ml.c6i.xlarge" || "ml.c6i.2xlarge" || "ml.c6i.8xlarge" || "ml.c6i.4xlarge" || "ml.c6i.12xlarge" || "ml.c6i.16xlarge" || "ml.c6i.24xlarge" || "ml.c6i.32xlarge" || "ml.r5d.large" || "ml.r5d.xlarge" || "ml.r5d.2xlarge" || "ml.r5d.4xlarge" || "ml.r5d.8xlarge" || "ml.r5d.12xlarge" || "ml.r5d.16xlarge" || "ml.r5d.24xlarge" || "ml.t3.medium" || "ml.t3.large" || "ml.t3.xlarge" || "ml.t3.2xlarge" || "ml.r5.large" || "ml.r5.xlarge" || "ml.r5.2xlarge" || "ml.r5.4xlarge" || "ml.r5.8xlarge" || "ml.r5.12xlarge" || "ml.r5.16xlarge" || "ml.r5.24xlarge", * // InstanceCount: Number("int"), * // VolumeSizeInGB: Number("int"), // required * // VolumeKmsKeyId: "STRING_VALUE", * // KeepAlivePeriodInSeconds: Number("int"), * // InstanceGroups: [ // InstanceGroups * // { // InstanceGroup - * // InstanceType: "ml.m4.xlarge" || "ml.m4.2xlarge" || "ml.m4.4xlarge" || "ml.m4.10xlarge" || "ml.m4.16xlarge" || "ml.g4dn.xlarge" || "ml.g4dn.2xlarge" || "ml.g4dn.4xlarge" || "ml.g4dn.8xlarge" || "ml.g4dn.12xlarge" || "ml.g4dn.16xlarge" || "ml.m5.large" || "ml.m5.xlarge" || "ml.m5.2xlarge" || "ml.m5.4xlarge" || "ml.m5.12xlarge" || "ml.m5.24xlarge" || "ml.c4.xlarge" || "ml.c4.2xlarge" || "ml.c4.4xlarge" || "ml.c4.8xlarge" || "ml.p2.xlarge" || "ml.p2.8xlarge" || "ml.p2.16xlarge" || "ml.p3.2xlarge" || "ml.p3.8xlarge" || "ml.p3.16xlarge" || "ml.p3dn.24xlarge" || "ml.p4d.24xlarge" || "ml.p4de.24xlarge" || "ml.p5.48xlarge" || "ml.p5e.48xlarge" || "ml.c5.xlarge" || "ml.c5.2xlarge" || "ml.c5.4xlarge" || "ml.c5.9xlarge" || "ml.c5.18xlarge" || "ml.c5n.xlarge" || "ml.c5n.2xlarge" || "ml.c5n.4xlarge" || "ml.c5n.9xlarge" || "ml.c5n.18xlarge" || "ml.g5.xlarge" || "ml.g5.2xlarge" || "ml.g5.4xlarge" || "ml.g5.8xlarge" || "ml.g5.16xlarge" || "ml.g5.12xlarge" || "ml.g5.24xlarge" || "ml.g5.48xlarge" || "ml.g6.xlarge" || "ml.g6.2xlarge" || "ml.g6.4xlarge" || "ml.g6.8xlarge" || "ml.g6.16xlarge" || "ml.g6.12xlarge" || "ml.g6.24xlarge" || "ml.g6.48xlarge" || "ml.g6e.xlarge" || "ml.g6e.2xlarge" || "ml.g6e.4xlarge" || "ml.g6e.8xlarge" || "ml.g6e.16xlarge" || "ml.g6e.12xlarge" || "ml.g6e.24xlarge" || "ml.g6e.48xlarge" || "ml.trn1.2xlarge" || "ml.trn1.32xlarge" || "ml.trn1n.32xlarge" || "ml.m6i.large" || "ml.m6i.xlarge" || "ml.m6i.2xlarge" || "ml.m6i.4xlarge" || "ml.m6i.8xlarge" || "ml.m6i.12xlarge" || "ml.m6i.16xlarge" || "ml.m6i.24xlarge" || "ml.m6i.32xlarge" || "ml.c6i.xlarge" || "ml.c6i.2xlarge" || "ml.c6i.8xlarge" || "ml.c6i.4xlarge" || "ml.c6i.12xlarge" || "ml.c6i.16xlarge" || "ml.c6i.24xlarge" || "ml.c6i.32xlarge" || "ml.r5d.large" || "ml.r5d.xlarge" || "ml.r5d.2xlarge" || "ml.r5d.4xlarge" || "ml.r5d.8xlarge" || "ml.r5d.12xlarge" || "ml.r5d.16xlarge" || "ml.r5d.24xlarge" || "ml.t3.medium" || "ml.t3.large" || "ml.t3.xlarge" || "ml.t3.2xlarge" || "ml.r5.large" || "ml.r5.xlarge" || "ml.r5.2xlarge" || "ml.r5.4xlarge" || "ml.r5.8xlarge" || "ml.r5.12xlarge" || "ml.r5.16xlarge" || "ml.r5.24xlarge", // required + * // InstanceType: "ml.m4.xlarge" || "ml.m4.2xlarge" || "ml.m4.4xlarge" || "ml.m4.10xlarge" || "ml.m4.16xlarge" || "ml.g4dn.xlarge" || "ml.g4dn.2xlarge" || "ml.g4dn.4xlarge" || "ml.g4dn.8xlarge" || "ml.g4dn.12xlarge" || "ml.g4dn.16xlarge" || "ml.m5.large" || "ml.m5.xlarge" || "ml.m5.2xlarge" || "ml.m5.4xlarge" || "ml.m5.12xlarge" || "ml.m5.24xlarge" || "ml.c4.xlarge" || "ml.c4.2xlarge" || "ml.c4.4xlarge" || "ml.c4.8xlarge" || "ml.p2.xlarge" || "ml.p2.8xlarge" || "ml.p2.16xlarge" || "ml.p3.2xlarge" || "ml.p3.8xlarge" || "ml.p3.16xlarge" || "ml.p3dn.24xlarge" || "ml.p4d.24xlarge" || "ml.p4de.24xlarge" || "ml.p5.48xlarge" || "ml.p5e.48xlarge" || "ml.p5en.48xlarge" || "ml.c5.xlarge" || "ml.c5.2xlarge" || "ml.c5.4xlarge" || "ml.c5.9xlarge" || "ml.c5.18xlarge" || "ml.c5n.xlarge" || "ml.c5n.2xlarge" || "ml.c5n.4xlarge" || "ml.c5n.9xlarge" || "ml.c5n.18xlarge" || "ml.g5.xlarge" || "ml.g5.2xlarge" || "ml.g5.4xlarge" || "ml.g5.8xlarge" || "ml.g5.16xlarge" || "ml.g5.12xlarge" || "ml.g5.24xlarge" || "ml.g5.48xlarge" || "ml.g6.xlarge" || "ml.g6.2xlarge" || "ml.g6.4xlarge" || "ml.g6.8xlarge" || "ml.g6.16xlarge" || "ml.g6.12xlarge" || "ml.g6.24xlarge" || "ml.g6.48xlarge" || "ml.g6e.xlarge" || "ml.g6e.2xlarge" || "ml.g6e.4xlarge" || "ml.g6e.8xlarge" || "ml.g6e.16xlarge" || "ml.g6e.12xlarge" || "ml.g6e.24xlarge" || "ml.g6e.48xlarge" || "ml.trn1.2xlarge" || "ml.trn1.32xlarge" || "ml.trn1n.32xlarge" || "ml.trn2.48xlarge" || "ml.m6i.large" || "ml.m6i.xlarge" || "ml.m6i.2xlarge" || "ml.m6i.4xlarge" || "ml.m6i.8xlarge" || "ml.m6i.12xlarge" || "ml.m6i.16xlarge" || "ml.m6i.24xlarge" || "ml.m6i.32xlarge" || "ml.c6i.xlarge" || "ml.c6i.2xlarge" || "ml.c6i.8xlarge" || "ml.c6i.4xlarge" || "ml.c6i.12xlarge" || "ml.c6i.16xlarge" || "ml.c6i.24xlarge" || "ml.c6i.32xlarge" || "ml.r5d.large" || "ml.r5d.xlarge" || "ml.r5d.2xlarge" || "ml.r5d.4xlarge" || "ml.r5d.8xlarge" || "ml.r5d.12xlarge" || "ml.r5d.16xlarge" || "ml.r5d.24xlarge" || "ml.t3.medium" || "ml.t3.large" || "ml.t3.xlarge" || "ml.t3.2xlarge" || "ml.r5.large" || "ml.r5.xlarge" || "ml.r5.2xlarge" || "ml.r5.4xlarge" || "ml.r5.8xlarge" || "ml.r5.12xlarge" || "ml.r5.16xlarge" || "ml.r5.24xlarge", // required * // InstanceCount: Number("int"), // required * // InstanceGroupName: "STRING_VALUE", // required * // }, * // ], + * // TrainingPlanArn: "STRING_VALUE", * // }, * // VpcConfig: { // VpcConfig * // SecurityGroupIds: [ // VpcSecurityGroupIds // required @@ -543,18 +544,19 @@ export interface SearchCommandOutput extends SearchResponse, __MetadataBearer {} * // CompressionType: "GZIP" || "NONE", * // }, * // ResourceConfig: { - * // InstanceType: "ml.m4.xlarge" || "ml.m4.2xlarge" || "ml.m4.4xlarge" || "ml.m4.10xlarge" || "ml.m4.16xlarge" || "ml.g4dn.xlarge" || "ml.g4dn.2xlarge" || "ml.g4dn.4xlarge" || "ml.g4dn.8xlarge" || "ml.g4dn.12xlarge" || "ml.g4dn.16xlarge" || "ml.m5.large" || "ml.m5.xlarge" || "ml.m5.2xlarge" || "ml.m5.4xlarge" || "ml.m5.12xlarge" || "ml.m5.24xlarge" || "ml.c4.xlarge" || "ml.c4.2xlarge" || "ml.c4.4xlarge" || "ml.c4.8xlarge" || "ml.p2.xlarge" || "ml.p2.8xlarge" || "ml.p2.16xlarge" || "ml.p3.2xlarge" || "ml.p3.8xlarge" || "ml.p3.16xlarge" || "ml.p3dn.24xlarge" || "ml.p4d.24xlarge" || "ml.p4de.24xlarge" || "ml.p5.48xlarge" || "ml.p5e.48xlarge" || "ml.c5.xlarge" || "ml.c5.2xlarge" || "ml.c5.4xlarge" || "ml.c5.9xlarge" || "ml.c5.18xlarge" || "ml.c5n.xlarge" || "ml.c5n.2xlarge" || "ml.c5n.4xlarge" || "ml.c5n.9xlarge" || "ml.c5n.18xlarge" || "ml.g5.xlarge" || "ml.g5.2xlarge" || "ml.g5.4xlarge" || "ml.g5.8xlarge" || "ml.g5.16xlarge" || "ml.g5.12xlarge" || "ml.g5.24xlarge" || "ml.g5.48xlarge" || "ml.g6.xlarge" || "ml.g6.2xlarge" || "ml.g6.4xlarge" || "ml.g6.8xlarge" || "ml.g6.16xlarge" || "ml.g6.12xlarge" || "ml.g6.24xlarge" || "ml.g6.48xlarge" || "ml.g6e.xlarge" || "ml.g6e.2xlarge" || "ml.g6e.4xlarge" || "ml.g6e.8xlarge" || "ml.g6e.16xlarge" || "ml.g6e.12xlarge" || "ml.g6e.24xlarge" || "ml.g6e.48xlarge" || "ml.trn1.2xlarge" || "ml.trn1.32xlarge" || "ml.trn1n.32xlarge" || "ml.m6i.large" || "ml.m6i.xlarge" || "ml.m6i.2xlarge" || "ml.m6i.4xlarge" || "ml.m6i.8xlarge" || "ml.m6i.12xlarge" || "ml.m6i.16xlarge" || "ml.m6i.24xlarge" || "ml.m6i.32xlarge" || "ml.c6i.xlarge" || "ml.c6i.2xlarge" || "ml.c6i.8xlarge" || "ml.c6i.4xlarge" || "ml.c6i.12xlarge" || "ml.c6i.16xlarge" || "ml.c6i.24xlarge" || "ml.c6i.32xlarge" || "ml.r5d.large" || "ml.r5d.xlarge" || "ml.r5d.2xlarge" || "ml.r5d.4xlarge" || "ml.r5d.8xlarge" || "ml.r5d.12xlarge" || "ml.r5d.16xlarge" || "ml.r5d.24xlarge" || "ml.t3.medium" || "ml.t3.large" || "ml.t3.xlarge" || "ml.t3.2xlarge" || "ml.r5.large" || "ml.r5.xlarge" || "ml.r5.2xlarge" || "ml.r5.4xlarge" || "ml.r5.8xlarge" || "ml.r5.12xlarge" || "ml.r5.16xlarge" || "ml.r5.24xlarge", + * // InstanceType: "ml.m4.xlarge" || "ml.m4.2xlarge" || "ml.m4.4xlarge" || "ml.m4.10xlarge" || "ml.m4.16xlarge" || "ml.g4dn.xlarge" || "ml.g4dn.2xlarge" || "ml.g4dn.4xlarge" || "ml.g4dn.8xlarge" || "ml.g4dn.12xlarge" || "ml.g4dn.16xlarge" || "ml.m5.large" || "ml.m5.xlarge" || "ml.m5.2xlarge" || "ml.m5.4xlarge" || "ml.m5.12xlarge" || "ml.m5.24xlarge" || "ml.c4.xlarge" || "ml.c4.2xlarge" || "ml.c4.4xlarge" || "ml.c4.8xlarge" || "ml.p2.xlarge" || "ml.p2.8xlarge" || "ml.p2.16xlarge" || "ml.p3.2xlarge" || "ml.p3.8xlarge" || "ml.p3.16xlarge" || "ml.p3dn.24xlarge" || "ml.p4d.24xlarge" || "ml.p4de.24xlarge" || "ml.p5.48xlarge" || "ml.p5e.48xlarge" || "ml.p5en.48xlarge" || "ml.c5.xlarge" || "ml.c5.2xlarge" || "ml.c5.4xlarge" || "ml.c5.9xlarge" || "ml.c5.18xlarge" || "ml.c5n.xlarge" || "ml.c5n.2xlarge" || "ml.c5n.4xlarge" || "ml.c5n.9xlarge" || "ml.c5n.18xlarge" || "ml.g5.xlarge" || "ml.g5.2xlarge" || "ml.g5.4xlarge" || "ml.g5.8xlarge" || "ml.g5.16xlarge" || "ml.g5.12xlarge" || "ml.g5.24xlarge" || "ml.g5.48xlarge" || "ml.g6.xlarge" || "ml.g6.2xlarge" || "ml.g6.4xlarge" || "ml.g6.8xlarge" || "ml.g6.16xlarge" || "ml.g6.12xlarge" || "ml.g6.24xlarge" || "ml.g6.48xlarge" || "ml.g6e.xlarge" || "ml.g6e.2xlarge" || "ml.g6e.4xlarge" || "ml.g6e.8xlarge" || "ml.g6e.16xlarge" || "ml.g6e.12xlarge" || "ml.g6e.24xlarge" || "ml.g6e.48xlarge" || "ml.trn1.2xlarge" || "ml.trn1.32xlarge" || "ml.trn1n.32xlarge" || "ml.trn2.48xlarge" || "ml.m6i.large" || "ml.m6i.xlarge" || "ml.m6i.2xlarge" || "ml.m6i.4xlarge" || "ml.m6i.8xlarge" || "ml.m6i.12xlarge" || "ml.m6i.16xlarge" || "ml.m6i.24xlarge" || "ml.m6i.32xlarge" || "ml.c6i.xlarge" || "ml.c6i.2xlarge" || "ml.c6i.8xlarge" || "ml.c6i.4xlarge" || "ml.c6i.12xlarge" || "ml.c6i.16xlarge" || "ml.c6i.24xlarge" || "ml.c6i.32xlarge" || "ml.r5d.large" || "ml.r5d.xlarge" || "ml.r5d.2xlarge" || "ml.r5d.4xlarge" || "ml.r5d.8xlarge" || "ml.r5d.12xlarge" || "ml.r5d.16xlarge" || "ml.r5d.24xlarge" || "ml.t3.medium" || "ml.t3.large" || "ml.t3.xlarge" || "ml.t3.2xlarge" || "ml.r5.large" || "ml.r5.xlarge" || "ml.r5.2xlarge" || "ml.r5.4xlarge" || "ml.r5.8xlarge" || "ml.r5.12xlarge" || "ml.r5.16xlarge" || "ml.r5.24xlarge", * // InstanceCount: Number("int"), * // VolumeSizeInGB: Number("int"), // required * // VolumeKmsKeyId: "STRING_VALUE", * // KeepAlivePeriodInSeconds: Number("int"), * // InstanceGroups: [ * // { - * // InstanceType: "ml.m4.xlarge" || "ml.m4.2xlarge" || "ml.m4.4xlarge" || "ml.m4.10xlarge" || "ml.m4.16xlarge" || "ml.g4dn.xlarge" || "ml.g4dn.2xlarge" || "ml.g4dn.4xlarge" || "ml.g4dn.8xlarge" || "ml.g4dn.12xlarge" || "ml.g4dn.16xlarge" || "ml.m5.large" || "ml.m5.xlarge" || "ml.m5.2xlarge" || "ml.m5.4xlarge" || "ml.m5.12xlarge" || "ml.m5.24xlarge" || "ml.c4.xlarge" || "ml.c4.2xlarge" || "ml.c4.4xlarge" || "ml.c4.8xlarge" || "ml.p2.xlarge" || "ml.p2.8xlarge" || "ml.p2.16xlarge" || "ml.p3.2xlarge" || "ml.p3.8xlarge" || "ml.p3.16xlarge" || "ml.p3dn.24xlarge" || "ml.p4d.24xlarge" || "ml.p4de.24xlarge" || "ml.p5.48xlarge" || "ml.p5e.48xlarge" || "ml.c5.xlarge" || "ml.c5.2xlarge" || "ml.c5.4xlarge" || "ml.c5.9xlarge" || "ml.c5.18xlarge" || "ml.c5n.xlarge" || "ml.c5n.2xlarge" || "ml.c5n.4xlarge" || "ml.c5n.9xlarge" || "ml.c5n.18xlarge" || "ml.g5.xlarge" || "ml.g5.2xlarge" || "ml.g5.4xlarge" || "ml.g5.8xlarge" || "ml.g5.16xlarge" || "ml.g5.12xlarge" || "ml.g5.24xlarge" || "ml.g5.48xlarge" || "ml.g6.xlarge" || "ml.g6.2xlarge" || "ml.g6.4xlarge" || "ml.g6.8xlarge" || "ml.g6.16xlarge" || "ml.g6.12xlarge" || "ml.g6.24xlarge" || "ml.g6.48xlarge" || "ml.g6e.xlarge" || "ml.g6e.2xlarge" || "ml.g6e.4xlarge" || "ml.g6e.8xlarge" || "ml.g6e.16xlarge" || "ml.g6e.12xlarge" || "ml.g6e.24xlarge" || "ml.g6e.48xlarge" || "ml.trn1.2xlarge" || "ml.trn1.32xlarge" || "ml.trn1n.32xlarge" || "ml.m6i.large" || "ml.m6i.xlarge" || "ml.m6i.2xlarge" || "ml.m6i.4xlarge" || "ml.m6i.8xlarge" || "ml.m6i.12xlarge" || "ml.m6i.16xlarge" || "ml.m6i.24xlarge" || "ml.m6i.32xlarge" || "ml.c6i.xlarge" || "ml.c6i.2xlarge" || "ml.c6i.8xlarge" || "ml.c6i.4xlarge" || "ml.c6i.12xlarge" || "ml.c6i.16xlarge" || "ml.c6i.24xlarge" || "ml.c6i.32xlarge" || "ml.r5d.large" || "ml.r5d.xlarge" || "ml.r5d.2xlarge" || "ml.r5d.4xlarge" || "ml.r5d.8xlarge" || "ml.r5d.12xlarge" || "ml.r5d.16xlarge" || "ml.r5d.24xlarge" || "ml.t3.medium" || "ml.t3.large" || "ml.t3.xlarge" || "ml.t3.2xlarge" || "ml.r5.large" || "ml.r5.xlarge" || "ml.r5.2xlarge" || "ml.r5.4xlarge" || "ml.r5.8xlarge" || "ml.r5.12xlarge" || "ml.r5.16xlarge" || "ml.r5.24xlarge", // required + * // InstanceType: "ml.m4.xlarge" || "ml.m4.2xlarge" || "ml.m4.4xlarge" || "ml.m4.10xlarge" || "ml.m4.16xlarge" || "ml.g4dn.xlarge" || "ml.g4dn.2xlarge" || "ml.g4dn.4xlarge" || "ml.g4dn.8xlarge" || "ml.g4dn.12xlarge" || "ml.g4dn.16xlarge" || "ml.m5.large" || "ml.m5.xlarge" || "ml.m5.2xlarge" || "ml.m5.4xlarge" || "ml.m5.12xlarge" || "ml.m5.24xlarge" || "ml.c4.xlarge" || "ml.c4.2xlarge" || "ml.c4.4xlarge" || "ml.c4.8xlarge" || "ml.p2.xlarge" || "ml.p2.8xlarge" || "ml.p2.16xlarge" || "ml.p3.2xlarge" || "ml.p3.8xlarge" || "ml.p3.16xlarge" || "ml.p3dn.24xlarge" || "ml.p4d.24xlarge" || "ml.p4de.24xlarge" || "ml.p5.48xlarge" || "ml.p5e.48xlarge" || "ml.p5en.48xlarge" || "ml.c5.xlarge" || "ml.c5.2xlarge" || "ml.c5.4xlarge" || "ml.c5.9xlarge" || "ml.c5.18xlarge" || "ml.c5n.xlarge" || "ml.c5n.2xlarge" || "ml.c5n.4xlarge" || "ml.c5n.9xlarge" || "ml.c5n.18xlarge" || "ml.g5.xlarge" || "ml.g5.2xlarge" || "ml.g5.4xlarge" || "ml.g5.8xlarge" || "ml.g5.16xlarge" || "ml.g5.12xlarge" || "ml.g5.24xlarge" || "ml.g5.48xlarge" || "ml.g6.xlarge" || "ml.g6.2xlarge" || "ml.g6.4xlarge" || "ml.g6.8xlarge" || "ml.g6.16xlarge" || "ml.g6.12xlarge" || "ml.g6.24xlarge" || "ml.g6.48xlarge" || "ml.g6e.xlarge" || "ml.g6e.2xlarge" || "ml.g6e.4xlarge" || "ml.g6e.8xlarge" || "ml.g6e.16xlarge" || "ml.g6e.12xlarge" || "ml.g6e.24xlarge" || "ml.g6e.48xlarge" || "ml.trn1.2xlarge" || "ml.trn1.32xlarge" || "ml.trn1n.32xlarge" || "ml.trn2.48xlarge" || "ml.m6i.large" || "ml.m6i.xlarge" || "ml.m6i.2xlarge" || "ml.m6i.4xlarge" || "ml.m6i.8xlarge" || "ml.m6i.12xlarge" || "ml.m6i.16xlarge" || "ml.m6i.24xlarge" || "ml.m6i.32xlarge" || "ml.c6i.xlarge" || "ml.c6i.2xlarge" || "ml.c6i.8xlarge" || "ml.c6i.4xlarge" || "ml.c6i.12xlarge" || "ml.c6i.16xlarge" || "ml.c6i.24xlarge" || "ml.c6i.32xlarge" || "ml.r5d.large" || "ml.r5d.xlarge" || "ml.r5d.2xlarge" || "ml.r5d.4xlarge" || "ml.r5d.8xlarge" || "ml.r5d.12xlarge" || "ml.r5d.16xlarge" || "ml.r5d.24xlarge" || "ml.t3.medium" || "ml.t3.large" || "ml.t3.xlarge" || "ml.t3.2xlarge" || "ml.r5.large" || "ml.r5.xlarge" || "ml.r5.2xlarge" || "ml.r5.4xlarge" || "ml.r5.8xlarge" || "ml.r5.12xlarge" || "ml.r5.16xlarge" || "ml.r5.24xlarge", // required * // InstanceCount: Number("int"), // required * // InstanceGroupName: "STRING_VALUE", // required * // }, * // ], + * // TrainingPlanArn: "STRING_VALUE", * // }, * // VpcConfig: { * // SecurityGroupIds: [ // required @@ -1638,14 +1640,14 @@ export interface SearchCommandOutput extends SearchResponse, __MetadataBearer {} * // OutputDataConfig: "Searches for available training plan offerings based on specified criteria.
+ *Users search for available plan offerings based on their requirements (e.g., + * instance type, count, start time, duration).
+ *And then, they create a plan that best matches their needs using the ID of the + * plan offering they want to use.
+ *For more information about how to reserve GPU capacity for your SageMaker training jobs or
+ * SageMaker HyperPod clusters using Amazon SageMaker Training Plan , see
+ * CreateTrainingPlan
+ * .
You have exceeded an SageMaker resource limit. For example, you might have too many + * training jobs created.
+ * + * @throws {@link SageMakerServiceException} + *Base exception class for all service exceptions from SageMaker service.
+ * + * @public + */ +export class SearchTrainingPlanOfferingsCommand extends $Command + .classBuilder< + SearchTrainingPlanOfferingsCommandInput, + SearchTrainingPlanOfferingsCommandOutput, + SageMakerClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: SageMakerClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("SageMaker", "SearchTrainingPlanOfferings", {}) + .n("SageMakerClient", "SearchTrainingPlanOfferingsCommand") + .f(void 0, void 0) + .ser(se_SearchTrainingPlanOfferingsCommand) + .de(de_SearchTrainingPlanOfferingsCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: SearchTrainingPlanOfferingsRequest; + output: SearchTrainingPlanOfferingsResponse; + }; + sdk: { + input: SearchTrainingPlanOfferingsCommandInput; + output: SearchTrainingPlanOfferingsCommandOutput; + }; + }; +} diff --git a/clients/client-sagemaker/src/commands/UpdateActionCommand.ts b/clients/client-sagemaker/src/commands/UpdateActionCommand.ts index e7ecbe38e9df..a73d4e498633 100644 --- a/clients/client-sagemaker/src/commands/UpdateActionCommand.ts +++ b/clients/client-sagemaker/src/commands/UpdateActionCommand.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 { UpdateActionRequest, UpdateActionResponse } from "../models/models_4"; +import { UpdateActionRequest } from "../models/models_4"; +import { 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/UpdateAppImageConfigCommand.ts b/clients/client-sagemaker/src/commands/UpdateAppImageConfigCommand.ts index c9b2ac86ee9e..cea8a799d683 100644 --- a/clients/client-sagemaker/src/commands/UpdateAppImageConfigCommand.ts +++ b/clients/client-sagemaker/src/commands/UpdateAppImageConfigCommand.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 { UpdateAppImageConfigRequest, UpdateAppImageConfigResponse } from "../models/models_4"; +import { UpdateAppImageConfigRequest, UpdateAppImageConfigResponse } from "../models/models_5"; import { de_UpdateAppImageConfigCommand, se_UpdateAppImageConfigCommand } from "../protocols/Aws_json1_1"; import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; diff --git a/clients/client-sagemaker/src/commands/UpdateArtifactCommand.ts b/clients/client-sagemaker/src/commands/UpdateArtifactCommand.ts index ffec8dc3e767..f9d4dcc1d690 100644 --- a/clients/client-sagemaker/src/commands/UpdateArtifactCommand.ts +++ b/clients/client-sagemaker/src/commands/UpdateArtifactCommand.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 { UpdateArtifactRequest, UpdateArtifactResponse } from "../models/models_4"; +import { UpdateArtifactRequest, UpdateArtifactResponse } from "../models/models_5"; import { de_UpdateArtifactCommand, se_UpdateArtifactCommand } from "../protocols/Aws_json1_1"; import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; diff --git a/clients/client-sagemaker/src/commands/UpdateClusterCommand.ts b/clients/client-sagemaker/src/commands/UpdateClusterCommand.ts index c488bed07f2c..aeaed438687b 100644 --- a/clients/client-sagemaker/src/commands/UpdateClusterCommand.ts +++ b/clients/client-sagemaker/src/commands/UpdateClusterCommand.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 { UpdateClusterRequest, UpdateClusterResponse } from "../models/models_4"; +import { UpdateClusterRequest, UpdateClusterResponse } from "../models/models_5"; import { de_UpdateClusterCommand, se_UpdateClusterCommand } from "../protocols/Aws_json1_1"; import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; @@ -41,7 +41,7 @@ export interface UpdateClusterCommandOutput extends UpdateClusterResponse, __Met * { // ClusterInstanceGroupSpecification * InstanceCount: Number("int"), // required * InstanceGroupName: "STRING_VALUE", // required - * InstanceType: "ml.p4d.24xlarge" || "ml.p4de.24xlarge" || "ml.p5.48xlarge" || "ml.trn1.32xlarge" || "ml.trn1n.32xlarge" || "ml.g5.xlarge" || "ml.g5.2xlarge" || "ml.g5.4xlarge" || "ml.g5.8xlarge" || "ml.g5.12xlarge" || "ml.g5.16xlarge" || "ml.g5.24xlarge" || "ml.g5.48xlarge" || "ml.c5.large" || "ml.c5.xlarge" || "ml.c5.2xlarge" || "ml.c5.4xlarge" || "ml.c5.9xlarge" || "ml.c5.12xlarge" || "ml.c5.18xlarge" || "ml.c5.24xlarge" || "ml.c5n.large" || "ml.c5n.2xlarge" || "ml.c5n.4xlarge" || "ml.c5n.9xlarge" || "ml.c5n.18xlarge" || "ml.m5.large" || "ml.m5.xlarge" || "ml.m5.2xlarge" || "ml.m5.4xlarge" || "ml.m5.8xlarge" || "ml.m5.12xlarge" || "ml.m5.16xlarge" || "ml.m5.24xlarge" || "ml.t3.medium" || "ml.t3.large" || "ml.t3.xlarge" || "ml.t3.2xlarge" || "ml.g6.xlarge" || "ml.g6.2xlarge" || "ml.g6.4xlarge" || "ml.g6.8xlarge" || "ml.g6.16xlarge" || "ml.g6.12xlarge" || "ml.g6.24xlarge" || "ml.g6.48xlarge" || "ml.gr6.4xlarge" || "ml.gr6.8xlarge" || "ml.g6e.xlarge" || "ml.g6e.2xlarge" || "ml.g6e.4xlarge" || "ml.g6e.8xlarge" || "ml.g6e.16xlarge" || "ml.g6e.12xlarge" || "ml.g6e.24xlarge" || "ml.g6e.48xlarge" || "ml.p5e.48xlarge", // required + * InstanceType: "ml.p4d.24xlarge" || "ml.p4de.24xlarge" || "ml.p5.48xlarge" || "ml.trn1.32xlarge" || "ml.trn1n.32xlarge" || "ml.g5.xlarge" || "ml.g5.2xlarge" || "ml.g5.4xlarge" || "ml.g5.8xlarge" || "ml.g5.12xlarge" || "ml.g5.16xlarge" || "ml.g5.24xlarge" || "ml.g5.48xlarge" || "ml.c5.large" || "ml.c5.xlarge" || "ml.c5.2xlarge" || "ml.c5.4xlarge" || "ml.c5.9xlarge" || "ml.c5.12xlarge" || "ml.c5.18xlarge" || "ml.c5.24xlarge" || "ml.c5n.large" || "ml.c5n.2xlarge" || "ml.c5n.4xlarge" || "ml.c5n.9xlarge" || "ml.c5n.18xlarge" || "ml.m5.large" || "ml.m5.xlarge" || "ml.m5.2xlarge" || "ml.m5.4xlarge" || "ml.m5.8xlarge" || "ml.m5.12xlarge" || "ml.m5.16xlarge" || "ml.m5.24xlarge" || "ml.t3.medium" || "ml.t3.large" || "ml.t3.xlarge" || "ml.t3.2xlarge" || "ml.g6.xlarge" || "ml.g6.2xlarge" || "ml.g6.4xlarge" || "ml.g6.8xlarge" || "ml.g6.16xlarge" || "ml.g6.12xlarge" || "ml.g6.24xlarge" || "ml.g6.48xlarge" || "ml.gr6.4xlarge" || "ml.gr6.8xlarge" || "ml.g6e.xlarge" || "ml.g6e.2xlarge" || "ml.g6e.4xlarge" || "ml.g6e.8xlarge" || "ml.g6e.16xlarge" || "ml.g6e.12xlarge" || "ml.g6e.24xlarge" || "ml.g6e.48xlarge" || "ml.p5e.48xlarge" || "ml.p5en.48xlarge" || "ml.trn2.48xlarge", // required * LifeCycleConfig: { // ClusterLifeCycleConfig * SourceS3Uri: "STRING_VALUE", // required * OnCreate: "STRING_VALUE", // required @@ -58,6 +58,7 @@ export interface UpdateClusterCommandOutput extends UpdateClusterResponse, __Met * OnStartDeepHealthChecks: [ // OnStartDeepHealthChecks * "InstanceStress" || "InstanceConnectivity", * ], + * TrainingPlanArn: "STRING_VALUE", * OverrideVpcConfig: { // VpcConfig * SecurityGroupIds: [ // VpcSecurityGroupIds // required * "STRING_VALUE", diff --git a/clients/client-sagemaker/src/commands/UpdateClusterSchedulerConfigCommand.ts b/clients/client-sagemaker/src/commands/UpdateClusterSchedulerConfigCommand.ts new file mode 100644 index 000000000000..ad2b1504b448 --- /dev/null +++ b/clients/client-sagemaker/src/commands/UpdateClusterSchedulerConfigCommand.ts @@ -0,0 +1,120 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { commonParams } from "../endpoint/EndpointParameters"; +import { UpdateClusterSchedulerConfigRequest, UpdateClusterSchedulerConfigResponse } from "../models/models_5"; +import { + de_UpdateClusterSchedulerConfigCommand, + se_UpdateClusterSchedulerConfigCommand, +} from "../protocols/Aws_json1_1"; +import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link UpdateClusterSchedulerConfigCommand}. + */ +export interface UpdateClusterSchedulerConfigCommandInput extends UpdateClusterSchedulerConfigRequest {} +/** + * @public + * + * The output of {@link UpdateClusterSchedulerConfigCommand}. + */ +export interface UpdateClusterSchedulerConfigCommandOutput + extends UpdateClusterSchedulerConfigResponse, + __MetadataBearer {} + +/** + *Update the cluster policy configuration.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, UpdateClusterSchedulerConfigCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, UpdateClusterSchedulerConfigCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const input = { // UpdateClusterSchedulerConfigRequest + * ClusterSchedulerConfigId: "STRING_VALUE", // required + * TargetVersion: Number("int"), // required + * SchedulerConfig: { // SchedulerConfig + * PriorityClasses: [ // PriorityClassList + * { // PriorityClass + * Name: "STRING_VALUE", // required + * Weight: Number("int"), // required + * }, + * ], + * FairShare: "Enabled" || "Disabled", + * }, + * Description: "STRING_VALUE", + * }; + * const command = new UpdateClusterSchedulerConfigCommand(input); + * const response = await client.send(command); + * // { // UpdateClusterSchedulerConfigResponse + * // ClusterSchedulerConfigArn: "STRING_VALUE", // required + * // ClusterSchedulerConfigVersion: Number("int"), // required + * // }; + * + * ``` + * + * @param UpdateClusterSchedulerConfigCommandInput - {@link UpdateClusterSchedulerConfigCommandInput} + * @returns {@link UpdateClusterSchedulerConfigCommandOutput} + * @see {@link UpdateClusterSchedulerConfigCommandInput} for command's `input` shape. + * @see {@link UpdateClusterSchedulerConfigCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for SageMakerClient's `config` shape. + * + * @throws {@link ConflictException} (client fault) + *There was a conflict when you attempted to modify a SageMaker entity such as an
+ * Experiment or Artifact.
You have exceeded an SageMaker resource limit. For example, you might have too many + * training jobs created.
+ * + * @throws {@link ResourceNotFound} (client fault) + *Resource being access is not found.
+ * + * @throws {@link SageMakerServiceException} + *Base exception class for all service exceptions from SageMaker service.
+ * + * @public + */ +export class UpdateClusterSchedulerConfigCommand extends $Command + .classBuilder< + UpdateClusterSchedulerConfigCommandInput, + UpdateClusterSchedulerConfigCommandOutput, + SageMakerClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: SageMakerClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("SageMaker", "UpdateClusterSchedulerConfig", {}) + .n("SageMakerClient", "UpdateClusterSchedulerConfigCommand") + .f(void 0, void 0) + .ser(se_UpdateClusterSchedulerConfigCommand) + .de(de_UpdateClusterSchedulerConfigCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: UpdateClusterSchedulerConfigRequest; + output: UpdateClusterSchedulerConfigResponse; + }; + sdk: { + input: UpdateClusterSchedulerConfigCommandInput; + output: UpdateClusterSchedulerConfigCommandOutput; + }; + }; +} diff --git a/clients/client-sagemaker/src/commands/UpdateClusterSoftwareCommand.ts b/clients/client-sagemaker/src/commands/UpdateClusterSoftwareCommand.ts index b21c3ff35997..affc22fbcf6c 100644 --- a/clients/client-sagemaker/src/commands/UpdateClusterSoftwareCommand.ts +++ b/clients/client-sagemaker/src/commands/UpdateClusterSoftwareCommand.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 { UpdateClusterSoftwareRequest, UpdateClusterSoftwareResponse } from "../models/models_4"; +import { UpdateClusterSoftwareRequest, UpdateClusterSoftwareResponse } from "../models/models_5"; import { de_UpdateClusterSoftwareCommand, se_UpdateClusterSoftwareCommand } from "../protocols/Aws_json1_1"; import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; diff --git a/clients/client-sagemaker/src/commands/UpdateCodeRepositoryCommand.ts b/clients/client-sagemaker/src/commands/UpdateCodeRepositoryCommand.ts index 1ea583ea5b1e..3a2ae075a655 100644 --- a/clients/client-sagemaker/src/commands/UpdateCodeRepositoryCommand.ts +++ b/clients/client-sagemaker/src/commands/UpdateCodeRepositoryCommand.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 { UpdateCodeRepositoryInput, UpdateCodeRepositoryOutput } from "../models/models_4"; +import { UpdateCodeRepositoryInput, UpdateCodeRepositoryOutput } from "../models/models_5"; import { de_UpdateCodeRepositoryCommand, se_UpdateCodeRepositoryCommand } from "../protocols/Aws_json1_1"; import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; diff --git a/clients/client-sagemaker/src/commands/UpdateComputeQuotaCommand.ts b/clients/client-sagemaker/src/commands/UpdateComputeQuotaCommand.ts new file mode 100644 index 000000000000..f61696bdc8d5 --- /dev/null +++ b/clients/client-sagemaker/src/commands/UpdateComputeQuotaCommand.ts @@ -0,0 +1,124 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { commonParams } from "../endpoint/EndpointParameters"; +import { UpdateComputeQuotaRequest, UpdateComputeQuotaResponse } from "../models/models_5"; +import { de_UpdateComputeQuotaCommand, se_UpdateComputeQuotaCommand } from "../protocols/Aws_json1_1"; +import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link UpdateComputeQuotaCommand}. + */ +export interface UpdateComputeQuotaCommandInput extends UpdateComputeQuotaRequest {} +/** + * @public + * + * The output of {@link UpdateComputeQuotaCommand}. + */ +export interface UpdateComputeQuotaCommandOutput extends UpdateComputeQuotaResponse, __MetadataBearer {} + +/** + *Update the compute allocation definition.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, UpdateComputeQuotaCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, UpdateComputeQuotaCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const input = { // UpdateComputeQuotaRequest + * ComputeQuotaId: "STRING_VALUE", // required + * TargetVersion: Number("int"), // required + * ComputeQuotaConfig: { // ComputeQuotaConfig + * ComputeQuotaResources: [ // ComputeQuotaResourceConfigList + * { // ComputeQuotaResourceConfig + * InstanceType: "ml.p4d.24xlarge" || "ml.p4de.24xlarge" || "ml.p5.48xlarge" || "ml.trn1.32xlarge" || "ml.trn1n.32xlarge" || "ml.g5.xlarge" || "ml.g5.2xlarge" || "ml.g5.4xlarge" || "ml.g5.8xlarge" || "ml.g5.12xlarge" || "ml.g5.16xlarge" || "ml.g5.24xlarge" || "ml.g5.48xlarge" || "ml.c5.large" || "ml.c5.xlarge" || "ml.c5.2xlarge" || "ml.c5.4xlarge" || "ml.c5.9xlarge" || "ml.c5.12xlarge" || "ml.c5.18xlarge" || "ml.c5.24xlarge" || "ml.c5n.large" || "ml.c5n.2xlarge" || "ml.c5n.4xlarge" || "ml.c5n.9xlarge" || "ml.c5n.18xlarge" || "ml.m5.large" || "ml.m5.xlarge" || "ml.m5.2xlarge" || "ml.m5.4xlarge" || "ml.m5.8xlarge" || "ml.m5.12xlarge" || "ml.m5.16xlarge" || "ml.m5.24xlarge" || "ml.t3.medium" || "ml.t3.large" || "ml.t3.xlarge" || "ml.t3.2xlarge" || "ml.g6.xlarge" || "ml.g6.2xlarge" || "ml.g6.4xlarge" || "ml.g6.8xlarge" || "ml.g6.16xlarge" || "ml.g6.12xlarge" || "ml.g6.24xlarge" || "ml.g6.48xlarge" || "ml.gr6.4xlarge" || "ml.gr6.8xlarge" || "ml.g6e.xlarge" || "ml.g6e.2xlarge" || "ml.g6e.4xlarge" || "ml.g6e.8xlarge" || "ml.g6e.16xlarge" || "ml.g6e.12xlarge" || "ml.g6e.24xlarge" || "ml.g6e.48xlarge" || "ml.p5e.48xlarge" || "ml.p5en.48xlarge" || "ml.trn2.48xlarge", // required + * Count: Number("int"), // required + * }, + * ], + * ResourceSharingConfig: { // ResourceSharingConfig + * Strategy: "Lend" || "DontLend" || "LendAndBorrow", // required + * BorrowLimit: Number("int"), + * }, + * PreemptTeamTasks: "Never" || "LowerPriority", + * }, + * ComputeQuotaTarget: { // ComputeQuotaTarget + * TeamName: "STRING_VALUE", // required + * FairShareWeight: Number("int"), + * }, + * ActivationState: "Enabled" || "Disabled", + * Description: "STRING_VALUE", + * }; + * const command = new UpdateComputeQuotaCommand(input); + * const response = await client.send(command); + * // { // UpdateComputeQuotaResponse + * // ComputeQuotaArn: "STRING_VALUE", // required + * // ComputeQuotaVersion: Number("int"), // required + * // }; + * + * ``` + * + * @param UpdateComputeQuotaCommandInput - {@link UpdateComputeQuotaCommandInput} + * @returns {@link UpdateComputeQuotaCommandOutput} + * @see {@link UpdateComputeQuotaCommandInput} for command's `input` shape. + * @see {@link UpdateComputeQuotaCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for SageMakerClient's `config` shape. + * + * @throws {@link ConflictException} (client fault) + *There was a conflict when you attempted to modify a SageMaker entity such as an
+ * Experiment or Artifact.
You have exceeded an SageMaker resource limit. For example, you might have too many + * training jobs created.
+ * + * @throws {@link ResourceNotFound} (client fault) + *Resource being access is not found.
+ * + * @throws {@link SageMakerServiceException} + *Base exception class for all service exceptions from SageMaker service.
+ * + * @public + */ +export class UpdateComputeQuotaCommand extends $Command + .classBuilder< + UpdateComputeQuotaCommandInput, + UpdateComputeQuotaCommandOutput, + SageMakerClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: SageMakerClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("SageMaker", "UpdateComputeQuota", {}) + .n("SageMakerClient", "UpdateComputeQuotaCommand") + .f(void 0, void 0) + .ser(se_UpdateComputeQuotaCommand) + .de(de_UpdateComputeQuotaCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: UpdateComputeQuotaRequest; + output: UpdateComputeQuotaResponse; + }; + sdk: { + input: UpdateComputeQuotaCommandInput; + output: UpdateComputeQuotaCommandOutput; + }; + }; +} diff --git a/clients/client-sagemaker/src/commands/UpdateContextCommand.ts b/clients/client-sagemaker/src/commands/UpdateContextCommand.ts index 12b9af70a6a9..006de2c7f2dd 100644 --- a/clients/client-sagemaker/src/commands/UpdateContextCommand.ts +++ b/clients/client-sagemaker/src/commands/UpdateContextCommand.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 { UpdateContextRequest, UpdateContextResponse } from "../models/models_4"; +import { UpdateContextRequest, UpdateContextResponse } from "../models/models_5"; import { de_UpdateContextCommand, se_UpdateContextCommand } from "../protocols/Aws_json1_1"; import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; diff --git a/clients/client-sagemaker/src/commands/UpdateDeviceFleetCommand.ts b/clients/client-sagemaker/src/commands/UpdateDeviceFleetCommand.ts index dd34c32b991b..d445f387355e 100644 --- a/clients/client-sagemaker/src/commands/UpdateDeviceFleetCommand.ts +++ b/clients/client-sagemaker/src/commands/UpdateDeviceFleetCommand.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 { UpdateDeviceFleetRequest } from "../models/models_4"; +import { UpdateDeviceFleetRequest } from "../models/models_5"; import { de_UpdateDeviceFleetCommand, se_UpdateDeviceFleetCommand } from "../protocols/Aws_json1_1"; import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; diff --git a/clients/client-sagemaker/src/commands/UpdateDevicesCommand.ts b/clients/client-sagemaker/src/commands/UpdateDevicesCommand.ts index df380fb001e0..74eab0a382b9 100644 --- a/clients/client-sagemaker/src/commands/UpdateDevicesCommand.ts +++ b/clients/client-sagemaker/src/commands/UpdateDevicesCommand.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 { UpdateDevicesRequest } from "../models/models_4"; +import { UpdateDevicesRequest } from "../models/models_5"; import { de_UpdateDevicesCommand, se_UpdateDevicesCommand } from "../protocols/Aws_json1_1"; import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; diff --git a/clients/client-sagemaker/src/commands/UpdateDomainCommand.ts b/clients/client-sagemaker/src/commands/UpdateDomainCommand.ts index 51329cf66472..fd57f3441148 100644 --- a/clients/client-sagemaker/src/commands/UpdateDomainCommand.ts +++ b/clients/client-sagemaker/src/commands/UpdateDomainCommand.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 { UpdateDomainRequest, UpdateDomainResponse } from "../models/models_4"; +import { UpdateDomainRequest, UpdateDomainResponse } from "../models/models_5"; import { de_UpdateDomainCommand, se_UpdateDomainCommand } from "../protocols/Aws_json1_1"; import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; @@ -227,11 +227,15 @@ export interface UpdateDomainCommandOutput extends UpdateDomainResponse, __Metad * FileSystemId: "STRING_VALUE", // required * FileSystemPath: "STRING_VALUE", * }, + * FSxLustreFileSystemConfig: { // FSxLustreFileSystemConfig + * FileSystemId: "STRING_VALUE", // required + * FileSystemPath: "STRING_VALUE", + * }, * }, * ], * StudioWebPortalSettings: { // StudioWebPortalSettings * HiddenMlTools: [ // HiddenMlToolsList - * "DataWrangler" || "FeatureStore" || "EmrClusters" || "AutoMl" || "Experiments" || "Training" || "ModelEvaluation" || "Pipelines" || "Models" || "JumpStart" || "InferenceRecommender" || "Endpoints" || "Projects" || "InferenceOptimization" || "PerformanceEvaluation", + * "DataWrangler" || "FeatureStore" || "EmrClusters" || "AutoMl" || "Experiments" || "Training" || "ModelEvaluation" || "Pipelines" || "Models" || "JumpStart" || "InferenceRecommender" || "Endpoints" || "Projects" || "InferenceOptimization" || "PerformanceEvaluation" || "HyperPodClusters" || "LakeraGuard" || "Comet" || "DeepchecksLLMEvaluation" || "Fiddler", * ], * HiddenAppTypes: [ // HiddenAppTypesList * "JupyterServer" || "KernelGateway" || "DetailedProfiler" || "TensorBoard" || "CodeEditor" || "JupyterLab" || "RStudioServerPro" || "RSessionGateway" || "Canvas", @@ -343,6 +347,10 @@ export interface UpdateDomainCommandOutput extends UpdateDomainResponse, __Metad * FileSystemId: "STRING_VALUE", // required * FileSystemPath: "STRING_VALUE", * }, + * FSxLustreFileSystemConfig: { + * FileSystemId: "STRING_VALUE", // required + * FileSystemPath: "STRING_VALUE", + * }, * }, * ], * }, diff --git a/clients/client-sagemaker/src/commands/UpdateEndpointCommand.ts b/clients/client-sagemaker/src/commands/UpdateEndpointCommand.ts index 4ec5b4b6a892..d41fb70cf488 100644 --- a/clients/client-sagemaker/src/commands/UpdateEndpointCommand.ts +++ b/clients/client-sagemaker/src/commands/UpdateEndpointCommand.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 { UpdateEndpointInput, UpdateEndpointOutput } from "../models/models_4"; +import { UpdateEndpointInput, UpdateEndpointOutput } from "../models/models_5"; import { de_UpdateEndpointCommand, se_UpdateEndpointCommand } from "../protocols/Aws_json1_1"; import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; diff --git a/clients/client-sagemaker/src/commands/UpdateEndpointWeightsAndCapacitiesCommand.ts b/clients/client-sagemaker/src/commands/UpdateEndpointWeightsAndCapacitiesCommand.ts index e19665116654..95685d61fa53 100644 --- a/clients/client-sagemaker/src/commands/UpdateEndpointWeightsAndCapacitiesCommand.ts +++ b/clients/client-sagemaker/src/commands/UpdateEndpointWeightsAndCapacitiesCommand.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 { UpdateEndpointWeightsAndCapacitiesInput, UpdateEndpointWeightsAndCapacitiesOutput } from "../models/models_4"; +import { UpdateEndpointWeightsAndCapacitiesInput, UpdateEndpointWeightsAndCapacitiesOutput } from "../models/models_5"; import { de_UpdateEndpointWeightsAndCapacitiesCommand, se_UpdateEndpointWeightsAndCapacitiesCommand, diff --git a/clients/client-sagemaker/src/commands/UpdateExperimentCommand.ts b/clients/client-sagemaker/src/commands/UpdateExperimentCommand.ts index 7960128e73b5..5b2b9635e532 100644 --- a/clients/client-sagemaker/src/commands/UpdateExperimentCommand.ts +++ b/clients/client-sagemaker/src/commands/UpdateExperimentCommand.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 { UpdateExperimentRequest, UpdateExperimentResponse } from "../models/models_4"; +import { UpdateExperimentRequest, UpdateExperimentResponse } from "../models/models_5"; import { de_UpdateExperimentCommand, se_UpdateExperimentCommand } from "../protocols/Aws_json1_1"; import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; diff --git a/clients/client-sagemaker/src/commands/UpdateFeatureGroupCommand.ts b/clients/client-sagemaker/src/commands/UpdateFeatureGroupCommand.ts index 486c2936ed33..fd740e6d8f8c 100644 --- a/clients/client-sagemaker/src/commands/UpdateFeatureGroupCommand.ts +++ b/clients/client-sagemaker/src/commands/UpdateFeatureGroupCommand.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 { UpdateFeatureGroupRequest, UpdateFeatureGroupResponse } from "../models/models_4"; +import { UpdateFeatureGroupRequest, UpdateFeatureGroupResponse } from "../models/models_5"; import { de_UpdateFeatureGroupCommand, se_UpdateFeatureGroupCommand } from "../protocols/Aws_json1_1"; import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; diff --git a/clients/client-sagemaker/src/commands/UpdateFeatureMetadataCommand.ts b/clients/client-sagemaker/src/commands/UpdateFeatureMetadataCommand.ts index 1fa5333929db..02046da75faa 100644 --- a/clients/client-sagemaker/src/commands/UpdateFeatureMetadataCommand.ts +++ b/clients/client-sagemaker/src/commands/UpdateFeatureMetadataCommand.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 { UpdateFeatureMetadataRequest } from "../models/models_4"; +import { UpdateFeatureMetadataRequest } from "../models/models_5"; import { de_UpdateFeatureMetadataCommand, se_UpdateFeatureMetadataCommand } from "../protocols/Aws_json1_1"; import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; diff --git a/clients/client-sagemaker/src/commands/UpdateHubCommand.ts b/clients/client-sagemaker/src/commands/UpdateHubCommand.ts index 859b1f4fd2fe..a5125a2f011d 100644 --- a/clients/client-sagemaker/src/commands/UpdateHubCommand.ts +++ b/clients/client-sagemaker/src/commands/UpdateHubCommand.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 { UpdateHubRequest, UpdateHubResponse } from "../models/models_4"; +import { UpdateHubRequest, UpdateHubResponse } from "../models/models_5"; import { de_UpdateHubCommand, se_UpdateHubCommand } from "../protocols/Aws_json1_1"; import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; diff --git a/clients/client-sagemaker/src/commands/UpdateImageCommand.ts b/clients/client-sagemaker/src/commands/UpdateImageCommand.ts index 897e8b50b05e..4879d6079a26 100644 --- a/clients/client-sagemaker/src/commands/UpdateImageCommand.ts +++ b/clients/client-sagemaker/src/commands/UpdateImageCommand.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 { UpdateImageRequest, UpdateImageResponse } from "../models/models_4"; +import { UpdateImageRequest, UpdateImageResponse } from "../models/models_5"; import { de_UpdateImageCommand, se_UpdateImageCommand } from "../protocols/Aws_json1_1"; import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; diff --git a/clients/client-sagemaker/src/commands/UpdateImageVersionCommand.ts b/clients/client-sagemaker/src/commands/UpdateImageVersionCommand.ts index bd8699f3d397..c346de4c9852 100644 --- a/clients/client-sagemaker/src/commands/UpdateImageVersionCommand.ts +++ b/clients/client-sagemaker/src/commands/UpdateImageVersionCommand.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 { UpdateImageVersionRequest, UpdateImageVersionResponse } from "../models/models_4"; +import { UpdateImageVersionRequest, UpdateImageVersionResponse } from "../models/models_5"; import { de_UpdateImageVersionCommand, se_UpdateImageVersionCommand } 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 a9fe321dddbe..befcd71c16fe 100644 --- a/clients/client-sagemaker/src/commands/UpdateInferenceComponentCommand.ts +++ b/clients/client-sagemaker/src/commands/UpdateInferenceComponentCommand.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 { UpdateInferenceComponentInput, UpdateInferenceComponentOutput } from "../models/models_4"; +import { UpdateInferenceComponentInput, UpdateInferenceComponentOutput } from "../models/models_5"; import { de_UpdateInferenceComponentCommand, se_UpdateInferenceComponentCommand } from "../protocols/Aws_json1_1"; import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; diff --git a/clients/client-sagemaker/src/commands/UpdateInferenceComponentRuntimeConfigCommand.ts b/clients/client-sagemaker/src/commands/UpdateInferenceComponentRuntimeConfigCommand.ts index 787c09ee824a..bf78b96dc1a7 100644 --- a/clients/client-sagemaker/src/commands/UpdateInferenceComponentRuntimeConfigCommand.ts +++ b/clients/client-sagemaker/src/commands/UpdateInferenceComponentRuntimeConfigCommand.ts @@ -8,7 +8,7 @@ import { commonParams } from "../endpoint/EndpointParameters"; import { UpdateInferenceComponentRuntimeConfigInput, UpdateInferenceComponentRuntimeConfigOutput, -} from "../models/models_4"; +} from "../models/models_5"; import { de_UpdateInferenceComponentRuntimeConfigCommand, se_UpdateInferenceComponentRuntimeConfigCommand, diff --git a/clients/client-sagemaker/src/commands/UpdateInferenceExperimentCommand.ts b/clients/client-sagemaker/src/commands/UpdateInferenceExperimentCommand.ts index f8f1cbab2743..3cfadd47c8bd 100644 --- a/clients/client-sagemaker/src/commands/UpdateInferenceExperimentCommand.ts +++ b/clients/client-sagemaker/src/commands/UpdateInferenceExperimentCommand.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 { UpdateInferenceExperimentRequest, UpdateInferenceExperimentResponse } from "../models/models_4"; +import { UpdateInferenceExperimentRequest, UpdateInferenceExperimentResponse } from "../models/models_5"; import { de_UpdateInferenceExperimentCommand, se_UpdateInferenceExperimentCommand } from "../protocols/Aws_json1_1"; import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; diff --git a/clients/client-sagemaker/src/commands/UpdateMlflowTrackingServerCommand.ts b/clients/client-sagemaker/src/commands/UpdateMlflowTrackingServerCommand.ts index 0f1bd886ee13..8b2b916d0028 100644 --- a/clients/client-sagemaker/src/commands/UpdateMlflowTrackingServerCommand.ts +++ b/clients/client-sagemaker/src/commands/UpdateMlflowTrackingServerCommand.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 { UpdateMlflowTrackingServerRequest, UpdateMlflowTrackingServerResponse } from "../models/models_4"; +import { UpdateMlflowTrackingServerRequest, UpdateMlflowTrackingServerResponse } from "../models/models_5"; import { de_UpdateMlflowTrackingServerCommand, se_UpdateMlflowTrackingServerCommand } from "../protocols/Aws_json1_1"; import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; diff --git a/clients/client-sagemaker/src/commands/UpdateModelCardCommand.ts b/clients/client-sagemaker/src/commands/UpdateModelCardCommand.ts index 1e4dd2c2bbf8..04edb4c361d7 100644 --- a/clients/client-sagemaker/src/commands/UpdateModelCardCommand.ts +++ b/clients/client-sagemaker/src/commands/UpdateModelCardCommand.ts @@ -9,7 +9,7 @@ import { UpdateModelCardRequest, UpdateModelCardRequestFilterSensitiveLog, UpdateModelCardResponse, -} from "../models/models_4"; +} from "../models/models_5"; import { de_UpdateModelCardCommand, se_UpdateModelCardCommand } from "../protocols/Aws_json1_1"; import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; diff --git a/clients/client-sagemaker/src/commands/UpdateModelPackageCommand.ts b/clients/client-sagemaker/src/commands/UpdateModelPackageCommand.ts index 7660dc9e9418..56183435f2fc 100644 --- a/clients/client-sagemaker/src/commands/UpdateModelPackageCommand.ts +++ b/clients/client-sagemaker/src/commands/UpdateModelPackageCommand.ts @@ -9,7 +9,7 @@ import { UpdateModelPackageInput, UpdateModelPackageInputFilterSensitiveLog, UpdateModelPackageOutput, -} from "../models/models_4"; +} from "../models/models_5"; import { de_UpdateModelPackageCommand, se_UpdateModelPackageCommand } from "../protocols/Aws_json1_1"; import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; diff --git a/clients/client-sagemaker/src/commands/UpdateMonitoringAlertCommand.ts b/clients/client-sagemaker/src/commands/UpdateMonitoringAlertCommand.ts index 1f882b60acba..47dbf91fed45 100644 --- a/clients/client-sagemaker/src/commands/UpdateMonitoringAlertCommand.ts +++ b/clients/client-sagemaker/src/commands/UpdateMonitoringAlertCommand.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 { UpdateMonitoringAlertRequest, UpdateMonitoringAlertResponse } from "../models/models_4"; +import { UpdateMonitoringAlertRequest, UpdateMonitoringAlertResponse } from "../models/models_5"; import { de_UpdateMonitoringAlertCommand, se_UpdateMonitoringAlertCommand } from "../protocols/Aws_json1_1"; import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; diff --git a/clients/client-sagemaker/src/commands/UpdateMonitoringScheduleCommand.ts b/clients/client-sagemaker/src/commands/UpdateMonitoringScheduleCommand.ts index f65549d43047..6ee95cc2ea28 100644 --- a/clients/client-sagemaker/src/commands/UpdateMonitoringScheduleCommand.ts +++ b/clients/client-sagemaker/src/commands/UpdateMonitoringScheduleCommand.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 { UpdateMonitoringScheduleRequest, UpdateMonitoringScheduleResponse } from "../models/models_4"; +import { UpdateMonitoringScheduleRequest, UpdateMonitoringScheduleResponse } from "../models/models_5"; import { de_UpdateMonitoringScheduleCommand, se_UpdateMonitoringScheduleCommand } from "../protocols/Aws_json1_1"; import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; diff --git a/clients/client-sagemaker/src/commands/UpdateNotebookInstanceCommand.ts b/clients/client-sagemaker/src/commands/UpdateNotebookInstanceCommand.ts index fda9cf406e1d..68be596aea6d 100644 --- a/clients/client-sagemaker/src/commands/UpdateNotebookInstanceCommand.ts +++ b/clients/client-sagemaker/src/commands/UpdateNotebookInstanceCommand.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 { UpdateNotebookInstanceInput, UpdateNotebookInstanceOutput } from "../models/models_4"; +import { UpdateNotebookInstanceInput, UpdateNotebookInstanceOutput } from "../models/models_5"; import { de_UpdateNotebookInstanceCommand, se_UpdateNotebookInstanceCommand } from "../protocols/Aws_json1_1"; import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; diff --git a/clients/client-sagemaker/src/commands/UpdateNotebookInstanceLifecycleConfigCommand.ts b/clients/client-sagemaker/src/commands/UpdateNotebookInstanceLifecycleConfigCommand.ts index 2094ce0500ab..ca1cd1cc8a3f 100644 --- a/clients/client-sagemaker/src/commands/UpdateNotebookInstanceLifecycleConfigCommand.ts +++ b/clients/client-sagemaker/src/commands/UpdateNotebookInstanceLifecycleConfigCommand.ts @@ -8,7 +8,7 @@ import { commonParams } from "../endpoint/EndpointParameters"; import { UpdateNotebookInstanceLifecycleConfigInput, UpdateNotebookInstanceLifecycleConfigOutput, -} from "../models/models_4"; +} from "../models/models_5"; import { de_UpdateNotebookInstanceLifecycleConfigCommand, se_UpdateNotebookInstanceLifecycleConfigCommand, diff --git a/clients/client-sagemaker/src/commands/UpdatePartnerAppCommand.ts b/clients/client-sagemaker/src/commands/UpdatePartnerAppCommand.ts new file mode 100644 index 000000000000..5befbfe8a533 --- /dev/null +++ b/clients/client-sagemaker/src/commands/UpdatePartnerAppCommand.ts @@ -0,0 +1,119 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { commonParams } from "../endpoint/EndpointParameters"; +import { UpdatePartnerAppRequest, UpdatePartnerAppResponse } from "../models/models_5"; +import { de_UpdatePartnerAppCommand, se_UpdatePartnerAppCommand } from "../protocols/Aws_json1_1"; +import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link UpdatePartnerAppCommand}. + */ +export interface UpdatePartnerAppCommandInput extends UpdatePartnerAppRequest {} +/** + * @public + * + * The output of {@link UpdatePartnerAppCommand}. + */ +export interface UpdatePartnerAppCommandOutput extends UpdatePartnerAppResponse, __MetadataBearer {} + +/** + *Updates all of the SageMaker Partner AI Apps in an account.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, UpdatePartnerAppCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, UpdatePartnerAppCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const input = { // UpdatePartnerAppRequest + * Arn: "STRING_VALUE", // required + * MaintenanceConfig: { // PartnerAppMaintenanceConfig + * MaintenanceWindowStart: "STRING_VALUE", + * }, + * Tier: "STRING_VALUE", + * ApplicationConfig: { // PartnerAppConfig + * AdminUsers: [ // PartnerAppAdminUserList + * "STRING_VALUE", + * ], + * Arguments: { // PartnerAppArguments + * "There was a conflict when you attempted to modify a SageMaker entity such as an
+ * Experiment or Artifact.
Resource being access is not found.
+ * + * @throws {@link SageMakerServiceException} + *Base exception class for all service exceptions from SageMaker service.
+ * + * @public + */ +export class UpdatePartnerAppCommand extends $Command + .classBuilder< + UpdatePartnerAppCommandInput, + UpdatePartnerAppCommandOutput, + SageMakerClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: SageMakerClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("SageMaker", "UpdatePartnerApp", {}) + .n("SageMakerClient", "UpdatePartnerAppCommand") + .f(void 0, void 0) + .ser(se_UpdatePartnerAppCommand) + .de(de_UpdatePartnerAppCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: UpdatePartnerAppRequest; + output: UpdatePartnerAppResponse; + }; + sdk: { + input: UpdatePartnerAppCommandInput; + output: UpdatePartnerAppCommandOutput; + }; + }; +} diff --git a/clients/client-sagemaker/src/commands/UpdatePipelineCommand.ts b/clients/client-sagemaker/src/commands/UpdatePipelineCommand.ts index 0f46602495bb..6a6c854f7fd9 100644 --- a/clients/client-sagemaker/src/commands/UpdatePipelineCommand.ts +++ b/clients/client-sagemaker/src/commands/UpdatePipelineCommand.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 { UpdatePipelineRequest, UpdatePipelineResponse } from "../models/models_4"; +import { UpdatePipelineRequest, UpdatePipelineResponse } from "../models/models_5"; import { de_UpdatePipelineCommand, se_UpdatePipelineCommand } from "../protocols/Aws_json1_1"; import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; diff --git a/clients/client-sagemaker/src/commands/UpdatePipelineExecutionCommand.ts b/clients/client-sagemaker/src/commands/UpdatePipelineExecutionCommand.ts index 6ba08e77bc93..1fa5371f0f44 100644 --- a/clients/client-sagemaker/src/commands/UpdatePipelineExecutionCommand.ts +++ b/clients/client-sagemaker/src/commands/UpdatePipelineExecutionCommand.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 { UpdatePipelineExecutionRequest, UpdatePipelineExecutionResponse } from "../models/models_4"; +import { UpdatePipelineExecutionRequest, UpdatePipelineExecutionResponse } from "../models/models_5"; import { de_UpdatePipelineExecutionCommand, se_UpdatePipelineExecutionCommand } from "../protocols/Aws_json1_1"; import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; diff --git a/clients/client-sagemaker/src/commands/UpdateProjectCommand.ts b/clients/client-sagemaker/src/commands/UpdateProjectCommand.ts index 6fbb83ffe0ab..663c9822e771 100644 --- a/clients/client-sagemaker/src/commands/UpdateProjectCommand.ts +++ b/clients/client-sagemaker/src/commands/UpdateProjectCommand.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 { UpdateProjectInput, UpdateProjectOutput } from "../models/models_4"; +import { UpdateProjectInput, UpdateProjectOutput } from "../models/models_5"; import { de_UpdateProjectCommand, se_UpdateProjectCommand } from "../protocols/Aws_json1_1"; import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; diff --git a/clients/client-sagemaker/src/commands/UpdateSpaceCommand.ts b/clients/client-sagemaker/src/commands/UpdateSpaceCommand.ts index 9acd80baec89..837349ea971b 100644 --- a/clients/client-sagemaker/src/commands/UpdateSpaceCommand.ts +++ b/clients/client-sagemaker/src/commands/UpdateSpaceCommand.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 { UpdateSpaceRequest, UpdateSpaceResponse } from "../models/models_4"; +import { UpdateSpaceRequest, UpdateSpaceResponse } from "../models/models_5"; import { de_UpdateSpaceCommand, se_UpdateSpaceCommand } from "../protocols/Aws_json1_1"; import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; @@ -119,6 +119,9 @@ export interface UpdateSpaceCommandOutput extends UpdateSpaceResponse, __Metadat * EFSFileSystem: { // EFSFileSystem * FileSystemId: "STRING_VALUE", // required * }, + * FSxLustreFileSystem: { // FSxLustreFileSystem + * FileSystemId: "STRING_VALUE", // required + * }, * }, * ], * }, diff --git a/clients/client-sagemaker/src/commands/UpdateTrainingJobCommand.ts b/clients/client-sagemaker/src/commands/UpdateTrainingJobCommand.ts index 6d6224e79797..0329fcad73e1 100644 --- a/clients/client-sagemaker/src/commands/UpdateTrainingJobCommand.ts +++ b/clients/client-sagemaker/src/commands/UpdateTrainingJobCommand.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 { UpdateTrainingJobRequest, UpdateTrainingJobResponse } from "../models/models_4"; +import { UpdateTrainingJobRequest, UpdateTrainingJobResponse } from "../models/models_5"; import { de_UpdateTrainingJobCommand, se_UpdateTrainingJobCommand } from "../protocols/Aws_json1_1"; import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; diff --git a/clients/client-sagemaker/src/commands/UpdateTrialCommand.ts b/clients/client-sagemaker/src/commands/UpdateTrialCommand.ts index 4654fe98eddb..3d11b2c4d1ca 100644 --- a/clients/client-sagemaker/src/commands/UpdateTrialCommand.ts +++ b/clients/client-sagemaker/src/commands/UpdateTrialCommand.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 { UpdateTrialRequest, UpdateTrialResponse } from "../models/models_4"; +import { UpdateTrialRequest, UpdateTrialResponse } from "../models/models_5"; import { de_UpdateTrialCommand, se_UpdateTrialCommand } from "../protocols/Aws_json1_1"; import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; diff --git a/clients/client-sagemaker/src/commands/UpdateTrialComponentCommand.ts b/clients/client-sagemaker/src/commands/UpdateTrialComponentCommand.ts index 1d3ada0d3603..a2ec62e47fc6 100644 --- a/clients/client-sagemaker/src/commands/UpdateTrialComponentCommand.ts +++ b/clients/client-sagemaker/src/commands/UpdateTrialComponentCommand.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 { UpdateTrialComponentRequest } from "../models/models_4"; -import { UpdateTrialComponentResponse } from "../models/models_5"; +import { UpdateTrialComponentRequest, UpdateTrialComponentResponse } from "../models/models_5"; import { de_UpdateTrialComponentCommand, se_UpdateTrialComponentCommand } from "../protocols/Aws_json1_1"; import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; diff --git a/clients/client-sagemaker/src/commands/UpdateUserProfileCommand.ts b/clients/client-sagemaker/src/commands/UpdateUserProfileCommand.ts index be817283595f..5b2f71937be6 100644 --- a/clients/client-sagemaker/src/commands/UpdateUserProfileCommand.ts +++ b/clients/client-sagemaker/src/commands/UpdateUserProfileCommand.ts @@ -228,11 +228,15 @@ export interface UpdateUserProfileCommandOutput extends UpdateUserProfileRespons * FileSystemId: "STRING_VALUE", // required * FileSystemPath: "STRING_VALUE", * }, + * FSxLustreFileSystemConfig: { // FSxLustreFileSystemConfig + * FileSystemId: "STRING_VALUE", // required + * FileSystemPath: "STRING_VALUE", + * }, * }, * ], * StudioWebPortalSettings: { // StudioWebPortalSettings * HiddenMlTools: [ // HiddenMlToolsList - * "DataWrangler" || "FeatureStore" || "EmrClusters" || "AutoMl" || "Experiments" || "Training" || "ModelEvaluation" || "Pipelines" || "Models" || "JumpStart" || "InferenceRecommender" || "Endpoints" || "Projects" || "InferenceOptimization" || "PerformanceEvaluation", + * "DataWrangler" || "FeatureStore" || "EmrClusters" || "AutoMl" || "Experiments" || "Training" || "ModelEvaluation" || "Pipelines" || "Models" || "JumpStart" || "InferenceRecommender" || "Endpoints" || "Projects" || "InferenceOptimization" || "PerformanceEvaluation" || "HyperPodClusters" || "LakeraGuard" || "Comet" || "DeepchecksLLMEvaluation" || "Fiddler", * ], * HiddenAppTypes: [ // HiddenAppTypesList * "JupyterServer" || "KernelGateway" || "DetailedProfiler" || "TensorBoard" || "CodeEditor" || "JupyterLab" || "RStudioServerPro" || "RSessionGateway" || "Canvas", diff --git a/clients/client-sagemaker/src/commands/index.ts b/clients/client-sagemaker/src/commands/index.ts index 6c12fa716805..141fec14545f 100644 --- a/clients/client-sagemaker/src/commands/index.ts +++ b/clients/client-sagemaker/src/commands/index.ts @@ -12,8 +12,10 @@ export * from "./CreateArtifactCommand"; export * from "./CreateAutoMLJobCommand"; export * from "./CreateAutoMLJobV2Command"; export * from "./CreateClusterCommand"; +export * from "./CreateClusterSchedulerConfigCommand"; export * from "./CreateCodeRepositoryCommand"; export * from "./CreateCompilationJobCommand"; +export * from "./CreateComputeQuotaCommand"; export * from "./CreateContextCommand"; export * from "./CreateDataQualityJobDefinitionCommand"; export * from "./CreateDeviceFleetCommand"; @@ -49,6 +51,8 @@ export * from "./CreateMonitoringScheduleCommand"; export * from "./CreateNotebookInstanceCommand"; export * from "./CreateNotebookInstanceLifecycleConfigCommand"; export * from "./CreateOptimizationJobCommand"; +export * from "./CreatePartnerAppCommand"; +export * from "./CreatePartnerAppPresignedUrlCommand"; export * from "./CreatePipelineCommand"; export * from "./CreatePresignedDomainUrlCommand"; export * from "./CreatePresignedMlflowTrackingServerUrlCommand"; @@ -58,6 +62,7 @@ export * from "./CreateProjectCommand"; export * from "./CreateSpaceCommand"; export * from "./CreateStudioLifecycleConfigCommand"; export * from "./CreateTrainingJobCommand"; +export * from "./CreateTrainingPlanCommand"; export * from "./CreateTransformJobCommand"; export * from "./CreateTrialCommand"; export * from "./CreateTrialComponentCommand"; @@ -71,8 +76,10 @@ export * from "./DeleteAppImageConfigCommand"; export * from "./DeleteArtifactCommand"; export * from "./DeleteAssociationCommand"; export * from "./DeleteClusterCommand"; +export * from "./DeleteClusterSchedulerConfigCommand"; export * from "./DeleteCodeRepositoryCommand"; export * from "./DeleteCompilationJobCommand"; +export * from "./DeleteComputeQuotaCommand"; export * from "./DeleteContextCommand"; export * from "./DeleteDataQualityJobDefinitionCommand"; export * from "./DeleteDeviceFleetCommand"; @@ -106,6 +113,7 @@ export * from "./DeleteMonitoringScheduleCommand"; export * from "./DeleteNotebookInstanceCommand"; export * from "./DeleteNotebookInstanceLifecycleConfigCommand"; export * from "./DeleteOptimizationJobCommand"; +export * from "./DeletePartnerAppCommand"; export * from "./DeletePipelineCommand"; export * from "./DeleteProjectCommand"; export * from "./DeleteSpaceCommand"; @@ -126,8 +134,10 @@ export * from "./DescribeAutoMLJobCommand"; export * from "./DescribeAutoMLJobV2Command"; export * from "./DescribeClusterCommand"; export * from "./DescribeClusterNodeCommand"; +export * from "./DescribeClusterSchedulerConfigCommand"; export * from "./DescribeCodeRepositoryCommand"; export * from "./DescribeCompilationJobCommand"; +export * from "./DescribeComputeQuotaCommand"; export * from "./DescribeContextCommand"; export * from "./DescribeDataQualityJobDefinitionCommand"; export * from "./DescribeDeviceCommand"; @@ -165,6 +175,7 @@ export * from "./DescribeMonitoringScheduleCommand"; export * from "./DescribeNotebookInstanceCommand"; export * from "./DescribeNotebookInstanceLifecycleConfigCommand"; export * from "./DescribeOptimizationJobCommand"; +export * from "./DescribePartnerAppCommand"; export * from "./DescribePipelineCommand"; export * from "./DescribePipelineDefinitionForExecutionCommand"; export * from "./DescribePipelineExecutionCommand"; @@ -174,6 +185,7 @@ export * from "./DescribeSpaceCommand"; export * from "./DescribeStudioLifecycleConfigCommand"; export * from "./DescribeSubscribedWorkteamCommand"; export * from "./DescribeTrainingJobCommand"; +export * from "./DescribeTrainingPlanCommand"; export * from "./DescribeTransformJobCommand"; export * from "./DescribeTrialCommand"; export * from "./DescribeTrialComponentCommand"; @@ -200,9 +212,11 @@ export * from "./ListAssociationsCommand"; export * from "./ListAutoMLJobsCommand"; export * from "./ListCandidatesForAutoMLJobCommand"; export * from "./ListClusterNodesCommand"; +export * from "./ListClusterSchedulerConfigsCommand"; export * from "./ListClustersCommand"; export * from "./ListCodeRepositoriesCommand"; export * from "./ListCompilationJobsCommand"; +export * from "./ListComputeQuotasCommand"; export * from "./ListContextsCommand"; export * from "./ListDataQualityJobDefinitionsCommand"; export * from "./ListDeviceFleetsCommand"; @@ -247,6 +261,7 @@ export * from "./ListMonitoringSchedulesCommand"; export * from "./ListNotebookInstanceLifecycleConfigsCommand"; export * from "./ListNotebookInstancesCommand"; export * from "./ListOptimizationJobsCommand"; +export * from "./ListPartnerAppsCommand"; export * from "./ListPipelineExecutionStepsCommand"; export * from "./ListPipelineExecutionsCommand"; export * from "./ListPipelineParametersForExecutionCommand"; @@ -261,6 +276,7 @@ export * from "./ListSubscribedWorkteamsCommand"; export * from "./ListTagsCommand"; export * from "./ListTrainingJobsCommand"; export * from "./ListTrainingJobsForHyperParameterTuningJobCommand"; +export * from "./ListTrainingPlansCommand"; export * from "./ListTransformJobsCommand"; export * from "./ListTrialComponentsCommand"; export * from "./ListTrialsCommand"; @@ -273,6 +289,7 @@ export * from "./RegisterDevicesCommand"; export * from "./RenderUiTemplateCommand"; export * from "./RetryPipelineExecutionCommand"; export * from "./SearchCommand"; +export * from "./SearchTrainingPlanOfferingsCommand"; export * from "./SendPipelineExecutionStepFailureCommand"; export * from "./SendPipelineExecutionStepSuccessCommand"; export * from "./StartEdgeDeploymentStageCommand"; @@ -301,8 +318,10 @@ export * from "./UpdateActionCommand"; export * from "./UpdateAppImageConfigCommand"; export * from "./UpdateArtifactCommand"; export * from "./UpdateClusterCommand"; +export * from "./UpdateClusterSchedulerConfigCommand"; export * from "./UpdateClusterSoftwareCommand"; export * from "./UpdateCodeRepositoryCommand"; +export * from "./UpdateComputeQuotaCommand"; export * from "./UpdateContextCommand"; export * from "./UpdateDeviceFleetCommand"; export * from "./UpdateDevicesCommand"; @@ -325,6 +344,7 @@ export * from "./UpdateMonitoringAlertCommand"; export * from "./UpdateMonitoringScheduleCommand"; export * from "./UpdateNotebookInstanceCommand"; export * from "./UpdateNotebookInstanceLifecycleConfigCommand"; +export * from "./UpdatePartnerAppCommand"; export * from "./UpdatePipelineCommand"; export * from "./UpdatePipelineExecutionCommand"; export * from "./UpdateProjectCommand"; diff --git a/clients/client-sagemaker/src/models/models_0.ts b/clients/client-sagemaker/src/models/models_0.ts index 38f5db5fa797..2ca52f2481aa 100644 --- a/clients/client-sagemaker/src/models/models_0.ts +++ b/clients/client-sagemaker/src/models/models_0.ts @@ -95,6 +95,20 @@ export interface ActionSummary { LastModifiedTime?: Date | undefined; } +/** + * @public + * @enum + */ +export const ActivationState = { + DISABLED: "Disabled", + ENABLED: "Enabled", +} as const; + +/** + * @public + */ +export type ActivationState = (typeof ActivationState)[keyof typeof ActivationState]; + /** * @public * @enum @@ -1968,6 +1982,7 @@ export const TrainingInstanceType = { ML_P3_8XLARGE: "ml.p3.8xlarge", ML_P4DE_24XLARGE: "ml.p4de.24xlarge", ML_P4D_24XLARGE: "ml.p4d.24xlarge", + ML_P5EN_48XLARGE: "ml.p5en.48xlarge", ML_P5E_48XLARGE: "ml.p5e.48xlarge", ML_P5_48XLARGE: "ml.p5.48xlarge", ML_R5D_12XLARGE: "ml.r5d.12xlarge", @@ -1993,6 +2008,7 @@ export const TrainingInstanceType = { ML_TRN1N_32XLARGE: "ml.trn1n.32xlarge", ML_TRN1_2XLARGE: "ml.trn1.2xlarge", ML_TRN1_32XLARGE: "ml.trn1.32xlarge", + ML_TRN2_48XLARGE: "ml.trn2.48xlarge", } as const; /** @@ -2134,6 +2150,12 @@ export interface ResourceConfig { * @public */ InstanceGroups?: InstanceGroup[] | undefined; + + /** + *The Amazon Resource Name (ARN); of the training plan to use for this resource configuration.
+ * @public + */ + TrainingPlanArn?: string | undefined; } /** @@ -9402,6 +9424,7 @@ export const ClusterInstanceType = { ML_M5_XLARGE: "ml.m5.xlarge", ML_P4DE_24XLARGE: "ml.p4de.24xlarge", ML_P4D_24XLARGE: "ml.p4d.24xlarge", + ML_P5EN_48XLARGE: "ml.p5en.48xlarge", ML_P5E_48XLARGE: "ml.p5e.48xlarge", ML_P5_48XLARGE: "ml.p5.48xlarge", ML_T3_2XLARGE: "ml.t3.2xlarge", @@ -9410,6 +9433,7 @@ export const ClusterInstanceType = { ML_T3_XLARGE: "ml.t3.xlarge", ML_TRN1N_32XLARGE: "ml.trn1n.32xlarge", ML_TRN1_32XLARGE: "ml.trn1.32xlarge", + ML_TRN2_48XLARGE: "ml.trn2.48xlarge", } as const; /** @@ -9457,6 +9481,25 @@ export const DeepHealthCheckType = { */ export type DeepHealthCheckType = (typeof DeepHealthCheckType)[keyof typeof DeepHealthCheckType]; +/** + * @public + * @enum + */ +export const InstanceGroupStatus = { + CREATING: "Creating", + DEGRADED: "Degraded", + DELETING: "Deleting", + FAILED: "Failed", + INSERVICE: "InService", + SYSTEMUPDATING: "SystemUpdating", + UPDATING: "Updating", +} as const; + +/** + * @public + */ +export type InstanceGroupStatus = (typeof InstanceGroupStatus)[keyof typeof InstanceGroupStatus]; + /** *Details of an instance group in a SageMaker HyperPod cluster.
* @public @@ -9525,6 +9568,57 @@ export interface ClusterInstanceGroupDetails { */ OnStartDeepHealthChecks?: DeepHealthCheckType[] | undefined; + /** + *The current status of the cluster instance group.
+ *
+ * InService: The instance group is active and healthy.
+ * Creating: The instance group is being provisioned.
+ * Updating: The instance group is being updated.
+ * Failed: The instance group has failed to provision or is no longer
+ * healthy.
+ * Degraded: The instance group is degraded, meaning that some instances
+ * have failed to provision or are no longer healthy.
+ * Deleting: The instance group is being deleted.
The Amazon Resource Name (ARN); of the training plan associated with this cluster instance group.
+ *For more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using
+ * Amazon SageMaker Training Plan, see
+ * CreateTrainingPlan
+ * .
The current status of the training plan associated with this cluster instance + * group.
+ * @public + */ + TrainingPlanStatus?: string | undefined; + /** *Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources * have access to. You can control access to and from your resources by configuring a VPC. @@ -9597,6 +9691,16 @@ export interface ClusterInstanceGroupSpecification { */ OnStartDeepHealthChecks?: DeepHealthCheckType[] | undefined; + /** + *
The Amazon Resource Name (ARN); of the training plan to use for this cluster instance group.
+ *For more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using
+ * Amazon SageMaker Training Plan, see
+ * CreateTrainingPlan
+ * .
Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources * have access to. You can control access to and from your resources by configuring a VPC. @@ -9824,6 +9928,84 @@ export interface ClusterOrchestrator { Eks: ClusterOrchestratorEksConfig | undefined; } +/** + * @public + * @enum + */ +export const SchedulerResourceStatus = { + CREATED: "Created", + CREATE_FAILED: "CreateFailed", + CREATE_ROLLBACK_FAILED: "CreateRollbackFailed", + CREATING: "Creating", + DELETED: "Deleted", + DELETE_FAILED: "DeleteFailed", + DELETE_ROLLBACK_FAILED: "DeleteRollbackFailed", + DELETING: "Deleting", + UPDATED: "Updated", + UPDATE_FAILED: "UpdateFailed", + UPDATE_ROLLBACK_FAILED: "UpdateRollbackFailed", + UPDATING: "Updating", +} as const; + +/** + * @public + */ +export type SchedulerResourceStatus = (typeof SchedulerResourceStatus)[keyof typeof SchedulerResourceStatus]; + +/** + *
Summary of the cluster policy.
+ * @public + */ +export interface ClusterSchedulerConfigSummary { + /** + *ARN of the cluster policy.
+ * @public + */ + ClusterSchedulerConfigArn: string | undefined; + + /** + *ID of the cluster policy.
+ * @public + */ + ClusterSchedulerConfigId: string | undefined; + + /** + *Version of the cluster policy.
+ * @public + */ + ClusterSchedulerConfigVersion?: number | undefined; + + /** + *Name of the cluster policy.
+ * @public + */ + Name: string | undefined; + + /** + *Creation time of the cluster policy.
+ * @public + */ + CreationTime: Date | undefined; + + /** + *Last modified time of the cluster policy.
+ * @public + */ + LastModifiedTime?: Date | undefined; + + /** + *Status of the cluster policy.
+ * @public + */ + Status: SchedulerResourceStatus | undefined; + + /** + *ARN of the cluster.
+ * @public + */ + ClusterArn?: string | undefined; +} + /** * @public * @enum @@ -9885,6 +10067,17 @@ export interface ClusterSummary { * @public */ ClusterStatus: ClusterStatus | undefined; + + /** + *A list of Amazon Resource Names (ARNs) of the training plans associated with this + * cluster.
+ *For more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using
+ * Amazon SageMaker Training Plan, see
+ * CreateTrainingPlan
+ * .
Configuration of the resources used for the compute allocation definition.
+ * @public + */ +export interface ComputeQuotaResourceConfig { + /** + *The instance type of the instance group for the cluster.
+ * @public + */ + InstanceType: ClusterInstanceType | undefined; + + /** + *The number of instances to add to the instance group of a SageMaker HyperPod + * cluster.
+ * @public + */ + Count: number | undefined; +} + +/** + * @public + * @enum + */ +export const PreemptTeamTasks = { + LOWERPRIORITY: "LowerPriority", + NEVER: "Never", +} as const; + +/** + * @public + */ +export type PreemptTeamTasks = (typeof PreemptTeamTasks)[keyof typeof PreemptTeamTasks]; + +/** + * @public + * @enum + */ +export const ResourceSharingStrategy = { + DONTLEND: "DontLend", + LEND: "Lend", + LENDANDBORROW: "LendAndBorrow", +} as const; + +/** + * @public + */ +export type ResourceSharingStrategy = (typeof ResourceSharingStrategy)[keyof typeof ResourceSharingStrategy]; + +/** + *Resource sharing configuration.
+ * @public + */ +export interface ResourceSharingConfig { + /** + *The strategy of how idle compute is shared within the cluster. The following are the + * options of strategies.
+ *
+ * DontLend: entities do not lend idle compute.
+ * Lend: entities can lend idle compute to entities that can
+ * borrow.
+ * LendandBorrow: entities can lend idle compute and borrow idle compute
+ * from other entities.
Default is LendandBorrow.
The limit on how much idle compute can be borrowed.The values can be 1 - 500 percent of + * idle compute that the team is allowed to borrow.
+ *Default is 50.
Configuration of the compute allocation definition for an entity. This includes the + * resource sharing option and the setting to preempt low priority tasks.
+ * @public + */ +export interface ComputeQuotaConfig { + /** + *Allocate compute resources by instance types.
+ * @public + */ + ComputeQuotaResources?: ComputeQuotaResourceConfig[] | undefined; + + /** + *Resource sharing configuration. This defines how an entity can lend and borrow idle + * compute with other entities within the cluster.
+ * @public + */ + ResourceSharingConfig?: ResourceSharingConfig | undefined; + + /** + *Allows workloads from within an entity to preempt same-team workloads. When set to
+ * LowerPriority, the entity's lower priority tasks are preempted by their own
+ * higher priority tasks.
Default is LowerPriority.
The target entity to allocate compute resources to.
+ * @public + */ +export interface ComputeQuotaTarget { + /** + *Name of the team to allocate compute resources to.
+ * @public + */ + TeamName: string | undefined; + + /** + *Assigned entity fair-share weight. Idle compute will be shared across entities based on
+ * these assigned weights. This weight is only used when FairShare is
+ * enabled.
A weight of 0 is the lowest priority and 100 is the highest. Weight 0 is the + * default.
+ * @public + */ + FairShareWeight?: number | undefined; +} + +/** + *Summary of the compute allocation definition.
+ * @public + */ +export interface ComputeQuotaSummary { + /** + *ARN of the compute allocation definition.
+ * @public + */ + ComputeQuotaArn: string | undefined; + + /** + *ID of the compute allocation definition.
+ * @public + */ + ComputeQuotaId: string | undefined; + + /** + *Name of the compute allocation definition.
+ * @public + */ + Name: string | undefined; + + /** + *Version of the compute allocation definition.
+ * @public + */ + ComputeQuotaVersion?: number | undefined; + + /** + *Status of the compute allocation definition.
+ * @public + */ + Status: SchedulerResourceStatus | undefined; + + /** + *ARN of the cluster.
+ * @public + */ + ClusterArn?: string | undefined; + + /** + *Configuration of the compute allocation definition. This includes the resource sharing + * option, and the setting to preempt low priority tasks.
+ * @public + */ + ComputeQuotaConfig?: ComputeQuotaConfig | undefined; + + /** + *The target entity to allocate compute resources to.
+ * @public + */ + ComputeQuotaTarget: ComputeQuotaTarget | undefined; + + /** + *The state of the compute allocation being described. Use to enable or disable compute + * allocation.
+ *Default is Enabled.
Creation time of the compute allocation definition.
+ * @public + */ + CreationTime: Date | undefined; + + /** + *Last modified time of the compute allocation definition.
+ * @public + */ + LastModifiedTime?: Date | undefined; +} + /** * @public * @enum @@ -10885,330 +11290,3 @@ export interface ContinuousParameterRangeSpecification { */ MaxValue: string | undefined; } - -/** - *A flag to indicating that automatic model tuning (AMT) has detected model convergence, - * defined as a lack of significant improvement (1% or less) against an objective - * metric.
- * @public - */ -export interface ConvergenceDetected { - /** - *A flag to stop a tuning job once AMT has detected that the job has converged.
- * @public - */ - CompleteOnConvergence?: CompleteOnConvergence | undefined; -} - -/** - *Metadata properties of the tracking entity, trial, or trial component.
- * @public - */ -export interface MetadataProperties { - /** - *The commit ID.
- * @public - */ - CommitId?: string | undefined; - - /** - *The repository.
- * @public - */ - Repository?: string | undefined; - - /** - *The entity this entity was generated by.
- * @public - */ - GeneratedBy?: string | undefined; - - /** - *The project ID.
- * @public - */ - ProjectId?: string | undefined; -} - -/** - * @public - */ -export interface CreateActionRequest { - /** - *The name of the action. Must be unique to your account in an Amazon Web Services Region.
- * @public - */ - ActionName: string | undefined; - - /** - *The source type, ID, and URI.
- * @public - */ - Source: ActionSource | undefined; - - /** - *The action type.
- * @public - */ - ActionType: string | undefined; - - /** - *The description of the action.
- * @public - */ - Description?: string | undefined; - - /** - *The status of the action.
- * @public - */ - Status?: ActionStatus | undefined; - - /** - *A list of properties to add to the action.
- * @public - */ - Properties?: RecordMetadata properties of the tracking entity, trial, or trial component.
- * @public - */ - MetadataProperties?: MetadataProperties | undefined; - - /** - *A list of tags to apply to the action.
- * @public - */ - Tags?: Tag[] | undefined; -} - -/** - * @public - */ -export interface CreateActionResponse { - /** - *The Amazon Resource Name (ARN) of the action.
- * @public - */ - ActionArn?: string | undefined; -} - -/** - *Defines the possible values for an integer hyperparameter.
- * @public - */ -export interface IntegerParameterRangeSpecification { - /** - *The minimum integer value allowed.
- * @public - */ - MinValue: string | undefined; - - /** - *The maximum integer value allowed.
- * @public - */ - MaxValue: string | undefined; -} - -/** - *Defines the possible values for categorical, continuous, and integer hyperparameters - * to be used by an algorithm.
- * @public - */ -export interface ParameterRange { - /** - *A IntegerParameterRangeSpecification object that defines the possible
- * values for an integer hyperparameter.
A ContinuousParameterRangeSpecification object that defines the possible
- * values for a continuous hyperparameter.
A CategoricalParameterRangeSpecification object that defines the possible
- * values for a categorical hyperparameter.
Defines a hyperparameter to be used by an algorithm.
- * @public - */ -export interface HyperParameterSpecification { - /** - *The name of this hyperparameter. The name must be unique.
- * @public - */ - Name: string | undefined; - - /** - *A brief description of the hyperparameter.
- * @public - */ - Description?: string | undefined; - - /** - *The type of this hyperparameter. The valid types are Integer,
- * Continuous, Categorical, and FreeText.
The allowed range for this hyperparameter.
- * @public - */ - Range?: ParameterRange | undefined; - - /** - *Indicates whether this hyperparameter is tunable in a hyperparameter tuning - * job.
- * @public - */ - IsTunable?: boolean | undefined; - - /** - *Indicates whether this hyperparameter is required.
- * @public - */ - IsRequired?: boolean | undefined; - - /** - *The default value for this hyperparameter. If a default value is specified, a - * hyperparameter cannot be required.
- * @public - */ - DefaultValue?: string | undefined; -} - -/** - * @public - * @enum - */ -export const HyperParameterTuningJobObjectiveType = { - MAXIMIZE: "Maximize", - MINIMIZE: "Minimize", -} as const; - -/** - * @public - */ -export type HyperParameterTuningJobObjectiveType = - (typeof HyperParameterTuningJobObjectiveType)[keyof typeof HyperParameterTuningJobObjectiveType]; - -/** - *Defines the objective metric for a hyperparameter tuning job. Hyperparameter tuning
- * uses the value of this metric to evaluate the training jobs it launches, and returns the
- * training job that results in either the highest or lowest value for this metric,
- * depending on the value you specify for the Type parameter. If you want to
- * define a custom objective metric, see Define metrics and environment variables.
Whether to minimize or maximize the objective metric.
- * @public - */ - Type: HyperParameterTuningJobObjectiveType | undefined; - - /** - *The - * name of the metric to use for the objective metric.
- * @public - */ - MetricName: string | undefined; -} - -/** - *Defines how the algorithm is used for a training job.
- * @public - */ -export interface TrainingSpecification { - /** - *The Amazon ECR registry path of the Docker image that contains the training - * algorithm.
- * @public - */ - TrainingImage: string | undefined; - - /** - *An MD5 hash of the training algorithm that identifies the Docker image used for - * training.
- * @public - */ - TrainingImageDigest?: string | undefined; - - /** - *A list of the HyperParameterSpecification objects, that define the
- * supported hyperparameters. This is required if the algorithm supports automatic model
- * tuning.>
A list of the instance types that this algorithm can use for training.
- * @public - */ - SupportedTrainingInstanceTypes: TrainingInstanceType[] | undefined; - - /** - *Indicates whether the algorithm supports distributed training. If set to false, buyers - * can't request more than one instance during training.
- * @public - */ - SupportsDistributedTraining?: boolean | undefined; - - /** - *A list of MetricDefinition objects, which are used for parsing metrics
- * generated by the algorithm.
A list of ChannelSpecification objects, which specify the input sources
- * to be used by the algorithm.
A list of the metrics that the algorithm emits that can be used as the objective - * metric in a hyperparameter tuning job.
- * @public - */ - SupportedTuningJobObjectiveMetrics?: HyperParameterTuningJobObjective[] | undefined; - - /** - *The additional data source used during the training job.
- * @public - */ - AdditionalS3DataSource?: AdditionalS3DataSource | undefined; -} diff --git a/clients/client-sagemaker/src/models/models_1.ts b/clients/client-sagemaker/src/models/models_1.ts index 106eb075d0b7..fa2755f1d292 100644 --- a/clients/client-sagemaker/src/models/models_1.ts +++ b/clients/client-sagemaker/src/models/models_1.ts @@ -6,7 +6,11 @@ import { } from "@smithy/smithy-client"; import { + ActionSource, + ActionStatus, + ActivationState, AdditionalInferenceSpecificationDefinition, + AdditionalS3DataSource, AlgorithmValidationSpecification, AmazonQSettings, AnnotationConsolidationConfig, @@ -42,7 +46,9 @@ import { CaptureOption, CategoricalParameter, CategoricalParameterRange, + CategoricalParameterRangeSpecification, Channel, + ChannelSpecification, CheckpointConfig, ClarifyExplainerConfig, ClusterInstanceGroupSpecification, @@ -53,20 +59,21 @@ import { CodeRepository, CollectionConfig, CollectionType, + CompleteOnConvergence, + ComputeQuotaConfig, + ComputeQuotaTarget, ContainerDefinition, ContentClassifier, ContextSource, ContinuousParameterRange, - ConvergenceDetected, + ContinuousParameterRangeSpecification, CustomImage, FeatureStatus, GitConfig, HyperParameterScalingType, - HyperParameterTuningJobObjective, InferenceSpecification, JupyterLabAppImageConfig, KernelGatewayImageConfig, - MetadataProperties, MetricDefinition, MetricsSource, ModelApprovalStatus, @@ -86,13 +93,339 @@ import { TargetPlatformOs, TrainingInputMode, TrainingInstanceType, - TrainingSpecification, TransformJobDefinition, VpcConfig, } from "./models_0"; import { SageMakerServiceException as __BaseException } from "./SageMakerServiceException"; +/** + *A flag to indicating that automatic model tuning (AMT) has detected model convergence, + * defined as a lack of significant improvement (1% or less) against an objective + * metric.
+ * @public + */ +export interface ConvergenceDetected { + /** + *A flag to stop a tuning job once AMT has detected that the job has converged.
+ * @public + */ + CompleteOnConvergence?: CompleteOnConvergence | undefined; +} + +/** + *Metadata properties of the tracking entity, trial, or trial component.
+ * @public + */ +export interface MetadataProperties { + /** + *The commit ID.
+ * @public + */ + CommitId?: string | undefined; + + /** + *The repository.
+ * @public + */ + Repository?: string | undefined; + + /** + *The entity this entity was generated by.
+ * @public + */ + GeneratedBy?: string | undefined; + + /** + *The project ID.
+ * @public + */ + ProjectId?: string | undefined; +} + +/** + * @public + */ +export interface CreateActionRequest { + /** + *The name of the action. Must be unique to your account in an Amazon Web Services Region.
+ * @public + */ + ActionName: string | undefined; + + /** + *The source type, ID, and URI.
+ * @public + */ + Source: ActionSource | undefined; + + /** + *The action type.
+ * @public + */ + ActionType: string | undefined; + + /** + *The description of the action.
+ * @public + */ + Description?: string | undefined; + + /** + *The status of the action.
+ * @public + */ + Status?: ActionStatus | undefined; + + /** + *A list of properties to add to the action.
+ * @public + */ + Properties?: RecordMetadata properties of the tracking entity, trial, or trial component.
+ * @public + */ + MetadataProperties?: MetadataProperties | undefined; + + /** + *A list of tags to apply to the action.
+ * @public + */ + Tags?: Tag[] | undefined; +} + +/** + * @public + */ +export interface CreateActionResponse { + /** + *The Amazon Resource Name (ARN) of the action.
+ * @public + */ + ActionArn?: string | undefined; +} + +/** + *Defines the possible values for an integer hyperparameter.
+ * @public + */ +export interface IntegerParameterRangeSpecification { + /** + *The minimum integer value allowed.
+ * @public + */ + MinValue: string | undefined; + + /** + *The maximum integer value allowed.
+ * @public + */ + MaxValue: string | undefined; +} + +/** + *Defines the possible values for categorical, continuous, and integer hyperparameters + * to be used by an algorithm.
+ * @public + */ +export interface ParameterRange { + /** + *A IntegerParameterRangeSpecification object that defines the possible
+ * values for an integer hyperparameter.
A ContinuousParameterRangeSpecification object that defines the possible
+ * values for a continuous hyperparameter.
A CategoricalParameterRangeSpecification object that defines the possible
+ * values for a categorical hyperparameter.
Defines a hyperparameter to be used by an algorithm.
+ * @public + */ +export interface HyperParameterSpecification { + /** + *The name of this hyperparameter. The name must be unique.
+ * @public + */ + Name: string | undefined; + + /** + *A brief description of the hyperparameter.
+ * @public + */ + Description?: string | undefined; + + /** + *The type of this hyperparameter. The valid types are Integer,
+ * Continuous, Categorical, and FreeText.
The allowed range for this hyperparameter.
+ * @public + */ + Range?: ParameterRange | undefined; + + /** + *Indicates whether this hyperparameter is tunable in a hyperparameter tuning + * job.
+ * @public + */ + IsTunable?: boolean | undefined; + + /** + *Indicates whether this hyperparameter is required.
+ * @public + */ + IsRequired?: boolean | undefined; + + /** + *The default value for this hyperparameter. If a default value is specified, a + * hyperparameter cannot be required.
+ * @public + */ + DefaultValue?: string | undefined; +} + +/** + * @public + * @enum + */ +export const HyperParameterTuningJobObjectiveType = { + MAXIMIZE: "Maximize", + MINIMIZE: "Minimize", +} as const; + +/** + * @public + */ +export type HyperParameterTuningJobObjectiveType = + (typeof HyperParameterTuningJobObjectiveType)[keyof typeof HyperParameterTuningJobObjectiveType]; + +/** + *Defines the objective metric for a hyperparameter tuning job. Hyperparameter tuning
+ * uses the value of this metric to evaluate the training jobs it launches, and returns the
+ * training job that results in either the highest or lowest value for this metric,
+ * depending on the value you specify for the Type parameter. If you want to
+ * define a custom objective metric, see Define metrics and environment variables.
Whether to minimize or maximize the objective metric.
+ * @public + */ + Type: HyperParameterTuningJobObjectiveType | undefined; + + /** + *The + * name of the metric to use for the objective metric.
+ * @public + */ + MetricName: string | undefined; +} + +/** + *Defines how the algorithm is used for a training job.
+ * @public + */ +export interface TrainingSpecification { + /** + *The Amazon ECR registry path of the Docker image that contains the training + * algorithm.
+ * @public + */ + TrainingImage: string | undefined; + + /** + *An MD5 hash of the training algorithm that identifies the Docker image used for + * training.
+ * @public + */ + TrainingImageDigest?: string | undefined; + + /** + *A list of the HyperParameterSpecification objects, that define the
+ * supported hyperparameters. This is required if the algorithm supports automatic model
+ * tuning.>
A list of the instance types that this algorithm can use for training.
+ * @public + */ + SupportedTrainingInstanceTypes: TrainingInstanceType[] | undefined; + + /** + *Indicates whether the algorithm supports distributed training. If set to false, buyers + * can't request more than one instance during training.
+ * @public + */ + SupportsDistributedTraining?: boolean | undefined; + + /** + *A list of MetricDefinition objects, which are used for parsing metrics
+ * generated by the algorithm.
A list of ChannelSpecification objects, which specify the input sources
+ * to be used by the algorithm.
A list of the metrics that the algorithm emits that can be used as the objective + * metric in a hyperparameter tuning job.
+ * @public + */ + SupportedTuningJobObjectiveMetrics?: HyperParameterTuningJobObjective[] | undefined; + + /** + *The additional data source used during the training job.
+ * @public + */ + AdditionalS3DataSource?: AdditionalS3DataSource | undefined; +} + /** * @public */ @@ -719,51 +1052,164 @@ export interface CreateClusterResponse { /** * @public + * @enum */ -export interface CreateCodeRepositoryInput { - /** - *The name of the Git repository. The name must have 1 to 63 characters. Valid - * characters are a-z, A-Z, 0-9, and - (hyphen).
- * @public - */ - CodeRepositoryName: string | undefined; +export const FairShare = { + DISABLED: "Disabled", + ENABLED: "Enabled", +} as const; + +/** + * @public + */ +export type FairShare = (typeof FairShare)[keyof typeof FairShare]; +/** + *Priority class configuration. When included in PriorityClasses, these class
+ * configurations define how tasks are queued.
Specifies details about the repository, including the URL where the repository is - * located, the default branch, and credentials to use to access the repository.
+ *Name of the priority class.
* @public */ - GitConfig: GitConfig | undefined; + Name: string | undefined; /** - *An array of key-value pairs. You can use tags to categorize your Amazon Web Services - * resources in different ways, for example, by purpose, owner, or environment. For more - * information, see Tagging Amazon Web Services Resources.
+ *Weight of the priority class. The value is within a range from 0 to 100, where 0 is the + * default.
+ *A weight of 0 is the lowest priority and 100 is the highest. Weight 0 is the + * default.
* @public */ - Tags?: Tag[] | undefined; + Weight: number | undefined; } /** + *Cluster policy configuration. This policy is used for task prioritization and fair-share + * allocation. This helps prioritize critical workloads and distributes idle compute + * across entities.
* @public */ -export interface CreateCodeRepositoryOutput { +export interface SchedulerConfig { /** - *The Amazon Resource Name (ARN) of the new repository.
+ *List of the priority classes, PriorityClass, of the cluster policy. When
+ * specified, these class configurations define how tasks are queued.
When enabled, entities borrow idle compute based on their assigned
+ * FairShareWeight.
When disabled, entities borrow idle compute based on a first-come first-serve + * basis.
+ *Default is Enabled.
Name for the cluster policy.
+ * @public + */ + Name: string | undefined; + + /** + *ARN of the cluster.
+ * @public + */ + ClusterArn: string | undefined; + + /** + *Configuration about the monitoring schedule.
+ * @public + */ + SchedulerConfig: SchedulerConfig | undefined; + + /** + *Description of the cluster policy.
+ * @public + */ + Description?: string | undefined; + + /** + *Tags of the cluster policy.
+ * @public + */ + Tags?: Tag[] | undefined; +} + +/** + * @public + */ +export interface CreateClusterSchedulerConfigResponse { + /** + *ARN of the cluster policy.
+ * @public + */ + ClusterSchedulerConfigArn: string | undefined; + + /** + *ID of the cluster policy.
+ * @public + */ + ClusterSchedulerConfigId: string | undefined; +} + +/** + * @public + */ +export interface CreateCodeRepositoryInput { + /** + *The name of the Git repository. The name must have 1 to 63 characters. Valid + * characters are a-z, A-Z, 0-9, and - (hyphen).
+ * @public + */ + CodeRepositoryName: string | undefined; + + /** + *Specifies details about the repository, including the URL where the repository is + * located, the default branch, and credentials to use to access the repository.
+ * @public + */ + GitConfig: GitConfig | undefined; + + /** + *An array of key-value pairs. You can use tags to categorize your Amazon Web Services + * resources in different ways, for example, by purpose, owner, or environment. For more + * information, see Tagging Amazon Web Services Resources.
+ * @public + */ + Tags?: Tag[] | undefined; +} + +/** + * @public + */ +export interface CreateCodeRepositoryOutput { + /** + *The Amazon Resource Name (ARN) of the new repository.
+ * @public + */ + CodeRepositoryArn: string | undefined; +} + +/** + * @public + * @enum + */ +export const Framework = { + DARKNET: "DARKNET", + KERAS: "KERAS", + MXNET: "MXNET", + ONNX: "ONNX", PYTORCH: "PYTORCH", SKLEARN: "SKLEARN", TENSORFLOW: "TENSORFLOW", @@ -1619,6 +2065,73 @@ export interface CreateCompilationJobResponse { CompilationJobArn: string | undefined; } +/** + * @public + */ +export interface CreateComputeQuotaRequest { + /** + *Name to the compute allocation definition.
+ * @public + */ + Name: string | undefined; + + /** + *Description of the compute allocation definition.
+ * @public + */ + Description?: string | undefined; + + /** + *ARN of the cluster.
+ * @public + */ + ClusterArn: string | undefined; + + /** + *Configuration of the compute allocation definition. This includes the resource sharing + * option, and the setting to preempt low priority tasks.
+ * @public + */ + ComputeQuotaConfig: ComputeQuotaConfig | undefined; + + /** + *The target entity to allocate compute resources to.
+ * @public + */ + ComputeQuotaTarget: ComputeQuotaTarget | undefined; + + /** + *The state of the compute allocation being described. Use to enable or disable compute + * allocation.
+ *Default is Enabled.
Tags of the compute allocation definition.
+ * @public + */ + Tags?: Tag[] | undefined; +} + +/** + * @public + */ +export interface CreateComputeQuotaResponse { + /** + *ARN of the compute allocation definition.
+ * @public + */ + ComputeQuotaArn: string | undefined; + + /** + *ID of the compute allocation definition.
+ * @public + */ + ComputeQuotaId: string | undefined; +} + /** * @public */ @@ -2332,6 +2845,26 @@ export interface EFSFileSystemConfig { FileSystemPath?: string | undefined; } +/** + *The settings for assigning a custom Amazon FSx for Lustre file system to a user profile or space for an + * Amazon SageMaker Domain.
+ * @public + */ +export interface FSxLustreFileSystemConfig { + /** + *The globally unique, 17-digit, ID of the file system, assigned by Amazon FSx for Lustre.
+ * @public + */ + FileSystemId: string | undefined; + + /** + *The path to the file system directory that is accessible in Amazon SageMaker Studio. Permitted + * users can access only this directory and below.
+ * @public + */ + FileSystemPath?: string | undefined; +} + /** *The settings for assigning a custom file system to a user profile or space for an Amazon SageMaker Domain. Permitted users can access this file system in Amazon SageMaker * Studio.
@@ -2339,6 +2872,7 @@ export interface EFSFileSystemConfig { */ export type CustomFileSystemConfig = | CustomFileSystemConfig.EFSFileSystemConfigMember + | CustomFileSystemConfig.FSxLustreFileSystemConfigMember | CustomFileSystemConfig.$UnknownMember; /** @@ -2351,6 +2885,17 @@ export namespace CustomFileSystemConfig { */ export interface EFSFileSystemConfigMember { EFSFileSystemConfig: EFSFileSystemConfig; + FSxLustreFileSystemConfig?: never; + $unknown?: never; + } + + /** + *The settings for a custom Amazon FSx for Lustre file system.
+ * @public + */ + export interface FSxLustreFileSystemConfigMember { + EFSFileSystemConfig?: never; + FSxLustreFileSystemConfig: FSxLustreFileSystemConfig; $unknown?: never; } @@ -2359,16 +2904,20 @@ export namespace CustomFileSystemConfig { */ export interface $UnknownMember { EFSFileSystemConfig?: never; + FSxLustreFileSystemConfig?: never; $unknown: [string, any]; } export interface VisitorInformation on the IMDS configuration of the notebook instance
- * @public - */ -export interface InstanceMetadataServiceConfiguration { - /** - *Indicates the minimum IMDS version that the notebook instance supports. When passed as
- * part of CreateNotebookInstance, if no value is selected, then it defaults
- * to IMDSv1. This means that both IMDSv1 and IMDSv2 are supported. If passed as part of
- * UpdateNotebookInstance, there is no default.
The name of the new notebook instance.
- * @public - */ - NotebookInstanceName: string | undefined; - - /** - *The type of ML compute instance to launch for the notebook instance.
- * @public - */ - InstanceType: _InstanceType | undefined; - - /** - *The ID of the subnet in a VPC to which you would like to have a connectivity from - * your ML compute instance.
- * @public - */ - SubnetId?: string | undefined; - - /** - *The VPC security group IDs, in the form sg-xxxxxxxx. The security groups must be - * for the same VPC as specified in the subnet.
- * @public - */ - SecurityGroupIds?: string[] | undefined; - - /** - *When you send any requests to Amazon Web Services resources from the notebook - * instance, SageMaker assumes this role to perform tasks on your behalf. You must - * grant this role necessary permissions so SageMaker can perform these tasks. The - * policy must allow the SageMaker service principal (sagemaker.amazonaws.com) - * permissions to assume this role. For more information, see SageMaker Roles.
- *To be able to pass this role to SageMaker, the caller of this API must
- * have the iam:PassRole permission.
The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that - * SageMaker uses to encrypt data on the storage volume attached to your - * notebook instance. The KMS key you provide must be enabled. For information, see Enabling and - * Disabling Keys in the Amazon Web Services Key Management Service - * Developer Guide.
- * @public - */ - KmsKeyId?: string | undefined; - - /** - *An array of key-value pairs. You can use tags to categorize your Amazon Web Services - * resources in different ways, for example, by purpose, owner, or environment. For more - * information, see Tagging Amazon Web Services Resources.
- * @public - */ - Tags?: Tag[] | undefined; - - /** - *The name of a lifecycle configuration to associate with the notebook instance. For - * information about lifestyle configurations, see Step 2.1: (Optional) - * Customize a Notebook Instance.
- * @public - */ - LifecycleConfigName?: string | undefined; - - /** - *Sets whether SageMaker provides internet access to the notebook instance. If
- * you set this to Disabled this notebook instance is able to access resources
- * only in your VPC, and is not be able to connect to SageMaker training and
- * endpoint services unless you configure a NAT Gateway in your VPC.
For more information, see Notebook Instances Are Internet-Enabled by Default. You can set the value
- * of this parameter to Disabled only if you set a value for the
- * SubnetId parameter.
The size, in GB, of the ML storage volume to attach to the notebook instance. The - * default value is 5 GB.
- * @public - */ - VolumeSizeInGB?: number | undefined; - - /** - *This parameter is no longer supported. Elastic Inference (EI) is no longer - * available.
- *This parameter was used to specify a list of EI instance types to associate with this - * notebook instance.
- * @public - */ - AcceleratorTypes?: NotebookInstanceAcceleratorType[] | undefined; - - /** - *A Git repository to associate with the notebook instance as its default code - * repository. This can be either the name of a Git repository stored as a resource in your - * account, or the URL of a Git repository in Amazon Web Services CodeCommit - * or in any other Git repository. When you open a notebook instance, it opens in the - * directory that contains this repository. For more information, see Associating Git - * Repositories with SageMaker Notebook Instances.
- * @public - */ - DefaultCodeRepository?: string | undefined; - - /** - *An array of up to three Git repositories to associate with the notebook instance. - * These can be either the names of Git repositories stored as resources in your account, - * or the URL of Git repositories in Amazon Web Services CodeCommit - * or in any other Git repository. These repositories are cloned at the same level as the - * default repository of your notebook instance. For more information, see Associating Git - * Repositories with SageMaker Notebook Instances.
- * @public - */ - AdditionalCodeRepositories?: string[] | undefined; - - /** - *Whether root access is enabled or disabled for users of the notebook instance. The
- * default value is Enabled.
Lifecycle configurations need root access to be able to set up a notebook - * instance. Because of this, lifecycle configurations associated with a notebook - * instance always run with root access even if you disable root access for - * users.
- *The platform identifier of the notebook instance runtime environment.
- * @public - */ - PlatformIdentifier?: string | undefined; - - /** - *Information on the IMDS configuration of the notebook instance
- * @public - */ - InstanceMetadataServiceConfiguration?: InstanceMetadataServiceConfiguration | undefined; -} - -/** - * @public - */ -export interface CreateNotebookInstanceOutput { - /** - *The Amazon Resource Name (ARN) of the notebook instance.
- * @public - */ - NotebookInstanceArn?: string | undefined; -} - -/** - *Contains the notebook instance lifecycle configuration script.
- *Each lifecycle configuration script has a limit of 16384 characters.
- *The value of the $PATH environment variable that is available to both
- * scripts is /sbin:bin:/usr/sbin:/usr/bin.
View Amazon CloudWatch Logs for notebook instance lifecycle configurations in log
- * group /aws/sagemaker/NotebookInstances in log stream
- * [notebook-instance-name]/[LifecycleConfigHook].
Lifecycle configuration scripts cannot run for longer than 5 minutes. If a script runs - * for longer than 5 minutes, it fails and the notebook instance is not created or - * started.
- *For information about notebook instance lifestyle configurations, see Step - * 2.1: (Optional) Customize a Notebook Instance.
- * @public - */ -export interface NotebookInstanceLifecycleHook { - /** - *A base64-encoded string that contains a shell script for a notebook instance lifecycle - * configuration.
- * @public - */ - Content?: string | undefined; -} - -/** - * @public - */ -export interface CreateNotebookInstanceLifecycleConfigInput { - /** - *The name of the lifecycle configuration.
- * @public - */ - NotebookInstanceLifecycleConfigName: string | undefined; - - /** - *A shell script that runs only once, when you create a notebook instance. The shell - * script must be a base64-encoded string.
- * @public - */ - OnCreate?: NotebookInstanceLifecycleHook[] | undefined; - - /** - *A shell script that runs every time you start a notebook instance, including when you - * create the notebook instance. The shell script must be a base64-encoded string.
- * @public - */ - OnStart?: NotebookInstanceLifecycleHook[] | undefined; -} - -/** - * @public - */ -export interface CreateNotebookInstanceLifecycleConfigOutput { - /** - *The Amazon Resource Name (ARN) of the lifecycle configuration.
- * @public - */ - NotebookInstanceLifecycleConfigArn?: string | undefined; -} - -/** - * @public - * @enum - */ -export const OptimizationJobDeploymentInstanceType = { - ML_G5_12XLARGE: "ml.g5.12xlarge", - ML_G5_16XLARGE: "ml.g5.16xlarge", - ML_G5_24XLARGE: "ml.g5.24xlarge", - ML_G5_2XLARGE: "ml.g5.2xlarge", - ML_G5_48XLARGE: "ml.g5.48xlarge", - ML_G5_4XLARGE: "ml.g5.4xlarge", - ML_G5_8XLARGE: "ml.g5.8xlarge", - ML_G5_XLARGE: "ml.g5.xlarge", - ML_G6_12XLARGE: "ml.g6.12xlarge", - ML_G6_16XLARGE: "ml.g6.16xlarge", - ML_G6_24XLARGE: "ml.g6.24xlarge", - ML_G6_2XLARGE: "ml.g6.2xlarge", - ML_G6_48XLARGE: "ml.g6.48xlarge", - ML_G6_4XLARGE: "ml.g6.4xlarge", - ML_G6_8XLARGE: "ml.g6.8xlarge", - ML_G6_XLARGE: "ml.g6.xlarge", - ML_INF2_24XLARGE: "ml.inf2.24xlarge", - ML_INF2_48XLARGE: "ml.inf2.48xlarge", - ML_INF2_8XLARGE: "ml.inf2.8xlarge", - ML_INF2_XLARGE: "ml.inf2.xlarge", - ML_P4DE_24XLARGE: "ml.p4de.24xlarge", - ML_P4D_24XLARGE: "ml.p4d.24xlarge", - ML_P5_48XLARGE: "ml.p5.48xlarge", - ML_TRN1N_32XLARGE: "ml.trn1n.32xlarge", - ML_TRN1_2XLARGE: "ml.trn1.2xlarge", - ML_TRN1_32XLARGE: "ml.trn1.32xlarge", -} as const; - -/** - * @public - */ -export type OptimizationJobDeploymentInstanceType = - (typeof OptimizationJobDeploymentInstanceType)[keyof typeof OptimizationJobDeploymentInstanceType]; - -/** - *The access configuration settings for the source ML model for an optimization job, where you can accept the model end-user license agreement (EULA).
- * @public - */ -export interface OptimizationModelAccessConfig { - /** - *Specifies agreement to the model end-user license agreement (EULA). The
- * AcceptEula value must be explicitly defined as True in order
- * to accept the EULA that this model requires. You are responsible for reviewing and
- * complying with any applicable license terms and making sure they are acceptable for your
- * use case before downloading or using a model.
The Amazon S3 location of a source model to optimize with an optimization job.
- * @public - */ -export interface OptimizationJobModelSourceS3 { - /** - *An Amazon S3 URI that locates a source model to optimize with an optimization job.
- * @public - */ - S3Uri?: string | undefined; - - /** - *The access configuration settings for the source ML model for an optimization job, where you can accept the model end-user license agreement (EULA).
- * @public - */ - ModelAccessConfig?: OptimizationModelAccessConfig | undefined; -} - -/** - *The location of the source model to optimize with an optimization job.
- * @public - */ -export interface OptimizationJobModelSource { - /** - *The Amazon S3 location of a source model to optimize with an optimization job.
- * @public - */ - S3?: OptimizationJobModelSourceS3 | undefined; -} - -/** - *Settings for the model compilation technique that's applied by a model optimization job.
- * @public - */ -export interface ModelCompilationConfig { - /** - *The URI of an LMI DLC in Amazon ECR. SageMaker uses this image to run the optimization.
- * @public - */ - Image?: string | undefined; - - /** - *Environment variables that override the default ones in the model container.
- * @public - */ - OverrideEnvironment?: RecordSettings for the model quantization technique that's applied by a model optimization job.
- * @public - */ -export interface ModelQuantizationConfig { - /** - *The URI of an LMI DLC in Amazon ECR. SageMaker uses this image to run the optimization.
- * @public - */ - Image?: string | undefined; - - /** - *Environment variables that override the default ones in the model container.
- * @public - */ - OverrideEnvironment?: RecordSettings for the model sharding technique that's applied by a model optimization job.
- * @public - */ -export interface ModelShardingConfig { - /** - *The URI of an LMI DLC in Amazon ECR. SageMaker uses this image to run the optimization.
- * @public - */ - Image?: string | undefined; - - /** - *Environment variables that override the default ones in the model container.
- * @public - */ - OverrideEnvironment?: RecordSettings for an optimization technique that you apply with a model optimization - * job.
- * @public - */ -export type OptimizationConfig = - | OptimizationConfig.ModelCompilationConfigMember - | OptimizationConfig.ModelQuantizationConfigMember - | OptimizationConfig.ModelShardingConfigMember - | OptimizationConfig.$UnknownMember; - -/** - * @public - */ -export namespace OptimizationConfig { - /** - *Settings for the model quantization technique that's applied by a model optimization job.
- * @public - */ - export interface ModelQuantizationConfigMember { - ModelQuantizationConfig: ModelQuantizationConfig; - ModelCompilationConfig?: never; - ModelShardingConfig?: never; - $unknown?: never; - } - - /** - *Settings for the model compilation technique that's applied by a model optimization job.
- * @public - */ - export interface ModelCompilationConfigMember { - ModelQuantizationConfig?: never; - ModelCompilationConfig: ModelCompilationConfig; - ModelShardingConfig?: never; - $unknown?: never; - } - - /** - *Settings for the model sharding technique that's applied by a model optimization job.
- * @public - */ - export interface ModelShardingConfigMember { - ModelQuantizationConfig?: never; - ModelCompilationConfig?: never; - ModelShardingConfig: ModelShardingConfig; - $unknown?: never; - } - - /** - * @public - */ - export interface $UnknownMember { - ModelQuantizationConfig?: never; - ModelCompilationConfig?: never; - ModelShardingConfig?: never; - $unknown: [string, any]; - } - - export interface VisitorDetails for where to store the optimized model that you create with the optimization job.
- * @public - */ -export interface OptimizationJobOutputConfig { - /** - *The Amazon Resource Name (ARN) of a key in Amazon Web Services KMS. SageMaker uses they key to encrypt the artifacts of the - * optimized model when SageMaker uploads the model to Amazon S3.
- * @public - */ - KmsKeyId?: string | undefined; - - /** - *The Amazon S3 URI for where to store the optimized model that you create with an optimization - * job.
- * @public - */ - S3OutputLocation: string | undefined; -} - -/** - *A VPC in Amazon VPC that's accessible to an optimized that you create with an optimization - * job. You can control access to and from your resources by configuring a VPC. For more - * information, see Give SageMaker Access to Resources in your Amazon VPC.
- * @public - */ -export interface OptimizationVpcConfig { - /** - *The VPC security group IDs, in the form sg-xxxxxxxx. Specify the security
- * groups for the VPC that is specified in the Subnets field.
The ID of the subnets in the VPC to which you want to connect your optimized - * model.
- * @public - */ - Subnets: string[] | undefined; -} - /** * @internal */ diff --git a/clients/client-sagemaker/src/models/models_2.ts b/clients/client-sagemaker/src/models/models_2.ts index 3b1886525097..3e6c5ba57642 100644 --- a/clients/client-sagemaker/src/models/models_2.ts +++ b/clients/client-sagemaker/src/models/models_2.ts @@ -4,6 +4,7 @@ import { SENSITIVE_STRING } from "@smithy/smithy-client"; import { ActionSource, ActionStatus, + ActivationState, AlgorithmSpecification, AlgorithmStatus, AlgorithmStatusDetails, @@ -34,7 +35,6 @@ import { AutoMLProblemTypeConfigName, AutoMLResolvedAttributes, AutoMLSecurityConfig, - Autotune, BatchDataCaptureConfig, BatchStrategy, CaptureStatus, @@ -51,14 +51,13 @@ import { CognitoMemberDefinition, CollectionConfiguration, CompilationJobStatus, + ComputeQuotaConfig, + ComputeQuotaTarget, ContextSource, GitConfig, - HyperParameterTuningJobObjectiveType, InferenceSpecification, JupyterLabAppImageConfig, KernelGatewayImageConfig, - MetadataProperties, - ObjectiveStatus, OutputDataConfig, ProblemType, ProcessingS3DataDistributionType, @@ -66,9 +65,9 @@ import { ProductionVariantInstanceType, ResourceConfig, ResourceSpec, + SchedulerResourceStatus, StoppingCondition, Tag, - TrainingSpecification, TransformInput, TransformOutput, TransformResources, @@ -77,6 +76,7 @@ import { } from "./models_0"; import { + _InstanceType, DataCaptureConfig, DataQualityAppSpecification, DataQualityBaselineConfig, @@ -89,7 +89,6 @@ import { EdgeDeploymentModelConfig, EdgeOutputConfig, EdgePresetDeploymentType, - EndpointInfo, ExplainerConfig, FeatureDefinition, FeatureType, @@ -98,20 +97,11 @@ import { HumanLoopActivationConfig, HumanLoopConfig, HumanLoopRequestSource, - HyperParameterTrainingJobDefinition, - HyperParameterTuningJobConfig, - HyperParameterTuningJobWarmStartConfig, - InferenceComponentComputeResourceRequirements, - InferenceComponentStartupParameters, - InferenceExperimentDataStorageConfig, - InferenceExperimentSchedule, - InferenceExperimentType, InputConfig, - JobType, JupyterServerAppSettings, KernelGatewayAppSettings, + MetadataProperties, ModelDeployConfig, - ModelInfrastructureConfig, MonitoringNetworkConfig, MonitoringOutputConfig, MonitoringResources, @@ -120,2916 +110,2731 @@ import { NetworkConfig, OfflineStoreConfig, OnlineStoreConfig, - OptimizationConfig, - OptimizationJobDeploymentInstanceType, - OptimizationJobModelSource, - OptimizationJobOutputConfig, - OptimizationVpcConfig, OutputConfig, ProcessingInstanceType, ProcessingS3UploadMode, - Processor, ProductionVariant, ProductionVariantAcceleratorType, ProductionVariantManagedInstanceScaling, ProductionVariantRoutingConfig, ProductionVariantServerlessConfig, RetryStrategy, - ShadowModeConfig, + SchedulerConfig, TagPropagation, ThroughputMode, + TrainingSpecification, UserSettings, - VendorGuidance, } from "./models_1"; /** * @public + * @enum */ -export interface CreateOptimizationJobRequest { +export const NotebookInstanceAcceleratorType = { + ML_EIA1_LARGE: "ml.eia1.large", + ML_EIA1_MEDIUM: "ml.eia1.medium", + ML_EIA1_XLARGE: "ml.eia1.xlarge", + ML_EIA2_LARGE: "ml.eia2.large", + ML_EIA2_MEDIUM: "ml.eia2.medium", + ML_EIA2_XLARGE: "ml.eia2.xlarge", +} as const; + +/** + * @public + */ +export type NotebookInstanceAcceleratorType = + (typeof NotebookInstanceAcceleratorType)[keyof typeof NotebookInstanceAcceleratorType]; + +/** + * @public + * @enum + */ +export const DirectInternetAccess = { + DISABLED: "Disabled", + ENABLED: "Enabled", +} as const; + +/** + * @public + */ +export type DirectInternetAccess = (typeof DirectInternetAccess)[keyof typeof DirectInternetAccess]; + +/** + *Information on the IMDS configuration of the notebook instance
+ * @public + */ +export interface InstanceMetadataServiceConfiguration { /** - *A custom name for the new optimization job.
+ *Indicates the minimum IMDS version that the notebook instance supports. When passed as
+ * part of CreateNotebookInstance, if no value is selected, then it defaults
+ * to IMDSv1. This means that both IMDSv1 and IMDSv2 are supported. If passed as part of
+ * UpdateNotebookInstance, there is no default.
The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.
- *During model optimization, Amazon SageMaker needs your permission to:
- *Read input data from an S3 bucket
- *Write model artifacts to an S3 bucket
- *Write logs to Amazon CloudWatch Logs
- *Publish metrics to Amazon CloudWatch
- *You grant permissions for all of these tasks to an IAM role. To pass this
- * role to Amazon SageMaker, the caller of this API must have the
- * iam:PassRole permission. For more information, see Amazon SageMaker Roles.
- *
The name of the new notebook instance.
+ * @public + */ + NotebookInstanceName: string | undefined; + + /** + *The type of ML compute instance to launch for the notebook instance.
+ * @public + */ + InstanceType: _InstanceType | undefined; + + /** + *The ID of the subnet in a VPC to which you would like to have a connectivity from + * your ML compute instance.
+ * @public + */ + SubnetId?: string | undefined; + + /** + *The VPC security group IDs, in the form sg-xxxxxxxx. The security groups must be + * for the same VPC as specified in the subnet.
+ * @public + */ + SecurityGroupIds?: string[] | undefined; + + /** + *When you send any requests to Amazon Web Services resources from the notebook + * instance, SageMaker assumes this role to perform tasks on your behalf. You must + * grant this role necessary permissions so SageMaker can perform these tasks. The + * policy must allow the SageMaker service principal (sagemaker.amazonaws.com) + * permissions to assume this role. For more information, see SageMaker Roles.
+ *To be able to pass this role to SageMaker, the caller of this API must
+ * have the iam:PassRole permission.
The location of the source model to optimize with an optimization job.
+ *The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that + * SageMaker uses to encrypt data on the storage volume attached to your + * notebook instance. The KMS key you provide must be enabled. For information, see Enabling and + * Disabling Keys in the Amazon Web Services Key Management Service + * Developer Guide.
* @public */ - ModelSource: OptimizationJobModelSource | undefined; + KmsKeyId?: string | undefined; /** - *The type of instance that hosts the optimized model that you create with the optimization job.
+ *An array of key-value pairs. You can use tags to categorize your Amazon Web Services + * resources in different ways, for example, by purpose, owner, or environment. For more + * information, see Tagging Amazon Web Services Resources.
* @public */ - DeploymentInstanceType: OptimizationJobDeploymentInstanceType | undefined; + Tags?: Tag[] | undefined; /** - *The environment variables to set in the model container.
+ *The name of a lifecycle configuration to associate with the notebook instance. For + * information about lifestyle configurations, see Step 2.1: (Optional) + * Customize a Notebook Instance.
* @public */ - OptimizationEnvironment?: RecordSettings for each of the optimization techniques that the job applies.
+ *Sets whether SageMaker provides internet access to the notebook instance. If
+ * you set this to Disabled this notebook instance is able to access resources
+ * only in your VPC, and is not be able to connect to SageMaker training and
+ * endpoint services unless you configure a NAT Gateway in your VPC.
For more information, see Notebook Instances Are Internet-Enabled by Default. You can set the value
+ * of this parameter to Disabled only if you set a value for the
+ * SubnetId parameter.
Details for where to store the optimized model that you create with the optimization job.
+ *The size, in GB, of the ML storage volume to attach to the notebook instance. The + * default value is 5 GB.
* @public */ - OutputConfig: OptimizationJobOutputConfig | undefined; + VolumeSizeInGB?: number | undefined; /** - *Specifies a limit to how long a job can run. When the job reaches the time limit, SageMaker - * ends the job. Use this API to cap costs.
- *To stop a training job, SageMaker sends the algorithm the SIGTERM signal,
- * which delays job termination for 120 seconds. Algorithms can use this 120-second window
- * to save the model artifacts, so the results of training are not lost.
The training algorithms provided by SageMaker automatically save the intermediate results
- * of a model training job when possible. This attempt to save artifacts is only a best
- * effort case as model might not be in a state from which it can be saved. For example, if
- * training has just started, the model might not be ready to save. When saved, this
- * intermediate data is a valid model artifact. You can use it to create a model with
- * CreateModel.
This parameter is no longer supported. Elastic Inference (EI) is no longer + * available.
+ *This parameter was used to specify a list of EI instance types to associate with this + * notebook instance.
+ * @public + */ + AcceleratorTypes?: NotebookInstanceAcceleratorType[] | undefined; + + /** + *A Git repository to associate with the notebook instance as its default code + * repository. This can be either the name of a Git repository stored as a resource in your + * account, or the URL of a Git repository in Amazon Web Services CodeCommit + * or in any other Git repository. When you open a notebook instance, it opens in the + * directory that contains this repository. For more information, see Associating Git + * Repositories with SageMaker Notebook Instances.
+ * @public + */ + DefaultCodeRepository?: string | undefined; + + /** + *An array of up to three Git repositories to associate with the notebook instance. + * These can be either the names of Git repositories stored as resources in your account, + * or the URL of Git repositories in Amazon Web Services CodeCommit + * or in any other Git repository. These repositories are cloned at the same level as the + * default repository of your notebook instance. For more information, see Associating Git + * Repositories with SageMaker Notebook Instances.
+ * @public + */ + AdditionalCodeRepositories?: string[] | undefined; + + /** + *Whether root access is enabled or disabled for users of the notebook instance. The
+ * default value is Enabled.
The Neural Topic Model (NTM) currently does not support saving intermediate model - * artifacts. When training NTMs, make sure that the maximum runtime is sufficient for - * the training job to complete.
+ *Lifecycle configurations need root access to be able to set up a notebook + * instance. Because of this, lifecycle configurations associated with a notebook + * instance always run with root access even if you disable root access for + * users.
*A list of key-value pairs associated with the optimization job. For more information, - * see Tagging Amazon Web Services resources in the Amazon Web Services General Reference - * Guide.
+ *The platform identifier of the notebook instance runtime environment.
* @public */ - Tags?: Tag[] | undefined; + PlatformIdentifier?: string | undefined; /** - *A VPC in Amazon VPC that your optimized model has access to.
+ *Information on the IMDS configuration of the notebook instance
* @public */ - VpcConfig?: OptimizationVpcConfig | undefined; + InstanceMetadataServiceConfiguration?: InstanceMetadataServiceConfiguration | undefined; } /** * @public */ -export interface CreateOptimizationJobResponse { +export interface CreateNotebookInstanceOutput { /** - *The Amazon Resource Name (ARN) of the optimization job.
+ *The Amazon Resource Name (ARN) of the notebook instance.
* @public */ - OptimizationJobArn: string | undefined; + NotebookInstanceArn?: string | undefined; } /** - *Configuration that controls the parallelism of the pipeline. - * By default, the parallelism configuration specified applies to all - * executions of the pipeline unless overridden.
+ *Contains the notebook instance lifecycle configuration script.
+ *Each lifecycle configuration script has a limit of 16384 characters.
+ *The value of the $PATH environment variable that is available to both
+ * scripts is /sbin:bin:/usr/sbin:/usr/bin.
View Amazon CloudWatch Logs for notebook instance lifecycle configurations in log
+ * group /aws/sagemaker/NotebookInstances in log stream
+ * [notebook-instance-name]/[LifecycleConfigHook].
Lifecycle configuration scripts cannot run for longer than 5 minutes. If a script runs + * for longer than 5 minutes, it fails and the notebook instance is not created or + * started.
+ *For information about notebook instance lifestyle configurations, see Step + * 2.1: (Optional) Customize a Notebook Instance.
* @public */ -export interface ParallelismConfiguration { +export interface NotebookInstanceLifecycleHook { /** - *The max number of steps that can be executed in parallel.
+ *A base64-encoded string that contains a shell script for a notebook instance lifecycle + * configuration.
* @public */ - MaxParallelExecutionSteps: number | undefined; + Content?: string | undefined; } /** - *The location of the pipeline definition stored in Amazon S3.
* @public */ -export interface PipelineDefinitionS3Location { +export interface CreateNotebookInstanceLifecycleConfigInput { /** - *Name of the S3 bucket.
+ *The name of the lifecycle configuration.
* @public */ - Bucket: string | undefined; + NotebookInstanceLifecycleConfigName: string | undefined; /** - *The object key (or key name) uniquely identifies the - * object in an S3 bucket.
+ *A shell script that runs only once, when you create a notebook instance. The shell + * script must be a base64-encoded string.
* @public */ - ObjectKey: string | undefined; + OnCreate?: NotebookInstanceLifecycleHook[] | undefined; /** - *Version Id of the pipeline definition file. If not specified, Amazon SageMaker - * will retrieve the latest version.
+ *A shell script that runs every time you start a notebook instance, including when you + * create the notebook instance. The shell script must be a base64-encoded string.
* @public */ - VersionId?: string | undefined; + OnStart?: NotebookInstanceLifecycleHook[] | undefined; } /** * @public */ -export interface CreatePipelineRequest { +export interface CreateNotebookInstanceLifecycleConfigOutput { /** - *The name of the pipeline.
+ *The Amazon Resource Name (ARN) of the lifecycle configuration.
* @public */ - PipelineName: string | undefined; + NotebookInstanceLifecycleConfigArn?: string | undefined; +} + +/** + * @public + * @enum + */ +export const OptimizationJobDeploymentInstanceType = { + ML_G5_12XLARGE: "ml.g5.12xlarge", + ML_G5_16XLARGE: "ml.g5.16xlarge", + ML_G5_24XLARGE: "ml.g5.24xlarge", + ML_G5_2XLARGE: "ml.g5.2xlarge", + ML_G5_48XLARGE: "ml.g5.48xlarge", + ML_G5_4XLARGE: "ml.g5.4xlarge", + ML_G5_8XLARGE: "ml.g5.8xlarge", + ML_G5_XLARGE: "ml.g5.xlarge", + ML_G6_12XLARGE: "ml.g6.12xlarge", + ML_G6_16XLARGE: "ml.g6.16xlarge", + ML_G6_24XLARGE: "ml.g6.24xlarge", + ML_G6_2XLARGE: "ml.g6.2xlarge", + ML_G6_48XLARGE: "ml.g6.48xlarge", + ML_G6_4XLARGE: "ml.g6.4xlarge", + ML_G6_8XLARGE: "ml.g6.8xlarge", + ML_G6_XLARGE: "ml.g6.xlarge", + ML_INF2_24XLARGE: "ml.inf2.24xlarge", + ML_INF2_48XLARGE: "ml.inf2.48xlarge", + ML_INF2_8XLARGE: "ml.inf2.8xlarge", + ML_INF2_XLARGE: "ml.inf2.xlarge", + ML_P4DE_24XLARGE: "ml.p4de.24xlarge", + ML_P4D_24XLARGE: "ml.p4d.24xlarge", + ML_P5_48XLARGE: "ml.p5.48xlarge", + ML_TRN1N_32XLARGE: "ml.trn1n.32xlarge", + ML_TRN1_2XLARGE: "ml.trn1.2xlarge", + ML_TRN1_32XLARGE: "ml.trn1.32xlarge", +} as const; + +/** + * @public + */ +export type OptimizationJobDeploymentInstanceType = + (typeof OptimizationJobDeploymentInstanceType)[keyof typeof OptimizationJobDeploymentInstanceType]; +/** + *The access configuration settings for the source ML model for an optimization job, where you can accept the model end-user license agreement (EULA).
+ * @public + */ +export interface OptimizationModelAccessConfig { /** - *The display name of the pipeline.
+ *Specifies agreement to the model end-user license agreement (EULA). The
+ * AcceptEula value must be explicitly defined as True in order
+ * to accept the EULA that this model requires. You are responsible for reviewing and
+ * complying with any applicable license terms and making sure they are acceptable for your
+ * use case before downloading or using a model.
The Amazon S3 location of a source model to optimize with an optimization job.
+ * @public + */ +export interface OptimizationJobModelSourceS3 { /** - *The JSON - * pipeline definition of the pipeline.
+ *An Amazon S3 URI that locates a source model to optimize with an optimization job.
* @public */ - PipelineDefinition?: string | undefined; + S3Uri?: string | undefined; /** - *The location of the pipeline definition stored in Amazon S3. If specified, - * SageMaker will retrieve the pipeline definition from this location.
+ *The access configuration settings for the source ML model for an optimization job, where you can accept the model end-user license agreement (EULA).
* @public */ - PipelineDefinitionS3Location?: PipelineDefinitionS3Location | undefined; + ModelAccessConfig?: OptimizationModelAccessConfig | undefined; +} +/** + *The location of the source model to optimize with an optimization job.
+ * @public + */ +export interface OptimizationJobModelSource { /** - *A description of the pipeline.
+ *The Amazon S3 location of a source model to optimize with an optimization job.
* @public */ - PipelineDescription?: string | undefined; + S3?: OptimizationJobModelSourceS3 | undefined; +} +/** + *Settings for the model compilation technique that's applied by a model optimization job.
+ * @public + */ +export interface ModelCompilationConfig { /** - *A unique, case-sensitive identifier that you provide to ensure the idempotency of the - * operation. An idempotent operation completes no more than one time.
+ *The URI of an LMI DLC in Amazon ECR. SageMaker uses this image to run the optimization.
* @public */ - ClientRequestToken?: string | undefined; + Image?: string | undefined; /** - *The Amazon Resource Name (ARN) of the role used by the pipeline to access and create resources.
+ *Environment variables that override the default ones in the model container.
* @public */ - RoleArn: string | undefined; + OverrideEnvironment?: RecordSettings for the model quantization technique that's applied by a model optimization job.
+ * @public + */ +export interface ModelQuantizationConfig { /** - *A list of tags to apply to the created pipeline.
+ *The URI of an LMI DLC in Amazon ECR. SageMaker uses this image to run the optimization.
* @public */ - Tags?: Tag[] | undefined; + Image?: string | undefined; /** - *This is the configuration that controls the parallelism of the pipeline. - * If specified, it applies to all runs of this pipeline by default.
+ *Environment variables that override the default ones in the model container.
* @public */ - ParallelismConfiguration?: ParallelismConfiguration | undefined; + OverrideEnvironment?: RecordSettings for the model sharding technique that's applied by a model optimization job.
* @public */ -export interface CreatePipelineResponse { +export interface ModelShardingConfig { /** - *The Amazon Resource Name (ARN) of the created pipeline.
+ *The URI of an LMI DLC in Amazon ECR. SageMaker uses this image to run the optimization.
* @public */ - PipelineArn?: string | undefined; + Image?: string | undefined; + + /** + *Environment variables that override the default ones in the model container.
+ * @public + */ + OverrideEnvironment?: RecordSettings for an optimization technique that you apply with a model optimization + * job.
* @public */ -export interface CreatePresignedDomainUrlRequest { +export type OptimizationConfig = + | OptimizationConfig.ModelCompilationConfigMember + | OptimizationConfig.ModelQuantizationConfigMember + | OptimizationConfig.ModelShardingConfigMember + | OptimizationConfig.$UnknownMember; + +/** + * @public + */ +export namespace OptimizationConfig { /** - *The domain ID.
+ *Settings for the model quantization technique that's applied by a model optimization job.
* @public */ - DomainId: string | undefined; + export interface ModelQuantizationConfigMember { + ModelQuantizationConfig: ModelQuantizationConfig; + ModelCompilationConfig?: never; + ModelShardingConfig?: never; + $unknown?: never; + } /** - *The name of the UserProfile to sign-in as.
+ *Settings for the model compilation technique that's applied by a model optimization job.
* @public */ - UserProfileName: string | undefined; + export interface ModelCompilationConfigMember { + ModelQuantizationConfig?: never; + ModelCompilationConfig: ModelCompilationConfig; + ModelShardingConfig?: never; + $unknown?: never; + } /** - *The session expiration duration in seconds. This value defaults to 43200.
+ *Settings for the model sharding technique that's applied by a model optimization job.
* @public */ - SessionExpirationDurationInSeconds?: number | undefined; + export interface ModelShardingConfigMember { + ModelQuantizationConfig?: never; + ModelCompilationConfig?: never; + ModelShardingConfig: ModelShardingConfig; + $unknown?: never; + } /** - *The number of seconds until the pre-signed URL expires. This value defaults to 300.
* @public */ - ExpiresInSeconds?: number | undefined; + export interface $UnknownMember { + ModelQuantizationConfig?: never; + ModelCompilationConfig?: never; + ModelShardingConfig?: never; + $unknown: [string, any]; + } + + export interface VisitorDetails for where to store the optimized model that you create with the optimization job.
+ * @public + */ +export interface OptimizationJobOutputConfig { /** - *The name of the space.
+ *The Amazon Resource Name (ARN) of a key in Amazon Web Services KMS. SageMaker uses they key to encrypt the artifacts of the + * optimized model when SageMaker uploads the model to Amazon S3.
* @public */ - SpaceName?: string | undefined; + KmsKeyId?: string | undefined; /** - *The landing page that the user is directed to when accessing the presigned URL. Using this - * value, users can access Studio or Studio Classic, even if it is not the default experience for - * the domain. The supported values are:
- *
- * studio::relative/path: Directs users to the relative path in
- * Studio.
- * app:JupyterServer:relative/path: Directs users to the relative path in
- * the Studio Classic application.
- * app:JupyterLab:relative/path: Directs users to the relative path in the
- * JupyterLab application.
- * app:RStudioServerPro:relative/path: Directs users to the relative path in
- * the RStudio application.
- * app:CodeEditor:relative/path: Directs users to the relative path in the
- * Code Editor, based on Code-OSS, Visual Studio Code - Open Source application.
- * app:Canvas:relative/path: Directs users to the relative path in the
- * Canvas application.
The Amazon S3 URI for where to store the optimized model that you create with an optimization + * job.
* @public */ - LandingUri?: string | undefined; + S3OutputLocation: string | undefined; } /** + *A VPC in Amazon VPC that's accessible to an optimized that you create with an optimization + * job. You can control access to and from your resources by configuring a VPC. For more + * information, see Give SageMaker Access to Resources in your Amazon VPC.
* @public */ -export interface CreatePresignedDomainUrlResponse { +export interface OptimizationVpcConfig { /** - *The presigned URL.
+ *The VPC security group IDs, in the form sg-xxxxxxxx. Specify the security
+ * groups for the VPC that is specified in the Subnets field.
The ID of the subnets in the VPC to which you want to connect your optimized + * model.
+ * @public + */ + Subnets: string[] | undefined; } /** * @public */ -export interface CreatePresignedMlflowTrackingServerUrlRequest { +export interface CreateOptimizationJobRequest { /** - *The name of the tracking server to connect to your MLflow UI.
+ *A custom name for the new optimization job.
* @public */ - TrackingServerName: string | undefined; + OptimizationJobName: string | undefined; /** - *The duration in seconds that your presigned URL is valid. The presigned URL can be used - * only once.
+ *The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.
+ *During model optimization, Amazon SageMaker needs your permission to:
+ *Read input data from an S3 bucket
+ *Write model artifacts to an S3 bucket
+ *Write logs to Amazon CloudWatch Logs
+ *Publish metrics to Amazon CloudWatch
+ *You grant permissions for all of these tasks to an IAM role. To pass this
+ * role to Amazon SageMaker, the caller of this API must have the
+ * iam:PassRole permission. For more information, see Amazon SageMaker Roles.
+ *
The duration in seconds that your MLflow UI session is valid.
+ *The location of the source model to optimize with an optimization job.
* @public */ - SessionExpirationDurationInSeconds?: number | undefined; -} + ModelSource: OptimizationJobModelSource | undefined; -/** - * @public - */ -export interface CreatePresignedMlflowTrackingServerUrlResponse { /** - *A presigned URL with an authorization token.
+ *The type of instance that hosts the optimized model that you create with the optimization job.
* @public */ - AuthorizedUrl?: string | undefined; -} + DeploymentInstanceType: OptimizationJobDeploymentInstanceType | undefined; -/** - * @public - */ -export interface CreatePresignedNotebookInstanceUrlInput { /** - *The name of the notebook instance.
+ *The environment variables to set in the model container.
* @public */ - NotebookInstanceName: string | undefined; + OptimizationEnvironment?: RecordThe duration of the session, in seconds. The default is 12 hours.
+ *Settings for each of the optimization techniques that the job applies.
* @public */ - SessionExpirationDurationInSeconds?: number | undefined; -} + OptimizationConfigs: OptimizationConfig[] | undefined; -/** - * @public - */ -export interface CreatePresignedNotebookInstanceUrlOutput { /** - *A JSON object that contains the URL string.
+ *Details for where to store the optimized model that you create with the optimization job.
* @public */ - AuthorizedUrl?: string | undefined; -} + OutputConfig: OptimizationJobOutputConfig | undefined; -/** - *Associates a SageMaker job as a trial component with an experiment and trial. Specified when - * you call the following APIs:
- *- * CreateProcessingJob - *
- *- * CreateTrainingJob - *
- *- * CreateTransformJob - *
- *The name of an existing experiment to associate with the trial component.
+ *Specifies a limit to how long a job can run. When the job reaches the time limit, SageMaker + * ends the job. Use this API to cap costs.
+ *To stop a training job, SageMaker sends the algorithm the SIGTERM signal,
+ * which delays job termination for 120 seconds. Algorithms can use this 120-second window
+ * to save the model artifacts, so the results of training are not lost.
The training algorithms provided by SageMaker automatically save the intermediate results
+ * of a model training job when possible. This attempt to save artifacts is only a best
+ * effort case as model might not be in a state from which it can be saved. For example, if
+ * training has just started, the model might not be ready to save. When saved, this
+ * intermediate data is a valid model artifact. You can use it to create a model with
+ * CreateModel.
The Neural Topic Model (NTM) currently does not support saving intermediate model + * artifacts. When training NTMs, make sure that the maximum runtime is sufficient for + * the training job to complete.
+ *The name of an existing trial to associate the trial component with. If not specified, a - * new trial is created.
+ *A list of key-value pairs associated with the optimization job. For more information, + * see Tagging Amazon Web Services resources in the Amazon Web Services General Reference + * Guide.
* @public */ - TrialName?: string | undefined; + Tags?: Tag[] | undefined; /** - *The display name for the trial component. If this key isn't specified, the display name is - * the trial component name.
+ *A VPC in Amazon VPC that your optimized model has access to.
* @public */ - TrialComponentDisplayName?: string | undefined; + VpcConfig?: OptimizationVpcConfig | undefined; +} +/** + * @public + */ +export interface CreateOptimizationJobResponse { /** - *The name of the experiment run to associate with the trial component.
+ *The Amazon Resource Name (ARN) of the optimization job.
* @public */ - RunName?: string | undefined; + OptimizationJobArn: string | undefined; } /** + *Configuration settings for the SageMaker Partner AI App.
* @public - * @enum */ -export const DataDistributionType = { - FULLYREPLICATED: "FullyReplicated", - SHARDEDBYS3KEY: "ShardedByS3Key", -} as const; +export interface PartnerAppConfig { + /** + *The list of users that are given admin access to the SageMaker Partner AI App.
+ * @public + */ + AdminUsers?: string[] | undefined; -/** - * @public - */ -export type DataDistributionType = (typeof DataDistributionType)[keyof typeof DataDistributionType]; + /** + *This is a map of required inputs for a SageMaker Partner AI App. Based on the application type, the map is populated with a key and value pair that is specific to the user and application.
+ * @public + */ + Arguments?: RecordMaintenance configuration settings for the SageMaker Partner AI App.
* @public */ -export type RedshiftResultCompressionType = - (typeof RedshiftResultCompressionType)[keyof typeof RedshiftResultCompressionType]; +export interface PartnerAppMaintenanceConfig { + /** + *The day and time of the week in Coordinated Universal Time (UTC) 24-hour standard time that weekly maintenance updates are scheduled. This value must take the following format: 3-letter-day:24-h-hour:minute. For example: TUE:03:30.
Configuration for Redshift Dataset Definition input.
* @public */ -export interface RedshiftDatasetDefinition { +export interface CreatePartnerAppRequest { /** - *The Redshift cluster Identifier.
+ *The name to give the SageMaker Partner AI App.
* @public */ - ClusterId: string | undefined; + Name: string | undefined; /** - *The name of the Redshift database used in Redshift query execution.
+ *The type of SageMaker Partner AI App to create. Must be one of the following: lakera-guard, comet, deepchecks-llm-evaluation, or fiddler.
The database user name used in Redshift query execution.
+ *The ARN of the IAM role that the partner application uses.
* @public */ - DbUser: string | undefined; + ExecutionRoleArn: string | undefined; /** - *The SQL query statements to be executed.
+ *Maintenance configuration settings for the SageMaker Partner AI App.
* @public */ - QueryString: string | undefined; + MaintenanceConfig?: PartnerAppMaintenanceConfig | undefined; /** - *The IAM role attached to your Redshift cluster that Amazon SageMaker uses to generate datasets.
+ *Indicates the instance type and size of the cluster attached to the SageMaker Partner AI App.
* @public */ - ClusterRoleArn: string | undefined; + Tier: string | undefined; /** - *The location in Amazon S3 where the Redshift query results are stored.
+ *Configuration settings for the SageMaker Partner AI App.
* @public */ - OutputS3Uri: string | undefined; + ApplicationConfig?: PartnerAppConfig | undefined; /** - *The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data from a - * Redshift execution.
+ *The authorization type that users use to access the SageMaker Partner AI App.
* @public */ - KmsKeyId?: string | undefined; + AuthType: PartnerAppAuthType | undefined; /** - *The data storage format for Redshift query results.
+ *When set to TRUE, the SageMaker Partner AI App sets the Amazon Web Services IAM session name or the authenticated IAM user as the identity of the SageMaker Partner AI App user.
The compression used for Redshift query results.
+ *A unique token that guarantees that the call to this API is idempotent.
* @public */ - OutputCompression?: RedshiftResultCompressionType | undefined; + ClientToken?: string | undefined; + + /** + *Each tag consists of a key and an optional value. Tag keys must be unique per + * resource.
+ * @public + */ + Tags?: Tag[] | undefined; } /** - *Configuration for Dataset Definition inputs. The Dataset Definition input must specify
- * exactly one of either AthenaDatasetDefinition or RedshiftDatasetDefinition
- * types.
Configuration for Athena Dataset Definition input.
+ *The ARN of the SageMaker Partner AI App.
* @public */ - AthenaDatasetDefinition?: AthenaDatasetDefinition | undefined; + Arn?: string | undefined; +} +/** + * @public + */ +export interface CreatePartnerAppPresignedUrlRequest { /** - *Configuration for Redshift Dataset Definition input.
+ *The ARN of the SageMaker Partner AI App to create the presigned URL for.
* @public */ - RedshiftDatasetDefinition?: RedshiftDatasetDefinition | undefined; + Arn: string | undefined; /** - *The local path where you want Amazon SageMaker to download the Dataset Definition inputs to run a
- * processing job. LocalPath is an absolute path to the input data. This is a required
- * parameter when AppManaged is False (default).
The time that will pass before the presigned URL expires.
* @public */ - LocalPath?: string | undefined; + ExpiresInSeconds?: number | undefined; /** - *Whether the generated dataset is FullyReplicated or
- * ShardedByS3Key (default).
Indicates how long the Amazon SageMaker Partner AI App session can be accessed for after logging in.
* @public */ - DataDistributionType?: DataDistributionType | undefined; - - /** - *Whether to use File or Pipe input mode. In File (default) mode,
- * Amazon SageMaker copies the data from the input source onto the local Amazon Elastic Block Store
- * (Amazon EBS) volumes before starting your training algorithm. This is the most commonly used
- * input mode. In Pipe mode, Amazon SageMaker streams input data from the source directly to your
- * algorithm without using the EBS volume.
The presigned URL that you can use to access the SageMaker Partner AI App.
+ * @public + */ + Url?: string | undefined; +} /** + *Configuration that controls the parallelism of the pipeline. + * By default, the parallelism configuration specified applies to all + * executions of the pipeline unless overridden.
* @public */ -export type ProcessingS3CompressionType = - (typeof ProcessingS3CompressionType)[keyof typeof ProcessingS3CompressionType]; +export interface ParallelismConfiguration { + /** + *The max number of steps that can be executed in parallel.
+ * @public + */ + MaxParallelExecutionSteps: number | undefined; +} /** + *The location of the pipeline definition stored in Amazon S3.
* @public - * @enum */ -export const ProcessingS3DataType = { - MANIFEST_FILE: "ManifestFile", - S3_PREFIX: "S3Prefix", -} as const; +export interface PipelineDefinitionS3Location { + /** + *Name of the S3 bucket.
+ * @public + */ + Bucket: string | undefined; -/** - * @public - */ -export type ProcessingS3DataType = (typeof ProcessingS3DataType)[keyof typeof ProcessingS3DataType]; + /** + *The object key (or key name) uniquely identifies the + * object in an S3 bucket.
+ * @public + */ + ObjectKey: string | undefined; -/** - *Configuration for downloading input data from Amazon S3 into the processing container.
- * @public - */ -export interface ProcessingS3Input { /** - *The URI of the Amazon S3 prefix Amazon SageMaker downloads data required to run a processing job.
+ *Version Id of the pipeline definition file. If not specified, Amazon SageMaker + * will retrieve the latest version.
* @public */ - S3Uri: string | undefined; + VersionId?: string | undefined; +} +/** + * @public + */ +export interface CreatePipelineRequest { /** - *The local path in your container where you want Amazon SageMaker to write input data to.
- * LocalPath is an absolute path to the input data and must begin with
- * /opt/ml/processing/. LocalPath is a required
- * parameter when AppManaged is False (default).
The name of the pipeline.
* @public */ - LocalPath?: string | undefined; + PipelineName: string | undefined; /** - *Whether you use an S3Prefix or a ManifestFile for
- * the data type. If you choose S3Prefix, S3Uri identifies a key
- * name prefix. Amazon SageMaker uses all objects with the specified key name prefix for the processing
- * job. If you choose ManifestFile, S3Uri identifies an object
- * that is a manifest file containing a list of object keys that you want Amazon SageMaker to use for
- * the processing job.
The display name of the pipeline.
* @public */ - S3DataType: ProcessingS3DataType | undefined; + PipelineDisplayName?: string | undefined; /** - *Whether to use File or Pipe input mode. In File mode, Amazon SageMaker copies the data
- * from the input source onto the local ML storage volume before starting your processing
- * container. This is the most commonly used input mode. In Pipe mode, Amazon SageMaker
- * streams input data from the source directly to your processing container into named
- * pipes without using the ML storage volume.
The JSON + * pipeline definition of the pipeline.
* @public */ - S3InputMode?: ProcessingS3InputMode | undefined; + PipelineDefinition?: string | undefined; /** - *Whether to distribute the data from Amazon S3 to all processing instances with
- * FullyReplicated, or whether the data from Amazon S3 is shared by Amazon S3 key,
- * downloading one shard of data to each processing instance.
The location of the pipeline definition stored in Amazon S3. If specified, + * SageMaker will retrieve the pipeline definition from this location.
* @public */ - S3DataDistributionType?: ProcessingS3DataDistributionType | undefined; + PipelineDefinitionS3Location?: PipelineDefinitionS3Location | undefined; /** - *Whether to GZIP-decompress the data in Amazon S3 as it is streamed into the processing
- * container. Gzip can only be used when Pipe mode is
- * specified as the S3InputMode. In Pipe mode, Amazon SageMaker streams input
- * data from the source directly to your container without using the EBS volume.
A description of the pipeline.
* @public */ - S3CompressionType?: ProcessingS3CompressionType | undefined; -} + PipelineDescription?: string | undefined; -/** - *The inputs for a processing job. The processing input must specify exactly one of either
- * S3Input or DatasetDefinition types.
The name for the processing job input.
+ *A unique, case-sensitive identifier that you provide to ensure the idempotency of the + * operation. An idempotent operation completes no more than one time.
* @public */ - InputName: string | undefined; + ClientRequestToken?: string | undefined; /** - *When True, input operations such as data download are managed natively by the
- * processing job application. When False (default), input operations are managed by Amazon SageMaker.
The Amazon Resource Name (ARN) of the role used by the pipeline to access and create resources.
* @public */ - AppManaged?: boolean | undefined; + RoleArn: string | undefined; /** - *Configuration for downloading input data from Amazon S3 into the processing container.
+ *A list of tags to apply to the created pipeline.
* @public */ - S3Input?: ProcessingS3Input | undefined; + Tags?: Tag[] | undefined; /** - *Configuration for a Dataset Definition input.
+ *This is the configuration that controls the parallelism of the pipeline. + * If specified, it applies to all runs of this pipeline by default.
* @public */ - DatasetDefinition?: DatasetDefinition | undefined; + ParallelismConfiguration?: ParallelismConfiguration | undefined; } /** - *Configuration for processing job outputs in Amazon SageMaker Feature Store.
* @public */ -export interface ProcessingFeatureStoreOutput { +export interface CreatePipelineResponse { /** - *The name of the Amazon SageMaker FeatureGroup to use as the destination for processing job output. Note that your - * processing script is responsible for putting records into your Feature Store.
+ *The Amazon Resource Name (ARN) of the created pipeline.
* @public */ - FeatureGroupName: string | undefined; + PipelineArn?: string | undefined; } /** - *Configuration for uploading output data to Amazon S3 from the processing container.
* @public */ -export interface ProcessingS3Output { +export interface CreatePresignedDomainUrlRequest { /** - *A URI that identifies the Amazon S3 bucket where you want Amazon SageMaker to save the results of - * a processing job.
+ *The domain ID.
* @public */ - S3Uri: string | undefined; + DomainId: string | undefined; /** - *The local path of a directory where you want Amazon SageMaker to upload its contents to Amazon S3.
- * LocalPath is an absolute path to a directory containing output files.
- * This directory will be created by the platform and exist when your container's
- * entrypoint is invoked.
The name of the UserProfile to sign-in as.
* @public */ - LocalPath?: string | undefined; + UserProfileName: string | undefined; /** - *Whether to upload the results of the processing job continuously or after the job - * completes.
+ *The session expiration duration in seconds. This value defaults to 43200.
* @public */ - S3UploadMode: ProcessingS3UploadMode | undefined; -} + SessionExpirationDurationInSeconds?: number | undefined; -/** - *Describes the results of a processing job. The processing output must specify exactly one of
- * either S3Output or FeatureStoreOutput types.
The name for the processing job output.
+ *The number of seconds until the pre-signed URL expires. This value defaults to 300.
* @public */ - OutputName: string | undefined; + ExpiresInSeconds?: number | undefined; /** - *Configuration for processing job outputs in Amazon S3.
+ *The name of the space.
* @public */ - S3Output?: ProcessingS3Output | undefined; + SpaceName?: string | undefined; /** - *Configuration for processing job outputs in Amazon SageMaker Feature Store. This processing output
- * type is only supported when AppManaged is specified.
The landing page that the user is directed to when accessing the presigned URL. Using this + * value, users can access Studio or Studio Classic, even if it is not the default experience for + * the domain. The supported values are:
+ *
+ * studio::relative/path: Directs users to the relative path in
+ * Studio.
+ * app:JupyterServer:relative/path: Directs users to the relative path in
+ * the Studio Classic application.
+ * app:JupyterLab:relative/path: Directs users to the relative path in the
+ * JupyterLab application.
+ * app:RStudioServerPro:relative/path: Directs users to the relative path in
+ * the RStudio application.
+ * app:CodeEditor:relative/path: Directs users to the relative path in the
+ * Code Editor, based on Code-OSS, Visual Studio Code - Open Source application.
+ * app:Canvas:relative/path: Directs users to the relative path in the
+ * Canvas application.
When True, output operations such as data upload are managed natively by the
- * processing job application. When False (default), output operations are managed by
- * Amazon SageMaker.
The presigned URL.
* @public */ - AppManaged?: boolean | undefined; + AuthorizedUrl?: string | undefined; } /** - *Configuration for uploading output from the processing container.
* @public */ -export interface ProcessingOutputConfig { +export interface CreatePresignedMlflowTrackingServerUrlRequest { /** - *An array of outputs configuring the data to upload from the processing container.
+ *The name of the tracking server to connect to your MLflow UI.
* @public */ - Outputs: ProcessingOutput[] | undefined; + TrackingServerName: string | undefined; /** - *The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt the processing
- * job output. KmsKeyId can be an ID of a KMS key, ARN of a KMS key, alias of
- * a KMS key, or alias of a KMS key. The KmsKeyId is applied to all
- * outputs.
The duration in seconds that your presigned URL is valid. The presigned URL can be used + * only once.
* @public */ - KmsKeyId?: string | undefined; + ExpiresInSeconds?: number | undefined; + + /** + *The duration in seconds that your MLflow UI session is valid.
+ * @public + */ + SessionExpirationDurationInSeconds?: number | undefined; } /** - *Configuration for the cluster used to run a processing job.
* @public */ -export interface ProcessingClusterConfig { +export interface CreatePresignedMlflowTrackingServerUrlResponse { /** - *The number of ML compute instances to use in the processing job. For distributed - * processing jobs, specify a value greater than 1. The default value is 1.
+ *A presigned URL with an authorization token.
* @public */ - InstanceCount: number | undefined; - - /** - *The ML compute instance type for the processing job.
- * @public - */ - InstanceType: ProcessingInstanceType | undefined; + AuthorizedUrl?: string | undefined; +} +/** + * @public + */ +export interface CreatePresignedNotebookInstanceUrlInput { /** - *The size of the ML storage volume in gigabytes that you want to provision. You must - * specify sufficient ML storage for your scenario.
- *Certain Nitro-based instances include local storage with a fixed total size,
- * dependent on the instance type. When using these instances for processing, Amazon SageMaker mounts
- * the local instance storage instead of Amazon EBS gp2 storage. You can't request a
- * VolumeSizeInGB greater than the total size of the local instance
- * storage.
For a list of instance types that support local instance storage, including the - * total size per instance type, see Instance Store Volumes.
- *The name of the notebook instance.
* @public */ - VolumeSizeInGB: number | undefined; + NotebookInstanceName: string | undefined; /** - *The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the - * storage volume attached to the ML compute instance(s) that run the processing job. - *
- *Certain Nitro-based instances include local storage, dependent on the instance
- * type. Local storage volumes are encrypted using a hardware module on the instance.
- * You can't request a VolumeKmsKeyId when using an instance type with
- * local storage.
For a list of instance types that support local instance storage, see Instance Store Volumes.
- *For more information about local instance storage encryption, see SSD - * Instance Store Volumes.
- *The duration of the session, in seconds. The default is 12 hours.
* @public */ - VolumeKmsKeyId?: string | undefined; + SessionExpirationDurationInSeconds?: number | undefined; } /** - *Identifies the resources, ML compute instances, and ML storage volumes to deploy for a - * processing job. In distributed training, you specify more than one instance.
* @public */ -export interface ProcessingResources { +export interface CreatePresignedNotebookInstanceUrlOutput { /** - *The configuration for the resources in a cluster used to run the processing - * job.
+ *A JSON object that contains the URL string.
* @public */ - ClusterConfig: ProcessingClusterConfig | undefined; + AuthorizedUrl?: string | undefined; } /** - *Configures conditions under which the processing job should be stopped, such as how long - * the processing job has been running. After the condition is met, the processing job is stopped.
+ *Associates a SageMaker job as a trial component with an experiment and trial. Specified when + * you call the following APIs:
+ *+ * CreateProcessingJob + *
+ *+ * CreateTrainingJob + *
+ *+ * CreateTransformJob + *
+ *Specifies the maximum runtime in seconds.
+ *The name of an existing experiment to associate with the trial component.
* @public */ - MaxRuntimeInSeconds: number | undefined; -} + ExperimentName?: string | undefined; -/** - * @public - */ -export interface CreateProcessingJobRequest { /** - *An array of inputs configuring the data to download into the - * processing container.
+ *The name of an existing trial to associate the trial component with. If not specified, a + * new trial is created.
* @public */ - ProcessingInputs?: ProcessingInput[] | undefined; + TrialName?: string | undefined; /** - *Output configuration for the processing job.
+ *The display name for the trial component. If this key isn't specified, the display name is + * the trial component name.
* @public */ - ProcessingOutputConfig?: ProcessingOutputConfig | undefined; + TrialComponentDisplayName?: string | undefined; /** - *The name of the processing job. The name must be unique within an Amazon Web Services Region in the - * Amazon Web Services account.
+ *The name of the experiment run to associate with the trial component.
* @public */ - ProcessingJobName: string | undefined; + RunName?: string | undefined; +} + +/** + * @public + * @enum + */ +export const DataDistributionType = { + FULLYREPLICATED: "FullyReplicated", + SHARDEDBYS3KEY: "ShardedByS3Key", +} as const; + +/** + * @public + */ +export type DataDistributionType = (typeof DataDistributionType)[keyof typeof DataDistributionType]; + +/** + * @public + * @enum + */ +export const InputMode = { + FILE: "File", + PIPE: "Pipe", +} as const; + +/** + * @public + */ +export type InputMode = (typeof InputMode)[keyof typeof InputMode]; +/** + * @public + * @enum + */ +export const RedshiftResultCompressionType = { + BZIP2: "BZIP2", + GZIP: "GZIP", + NONE: "None", + SNAPPY: "SNAPPY", + ZSTD: "ZSTD", +} as const; + +/** + * @public + */ +export type RedshiftResultCompressionType = + (typeof RedshiftResultCompressionType)[keyof typeof RedshiftResultCompressionType]; + +/** + * @public + * @enum + */ +export const RedshiftResultFormat = { + CSV: "CSV", + PARQUET: "PARQUET", +} as const; + +/** + * @public + */ +export type RedshiftResultFormat = (typeof RedshiftResultFormat)[keyof typeof RedshiftResultFormat]; + +/** + *Configuration for Redshift Dataset Definition input.
+ * @public + */ +export interface RedshiftDatasetDefinition { /** - *Identifies the resources, ML compute instances, and ML storage volumes to deploy for a - * processing job. In distributed training, you specify more than one instance.
+ *The Redshift cluster Identifier.
* @public */ - ProcessingResources: ProcessingResources | undefined; + ClusterId: string | undefined; /** - *The time limit for how long the processing job is allowed to run.
+ *The name of the Redshift database used in Redshift query execution.
* @public */ - StoppingCondition?: ProcessingStoppingCondition | undefined; + Database: string | undefined; /** - *Configures the processing job to run a specified Docker container image.
+ *The database user name used in Redshift query execution.
* @public */ - AppSpecification: AppSpecification | undefined; + DbUser: string | undefined; /** - *The environment variables to set in the Docker container. Up to - * 100 key and values entries in the map are supported.
+ *The SQL query statements to be executed.
* @public */ - Environment?: RecordNetworking options for a processing job, such as whether to allow inbound and - * outbound network calls to and from processing containers, and the VPC subnets and - * security groups to use for VPC-enabled processing jobs.
+ *The IAM role attached to your Redshift cluster that Amazon SageMaker uses to generate datasets.
* @public */ - NetworkConfig?: NetworkConfig | undefined; + ClusterRoleArn: string | undefined; /** - *The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on - * your behalf.
+ *The location in Amazon S3 where the Redshift query results are stored.
* @public */ - RoleArn: string | undefined; + OutputS3Uri: string | undefined; /** - *(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management - * User Guide.
+ *The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data from a + * Redshift execution.
* @public */ - Tags?: Tag[] | undefined; + KmsKeyId?: string | undefined; /** - *Associates a SageMaker job as a trial component with an experiment and trial. Specified when - * you call the following APIs:
- *- * CreateProcessingJob - *
- *- * CreateTrainingJob - *
- *- * CreateTransformJob - *
- *The data storage format for Redshift query results.
* @public */ - ExperimentConfig?: ExperimentConfig | undefined; -} + OutputFormat: RedshiftResultFormat | undefined; -/** - * @public - */ -export interface CreateProcessingJobResponse { /** - *The Amazon Resource Name (ARN) of the processing job.
+ *The compression used for Redshift query results.
* @public */ - ProcessingJobArn: string | undefined; + OutputCompression?: RedshiftResultCompressionType | undefined; } /** - *A key value pair used when you provision a project as a service catalog product. For - * information, see What is Amazon Web Services Service - * Catalog.
+ *Configuration for Dataset Definition inputs. The Dataset Definition input must specify
+ * exactly one of either AthenaDatasetDefinition or RedshiftDatasetDefinition
+ * types.
The key that identifies a provisioning parameter.
+ *Configuration for Athena Dataset Definition input.
* @public */ - Key?: string | undefined; + AthenaDatasetDefinition?: AthenaDatasetDefinition | undefined; /** - *The value of the provisioning parameter.
+ *Configuration for Redshift Dataset Definition input.
* @public */ - Value?: string | undefined; -} + RedshiftDatasetDefinition?: RedshiftDatasetDefinition | undefined; -/** - *Details that you specify to provision a service catalog product. For information about - * service catalog, see What is Amazon Web Services Service - * Catalog.
- * @public - */ -export interface ServiceCatalogProvisioningDetails { /** - *The ID of the product to provision.
- * @public - */ - ProductId: string | undefined; - - /** - *The ID of the provisioning artifact.
+ *The local path where you want Amazon SageMaker to download the Dataset Definition inputs to run a
+ * processing job. LocalPath is an absolute path to the input data. This is a required
+ * parameter when AppManaged is False (default).
The path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path.
+ *Whether the generated dataset is FullyReplicated or
+ * ShardedByS3Key (default).
A list of key value pairs that you specify when you provision a product.
+ *Whether to use File or Pipe input mode. In File (default) mode,
+ * Amazon SageMaker copies the data from the input source onto the local Amazon Elastic Block Store
+ * (Amazon EBS) volumes before starting your training algorithm. This is the most commonly used
+ * input mode. In Pipe mode, Amazon SageMaker streams input data from the source directly to your
+ * algorithm without using the EBS volume.
The name of the project.
- * @public - */ - ProjectName: string | undefined; +export const ProcessingS3CompressionType = { + GZIP: "Gzip", + NONE: "None", +} as const; + +/** + * @public + */ +export type ProcessingS3CompressionType = + (typeof ProcessingS3CompressionType)[keyof typeof ProcessingS3CompressionType]; + +/** + * @public + * @enum + */ +export const ProcessingS3DataType = { + MANIFEST_FILE: "ManifestFile", + S3_PREFIX: "S3Prefix", +} as const; + +/** + * @public + */ +export type ProcessingS3DataType = (typeof ProcessingS3DataType)[keyof typeof ProcessingS3DataType]; +/** + *Configuration for downloading input data from Amazon S3 into the processing container.
+ * @public + */ +export interface ProcessingS3Input { /** - *A description for the project.
+ *The URI of the Amazon S3 prefix Amazon SageMaker downloads data required to run a processing job.
* @public */ - ProjectDescription?: string | undefined; + S3Uri: string | undefined; /** - *The product ID and provisioning artifact ID to provision a service catalog. The provisioning - * artifact ID will default to the latest provisioning artifact ID of the product, if you don't - * provide the provisioning artifact ID. For more information, see What is Amazon Web Services Service - * Catalog.
+ *The local path in your container where you want Amazon SageMaker to write input data to.
+ * LocalPath is an absolute path to the input data and must begin with
+ * /opt/ml/processing/. LocalPath is a required
+ * parameter when AppManaged is False (default).
An array of key-value pairs that you want to use to organize and track your Amazon Web Services - * resource costs. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.
+ *Whether you use an S3Prefix or a ManifestFile for
+ * the data type. If you choose S3Prefix, S3Uri identifies a key
+ * name prefix. Amazon SageMaker uses all objects with the specified key name prefix for the processing
+ * job. If you choose ManifestFile, S3Uri identifies an object
+ * that is a manifest file containing a list of object keys that you want Amazon SageMaker to use for
+ * the processing job.
The Amazon Resource Name (ARN) of the project.
+ *Whether to use File or Pipe input mode. In File mode, Amazon SageMaker copies the data
+ * from the input source onto the local ML storage volume before starting your processing
+ * container. This is the most commonly used input mode. In Pipe mode, Amazon SageMaker
+ * streams input data from the source directly to your processing container into named
+ * pipes without using the ML storage volume.
The ID of the new project.
+ *Whether to distribute the data from Amazon S3 to all processing instances with
+ * FullyReplicated, or whether the data from Amazon S3 is shared by Amazon S3 key,
+ * downloading one shard of data to each processing instance.
The collection of ownership settings for a space.
- * @public - */ -export interface OwnershipSettings { /** - *The user profile who is the owner of the space.
+ *Whether to GZIP-decompress the data in Amazon S3 as it is streamed into the processing
+ * container. Gzip can only be used when Pipe mode is
+ * specified as the S3InputMode. In Pipe mode, Amazon SageMaker streams input
+ * data from the source directly to your container without using the EBS volume.
Settings related to idle shutdown of Studio applications in a space.
+ *The inputs for a processing job. The processing input must specify exactly one of either
+ * S3Input or DatasetDefinition types.
The time that SageMaker waits after the application becomes idle before shutting it - * down.
+ *The name for the processing job input.
* @public */ - IdleTimeoutInMinutes?: number | undefined; -} + InputName: string | undefined; -/** - *Settings that are used to configure and manage the lifecycle of Amazon SageMaker Studio - * applications in a space.
- * @public - */ -export interface SpaceAppLifecycleManagement { /** - *Settings related to idle shutdown of Studio applications.
+ *When True, input operations such as data download are managed natively by the
+ * processing job application. When False (default), input operations are managed by Amazon SageMaker.
The application settings for a Code Editor space.
- * @public - */ -export interface SpaceCodeEditorAppSettings { /** - *Specifies the ARN's of a SageMaker image and SageMaker image version, and the instance type that - * the version runs on.
+ *Configuration for downloading input data from Amazon S3 into the processing container.
* @public */ - DefaultResourceSpec?: ResourceSpec | undefined; + S3Input?: ProcessingS3Input | undefined; /** - *Settings that are used to configure and manage the lifecycle of CodeEditor applications in - * a space.
+ *Configuration for a Dataset Definition input.
* @public */ - AppLifecycleManagement?: SpaceAppLifecycleManagement | undefined; + DatasetDefinition?: DatasetDefinition | undefined; } /** - *A file system, created by you in Amazon EFS, that you assign to a user profile or - * space for an Amazon SageMaker Domain. Permitted users can access this file system in - * Amazon SageMaker Studio.
+ *Configuration for processing job outputs in Amazon SageMaker Feature Store.
* @public */ -export interface EFSFileSystem { +export interface ProcessingFeatureStoreOutput { /** - *The ID of your Amazon EFS file system.
+ *The name of the Amazon SageMaker FeatureGroup to use as the destination for processing job output. Note that your + * processing script is responsible for putting records into your Feature Store.
* @public */ - FileSystemId: string | undefined; + FeatureGroupName: string | undefined; } /** - *A file system, created by you, that you assign to a user profile or space for an Amazon SageMaker Domain. Permitted users can access this file system in Amazon SageMaker - * Studio.
- * @public - */ -export type CustomFileSystem = CustomFileSystem.EFSFileSystemMember | CustomFileSystem.$UnknownMember; - -/** + *Configuration for uploading output data to Amazon S3 from the processing container.
* @public */ -export namespace CustomFileSystem { +export interface ProcessingS3Output { /** - *A custom file system in Amazon EFS.
+ *A URI that identifies the Amazon S3 bucket where you want Amazon SageMaker to save the results of + * a processing job.
* @public */ - export interface EFSFileSystemMember { - EFSFileSystem: EFSFileSystem; - $unknown?: never; - } + S3Uri: string | undefined; /** + *The local path of a directory where you want Amazon SageMaker to upload its contents to Amazon S3.
+ * LocalPath is an absolute path to a directory containing output files.
+ * This directory will be created by the platform and exist when your container's
+ * entrypoint is invoked.
Whether to upload the results of the processing job continuously or after the job + * completes.
+ * @public + */ + S3UploadMode: ProcessingS3UploadMode | undefined; } /** - *The settings for the JupyterLab application within a space.
+ *Describes the results of a processing job. The processing output must specify exactly one of
+ * either S3Output or FeatureStoreOutput types.
Specifies the ARN's of a SageMaker image and SageMaker image version, and the instance type that - * the version runs on.
+ *The name for the processing job output.
* @public */ - DefaultResourceSpec?: ResourceSpec | undefined; + OutputName: string | undefined; /** - *A list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterLab application.
+ *Configuration for processing job outputs in Amazon S3.
* @public */ - CodeRepositories?: CodeRepository[] | undefined; + S3Output?: ProcessingS3Output | undefined; /** - *Settings that are used to configure and manage the lifecycle of JupyterLab applications in - * a space.
+ *Configuration for processing job outputs in Amazon SageMaker Feature Store. This processing output
+ * type is only supported when AppManaged is specified.
A collection of EBS storage settings that apply to both private and shared spaces.
- * @public - */ -export interface EbsStorageSettings { /** - *The size of an EBS storage volume for a space.
+ *When True, output operations such as data upload are managed natively by the
+ * processing job application. When False (default), output operations are managed by
+ * Amazon SageMaker.
The storage settings for a space.
+ *Configuration for uploading output from the processing container.
* @public */ -export interface SpaceStorageSettings { +export interface ProcessingOutputConfig { /** - *A collection of EBS storage settings for a space.
+ *An array of outputs configuring the data to upload from the processing container.
* @public */ - EbsStorageSettings?: EbsStorageSettings | undefined; + Outputs: ProcessingOutput[] | undefined; + + /** + *The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt the processing
+ * job output. KmsKeyId can be an ID of a KMS key, ARN of a KMS key, alias of
+ * a KMS key, or alias of a KMS key. The KmsKeyId is applied to all
+ * outputs.
A collection of space settings.
+ *Configuration for the cluster used to run a processing job.
* @public */ -export interface SpaceSettings { - /** - *The JupyterServer app settings.
- * @public - */ - JupyterServerAppSettings?: JupyterServerAppSettings | undefined; - - /** - *The KernelGateway app settings.
- * @public - */ - KernelGatewayAppSettings?: KernelGatewayAppSettings | undefined; - - /** - *The Code Editor application settings.
- * @public - */ - CodeEditorAppSettings?: SpaceCodeEditorAppSettings | undefined; - +export interface ProcessingClusterConfig { /** - *The settings for the JupyterLab application.
+ *The number of ML compute instances to use in the processing job. For distributed + * processing jobs, specify a value greater than 1. The default value is 1.
* @public */ - JupyterLabAppSettings?: SpaceJupyterLabAppSettings | undefined; + InstanceCount: number | undefined; /** - *The type of app created within the space.
+ *The ML compute instance type for the processing job.
* @public */ - AppType?: AppType | undefined; + InstanceType: ProcessingInstanceType | undefined; /** - *The storage settings for a space.
+ *The size of the ML storage volume in gigabytes that you want to provision. You must + * specify sufficient ML storage for your scenario.
+ *Certain Nitro-based instances include local storage with a fixed total size,
+ * dependent on the instance type. When using these instances for processing, Amazon SageMaker mounts
+ * the local instance storage instead of Amazon EBS gp2 storage. You can't request a
+ * VolumeSizeInGB greater than the total size of the local instance
+ * storage.
For a list of instance types that support local instance storage, including the + * total size per instance type, see Instance Store Volumes.
+ *A file system, created by you, that you assign to a space for an Amazon SageMaker - * Domain. Permitted users can access this file system in Amazon SageMaker Studio.
+ *The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the + * storage volume attached to the ML compute instance(s) that run the processing job. + *
+ *Certain Nitro-based instances include local storage, dependent on the instance
+ * type. Local storage volumes are encrypted using a hardware module on the instance.
+ * You can't request a VolumeKmsKeyId when using an instance type with
+ * local storage.
For a list of instance types that support local instance storage, see Instance Store Volumes.
+ *For more information about local instance storage encryption, see SSD + * Instance Store Volumes.
+ *Identifies the resources, ML compute instances, and ML storage volumes to deploy for a + * processing job. In distributed training, you specify more than one instance.
* @public */ -export type SharingType = (typeof SharingType)[keyof typeof SharingType]; +export interface ProcessingResources { + /** + *The configuration for the resources in a cluster used to run the processing + * job.
+ * @public + */ + ClusterConfig: ProcessingClusterConfig | undefined; +} /** - *A collection of space sharing settings.
+ *Configures conditions under which the processing job should be stopped, such as how long + * the processing job has been running. After the condition is met, the processing job is stopped.
* @public */ -export interface SpaceSharingSettings { +export interface ProcessingStoppingCondition { /** - *Specifies the sharing type of the space.
+ *Specifies the maximum runtime in seconds.
* @public */ - SharingType: SharingType | undefined; + MaxRuntimeInSeconds: number | undefined; } /** * @public */ -export interface CreateSpaceRequest { +export interface CreateProcessingJobRequest { /** - *The ID of the associated domain.
+ *An array of inputs configuring the data to download into the + * processing container.
* @public */ - DomainId: string | undefined; + ProcessingInputs?: ProcessingInput[] | undefined; /** - *The name of the space.
+ *Output configuration for the processing job.
* @public */ - SpaceName: string | undefined; + ProcessingOutputConfig?: ProcessingOutputConfig | undefined; /** - *Tags to associated with the space. Each tag consists of a key and an optional value. Tag
- * keys must be unique for each resource. Tags are searchable using the Search
- * API.
The name of the processing job. The name must be unique within an Amazon Web Services Region in the + * Amazon Web Services account.
* @public */ - Tags?: Tag[] | undefined; + ProcessingJobName: string | undefined; /** - *A collection of space settings.
+ *Identifies the resources, ML compute instances, and ML storage volumes to deploy for a + * processing job. In distributed training, you specify more than one instance.
* @public */ - SpaceSettings?: SpaceSettings | undefined; + ProcessingResources: ProcessingResources | undefined; /** - *A collection of ownership settings.
+ *The time limit for how long the processing job is allowed to run.
* @public */ - OwnershipSettings?: OwnershipSettings | undefined; + StoppingCondition?: ProcessingStoppingCondition | undefined; /** - *A collection of space sharing settings.
+ *Configures the processing job to run a specified Docker container image.
* @public */ - SpaceSharingSettings?: SpaceSharingSettings | undefined; + AppSpecification: AppSpecification | undefined; /** - *The name of the space that appears in the SageMaker Studio UI.
+ *The environment variables to set in the Docker container. Up to + * 100 key and values entries in the map are supported.
* @public */ - SpaceDisplayName?: string | undefined; -} + Environment?: RecordThe space's Amazon Resource Name (ARN).
+ *Networking options for a processing job, such as whether to allow inbound and + * outbound network calls to and from processing containers, and the VPC subnets and + * security groups to use for VPC-enabled processing jobs.
* @public */ - SpaceArn?: string | undefined; -} - -/** - * @public - * @enum - */ -export const StudioLifecycleConfigAppType = { - CodeEditor: "CodeEditor", - JupyterLab: "JupyterLab", - JupyterServer: "JupyterServer", - KernelGateway: "KernelGateway", -} as const; - -/** - * @public - */ -export type StudioLifecycleConfigAppType = - (typeof StudioLifecycleConfigAppType)[keyof typeof StudioLifecycleConfigAppType]; + NetworkConfig?: NetworkConfig | undefined; -/** - * @public - */ -export interface CreateStudioLifecycleConfigRequest { /** - *The name of the Amazon SageMaker Studio Lifecycle Configuration to create.
+ *The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on + * your behalf.
* @public */ - StudioLifecycleConfigName: string | undefined; + RoleArn: string | undefined; /** - *The content of your Amazon SageMaker Studio Lifecycle Configuration script. This - * content must be base64 encoded.
+ *(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management + * User Guide.
* @public */ - StudioLifecycleConfigContent: string | undefined; + Tags?: Tag[] | undefined; /** - *The App type that the Lifecycle Configuration is attached to.
+ *Associates a SageMaker job as a trial component with an experiment and trial. Specified when + * you call the following APIs:
+ *+ * CreateProcessingJob + *
+ *+ * CreateTrainingJob + *
+ *+ * CreateTransformJob + *
+ *Tags to be associated with the Lifecycle Configuration. Each tag consists of a key and an - * optional value. Tag keys must be unique per resource. Tags are searchable using the Search - * API.
+ *The Amazon Resource Name (ARN) of the processing job.
* @public */ - Tags?: Tag[] | undefined; + ProcessingJobArn: string | undefined; } /** + *A key value pair used when you provision a project as a service catalog product. For + * information, see What is Amazon Web Services Service + * Catalog.
* @public */ -export interface CreateStudioLifecycleConfigResponse { +export interface ProvisioningParameter { /** - *The ARN of your created Lifecycle Configuration.
+ *The key that identifies a provisioning parameter.
* @public */ - StudioLifecycleConfigArn?: string | undefined; + Key?: string | undefined; + + /** + *The value of the provisioning parameter.
+ * @public + */ + Value?: string | undefined; } /** - *Configuration information for the Amazon SageMaker Debugger hook parameters, metric and tensor collections, and
- * storage paths. To learn more about
- * how to configure the DebugHookConfig parameter,
- * see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.
Details that you specify to provision a service catalog product. For information about + * service catalog, see What is Amazon Web Services Service + * Catalog.
* @public */ -export interface DebugHookConfig { +export interface ServiceCatalogProvisioningDetails { /** - *Path to local storage location for metrics and tensors. Defaults to
- * /opt/ml/output/tensors/.
The ID of the product to provision.
* @public */ - LocalPath?: string | undefined; + ProductId: string | undefined; /** - *Path to Amazon S3 storage location for metrics and tensors.
+ *The ID of the provisioning artifact.
* @public */ - S3OutputPath: string | undefined; + ProvisioningArtifactId?: string | undefined; /** - *Configuration information for the Amazon SageMaker Debugger hook parameters.
+ *The path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path.
* @public */ - HookParameters?: RecordConfiguration information for Amazon SageMaker Debugger tensor collections. To learn more about
- * how to configure the CollectionConfiguration parameter,
- * see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.
- *
A list of key value pairs that you specify when you provision a product.
* @public */ - CollectionConfigurations?: CollectionConfiguration[] | undefined; + ProvisioningParameters?: ProvisioningParameter[] | undefined; } /** - *Configuration information for SageMaker Debugger rules for debugging. To learn more about
- * how to configure the DebugRuleConfiguration parameter,
- * see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.
The name of the rule configuration. It must be unique relative to other rule - * configuration names.
+ *The name of the project.
* @public */ - RuleConfigurationName: string | undefined; + ProjectName: string | undefined; /** - *Path to local storage location for output of rules. Defaults to
- * /opt/ml/processing/output/rule/.
A description for the project.
* @public */ - LocalPath?: string | undefined; + ProjectDescription?: string | undefined; /** - *Path to Amazon S3 storage location for rules.
+ *The product ID and provisioning artifact ID to provision a service catalog. The provisioning + * artifact ID will default to the latest provisioning artifact ID of the product, if you don't + * provide the provisioning artifact ID. For more information, see What is Amazon Web Services Service + * Catalog.
* @public */ - S3OutputPath?: string | undefined; + ServiceCatalogProvisioningDetails: ServiceCatalogProvisioningDetails | undefined; /** - *The Amazon Elastic Container (ECR) Image for the managed rule evaluation.
+ *An array of key-value pairs that you want to use to organize and track your Amazon Web Services + * resource costs. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.
* @public */ - RuleEvaluatorImage: string | undefined; + Tags?: Tag[] | undefined; +} +/** + * @public + */ +export interface CreateProjectOutput { /** - *The instance type to deploy a custom rule for debugging a training job.
+ *The Amazon Resource Name (ARN) of the project.
* @public */ - InstanceType?: ProcessingInstanceType | undefined; + ProjectArn: string | undefined; /** - *The size, in GB, of the ML storage volume attached to the processing instance.
+ *The ID of the new project.
* @public */ - VolumeSizeInGB?: number | undefined; + ProjectId: string | undefined; +} +/** + *The collection of ownership settings for a space.
+ * @public + */ +export interface OwnershipSettings { /** - *Runtime configuration for rule container.
+ *The user profile who is the owner of the space.
* @public */ - RuleParameters?: RecordConfiguration information for the infrastructure health check of a training job. A SageMaker-provided health check tests the health of instance hardware and cluster network - * connectivity.
+ *Settings related to idle shutdown of Studio applications in a space.
* @public */ -export interface InfraCheckConfig { +export interface SpaceIdleSettings { /** - *Enables an infrastructure health check.
+ *The time that SageMaker waits after the application becomes idle before shutting it + * down.
* @public */ - EnableInfraCheck?: boolean | undefined; + IdleTimeoutInMinutes?: number | undefined; } /** - *Configuration information for Amazon SageMaker Debugger system monitoring, framework profiling, and - * storage paths.
+ *Settings that are used to configure and manage the lifecycle of Amazon SageMaker Studio + * applications in a space.
* @public */ -export interface ProfilerConfig { +export interface SpaceAppLifecycleManagement { /** - *Path to Amazon S3 storage location for system and framework metrics.
+ *Settings related to idle shutdown of Studio applications.
* @public */ - S3OutputPath?: string | undefined; + IdleSettings?: SpaceIdleSettings | undefined; +} +/** + *The application settings for a Code Editor space.
+ * @public + */ +export interface SpaceCodeEditorAppSettings { /** - *A time interval for capturing system metrics in milliseconds. Available values are - * 100, 200, 500, 1000 (1 second), 5000 (5 seconds), and 60000 (1 minute) milliseconds. The default value is 500 milliseconds.
+ *Specifies the ARN's of a SageMaker image and SageMaker image version, and the instance type that + * the version runs on.
* @public */ - ProfilingIntervalInMilliseconds?: number | undefined; + DefaultResourceSpec?: ResourceSpec | undefined; /** - *Configuration information for capturing framework metrics. Available key strings for different profiling options are
- * DetailedProfilingConfig, PythonProfilingConfig, and DataLoaderProfilingConfig.
- * The following codes are configuration structures for the ProfilingParameters parameter. To learn more about
- * how to configure the ProfilingParameters parameter,
- * see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.
- *
Settings that are used to configure and manage the lifecycle of CodeEditor applications in + * a space.
* @public */ - ProfilingParameters?: RecordA file system, created by you in Amazon EFS, that you assign to a user profile or + * space for an Amazon SageMaker Domain. Permitted users can access this file system in + * Amazon SageMaker Studio.
+ * @public + */ +export interface EFSFileSystem { /** - *Configuration to turn off Amazon SageMaker Debugger's system monitoring and profiling functionality. To turn it off, set to True.
The ID of your Amazon EFS file system.
* @public */ - DisableProfiler?: boolean | undefined; + FileSystemId: string | undefined; } /** - *Configuration information for profiling rules.
+ *A custom file system in Amazon FSx for Lustre.
* @public */ -export interface ProfilerRuleConfiguration { +export interface FSxLustreFileSystem { /** - *The name of the rule configuration. It must be unique relative to other rule configuration names.
+ *Amazon FSx for Lustre file system ID.
* @public */ - RuleConfigurationName: string | undefined; + FileSystemId: string | undefined; +} + +/** + *A file system, created by you, that you assign to a user profile or space for an Amazon SageMaker Domain. Permitted users can access this file system in Amazon SageMaker + * Studio.
+ * @public + */ +export type CustomFileSystem = + | CustomFileSystem.EFSFileSystemMember + | CustomFileSystem.FSxLustreFileSystemMember + | CustomFileSystem.$UnknownMember; +/** + * @public + */ +export namespace CustomFileSystem { /** - *Path to local storage location for output of rules. Defaults to /opt/ml/processing/output/rule/.
A custom file system in Amazon EFS.
* @public */ - LocalPath?: string | undefined; + export interface EFSFileSystemMember { + EFSFileSystem: EFSFileSystem; + FSxLustreFileSystem?: never; + $unknown?: never; + } /** - *Path to Amazon S3 storage location for rules.
+ *A custom file system in Amazon FSx for Lustre.
* @public */ - S3OutputPath?: string | undefined; + export interface FSxLustreFileSystemMember { + EFSFileSystem?: never; + FSxLustreFileSystem: FSxLustreFileSystem; + $unknown?: never; + } /** - *The Amazon Elastic Container Registry Image for the managed rule evaluation.
* @public */ - RuleEvaluatorImage: string | undefined; + export interface $UnknownMember { + EFSFileSystem?: never; + FSxLustreFileSystem?: never; + $unknown: [string, any]; + } + export interface VisitorThe settings for the JupyterLab application within a space.
+ * @public + */ +export interface SpaceJupyterLabAppSettings { /** - *The instance type to deploy a custom rule for profiling a training job.
+ *Specifies the ARN's of a SageMaker image and SageMaker image version, and the instance type that + * the version runs on.
* @public */ - InstanceType?: ProcessingInstanceType | undefined; + DefaultResourceSpec?: ResourceSpec | undefined; /** - *The size, in GB, of the ML storage volume attached to the processing instance.
+ *A list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterLab application.
* @public */ - VolumeSizeInGB?: number | undefined; + CodeRepositories?: CodeRepository[] | undefined; /** - *Runtime configuration for rule container.
+ *Settings that are used to configure and manage the lifecycle of JupyterLab applications in + * a space.
* @public */ - RuleParameters?: RecordConfiguration for remote debugging for the CreateTrainingJob API. To learn more about the remote debugging - * functionality of SageMaker, see Access a training container - * through Amazon Web Services Systems Manager (SSM) for remote - * debugging.
+ *A collection of EBS storage settings that apply to both private and shared spaces.
* @public */ -export interface RemoteDebugConfig { +export interface EbsStorageSettings { /** - *If set to True, enables remote debugging.
+ *The size of an EBS storage volume for a space.
* @public */ - EnableRemoteDebug?: boolean | undefined; + EbsVolumeSizeInGb: number | undefined; } /** - *Contains information about attribute-based access control (ABAC) for a training job. - * The session chaining configuration uses Amazon Security Token Service (STS) for your training job to - * request temporary, limited-privilege credentials to tenants. For more information, see - * Attribute-based access control (ABAC) for multi-tenancy training.
+ *The storage settings for a space.
* @public */ -export interface SessionChainingConfig { +export interface SpaceStorageSettings { /** - *Set to True to allow SageMaker to extract session tags from a training job
- * creation role and reuse these tags when assuming the training job execution role.
A collection of EBS storage settings for a space.
* @public */ - EnableSessionTagChaining?: boolean | undefined; + EbsStorageSettings?: EbsStorageSettings | undefined; } /** - *Configuration of storage locations for the Amazon SageMaker Debugger TensorBoard output data.
+ *A collection of space settings.
* @public */ -export interface TensorBoardOutputConfig { +export interface SpaceSettings { /** - *Path to local storage location for tensorBoard output. Defaults to
- * /opt/ml/output/tensorboard.
The JupyterServer app settings.
* @public */ - LocalPath?: string | undefined; + JupyterServerAppSettings?: JupyterServerAppSettings | undefined; /** - *Path to Amazon S3 storage location for TensorBoard output.
+ *The KernelGateway app settings.
* @public */ - S3OutputPath: string | undefined; -} + KernelGatewayAppSettings?: KernelGatewayAppSettings | undefined; -/** - * @public - */ -export interface CreateTrainingJobRequest { /** - *The name of the training job. The name must be unique within an Amazon Web Services - * Region in an Amazon Web Services account.
+ *The Code Editor application settings.
* @public */ - TrainingJobName: string | undefined; + CodeEditorAppSettings?: SpaceCodeEditorAppSettings | undefined; /** - *Algorithm-specific parameters that influence the quality of the model. You set - * hyperparameters before you start the learning process. For a list of hyperparameters for - * each training algorithm provided by SageMaker, see Algorithms.
- *You can specify a maximum of 100 hyperparameters. Each hyperparameter is a
- * key-value pair. Each key and value is limited to 256 characters, as specified by the
- * Length Constraint.
Do not include any security-sensitive information including account access IDs, - * secrets or tokens in any hyperparameter field. If the use of security-sensitive - * credentials are detected, SageMaker will reject your training job request and return an - * exception error.
- *The settings for the JupyterLab application.
* @public */ - HyperParameters?: RecordThe registry path of the Docker image that contains the training algorithm and - * algorithm-specific metadata, including the input mode. For more information about - * algorithms provided by SageMaker, see Algorithms. For information about - * providing your own algorithms, see Using Your Own Algorithms with - * Amazon SageMaker.
+ *The type of app created within the space.
* @public */ - AlgorithmSpecification: AlgorithmSpecification | undefined; + AppType?: AppType | undefined; /** - *The Amazon Resource Name (ARN) of an IAM role that SageMaker can assume to perform - * tasks on your behalf.
- *During model training, SageMaker needs your permission to read input data from an S3 - * bucket, download a Docker image that contains training code, write model artifacts to an - * S3 bucket, write logs to Amazon CloudWatch Logs, and publish metrics to Amazon CloudWatch. You grant - * permissions for all of these tasks to an IAM role. For more information, see SageMaker - * Roles.
- *To be able to pass this role to SageMaker, the caller of this API must have the
- * iam:PassRole permission.
The storage settings for a space.
* @public */ - RoleArn: string | undefined; + SpaceStorageSettings?: SpaceStorageSettings | undefined; /** - *An array of Channel objects. Each channel is a named input source.
- * InputDataConfig describes the input data and its location.
Algorithms can accept input data from one or more channels. For example, an
- * algorithm might have two channels of input data, training_data and
- * validation_data. The configuration for each channel provides the S3,
- * EFS, or FSx location where the input data is stored. It also provides information about
- * the stored data: the MIME type, compression method, and whether the data is wrapped in
- * RecordIO format.
Depending on the input mode that the algorithm supports, SageMaker either copies input - * data files from an S3 bucket to a local directory in the Docker container, or makes it - * available as input streams. For example, if you specify an EFS location, input data - * files are available as input streams. They do not need to be downloaded.
- *Your input must be in the same Amazon Web Services region as your training - * job.
- * @public - */ - InputDataConfig?: Channel[] | undefined; - - /** - *Specifies the path to the S3 location where you want to store model artifacts. SageMaker - * creates subfolders for the artifacts.
+ *A file system, created by you, that you assign to a space for an Amazon SageMaker + * Domain. Permitted users can access this file system in Amazon SageMaker Studio.
* @public */ - OutputDataConfig: OutputDataConfig | undefined; + CustomFileSystems?: CustomFileSystem[] | undefined; +} + +/** + * @public + * @enum + */ +export const SharingType = { + Private: "Private", + Shared: "Shared", +} as const; + +/** + * @public + */ +export type SharingType = (typeof SharingType)[keyof typeof SharingType]; +/** + *A collection of space sharing settings.
+ * @public + */ +export interface SpaceSharingSettings { /** - *The resources, including the ML compute instances and ML storage volumes, to use - * for model training.
- *ML storage volumes store model artifacts and incremental states. Training
- * algorithms might also use ML storage volumes for scratch space. If you want SageMaker to use
- * the ML storage volume to store the training data, choose File as the
- * TrainingInputMode in the algorithm specification. For distributed
- * training algorithms, specify an instance count greater than 1.
Specifies the sharing type of the space.
* @public */ - ResourceConfig: ResourceConfig | undefined; + SharingType: SharingType | undefined; +} +/** + * @public + */ +export interface CreateSpaceRequest { /** - *A VpcConfig object that specifies the VPC that you want your training job to - * connect to. Control access to and from your training container by configuring the VPC. - * For more information, see Protect Training Jobs by Using an Amazon - * Virtual Private Cloud.
+ *The ID of the associated domain.
* @public */ - VpcConfig?: VpcConfig | undefined; + DomainId: string | undefined; /** - *Specifies a limit to how long a model training job can run. It also specifies how long - * a managed Spot training job has to complete. When the job reaches the time limit, SageMaker - * ends the training job. Use this API to cap model training costs.
- *To stop a job, SageMaker sends the algorithm the SIGTERM signal, which delays
- * job termination for 120 seconds. Algorithms can use this 120-second window to save the
- * model artifacts, so the results of training are not lost.
The name of the space.
* @public */ - StoppingCondition: StoppingCondition | undefined; + SpaceName: string | undefined; /** - *An array of key-value pairs. You can use tags to categorize your Amazon Web Services - * resources in different ways, for example, by purpose, owner, or environment. For more - * information, see Tagging Amazon Web Services Resources.
+ *Tags to associated with the space. Each tag consists of a key and an optional value. Tag
+ * keys must be unique for each resource. Tags are searchable using the Search
+ * API.
Isolates the training container. No inbound or outbound network calls can be made, - * except for calls between peers within a training cluster for distributed training. If - * you enable network isolation for training jobs that are configured to use a VPC, SageMaker - * downloads and uploads customer data and model artifacts through the specified VPC, but - * the training container does not have network access.
+ *A collection of space settings.
* @public */ - EnableNetworkIsolation?: boolean | undefined; + SpaceSettings?: SpaceSettings | undefined; /** - *To encrypt all communications between ML compute instances in distributed training,
- * choose True. Encryption provides greater security for distributed training,
- * but training might take longer. How long it takes depends on the amount of communication
- * between compute instances, especially if you use a deep learning algorithm in
- * distributed training. For more information, see Protect Communications Between ML
- * Compute Instances in a Distributed Training Job.
A collection of ownership settings.
* @public */ - EnableInterContainerTrafficEncryption?: boolean | undefined; + OwnershipSettings?: OwnershipSettings | undefined; /** - *To train models using managed spot training, choose True. Managed spot
- * training provides a fully managed and scalable infrastructure for training machine
- * learning models. this option is useful when training jobs can be interrupted and when
- * there is flexibility when the training job is run.
The complete and intermediate results of jobs are stored in an Amazon S3 bucket, and can be - * used as a starting point to train models incrementally. Amazon SageMaker provides metrics and - * logs in CloudWatch. They can be used to see when managed spot training jobs are running, - * interrupted, resumed, or completed.
+ *A collection of space sharing settings.
* @public */ - EnableManagedSpotTraining?: boolean | undefined; + SpaceSharingSettings?: SpaceSharingSettings | undefined; /** - *Contains information about the output location for managed spot training checkpoint - * data.
+ *The name of the space that appears in the SageMaker Studio UI.
* @public */ - CheckpointConfig?: CheckpointConfig | undefined; + SpaceDisplayName?: string | undefined; +} +/** + * @public + */ +export interface CreateSpaceResponse { /** - *Configuration information for the Amazon SageMaker Debugger hook parameters, metric and tensor collections, and
- * storage paths. To learn more about
- * how to configure the DebugHookConfig parameter,
- * see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.
The space's Amazon Resource Name (ARN).
* @public */ - DebugHookConfig?: DebugHookConfig | undefined; + SpaceArn?: string | undefined; +} - /** - *Configuration information for Amazon SageMaker Debugger rules for debugging output tensors.
- * @public - */ - DebugRuleConfigurations?: DebugRuleConfiguration[] | undefined; +/** + * @public + * @enum + */ +export const StudioLifecycleConfigAppType = { + CodeEditor: "CodeEditor", + JupyterLab: "JupyterLab", + JupyterServer: "JupyterServer", + KernelGateway: "KernelGateway", +} as const; +/** + * @public + */ +export type StudioLifecycleConfigAppType = + (typeof StudioLifecycleConfigAppType)[keyof typeof StudioLifecycleConfigAppType]; + +/** + * @public + */ +export interface CreateStudioLifecycleConfigRequest { /** - *Configuration of storage locations for the Amazon SageMaker Debugger TensorBoard output data.
+ *The name of the Amazon SageMaker Studio Lifecycle Configuration to create.
* @public */ - TensorBoardOutputConfig?: TensorBoardOutputConfig | undefined; + StudioLifecycleConfigName: string | undefined; /** - *Associates a SageMaker job as a trial component with an experiment and trial. Specified when - * you call the following APIs:
- *- * CreateProcessingJob - *
- *- * CreateTrainingJob - *
- *- * CreateTransformJob - *
- *The content of your Amazon SageMaker Studio Lifecycle Configuration script. This + * content must be base64 encoded.
* @public */ - ExperimentConfig?: ExperimentConfig | undefined; + StudioLifecycleConfigContent: string | undefined; /** - *Configuration information for Amazon SageMaker Debugger system monitoring, framework profiling, and - * storage paths.
+ *The App type that the Lifecycle Configuration is attached to.
* @public */ - ProfilerConfig?: ProfilerConfig | undefined; + StudioLifecycleConfigAppType: StudioLifecycleConfigAppType | undefined; /** - *Configuration information for Amazon SageMaker Debugger rules for profiling system and framework - * metrics.
+ *Tags to be associated with the Lifecycle Configuration. Each tag consists of a key and an + * optional value. Tag keys must be unique per resource. Tags are searchable using the Search + * API.
* @public */ - ProfilerRuleConfigurations?: ProfilerRuleConfiguration[] | undefined; + Tags?: Tag[] | undefined; +} +/** + * @public + */ +export interface CreateStudioLifecycleConfigResponse { /** - *The environment variables to set in the Docker container.
+ *The ARN of your created Lifecycle Configuration.
* @public */ - Environment?: RecordConfiguration information for the Amazon SageMaker Debugger hook parameters, metric and tensor collections, and
+ * storage paths. To learn more about
+ * how to configure the DebugHookConfig parameter,
+ * see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.
The number of times to retry the job when the job fails due to an
- * InternalServerError.
Path to local storage location for metrics and tensors. Defaults to
+ * /opt/ml/output/tensors/.
Configuration for remote debugging. To learn more about the remote debugging - * functionality of SageMaker, see Access a training container - * through Amazon Web Services Systems Manager (SSM) for remote - * debugging.
+ *Path to Amazon S3 storage location for metrics and tensors.
* @public */ - RemoteDebugConfig?: RemoteDebugConfig | undefined; + S3OutputPath: string | undefined; /** - *Contains information about the infrastructure health check configuration for the training job.
+ *Configuration information for the Amazon SageMaker Debugger hook parameters.
* @public */ - InfraCheckConfig?: InfraCheckConfig | undefined; + HookParameters?: RecordContains information about attribute-based access control (ABAC) for the training - * job.
+ *Configuration information for Amazon SageMaker Debugger tensor collections. To learn more about
+ * how to configure the CollectionConfiguration parameter,
+ * see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.
+ *
Configuration information for SageMaker Debugger rules for debugging. To learn more about
+ * how to configure the DebugRuleConfiguration parameter,
+ * see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.
The Amazon Resource Name (ARN) of the training job.
+ *The name of the rule configuration. It must be unique relative to other rule + * configuration names.
* @public */ - TrainingJobArn: string | undefined; -} + RuleConfigurationName: string | undefined; -/** - * @public - * @enum - */ -export const JoinSource = { - INPUT: "Input", - NONE: "None", -} as const; + /** + *Path to local storage location for output of rules. Defaults to
+ * /opt/ml/processing/output/rule/.
The data structure used to specify the data to be used for inference in a batch - * transform job and to associate the data that is relevant to the prediction results in - * the output. The input filter provided allows you to exclude input data that is not - * needed for inference in a batch transform job. The output filter provided allows you to - * include input data relevant to interpreting the predictions in the output from the job. - * For more information, see Associate Prediction - * Results with their Corresponding Input Records.
- * @public - */ -export interface DataProcessing { - /** - *A JSONPath expression used to select a portion of the input data to pass to
- * the algorithm. Use the InputFilter parameter to exclude fields, such as an
- * ID column, from the input. If you want SageMaker to pass the entire input dataset to the
- * algorithm, accept the default value $.
Examples: "$", "$[1:]", "$.features"
- *
Path to Amazon S3 storage location for rules.
+ * @public + */ + S3OutputPath?: string | undefined; /** - *A JSONPath expression used to select a portion of the joined dataset to save
- * in the output file for a batch transform job. If you want SageMaker to store the entire input
- * dataset in the output file, leave the default value, $. If you specify
- * indexes that aren't within the dimension size of the joined dataset, you get an
- * error.
Examples: "$", "$[0,5:]",
- * "$['id','SageMakerOutput']"
- *
The Amazon Elastic Container (ECR) Image for the managed rule evaluation.
* @public */ - OutputFilter?: string | undefined; + RuleEvaluatorImage: string | undefined; /** - *Specifies the source of the data to join with the transformed data. The valid values
- * are None and Input. The default value is None,
- * which specifies not to join the input with the transformed data. If you want the batch
- * transform job to join the original input data with the transformed data, set
- * JoinSource to Input. You can specify
- * OutputFilter as an additional filter to select a portion of the joined
- * dataset and store it in the output file.
For JSON or JSONLines objects, such as a JSON array, SageMaker adds the transformed data to
- * the input JSON object in an attribute called SageMakerOutput. The joined
- * result for JSON must be a key-value pair object. If the input is not a key-value pair
- * object, SageMaker creates a new JSON file. In the new JSON file, and the input data is stored
- * under the SageMakerInput key and the results are stored in
- * SageMakerOutput.
For CSV data, SageMaker takes each row as a JSON array and joins the transformed data with - * the input by appending each transformed row to the end of the input. The joined data has - * the original input data followed by the transformed data and the output is a CSV - * file.
- *For information on how joining in applied, see Workflow for Associating Inferences with Input Records.
+ *The instance type to deploy a custom rule for debugging a training job.
* @public */ - JoinSource?: JoinSource | undefined; -} + InstanceType?: ProcessingInstanceType | undefined; -/** - *Configures the timeout and maximum number of retries for processing a transform job - * invocation.
- * @public - */ -export interface ModelClientConfig { /** - *The timeout value in seconds for an invocation request. The default value is - * 600.
+ *The size, in GB, of the ML storage volume attached to the processing instance.
* @public */ - InvocationsTimeoutInSeconds?: number | undefined; + VolumeSizeInGB?: number | undefined; /** - *The maximum number of retries when invocation requests are failing. The default value - * is 3.
+ *Runtime configuration for rule container.
* @public */ - InvocationsMaxRetries?: number | undefined; + RuleParameters?: RecordConfiguration information for the infrastructure health check of a training job. A SageMaker-provided health check tests the health of instance hardware and cluster network + * connectivity.
* @public */ -export interface CreateTransformJobRequest { - /** - *The name of the transform job. The name must be unique within an Amazon Web Services Region in an - * Amazon Web Services account.
- * @public - */ - TransformJobName: string | undefined; - +export interface InfraCheckConfig { /** - *The name of the model that you want to use for the transform job.
- * ModelName must be the name of an existing Amazon SageMaker model within an Amazon Web Services
- * Region in an Amazon Web Services account.
Enables an infrastructure health check.
* @public */ - ModelName: string | undefined; + EnableInfraCheck?: boolean | undefined; +} +/** + *Configuration information for Amazon SageMaker Debugger system monitoring, framework profiling, and + * storage paths.
+ * @public + */ +export interface ProfilerConfig { /** - *The maximum number of parallel requests that can be sent to each instance in a
- * transform job. If MaxConcurrentTransforms is set to 0 or left
- * unset, Amazon SageMaker checks the optional execution-parameters to determine the settings for your
- * chosen algorithm. If the execution-parameters endpoint is not enabled, the default value
- * is 1. For more information on execution-parameters, see How Containers Serve Requests. For built-in algorithms, you don't need to
- * set a value for MaxConcurrentTransforms.
Path to Amazon S3 storage location for system and framework metrics.
* @public */ - MaxConcurrentTransforms?: number | undefined; + S3OutputPath?: string | undefined; /** - *Configures the timeout and maximum number of retries for processing a transform job - * invocation.
+ *A time interval for capturing system metrics in milliseconds. Available values are + * 100, 200, 500, 1000 (1 second), 5000 (5 seconds), and 60000 (1 minute) milliseconds. The default value is 500 milliseconds.
* @public */ - ModelClientConfig?: ModelClientConfig | undefined; + ProfilingIntervalInMilliseconds?: number | undefined; /** - *The maximum allowed size of the payload, in MB. A payload is the
- * data portion of a record (without metadata). The value in MaxPayloadInMB
- * must be greater than, or equal to, the size of a single record. To estimate the size of
- * a record in MB, divide the size of your dataset by the number of records. To ensure that
- * the records fit within the maximum payload size, we recommend using a slightly larger
- * value. The default value is 6 MB.
- *
The value of MaxPayloadInMB cannot be greater than 100 MB. If you specify
- * the MaxConcurrentTransforms parameter, the value of
- * (MaxConcurrentTransforms * MaxPayloadInMB) also cannot exceed 100
- * MB.
For cases where the payload might be arbitrarily large and is transmitted using HTTP
- * chunked encoding, set the value to 0.
- * This
- * feature works only in supported algorithms. Currently, Amazon SageMaker built-in
- * algorithms do not support HTTP chunked encoding.
Configuration information for capturing framework metrics. Available key strings for different profiling options are
+ * DetailedProfilingConfig, PythonProfilingConfig, and DataLoaderProfilingConfig.
+ * The following codes are configuration structures for the ProfilingParameters parameter. To learn more about
+ * how to configure the ProfilingParameters parameter,
+ * see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.
+ *
Specifies the number of records to include in a mini-batch for an HTTP inference - * request. A record - * is a single unit of input data that - * inference can be made on. For example, a single line in a CSV file is a record.
- *To enable the batch strategy, you must set the SplitType property to
- * Line, RecordIO, or TFRecord.
To use only one record when making an HTTP invocation request to a container, set
- * BatchStrategy to SingleRecord and SplitType
- * to Line.
To fit as many records in a mini-batch as can fit within the
- * MaxPayloadInMB limit, set BatchStrategy to
- * MultiRecord and SplitType to Line.
Configuration to turn off Amazon SageMaker Debugger's system monitoring and profiling functionality. To turn it off, set to True.
Configuration information for profiling rules.
+ * @public + */ +export interface ProfilerRuleConfiguration { /** - *The environment variables to set in the Docker container. Don't include any - * sensitive data in your environment variables. We support up to 16 key and - * values entries in the map.
+ *The name of the rule configuration. It must be unique relative to other rule configuration names.
* @public */ - Environment?: RecordDescribes the input source and - * the - * way the transform job consumes it.
+ *Path to local storage location for output of rules. Defaults to /opt/ml/processing/output/rule/.
Describes the results of the transform job.
+ *Path to Amazon S3 storage location for rules.
* @public */ - TransformOutput: TransformOutput | undefined; + S3OutputPath?: string | undefined; /** - *Configuration to control how SageMaker captures inference data.
+ *The Amazon Elastic Container Registry Image for the managed rule evaluation.
* @public */ - DataCaptureConfig?: BatchDataCaptureConfig | undefined; + RuleEvaluatorImage: string | undefined; /** - *Describes the resources, including - * ML - * instance types and ML instance count, to use for the transform - * job.
+ *The instance type to deploy a custom rule for profiling a training job.
* @public */ - TransformResources: TransformResources | undefined; + InstanceType?: ProcessingInstanceType | undefined; /** - *The data structure used to specify the data to be used for inference in a batch - * transform job and to associate the data that is relevant to the prediction results in - * the output. The input filter provided allows you to exclude input data that is not - * needed for inference in a batch transform job. The output filter provided allows you to - * include input data relevant to interpreting the predictions in the output from the job. - * For more information, see Associate Prediction - * Results with their Corresponding Input Records.
+ *The size, in GB, of the ML storage volume attached to the processing instance.
* @public */ - DataProcessing?: DataProcessing | undefined; + VolumeSizeInGB?: number | undefined; /** - *(Optional) - * An - * array of key-value pairs. For more information, see Using - * Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User - * Guide.
+ *Runtime configuration for rule container.
* @public */ - Tags?: Tag[] | undefined; + RuleParameters?: RecordConfiguration for remote debugging for the CreateTrainingJob API. To learn more about the remote debugging + * functionality of SageMaker, see Access a training container + * through Amazon Web Services Systems Manager (SSM) for remote + * debugging.
+ * @public + */ +export interface RemoteDebugConfig { /** - *Associates a SageMaker job as a trial component with an experiment and trial. Specified when - * you call the following APIs:
- *- * CreateProcessingJob - *
- *- * CreateTrainingJob - *
- *- * CreateTransformJob - *
- *If set to True, enables remote debugging.
* @public */ - ExperimentConfig?: ExperimentConfig | undefined; + EnableRemoteDebug?: boolean | undefined; } /** + *Contains information about attribute-based access control (ABAC) for a training job. + * The session chaining configuration uses Amazon Security Token Service (STS) for your training job to + * request temporary, limited-privilege credentials to tenants. For more information, see + * Attribute-based access control (ABAC) for multi-tenancy training.
* @public */ -export interface CreateTransformJobResponse { +export interface SessionChainingConfig { /** - *The Amazon Resource Name (ARN) of the transform job.
+ *Set to True to allow SageMaker to extract session tags from a training job
+ * creation role and reuse these tags when assuming the training job execution role.
Configuration of storage locations for the Amazon SageMaker Debugger TensorBoard output data.
* @public */ -export interface CreateTrialRequest { +export interface TensorBoardOutputConfig { /** - *The name of the trial. The name must be unique in your Amazon Web Services account and is not - * case-sensitive.
+ *Path to local storage location for tensorBoard output. Defaults to
+ * /opt/ml/output/tensorboard.
The name of the trial as displayed. The name doesn't need to be unique. If
- * DisplayName isn't specified, TrialName is displayed.
Path to Amazon S3 storage location for TensorBoard output.
* @public */ - DisplayName?: string | undefined; - - /** - *The name of the experiment to associate the trial with.
- * @public - */ - ExperimentName: string | undefined; - - /** - *Metadata properties of the tracking entity, trial, or trial component.
- * @public - */ - MetadataProperties?: MetadataProperties | undefined; - - /** - *A list of tags to associate with the trial. You can use Search API to - * search on the tags.
- * @public - */ - Tags?: Tag[] | undefined; -} - -/** - * @public - */ -export interface CreateTrialResponse { - /** - *The Amazon Resource Name (ARN) of the trial.
- * @public - */ - TrialArn?: string | undefined; -} - -/** - *Represents an input or output artifact of a trial component. You specify
- * TrialComponentArtifact as part of the InputArtifacts and
- * OutputArtifacts parameters in the CreateTrialComponent
- * request.
Examples of input artifacts are datasets, algorithms, hyperparameters, source code, and - * instance types. Examples of output artifacts are metrics, snapshots, logs, and images.
- * @public - */ -export interface TrialComponentArtifact { - /** - *The media type of the artifact, which indicates the type of data in the artifact file. The - * media type consists of a type and a subtype - * concatenated with a slash (/) character, for example, text/csv, image/jpeg, and s3/uri. The - * type specifies the category of the media. The subtype specifies the kind of data.
- * @public - */ - MediaType?: string | undefined; - - /** - *The location of the artifact.
- * @public - */ - Value: string | undefined; -} - -/** - *The value of a hyperparameter. Only one of NumberValue or
- * StringValue can be specified.
This object is specified in the CreateTrialComponent request.
- * @public - */ -export type TrialComponentParameterValue = - | TrialComponentParameterValue.NumberValueMember - | TrialComponentParameterValue.StringValueMember - | TrialComponentParameterValue.$UnknownMember; - -/** - * @public - */ -export namespace TrialComponentParameterValue { - /** - *The string value of a categorical hyperparameter. If you specify a value for this
- * parameter, you can't specify the NumberValue parameter.
The numeric value of a numeric hyperparameter. If you specify a value for this parameter,
- * you can't specify the StringValue parameter.
The status of the trial component.
- * @public - */ -export interface TrialComponentStatus { - /** - *The status of the trial component.
- * @public - */ - PrimaryStatus?: TrialComponentPrimaryStatus | undefined; - - /** - *If the component failed, a message describing why.
- * @public - */ - Message?: string | undefined; -} - -/** - * @public - */ -export interface CreateTrialComponentRequest { - /** - *The name of the component. The name must be unique in your Amazon Web Services account and is not - * case-sensitive.
- * @public - */ - TrialComponentName: string | undefined; - - /** - *The name of the component as displayed. The name doesn't need to be unique. If
- * DisplayName isn't specified, TrialComponentName is
- * displayed.
The status of the component. States include:
- *InProgress
- *Completed
- *Failed
- *When the component started.
- * @public - */ - StartTime?: Date | undefined; - - /** - *When the component ended.
- * @public - */ - EndTime?: Date | undefined; - - /** - *The hyperparameters for the component.
- * @public - */ - Parameters?: RecordThe input artifacts for the component. Examples of input artifacts are datasets, - * algorithms, hyperparameters, source code, and instance types.
- * @public - */ - InputArtifacts?: RecordThe output artifacts for the component. Examples of output artifacts are metrics, - * snapshots, logs, and images.
- * @public - */ - OutputArtifacts?: RecordMetadata properties of the tracking entity, trial, or trial component.
- * @public - */ - MetadataProperties?: MetadataProperties | undefined; - - /** - *A list of tags to associate with the component. You can use Search API - * to search on the tags.
- * @public - */ - Tags?: Tag[] | undefined; -} - -/** - * @public - */ -export interface CreateTrialComponentResponse { - /** - *The Amazon Resource Name (ARN) of the trial component.
- * @public - */ - TrialComponentArn?: string | undefined; -} - -/** - * @public - */ -export interface CreateUserProfileRequest { - /** - *The ID of the associated Domain.
- * @public - */ - DomainId: string | undefined; - - /** - *A name for the UserProfile. This value is not case sensitive.
- * @public - */ - UserProfileName: string | undefined; - - /** - *A specifier for the type of value specified in SingleSignOnUserValue. Currently, the only - * supported value is "UserName". If the Domain's AuthMode is IAM Identity Center, this field is - * required. If the Domain's AuthMode is not IAM Identity Center, this field cannot be specified. - *
- * @public - */ - SingleSignOnUserIdentifier?: string | undefined; - - /** - *The username of the associated Amazon Web Services Single Sign-On User for this - * UserProfile. If the Domain's AuthMode is IAM Identity Center, this field is required, and must - * match a valid username of a user in your directory. If the Domain's AuthMode is not IAM Identity Center, this field cannot be specified.
- * @public - */ - SingleSignOnUserValue?: string | undefined; - - /** - *Each tag consists of a key and an optional value. Tag keys must be unique per - * resource.
- *Tags that you specify for the User Profile are also added to all Apps that the User - * Profile launches.
- * @public - */ - Tags?: Tag[] | undefined; - - /** - *A collection of settings.
- * @public - */ - UserSettings?: UserSettings | undefined; -} - -/** - * @public - */ -export interface CreateUserProfileResponse { - /** - *The user profile Amazon Resource Name (ARN).
- * @public - */ - UserProfileArn?: string | undefined; -} - -/** - *Use this parameter to configure your OIDC Identity Provider (IdP).
- * @public - */ -export interface OidcConfig { - /** - *The OIDC IdP client ID used to configure your private workforce.
- * @public - */ - ClientId: string | undefined; - - /** - *The OIDC IdP client secret used to configure your private workforce.
- * @public - */ - ClientSecret: string | undefined; - - /** - *The OIDC IdP issuer used to configure your private workforce.
- * @public - */ - Issuer: string | undefined; - - /** - *The OIDC IdP authorization endpoint used to configure your private workforce.
- * @public - */ - AuthorizationEndpoint: string | undefined; - - /** - *The OIDC IdP token endpoint used to configure your private workforce.
- * @public - */ - TokenEndpoint: string | undefined; - - /** - *The OIDC IdP user information endpoint used to configure your private workforce.
- * @public - */ - UserInfoEndpoint: string | undefined; - - /** - *The OIDC IdP logout endpoint used to configure your private workforce.
- * @public - */ - LogoutEndpoint: string | undefined; - +export interface CreateTrainingJobRequest { /** - *The OIDC IdP JSON Web Key Set (Jwks) URI used to configure your private workforce.
+ *The name of the training job. The name must be unique within an Amazon Web Services + * Region in an Amazon Web Services account.
* @public */ - JwksUri: string | undefined; + TrainingJobName: string | undefined; /** - *An array of string identifiers used to refer to the specific pieces of user data or claims that the client application wants to access.
+ *Algorithm-specific parameters that influence the quality of the model. You set + * hyperparameters before you start the learning process. For a list of hyperparameters for + * each training algorithm provided by SageMaker, see Algorithms.
+ *You can specify a maximum of 100 hyperparameters. Each hyperparameter is a
+ * key-value pair. Each key and value is limited to 256 characters, as specified by the
+ * Length Constraint.
Do not include any security-sensitive information including account access IDs, + * secrets or tokens in any hyperparameter field. If the use of security-sensitive + * credentials are detected, SageMaker will reject your training job request and return an + * exception error.
+ *A string to string map of identifiers specific to the custom identity provider (IdP) being used.
+ *The registry path of the Docker image that contains the training algorithm and + * algorithm-specific metadata, including the input mode. For more information about + * algorithms provided by SageMaker, see Algorithms. For information about + * providing your own algorithms, see Using Your Own Algorithms with + * Amazon SageMaker.
* @public */ - AuthenticationRequestExtraParams?: RecordA list of IP address ranges (CIDRs). Used to create an allow - * list of IP addresses for a private workforce. Workers will only be able to log in to their worker portal from an - * IP address within this range. By default, a workforce isn't restricted to specific IP addresses.
- * @public - */ -export interface SourceIpConfig { /** - *A list of one to ten Classless Inter-Domain Routing (CIDR) values.
- *Maximum: Ten CIDR values
+ *The Amazon Resource Name (ARN) of an IAM role that SageMaker can assume to perform + * tasks on your behalf.
+ *During model training, SageMaker needs your permission to read input data from an S3 + * bucket, download a Docker image that contains training code, write model artifacts to an + * S3 bucket, write logs to Amazon CloudWatch Logs, and publish metrics to Amazon CloudWatch. You grant + * permissions for all of these tasks to an IAM role. For more information, see SageMaker + * Roles.
*The following Length Constraints apply to individual CIDR values in - * the CIDR value list.
+ *To be able to pass this role to SageMaker, the caller of this API must have the
+ * iam:PassRole permission.
The VPC object you use to create or update a workforce.
- * @public - */ -export interface WorkforceVpcConfigRequest { /** - *The ID of the VPC that the workforce uses for communication.
+ *An array of Channel objects. Each channel is a named input source.
+ * InputDataConfig describes the input data and its location.
Algorithms can accept input data from one or more channels. For example, an
+ * algorithm might have two channels of input data, training_data and
+ * validation_data. The configuration for each channel provides the S3,
+ * EFS, or FSx location where the input data is stored. It also provides information about
+ * the stored data: the MIME type, compression method, and whether the data is wrapped in
+ * RecordIO format.
Depending on the input mode that the algorithm supports, SageMaker either copies input + * data files from an S3 bucket to a local directory in the Docker container, or makes it + * available as input streams. For example, if you specify an EFS location, input data + * files are available as input streams. They do not need to be downloaded.
+ *Your input must be in the same Amazon Web Services region as your training + * job.
* @public */ - VpcId?: string | undefined; + InputDataConfig?: Channel[] | undefined; /** - *The VPC security group IDs, in the form sg-xxxxxxxx. The security groups must be for the same VPC as specified in the subnet.
Specifies the path to the S3 location where you want to store model artifacts. SageMaker + * creates subfolders for the artifacts.
* @public */ - SecurityGroupIds?: string[] | undefined; + OutputDataConfig: OutputDataConfig | undefined; /** - *The ID of the subnets in the VPC that you want to connect.
+ *The resources, including the ML compute instances and ML storage volumes, to use + * for model training.
+ *ML storage volumes store model artifacts and incremental states. Training
+ * algorithms might also use ML storage volumes for scratch space. If you want SageMaker to use
+ * the ML storage volume to store the training data, choose File as the
+ * TrainingInputMode in the algorithm specification. For distributed
+ * training algorithms, specify an instance count greater than 1.
Use this parameter to configure an Amazon Cognito private workforce. - * A single Cognito workforce is created using and corresponds to a single - * - * Amazon Cognito user pool.
- *Do not use OidcConfig if you specify values for
- * CognitoConfig.
A VpcConfig object that specifies the VPC that you want your training job to + * connect to. Control access to and from your training container by configuring the VPC. + * For more information, see Protect Training Jobs by Using an Amazon + * Virtual Private Cloud.
* @public */ - CognitoConfig?: CognitoConfig | undefined; + VpcConfig?: VpcConfig | undefined; /** - *Use this parameter to configure a private workforce using your own OIDC Identity Provider.
- *Do not use CognitoConfig if you specify values for
- * OidcConfig.
Specifies a limit to how long a model training job can run. It also specifies how long + * a managed Spot training job has to complete. When the job reaches the time limit, SageMaker + * ends the training job. Use this API to cap model training costs.
+ *To stop a job, SageMaker sends the algorithm the SIGTERM signal, which delays
+ * job termination for 120 seconds. Algorithms can use this 120-second window to save the
+ * model artifacts, so the results of training are not lost.
A list of IP address ranges (CIDRs). Used to create an allow - * list of IP addresses for a private workforce. Workers will only be able to log in to their worker portal from an - * IP address within this range. By default, a workforce isn't restricted to specific IP addresses.
+ *An array of key-value pairs. You can use tags to categorize your Amazon Web Services + * resources in different ways, for example, by purpose, owner, or environment. For more + * information, see Tagging Amazon Web Services Resources.
* @public */ - SourceIpConfig?: SourceIpConfig | undefined; + Tags?: Tag[] | undefined; /** - *The name of the private workforce.
+ *Isolates the training container. No inbound or outbound network calls can be made, + * except for calls between peers within a training cluster for distributed training. If + * you enable network isolation for training jobs that are configured to use a VPC, SageMaker + * downloads and uploads customer data and model artifacts through the specified VPC, but + * the training container does not have network access.
* @public */ - WorkforceName: string | undefined; + EnableNetworkIsolation?: boolean | undefined; /** - *An array of key-value pairs that contain metadata to help you categorize and - * organize our workforce. Each tag consists of a key and a value, - * both of which you define.
+ *To encrypt all communications between ML compute instances in distributed training,
+ * choose True. Encryption provides greater security for distributed training,
+ * but training might take longer. How long it takes depends on the amount of communication
+ * between compute instances, especially if you use a deep learning algorithm in
+ * distributed training. For more information, see Protect Communications Between ML
+ * Compute Instances in a Distributed Training Job.
Use this parameter to configure a workforce using VPC.
+ *To train models using managed spot training, choose True. Managed spot
+ * training provides a fully managed and scalable infrastructure for training machine
+ * learning models. this option is useful when training jobs can be interrupted and when
+ * there is flexibility when the training job is run.
The complete and intermediate results of jobs are stored in an Amazon S3 bucket, and can be + * used as a starting point to train models incrementally. Amazon SageMaker provides metrics and + * logs in CloudWatch. They can be used to see when managed spot training jobs are running, + * interrupted, resumed, or completed.
* @public */ - WorkforceVpcConfig?: WorkforceVpcConfigRequest | undefined; -} + EnableManagedSpotTraining?: boolean | undefined; -/** - * @public - */ -export interface CreateWorkforceResponse { /** - *The Amazon Resource Name (ARN) of the workforce.
+ *Contains information about the output location for managed spot training checkpoint + * data.
* @public */ - WorkforceArn: string | undefined; -} + CheckpointConfig?: CheckpointConfig | undefined; -/** - *A list of user groups that exist in your OIDC Identity Provider (IdP).
- * One to ten groups can be used to create a single private work team.
- * When you add a user group to the list of Groups, you can add that user group to one or more
- * private work teams. If you add a user group to a private work team, all workers in that user group
- * are added to the work team.
A list of comma seperated strings that identifies - * user groups in your OIDC IdP. Each user group is - * made up of a group of private workers.
+ *Configuration information for the Amazon SageMaker Debugger hook parameters, metric and tensor collections, and
+ * storage paths. To learn more about
+ * how to configure the DebugHookConfig parameter,
+ * see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.
Defines an Amazon Cognito or your own OIDC IdP user group that is part of a work team.
- * @public - */ -export interface MemberDefinition { /** - *The Amazon Cognito user group that is part of the work team.
+ *Configuration information for Amazon SageMaker Debugger rules for debugging output tensors.
* @public */ - CognitoMemberDefinition?: CognitoMemberDefinition | undefined; + DebugRuleConfigurations?: DebugRuleConfiguration[] | undefined; /** - *A list user groups that exist in your OIDC Identity Provider (IdP).
- * One to ten groups can be used to create a single private work team.
- * When you add a user group to the list of Groups, you can add that user group to one or more
- * private work teams. If you add a user group to a private work team, all workers in that user group
- * are added to the work team.
Configuration of storage locations for the Amazon SageMaker Debugger TensorBoard output data.
* @public */ - OidcMemberDefinition?: OidcMemberDefinition | undefined; -} + TensorBoardOutputConfig?: TensorBoardOutputConfig | undefined; -/** - *Configures Amazon SNS notifications of available or expiring work items for work - * teams.
- * @public - */ -export interface NotificationConfiguration { /** - *The ARN for the Amazon SNS topic to which notifications should be published.
+ *Associates a SageMaker job as a trial component with an experiment and trial. Specified when + * you call the following APIs:
+ *+ * CreateProcessingJob + *
+ *+ * CreateTrainingJob + *
+ *+ * CreateTransformJob + *
+ *Use this parameter to specify a supported global condition key that is added to the IAM policy.
- * @public - */ -export interface IamPolicyConstraints { /** - *When SourceIp is Enabled the worker's IP address when a task is rendered in the worker portal is added to the IAM policy as a Condition used to generate the Amazon S3 presigned URL. This IP address is checked by Amazon S3 and must match in order for the Amazon S3 resource to be rendered in the worker portal.
Configuration information for Amazon SageMaker Debugger system monitoring, framework profiling, and + * storage paths.
* @public */ - SourceIp?: EnabledOrDisabled | undefined; + ProfilerConfig?: ProfilerConfig | undefined; /** - *When VpcSourceIp is Enabled the worker's IP address when a task is rendered in private worker portal inside the VPC is added to the IAM policy as a Condition used to generate the Amazon S3 presigned URL. To render the task successfully Amazon S3 checks that the presigned URL is being accessed over an Amazon S3 VPC Endpoint, and that the worker's IP address matches the IP address in the IAM policy. To learn more about configuring private worker portal, see Use Amazon VPC mode from a private worker portal.
Configuration information for Amazon SageMaker Debugger rules for profiling system and framework + * metrics.
* @public */ - VpcSourceIp?: EnabledOrDisabled | undefined; -} + ProfilerRuleConfigurations?: ProfilerRuleConfiguration[] | undefined; -/** - *This object defines the access restrictions to Amazon S3 resources that are included in custom worker task templates using the Liquid filter, grant_read_access.
To learn more about how custom templates are created, see Create custom worker task templates.
- * @public - */ -export interface S3Presign { /** - *Use this parameter to specify the allowed request source. Possible sources are either SourceIp or VpcSourceIp.
The environment variables to set in the Docker container.
* @public */ - IamPolicyConstraints?: IamPolicyConstraints | undefined; -} + Environment?: RecordUse this optional parameter to constrain access to an Amazon S3 resource based on the IP address using supported IAM global condition keys. The Amazon S3 resource is accessed in the worker portal using a Amazon S3 presigned URL.
- * @public - */ -export interface WorkerAccessConfiguration { /** - *Defines any Amazon S3 resource constraints.
+ *The number of times to retry the job when the job fails due to an
+ * InternalServerError.
The name of the work team. Use this name to identify the work team.
+ *Configuration for remote debugging. To learn more about the remote debugging + * functionality of SageMaker, see Access a training container + * through Amazon Web Services Systems Manager (SSM) for remote + * debugging.
* @public */ - WorkteamName: string | undefined; + RemoteDebugConfig?: RemoteDebugConfig | undefined; /** - *The name of the workforce.
+ *Contains information about the infrastructure health check configuration for the training job.
* @public */ - WorkforceName?: string | undefined; + InfraCheckConfig?: InfraCheckConfig | undefined; /** - *A list of MemberDefinition objects that contains objects that identify
- * the workers that make up the work team.
Workforces can be created using Amazon Cognito or your own OIDC Identity Provider (IdP). For
- * private workforces created using Amazon Cognito use CognitoMemberDefinition. For
- * workforces created using your own OIDC identity provider (IdP) use
- * OidcMemberDefinition. Do not provide input for both of these parameters
- * in a single request.
For workforces created using Amazon Cognito, private work teams correspond to Amazon Cognito
- * user groups within the user pool used to create a workforce. All of the
- * CognitoMemberDefinition objects that make up the member definition must
- * have the same ClientId and UserPool values. To add a Amazon
- * Cognito user group to an existing worker pool, see Adding groups to a User
- * Pool. For more information about user pools, see Amazon Cognito User
- * Pools.
For workforces created using your own OIDC IdP, specify the user groups that you want to
- * include in your private work team in OidcMemberDefinition by listing those groups
- * in Groups.
Contains information about attribute-based access control (ABAC) for the training + * job.
* @public */ - MemberDefinitions: MemberDefinition[] | undefined; + SessionChainingConfig?: SessionChainingConfig | undefined; +} +/** + * @public + */ +export interface CreateTrainingJobResponse { /** - *A description of the work team.
+ *The Amazon Resource Name (ARN) of the training job.
* @public */ - Description: string | undefined; + TrainingJobArn: string | undefined; +} +/** + * @public + */ +export interface CreateTrainingPlanRequest { /** - *Configures notification of workers regarding available or expiring work items.
+ *The name of the training plan to create.
* @public */ - NotificationConfiguration?: NotificationConfiguration | undefined; + TrainingPlanName: string | undefined; /** - *Use this optional parameter to constrain access to an Amazon S3 resource based on the IP address using supported IAM global condition keys. The Amazon S3 resource is accessed in the worker portal using a Amazon S3 presigned URL.
+ *The unique identifier of the training plan offering to use for creating this + * plan.
* @public */ - WorkerAccessConfiguration?: WorkerAccessConfiguration | undefined; + TrainingPlanOfferingId: string | undefined; /** - *An array of key-value pairs.
- *For more information, see Resource - * Tag and Using - * Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User - * Guide.
+ *An array of key-value pairs to apply to this training plan.
* @public */ Tags?: Tag[] | undefined; @@ -3038,2467 +2843,2699 @@ export interface CreateWorkteamRequest { /** * @public */ -export interface CreateWorkteamResponse { +export interface CreateTrainingPlanResponse { /** - *The Amazon Resource Name (ARN) of the work team. You can use this ARN to identify the - * work team.
+ *The Amazon Resource Name (ARN); of the created training plan.
* @public */ - WorkteamArn?: string | undefined; + TrainingPlanArn: string | undefined; } /** * @public * @enum */ -export const CrossAccountFilterOption = { - CROSS_ACCOUNT: "CrossAccount", - SAME_ACCOUNT: "SameAccount", -} as const; - -/** - * @public - */ -export type CrossAccountFilterOption = (typeof CrossAccountFilterOption)[keyof typeof CrossAccountFilterOption]; - -/** - * @public - * @enum - */ -export const Statistic = { - AVERAGE: "Average", - MAXIMUM: "Maximum", - MINIMUM: "Minimum", - SAMPLE_COUNT: "SampleCount", - SUM: "Sum", +export const JoinSource = { + INPUT: "Input", + NONE: "None", } as const; /** * @public */ -export type Statistic = (typeof Statistic)[keyof typeof Statistic]; +export type JoinSource = (typeof JoinSource)[keyof typeof JoinSource]; /** - *A customized metric.
+ *The data structure used to specify the data to be used for inference in a batch + * transform job and to associate the data that is relevant to the prediction results in + * the output. The input filter provided allows you to exclude input data that is not + * needed for inference in a batch transform job. The output filter provided allows you to + * include input data relevant to interpreting the predictions in the output from the job. + * For more information, see Associate Prediction + * Results with their Corresponding Input Records.
* @public */ -export interface CustomizedMetricSpecification { +export interface DataProcessing { /** - *The name of the customized metric.
+ *A JSONPath expression used to select a portion of the input data to pass to
+ * the algorithm. Use the InputFilter parameter to exclude fields, such as an
+ * ID column, from the input. If you want SageMaker to pass the entire input dataset to the
+ * algorithm, accept the default value $.
Examples: "$", "$[1:]", "$.features"
+ *
The namespace of the customized metric.
+ *A JSONPath expression used to select a portion of the joined dataset to save
+ * in the output file for a batch transform job. If you want SageMaker to store the entire input
+ * dataset in the output file, leave the default value, $. If you specify
+ * indexes that aren't within the dimension size of the joined dataset, you get an
+ * error.
Examples: "$", "$[0,5:]",
+ * "$['id','SageMakerOutput']"
+ *
The statistic of the customized metric.
+ *Specifies the source of the data to join with the transformed data. The valid values
+ * are None and Input. The default value is None,
+ * which specifies not to join the input with the transformed data. If you want the batch
+ * transform job to join the original input data with the transformed data, set
+ * JoinSource to Input. You can specify
+ * OutputFilter as an additional filter to select a portion of the joined
+ * dataset and store it in the output file.
For JSON or JSONLines objects, such as a JSON array, SageMaker adds the transformed data to
+ * the input JSON object in an attribute called SageMakerOutput. The joined
+ * result for JSON must be a key-value pair object. If the input is not a key-value pair
+ * object, SageMaker creates a new JSON file. In the new JSON file, and the input data is stored
+ * under the SageMakerInput key and the results are stored in
+ * SageMakerOutput.
For CSV data, SageMaker takes each row as a JSON array and joins the transformed data with + * the input by appending each transformed row to the end of the input. The joined data has + * the original input data followed by the transformed data and the output is a CSV + * file.
+ *For information on how joining in applied, see Workflow for Associating Inferences with Input Records.
* @public */ - Statistic?: Statistic | undefined; + JoinSource?: JoinSource | undefined; } /** - *The currently active data capture configuration used by your Endpoint.
+ *Configures the timeout and maximum number of retries for processing a transform job + * invocation.
* @public */ -export interface DataCaptureConfigSummary { - /** - *Whether data capture is enabled or disabled.
- * @public - */ - EnableCapture: boolean | undefined; - - /** - *Whether data capture is currently functional.
- * @public - */ - CaptureStatus: CaptureStatus | undefined; - - /** - *The percentage of requests being captured by your Endpoint.
- * @public - */ - CurrentSamplingPercentage: number | undefined; - +export interface ModelClientConfig { /** - *The Amazon S3 location being used to capture the data.
+ *The timeout value in seconds for an invocation request. The default value is + * 600.
* @public */ - DestinationS3Uri: string | undefined; + InvocationsTimeoutInSeconds?: number | undefined; /** - *The KMS key being used to encrypt the data in Amazon S3.
+ *The maximum number of retries when invocation requests are failing. The default value + * is 3.
* @public */ - KmsKeyId: string | undefined; + InvocationsMaxRetries?: number | undefined; } /** - * @public - * @enum - */ -export const RuleEvaluationStatus = { - ERROR: "Error", - IN_PROGRESS: "InProgress", - ISSUES_FOUND: "IssuesFound", - NO_ISSUES_FOUND: "NoIssuesFound", - STOPPED: "Stopped", - STOPPING: "Stopping", -} as const; - -/** - * @public - */ -export type RuleEvaluationStatus = (typeof RuleEvaluationStatus)[keyof typeof RuleEvaluationStatus]; - -/** - *Information about the status of the rule evaluation.
* @public */ -export interface DebugRuleEvaluationStatus { - /** - *The name of the rule configuration.
- * @public - */ - RuleConfigurationName?: string | undefined; - - /** - *The Amazon Resource Name (ARN) of the rule evaluation job.
- * @public - */ - RuleEvaluationJobArn?: string | undefined; - +export interface CreateTransformJobRequest { /** - *Status of the rule evaluation.
+ *The name of the transform job. The name must be unique within an Amazon Web Services Region in an + * Amazon Web Services account.
* @public */ - RuleEvaluationStatus?: RuleEvaluationStatus | undefined; + TransformJobName: string | undefined; /** - *Details from the rule evaluation.
+ *The name of the model that you want to use for the transform job.
+ * ModelName must be the name of an existing Amazon SageMaker model within an Amazon Web Services
+ * Region in an Amazon Web Services account.
Timestamp when the rule evaluation status was last modified.
+ *The maximum number of parallel requests that can be sent to each instance in a
+ * transform job. If MaxConcurrentTransforms is set to 0 or left
+ * unset, Amazon SageMaker checks the optional execution-parameters to determine the settings for your
+ * chosen algorithm. If the execution-parameters endpoint is not enabled, the default value
+ * is 1. For more information on execution-parameters, see How Containers Serve Requests. For built-in algorithms, you don't need to
+ * set a value for MaxConcurrentTransforms.
The name of the action to delete.
+ *Configures the timeout and maximum number of retries for processing a transform job + * invocation.
* @public */ - ActionName: string | undefined; -} + ModelClientConfig?: ModelClientConfig | undefined; -/** - * @public - */ -export interface DeleteActionResponse { /** - *The Amazon Resource Name (ARN) of the action.
+ *The maximum allowed size of the payload, in MB. A payload is the
+ * data portion of a record (without metadata). The value in MaxPayloadInMB
+ * must be greater than, or equal to, the size of a single record. To estimate the size of
+ * a record in MB, divide the size of your dataset by the number of records. To ensure that
+ * the records fit within the maximum payload size, we recommend using a slightly larger
+ * value. The default value is 6 MB.
+ *
The value of MaxPayloadInMB cannot be greater than 100 MB. If you specify
+ * the MaxConcurrentTransforms parameter, the value of
+ * (MaxConcurrentTransforms * MaxPayloadInMB) also cannot exceed 100
+ * MB.
For cases where the payload might be arbitrarily large and is transmitted using HTTP
+ * chunked encoding, set the value to 0.
+ * This
+ * feature works only in supported algorithms. Currently, Amazon SageMaker built-in
+ * algorithms do not support HTTP chunked encoding.
The name of the algorithm to delete.
+ *Specifies the number of records to include in a mini-batch for an HTTP inference + * request. A record + * is a single unit of input data that + * inference can be made on. For example, a single line in a CSV file is a record.
+ *To enable the batch strategy, you must set the SplitType property to
+ * Line, RecordIO, or TFRecord.
To use only one record when making an HTTP invocation request to a container, set
+ * BatchStrategy to SingleRecord and SplitType
+ * to Line.
To fit as many records in a mini-batch as can fit within the
+ * MaxPayloadInMB limit, set BatchStrategy to
+ * MultiRecord and SplitType to Line.
The domain ID.
+ *The environment variables to set in the Docker container. Don't include any + * sensitive data in your environment variables. We support up to 16 key and + * values entries in the map.
* @public */ - DomainId: string | undefined; + Environment?: RecordThe user profile name. If this value is not set, then SpaceName must be
- * set.
Describes the input source and + * the + * way the transform job consumes it.
* @public */ - UserProfileName?: string | undefined; + TransformInput: TransformInput | undefined; /** - *The name of the space. If this value is not set, then UserProfileName must be
- * set.
Describes the results of the transform job.
* @public */ - SpaceName?: string | undefined; + TransformOutput: TransformOutput | undefined; /** - *The type of app.
+ *Configuration to control how SageMaker captures inference data.
* @public */ - AppType: AppType | undefined; + DataCaptureConfig?: BatchDataCaptureConfig | undefined; /** - *The name of the app.
+ *Describes the resources, including + * ML + * instance types and ML instance count, to use for the transform + * job.
* @public */ - AppName: string | undefined; -} + TransformResources: TransformResources | undefined; -/** - * @public - */ -export interface DeleteAppImageConfigRequest { /** - *The name of the AppImageConfig to delete.
+ *The data structure used to specify the data to be used for inference in a batch + * transform job and to associate the data that is relevant to the prediction results in + * the output. The input filter provided allows you to exclude input data that is not + * needed for inference in a batch transform job. The output filter provided allows you to + * include input data relevant to interpreting the predictions in the output from the job. + * For more information, see Associate Prediction + * Results with their Corresponding Input Records.
* @public */ - AppImageConfigName: string | undefined; -} + DataProcessing?: DataProcessing | undefined; -/** - * @public - */ -export interface DeleteArtifactRequest { /** - *The Amazon Resource Name (ARN) of the artifact to delete.
+ *(Optional) + * An + * array of key-value pairs. For more information, see Using + * Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User + * Guide.
* @public */ - ArtifactArn?: string | undefined; + Tags?: Tag[] | undefined; /** - *The URI of the source.
+ *Associates a SageMaker job as a trial component with an experiment and trial. Specified when + * you call the following APIs:
+ *+ * CreateProcessingJob + *
+ *+ * CreateTrainingJob + *
+ *+ * CreateTransformJob + *
+ *The Amazon Resource Name (ARN) of the artifact.
+ *The Amazon Resource Name (ARN) of the transform job.
* @public */ - ArtifactArn?: string | undefined; + TransformJobArn: string | undefined; } /** * @public */ -export interface DeleteAssociationRequest { +export interface CreateTrialRequest { /** - *The ARN of the source.
+ *The name of the trial. The name must be unique in your Amazon Web Services account and is not + * case-sensitive.
* @public */ - SourceArn: string | undefined; + TrialName: string | undefined; /** - *The Amazon Resource Name (ARN) of the destination.
+ *The name of the trial as displayed. The name doesn't need to be unique. If
+ * DisplayName isn't specified, TrialName is displayed.
The ARN of the source.
+ *The name of the experiment to associate the trial with.
* @public */ - SourceArn?: string | undefined; + ExperimentName: string | undefined; /** - *The Amazon Resource Name (ARN) of the destination.
+ *Metadata properties of the tracking entity, trial, or trial component.
* @public */ - DestinationArn?: string | undefined; -} + MetadataProperties?: MetadataProperties | undefined; -/** - * @public - */ -export interface DeleteClusterRequest { /** - *The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster to delete.
+ *A list of tags to associate with the trial. You can use Search API to + * search on the tags.
* @public */ - ClusterName: string | undefined; + Tags?: Tag[] | undefined; } /** * @public */ -export interface DeleteClusterResponse { +export interface CreateTrialResponse { /** - *The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster to delete.
+ *The Amazon Resource Name (ARN) of the trial.
* @public */ - ClusterArn: string | undefined; + TrialArn?: string | undefined; } /** + *Represents an input or output artifact of a trial component. You specify
+ * TrialComponentArtifact as part of the InputArtifacts and
+ * OutputArtifacts parameters in the CreateTrialComponent
+ * request.
Examples of input artifacts are datasets, algorithms, hyperparameters, source code, and + * instance types. Examples of output artifacts are metrics, snapshots, logs, and images.
* @public */ -export interface DeleteCodeRepositoryInput { +export interface TrialComponentArtifact { /** - *The name of the Git repository to delete.
+ *The media type of the artifact, which indicates the type of data in the artifact file. The + * media type consists of a type and a subtype + * concatenated with a slash (/) character, for example, text/csv, image/jpeg, and s3/uri. The + * type specifies the category of the media. The subtype specifies the kind of data.
* @public */ - CodeRepositoryName: string | undefined; -} + MediaType?: string | undefined; -/** - * @public - */ -export interface DeleteCompilationJobRequest { /** - *The name of the compilation job to delete.
+ *The location of the artifact.
* @public */ - CompilationJobName: string | undefined; + Value: string | undefined; } /** + *The value of a hyperparameter. Only one of NumberValue or
+ * StringValue can be specified.
This object is specified in the CreateTrialComponent request.
* @public */ -export interface DeleteContextRequest { - /** - *The name of the context to delete.
- * @public - */ - ContextName: string | undefined; -} +export type TrialComponentParameterValue = + | TrialComponentParameterValue.NumberValueMember + | TrialComponentParameterValue.StringValueMember + | TrialComponentParameterValue.$UnknownMember; /** * @public */ -export interface DeleteContextResponse { +export namespace TrialComponentParameterValue { /** - *The Amazon Resource Name (ARN) of the context.
+ *The string value of a categorical hyperparameter. If you specify a value for this
+ * parameter, you can't specify the NumberValue parameter.
The name of the data quality monitoring job definition to delete.
+ *The numeric value of a numeric hyperparameter. If you specify a value for this parameter,
+ * you can't specify the StringValue parameter.
The name of the fleet to delete.
* @public */ - DeviceFleetName: string | undefined; + export interface $UnknownMember { + StringValue?: never; + NumberValue?: never; + $unknown: [string, any]; + } + + export interface VisitorThe retention policy for data stored on an Amazon Elastic File System volume.
- * @public - */ -export interface RetentionPolicy { - /** - *The default is Retain, which specifies to keep the data stored on the
- * Amazon EFS volume.
Specify Delete to delete the data stored on the Amazon EFS
- * volume.
The status of the trial component.
* @public */ -export interface DeleteDomainRequest { +export interface TrialComponentStatus { /** - *The domain ID.
+ *The status of the trial component.
* @public */ - DomainId: string | undefined; + PrimaryStatus?: TrialComponentPrimaryStatus | undefined; /** - *The retention policy for this domain, which specifies whether resources will be retained - * after the Domain is deleted. By default, all resources are retained (not automatically - * deleted).
+ *If the component failed, a message describing why.
* @public */ - RetentionPolicy?: RetentionPolicy | undefined; + Message?: string | undefined; } /** * @public */ -export interface DeleteEdgeDeploymentPlanRequest { +export interface CreateTrialComponentRequest { /** - *The name of the edge deployment plan to delete.
+ *The name of the component. The name must be unique in your Amazon Web Services account and is not + * case-sensitive.
* @public */ - EdgeDeploymentPlanName: string | undefined; -} + TrialComponentName: string | undefined; + + /** + *The name of the component as displayed. The name doesn't need to be unique. If
+ * DisplayName isn't specified, TrialComponentName is
+ * displayed.
The name of the edge deployment plan from which the stage will be deleted.
+ *The status of the component. States include:
+ *InProgress
+ *Completed
+ *Failed
+ *The name of the stage.
+ *When the component started.
* @public */ - StageName: string | undefined; -} + StartTime?: Date | undefined; -/** - * @public - */ -export interface DeleteEndpointInput { /** - *The name of the endpoint that you want to delete.
+ *When the component ended.
* @public */ - EndpointName: string | undefined; -} + EndTime?: Date | undefined; -/** - * @public - */ -export interface DeleteEndpointConfigInput { /** - *The name of the endpoint configuration that you want to delete.
+ *The hyperparameters for the component.
* @public */ - EndpointConfigName: string | undefined; -} + Parameters?: RecordThe name of the experiment to delete.
+ *The input artifacts for the component. Examples of input artifacts are datasets, + * algorithms, hyperparameters, source code, and instance types.
* @public */ - ExperimentName: string | undefined; -} + InputArtifacts?: RecordThe Amazon Resource Name (ARN) of the experiment that is being deleted.
+ *The output artifacts for the component. Examples of output artifacts are metrics, + * snapshots, logs, and images.
* @public */ - ExperimentArn?: string | undefined; -} + OutputArtifacts?: RecordThe name of the FeatureGroup you want to delete. The name must be unique
- * within an Amazon Web Services Region in an Amazon Web Services account.
Metadata properties of the tracking entity, trial, or trial component.
* @public */ - FeatureGroupName: string | undefined; -} + MetadataProperties?: MetadataProperties | undefined; -/** - * @public - */ -export interface DeleteFlowDefinitionRequest { /** - *The name of the flow definition you are deleting.
+ *A list of tags to associate with the component. You can use Search API + * to search on the tags.
* @public */ - FlowDefinitionName: string | undefined; + Tags?: Tag[] | undefined; } /** * @public */ -export interface DeleteFlowDefinitionResponse {} - -/** - * @public - */ -export interface DeleteHubRequest { +export interface CreateTrialComponentResponse { /** - *The name of the hub to delete.
+ *The Amazon Resource Name (ARN) of the trial component.
* @public */ - HubName: string | undefined; + TrialComponentArn?: string | undefined; } -/** - * @public - * @enum - */ -export const HubContentType = { - MODEL: "Model", - MODEL_REFERENCE: "ModelReference", - NOTEBOOK: "Notebook", -} as const; - -/** - * @public - */ -export type HubContentType = (typeof HubContentType)[keyof typeof HubContentType]; - /** * @public */ -export interface DeleteHubContentRequest { - /** - *The name of the hub that you want to delete content in.
- * @public - */ - HubName: string | undefined; - +export interface CreateUserProfileRequest { /** - *The type of content that you want to delete from a hub.
+ *The ID of the associated Domain.
* @public */ - HubContentType: HubContentType | undefined; + DomainId: string | undefined; /** - *The name of the content that you want to delete from a hub.
+ *A name for the UserProfile. This value is not case sensitive.
* @public */ - HubContentName: string | undefined; + UserProfileName: string | undefined; /** - *The version of the content that you want to delete from a hub.
+ *A specifier for the type of value specified in SingleSignOnUserValue. Currently, the only + * supported value is "UserName". If the Domain's AuthMode is IAM Identity Center, this field is + * required. If the Domain's AuthMode is not IAM Identity Center, this field cannot be specified. + *
* @public */ - HubContentVersion: string | undefined; -} + SingleSignOnUserIdentifier?: string | undefined; -/** - * @public - */ -export interface DeleteHubContentReferenceRequest { /** - *The name of the hub to delete the hub content reference from.
+ *The username of the associated Amazon Web Services Single Sign-On User for this + * UserProfile. If the Domain's AuthMode is IAM Identity Center, this field is required, and must + * match a valid username of a user in your directory. If the Domain's AuthMode is not IAM Identity Center, this field cannot be specified.
* @public */ - HubName: string | undefined; + SingleSignOnUserValue?: string | undefined; /** - *The type of hub content reference to delete. The only supported type of hub content reference to delete is ModelReference.
Each tag consists of a key and an optional value. Tag keys must be unique per + * resource.
+ *Tags that you specify for the User Profile are also added to all Apps that the User + * Profile launches.
* @public */ - HubContentType: HubContentType | undefined; + Tags?: Tag[] | undefined; /** - *The name of the hub content to delete.
+ *A collection of settings.
* @public */ - HubContentName: string | undefined; + UserSettings?: UserSettings | undefined; } /** * @public */ -export interface DeleteHumanTaskUiRequest { +export interface CreateUserProfileResponse { /** - *The name of the human task user interface (work task template) you want to delete.
+ *The user profile Amazon Resource Name (ARN).
* @public */ - HumanTaskUiName: string | undefined; + UserProfileArn?: string | undefined; } /** + *Use this parameter to configure your OIDC Identity Provider (IdP).
* @public */ -export interface DeleteHumanTaskUiResponse {} - -/** - * @public - */ -export interface DeleteHyperParameterTuningJobRequest { +export interface OidcConfig { /** - *The name of the hyperparameter tuning job that you want to delete.
+ *The OIDC IdP client ID used to configure your private workforce.
* @public */ - HyperParameterTuningJobName: string | undefined; -} + ClientId: string | undefined; -/** - * @public - */ -export interface DeleteImageRequest { /** - *The name of the image to delete.
+ *The OIDC IdP client secret used to configure your private workforce.
* @public */ - ImageName: string | undefined; -} - -/** - * @public - */ -export interface DeleteImageResponse {} + ClientSecret: string | undefined; -/** - * @public - */ -export interface DeleteImageVersionRequest { /** - *The name of the image to delete.
+ *The OIDC IdP issuer used to configure your private workforce.
* @public */ - ImageName: string | undefined; + Issuer: string | undefined; /** - *The version to delete.
+ *The OIDC IdP authorization endpoint used to configure your private workforce.
* @public */ - Version?: number | undefined; + AuthorizationEndpoint: string | undefined; /** - *The alias of the image to delete.
+ *The OIDC IdP token endpoint used to configure your private workforce.
* @public */ - Alias?: string | undefined; -} - -/** - * @public - */ -export interface DeleteImageVersionResponse {} + TokenEndpoint: string | undefined; -/** - * @public - */ -export interface DeleteInferenceComponentInput { /** - *The name of the inference component to delete.
+ *The OIDC IdP user information endpoint used to configure your private workforce.
* @public */ - InferenceComponentName: string | undefined; -} + UserInfoEndpoint: string | undefined; -/** - * @public - */ -export interface DeleteInferenceExperimentRequest { /** - *The name of the inference experiment you want to delete.
+ *The OIDC IdP logout endpoint used to configure your private workforce.
* @public */ - Name: string | undefined; -} + LogoutEndpoint: string | undefined; -/** - * @public - */ -export interface DeleteInferenceExperimentResponse { /** - *The ARN of the deleted inference experiment.
+ *The OIDC IdP JSON Web Key Set (Jwks) URI used to configure your private workforce.
* @public */ - InferenceExperimentArn: string | undefined; -} + JwksUri: string | undefined; -/** - * @public - */ -export interface DeleteMlflowTrackingServerRequest { /** - *The name of the the tracking server to delete.
+ *An array of string identifiers used to refer to the specific pieces of user data or claims that the client application wants to access.
* @public */ - TrackingServerName: string | undefined; -} + Scope?: string | undefined; -/** - * @public - */ -export interface DeleteMlflowTrackingServerResponse { /** - *A TrackingServerArn object, the ARN of the tracking server that is deleted if
- * successfully found.
A string to string map of identifiers specific to the custom identity provider (IdP) being used.
* @public */ - TrackingServerArn?: string | undefined; + AuthenticationRequestExtraParams?: RecordA list of IP address ranges (CIDRs). Used to create an allow + * list of IP addresses for a private workforce. Workers will only be able to log in to their worker portal from an + * IP address within this range. By default, a workforce isn't restricted to specific IP addresses.
* @public */ -export interface DeleteModelInput { +export interface SourceIpConfig { /** - *The name of the model to delete.
+ *A list of one to ten Classless Inter-Domain Routing (CIDR) values.
+ *Maximum: Ten CIDR values
+ *The following Length Constraints apply to individual CIDR values in + * the CIDR value list.
+ *The VPC object you use to create or update a workforce.
* @public */ -export interface DeleteModelBiasJobDefinitionRequest { +export interface WorkforceVpcConfigRequest { /** - *The name of the model bias job definition to delete.
+ *The ID of the VPC that the workforce uses for communication.
* @public */ - JobDefinitionName: string | undefined; -} + VpcId?: string | undefined; -/** - * @public - */ -export interface DeleteModelCardRequest { /** - *The name of the model card to delete.
+ *The VPC security group IDs, in the form sg-xxxxxxxx. The security groups must be for the same VPC as specified in the subnet.
The name of the model explainability job definition to delete.
+ *The ID of the subnets in the VPC that you want to connect.
* @public */ - JobDefinitionName: string | undefined; + Subnets?: string[] | undefined; } /** * @public */ -export interface DeleteModelPackageInput { +export interface CreateWorkforceRequest { /** - *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).
+ *Use this parameter to configure an Amazon Cognito private workforce. + * A single Cognito workforce is created using and corresponds to a single + * + * Amazon Cognito user pool.
+ *Do not use OidcConfig if you specify values for
+ * CognitoConfig.
The name of the model group to delete.
+ *Use this parameter to configure a private workforce using your own OIDC Identity Provider.
+ *Do not use CognitoConfig if you specify values for
+ * OidcConfig.
The name of the model group for which to delete the policy.
+ *A list of IP address ranges (CIDRs). Used to create an allow + * list of IP addresses for a private workforce. Workers will only be able to log in to their worker portal from an + * IP address within this range. By default, a workforce isn't restricted to specific IP addresses.
* @public */ - ModelPackageGroupName: string | undefined; -} + SourceIpConfig?: SourceIpConfig | undefined; -/** - * @public - */ -export interface DeleteModelQualityJobDefinitionRequest { /** - *The name of the model quality monitoring job definition to delete.
+ *The name of the private workforce.
* @public */ - JobDefinitionName: string | undefined; -} + WorkforceName: string | undefined; -/** - * @public - */ -export interface DeleteMonitoringScheduleRequest { /** - *The name of the monitoring schedule to delete.
+ *An array of key-value pairs that contain metadata to help you categorize and + * organize our workforce. Each tag consists of a key and a value, + * both of which you define.
* @public */ - MonitoringScheduleName: string | undefined; -} + Tags?: Tag[] | undefined; -/** - * @public - */ -export interface DeleteNotebookInstanceInput { /** - *The name of the SageMaker notebook instance to delete.
+ *Use this parameter to configure a workforce using VPC.
* @public */ - NotebookInstanceName: string | undefined; + WorkforceVpcConfig?: WorkforceVpcConfigRequest | undefined; } /** * @public */ -export interface DeleteNotebookInstanceLifecycleConfigInput { +export interface CreateWorkforceResponse { /** - *The name of the lifecycle configuration to delete.
+ *The Amazon Resource Name (ARN) of the workforce.
* @public */ - NotebookInstanceLifecycleConfigName: string | undefined; + WorkforceArn: string | undefined; } /** + *A list of user groups that exist in your OIDC Identity Provider (IdP).
+ * One to ten groups can be used to create a single private work team.
+ * When you add a user group to the list of Groups, you can add that user group to one or more
+ * private work teams. If you add a user group to a private work team, all workers in that user group
+ * are added to the work team.
The name that you assigned to the optimization job.
+ *A list of comma seperated strings that identifies + * user groups in your OIDC IdP. Each user group is + * made up of a group of private workers.
* @public */ - OptimizationJobName: string | undefined; + Groups?: string[] | undefined; } /** + *Defines an Amazon Cognito or your own OIDC IdP user group that is part of a work team.
* @public */ -export interface DeletePipelineRequest { +export interface MemberDefinition { /** - *The name of the pipeline to delete.
+ *The Amazon Cognito user group that is part of the work team.
* @public */ - PipelineName: string | undefined; + CognitoMemberDefinition?: CognitoMemberDefinition | undefined; /** - *A unique, case-sensitive identifier that you provide to ensure the idempotency of the - * operation. An idempotent operation completes no more than one time.
+ *A list user groups that exist in your OIDC Identity Provider (IdP).
+ * One to ten groups can be used to create a single private work team.
+ * When you add a user group to the list of Groups, you can add that user group to one or more
+ * private work teams. If you add a user group to a private work team, all workers in that user group
+ * are added to the work team.
Configures Amazon SNS notifications of available or expiring work items for work + * teams.
* @public */ -export interface DeletePipelineResponse { +export interface NotificationConfiguration { /** - *The Amazon Resource Name (ARN) of the pipeline to delete.
+ *The ARN for the Amazon SNS topic to which notifications should be published.
* @public */ - PipelineArn?: string | undefined; + NotificationTopicArn?: string | undefined; } /** * @public + * @enum */ -export interface DeleteProjectInput { - /** - *The name of the project to delete.
- * @public - */ - ProjectName: string | undefined; -} +export const EnabledOrDisabled = { + Disabled: "Disabled", + Enabled: "Enabled", +} as const; /** * @public */ -export interface DeleteSpaceRequest { +export type EnabledOrDisabled = (typeof EnabledOrDisabled)[keyof typeof EnabledOrDisabled]; + +/** + *Use this parameter to specify a supported global condition key that is added to the IAM policy.
+ * @public + */ +export interface IamPolicyConstraints { /** - *The ID of the associated domain.
+ *When SourceIp is Enabled the worker's IP address when a task is rendered in the worker portal is added to the IAM policy as a Condition used to generate the Amazon S3 presigned URL. This IP address is checked by Amazon S3 and must match in order for the Amazon S3 resource to be rendered in the worker portal.
The name of the space.
+ *When VpcSourceIp is Enabled the worker's IP address when a task is rendered in private worker portal inside the VPC is added to the IAM policy as a Condition used to generate the Amazon S3 presigned URL. To render the task successfully Amazon S3 checks that the presigned URL is being accessed over an Amazon S3 VPC Endpoint, and that the worker's IP address matches the IP address in the IAM policy. To learn more about configuring private worker portal, see Use Amazon VPC mode from a private worker portal.
This object defines the access restrictions to Amazon S3 resources that are included in custom worker task templates using the Liquid filter, grant_read_access.
To learn more about how custom templates are created, see Create custom worker task templates.
* @public */ -export interface DeleteStudioLifecycleConfigRequest { +export interface S3Presign { /** - *The name of the Amazon SageMaker Studio Lifecycle Configuration to delete.
+ *Use this parameter to specify the allowed request source. Possible sources are either SourceIp or VpcSourceIp.
Use this optional parameter to constrain access to an Amazon S3 resource based on the IP address using supported IAM global condition keys. The Amazon S3 resource is accessed in the worker portal using a Amazon S3 presigned URL.
* @public */ -export interface DeleteTagsInput { - /** - *The Amazon Resource Name (ARN) of the resource whose tags you want to - * delete.
- * @public - */ - ResourceArn: string | undefined; - +export interface WorkerAccessConfiguration { /** - *An array or one or more tag keys to delete.
+ *Defines any Amazon S3 resource constraints.
* @public */ - TagKeys: string[] | undefined; + S3Presign?: S3Presign | undefined; } /** * @public */ -export interface DeleteTagsOutput {} +export interface CreateWorkteamRequest { + /** + *The name of the work team. Use this name to identify the work team.
+ * @public + */ + WorkteamName: string | undefined; -/** - * @public - */ -export interface DeleteTrialRequest { /** - *The name of the trial to delete.
+ *The name of the workforce.
* @public */ - TrialName: string | undefined; -} + WorkforceName?: string | undefined; -/** - * @public - */ -export interface DeleteTrialResponse { /** - *The Amazon Resource Name (ARN) of the trial that is being deleted.
+ *A list of MemberDefinition objects that contains objects that identify
+ * the workers that make up the work team.
Workforces can be created using Amazon Cognito or your own OIDC Identity Provider (IdP). For
+ * private workforces created using Amazon Cognito use CognitoMemberDefinition. For
+ * workforces created using your own OIDC identity provider (IdP) use
+ * OidcMemberDefinition. Do not provide input for both of these parameters
+ * in a single request.
For workforces created using Amazon Cognito, private work teams correspond to Amazon Cognito
+ * user groups within the user pool used to create a workforce. All of the
+ * CognitoMemberDefinition objects that make up the member definition must
+ * have the same ClientId and UserPool values. To add a Amazon
+ * Cognito user group to an existing worker pool, see Adding groups to a User
+ * Pool. For more information about user pools, see Amazon Cognito User
+ * Pools.
For workforces created using your own OIDC IdP, specify the user groups that you want to
+ * include in your private work team in OidcMemberDefinition by listing those groups
+ * in Groups.
The name of the component to delete.
+ *A description of the work team.
* @public */ - TrialComponentName: string | undefined; -} + Description: string | undefined; -/** - * @public - */ -export interface DeleteTrialComponentResponse { /** - *The Amazon Resource Name (ARN) of the component is being deleted.
+ *Configures notification of workers regarding available or expiring work items.
* @public */ - TrialComponentArn?: string | undefined; -} + NotificationConfiguration?: NotificationConfiguration | undefined; -/** - * @public - */ -export interface DeleteUserProfileRequest { /** - *The domain ID.
+ *Use this optional parameter to constrain access to an Amazon S3 resource based on the IP address using supported IAM global condition keys. The Amazon S3 resource is accessed in the worker portal using a Amazon S3 presigned URL.
* @public */ - DomainId: string | undefined; + WorkerAccessConfiguration?: WorkerAccessConfiguration | undefined; /** - *The user profile name.
+ *An array of key-value pairs.
+ *For more information, see Resource + * Tag and Using + * Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User + * Guide.
* @public */ - UserProfileName: string | undefined; + Tags?: Tag[] | undefined; } /** * @public */ -export interface DeleteWorkforceRequest { +export interface CreateWorkteamResponse { /** - *The name of the workforce.
+ *The Amazon Resource Name (ARN) of the work team. You can use this ARN to identify the + * work team.
* @public */ - WorkforceName: string | undefined; + WorkteamArn?: string | undefined; } /** * @public + * @enum */ -export interface DeleteWorkforceResponse {} +export const CrossAccountFilterOption = { + CROSS_ACCOUNT: "CrossAccount", + SAME_ACCOUNT: "SameAccount", +} as const; /** * @public */ -export interface DeleteWorkteamRequest { - /** - *The name of the work team to delete.
- * @public - */ - WorkteamName: string | undefined; -} +export type CrossAccountFilterOption = (typeof CrossAccountFilterOption)[keyof typeof CrossAccountFilterOption]; /** * @public + * @enum */ -export interface DeleteWorkteamResponse { - /** - *Returns true if the work team was successfully deleted; otherwise,
- * returns false.
Gets the Amazon EC2 Container Registry path of the docker image of the model that is hosted in this ProductionVariant.
- *If you used the registry/repository[:tag] form to specify the image path
- * of the primary container when you created the model hosted in this
- * ProductionVariant, the path resolves to a path of the form
- * registry/repository[@digest]. A digest is a hash value that identifies
- * a specific version of an image. For information about Amazon ECR paths, see Pulling an Image in the Amazon ECR User Guide.
A customized metric.
+ * @public + */ +export interface CustomizedMetricSpecification { /** - *The image path you specified when you created the model.
+ *The name of the customized metric.
* @public */ - SpecifiedImage?: string | undefined; + MetricName?: string | undefined; /** - *The specific digest path of the image hosted in this
- * ProductionVariant.
The namespace of the customized metric.
* @public */ - ResolvedImage?: string | undefined; + Namespace?: string | undefined; /** - *The date and time when the image path for the model resolved to the
- * ResolvedImage
- *
The statistic of the customized metric.
* @public */ - ResolutionTime?: Date | undefined; + Statistic?: Statistic | undefined; } /** - *The recommended configuration to use for Real-Time Inference.
+ *The currently active data capture configuration used by your Endpoint.
* @public */ -export interface RealTimeInferenceRecommendation { +export interface DataCaptureConfigSummary { /** - *The recommendation ID which uniquely identifies each recommendation.
+ *Whether data capture is enabled or disabled.
* @public */ - RecommendationId: string | undefined; + EnableCapture: boolean | undefined; /** - *The recommended instance type for Real-Time Inference.
+ *Whether data capture is currently functional.
* @public */ - InstanceType: ProductionVariantInstanceType | undefined; + CaptureStatus: CaptureStatus | undefined; /** - *The recommended environment variables to set in the model container for Real-Time Inference.
+ *The percentage of requests being captured by your Endpoint.
* @public */ - Environment?: RecordThe Amazon S3 location being used to capture the data.
+ * @public + */ + DestinationS3Uri: string | undefined; + + /** + *The KMS key being used to encrypt the data in Amazon S3.
+ * @public + */ + KmsKeyId: string | undefined; } /** * @public * @enum */ -export const RecommendationStatus = { - COMPLETED: "COMPLETED", - FAILED: "FAILED", - IN_PROGRESS: "IN_PROGRESS", - NOT_APPLICABLE: "NOT_APPLICABLE", +export const RuleEvaluationStatus = { + ERROR: "Error", + IN_PROGRESS: "InProgress", + ISSUES_FOUND: "IssuesFound", + NO_ISSUES_FOUND: "NoIssuesFound", + STOPPED: "Stopped", + STOPPING: "Stopping", } as const; /** * @public */ -export type RecommendationStatus = (typeof RecommendationStatus)[keyof typeof RecommendationStatus]; +export type RuleEvaluationStatus = (typeof RuleEvaluationStatus)[keyof typeof RuleEvaluationStatus]; /** - *A set of recommended deployment configurations for the model. To get more advanced recommendations, see - * CreateInferenceRecommendationsJob - * to create an inference recommendation job.
+ *Information about the status of the rule evaluation.
* @public */ -export interface DeploymentRecommendation { +export interface DebugRuleEvaluationStatus { /** - *Status of the deployment recommendation. The status NOT_APPLICABLE means that SageMaker
- * is unable to provide a default recommendation for the model using the information provided. If the deployment status is IN_PROGRESS,
- * retry your API call after a few seconds to get a COMPLETED deployment recommendation.
The name of the rule configuration.
* @public */ - RecommendationStatus: RecommendationStatus | undefined; + RuleConfigurationName?: string | undefined; /** - *A list of RealTimeInferenceRecommendation items.
+ *The Amazon Resource Name (ARN) of the rule evaluation job.
* @public */ - RealTimeInferenceRecommendations?: RealTimeInferenceRecommendation[] | undefined; + RuleEvaluationJobArn?: string | undefined; + + /** + *Status of the rule evaluation.
+ * @public + */ + RuleEvaluationStatus?: RuleEvaluationStatus | undefined; + + /** + *Details from the rule evaluation.
+ * @public + */ + StatusDetails?: string | undefined; + + /** + *Timestamp when the rule evaluation status was last modified.
+ * @public + */ + LastModifiedTime?: Date | undefined; } /** * @public - * @enum */ -export const StageStatus = { - Creating: "CREATING", - Deployed: "DEPLOYED", - Failed: "FAILED", - InProgress: "INPROGRESS", - ReadyToDeploy: "READYTODEPLOY", - Starting: "STARTING", - Stopped: "STOPPED", - Stopping: "STOPPING", -} as const; +export interface DeleteActionRequest { + /** + *The name of the action to delete.
+ * @public + */ + ActionName: string | undefined; +} /** * @public */ -export type StageStatus = (typeof StageStatus)[keyof typeof StageStatus]; +export interface DeleteActionResponse { + /** + *The Amazon Resource Name (ARN) of the action.
+ * @public + */ + ActionArn?: string | undefined; +} /** - *Contains information summarizing the deployment stage results.
* @public */ -export interface EdgeDeploymentStatus { +export interface DeleteAlgorithmInput { /** - *The general status of the current stage.
+ *The name of the algorithm to delete.
* @public */ - StageStatus: StageStatus | undefined; + AlgorithmName: string | undefined; +} +/** + * @public + */ +export interface DeleteAppRequest { /** - *The number of edge devices with the successful deployment in the current stage.
+ *The domain ID.
* @public */ - EdgeDeploymentSuccessInStage: number | undefined; + DomainId: string | undefined; /** - *The number of edge devices yet to pick up the deployment in current stage, or in - * progress.
+ *The user profile name. If this value is not set, then SpaceName must be
+ * set.
The number of edge devices that failed the deployment in current stage.
+ *The name of the space. If this value is not set, then UserProfileName must be
+ * set.
A detailed message about deployment status in current stage.
+ *The type of app.
* @public */ - EdgeDeploymentStatusMessage?: string | undefined; + AppType: AppType | undefined; /** - *The time when the deployment API started.
+ *The name of the app.
* @public */ - EdgeDeploymentStageStartTime?: Date | undefined; + AppName: string | undefined; } /** - *Contains information summarizing the deployment stage results.
* @public */ -export interface DeploymentStageStatusSummary { +export interface DeleteAppImageConfigRequest { /** - *The name of the stage.
+ *The name of the AppImageConfig to delete.
* @public */ - StageName: string | undefined; + AppImageConfigName: string | undefined; +} + +/** + * @public + */ +export interface DeleteArtifactRequest { + /** + *The Amazon Resource Name (ARN) of the artifact to delete.
+ * @public + */ + ArtifactArn?: string | undefined; /** - *Configuration of the devices in the stage.
+ *The URI of the source.
* @public */ - DeviceSelectionConfig: DeviceSelectionConfig | undefined; + Source?: ArtifactSource | undefined; +} +/** + * @public + */ +export interface DeleteArtifactResponse { /** - *Configuration of the deployment details.
+ *The Amazon Resource Name (ARN) of the artifact.
* @public */ - DeploymentConfig: EdgeDeploymentConfig | undefined; + ArtifactArn?: string | undefined; +} + +/** + * @public + */ +export interface DeleteAssociationRequest { + /** + *The ARN of the source.
+ * @public + */ + SourceArn: string | undefined; /** - *General status of the current state.
+ *The Amazon Resource Name (ARN) of the destination.
* @public */ - DeploymentStatus: EdgeDeploymentStatus | undefined; + DestinationArn: string | undefined; } /** * @public */ -export interface DeregisterDevicesRequest { +export interface DeleteAssociationResponse { /** - *The name of the fleet the devices belong to.
+ *The ARN of the source.
* @public */ - DeviceFleetName: string | undefined; + SourceArn?: string | undefined; /** - *The unique IDs of the devices.
+ *The Amazon Resource Name (ARN) of the destination.
* @public */ - DeviceNames: string[] | undefined; + DestinationArn?: string | undefined; } /** - *Information that SageMaker Neo automatically derived about the model.
* @public */ -export interface DerivedInformation { +export interface DeleteClusterRequest { /** - *The data input configuration that SageMaker Neo automatically derived for the model. - * When SageMaker Neo derives this information, you don't need to specify the data input - * configuration when you create a compilation job.
+ *The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster to delete.
* @public */ - DerivedDataInputConfig?: string | undefined; + ClusterName: string | undefined; } /** * @public */ -export interface DescribeActionRequest { +export interface DeleteClusterResponse { /** - *The name of the action to describe.
+ *The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster to delete.
* @public */ - ActionName: string | undefined; + ClusterArn: string | undefined; } /** * @public */ -export interface DescribeActionResponse { +export interface DeleteClusterSchedulerConfigRequest { /** - *The name of the action.
+ *ID of the cluster policy.
* @public */ - ActionName?: string | undefined; + ClusterSchedulerConfigId: string | undefined; +} +/** + * @public + */ +export interface DeleteCodeRepositoryInput { /** - *The Amazon Resource Name (ARN) of the action.
+ *The name of the Git repository to delete.
* @public */ - ActionArn?: string | undefined; + CodeRepositoryName: string | undefined; +} +/** + * @public + */ +export interface DeleteCompilationJobRequest { /** - *The source of the action.
+ *The name of the compilation job to delete.
* @public */ - Source?: ActionSource | undefined; + CompilationJobName: string | undefined; +} +/** + * @public + */ +export interface DeleteComputeQuotaRequest { /** - *The type of the action.
+ *ID of the compute allocation definition.
* @public */ - ActionType?: string | undefined; + ComputeQuotaId: string | undefined; +} +/** + * @public + */ +export interface DeleteContextRequest { /** - *The description of the action.
+ *The name of the context to delete.
* @public */ - Description?: string | undefined; + ContextName: string | undefined; +} +/** + * @public + */ +export interface DeleteContextResponse { /** - *The status of the action.
+ *The Amazon Resource Name (ARN) of the context.
* @public */ - Status?: ActionStatus | undefined; + ContextArn?: string | undefined; +} +/** + * @public + */ +export interface DeleteDataQualityJobDefinitionRequest { /** - *A list of the action's properties.
+ *The name of the data quality monitoring job definition to delete.
* @public */ - Properties?: RecordWhen the action was created.
+ *The name of the fleet to delete.
* @public */ - CreationTime?: Date | undefined; + DeviceFleetName: string | undefined; +} - /** - *Information about the user who created or modified an experiment, trial, trial - * component, lineage group, project, or model card.
- * @public - */ - CreatedBy?: UserContext | undefined; +/** + * @public + * @enum + */ +export const RetentionType = { + Delete: "Delete", + Retain: "Retain", +} as const; - /** - *When the action was last modified.
- * @public - */ - LastModifiedTime?: Date | undefined; +/** + * @public + */ +export type RetentionType = (typeof RetentionType)[keyof typeof RetentionType]; +/** + *The retention policy for data stored on an Amazon Elastic File System volume.
+ * @public + */ +export interface RetentionPolicy { /** - *Information about the user who created or modified an experiment, trial, trial - * component, lineage group, project, or model card.
+ *The default is Retain, which specifies to keep the data stored on the
+ * Amazon EFS volume.
Specify Delete to delete the data stored on the Amazon EFS
+ * volume.
Metadata properties of the tracking entity, trial, or trial component.
+ *The domain ID.
* @public */ - MetadataProperties?: MetadataProperties | undefined; + DomainId: string | undefined; /** - *The Amazon Resource Name (ARN) of the lineage group.
+ *The retention policy for this domain, which specifies whether resources will be retained + * after the Domain is deleted. By default, all resources are retained (not automatically + * deleted).
* @public */ - LineageGroupArn?: string | undefined; + RetentionPolicy?: RetentionPolicy | undefined; } /** * @public */ -export interface DescribeAlgorithmInput { +export interface DeleteEdgeDeploymentPlanRequest { /** - *The name of the algorithm to describe.
+ *The name of the edge deployment plan to delete.
* @public */ - AlgorithmName: string | undefined; + EdgeDeploymentPlanName: string | undefined; } /** * @public */ -export interface DescribeAlgorithmOutput { - /** - *The name of the algorithm being described.
- * @public - */ - AlgorithmName: string | undefined; - +export interface DeleteEdgeDeploymentStageRequest { /** - *The Amazon Resource Name (ARN) of the algorithm.
+ *The name of the edge deployment plan from which the stage will be deleted.
* @public */ - AlgorithmArn: string | undefined; + EdgeDeploymentPlanName: string | undefined; /** - *A brief summary about the algorithm.
+ *The name of the stage.
* @public */ - AlgorithmDescription?: string | undefined; + StageName: string | undefined; +} +/** + * @public + */ +export interface DeleteEndpointInput { /** - *A timestamp specifying when the algorithm was created.
+ *The name of the endpoint that you want to delete.
* @public */ - CreationTime: Date | undefined; + EndpointName: string | undefined; +} +/** + * @public + */ +export interface DeleteEndpointConfigInput { /** - *Details about training jobs run by this algorithm.
+ *The name of the endpoint configuration that you want to delete.
* @public */ - TrainingSpecification: TrainingSpecification | undefined; + EndpointConfigName: string | undefined; +} +/** + * @public + */ +export interface DeleteExperimentRequest { /** - *Details about inference jobs that the algorithm runs.
+ *The name of the experiment to delete.
* @public */ - InferenceSpecification?: InferenceSpecification | undefined; + ExperimentName: string | undefined; +} +/** + * @public + */ +export interface DeleteExperimentResponse { /** - *Details about configurations for one or more training jobs that SageMaker runs to test the - * algorithm.
+ *The Amazon Resource Name (ARN) of the experiment that is being deleted.
* @public */ - ValidationSpecification?: AlgorithmValidationSpecification | undefined; + ExperimentArn?: string | undefined; +} +/** + * @public + */ +export interface DeleteFeatureGroupRequest { /** - *The current status of the algorithm.
+ *The name of the FeatureGroup you want to delete. The name must be unique
+ * within an Amazon Web Services Region in an Amazon Web Services account.
Details about the current status of the algorithm.
+ *The name of the flow definition you are deleting.
* @public */ - AlgorithmStatusDetails: AlgorithmStatusDetails | undefined; + FlowDefinitionName: string | undefined; +} - /** - *The product identifier of the algorithm.
- * @public - */ - ProductId?: string | undefined; +/** + * @public + */ +export interface DeleteFlowDefinitionResponse {} +/** + * @public + */ +export interface DeleteHubRequest { /** - *Whether the algorithm is certified to be listed in Amazon Web Services - * Marketplace.
+ *The name of the hub to delete.
* @public */ - CertifyForMarketplace?: boolean | undefined; + HubName: string | undefined; } +/** + * @public + * @enum + */ +export const HubContentType = { + MODEL: "Model", + MODEL_REFERENCE: "ModelReference", + NOTEBOOK: "Notebook", +} as const; + /** * @public */ -export interface DescribeAppRequest { - /** - *The domain ID.
- * @public - */ - DomainId: string | undefined; +export type HubContentType = (typeof HubContentType)[keyof typeof HubContentType]; +/** + * @public + */ +export interface DeleteHubContentRequest { /** - *The user profile name. If this value is not set, then SpaceName must be
- * set.
The name of the hub that you want to delete content in.
* @public */ - UserProfileName?: string | undefined; + HubName: string | undefined; /** - *The name of the space.
+ *The type of content that you want to delete from a hub.
* @public */ - SpaceName?: string | undefined; + HubContentType: HubContentType | undefined; /** - *The type of app.
+ *The name of the content that you want to delete from a hub.
* @public */ - AppType: AppType | undefined; + HubContentName: string | undefined; /** - *The name of the app.
+ *The version of the content that you want to delete from a hub.
* @public */ - AppName: string | undefined; + HubContentVersion: string | undefined; } /** * @public */ -export interface DescribeAppResponse { +export interface DeleteHubContentReferenceRequest { /** - *The Amazon Resource Name (ARN) of the app.
+ *The name of the hub to delete the hub content reference from.
* @public */ - AppArn?: string | undefined; + HubName: string | undefined; /** - *The type of app.
+ *The type of hub content reference to delete. The only supported type of hub content reference to delete is ModelReference.
The name of the app.
+ *The name of the hub content to delete.
* @public */ - AppName?: string | undefined; + HubContentName: string | undefined; +} +/** + * @public + */ +export interface DeleteHumanTaskUiRequest { /** - *The domain ID.
+ *The name of the human task user interface (work task template) you want to delete.
* @public */ - DomainId?: string | undefined; + HumanTaskUiName: string | undefined; +} + +/** + * @public + */ +export interface DeleteHumanTaskUiResponse {} +/** + * @public + */ +export interface DeleteHyperParameterTuningJobRequest { /** - *The user profile name.
+ *The name of the hyperparameter tuning job that you want to delete.
* @public */ - UserProfileName?: string | undefined; + HyperParameterTuningJobName: string | undefined; +} +/** + * @public + */ +export interface DeleteImageRequest { /** - *The name of the space. If this value is not set, then UserProfileName must be
- * set.
The name of the image to delete.
* @public */ - SpaceName?: string | undefined; + ImageName: string | undefined; +} + +/** + * @public + */ +export interface DeleteImageResponse {} +/** + * @public + */ +export interface DeleteImageVersionRequest { /** - *The status.
+ *The name of the image to delete.
* @public */ - Status?: AppStatus | undefined; + ImageName: string | undefined; /** - *The timestamp of the last health check.
+ *The version to delete.
* @public */ - LastHealthCheckTimestamp?: Date | undefined; + Version?: number | undefined; /** - *The timestamp of the last user's activity. LastUserActivityTimestamp is also
- * updated when SageMaker performs health checks without user activity. As a result, this
- * value is set to the same value as LastHealthCheckTimestamp.
The alias of the image to delete.
* @public */ - LastUserActivityTimestamp?: Date | undefined; + Alias?: string | undefined; +} + +/** + * @public + */ +export interface DeleteImageVersionResponse {} +/** + * @public + */ +export interface DeleteInferenceComponentInput { /** - *The creation time of the application.
- *After an application has been shut down for 24 hours, SageMaker deletes all - * metadata for the application. To be considered an update and retain application metadata, - * applications must be restarted within 24 hours after the previous application has been shut - * down. After this time window, creation of an application is considered a new application - * rather than an update of the previous application.
- *The name of the inference component to delete.
* @public */ - CreationTime?: Date | undefined; + InferenceComponentName: string | undefined; +} +/** + * @public + */ +export interface DeleteInferenceExperimentRequest { /** - *The failure reason.
+ *The name of the inference experiment you want to delete.
* @public */ - FailureReason?: string | undefined; + Name: string | undefined; +} +/** + * @public + */ +export interface DeleteInferenceExperimentResponse { /** - *The instance type and the Amazon Resource Name (ARN) of the SageMaker image - * created on the instance.
+ *The ARN of the deleted inference experiment.
* @public */ - ResourceSpec?: ResourceSpec | undefined; + InferenceExperimentArn: string | undefined; +} +/** + * @public + */ +export interface DeleteMlflowTrackingServerRequest { /** - *The lifecycle configuration that runs before the default lifecycle configuration
+ *The name of the the tracking server to delete.
* @public */ - BuiltInLifecycleConfigArn?: string | undefined; + TrackingServerName: string | undefined; } /** * @public */ -export interface DescribeAppImageConfigRequest { +export interface DeleteMlflowTrackingServerResponse { /** - *The name of the AppImageConfig to describe.
+ *A TrackingServerArn object, the ARN of the tracking server that is deleted if
+ * successfully found.
The ARN of the AppImageConfig.
+ *The name of the model to delete.
* @public */ - AppImageConfigArn?: string | undefined; + ModelName: string | undefined; +} +/** + * @public + */ +export interface DeleteModelBiasJobDefinitionRequest { /** - *The name of the AppImageConfig.
+ *The name of the model bias job definition to delete.
* @public */ - AppImageConfigName?: string | undefined; + JobDefinitionName: string | undefined; +} +/** + * @public + */ +export interface DeleteModelCardRequest { /** - *When the AppImageConfig was created.
+ *The name of the model card to delete.
* @public */ - CreationTime?: Date | undefined; + ModelCardName: string | undefined; +} +/** + * @public + */ +export interface DeleteModelExplainabilityJobDefinitionRequest { /** - *When the AppImageConfig was last modified.
+ *The name of the model explainability job definition to delete.
* @public */ - LastModifiedTime?: Date | undefined; + JobDefinitionName: string | undefined; +} +/** + * @public + */ +export interface DeleteModelPackageInput { /** - *The configuration of a KernelGateway app.
+ *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).
* @public */ - KernelGatewayImageConfig?: KernelGatewayImageConfig | undefined; + ModelPackageName: string | undefined; +} +/** + * @public + */ +export interface DeleteModelPackageGroupInput { /** - *The configuration of the JupyterLab app.
+ *The name of the model group to delete.
* @public */ - JupyterLabAppImageConfig?: JupyterLabAppImageConfig | undefined; + ModelPackageGroupName: string | undefined; +} +/** + * @public + */ +export interface DeleteModelPackageGroupPolicyInput { /** - *The configuration of the Code Editor app.
+ *The name of the model group for which to delete the policy.
* @public */ - CodeEditorAppImageConfig?: CodeEditorAppImageConfig | undefined; + ModelPackageGroupName: string | undefined; } /** * @public */ -export interface DescribeArtifactRequest { +export interface DeleteModelQualityJobDefinitionRequest { /** - *The Amazon Resource Name (ARN) of the artifact to describe.
+ *The name of the model quality monitoring job definition to delete.
* @public */ - ArtifactArn: string | undefined; + JobDefinitionName: string | undefined; } /** * @public */ -export interface DescribeArtifactResponse { +export interface DeleteMonitoringScheduleRequest { /** - *The name of the artifact.
+ *The name of the monitoring schedule to delete.
* @public */ - ArtifactName?: string | undefined; + MonitoringScheduleName: string | undefined; +} +/** + * @public + */ +export interface DeleteNotebookInstanceInput { /** - *The Amazon Resource Name (ARN) of the artifact.
+ *The name of the SageMaker notebook instance to delete.
* @public */ - ArtifactArn?: string | undefined; + NotebookInstanceName: string | undefined; +} +/** + * @public + */ +export interface DeleteNotebookInstanceLifecycleConfigInput { /** - *The source of the artifact.
+ *The name of the lifecycle configuration to delete.
* @public */ - Source?: ArtifactSource | undefined; + NotebookInstanceLifecycleConfigName: string | undefined; +} +/** + * @public + */ +export interface DeleteOptimizationJobRequest { /** - *The type of the artifact.
+ *The name that you assigned to the optimization job.
* @public */ - ArtifactType?: string | undefined; + OptimizationJobName: string | undefined; +} +/** + * @public + */ +export interface DeletePartnerAppRequest { /** - *A list of the artifact's properties.
+ *The ARN of the SageMaker Partner AI App to delete.
* @public */ - Properties?: RecordWhen the artifact was created.
+ *A unique token that guarantees that the call to this API is idempotent.
* @public */ - CreationTime?: Date | undefined; + ClientToken?: string | undefined; +} +/** + * @public + */ +export interface DeletePartnerAppResponse { /** - *Information about the user who created or modified an experiment, trial, trial - * component, lineage group, project, or model card.
+ *The ARN of the SageMaker Partner AI App that was deleted.
* @public */ - CreatedBy?: UserContext | undefined; + Arn?: string | undefined; +} +/** + * @public + */ +export interface DeletePipelineRequest { /** - *When the artifact was last modified.
+ *The name of the pipeline to delete.
* @public */ - LastModifiedTime?: Date | undefined; + PipelineName: string | undefined; /** - *Information about the user who created or modified an experiment, trial, trial - * component, lineage group, project, or model card.
+ *A unique, case-sensitive identifier that you provide to ensure the idempotency of the + * operation. An idempotent operation completes no more than one time.
* @public */ - LastModifiedBy?: UserContext | undefined; + ClientRequestToken?: string | undefined; +} +/** + * @public + */ +export interface DeletePipelineResponse { /** - *Metadata properties of the tracking entity, trial, or trial component.
+ *The Amazon Resource Name (ARN) of the pipeline to delete.
* @public */ - MetadataProperties?: MetadataProperties | undefined; + PipelineArn?: string | undefined; +} +/** + * @public + */ +export interface DeleteProjectInput { /** - *The Amazon Resource Name (ARN) of the lineage group.
+ *The name of the project to delete.
* @public */ - LineageGroupArn?: string | undefined; + ProjectName: string | undefined; } /** * @public */ -export interface DescribeAutoMLJobRequest { +export interface DeleteSpaceRequest { /** - *Requests information about an AutoML job using its unique name.
+ *The ID of the associated domain.
* @public */ - AutoMLJobName: string | undefined; + DomainId: string | undefined; + + /** + *The name of the space.
+ * @public + */ + SpaceName: string | undefined; } /** - *Provides information about the endpoint of the model deployment.
* @public */ -export interface ModelDeployResult { +export interface DeleteStudioLifecycleConfigRequest { /** - *The name of the endpoint to which the model has been deployed.
- *If model deployment fails, this field is omitted from the response.
- *The name of the Amazon SageMaker Studio Lifecycle Configuration to delete.
* @public */ - EndpointName?: string | undefined; + StudioLifecycleConfigName: string | undefined; } /** - *The resolved attributes.
* @public */ -export interface ResolvedAttributes { +export interface DeleteTagsInput { /** - *Specifies a metric to minimize or maximize as the objective of an AutoML job.
+ *The Amazon Resource Name (ARN) of the resource whose tags you want to + * delete.
* @public */ - AutoMLJobObjective?: AutoMLJobObjective | undefined; + ResourceArn: string | undefined; /** - *The problem type.
+ *An array or one or more tag keys to delete.
* @public */ - ProblemType?: ProblemType | undefined; + TagKeys: string[] | undefined; +} + +/** + * @public + */ +export interface DeleteTagsOutput {} +/** + * @public + */ +export interface DeleteTrialRequest { /** - *How long a job is allowed to run, or how many candidates a job is allowed to - * generate.
+ *The name of the trial to delete.
* @public */ - CompletionCriteria?: AutoMLJobCompletionCriteria | undefined; + TrialName: string | undefined; } /** * @public */ -export interface DescribeAutoMLJobResponse { +export interface DeleteTrialResponse { /** - *Returns the name of the AutoML job.
+ *The Amazon Resource Name (ARN) of the trial that is being deleted.
* @public */ - AutoMLJobName: string | undefined; + TrialArn?: string | undefined; +} +/** + * @public + */ +export interface DeleteTrialComponentRequest { /** - *Returns the ARN of the AutoML job.
+ *The name of the component to delete.
* @public */ - AutoMLJobArn: string | undefined; + TrialComponentName: string | undefined; +} +/** + * @public + */ +export interface DeleteTrialComponentResponse { /** - *Returns the input data configuration for the AutoML job.
+ *The Amazon Resource Name (ARN) of the component is being deleted.
* @public */ - InputDataConfig: AutoMLChannel[] | undefined; + TrialComponentArn?: string | undefined; +} +/** + * @public + */ +export interface DeleteUserProfileRequest { /** - *Returns the job's output data config.
+ *The domain ID.
* @public */ - OutputDataConfig: AutoMLOutputDataConfig | undefined; + DomainId: string | undefined; /** - *The ARN of the IAM role that has read permission to the input data - * location and write permission to the output data location in Amazon S3.
+ *The user profile name.
* @public */ - RoleArn: string | undefined; + UserProfileName: string | undefined; +} +/** + * @public + */ +export interface DeleteWorkforceRequest { /** - *Returns the job's objective.
+ *The name of the workforce.
* @public */ - AutoMLJobObjective?: AutoMLJobObjective | undefined; + WorkforceName: string | undefined; +} + +/** + * @public + */ +export interface DeleteWorkforceResponse {} +/** + * @public + */ +export interface DeleteWorkteamRequest { /** - *Returns the job's problem type.
+ *The name of the work team to delete.
* @public */ - ProblemType?: ProblemType | undefined; + WorkteamName: string | undefined; +} +/** + * @public + */ +export interface DeleteWorkteamResponse { /** - *Returns the configuration for the AutoML job.
+ *Returns true if the work team was successfully deleted; otherwise,
+ * returns false.
Gets the Amazon EC2 Container Registry path of the docker image of the model that is hosted in this ProductionVariant.
+ *If you used the registry/repository[:tag] form to specify the image path
+ * of the primary container when you created the model hosted in this
+ * ProductionVariant, the path resolves to a path of the form
+ * registry/repository[@digest]. A digest is a hash value that identifies
+ * a specific version of an image. For information about Amazon ECR paths, see Pulling an Image in the Amazon ECR User Guide.
Returns the creation time of the AutoML job.
+ *The image path you specified when you created the model.
* @public */ - CreationTime: Date | undefined; + SpecifiedImage?: string | undefined; /** - *Returns the end time of the AutoML job.
+ *The specific digest path of the image hosted in this
+ * ProductionVariant.
Returns the job's last modified time.
+ *The date and time when the image path for the model resolved to the
+ * ResolvedImage
+ *
The recommended configuration to use for Real-Time Inference.
+ * @public + */ +export interface RealTimeInferenceRecommendation { /** - *Returns the failure reason for an AutoML job, when applicable.
+ *The recommendation ID which uniquely identifies each recommendation.
* @public */ - FailureReason?: string | undefined; + RecommendationId: string | undefined; /** - *Returns a list of reasons for partial failures within an AutoML job.
+ *The recommended instance type for Real-Time Inference.
* @public */ - PartialFailureReasons?: AutoMLPartialFailureReason[] | undefined; + InstanceType: ProductionVariantInstanceType | undefined; /** - *The best model candidate selected by SageMaker Autopilot using both the best - * objective metric and lowest InferenceLatency for - * an experiment.
+ *The recommended environment variables to set in the model container for Real-Time Inference.
* @public */ - BestCandidate?: AutoMLCandidate | undefined; + Environment?: RecordA set of recommended deployment configurations for the model. To get more advanced recommendations, see + * CreateInferenceRecommendationsJob + * to create an inference recommendation job.
+ * @public + */ +export interface DeploymentRecommendation { /** - *Returns the status of the AutoML job.
+ *Status of the deployment recommendation. The status NOT_APPLICABLE means that SageMaker
+ * is unable to provide a default recommendation for the model using the information provided. If the deployment status is IN_PROGRESS,
+ * retry your API call after a few seconds to get a COMPLETED deployment recommendation.
Returns the secondary status of the AutoML job.
+ *A list of RealTimeInferenceRecommendation items.
* @public */ - AutoMLJobSecondaryStatus: AutoMLJobSecondaryStatus | undefined; + RealTimeInferenceRecommendations?: RealTimeInferenceRecommendation[] | undefined; +} + +/** + * @public + * @enum + */ +export const StageStatus = { + Creating: "CREATING", + Deployed: "DEPLOYED", + Failed: "FAILED", + InProgress: "INPROGRESS", + ReadyToDeploy: "READYTODEPLOY", + Starting: "STARTING", + Stopped: "STOPPED", + Stopping: "STOPPING", +} as const; + +/** + * @public + */ +export type StageStatus = (typeof StageStatus)[keyof typeof StageStatus]; +/** + *Contains information summarizing the deployment stage results.
+ * @public + */ +export interface EdgeDeploymentStatus { /** - *Indicates whether the output for an AutoML job generates candidate definitions - * only.
+ *The general status of the current stage.
* @public */ - GenerateCandidateDefinitionsOnly?: boolean | undefined; + StageStatus: StageStatus | undefined; /** - *Returns information on the job's artifacts found in
- * AutoMLJobArtifacts.
The number of edge devices with the successful deployment in the current stage.
* @public */ - AutoMLJobArtifacts?: AutoMLJobArtifacts | undefined; + EdgeDeploymentSuccessInStage: number | undefined; /** - *Contains ProblemType, AutoMLJobObjective, and
- * CompletionCriteria. If you do not provide these values, they are
- * inferred.
The number of edge devices yet to pick up the deployment in current stage, or in + * progress.
* @public */ - ResolvedAttributes?: ResolvedAttributes | undefined; + EdgeDeploymentPendingInStage: number | undefined; /** - *Indicates whether the model was deployed automatically to an endpoint and the name of - * that endpoint if deployed automatically.
+ *The number of edge devices that failed the deployment in current stage.
* @public */ - ModelDeployConfig?: ModelDeployConfig | undefined; + EdgeDeploymentFailedInStage: number | undefined; /** - *Provides information about endpoint for the model deployment.
+ *A detailed message about deployment status in current stage.
* @public */ - ModelDeployResult?: ModelDeployResult | undefined; -} + EdgeDeploymentStatusMessage?: string | undefined; -/** - * @public - */ -export interface DescribeAutoMLJobV2Request { /** - *Requests information about an AutoML job V2 using its unique name.
+ *The time when the deployment API started.
* @public */ - AutoMLJobName: string | undefined; + EdgeDeploymentStageStartTime?: Date | undefined; } /** + *Contains information summarizing the deployment stage results.
* @public */ -export interface DescribeAutoMLJobV2Response { - /** - *Returns the name of the AutoML job V2.
- * @public - */ - AutoMLJobName: string | undefined; - - /** - *Returns the Amazon Resource Name (ARN) of the AutoML job V2.
- * @public - */ - AutoMLJobArn: string | undefined; - +export interface DeploymentStageStatusSummary { /** - *Returns an array of channel objects describing the input data and their location.
+ *The name of the stage.
* @public */ - AutoMLJobInputDataConfig: AutoMLJobChannel[] | undefined; + StageName: string | undefined; /** - *Returns the job's output data config.
+ *Configuration of the devices in the stage.
* @public */ - OutputDataConfig: AutoMLOutputDataConfig | undefined; + DeviceSelectionConfig: DeviceSelectionConfig | undefined; /** - *The ARN of the IAM role that has read permission to the input data - * location and write permission to the output data location in Amazon S3.
+ *Configuration of the deployment details.
* @public */ - RoleArn: string | undefined; + DeploymentConfig: EdgeDeploymentConfig | undefined; /** - *Returns the job's objective.
+ *General status of the current state.
* @public */ - AutoMLJobObjective?: AutoMLJobObjective | undefined; + DeploymentStatus: EdgeDeploymentStatus | undefined; +} +/** + * @public + */ +export interface DeregisterDevicesRequest { /** - *Returns the configuration settings of the problem type set for the AutoML job V2.
+ *The name of the fleet the devices belong to.
* @public */ - AutoMLProblemTypeConfig?: AutoMLProblemTypeConfig | undefined; + DeviceFleetName: string | undefined; /** - *Returns the name of the problem type configuration set for the AutoML job V2.
+ *The unique IDs of the devices.
* @public */ - AutoMLProblemTypeConfigName?: AutoMLProblemTypeConfigName | undefined; + DeviceNames: string[] | undefined; +} +/** + *Information that SageMaker Neo automatically derived about the model.
+ * @public + */ +export interface DerivedInformation { /** - *Returns the creation time of the AutoML job V2.
+ *The data input configuration that SageMaker Neo automatically derived for the model. + * When SageMaker Neo derives this information, you don't need to specify the data input + * configuration when you create a compilation job.
* @public */ - CreationTime: Date | undefined; + DerivedDataInputConfig?: string | undefined; +} +/** + * @public + */ +export interface DescribeActionRequest { /** - *Returns the end time of the AutoML job V2.
+ *The name of the action to describe.
* @public */ - EndTime?: Date | undefined; + ActionName: string | undefined; +} +/** + * @public + */ +export interface DescribeActionResponse { /** - *Returns the job's last modified time.
+ *The name of the action.
* @public */ - LastModifiedTime: Date | undefined; + ActionName?: string | undefined; /** - *Returns the reason for the failure of the AutoML job V2, when applicable.
+ *The Amazon Resource Name (ARN) of the action.
* @public */ - FailureReason?: string | undefined; + ActionArn?: string | undefined; /** - *Returns a list of reasons for partial failures within an AutoML job V2.
+ *The source of the action.
* @public */ - PartialFailureReasons?: AutoMLPartialFailureReason[] | undefined; + Source?: ActionSource | undefined; /** - *Information about the candidate produced by an AutoML training job V2, including its - * status, steps, and other properties.
+ *The type of the action.
* @public */ - BestCandidate?: AutoMLCandidate | undefined; + ActionType?: string | undefined; /** - *Returns the status of the AutoML job V2.
+ *The description of the action.
* @public */ - AutoMLJobStatus: AutoMLJobStatus | undefined; + Description?: string | undefined; /** - *Returns the secondary status of the AutoML job V2.
+ *The status of the action.
* @public */ - AutoMLJobSecondaryStatus: AutoMLJobSecondaryStatus | undefined; + Status?: ActionStatus | undefined; /** - *The artifacts that are generated during an AutoML job.
+ *A list of the action's properties.
* @public */ - AutoMLJobArtifacts?: AutoMLJobArtifacts | undefined; + Properties?: RecordReturns the resolved attributes used by the AutoML job V2.
+ *When the action was created.
* @public */ - ResolvedAttributes?: AutoMLResolvedAttributes | undefined; + CreationTime?: Date | undefined; /** - *Indicates whether the model was deployed automatically to an endpoint and the name of - * that endpoint if deployed automatically.
+ *Information about the user who created or modified an experiment, trial, trial + * component, lineage group, project, or model card.
* @public */ - ModelDeployConfig?: ModelDeployConfig | undefined; + CreatedBy?: UserContext | undefined; /** - *Provides information about endpoint for the model deployment.
+ *When the action was last modified.
* @public */ - ModelDeployResult?: ModelDeployResult | undefined; + LastModifiedTime?: Date | undefined; /** - *Returns the configuration settings of how the data are split into train and validation - * datasets.
+ *Information about the user who created or modified an experiment, trial, trial + * component, lineage group, project, or model card.
* @public */ - DataSplitConfig?: AutoMLDataSplitConfig | undefined; + LastModifiedBy?: UserContext | undefined; /** - *Returns the security configuration for traffic encryption or Amazon VPC - * settings.
+ *Metadata properties of the tracking entity, trial, or trial component.
* @public */ - SecurityConfig?: AutoMLSecurityConfig | undefined; + MetadataProperties?: MetadataProperties | undefined; /** - *The compute configuration used for the AutoML job V2.
+ *The Amazon Resource Name (ARN) of the lineage group.
* @public */ - AutoMLComputeConfig?: AutoMLComputeConfig | undefined; + LineageGroupArn?: string | undefined; } /** * @public */ -export interface DescribeClusterRequest { +export interface DescribeAlgorithmInput { /** - *The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster.
+ *The name of the algorithm to describe.
* @public */ - ClusterName: string | undefined; + AlgorithmName: string | undefined; } /** * @public */ -export interface DescribeClusterResponse { - /** - *The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster.
- * @public - */ - ClusterArn: string | undefined; - - /** - *The name of the SageMaker HyperPod cluster.
- * @public - */ - ClusterName?: string | undefined; - +export interface DescribeAlgorithmOutput { /** - *The status of the SageMaker HyperPod cluster.
+ *The name of the algorithm being described.
* @public */ - ClusterStatus: ClusterStatus | undefined; + AlgorithmName: string | undefined; /** - *The time when the SageMaker Cluster is created.
+ *The Amazon Resource Name (ARN) of the algorithm.
* @public */ - CreationTime?: Date | undefined; + AlgorithmArn: string | undefined; /** - *The failure message of the SageMaker HyperPod cluster.
+ *A brief summary about the algorithm.
* @public */ - FailureMessage?: string | undefined; + AlgorithmDescription?: string | undefined; /** - *The instance groups of the SageMaker HyperPod cluster.
+ *A timestamp specifying when the algorithm was created.
* @public */ - InstanceGroups: ClusterInstanceGroupDetails[] | undefined; + CreationTime: Date | undefined; /** - *Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources - * have access to. You can control access to and from your resources by configuring a VPC. - * For more information, see Give SageMaker Access to - * Resources in your Amazon VPC.
+ *Details about training jobs run by this algorithm.
* @public */ - VpcConfig?: VpcConfig | undefined; + TrainingSpecification: TrainingSpecification | undefined; /** - *The type of orchestrator used for the SageMaker HyperPod cluster.
+ *Details about inference jobs that the algorithm runs.
* @public */ - Orchestrator?: ClusterOrchestrator | undefined; + InferenceSpecification?: InferenceSpecification | undefined; /** - *The node recovery mode configured for the SageMaker HyperPod cluster.
+ *Details about configurations for one or more training jobs that SageMaker runs to test the + * algorithm.
* @public */ - NodeRecovery?: ClusterNodeRecovery | undefined; -} + ValidationSpecification?: AlgorithmValidationSpecification | undefined; -/** - * @public - */ -export interface DescribeClusterNodeRequest { /** - *The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster in which the node is.
+ *The current status of the algorithm.
* @public */ - ClusterName: string | undefined; + AlgorithmStatus: AlgorithmStatus | undefined; /** - *The ID of the SageMaker HyperPod cluster node.
+ *Details about the current status of the algorithm.
* @public */ - NodeId: string | undefined; -} + AlgorithmStatusDetails: AlgorithmStatusDetails | undefined; -/** - * @public - */ -export interface DescribeClusterNodeResponse { /** - *The details of the SageMaker HyperPod cluster node.
+ *The product identifier of the algorithm.
* @public - */ - NodeDetails: ClusterNodeDetails | undefined; -} - -/** - * @public - */ -export interface DescribeCodeRepositoryInput { + */ + ProductId?: string | undefined; + /** - *The name of the Git repository to describe.
+ *Whether the algorithm is certified to be listed in Amazon Web Services + * Marketplace.
* @public */ - CodeRepositoryName: string | undefined; + CertifyForMarketplace?: boolean | undefined; } /** * @public */ -export interface DescribeCodeRepositoryOutput { +export interface DescribeAppRequest { /** - *The name of the Git repository.
+ *The domain ID.
* @public */ - CodeRepositoryName: string | undefined; + DomainId: string | undefined; /** - *The Amazon Resource Name (ARN) of the Git repository.
+ *The user profile name. If this value is not set, then SpaceName must be
+ * set.
The date and time that the repository was created.
+ *The name of the space.
* @public */ - CreationTime: Date | undefined; + SpaceName?: string | undefined; /** - *The date and time that the repository was last changed.
+ *The type of app.
* @public */ - LastModifiedTime: Date | undefined; + AppType: AppType | undefined; /** - *Configuration details about the repository, including the URL where the repository is - * located, the default branch, and the Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that contains the credentials used to access the - * repository.
+ *The name of the app.
* @public */ - GitConfig?: GitConfig | undefined; + AppName: string | undefined; } /** * @public */ -export interface DescribeCompilationJobRequest { +export interface DescribeAppResponse { /** - *The name of the model compilation job that you want information about.
+ *The Amazon Resource Name (ARN) of the app.
* @public */ - CompilationJobName: string | undefined; -} + AppArn?: string | undefined; -/** - *Provides information about the location that is configured for storing model - * artifacts.
- *Model artifacts are outputs that result from training a model. They typically consist
- * of trained parameters, a model definition that describes how to compute inferences, and
- * other metadata. A SageMaker container stores your trained model artifacts in the
- * /opt/ml/model directory. After training has completed, by default,
- * these artifacts are uploaded to your Amazon S3 bucket as compressed files.
The path of the S3 object that contains the model artifacts. For example,
- * s3://bucket-name/keynameprefix/model.tar.gz.
The type of app.
* @public */ - S3ModelArtifacts: string | undefined; -} + AppType?: AppType | undefined; -/** - *Provides information to verify the integrity of stored model artifacts.
- * @public - */ -export interface ModelDigests { /** - *Provides a hash value that uniquely identifies the stored model - * artifacts.
+ *The name of the app.
* @public */ - ArtifactDigest?: string | undefined; -} + AppName?: string | undefined; -/** - * @public - */ -export interface DescribeCompilationJobResponse { /** - *The name of the model compilation job.
+ *The domain ID.
* @public */ - CompilationJobName: string | undefined; + DomainId?: string | undefined; /** - *The Amazon Resource Name (ARN) of the model compilation job.
+ *The user profile name.
* @public */ - CompilationJobArn: string | undefined; + UserProfileName?: string | undefined; /** - *The status of the model compilation job.
+ *The name of the space. If this value is not set, then UserProfileName must be
+ * set.
The time when the model compilation job started the CompilationJob
- * instances.
You are billed for the time between this timestamp and the timestamp in the
- * CompilationEndTime field. In Amazon CloudWatch Logs, the start time might be later
- * than this time. That's because it takes time to download the compilation job, which
- * depends on the size of the compilation job container.
The status.
* @public */ - CompilationStartTime?: Date | undefined; + Status?: AppStatus | undefined; /** - *The time when the model compilation job on a compilation job instance ended. For a - * successful or stopped job, this is when the job's model artifacts have finished - * uploading. For a failed job, this is when Amazon SageMaker detected that the job failed.
+ *The timestamp of the last health check.
* @public */ - CompilationEndTime?: Date | undefined; + LastHealthCheckTimestamp?: Date | undefined; /** - *Specifies a limit to how long a model compilation job can run. When the job reaches - * the time limit, Amazon SageMaker ends the compilation job. Use this API to cap model training - * costs.
+ *The timestamp of the last user's activity. LastUserActivityTimestamp is also
+ * updated when SageMaker performs health checks without user activity. As a result, this
+ * value is set to the same value as LastHealthCheckTimestamp.
The inference image to use when compiling a model. Specify an image only if the target - * device is a cloud instance.
+ *The creation time of the application.
+ *After an application has been shut down for 24 hours, SageMaker deletes all + * metadata for the application. To be considered an update and retain application metadata, + * applications must be restarted within 24 hours after the previous application has been shut + * down. After this time window, creation of an application is considered a new application + * rather than an update of the previous application.
+ *The Amazon Resource Name (ARN) of the versioned model package that was - * provided to SageMaker Neo when you initiated a compilation job.
+ *The failure reason.
* @public */ - ModelPackageVersionArn?: string | undefined; + FailureReason?: string | undefined; /** - *The time that the model compilation job was created.
+ *The instance type and the Amazon Resource Name (ARN) of the SageMaker image + * created on the instance.
* @public */ - CreationTime: Date | undefined; + ResourceSpec?: ResourceSpec | undefined; /** - *The time that the status - * of - * the model compilation job was last modified.
+ *The lifecycle configuration that runs before the default lifecycle configuration
* @public */ - LastModifiedTime: Date | undefined; + BuiltInLifecycleConfigArn?: string | undefined; +} +/** + * @public + */ +export interface DescribeAppImageConfigRequest { /** - *If a model compilation job failed, the reason it failed.
+ *The name of the AppImageConfig to describe.
* @public */ - FailureReason: string | undefined; + AppImageConfigName: string | undefined; +} +/** + * @public + */ +export interface DescribeAppImageConfigResponse { /** - *Information about the location in Amazon S3 that has been configured for storing the model - * artifacts used in the compilation job.
+ *The ARN of the AppImageConfig.
* @public */ - ModelArtifacts: ModelArtifacts | undefined; + AppImageConfigArn?: string | undefined; /** - *Provides a BLAKE2 hash value that identifies the compiled model artifacts in - * Amazon S3.
+ *The name of the AppImageConfig.
* @public */ - ModelDigests?: ModelDigests | undefined; + AppImageConfigName?: string | undefined; /** - *The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker assumes to perform the model - * compilation job.
+ *When the AppImageConfig was created.
* @public */ - RoleArn: string | undefined; + CreationTime?: Date | undefined; /** - *Information about the location in Amazon S3 of the input model artifacts, the name and - * shape of the expected data inputs, and the framework in which the model was - * trained.
+ *When the AppImageConfig was last modified.
* @public */ - InputConfig: InputConfig | undefined; + LastModifiedTime?: Date | undefined; /** - *Information about the output location for the compiled model and the target device - * that the model runs on.
+ *The configuration of a KernelGateway app.
* @public */ - OutputConfig: OutputConfig | undefined; + KernelGatewayImageConfig?: KernelGatewayImageConfig | undefined; /** - *A VpcConfig object that specifies the VPC that you want your compilation job - * to connect to. Control access to your models by configuring the VPC. For more - * information, see Protect Compilation Jobs by Using an Amazon Virtual Private Cloud.
+ *The configuration of the JupyterLab app.
* @public */ - VpcConfig?: NeoVpcConfig | undefined; + JupyterLabAppImageConfig?: JupyterLabAppImageConfig | undefined; /** - *Information that SageMaker Neo automatically derived about the model.
+ *The configuration of the Code Editor app.
* @public */ - DerivedInformation?: DerivedInformation | undefined; + CodeEditorAppImageConfig?: CodeEditorAppImageConfig | undefined; } /** * @public */ -export interface DescribeContextRequest { +export interface DescribeArtifactRequest { /** - *The name of the context to describe.
+ *The Amazon Resource Name (ARN) of the artifact to describe.
* @public */ - ContextName: string | undefined; + ArtifactArn: string | undefined; } /** * @public */ -export interface DescribeContextResponse { - /** - *The name of the context.
- * @public - */ - ContextName?: string | undefined; - +export interface DescribeArtifactResponse { /** - *The Amazon Resource Name (ARN) of the context.
+ *The name of the artifact.
* @public */ - ContextArn?: string | undefined; + ArtifactName?: string | undefined; /** - *The source of the context.
+ *The Amazon Resource Name (ARN) of the artifact.
* @public */ - Source?: ContextSource | undefined; + ArtifactArn?: string | undefined; /** - *The type of the context.
+ *The source of the artifact.
* @public */ - ContextType?: string | undefined; + Source?: ArtifactSource | undefined; /** - *The description of the context.
+ *The type of the artifact.
* @public */ - Description?: string | undefined; + ArtifactType?: string | undefined; /** - *A list of the context's properties.
+ *A list of the artifact's properties.
* @public */ Properties?: RecordWhen the context was created.
+ *When the artifact was created.
* @public */ CreationTime?: Date | undefined; @@ -5511,7 +5548,7 @@ export interface DescribeContextResponse { CreatedBy?: UserContext | undefined; /** - *When the context was last modified.
+ *When the artifact was last modified.
* @public */ LastModifiedTime?: Date | undefined; @@ -5524,3693 +5561,3192 @@ export interface DescribeContextResponse { LastModifiedBy?: UserContext | undefined; /** - *The Amazon Resource Name (ARN) of the lineage group.
+ *Metadata properties of the tracking entity, trial, or trial component.
* @public */ - LineageGroupArn?: string | undefined; -} + MetadataProperties?: MetadataProperties | undefined; -/** - * @public - */ -export interface DescribeDataQualityJobDefinitionRequest { /** - *The name of the data quality monitoring job definition to describe.
+ *The Amazon Resource Name (ARN) of the lineage group.
* @public */ - JobDefinitionName: string | undefined; + LineageGroupArn?: string | undefined; } /** - * @public - */ -export interface DescribeDataQualityJobDefinitionResponse { - /** - *The Amazon Resource Name (ARN) of the data quality monitoring job definition.
- * @public - */ - JobDefinitionArn: string | undefined; - - /** - *The name of the data quality monitoring job definition.
- * @public - */ - JobDefinitionName: string | undefined; - - /** - *The time that the data quality monitoring job definition was created.
- * @public - */ - CreationTime: Date | undefined; - + * @public + */ +export interface DescribeAutoMLJobRequest { /** - *The constraints and baselines for the data quality monitoring job definition.
+ *Requests information about an AutoML job using its unique name.
* @public */ - DataQualityBaselineConfig?: DataQualityBaselineConfig | undefined; + AutoMLJobName: string | undefined; +} +/** + *Provides information about the endpoint of the model deployment.
+ * @public + */ +export interface ModelDeployResult { /** - *Information about the container that runs the data quality monitoring job.
+ *The name of the endpoint to which the model has been deployed.
+ *If model deployment fails, this field is omitted from the response.
+ *The resolved attributes.
+ * @public + */ +export interface ResolvedAttributes { /** - *The list of inputs for the data quality monitoring job. Currently endpoints are - * supported.
+ *Specifies a metric to minimize or maximize as the objective of an AutoML job.
* @public */ - DataQualityJobInput: DataQualityJobInput | undefined; + AutoMLJobObjective?: AutoMLJobObjective | undefined; /** - *The output configuration for monitoring jobs.
+ *The problem type.
* @public */ - DataQualityJobOutputConfig: MonitoringOutputConfig | undefined; + ProblemType?: ProblemType | undefined; /** - *Identifies the resources to deploy for a monitoring job.
+ *How long a job is allowed to run, or how many candidates a job is allowed to + * generate.
* @public */ - JobResources: MonitoringResources | undefined; + CompletionCriteria?: AutoMLJobCompletionCriteria | undefined; +} +/** + * @public + */ +export interface DescribeAutoMLJobResponse { /** - *The networking configuration for the data quality monitoring job.
+ *Returns the name of the AutoML job.
* @public */ - NetworkConfig?: MonitoringNetworkConfig | undefined; + AutoMLJobName: string | undefined; /** - *The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can - * assume to perform tasks on your behalf.
+ *Returns the ARN of the AutoML job.
* @public */ - RoleArn: string | undefined; + AutoMLJobArn: string | undefined; /** - *A time limit for how long the monitoring job is allowed to run before stopping.
+ *Returns the input data configuration for the AutoML job.
* @public */ - StoppingCondition?: MonitoringStoppingCondition | undefined; -} + InputDataConfig: AutoMLChannel[] | undefined; -/** - * @public - */ -export interface DescribeDeviceRequest { /** - *Next token of device description.
+ *Returns the job's output data config.
* @public */ - NextToken?: string | undefined; + OutputDataConfig: AutoMLOutputDataConfig | undefined; /** - *The unique ID of the device.
+ *The ARN of the IAM role that has read permission to the input data + * location and write permission to the output data location in Amazon S3.
* @public */ - DeviceName: string | undefined; + RoleArn: string | undefined; /** - *The name of the fleet the devices belong to.
+ *Returns the job's objective.
* @public */ - DeviceFleetName: string | undefined; -} + AutoMLJobObjective?: AutoMLJobObjective | undefined; -/** - *The model on the edge device.
- * @public - */ -export interface EdgeModel { /** - *The name of the model.
+ *Returns the job's problem type.
* @public */ - ModelName: string | undefined; + ProblemType?: ProblemType | undefined; /** - *The model version.
+ *Returns the configuration for the AutoML job.
* @public */ - ModelVersion: string | undefined; + AutoMLJobConfig?: AutoMLJobConfig | undefined; /** - *The timestamp of the last data sample taken.
+ *Returns the creation time of the AutoML job.
* @public */ - LatestSampleTime?: Date | undefined; + CreationTime: Date | undefined; /** - *The timestamp of the last inference that was made.
+ *Returns the end time of the AutoML job.
* @public */ - LatestInference?: Date | undefined; -} + EndTime?: Date | undefined; -/** - * @public - */ -export interface DescribeDeviceResponse { /** - *The Amazon Resource Name (ARN) of the device.
+ *Returns the job's last modified time.
* @public */ - DeviceArn?: string | undefined; + LastModifiedTime: Date | undefined; /** - *The unique identifier of the device.
+ *Returns the failure reason for an AutoML job, when applicable.
* @public */ - DeviceName: string | undefined; + FailureReason?: string | undefined; /** - *A description of the device.
+ *Returns a list of reasons for partial failures within an AutoML job.
* @public */ - Description?: string | undefined; + PartialFailureReasons?: AutoMLPartialFailureReason[] | undefined; /** - *The name of the fleet the device belongs to.
+ *The best model candidate selected by SageMaker Autopilot using both the best + * objective metric and lowest InferenceLatency for + * an experiment.
* @public */ - DeviceFleetName: string | undefined; + BestCandidate?: AutoMLCandidate | undefined; /** - *The Amazon Web Services Internet of Things (IoT) object thing name associated with the device.
+ *Returns the status of the AutoML job.
* @public */ - IotThingName?: string | undefined; + AutoMLJobStatus: AutoMLJobStatus | undefined; /** - *The timestamp of the last registration or de-reregistration.
+ *Returns the secondary status of the AutoML job.
* @public */ - RegistrationTime: Date | undefined; + AutoMLJobSecondaryStatus: AutoMLJobSecondaryStatus | undefined; /** - *The last heartbeat received from the device.
+ *Indicates whether the output for an AutoML job generates candidate definitions + * only.
* @public */ - LatestHeartbeat?: Date | undefined; + GenerateCandidateDefinitionsOnly?: boolean | undefined; /** - *Models on the device.
+ *Returns information on the job's artifacts found in
+ * AutoMLJobArtifacts.
The maximum number of models.
+ *Contains ProblemType, AutoMLJobObjective, and
+ * CompletionCriteria. If you do not provide these values, they are
+ * inferred.
The response from the last list when returning a list large enough to need tokening.
+ *Indicates whether the model was deployed automatically to an endpoint and the name of + * that endpoint if deployed automatically.
* @public */ - NextToken?: string | undefined; + ModelDeployConfig?: ModelDeployConfig | undefined; /** - *Edge Manager agent version.
+ *Provides information about endpoint for the model deployment.
* @public */ - AgentVersion?: string | undefined; + ModelDeployResult?: ModelDeployResult | undefined; } /** * @public */ -export interface DescribeDeviceFleetRequest { +export interface DescribeAutoMLJobV2Request { /** - *The name of the fleet.
+ *Requests information about an AutoML job V2 using its unique name.
* @public */ - DeviceFleetName: string | undefined; + AutoMLJobName: string | undefined; } /** * @public */ -export interface DescribeDeviceFleetResponse { +export interface DescribeAutoMLJobV2Response { /** - *The name of the fleet.
+ *Returns the name of the AutoML job V2.
* @public */ - DeviceFleetName: string | undefined; + AutoMLJobName: string | undefined; /** - *The The Amazon Resource Name (ARN) of the fleet.
+ *Returns the Amazon Resource Name (ARN) of the AutoML job V2.
* @public */ - DeviceFleetArn: string | undefined; + AutoMLJobArn: string | undefined; /** - *The output configuration for storing sampled data.
+ *Returns an array of channel objects describing the input data and their location.
* @public */ - OutputConfig: EdgeOutputConfig | undefined; + AutoMLJobInputDataConfig: AutoMLJobChannel[] | undefined; /** - *A description of the fleet.
+ *Returns the job's output data config.
* @public */ - Description?: string | undefined; + OutputDataConfig: AutoMLOutputDataConfig | undefined; /** - *Timestamp of when the device fleet was created.
+ *The ARN of the IAM role that has read permission to the input data + * location and write permission to the output data location in Amazon S3.
* @public */ - CreationTime: Date | undefined; + RoleArn: string | undefined; /** - *Timestamp of when the device fleet was last updated.
+ *Returns the job's objective.
* @public */ - LastModifiedTime: Date | undefined; + AutoMLJobObjective?: AutoMLJobObjective | undefined; /** - *The Amazon Resource Name (ARN) that has access to Amazon Web Services Internet of Things (IoT).
+ *Returns the configuration settings of the problem type set for the AutoML job V2.
* @public */ - RoleArn?: string | undefined; + AutoMLProblemTypeConfig?: AutoMLProblemTypeConfig | undefined; /** - *The Amazon Resource Name (ARN) alias created in Amazon Web Services Internet of Things (IoT).
+ *Returns the name of the problem type configuration set for the AutoML job V2.
* @public */ - IotRoleAlias?: string | undefined; -} + AutoMLProblemTypeConfigName?: AutoMLProblemTypeConfigName | undefined; -/** - * @public - */ -export interface DescribeDomainRequest { /** - *The domain ID.
+ *Returns the creation time of the AutoML job V2.
* @public */ - DomainId: string | undefined; -} + CreationTime: Date | undefined; -/** - * @public - * @enum - */ -export const DomainStatus = { - Delete_Failed: "Delete_Failed", - Deleting: "Deleting", - Failed: "Failed", - InService: "InService", - Pending: "Pending", - Update_Failed: "Update_Failed", - Updating: "Updating", -} as const; + /** + *Returns the end time of the AutoML job V2.
+ * @public + */ + EndTime?: Date | undefined; -/** - * @public - */ -export type DomainStatus = (typeof DomainStatus)[keyof typeof DomainStatus]; + /** + *Returns the job's last modified time.
+ * @public + */ + LastModifiedTime: Date | undefined; -/** - * @public - */ -export interface DescribeDomainResponse { /** - *The domain's Amazon Resource Name (ARN).
+ *Returns the reason for the failure of the AutoML job V2, when applicable.
* @public */ - DomainArn?: string | undefined; + FailureReason?: string | undefined; /** - *The domain ID.
+ *Returns a list of reasons for partial failures within an AutoML job V2.
* @public */ - DomainId?: string | undefined; + PartialFailureReasons?: AutoMLPartialFailureReason[] | undefined; /** - *The domain name.
+ *Information about the candidate produced by an AutoML training job V2, including its + * status, steps, and other properties.
* @public */ - DomainName?: string | undefined; + BestCandidate?: AutoMLCandidate | undefined; /** - *The ID of the Amazon Elastic File System managed by this Domain.
+ *Returns the status of the AutoML job V2.
+ * @public + */ + AutoMLJobStatus: AutoMLJobStatus | undefined; + + /** + *Returns the secondary status of the AutoML job V2.
* @public */ - HomeEfsFileSystemId?: string | undefined; + AutoMLJobSecondaryStatus: AutoMLJobSecondaryStatus | undefined; /** - *The IAM Identity Center managed application instance ID.
+ *The artifacts that are generated during an AutoML job.
* @public */ - SingleSignOnManagedApplicationInstanceId?: string | undefined; + AutoMLJobArtifacts?: AutoMLJobArtifacts | undefined; /** - *The ARN of the application managed by SageMaker in IAM Identity Center. This value - * is only returned for domains created after October 1, 2023.
+ *Returns the resolved attributes used by the AutoML job V2.
* @public */ - SingleSignOnApplicationArn?: string | undefined; + ResolvedAttributes?: AutoMLResolvedAttributes | undefined; /** - *The status.
+ *Indicates whether the model was deployed automatically to an endpoint and the name of + * that endpoint if deployed automatically.
* @public */ - Status?: DomainStatus | undefined; + ModelDeployConfig?: ModelDeployConfig | undefined; /** - *The creation time.
+ *Provides information about endpoint for the model deployment.
* @public */ - CreationTime?: Date | undefined; + ModelDeployResult?: ModelDeployResult | undefined; /** - *The last modified time.
+ *Returns the configuration settings of how the data are split into train and validation + * datasets.
* @public */ - LastModifiedTime?: Date | undefined; + DataSplitConfig?: AutoMLDataSplitConfig | undefined; /** - *The failure reason.
+ *Returns the security configuration for traffic encryption or Amazon VPC + * settings.
* @public */ - FailureReason?: string | undefined; + SecurityConfig?: AutoMLSecurityConfig | undefined; /** - *The ID of the security group that authorizes traffic between the
- * RSessionGateway apps and the RStudioServerPro app.
The compute configuration used for the AutoML job V2.
* @public */ - SecurityGroupIdForDomainBoundary?: string | undefined; + AutoMLComputeConfig?: AutoMLComputeConfig | undefined; +} +/** + * @public + */ +export interface DescribeClusterRequest { /** - *The domain's authentication mode.
+ *The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster.
* @public */ - AuthMode?: AuthMode | undefined; + ClusterName: string | undefined; +} +/** + * @public + */ +export interface DescribeClusterResponse { /** - *Settings which are applied to UserProfiles in this domain if settings are not explicitly - * specified in a given UserProfile.
+ *The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster.
* @public */ - DefaultUserSettings?: UserSettings | undefined; + ClusterArn: string | undefined; /** - *A collection of Domain settings.
The name of the SageMaker HyperPod cluster.
* @public */ - DomainSettings?: DomainSettings | undefined; + ClusterName?: string | undefined; /** - *Specifies the VPC used for non-EFS traffic. The default value is
- * PublicInternetOnly.
- * PublicInternetOnly - Non-EFS traffic is through a VPC managed by Amazon SageMaker, which allows direct internet access
- * VpcOnly - All traffic is through the specified VPC and subnets
The status of the SageMaker HyperPod cluster.
* @public */ - AppNetworkAccessType?: AppNetworkAccessType | undefined; + ClusterStatus: ClusterStatus | undefined; /** - * @deprecated - * - *Use KmsKeyId.
The time when the SageMaker Cluster is created.
* @public */ - HomeEfsFileSystemKmsKeyId?: string | undefined; + CreationTime?: Date | undefined; /** - *The VPC subnets that the domain uses for communication.
+ *The failure message of the SageMaker HyperPod cluster.
* @public */ - SubnetIds?: string[] | undefined; + FailureMessage?: string | undefined; /** - *The domain's URL.
+ *The instance groups of the SageMaker HyperPod cluster.
* @public */ - Url?: string | undefined; + InstanceGroups: ClusterInstanceGroupDetails[] | undefined; /** - *The ID of the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.
+ *Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources + * have access to. You can control access to and from your resources by configuring a VPC. + * For more information, see Give SageMaker Access to + * Resources in your Amazon VPC.
* @public */ - VpcId?: string | undefined; + VpcConfig?: VpcConfig | undefined; /** - *The Amazon Web Services KMS customer managed key used to encrypt the EFS volume attached to - * the domain.
+ *The type of orchestrator used for the SageMaker HyperPod cluster.
* @public */ - KmsKeyId?: string | undefined; + Orchestrator?: ClusterOrchestrator | undefined; /** - *The entity that creates and manages the required security groups for inter-app
- * communication in VPCOnly mode. Required when
- * CreateDomain.AppNetworkAccessType is VPCOnly and
- * DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is
- * provided.
The node recovery mode configured for the SageMaker HyperPod cluster.
* @public */ - AppSecurityGroupManagement?: AppSecurityGroupManagement | undefined; + NodeRecovery?: ClusterNodeRecovery | undefined; +} +/** + * @public + */ +export interface DescribeClusterNodeRequest { /** - *Indicates whether custom tag propagation is supported for the domain.
+ *The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster in which the node is.
* @public */ - TagPropagation?: TagPropagation | undefined; + ClusterName: string | undefined; /** - *The default settings for shared spaces that users create in the domain.
+ *The ID of the SageMaker HyperPod cluster node.
* @public */ - DefaultSpaceSettings?: DefaultSpaceSettings | undefined; + NodeId: string | undefined; } /** * @public */ -export interface DescribeEdgeDeploymentPlanRequest { +export interface DescribeClusterNodeResponse { /** - *The name of the deployment plan to describe.
+ *The details of the SageMaker HyperPod cluster node.
* @public */ - EdgeDeploymentPlanName: string | undefined; + NodeDetails: ClusterNodeDetails | undefined; +} +/** + * @public + */ +export interface DescribeClusterSchedulerConfigRequest { /** - *If the edge deployment plan has enough stages to require tokening, then this is the - * response from the last list of stages returned.
+ *ID of the cluster policy.
* @public */ - NextToken?: string | undefined; + ClusterSchedulerConfigId: string | undefined; /** - *The maximum number of results to select (50 by default).
+ *Version of the cluster policy.
* @public */ - MaxResults?: number | undefined; + ClusterSchedulerConfigVersion?: number | undefined; } /** * @public */ -export interface DescribeEdgeDeploymentPlanResponse { +export interface DescribeClusterSchedulerConfigResponse { /** - *The ARN of edge deployment plan.
+ *ARN of the cluster policy.
* @public */ - EdgeDeploymentPlanArn: string | undefined; + ClusterSchedulerConfigArn: string | undefined; /** - *The name of the edge deployment plan.
+ *ID of the cluster policy.
* @public */ - EdgeDeploymentPlanName: string | undefined; + ClusterSchedulerConfigId: string | undefined; /** - *List of models associated with the edge deployment plan.
+ *Name of the cluster policy.
* @public */ - ModelConfigs: EdgeDeploymentModelConfig[] | undefined; + Name: string | undefined; /** - *The device fleet used for this edge deployment plan.
+ *Version of the cluster policy.
* @public */ - DeviceFleetName: string | undefined; + ClusterSchedulerConfigVersion: number | undefined; /** - *The number of edge devices with the successful deployment.
+ *Status of the cluster policy.
* @public */ - EdgeDeploymentSuccess?: number | undefined; + Status: SchedulerResourceStatus | undefined; /** - *The number of edge devices yet to pick up deployment, or in progress.
+ *Failure reason of the cluster policy.
* @public */ - EdgeDeploymentPending?: number | undefined; + FailureReason?: string | undefined; /** - *The number of edge devices that failed the deployment.
+ *ARN of the cluster where the cluster policy is applied.
* @public */ - EdgeDeploymentFailed?: number | undefined; + ClusterArn?: string | undefined; /** - *List of stages in the edge deployment plan.
+ *Cluster policy configuration. This policy is used for task prioritization and fair-share + * allocation. This helps prioritize critical workloads and distributes idle compute + * across entities.
* @public */ - Stages: DeploymentStageStatusSummary[] | undefined; + SchedulerConfig?: SchedulerConfig | undefined; /** - *Token to use when calling the next set of stages in the edge deployment plan.
+ *Description of the cluster policy.
* @public */ - NextToken?: string | undefined; + Description?: string | undefined; /** - *The time when the edge deployment plan was created.
+ *Creation time of the cluster policy.
* @public */ - CreationTime?: Date | undefined; + CreationTime: Date | undefined; /** - *The time when the edge deployment plan was last updated.
+ *Information about the user who created or modified an experiment, trial, trial + * component, lineage group, project, or model card.
+ * @public + */ + CreatedBy?: UserContext | undefined; + + /** + *Last modified time of the cluster policy.
* @public */ LastModifiedTime?: Date | undefined; + + /** + *Information about the user who created or modified an experiment, trial, trial + * component, lineage group, project, or model card.
+ * @public + */ + LastModifiedBy?: UserContext | undefined; } /** * @public */ -export interface DescribeEdgePackagingJobRequest { +export interface DescribeCodeRepositoryInput { /** - *The name of the edge packaging job.
+ *The name of the Git repository to describe.
* @public */ - EdgePackagingJobName: string | undefined; + CodeRepositoryName: string | undefined; } /** * @public - * @enum */ -export const EdgePackagingJobStatus = { - Completed: "COMPLETED", - Failed: "FAILED", - InProgress: "INPROGRESS", - Starting: "STARTING", - Stopped: "STOPPED", - Stopping: "STOPPING", -} as const; +export interface DescribeCodeRepositoryOutput { + /** + *The name of the Git repository.
+ * @public + */ + CodeRepositoryName: string | undefined; -/** - * @public - */ -export type EdgePackagingJobStatus = (typeof EdgePackagingJobStatus)[keyof typeof EdgePackagingJobStatus]; + /** + *The Amazon Resource Name (ARN) of the Git repository.
+ * @public + */ + CodeRepositoryArn: string | undefined; -/** - * @public - * @enum - */ -export const EdgePresetDeploymentStatus = { - Completed: "COMPLETED", - Failed: "FAILED", -} as const; + /** + *The date and time that the repository was created.
+ * @public + */ + CreationTime: Date | undefined; + + /** + *The date and time that the repository was last changed.
+ * @public + */ + LastModifiedTime: Date | undefined; + + /** + *Configuration details about the repository, including the URL where the repository is + * located, the default branch, and the Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that contains the credentials used to access the + * repository.
+ * @public + */ + GitConfig?: GitConfig | undefined; +} /** * @public */ -export type EdgePresetDeploymentStatus = (typeof EdgePresetDeploymentStatus)[keyof typeof EdgePresetDeploymentStatus]; +export interface DescribeCompilationJobRequest { + /** + *The name of the model compilation job that you want information about.
+ * @public + */ + CompilationJobName: string | undefined; +} /** - *The output of a SageMaker Edge Manager deployable resource.
+ *Provides information about the location that is configured for storing model + * artifacts.
+ *Model artifacts are outputs that result from training a model. They typically consist
+ * of trained parameters, a model definition that describes how to compute inferences, and
+ * other metadata. A SageMaker container stores your trained model artifacts in the
+ * /opt/ml/model directory. After training has completed, by default,
+ * these artifacts are uploaded to your Amazon S3 bucket as compressed files.
The deployment type created by SageMaker Edge Manager. Currently only - * supports Amazon Web Services IoT Greengrass Version 2 components.
+ *The path of the S3 object that contains the model artifacts. For example,
+ * s3://bucket-name/keynameprefix/model.tar.gz.
Provides information to verify the integrity of stored model artifacts.
+ * @public + */ +export interface ModelDigests { /** - *The Amazon Resource Name (ARN) of the generated deployable resource.
+ *Provides a hash value that uniquely identifies the stored model + * artifacts.
* @public */ - Artifact?: string | undefined; + ArtifactDigest?: string | undefined; +} +/** + * @public + */ +export interface DescribeCompilationJobResponse { /** - *The status of the deployable resource.
+ *The name of the model compilation job.
* @public */ - Status?: EdgePresetDeploymentStatus | undefined; + CompilationJobName: string | undefined; /** - *Returns a message describing the status of the deployed resource.
+ *The Amazon Resource Name (ARN) of the model compilation job.
* @public */ - StatusMessage?: string | undefined; -} + CompilationJobArn: string | undefined; -/** - * @public - */ -export interface DescribeEdgePackagingJobResponse { /** - *The Amazon Resource Name (ARN) of the edge packaging job.
+ *The status of the model compilation job.
* @public */ - EdgePackagingJobArn: string | undefined; + CompilationJobStatus: CompilationJobStatus | undefined; /** - *The name of the edge packaging job.
+ *The time when the model compilation job started the CompilationJob
+ * instances.
You are billed for the time between this timestamp and the timestamp in the
+ * CompilationEndTime field. In Amazon CloudWatch Logs, the start time might be later
+ * than this time. That's because it takes time to download the compilation job, which
+ * depends on the size of the compilation job container.
The name of the SageMaker Neo compilation job that is used to locate model artifacts that are being packaged.
+ *The time when the model compilation job on a compilation job instance ended. For a + * successful or stopped job, this is when the job's model artifacts have finished + * uploading. For a failed job, this is when Amazon SageMaker detected that the job failed.
* @public */ - CompilationJobName?: string | undefined; + CompilationEndTime?: Date | undefined; /** - *The name of the model.
+ *Specifies a limit to how long a model compilation job can run. When the job reaches + * the time limit, Amazon SageMaker ends the compilation job. Use this API to cap model training + * costs.
* @public */ - ModelName?: string | undefined; + StoppingCondition: StoppingCondition | undefined; /** - *The version of the model.
+ *The inference image to use when compiling a model. Specify an image only if the target + * device is a cloud instance.
* @public */ - ModelVersion?: string | undefined; + InferenceImage?: string | undefined; /** - *The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to download and upload the model, and to contact Neo.
+ *The Amazon Resource Name (ARN) of the versioned model package that was + * provided to SageMaker Neo when you initiated a compilation job.
* @public */ - RoleArn?: string | undefined; + ModelPackageVersionArn?: string | undefined; /** - *The output configuration for the edge packaging job.
+ *The time that the model compilation job was created.
* @public */ - OutputConfig?: EdgeOutputConfig | undefined; + CreationTime: Date | undefined; /** - *The Amazon Web Services KMS key to use when encrypting the EBS volume the job run on.
+ *The time that the status + * of + * the model compilation job was last modified.
* @public */ - ResourceKey?: string | undefined; + LastModifiedTime: Date | undefined; /** - *The current status of the packaging job.
+ *If a model compilation job failed, the reason it failed.
* @public */ - EdgePackagingJobStatus: EdgePackagingJobStatus | undefined; + FailureReason: string | undefined; /** - *Returns a message describing the job status and error messages.
+ *Information about the location in Amazon S3 that has been configured for storing the model + * artifacts used in the compilation job.
* @public */ - EdgePackagingJobStatusMessage?: string | undefined; + ModelArtifacts: ModelArtifacts | undefined; /** - *The timestamp of when the packaging job was created.
+ *Provides a BLAKE2 hash value that identifies the compiled model artifacts in + * Amazon S3.
* @public */ - CreationTime?: Date | undefined; + ModelDigests?: ModelDigests | undefined; /** - *The timestamp of when the job was last updated.
+ *The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker assumes to perform the model + * compilation job.
* @public */ - LastModifiedTime?: Date | undefined; + RoleArn: string | undefined; /** - *The Amazon Simple Storage (S3) URI where model artifacts ares stored.
+ *Information about the location in Amazon S3 of the input model artifacts, the name and + * shape of the expected data inputs, and the framework in which the model was + * trained.
* @public */ - ModelArtifact?: string | undefined; + InputConfig: InputConfig | undefined; /** - *The signature document of files in the model artifact.
+ *Information about the output location for the compiled model and the target device + * that the model runs on.
* @public */ - ModelSignature?: string | undefined; + OutputConfig: OutputConfig | undefined; /** - *The output of a SageMaker Edge Manager deployable resource.
+ *A VpcConfig object that specifies the VPC that you want your compilation job + * to connect to. Control access to your models by configuring the VPC. For more + * information, see Protect Compilation Jobs by Using an Amazon Virtual Private Cloud.
* @public */ - PresetDeploymentOutput?: EdgePresetDeploymentOutput | undefined; -} + VpcConfig?: NeoVpcConfig | undefined; -/** - * @public - */ -export interface DescribeEndpointInput { /** - *The name of the endpoint.
+ *Information that SageMaker Neo automatically derived about the model.
* @public */ - EndpointName: string | undefined; + DerivedInformation?: DerivedInformation | undefined; } /** - * @public - * @enum - */ -export const EndpointStatus = { - CREATING: "Creating", - DELETING: "Deleting", - FAILED: "Failed", - IN_SERVICE: "InService", - OUT_OF_SERVICE: "OutOfService", - ROLLING_BACK: "RollingBack", - SYSTEM_UPDATING: "SystemUpdating", - UPDATE_ROLLBACK_FAILED: "UpdateRollbackFailed", - UPDATING: "Updating", -} as const; - -/** - * @public - */ -export type EndpointStatus = (typeof EndpointStatus)[keyof typeof EndpointStatus]; - -/** - * @public - * @enum - */ -export const VariantStatus = { - ACTIVATING_TRAFFIC: "ActivatingTraffic", - BAKING: "Baking", - CREATING: "Creating", - DELETING: "Deleting", - UPDATING: "Updating", -} as const; - -/** - * @public - */ -export type VariantStatus = (typeof VariantStatus)[keyof typeof VariantStatus]; - -/** - *Describes the status of the production variant.
* @public */ -export interface ProductionVariantStatus { - /** - *The endpoint variant status which describes the current deployment stage status or - * operational status.
- *
- * Creating: Creating inference resources for the production
- * variant.
- * Deleting: Terminating inference resources for the production
- * variant.
- * Updating: Updating capacity for the production variant.
- * ActivatingTraffic: Turning on traffic for the production
- * variant.
- * Baking: Waiting period to monitor the CloudWatch alarms in the
- * automatic rollback configuration.
A message that describes the status of the production variant.
+ *ID of the compute allocation definition.
* @public */ - StatusMessage?: string | undefined; + ComputeQuotaId: string | undefined; /** - *The start time of the current status change.
+ *Version of the compute allocation definition.
* @public */ - StartTime?: Date | undefined; + ComputeQuotaVersion?: number | undefined; } /** - *The production variant summary for a deployment when an endpoint is creating or
- * updating with the CreateEndpoint
- * or UpdateEndpoint
- * operations. Describes the VariantStatus , weight and capacity for a
- * production variant associated with an endpoint.
The name of the variant.
- * @public - */ - VariantName: string | undefined; - +export interface DescribeComputeQuotaResponse { /** - *An array of DeployedImage objects that specify the Amazon EC2 Container
- * Registry paths of the inference images deployed on instances of this
- * ProductionVariant.
ARN of the compute allocation definition.
* @public */ - DeployedImages?: DeployedImage[] | undefined; + ComputeQuotaArn: string | undefined; /** - *The weight associated with the variant.
+ *ID of the compute allocation definition.
* @public */ - CurrentWeight?: number | undefined; + ComputeQuotaId: string | undefined; /** - *The requested weight for the variant in this deployment, as specified in the endpoint - * configuration for the endpoint. The value is taken from the request to the CreateEndpointConfig operation.
+ *Name of the compute allocation definition.
* @public */ - DesiredWeight?: number | undefined; + Name: string | undefined; /** - *The number of instances associated with the variant.
+ *Description of the compute allocation definition.
* @public */ - CurrentInstanceCount?: number | undefined; + Description?: string | undefined; /** - *The number of instances requested in this deployment, as specified in the endpoint - * configuration for the endpoint. The value is taken from the request to the CreateEndpointConfig operation.
+ *Version of the compute allocation definition.
* @public */ - DesiredInstanceCount?: number | undefined; + ComputeQuotaVersion: number | undefined; /** - *The type of instances associated with the variant.
+ *Status of the compute allocation definition.
* @public */ - InstanceType?: ProductionVariantInstanceType | undefined; + Status: SchedulerResourceStatus | undefined; /** - *This parameter is no longer supported. Elastic Inference (EI) is no longer - * available.
- *This parameter was used to specify the size of the EI instance to use for the - * production variant.
+ *Failure reason of the compute allocation definition.
* @public */ - AcceleratorType?: ProductionVariantAcceleratorType | undefined; + FailureReason?: string | undefined; /** - *The endpoint variant status which describes the current deployment stage status or - * operational status.
+ *ARN of the cluster.
* @public */ - VariantStatus?: ProductionVariantStatus[] | undefined; + ClusterArn?: string | undefined; /** - *The serverless configuration for the endpoint.
+ *Configuration of the compute allocation definition. This includes the resource sharing + * option, and the setting to preempt low priority tasks.
* @public */ - CurrentServerlessConfig?: ProductionVariantServerlessConfig | undefined; + ComputeQuotaConfig?: ComputeQuotaConfig | undefined; /** - *The serverless configuration requested for this deployment, as specified in the endpoint configuration for the endpoint.
+ *The target entity to allocate compute resources to.
* @public */ - DesiredServerlessConfig?: ProductionVariantServerlessConfig | undefined; + ComputeQuotaTarget: ComputeQuotaTarget | undefined; /** - *Settings that control the range in the number of instances that the endpoint provisions - * as it scales up or down to accommodate traffic.
+ *The state of the compute allocation being described. Use to enable or disable compute + * allocation.
+ *Default is Enabled.
Settings that control how the endpoint routes incoming traffic to the instances that the - * endpoint hosts.
+ *Creation time of the compute allocation configuration.
* @public */ - RoutingConfig?: ProductionVariantRoutingConfig | undefined; -} + CreationTime: Date | undefined; -/** - *The summary of an in-progress deployment when an endpoint is creating or updating with - * a new endpoint configuration.
- * @public - */ -export interface PendingDeploymentSummary { /** - *The name of the endpoint configuration used in the deployment.
+ *Information about the user who created or modified an experiment, trial, trial + * component, lineage group, project, or model card.
* @public */ - EndpointConfigName: string | undefined; + CreatedBy?: UserContext | undefined; /** - *An array of PendingProductionVariantSummary objects, one for each model hosted behind - * this endpoint for the in-progress deployment.
+ *Last modified time of the compute allocation configuration.
* @public */ - ProductionVariants?: PendingProductionVariantSummary[] | undefined; + LastModifiedTime?: Date | undefined; /** - *The start time of the deployment.
+ *Information about the user who created or modified an experiment, trial, trial + * component, lineage group, project, or model card.
* @public */ - StartTime?: Date | undefined; + LastModifiedBy?: UserContext | undefined; +} +/** + * @public + */ +export interface DescribeContextRequest { /** - *An array of PendingProductionVariantSummary objects, one for each model hosted behind
- * this endpoint in shadow mode with production traffic replicated from the model specified
- * on ProductionVariants for the in-progress deployment.
The name of the context to describe.
* @public */ - ShadowProductionVariants?: PendingProductionVariantSummary[] | undefined; + ContextName: string | undefined; } /** - *Describes weight and capacities for a production variant associated with an
- * endpoint. If you sent a request to the UpdateEndpointWeightsAndCapacities
- * API and the endpoint status is Updating, you get different desired and
- * current values.
The name of the variant.
+ *The name of the context.
* @public */ - VariantName: string | undefined; + ContextName?: string | undefined; /** - *An array of DeployedImage objects that specify the Amazon EC2 Container Registry paths of the
- * inference images deployed on instances of this ProductionVariant.
The Amazon Resource Name (ARN) of the context.
* @public */ - DeployedImages?: DeployedImage[] | undefined; + ContextArn?: string | undefined; /** - *The weight associated with the variant.
+ *The source of the context.
* @public */ - CurrentWeight?: number | undefined; + Source?: ContextSource | undefined; /** - *The requested weight, as specified in the
- * UpdateEndpointWeightsAndCapacities request.
The type of the context.
* @public */ - DesiredWeight?: number | undefined; + ContextType?: string | undefined; /** - *The number of instances associated with the variant.
+ *The description of the context.
* @public */ - CurrentInstanceCount?: number | undefined; + Description?: string | undefined; /** - *The number of instances requested in the
- * UpdateEndpointWeightsAndCapacities request.
A list of the context's properties.
* @public */ - DesiredInstanceCount?: number | undefined; + Properties?: RecordThe endpoint variant status which describes the current deployment stage status or - * operational status.
+ *When the context was created.
* @public */ - VariantStatus?: ProductionVariantStatus[] | undefined; + CreationTime?: Date | undefined; /** - *The serverless configuration for the endpoint.
+ *Information about the user who created or modified an experiment, trial, trial + * component, lineage group, project, or model card.
* @public */ - CurrentServerlessConfig?: ProductionVariantServerlessConfig | undefined; + CreatedBy?: UserContext | undefined; /** - *The serverless configuration requested for the endpoint update.
+ *When the context was last modified.
* @public */ - DesiredServerlessConfig?: ProductionVariantServerlessConfig | undefined; + LastModifiedTime?: Date | undefined; /** - *Settings that control the range in the number of instances that the endpoint provisions - * as it scales up or down to accommodate traffic.
+ *Information about the user who created or modified an experiment, trial, trial + * component, lineage group, project, or model card.
* @public */ - ManagedInstanceScaling?: ProductionVariantManagedInstanceScaling | undefined; + LastModifiedBy?: UserContext | undefined; /** - *Settings that control how the endpoint routes incoming traffic to the instances that the - * endpoint hosts.
+ *The Amazon Resource Name (ARN) of the lineage group.
* @public */ - RoutingConfig?: ProductionVariantRoutingConfig | undefined; + LineageGroupArn?: string | undefined; } /** * @public */ -export interface DescribeEndpointOutput { +export interface DescribeDataQualityJobDefinitionRequest { /** - *Name of the endpoint.
+ *The name of the data quality monitoring job definition to describe.
* @public */ - EndpointName: string | undefined; + JobDefinitionName: string | undefined; +} +/** + * @public + */ +export interface DescribeDataQualityJobDefinitionResponse { /** - *The Amazon Resource Name (ARN) of the endpoint.
+ *The Amazon Resource Name (ARN) of the data quality monitoring job definition.
* @public */ - EndpointArn: string | undefined; + JobDefinitionArn: string | undefined; /** - *The name of the endpoint configuration associated with this endpoint.
+ *The name of the data quality monitoring job definition.
* @public */ - EndpointConfigName?: string | undefined; + JobDefinitionName: string | undefined; /** - *An array of ProductionVariantSummary objects, one for each model hosted behind this - * endpoint.
+ *The time that the data quality monitoring job definition was created.
* @public */ - ProductionVariants?: ProductionVariantSummary[] | undefined; + CreationTime: Date | undefined; /** - *The currently active data capture configuration used by your Endpoint.
+ *The constraints and baselines for the data quality monitoring job definition.
* @public */ - DataCaptureConfig?: DataCaptureConfigSummary | undefined; + DataQualityBaselineConfig?: DataQualityBaselineConfig | undefined; /** - *The status of the endpoint.
- *
- * OutOfService: Endpoint is not available to take incoming
- * requests.
- * Creating: CreateEndpoint is executing.
- * Updating: UpdateEndpoint or UpdateEndpointWeightsAndCapacities is executing.
- * SystemUpdating: Endpoint is undergoing maintenance and cannot be
- * updated or deleted or re-scaled until it has completed. This maintenance
- * operation does not change any customer-specified values such as VPC config, KMS
- * encryption, model, instance type, or instance count.
- * RollingBack: Endpoint fails to scale up or down or change its
- * variant weight and is in the process of rolling back to its previous
- * configuration. Once the rollback completes, endpoint returns to an
- * InService status. This transitional status only applies to an
- * endpoint that has autoscaling enabled and is undergoing variant weight or
- * capacity changes as part of an UpdateEndpointWeightsAndCapacities call or when the UpdateEndpointWeightsAndCapacities operation is called
- * explicitly.
- * InService: Endpoint is available to process incoming
- * requests.
- * Deleting: DeleteEndpoint is executing.
- * Failed: Endpoint could not be created, updated, or re-scaled. Use
- * the FailureReason value returned by DescribeEndpoint for information about the failure. DeleteEndpoint is the only operation that can be performed on a
- * failed endpoint.
- * UpdateRollbackFailed: Both the rolling deployment and
- * auto-rollback failed. Your endpoint is in service with a mix of the old and new
- * endpoint configurations. For information about how to remedy this issue and
- * restore the endpoint's status to InService, see Rolling
- * Deployments.
Information about the container that runs the data quality monitoring job.
* @public */ - EndpointStatus: EndpointStatus | undefined; + DataQualityAppSpecification: DataQualityAppSpecification | undefined; /** - *If the status of the endpoint is Failed, the reason why it failed.
- *
The list of inputs for the data quality monitoring job. Currently endpoints are + * supported.
* @public */ - FailureReason?: string | undefined; + DataQualityJobInput: DataQualityJobInput | undefined; /** - *A timestamp that shows when the endpoint was created.
+ *The output configuration for monitoring jobs.
* @public */ - CreationTime: Date | undefined; + DataQualityJobOutputConfig: MonitoringOutputConfig | undefined; /** - *A timestamp that shows when the endpoint was last modified.
+ *Identifies the resources to deploy for a monitoring job.
* @public */ - LastModifiedTime: Date | undefined; + JobResources: MonitoringResources | undefined; /** - *The most recent deployment configuration for the endpoint.
+ *The networking configuration for the data quality monitoring job.
* @public */ - LastDeploymentConfig?: DeploymentConfig | undefined; + NetworkConfig?: MonitoringNetworkConfig | undefined; /** - *Returns the description of an endpoint configuration created using the
- * CreateEndpointConfig
- * API.
The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can + * assume to perform tasks on your behalf.
* @public */ - AsyncInferenceConfig?: AsyncInferenceConfig | undefined; + RoleArn: string | undefined; /** - *Returns the summary of an in-progress deployment. This field is only returned when the - * endpoint is creating or updating with a new endpoint configuration.
+ *A time limit for how long the monitoring job is allowed to run before stopping.
* @public */ - PendingDeploymentSummary?: PendingDeploymentSummary | undefined; + StoppingCondition?: MonitoringStoppingCondition | undefined; +} +/** + * @public + */ +export interface DescribeDeviceRequest { /** - *The configuration parameters for an explainer.
+ *Next token of device description.
* @public */ - ExplainerConfig?: ExplainerConfig | undefined; + NextToken?: string | undefined; /** - *An array of ProductionVariantSummary objects, one for each model that you want to host
- * at this endpoint in shadow mode with production traffic replicated from the model
- * specified on ProductionVariants.
The unique ID of the device.
* @public */ - ShadowProductionVariants?: ProductionVariantSummary[] | undefined; -} + DeviceName: string | undefined; -/** - * @public - */ -export interface DescribeEndpointConfigInput { /** - *The name of the endpoint configuration.
+ *The name of the fleet the devices belong to.
* @public */ - EndpointConfigName: string | undefined; + DeviceFleetName: string | undefined; } /** + *The model on the edge device.
* @public */ -export interface DescribeEndpointConfigOutput { +export interface EdgeModel { /** - *Name of the SageMaker endpoint configuration.
+ *The name of the model.
* @public */ - EndpointConfigName: string | undefined; + ModelName: string | undefined; /** - *The Amazon Resource Name (ARN) of the endpoint configuration.
+ *The model version.
* @public */ - EndpointConfigArn: string | undefined; + ModelVersion: string | undefined; /** - *An array of ProductionVariant objects, one for each model that you
- * want to host at this endpoint.
The timestamp of the last data sample taken.
* @public */ - ProductionVariants: ProductionVariant[] | undefined; + LatestSampleTime?: Date | undefined; + + /** + *The timestamp of the last inference that was made.
+ * @public + */ + LatestInference?: Date | undefined; +} + +/** + * @public + */ +export interface DescribeDeviceResponse { + /** + *The Amazon Resource Name (ARN) of the device.
+ * @public + */ + DeviceArn?: string | undefined; /** - *Configuration to control how SageMaker captures inference data.
+ *The unique identifier of the device.
* @public */ - DataCaptureConfig?: DataCaptureConfig | undefined; + DeviceName: string | undefined; /** - *Amazon Web Services KMS key ID Amazon SageMaker uses to encrypt data when storing it on the ML - * storage volume attached to the instance.
+ *A description of the device.
* @public */ - KmsKeyId?: string | undefined; + Description?: string | undefined; /** - *A timestamp that shows when the endpoint configuration was created.
+ *The name of the fleet the device belongs to.
* @public */ - CreationTime: Date | undefined; + DeviceFleetName: string | undefined; /** - *Returns the description of an endpoint configuration created using the
- * CreateEndpointConfig
- * API.
The Amazon Web Services Internet of Things (IoT) object thing name associated with the device.
* @public */ - AsyncInferenceConfig?: AsyncInferenceConfig | undefined; + IotThingName?: string | undefined; /** - *The configuration parameters for an explainer.
+ *The timestamp of the last registration or de-reregistration.
* @public */ - ExplainerConfig?: ExplainerConfig | undefined; + RegistrationTime: Date | undefined; /** - *An array of ProductionVariant objects, one for each model that you want
- * to host at this endpoint in shadow mode with production traffic replicated from the
- * model specified on ProductionVariants.
The last heartbeat received from the device.
* @public */ - ShadowProductionVariants?: ProductionVariant[] | undefined; + LatestHeartbeat?: Date | undefined; /** - *The Amazon Resource Name (ARN) of the IAM role that you assigned to the - * endpoint configuration.
+ *Models on the device.
* @public */ - ExecutionRoleArn?: string | undefined; + Models?: EdgeModel[] | undefined; /** - *Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources - * have access to. You can control access to and from your resources by configuring a VPC. - * For more information, see Give SageMaker Access to - * Resources in your Amazon VPC.
+ *The maximum number of models.
* @public */ - VpcConfig?: VpcConfig | undefined; + MaxModels?: number | undefined; /** - *Indicates whether all model containers deployed to the endpoint are isolated. If they - * are, no inbound or outbound network calls can be made to or from the model - * containers.
+ *The response from the last list when returning a list large enough to need tokening.
* @public */ - EnableNetworkIsolation?: boolean | undefined; -} + NextToken?: string | undefined; -/** - * @public - */ -export interface DescribeExperimentRequest { /** - *The name of the experiment to describe.
+ *Edge Manager agent version.
* @public */ - ExperimentName: string | undefined; + AgentVersion?: string | undefined; } /** - *The source of the experiment.
* @public */ -export interface ExperimentSource { - /** - *The Amazon Resource Name (ARN) of the source.
- * @public - */ - SourceArn: string | undefined; - +export interface DescribeDeviceFleetRequest { /** - *The source type.
+ *The name of the fleet.
* @public */ - SourceType?: string | undefined; + DeviceFleetName: string | undefined; } /** * @public */ -export interface DescribeExperimentResponse { - /** - *The name of the experiment.
- * @public - */ - ExperimentName?: string | undefined; - +export interface DescribeDeviceFleetResponse { /** - *The Amazon Resource Name (ARN) of the experiment.
+ *The name of the fleet.
* @public */ - ExperimentArn?: string | undefined; + DeviceFleetName: string | undefined; /** - *The name of the experiment as displayed. If DisplayName isn't specified,
- * ExperimentName is displayed.
The The Amazon Resource Name (ARN) of the fleet.
* @public */ - DisplayName?: string | undefined; + DeviceFleetArn: string | undefined; /** - *The Amazon Resource Name (ARN) of the source and, optionally, the type.
+ *The output configuration for storing sampled data.
* @public */ - Source?: ExperimentSource | undefined; + OutputConfig: EdgeOutputConfig | undefined; /** - *The description of the experiment.
+ *A description of the fleet.
* @public */ Description?: string | undefined; /** - *When the experiment was created.
+ *Timestamp of when the device fleet was created.
* @public */ - CreationTime?: Date | undefined; + CreationTime: Date | undefined; /** - *Who created the experiment.
+ *Timestamp of when the device fleet was last updated.
* @public */ - CreatedBy?: UserContext | undefined; + LastModifiedTime: Date | undefined; /** - *When the experiment was last modified.
+ *The Amazon Resource Name (ARN) that has access to Amazon Web Services Internet of Things (IoT).
* @public */ - LastModifiedTime?: Date | undefined; + RoleArn?: string | undefined; /** - *Who last modified the experiment.
+ *The Amazon Resource Name (ARN) alias created in Amazon Web Services Internet of Things (IoT).
* @public */ - LastModifiedBy?: UserContext | undefined; + IotRoleAlias?: string | undefined; } /** * @public */ -export interface DescribeFeatureGroupRequest { - /** - *The name or Amazon Resource Name (ARN) of the FeatureGroup you want
- * described.
A token to resume pagination of the list of Features
- * (FeatureDefinitions). 2,500 Features are returned by
- * default.
The domain ID.
* @public */ - NextToken?: string | undefined; + DomainId: string | undefined; } /** * @public * @enum */ -export const FeatureGroupStatus = { - CREATED: "Created", - CREATE_FAILED: "CreateFailed", - CREATING: "Creating", - DELETE_FAILED: "DeleteFailed", - DELETING: "Deleting", -} as const; - -/** - * @public - */ -export type FeatureGroupStatus = (typeof FeatureGroupStatus)[keyof typeof FeatureGroupStatus]; - -/** - * @public - * @enum - */ -export const LastUpdateStatusValue = { - FAILED: "Failed", - IN_PROGRESS: "InProgress", - SUCCESSFUL: "Successful", +export const DomainStatus = { + Delete_Failed: "Delete_Failed", + Deleting: "Deleting", + Failed: "Failed", + InService: "InService", + Pending: "Pending", + Update_Failed: "Update_Failed", + Updating: "Updating", } as const; /** * @public */ -export type LastUpdateStatusValue = (typeof LastUpdateStatusValue)[keyof typeof LastUpdateStatusValue]; +export type DomainStatus = (typeof DomainStatus)[keyof typeof DomainStatus]; /** - *A value that indicates whether the update was successful.
* @public */ -export interface LastUpdateStatus { - /** - *A value that indicates whether the update was made successful.
- * @public - */ - Status: LastUpdateStatusValue | undefined; - +export interface DescribeDomainResponse { /** - *If the update wasn't successful, indicates the reason why it failed.
+ *The domain's Amazon Resource Name (ARN).
* @public */ - FailureReason?: string | undefined; -} - -/** - * @public - * @enum - */ -export const OfflineStoreStatusValue = { - ACTIVE: "Active", - BLOCKED: "Blocked", - DISABLED: "Disabled", -} as const; - -/** - * @public - */ -export type OfflineStoreStatusValue = (typeof OfflineStoreStatusValue)[keyof typeof OfflineStoreStatusValue]; + DomainArn?: string | undefined; -/** - *The status of OfflineStore.
An OfflineStore status.
The domain ID.
* @public */ - Status: OfflineStoreStatusValue | undefined; + DomainId?: string | undefined; /** - *The justification for why the OfflineStoreStatus is Blocked (if applicable).
+ *The domain name.
* @public */ - BlockedReason?: string | undefined; -} + DomainName?: string | undefined; -/** - *Active throughput configuration of the feature group. There are two modes:
- * ON_DEMAND and PROVISIONED. With on-demand mode, you are
- * charged for data reads and writes that your application performs on your feature group. You
- * do not need to specify read and write throughput because Feature Store accommodates your
- * workloads as they ramp up and down. You can switch a feature group to on-demand only once
- * in a 24 hour period. With provisioned throughput mode, you specify the read and write
- * capacity per second that you expect your application to require, and you are billed based
- * on those limits. Exceeding provisioned throughput will result in your requests being
- * throttled.
Note: PROVISIONED throughput mode is supported only for feature groups that
- * are offline-only, or use the
- * Standard
- * tier online store.
The mode used for your feature group throughput: ON_DEMAND or
- * PROVISIONED.
The ID of the Amazon Elastic File System managed by this Domain.
* @public */ - ThroughputMode: ThroughputMode | undefined; + HomeEfsFileSystemId?: string | undefined; /** - *For provisioned feature groups with online store enabled, this indicates the read - * throughput you are billed for and can consume without throttling.
- *This field is not applicable for on-demand feature groups.
+ *The IAM Identity Center managed application instance ID.
* @public */ - ProvisionedReadCapacityUnits?: number | undefined; + SingleSignOnManagedApplicationInstanceId?: string | undefined; /** - *For provisioned feature groups, this indicates the write throughput you are billed for - * and can consume without throttling.
- *This field is not applicable for on-demand feature groups.
+ *The ARN of the application managed by SageMaker in IAM Identity Center. This value + * is only returned for domains created after October 1, 2023.
* @public */ - ProvisionedWriteCapacityUnits?: number | undefined; -} + SingleSignOnApplicationArn?: string | undefined; -/** - * @public - */ -export interface DescribeFeatureGroupResponse { /** - *The Amazon Resource Name (ARN) of the FeatureGroup.
The status.
* @public */ - FeatureGroupArn: string | undefined; + Status?: DomainStatus | undefined; /** - *he name of the FeatureGroup.
The creation time.
* @public */ - FeatureGroupName: string | undefined; + CreationTime?: Date | undefined; /** - *The name of the Feature used for RecordIdentifier, whose value
- * uniquely identifies a record stored in the feature store.
The last modified time.
* @public */ - RecordIdentifierFeatureName: string | undefined; + LastModifiedTime?: Date | undefined; /** - *The name of the feature that stores the EventTime of a Record in a
- * FeatureGroup.
An EventTime is a point in time when a new event occurs that corresponds
- * to the creation or update of a Record in a FeatureGroup. All
- * Records in the FeatureGroup have a corresponding
- * EventTime.
The failure reason.
* @public */ - EventTimeFeatureName: string | undefined; + FailureReason?: string | undefined; /** - *A list of the Features in the FeatureGroup. Each feature is
- * defined by a FeatureName and FeatureType.
The ID of the security group that authorizes traffic between the
+ * RSessionGateway apps and the RStudioServerPro app.
A timestamp indicating when SageMaker created the FeatureGroup.
The domain's authentication mode.
* @public */ - CreationTime: Date | undefined; + AuthMode?: AuthMode | undefined; /** - *A timestamp indicating when the feature group was last updated.
+ *Settings which are applied to UserProfiles in this domain if settings are not explicitly + * specified in a given UserProfile.
* @public */ - LastModifiedTime?: Date | undefined; + DefaultUserSettings?: UserSettings | undefined; /** - *The configuration for the OnlineStore.
A collection of Domain settings.
The configuration of the offline store. It includes the following configurations:
+ *Specifies the VPC used for non-EFS traffic. The default value is
+ * PublicInternetOnly.
Amazon S3 location of the offline store.
- *Configuration of the Glue data catalog.
- *Table format of the offline store.
- *Option to disable the automatic creation of a Glue table for the offline - * store.
+ *
+ * PublicInternetOnly - Non-EFS traffic is through a VPC managed by Amazon SageMaker, which allows direct internet access
Encryption configuration.
+ *
+ * VpcOnly - All traffic is through the specified VPC and subnets
Active throughput configuration of the feature group. There are two modes:
- * ON_DEMAND and PROVISIONED. With on-demand mode, you are
- * charged for data reads and writes that your application performs on your feature group. You
- * do not need to specify read and write throughput because Feature Store accommodates your
- * workloads as they ramp up and down. You can switch a feature group to on-demand only once
- * in a 24 hour period. With provisioned throughput mode, you specify the read and write
- * capacity per second that you expect your application to require, and you are billed based
- * on those limits. Exceeding provisioned throughput will result in your requests being
- * throttled.
Note: PROVISIONED throughput mode is supported only for feature groups that
- * are offline-only, or use the
- * Standard
- * tier online store.
The Amazon Resource Name (ARN) of the IAM execution role used to persist data into the - * OfflineStore if an OfflineStoreConfig is provided.
+ * @deprecated + * + *Use KmsKeyId.
The status of the feature group.
+ *The VPC subnets that the domain uses for communication.
* @public */ - FeatureGroupStatus?: FeatureGroupStatus | undefined; + SubnetIds?: string[] | undefined; /** - *The status of the OfflineStore. Notifies you if replicating data into the
- * OfflineStore has failed. Returns either: Active or
- * Blocked
- *
The domain's URL.
* @public */ - OfflineStoreStatus?: OfflineStoreStatus | undefined; + Url?: string | undefined; /** - *A value indicating whether the update made to the feature group was successful.
+ *The ID of the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.
* @public */ - LastUpdateStatus?: LastUpdateStatus | undefined; + VpcId?: string | undefined; /** - *The reason that the FeatureGroup failed to be replicated in the
- * OfflineStore. This is failure can occur because:
The FeatureGroup could not be created in the
- * OfflineStore.
The FeatureGroup could not be deleted from the
- * OfflineStore.
The Amazon Web Services KMS customer managed key used to encrypt the EFS volume attached to + * the domain.
* @public */ - FailureReason?: string | undefined; + KmsKeyId?: string | undefined; /** - *A free form description of the feature group.
+ *The entity that creates and manages the required security groups for inter-app
+ * communication in VPCOnly mode. Required when
+ * CreateDomain.AppNetworkAccessType is VPCOnly and
+ * DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is
+ * provided.
A token to resume pagination of the list of Features
- * (FeatureDefinitions).
Indicates whether custom tag propagation is supported for the domain.
* @public */ - NextToken: string | undefined; + TagPropagation?: TagPropagation | undefined; /** - *The size of the OnlineStore in bytes.
The default settings for shared spaces that users create in the domain.
* @public */ - OnlineStoreTotalSizeBytes?: number | undefined; + DefaultSpaceSettings?: DefaultSpaceSettings | undefined; } /** * @public */ -export interface DescribeFeatureMetadataRequest { +export interface DescribeEdgeDeploymentPlanRequest { /** - *The name or Amazon Resource Name (ARN) of the feature group containing the - * feature.
+ *The name of the deployment plan to describe.
* @public */ - FeatureGroupName: string | undefined; + EdgeDeploymentPlanName: string | undefined; /** - *The name of the feature.
+ *If the edge deployment plan has enough stages to require tokening, then this is the + * response from the last list of stages returned.
* @public */ - FeatureName: string | undefined; + NextToken?: string | undefined; + + /** + *The maximum number of results to select (50 by default).
+ * @public + */ + MaxResults?: number | undefined; } /** - *A key-value pair that you specify to describe the feature.
* @public */ -export interface FeatureParameter { +export interface DescribeEdgeDeploymentPlanResponse { /** - *A key that must contain a value to describe the feature.
+ *The ARN of edge deployment plan.
* @public */ - Key?: string | undefined; + EdgeDeploymentPlanArn: string | undefined; /** - *The value that belongs to a key.
+ *The name of the edge deployment plan.
* @public */ - Value?: string | undefined; -} + EdgeDeploymentPlanName: string | undefined; -/** - * @public - */ -export interface DescribeFeatureMetadataResponse { /** - *The Amazon Resource Number (ARN) of the feature group that contains the feature.
+ *List of models associated with the edge deployment plan.
* @public */ - FeatureGroupArn: string | undefined; + ModelConfigs: EdgeDeploymentModelConfig[] | undefined; /** - *The name of the feature group that you've specified.
+ *The device fleet used for this edge deployment plan.
* @public */ - FeatureGroupName: string | undefined; + DeviceFleetName: string | undefined; /** - *The name of the feature that you've specified.
+ *The number of edge devices with the successful deployment.
* @public */ - FeatureName: string | undefined; + EdgeDeploymentSuccess?: number | undefined; /** - *The data type of the feature.
+ *The number of edge devices yet to pick up deployment, or in progress.
* @public */ - FeatureType: FeatureType | undefined; + EdgeDeploymentPending?: number | undefined; /** - *A timestamp indicating when the feature was created.
+ *The number of edge devices that failed the deployment.
* @public */ - CreationTime: Date | undefined; + EdgeDeploymentFailed?: number | undefined; /** - *A timestamp indicating when the metadata for the feature group was modified. For - * example, if you add a parameter describing the feature, the timestamp changes to reflect - * the last time you
+ *List of stages in the edge deployment plan.
* @public */ - LastModifiedTime: Date | undefined; + Stages: DeploymentStageStatusSummary[] | undefined; /** - *The description you added to describe the feature.
+ *Token to use when calling the next set of stages in the edge deployment plan.
* @public */ - Description?: string | undefined; + NextToken?: string | undefined; /** - *The key-value pairs that you added to describe the feature.
+ *The time when the edge deployment plan was created.
* @public */ - Parameters?: FeatureParameter[] | undefined; + CreationTime?: Date | undefined; + + /** + *The time when the edge deployment plan was last updated.
+ * @public + */ + LastModifiedTime?: Date | undefined; } /** * @public */ -export interface DescribeFlowDefinitionRequest { +export interface DescribeEdgePackagingJobRequest { /** - *The name of the flow definition.
+ *The name of the edge packaging job.
* @public */ - FlowDefinitionName: string | undefined; + EdgePackagingJobName: string | undefined; } /** * @public * @enum */ -export const FlowDefinitionStatus = { - ACTIVE: "Active", - DELETING: "Deleting", - FAILED: "Failed", - INITIALIZING: "Initializing", +export const EdgePackagingJobStatus = { + Completed: "COMPLETED", + Failed: "FAILED", + InProgress: "INPROGRESS", + Starting: "STARTING", + Stopped: "STOPPED", + Stopping: "STOPPING", } as const; /** * @public */ -export type FlowDefinitionStatus = (typeof FlowDefinitionStatus)[keyof typeof FlowDefinitionStatus]; +export type EdgePackagingJobStatus = (typeof EdgePackagingJobStatus)[keyof typeof EdgePackagingJobStatus]; /** * @public + * @enum */ -export interface DescribeFlowDefinitionResponse { - /** - *The Amazon Resource Name (ARN) of the flow defintion.
- * @public - */ - FlowDefinitionArn: string | undefined; - - /** - *The Amazon Resource Name (ARN) of the flow definition.
- * @public - */ - FlowDefinitionName: string | undefined; - - /** - *The status of the flow definition. Valid values are listed below.
- * @public - */ - FlowDefinitionStatus: FlowDefinitionStatus | undefined; - - /** - *The timestamp when the flow definition was created.
- * @public - */ - CreationTime: Date | undefined; - - /** - *Container for configuring the source of human task requests. Used to specify if - * Amazon Rekognition or Amazon Textract is used as an integration source.
- * @public - */ - HumanLoopRequestSource?: HumanLoopRequestSource | undefined; +export const EdgePresetDeploymentStatus = { + Completed: "COMPLETED", + Failed: "FAILED", +} as const; - /** - *An object containing information about what triggers a human review workflow.
- * @public - */ - HumanLoopActivationConfig?: HumanLoopActivationConfig | undefined; +/** + * @public + */ +export type EdgePresetDeploymentStatus = (typeof EdgePresetDeploymentStatus)[keyof typeof EdgePresetDeploymentStatus]; +/** + *The output of a SageMaker Edge Manager deployable resource.
+ * @public + */ +export interface EdgePresetDeploymentOutput { /** - *An object containing information about who works on the task, the workforce task price, and other task details.
+ *The deployment type created by SageMaker Edge Manager. Currently only + * supports Amazon Web Services IoT Greengrass Version 2 components.
* @public */ - HumanLoopConfig?: HumanLoopConfig | undefined; + Type: EdgePresetDeploymentType | undefined; /** - *An object containing information about the output file.
+ *The Amazon Resource Name (ARN) of the generated deployable resource.
* @public */ - OutputConfig: FlowDefinitionOutputConfig | undefined; + Artifact?: string | undefined; /** - *The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) execution role for the flow definition.
+ *The status of the deployable resource.
* @public */ - RoleArn: string | undefined; + Status?: EdgePresetDeploymentStatus | undefined; /** - *The reason your flow definition failed.
+ *Returns a message describing the status of the deployed resource.
* @public */ - FailureReason?: string | undefined; + StatusMessage?: string | undefined; } /** * @public */ -export interface DescribeHubRequest { +export interface DescribeEdgePackagingJobResponse { /** - *The name of the hub to describe.
+ *The Amazon Resource Name (ARN) of the edge packaging job.
* @public */ - HubName: string | undefined; -} - -/** - * @public - * @enum - */ -export const HubStatus = { - CREATE_FAILED: "CreateFailed", - CREATING: "Creating", - DELETE_FAILED: "DeleteFailed", - DELETING: "Deleting", - IN_SERVICE: "InService", - UPDATE_FAILED: "UpdateFailed", - UPDATING: "Updating", -} as const; - -/** - * @public - */ -export type HubStatus = (typeof HubStatus)[keyof typeof HubStatus]; + EdgePackagingJobArn: string | undefined; -/** - * @public - */ -export interface DescribeHubResponse { /** - *The name of the hub.
+ *The name of the edge packaging job.
* @public */ - HubName: string | undefined; + EdgePackagingJobName: string | undefined; /** - *The Amazon Resource Name (ARN) of the hub.
+ *The name of the SageMaker Neo compilation job that is used to locate model artifacts that are being packaged.
* @public */ - HubArn: string | undefined; + CompilationJobName?: string | undefined; /** - *The display name of the hub.
+ *The name of the model.
* @public */ - HubDisplayName?: string | undefined; + ModelName?: string | undefined; /** - *A description of the hub.
+ *The version of the model.
* @public */ - HubDescription?: string | undefined; + ModelVersion?: string | undefined; /** - *The searchable keywords for the hub.
+ *The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to download and upload the model, and to contact Neo.
* @public */ - HubSearchKeywords?: string[] | undefined; + RoleArn?: string | undefined; /** - *The Amazon S3 storage configuration for the hub.
+ *The output configuration for the edge packaging job.
* @public */ - S3StorageConfig?: HubS3StorageConfig | undefined; + OutputConfig?: EdgeOutputConfig | undefined; /** - *The status of the hub.
+ *The Amazon Web Services KMS key to use when encrypting the EBS volume the job run on.
* @public */ - HubStatus: HubStatus | undefined; + ResourceKey?: string | undefined; /** - *The failure reason if importing hub content failed.
+ *The current status of the packaging job.
* @public */ - FailureReason?: string | undefined; + EdgePackagingJobStatus: EdgePackagingJobStatus | undefined; /** - *The date and time that the hub was created.
+ *Returns a message describing the job status and error messages.
* @public */ - CreationTime: Date | undefined; + EdgePackagingJobStatusMessage?: string | undefined; /** - *The date and time that the hub was last modified.
+ *The timestamp of when the packaging job was created.
* @public */ - LastModifiedTime: Date | undefined; -} + CreationTime?: Date | undefined; -/** - * @public - */ -export interface DescribeHubContentRequest { /** - *The name of the hub that contains the content to describe.
+ *The timestamp of when the job was last updated.
* @public */ - HubName: string | undefined; + LastModifiedTime?: Date | undefined; /** - *The type of content in the hub.
+ *The Amazon Simple Storage (S3) URI where model artifacts ares stored.
* @public */ - HubContentType: HubContentType | undefined; + ModelArtifact?: string | undefined; /** - *The name of the content to describe.
+ *The signature document of files in the model artifact.
* @public */ - HubContentName: string | undefined; + ModelSignature?: string | undefined; /** - *The version of the content to describe.
+ *The output of a SageMaker Edge Manager deployable resource.
* @public */ - HubContentVersion?: string | undefined; + PresetDeploymentOutput?: EdgePresetDeploymentOutput | undefined; } /** - *Any dependencies related to hub content, such as scripts, model artifacts, datasets, or notebooks.
* @public */ -export interface HubContentDependency { - /** - *The hub content dependency origin path.
- * @public - */ - DependencyOriginPath?: string | undefined; - +export interface DescribeEndpointInput { /** - *The hub content dependency copy path.
+ *The name of the endpoint.
* @public */ - DependencyCopyPath?: string | undefined; + EndpointName: string | undefined; } /** * @public * @enum */ -export const HubContentStatus = { - AVAILABLE: "Available", - DELETE_FAILED: "DeleteFailed", +export const EndpointStatus = { + CREATING: "Creating", DELETING: "Deleting", - IMPORTING: "Importing", - IMPORT_FAILED: "ImportFailed", + FAILED: "Failed", + IN_SERVICE: "InService", + OUT_OF_SERVICE: "OutOfService", + ROLLING_BACK: "RollingBack", + SYSTEM_UPDATING: "SystemUpdating", + UPDATE_ROLLBACK_FAILED: "UpdateRollbackFailed", + UPDATING: "Updating", } as const; /** * @public */ -export type HubContentStatus = (typeof HubContentStatus)[keyof typeof HubContentStatus]; +export type EndpointStatus = (typeof EndpointStatus)[keyof typeof EndpointStatus]; /** * @public * @enum */ -export const HubContentSupportStatus = { - DEPRECATED: "Deprecated", - SUPPORTED: "Supported", +export const VariantStatus = { + ACTIVATING_TRAFFIC: "ActivatingTraffic", + BAKING: "Baking", + CREATING: "Creating", + DELETING: "Deleting", + UPDATING: "Updating", } as const; /** * @public */ -export type HubContentSupportStatus = (typeof HubContentSupportStatus)[keyof typeof HubContentSupportStatus]; +export type VariantStatus = (typeof VariantStatus)[keyof typeof VariantStatus]; /** + *Describes the status of the production variant.
* @public */ -export interface DescribeHubContentResponse { - /** - *The name of the hub content.
- * @public - */ - HubContentName: string | undefined; - - /** - *The Amazon Resource Name (ARN) of the hub content.
- * @public - */ - HubContentArn: string | undefined; - - /** - *The version of the hub content.
- * @public - */ - HubContentVersion: string | undefined; - - /** - *The type of hub content.
- * @public - */ - HubContentType: HubContentType | undefined; - - /** - *The document schema version for the hub content.
- * @public - */ - DocumentSchemaVersion: string | undefined; - - /** - *The name of the hub that contains the content.
- * @public - */ - HubName: string | undefined; - +export interface ProductionVariantStatus { /** - *The Amazon Resource Name (ARN) of the hub that contains the content.
+ *The endpoint variant status which describes the current deployment stage status or + * operational status.
+ *
+ * Creating: Creating inference resources for the production
+ * variant.
+ * Deleting: Terminating inference resources for the production
+ * variant.
+ * Updating: Updating capacity for the production variant.
+ * ActivatingTraffic: Turning on traffic for the production
+ * variant.
+ * Baking: Waiting period to monitor the CloudWatch alarms in the
+ * automatic rollback configuration.
The display name of the hub content.
+ *A message that describes the status of the production variant.
* @public */ - HubContentDisplayName?: string | undefined; + StatusMessage?: string | undefined; /** - *A description of the hub content.
+ *The start time of the current status change.
* @public */ - HubContentDescription?: string | undefined; + StartTime?: Date | undefined; +} +/** + *The production variant summary for a deployment when an endpoint is creating or
+ * updating with the CreateEndpoint
+ * or UpdateEndpoint
+ * operations. Describes the VariantStatus , weight and capacity for a
+ * production variant associated with an endpoint.
A string that provides a description of the hub content. This string can include links, tables, and standard markdown formating.
+ *The name of the variant.
* @public */ - HubContentMarkdown?: string | undefined; + VariantName: string | undefined; /** - *The hub content document that describes information about the hub content such as type, associated containers, scripts, and more.
+ *An array of DeployedImage objects that specify the Amazon EC2 Container
+ * Registry paths of the inference images deployed on instances of this
+ * ProductionVariant.
The ARN of the public hub content.
+ *The weight associated with the variant.
* @public */ - SageMakerPublicHubContentArn?: string | undefined; + CurrentWeight?: number | undefined; /** - *The minimum version of the hub content.
+ *The requested weight for the variant in this deployment, as specified in the endpoint + * configuration for the endpoint. The value is taken from the request to the CreateEndpointConfig operation.
* @public */ - ReferenceMinVersion?: string | undefined; + DesiredWeight?: number | undefined; /** - *The support status of the hub content.
+ *The number of instances associated with the variant.
* @public */ - SupportStatus?: HubContentSupportStatus | undefined; + CurrentInstanceCount?: number | undefined; /** - *The searchable keywords for the hub content.
+ *The number of instances requested in this deployment, as specified in the endpoint + * configuration for the endpoint. The value is taken from the request to the CreateEndpointConfig operation.
* @public */ - HubContentSearchKeywords?: string[] | undefined; + DesiredInstanceCount?: number | undefined; /** - *The location of any dependencies that the hub content has, such as scripts, model artifacts, datasets, or notebooks.
+ *The type of instances associated with the variant.
* @public */ - HubContentDependencies?: HubContentDependency[] | undefined; + InstanceType?: ProductionVariantInstanceType | undefined; /** - *The status of the hub content.
+ *This parameter is no longer supported. Elastic Inference (EI) is no longer + * available.
+ *This parameter was used to specify the size of the EI instance to use for the + * production variant.
* @public */ - HubContentStatus: HubContentStatus | undefined; + AcceleratorType?: ProductionVariantAcceleratorType | undefined; /** - *The failure reason if importing hub content failed.
+ *The endpoint variant status which describes the current deployment stage status or + * operational status.
* @public */ - FailureReason?: string | undefined; + VariantStatus?: ProductionVariantStatus[] | undefined; /** - *The date and time that hub content was created.
+ *The serverless configuration for the endpoint.
* @public */ - CreationTime: Date | undefined; -} + CurrentServerlessConfig?: ProductionVariantServerlessConfig | undefined; -/** - * @public - */ -export interface DescribeHumanTaskUiRequest { /** - *The name of the human task user interface - * (worker task template) you want information about.
+ *The serverless configuration requested for this deployment, as specified in the endpoint configuration for the endpoint.
* @public */ - HumanTaskUiName: string | undefined; -} - -/** - * @public - * @enum - */ -export const HumanTaskUiStatus = { - ACTIVE: "Active", - DELETING: "Deleting", -} as const; - -/** - * @public - */ -export type HumanTaskUiStatus = (typeof HumanTaskUiStatus)[keyof typeof HumanTaskUiStatus]; + DesiredServerlessConfig?: ProductionVariantServerlessConfig | undefined; -/** - *Container for user interface template information.
- * @public - */ -export interface UiTemplateInfo { /** - *The URL for the user interface template.
+ *Settings that control the range in the number of instances that the endpoint provisions + * as it scales up or down to accommodate traffic.
* @public */ - Url?: string | undefined; + ManagedInstanceScaling?: ProductionVariantManagedInstanceScaling | undefined; /** - *The SHA-256 digest of the contents of the template.
+ *Settings that control how the endpoint routes incoming traffic to the instances that the + * endpoint hosts.
* @public */ - ContentSha256?: string | undefined; + RoutingConfig?: ProductionVariantRoutingConfig | undefined; } /** + *The summary of an in-progress deployment when an endpoint is creating or updating with + * a new endpoint configuration.
* @public */ -export interface DescribeHumanTaskUiResponse { - /** - *The Amazon Resource Name (ARN) of the human task user interface (worker task template).
- * @public - */ - HumanTaskUiArn: string | undefined; - +export interface PendingDeploymentSummary { /** - *The name of the human task user interface (worker task template).
+ *The name of the endpoint configuration used in the deployment.
* @public */ - HumanTaskUiName: string | undefined; + EndpointConfigName: string | undefined; /** - *The status of the human task user interface (worker task template). Valid values are listed below.
+ *An array of PendingProductionVariantSummary objects, one for each model hosted behind + * this endpoint for the in-progress deployment.
* @public */ - HumanTaskUiStatus?: HumanTaskUiStatus | undefined; + ProductionVariants?: PendingProductionVariantSummary[] | undefined; /** - *The timestamp when the human task user interface was created.
+ *The start time of the deployment.
* @public */ - CreationTime: Date | undefined; + StartTime?: Date | undefined; /** - *Container for user interface template information.
+ *An array of PendingProductionVariantSummary objects, one for each model hosted behind
+ * this endpoint in shadow mode with production traffic replicated from the model specified
+ * on ProductionVariants for the in-progress deployment.
Describes weight and capacities for a production variant associated with an
+ * endpoint. If you sent a request to the UpdateEndpointWeightsAndCapacities
+ * API and the endpoint status is Updating, you get different desired and
+ * current values.
The name of the tuning job.
+ *The name of the variant.
* @public */ - HyperParameterTuningJobName: string | undefined; -} + VariantName: string | undefined; -/** - *Shows the latest objective metric emitted by a training job that was launched by a
- * hyperparameter tuning job. You define the objective metric in the
- * HyperParameterTuningJobObjective parameter of HyperParameterTuningJobConfig.
Select if you want to minimize or maximize the objective metric during hyperparameter - * tuning.
+ *An array of DeployedImage objects that specify the Amazon EC2 Container Registry paths of the
+ * inference images deployed on instances of this ProductionVariant.
The name of the objective metric. For SageMaker built-in algorithms, metrics are defined - * per algorithm. See the metrics for XGBoost as an - * example. You can also use a custom algorithm for training and define your own metrics. - * For more information, see Define metrics and environment variables.
+ *The weight associated with the variant.
* @public */ - MetricName: string | undefined; + CurrentWeight?: number | undefined; /** - *The value of the objective metric.
+ *The requested weight, as specified in the
+ * UpdateEndpointWeightsAndCapacities request.
The number of instances associated with the variant.
+ * @public + */ + CurrentInstanceCount?: number | undefined; -/** - *The container for the summary information about a training job.
- * @public - */ -export interface HyperParameterTrainingJobSummary { /** - *The training job definition name.
+ *The number of instances requested in the
+ * UpdateEndpointWeightsAndCapacities request.
The name of the training job.
+ *The endpoint variant status which describes the current deployment stage status or + * operational status.
* @public */ - TrainingJobName: string | undefined; + VariantStatus?: ProductionVariantStatus[] | undefined; /** - *The Amazon Resource Name (ARN) of the training job.
+ *The serverless configuration for the endpoint.
* @public */ - TrainingJobArn: string | undefined; + CurrentServerlessConfig?: ProductionVariantServerlessConfig | undefined; /** - *The HyperParameter tuning job that launched the training job.
+ *The serverless configuration requested for the endpoint update.
* @public */ - TuningJobName?: string | undefined; + DesiredServerlessConfig?: ProductionVariantServerlessConfig | undefined; /** - *The date and time that the training job was created.
+ *Settings that control the range in the number of instances that the endpoint provisions + * as it scales up or down to accommodate traffic.
* @public */ - CreationTime: Date | undefined; + ManagedInstanceScaling?: ProductionVariantManagedInstanceScaling | undefined; /** - *The date and time that the training job started.
+ *Settings that control how the endpoint routes incoming traffic to the instances that the + * endpoint hosts.
* @public */ - TrainingStartTime?: Date | undefined; + RoutingConfig?: ProductionVariantRoutingConfig | undefined; +} +/** + * @public + */ +export interface DescribeEndpointOutput { /** - *Specifies the time when the training job ends on training instances. You are billed
- * for the time interval between the value of TrainingStartTime and this time.
- * For successful jobs and stopped jobs, this is the time after model artifacts are
- * uploaded. For failed jobs, this is the time when SageMaker detects a job failure.
Name of the endpoint.
* @public */ - TrainingEndTime?: Date | undefined; + EndpointName: string | undefined; /** - *The - * status - * of the training job.
+ *The Amazon Resource Name (ARN) of the endpoint.
* @public */ - TrainingJobStatus: TrainingJobStatus | undefined; + EndpointArn: string | undefined; /** - *A - * list of the hyperparameters for which you specified ranges to - * search.
+ *The name of the endpoint configuration associated with this endpoint.
* @public */ - TunedHyperParameters: RecordThe - * reason that the training job failed. - *
+ *An array of ProductionVariantSummary objects, one for each model hosted behind this + * endpoint.
* @public */ - FailureReason?: string | undefined; + ProductionVariants?: ProductionVariantSummary[] | undefined; /** - *The FinalHyperParameterTuningJobObjectiveMetric object that specifies the - * value - * of the - * objective - * metric of the tuning job that launched this training job.
+ *The currently active data capture configuration used by your Endpoint.
* @public */ - FinalHyperParameterTuningJobObjectiveMetric?: FinalHyperParameterTuningJobObjectiveMetric | undefined; + DataCaptureConfig?: DataCaptureConfigSummary | undefined; /** - *The status of the objective metric for the training job:
+ *The status of the endpoint.
*Succeeded: The - * final - * objective metric for the training job was evaluated by the - * hyperparameter tuning job and - * used - * in the hyperparameter tuning process.
+ *
+ * OutOfService: Endpoint is not available to take incoming
+ * requests.
+ * Creating: CreateEndpoint is executing.
Pending: The training job is in progress and evaluation of its final objective - * metric is pending.
+ *
+ * Updating: UpdateEndpoint or UpdateEndpointWeightsAndCapacities is executing.
+ * SystemUpdating: Endpoint is undergoing maintenance and cannot be
+ * updated or deleted or re-scaled until it has completed. This maintenance
+ * operation does not change any customer-specified values such as VPC config, KMS
+ * encryption, model, instance type, or instance count.
+ * RollingBack: Endpoint fails to scale up or down or change its
+ * variant weight and is in the process of rolling back to its previous
+ * configuration. Once the rollback completes, endpoint returns to an
+ * InService status. This transitional status only applies to an
+ * endpoint that has autoscaling enabled and is undergoing variant weight or
+ * capacity changes as part of an UpdateEndpointWeightsAndCapacities call or when the UpdateEndpointWeightsAndCapacities operation is called
+ * explicitly.
+ * InService: Endpoint is available to process incoming
+ * requests.
+ * Deleting: DeleteEndpoint is executing.
Failed: - * The final objective metric for the training job was not evaluated, and was not - * used in the hyperparameter tuning process. This typically occurs when the - * training job failed or did not emit an objective - * metric.
+ *
+ * Failed: Endpoint could not be created, updated, or re-scaled. Use
+ * the FailureReason value returned by DescribeEndpoint for information about the failure. DeleteEndpoint is the only operation that can be performed on a
+ * failed endpoint.
+ * UpdateRollbackFailed: Both the rolling deployment and
+ * auto-rollback failed. Your endpoint is in service with a mix of the old and new
+ * endpoint configurations. For information about how to remedy this issue and
+ * restore the endpoint's status to InService, see Rolling
+ * Deployments.
The total resources consumed by your hyperparameter tuning job.
- * @public - */ -export interface HyperParameterTuningJobConsumedResources { /** - *The wall clock runtime in seconds used by your hyperparameter tuning job.
+ *If the status of the endpoint is Failed, the reason why it failed.
+ *
A timestamp that shows when the endpoint was created.
+ * @public + */ + CreationTime: Date | undefined; + + /** + *A timestamp that shows when the endpoint was last modified.
+ * @public + */ + LastModifiedTime: Date | undefined; + + /** + *The most recent deployment configuration for the endpoint.
+ * @public + */ + LastDeploymentConfig?: DeploymentConfig | undefined; -/** - * @public - */ -export type HyperParameterTuningJobStatus = - (typeof HyperParameterTuningJobStatus)[keyof typeof HyperParameterTuningJobStatus]; + /** + *Returns the description of an endpoint configuration created using the
+ * CreateEndpointConfig
+ * API.
Specifies the number of training jobs that this hyperparameter tuning job launched, - * categorized by the status of their objective metric. The objective metric status shows - * whether the - * final - * objective metric for the training job has been evaluated by the - * tuning job and used in the hyperparameter tuning process.
- * @public - */ -export interface ObjectiveStatusCounters { /** - *The number of training jobs whose final objective metric was evaluated by the - * hyperparameter tuning job and used in the hyperparameter tuning process.
+ *Returns the summary of an in-progress deployment. This field is only returned when the + * endpoint is creating or updating with a new endpoint configuration.
* @public */ - Succeeded?: number | undefined; + PendingDeploymentSummary?: PendingDeploymentSummary | undefined; /** - *The number of training jobs that are in progress and pending evaluation of their final - * objective metric.
+ *The configuration parameters for an explainer.
* @public */ - Pending?: number | undefined; + ExplainerConfig?: ExplainerConfig | undefined; /** - *The number of training jobs whose final objective metric was not evaluated and used in - * the hyperparameter tuning process. This typically occurs when the training job failed or - * did not emit an objective metric.
+ *An array of ProductionVariantSummary objects, one for each model that you want to host
+ * at this endpoint in shadow mode with production traffic replicated from the model
+ * specified on ProductionVariants.
The numbers of training jobs launched by a hyperparameter tuning job, categorized by - * status.
* @public */ -export interface TrainingJobStatusCounters { +export interface DescribeEndpointConfigInput { /** - *The number of completed training jobs launched by the hyperparameter tuning - * job.
+ *The name of the endpoint configuration.
* @public */ - Completed?: number | undefined; + EndpointConfigName: string | undefined; +} +/** + * @public + */ +export interface DescribeEndpointConfigOutput { /** - *The number of in-progress training jobs launched by a hyperparameter tuning - * job.
+ *Name of the SageMaker endpoint configuration.
* @public */ - InProgress?: number | undefined; + EndpointConfigName: string | undefined; /** - *The number of training jobs that failed, but can be retried. A failed training job can - * be retried only if it failed because an internal service error occurred.
+ *The Amazon Resource Name (ARN) of the endpoint configuration.
* @public */ - RetryableError?: number | undefined; + EndpointConfigArn: string | undefined; /** - *The number of training jobs that failed and can't be retried. A failed training job - * can't be retried if it failed because a client error occurred.
+ *An array of ProductionVariant objects, one for each model that you
+ * want to host at this endpoint.
The number of training jobs launched by a hyperparameter tuning job that were - * manually - * stopped.
+ *Configuration to control how SageMaker captures inference data.
* @public */ - Stopped?: number | undefined; -} + DataCaptureConfig?: DataCaptureConfig | undefined; -/** - *A structure that contains runtime information about both current and completed - * hyperparameter tuning jobs.
- * @public - */ -export interface HyperParameterTuningJobCompletionDetails { /** - *The number of training jobs launched by a tuning job that are not improving (1% or - * less) as measured by model performance evaluated against an objective function.
+ *Amazon Web Services KMS key ID Amazon SageMaker uses to encrypt data when storing it on the ML + * storage volume attached to the instance.
* @public */ - NumberOfTrainingJobsObjectiveNotImproving?: number | undefined; + KmsKeyId?: string | undefined; /** - *The time in timestamp format that AMT detected model convergence, as defined by a lack - * of significant improvement over time based on criteria developed over a wide range of - * diverse benchmarking tests.
+ *A timestamp that shows when the endpoint configuration was created.
* @public */ - ConvergenceDetectedTime?: Date | undefined; -} + CreationTime: Date | undefined; -/** - * @public - */ -export interface DescribeHyperParameterTuningJobResponse { /** - *The name of the hyperparameter tuning job.
+ *Returns the description of an endpoint configuration created using the
+ * CreateEndpointConfig
+ * API.
The Amazon Resource Name (ARN) of the tuning job.
+ *The configuration parameters for an explainer.
* @public */ - HyperParameterTuningJobArn: string | undefined; + ExplainerConfig?: ExplainerConfig | undefined; /** - *The HyperParameterTuningJobConfig object that specifies the configuration of - * the tuning job.
+ *An array of ProductionVariant objects, one for each model that you want
+ * to host at this endpoint in shadow mode with production traffic replicated from the
+ * model specified on ProductionVariants.
The HyperParameterTrainingJobDefinition object that specifies the definition of - * the training jobs that this tuning job launches.
+ *The Amazon Resource Name (ARN) of the IAM role that you assigned to the + * endpoint configuration.
* @public */ - TrainingJobDefinition?: HyperParameterTrainingJobDefinition | undefined; + ExecutionRoleArn?: string | undefined; /** - *A list of the HyperParameterTrainingJobDefinition objects launched for this tuning - * job.
+ *Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources + * have access to. You can control access to and from your resources by configuring a VPC. + * For more information, see Give SageMaker Access to + * Resources in your Amazon VPC.
* @public */ - TrainingJobDefinitions?: HyperParameterTrainingJobDefinition[] | undefined; + VpcConfig?: VpcConfig | undefined; /** - *The status of the tuning job.
+ *Indicates whether all model containers deployed to the endpoint are isolated. If they + * are, no inbound or outbound network calls can be made to or from the model + * containers.
* @public */ - HyperParameterTuningJobStatus: HyperParameterTuningJobStatus | undefined; + EnableNetworkIsolation?: boolean | undefined; +} +/** + * @public + */ +export interface DescribeExperimentRequest { /** - *The date and time that the tuning job started.
+ *The name of the experiment to describe.
* @public */ - CreationTime: Date | undefined; + ExperimentName: string | undefined; +} +/** + *The source of the experiment.
+ * @public + */ +export interface ExperimentSource { /** - *The date and time that the tuning job ended.
+ *The Amazon Resource Name (ARN) of the source.
* @public */ - HyperParameterTuningEndTime?: Date | undefined; + SourceArn: string | undefined; /** - *The date and time that the status of the tuning job was modified.
+ *The source type.
* @public */ - LastModifiedTime?: Date | undefined; + SourceType?: string | undefined; +} +/** + * @public + */ +export interface DescribeExperimentResponse { /** - *The TrainingJobStatusCounters object that specifies the number of training - * jobs, categorized by status, that this tuning job launched.
+ *The name of the experiment.
* @public */ - TrainingJobStatusCounters: TrainingJobStatusCounters | undefined; + ExperimentName?: string | undefined; /** - *The ObjectiveStatusCounters object that specifies the number of training jobs, - * categorized by the status of their final objective metric, that this tuning job - * launched.
+ *The Amazon Resource Name (ARN) of the experiment.
* @public */ - ObjectiveStatusCounters: ObjectiveStatusCounters | undefined; + ExperimentArn?: string | undefined; /** - *A TrainingJobSummary object that describes the training job that completed - * with the best current HyperParameterTuningJobObjective.
+ *The name of the experiment as displayed. If DisplayName isn't specified,
+ * ExperimentName is displayed.
If the hyperparameter tuning job is an warm start tuning job with a
- * WarmStartType of IDENTICAL_DATA_AND_ALGORITHM, this is the
- * TrainingJobSummary for the training job with the best objective metric
- * value of all training jobs launched by this tuning job and all parent jobs specified for
- * the warm start tuning job.
The Amazon Resource Name (ARN) of the source and, optionally, the type.
* @public */ - OverallBestTrainingJob?: HyperParameterTrainingJobSummary | undefined; + Source?: ExperimentSource | undefined; /** - *The configuration for starting the hyperparameter parameter tuning job using one or - * more previous tuning jobs as a starting point. The results of previous tuning jobs are - * used to inform which combinations of hyperparameters to search over in the new tuning - * job.
+ *The description of the experiment.
* @public */ - WarmStartConfig?: HyperParameterTuningJobWarmStartConfig | undefined; + Description?: string | undefined; /** - *A flag to indicate if autotune is enabled for the hyperparameter tuning job.
+ *When the experiment was created.
* @public */ - Autotune?: Autotune | undefined; + CreationTime?: Date | undefined; /** - *If the tuning job failed, the reason it failed.
+ *Who created the experiment.
* @public */ - FailureReason?: string | undefined; + CreatedBy?: UserContext | undefined; /** - *Tuning job completion information returned as the response from a hyperparameter - * tuning job. This information tells if your tuning job has or has not converged. It also - * includes the number of training jobs that have not improved model performance as - * evaluated against the objective function.
+ *When the experiment was last modified.
* @public */ - TuningJobCompletionDetails?: HyperParameterTuningJobCompletionDetails | undefined; + LastModifiedTime?: Date | undefined; /** - *The total resources consumed by your hyperparameter tuning job.
+ *Who last modified the experiment.
* @public */ - ConsumedResources?: HyperParameterTuningJobConsumedResources | undefined; + LastModifiedBy?: UserContext | undefined; } /** * @public */ -export interface DescribeImageRequest { +export interface DescribeFeatureGroupRequest { + /** + *The name or Amazon Resource Name (ARN) of the FeatureGroup you want
+ * described.
The name of the image to describe.
+ *A token to resume pagination of the list of Features
+ * (FeatureDefinitions). 2,500 Features are returned by
+ * default.
When the image was created.
- * @public - */ - CreationTime?: Date | undefined; +export const LastUpdateStatusValue = { + FAILED: "Failed", + IN_PROGRESS: "InProgress", + SUCCESSFUL: "Successful", +} as const; - /** - *The description of the image.
- * @public - */ - Description?: string | undefined; +/** + * @public + */ +export type LastUpdateStatusValue = (typeof LastUpdateStatusValue)[keyof typeof LastUpdateStatusValue]; +/** + *A value that indicates whether the update was successful.
+ * @public + */ +export interface LastUpdateStatus { /** - *The name of the image as displayed.
+ *A value that indicates whether the update was made successful.
* @public */ - DisplayName?: string | undefined; + Status: LastUpdateStatusValue | undefined; /** - *When a create, update, or delete operation fails, the reason for the failure.
+ *If the update wasn't successful, indicates the reason why it failed.
* @public */ FailureReason?: string | undefined; +} - /** - *The ARN of the image.
- * @public - */ - ImageArn?: string | undefined; - - /** - *The name of the image.
- * @public - */ - ImageName?: string | undefined; +/** + * @public + * @enum + */ +export const OfflineStoreStatusValue = { + ACTIVE: "Active", + BLOCKED: "Blocked", + DISABLED: "Disabled", +} as const; - /** - *The status of the image.
- * @public - */ - ImageStatus?: ImageStatus | undefined; +/** + * @public + */ +export type OfflineStoreStatusValue = (typeof OfflineStoreStatusValue)[keyof typeof OfflineStoreStatusValue]; +/** + *The status of OfflineStore.
When the image was last modified.
+ *An OfflineStore status.
The ARN of the IAM role that enables Amazon SageMaker to perform tasks on your behalf.
+ *The justification for why the OfflineStoreStatus is Blocked (if applicable).
* @public */ - RoleArn?: string | undefined; + BlockedReason?: string | undefined; } /** + *Active throughput configuration of the feature group. There are two modes:
+ * ON_DEMAND and PROVISIONED. With on-demand mode, you are
+ * charged for data reads and writes that your application performs on your feature group. You
+ * do not need to specify read and write throughput because Feature Store accommodates your
+ * workloads as they ramp up and down. You can switch a feature group to on-demand only once
+ * in a 24 hour period. With provisioned throughput mode, you specify the read and write
+ * capacity per second that you expect your application to require, and you are billed based
+ * on those limits. Exceeding provisioned throughput will result in your requests being
+ * throttled.
Note: PROVISIONED throughput mode is supported only for feature groups that
+ * are offline-only, or use the
+ * Standard
+ * tier online store.
The name of the image.
+ *The mode used for your feature group throughput: ON_DEMAND or
+ * PROVISIONED.
The version of the image. If not specified, the latest version is described.
+ *For provisioned feature groups with online store enabled, this indicates the read + * throughput you are billed for and can consume without throttling.
+ *This field is not applicable for on-demand feature groups.
* @public */ - Version?: number | undefined; + ProvisionedReadCapacityUnits?: number | undefined; /** - *The alias of the image version.
+ *For provisioned feature groups, this indicates the write throughput you are billed for + * and can consume without throttling.
+ *This field is not applicable for on-demand feature groups.
* @public */ - Alias?: string | undefined; + ProvisionedWriteCapacityUnits?: number | undefined; } -/** - * @public - * @enum - */ -export const ImageVersionStatus = { - CREATED: "CREATED", - CREATE_FAILED: "CREATE_FAILED", - CREATING: "CREATING", - DELETE_FAILED: "DELETE_FAILED", - DELETING: "DELETING", -} as const; - -/** - * @public - */ -export type ImageVersionStatus = (typeof ImageVersionStatus)[keyof typeof ImageVersionStatus]; - /** * @public */ -export interface DescribeImageVersionResponse { - /** - *The registry path of the container image on which this image version is based.
- * @public - */ - BaseImage?: string | undefined; - +export interface DescribeFeatureGroupResponse { /** - *The registry path of the container image that contains this image version.
+ *The Amazon Resource Name (ARN) of the FeatureGroup.
When the version was created.
+ *he name of the FeatureGroup.
When a create or delete operation fails, the reason for the failure.
+ *The name of the Feature used for RecordIdentifier, whose value
+ * uniquely identifies a record stored in the feature store.
The ARN of the image the version is based on.
+ *The name of the feature that stores the EventTime of a Record in a
+ * FeatureGroup.
An EventTime is a point in time when a new event occurs that corresponds
+ * to the creation or update of a Record in a FeatureGroup. All
+ * Records in the FeatureGroup have a corresponding
+ * EventTime.
The ARN of the version.
+ *A list of the Features in the FeatureGroup. Each feature is
+ * defined by a FeatureName and FeatureType.
The status of the version.
+ *A timestamp indicating when SageMaker created the FeatureGroup.
When the version was last modified.
+ *A timestamp indicating when the feature group was last updated.
* @public */ LastModifiedTime?: Date | undefined; /** - *The version number.
+ *The configuration for the OnlineStore.
The stability of the image version specified by the maintainer.
+ *The configuration of the offline store. It includes the following configurations:
*
- * NOT_PROVIDED: The maintainers did not provide a status for image version stability.
Amazon S3 location of the offline store.
*
- * STABLE: The image version is stable.
Configuration of the Glue data catalog.
*
- * TO_BE_ARCHIVED: The image version is set to be archived. Custom image versions that are set to be archived are automatically archived after three months.
Table format of the offline store.
*
- * ARCHIVED: The image version is archived. Archived image versions are not searchable and are no longer actively supported.
Option to disable the automatic creation of a Glue table for the offline + * store.
+ *Encryption configuration.
*Indicates SageMaker job type compatibility.
- *
- * TRAINING: The image version is compatible with SageMaker training jobs.
- * INFERENCE: The image version is compatible with SageMaker inference jobs.
- * NOTEBOOK_KERNEL: The image version is compatible with SageMaker notebook kernels.
Active throughput configuration of the feature group. There are two modes:
+ * ON_DEMAND and PROVISIONED. With on-demand mode, you are
+ * charged for data reads and writes that your application performs on your feature group. You
+ * do not need to specify read and write throughput because Feature Store accommodates your
+ * workloads as they ramp up and down. You can switch a feature group to on-demand only once
+ * in a 24 hour period. With provisioned throughput mode, you specify the read and write
+ * capacity per second that you expect your application to require, and you are billed based
+ * on those limits. Exceeding provisioned throughput will result in your requests being
+ * throttled.
Note: PROVISIONED throughput mode is supported only for feature groups that
+ * are offline-only, or use the
+ * Standard
+ * tier online store.
The machine learning framework vended in the image version.
+ *The Amazon Resource Name (ARN) of the IAM execution role used to persist data into the + * OfflineStore if an OfflineStoreConfig is provided.
* @public */ - MLFramework?: string | undefined; + RoleArn?: string | undefined; /** - *The supported programming language and its version.
+ *The status of the feature group.
* @public */ - ProgrammingLang?: string | undefined; + FeatureGroupStatus?: FeatureGroupStatus | undefined; /** - *Indicates CPU or GPU compatibility.
- *
- * CPU: The image version is compatible with CPU.
- * GPU: The image version is compatible with GPU.
The status of the OfflineStore. Notifies you if replicating data into the
+ * OfflineStore has failed. Returns either: Active or
+ * Blocked
+ *
Indicates Horovod compatibility.
+ *A value indicating whether the update made to the feature group was successful.
* @public */ - Horovod?: boolean | undefined; + LastUpdateStatus?: LastUpdateStatus | undefined; /** - *The maintainer description of the image version.
+ *The reason that the FeatureGroup failed to be replicated in the
+ * OfflineStore. This is failure can occur because:
The FeatureGroup could not be created in the
+ * OfflineStore.
The FeatureGroup could not be deleted from the
+ * OfflineStore.
The name of the inference component.
+ *A free form description of the feature group.
* @public */ - InferenceComponentName: string | undefined; -} - -/** - * @public - * @enum - */ -export const InferenceComponentStatus = { - CREATING: "Creating", - DELETING: "Deleting", - FAILED: "Failed", - IN_SERVICE: "InService", - UPDATING: "Updating", -} as const; - -/** - * @public - */ -export type InferenceComponentStatus = (typeof InferenceComponentStatus)[keyof typeof InferenceComponentStatus]; + Description?: string | undefined; -/** - *Details about the runtime settings for the model that is deployed with the inference - * component.
- * @public - */ -export interface InferenceComponentRuntimeConfigSummary { /** - *The number of runtime copies of the model container that you requested to deploy with - * the inference component.
+ *A token to resume pagination of the list of Features
+ * (FeatureDefinitions).
The number of runtime copies of the model container that are currently deployed.
+ *The size of the OnlineStore in bytes.
Details about the resources that are deployed with this inference component.
* @public */ -export interface InferenceComponentContainerSpecificationSummary { - /** - *Gets the Amazon EC2 Container Registry path of the docker image of the model that is hosted in this ProductionVariant.
- *If you used the registry/repository[:tag] form to specify the image path
- * of the primary container when you created the model hosted in this
- * ProductionVariant, the path resolves to a path of the form
- * registry/repository[@digest]. A digest is a hash value that identifies
- * a specific version of an image. For information about Amazon ECR paths, see Pulling an Image in the Amazon ECR User Guide.
The Amazon S3 path where the model artifacts are stored.
+ *The name or Amazon Resource Name (ARN) of the feature group containing the + * feature.
* @public */ - ArtifactUrl?: string | undefined; + FeatureGroupName: string | undefined; /** - *The environment variables to set in the Docker container.
+ *The name of the feature.
* @public */ - Environment?: RecordDetails about the resources that are deployed with this inference component.
+ *A key-value pair that you specify to describe the feature.
* @public */ -export interface InferenceComponentSpecificationSummary { - /** - *The name of the SageMaker model object that is deployed with the inference - * component.
- * @public - */ - ModelName?: string | undefined; - - /** - *Details about the container that provides the runtime environment for the model that is - * deployed with the inference component.
- * @public - */ - Container?: InferenceComponentContainerSpecificationSummary | undefined; - - /** - *Settings that take effect while the model container starts up.
- * @public - */ - StartupParameters?: InferenceComponentStartupParameters | undefined; - +export interface FeatureParameter { /** - *The compute resources allocated to run the model, plus any - * adapter models, that you assign to the inference component.
+ *A key that must contain a value to describe the feature.
* @public */ - ComputeResourceRequirements?: InferenceComponentComputeResourceRequirements | undefined; + Key?: string | undefined; /** - *The name of the base inference component that contains this inference component.
+ *The value that belongs to a key.
* @public */ - BaseInferenceComponentName?: string | undefined; + Value?: string | undefined; } /** * @public */ -export interface DescribeInferenceComponentOutput { +export interface DescribeFeatureMetadataResponse { /** - *The name of the inference component.
+ *The Amazon Resource Number (ARN) of the feature group that contains the feature.
* @public */ - InferenceComponentName: string | undefined; + FeatureGroupArn: string | undefined; /** - *The Amazon Resource Name (ARN) of the inference component.
+ *The name of the feature group that you've specified.
* @public */ - InferenceComponentArn: string | undefined; + FeatureGroupName: string | undefined; /** - *The name of the endpoint that hosts the inference component.
+ *The name of the feature that you've specified.
* @public */ - EndpointName: string | undefined; + FeatureName: string | undefined; /** - *The Amazon Resource Name (ARN) of the endpoint that hosts the inference component.
+ *The data type of the feature.
* @public */ - EndpointArn: string | undefined; + FeatureType: FeatureType | undefined; /** - *The name of the production variant that hosts the inference component.
+ *A timestamp indicating when the feature was created.
* @public */ - VariantName?: string | undefined; + CreationTime: Date | undefined; /** - *If the inference component status is Failed, the reason for the
- * failure.
A timestamp indicating when the metadata for the feature group was modified. For + * example, if you add a parameter describing the feature, the timestamp changes to reflect + * the last time you
* @public */ - FailureReason?: string | undefined; + LastModifiedTime: Date | undefined; /** - *Details about the resources that are deployed with this inference component.
+ *The description you added to describe the feature.
* @public */ - Specification?: InferenceComponentSpecificationSummary | undefined; + Description?: string | undefined; /** - *Details about the runtime settings for the model that is deployed with the inference - * component.
+ *The key-value pairs that you added to describe the feature.
* @public */ - RuntimeConfig?: InferenceComponentRuntimeConfigSummary | undefined; + Parameters?: FeatureParameter[] | undefined; +} +/** + * @public + */ +export interface DescribeFlowDefinitionRequest { /** - *The time when the inference component was created.
+ *The name of the flow definition.
* @public */ - CreationTime: Date | undefined; + FlowDefinitionName: string | undefined; +} + +/** + * @public + * @enum + */ +export const FlowDefinitionStatus = { + ACTIVE: "Active", + DELETING: "Deleting", + FAILED: "Failed", + INITIALIZING: "Initializing", +} as const; + +/** + * @public + */ +export type FlowDefinitionStatus = (typeof FlowDefinitionStatus)[keyof typeof FlowDefinitionStatus]; +/** + * @public + */ +export interface DescribeFlowDefinitionResponse { /** - *The time when the inference component was last updated.
+ *The Amazon Resource Name (ARN) of the flow defintion.
* @public */ - LastModifiedTime: Date | undefined; + FlowDefinitionArn: string | undefined; /** - *The status of the inference component.
+ *The Amazon Resource Name (ARN) of the flow definition.
* @public */ - InferenceComponentStatus?: InferenceComponentStatus | undefined; -} + FlowDefinitionName: string | undefined; -/** - * @public - */ -export interface DescribeInferenceExperimentRequest { /** - *The name of the inference experiment to describe.
+ *The status of the flow definition. Valid values are listed below.
* @public */ - Name: string | undefined; -} + FlowDefinitionStatus: FlowDefinitionStatus | undefined; -/** - *The metadata of the endpoint.
- * @public - */ -export interface EndpointMetadata { /** - *The name of the endpoint.
+ *The timestamp when the flow definition was created.
* @public */ - EndpointName: string | undefined; + CreationTime: Date | undefined; /** - *The name of the endpoint configuration.
+ *Container for configuring the source of human task requests. Used to specify if + * Amazon Rekognition or Amazon Textract is used as an integration source.
* @public */ - EndpointConfigName?: string | undefined; + HumanLoopRequestSource?: HumanLoopRequestSource | undefined; /** - *- * The status of the endpoint. For possible values of the status of an endpoint, see EndpointSummary. - *
+ *An object containing information about what triggers a human review workflow.
* @public */ - EndpointStatus?: EndpointStatus | undefined; + HumanLoopActivationConfig?: HumanLoopActivationConfig | undefined; /** - *
- * If the status of the endpoint is Failed, or the status is InService but update
- * operation fails, this provides the reason why it failed.
- *
An object containing information about who works on the task, the workforce task price, and other task details.
* @public */ - FailureReason?: string | undefined; -} - -/** - * @public - * @enum - */ -export const ModelVariantStatus = { - CREATING: "Creating", - DELETED: "Deleted", - DELETING: "Deleting", - IN_SERVICE: "InService", - UPDATING: "Updating", -} as const; - -/** - * @public - */ -export type ModelVariantStatus = (typeof ModelVariantStatus)[keyof typeof ModelVariantStatus]; + HumanLoopConfig?: HumanLoopConfig | undefined; -/** - *Summary of the deployment configuration of a model.
- * @public - */ -export interface ModelVariantConfigSummary { /** - *The name of the Amazon SageMaker Model entity.
+ *An object containing information about the output file.
* @public */ - ModelName: string | undefined; + OutputConfig: FlowDefinitionOutputConfig | undefined; /** - *The name of the variant.
+ *The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) execution role for the flow definition.
* @public */ - VariantName: string | undefined; + RoleArn: string | undefined; /** - *The configuration of the infrastructure that the model has been deployed to.
+ *The reason your flow definition failed.
* @public */ - InfrastructureConfig: ModelInfrastructureConfig | undefined; + FailureReason?: string | undefined; +} +/** + * @public + */ +export interface DescribeHubRequest { /** - *The status of deployment for the model variant on the hosted inference endpoint.
- *
- * Creating - Amazon SageMaker is preparing the model variant on the hosted inference endpoint.
- *
- * InService - The model variant is running on the hosted inference endpoint.
- *
- * Updating - Amazon SageMaker is updating the model variant on the hosted inference endpoint.
- *
- * Deleting - Amazon SageMaker is deleting the model variant on the hosted inference endpoint.
- *
- * Deleted - The model variant has been deleted on the hosted inference endpoint. This
- * can only happen after stopping the experiment.
- *
The name of the hub to describe.
* @public */ - Status: ModelVariantStatus | undefined; + HubName: string | undefined; } /** * @public * @enum */ -export const InferenceExperimentStatus = { - CANCELLED: "Cancelled", - COMPLETED: "Completed", - CREATED: "Created", +export const HubStatus = { + CREATE_FAILED: "CreateFailed", CREATING: "Creating", - RUNNING: "Running", - STARTING: "Starting", - STOPPING: "Stopping", + DELETE_FAILED: "DeleteFailed", + DELETING: "Deleting", + IN_SERVICE: "InService", + UPDATE_FAILED: "UpdateFailed", UPDATING: "Updating", } as const; /** * @public */ -export type InferenceExperimentStatus = (typeof InferenceExperimentStatus)[keyof typeof InferenceExperimentStatus]; +export type HubStatus = (typeof HubStatus)[keyof typeof HubStatus]; /** * @public */ -export interface DescribeInferenceExperimentResponse { +export interface DescribeHubResponse { /** - *The ARN of the inference experiment being described.
+ *The name of the hub.
* @public */ - Arn: string | undefined; + HubName: string | undefined; /** - *The name of the inference experiment.
+ *The Amazon Resource Name (ARN) of the hub.
* @public */ - Name: string | undefined; + HubArn: string | undefined; /** - *The type of the inference experiment.
+ *The display name of the hub.
* @public */ - Type: InferenceExperimentType | undefined; + HubDisplayName?: string | undefined; /** - *The duration for which the inference experiment ran or will run.
+ *A description of the hub.
* @public */ - Schedule?: InferenceExperimentSchedule | undefined; + HubDescription?: string | undefined; /** - *- * The status of the inference experiment. The following are the possible statuses for an inference - * experiment: - *
- *
- * Creating - Amazon SageMaker is creating your experiment.
- *
- * Created - Amazon SageMaker has finished the creation of your experiment and will begin the
- * experiment at the scheduled time.
- *
- * Updating - When you make changes to your experiment, your experiment shows as updating.
- *
- * Starting - Amazon SageMaker is beginning your experiment.
- *
- * Running - Your experiment is in progress.
- *
- * Stopping - Amazon SageMaker is stopping your experiment.
- *
- * Completed - Your experiment has completed.
- *
- * Cancelled - When you conclude your experiment early using the StopInferenceExperiment API, or if any operation fails with an unexpected error, it shows
- * as cancelled.
- *
The searchable keywords for the hub.
* @public */ - Status: InferenceExperimentStatus | undefined; + HubSearchKeywords?: string[] | undefined; /** - *
- * The error message or client-specified Reason from the StopInferenceExperiment
- * API, that explains the status of the inference experiment.
- *
The Amazon S3 storage configuration for the hub.
* @public */ - StatusReason?: string | undefined; + S3StorageConfig?: HubS3StorageConfig | undefined; /** - *The description of the inference experiment.
+ *The status of the hub.
* @public */ - Description?: string | undefined; + HubStatus: HubStatus | undefined; /** - *The timestamp at which you created the inference experiment.
+ *The failure reason if importing hub content failed.
* @public */ - CreationTime?: Date | undefined; + FailureReason?: string | undefined; /** - *- * The timestamp at which the inference experiment was completed. - *
+ *The date and time that the hub was created.
* @public */ - CompletionTime?: Date | undefined; + CreationTime: Date | undefined; /** - *The timestamp at which you last modified the inference experiment.
+ *The date and time that the hub was last modified.
* @public */ - LastModifiedTime?: Date | undefined; + LastModifiedTime: Date | undefined; +} +/** + * @public + */ +export interface DescribeHubContentRequest { /** - *- * The ARN of the IAM role that Amazon SageMaker can assume to access model artifacts and container images, and manage - * Amazon SageMaker Inference endpoints for model deployment. - *
+ *The name of the hub that contains the content to describe.
* @public */ - RoleArn?: string | undefined; + HubName: string | undefined; /** - *The metadata of the endpoint on which the inference experiment ran.
+ *The type of content in the hub.
* @public */ - EndpointMetadata: EndpointMetadata | undefined; + HubContentType: HubContentType | undefined; /** - *
- * An array of ModelVariantConfigSummary objects. There is one for each variant in the inference
- * experiment. Each ModelVariantConfigSummary object in the array describes the infrastructure
- * configuration for deploying the corresponding variant.
- *
The name of the content to describe.
* @public */ - ModelVariants: ModelVariantConfigSummary[] | undefined; + HubContentName: string | undefined; /** - *The Amazon S3 location and configuration for storing inference request and response data.
+ *The version of the content to describe.
* @public */ - DataStorageConfig?: InferenceExperimentDataStorageConfig | undefined; + HubContentVersion?: string | undefined; +} +/** + *Any dependencies related to hub content, such as scripts, model artifacts, datasets, or notebooks.
+ * @public + */ +export interface HubContentDependency { /** - *
- * The configuration of ShadowMode inference experiment type, which shows the production variant
- * that takes all the inference requests, and the shadow variant to which Amazon SageMaker replicates a percentage of the
- * inference requests. For the shadow variant it also shows the percentage of requests that Amazon SageMaker replicates.
- *
The hub content dependency origin path.
* @public */ - ShadowModeConfig?: ShadowModeConfig | undefined; + DependencyOriginPath?: string | undefined; /** - *- * The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on - * the storage volume attached to the ML compute instance that hosts the endpoint. For more information, see - * CreateInferenceExperiment. - *
+ *The hub content dependency copy path.
* @public */ - KmsKey?: string | undefined; + DependencyCopyPath?: string | undefined; } /** * @public + * @enum */ -export interface DescribeInferenceRecommendationsJobRequest { - /** - *The name of the job. The name must be unique within an - * Amazon Web Services Region in the Amazon Web Services account.
- * @public - */ - JobName: string | undefined; -} +export const HubContentStatus = { + AVAILABLE: "Available", + DELETE_FAILED: "DeleteFailed", + DELETING: "Deleting", + IMPORTING: "Importing", + IMPORT_FAILED: "ImportFailed", +} as const; /** - *The metrics for an existing endpoint compared in an Inference Recommender job.
* @public */ -export interface InferenceMetrics { - /** - *The expected maximum number of requests per minute for the instance.
- * @public - */ - MaxInvocations: number | undefined; +export type HubContentStatus = (typeof HubContentStatus)[keyof typeof HubContentStatus]; - /** - *The expected model latency at maximum invocations per minute for the instance.
- * @public - */ - ModelLatency: number | undefined; -} +/** + * @public + * @enum + */ +export const HubContentSupportStatus = { + DEPRECATED: "Deprecated", + SUPPORTED: "Supported", +} as const; /** - *The performance results from running an Inference Recommender job on an existing endpoint.
* @public */ -export interface EndpointPerformance { - /** - *The metrics for an existing endpoint.
- * @public - */ - Metrics: InferenceMetrics | undefined; +export type HubContentSupportStatus = (typeof HubContentSupportStatus)[keyof typeof HubContentSupportStatus]; +/** + * @public + */ +export interface DescribeHubContentResponse { /** - *Details about a customer endpoint that was compared in an Inference Recommender job.
+ *The name of the hub content.
* @public */ - EndpointInfo: EndpointInfo | undefined; -} + HubContentName: string | undefined; -/** - *The endpoint configuration made by Inference Recommender during a recommendation job.
- * @public - */ -export interface EndpointOutputConfiguration { /** - *The name of the endpoint made during a recommendation job.
+ *The Amazon Resource Name (ARN) of the hub content.
* @public */ - EndpointName: string | undefined; + HubContentArn: string | undefined; /** - *The name of the production variant (deployed model) made during a recommendation job.
+ *The version of the hub content.
* @public */ - VariantName: string | undefined; + HubContentVersion: string | undefined; /** - *The instance type recommended by Amazon SageMaker Inference Recommender.
+ *The type of hub content.
* @public */ - InstanceType?: ProductionVariantInstanceType | undefined; + HubContentType: HubContentType | undefined; /** - *The number of instances recommended to launch initially.
+ *The document schema version for the hub content.
* @public */ - InitialInstanceCount?: number | undefined; + DocumentSchemaVersion: string | undefined; /** - *Specifies the serverless configuration for an endpoint variant.
+ *The name of the hub that contains the content.
* @public */ - ServerlessConfig?: ProductionVariantServerlessConfig | undefined; -} + HubName: string | undefined; -/** - *The metrics of recommendations.
- * @public - */ -export interface RecommendationMetrics { /** - *Defines the cost per hour for the instance.
+ *The Amazon Resource Name (ARN) of the hub that contains the content.
* @public */ - CostPerHour?: number | undefined; + HubArn: string | undefined; /** - *Defines the cost per inference for the instance .
+ *The display name of the hub content.
* @public */ - CostPerInference?: number | undefined; + HubContentDisplayName?: string | undefined; /** - *The expected maximum number of requests per minute for the instance.
+ *A description of the hub content.
* @public */ - MaxInvocations?: number | undefined; + HubContentDescription?: string | undefined; /** - *The expected model latency at maximum invocation per minute for the instance.
+ *A string that provides a description of the hub content. This string can include links, tables, and standard markdown formating.
* @public */ - ModelLatency?: number | undefined; + HubContentMarkdown?: string | undefined; /** - *The expected CPU utilization at maximum invocations per minute for the instance.
- *
- * NaN indicates that the value is not available.
The hub content document that describes information about the hub content such as type, associated containers, scripts, and more.
* @public */ - CpuUtilization?: number | undefined; + HubContentDocument: string | undefined; /** - *The expected memory utilization at maximum invocations per minute for the instance.
- *
- * NaN indicates that the value is not available.
The ARN of the public hub content.
* @public */ - MemoryUtilization?: number | undefined; + SageMakerPublicHubContentArn?: string | undefined; /** - *The time it takes to launch new compute resources for a serverless endpoint. - * The time can vary depending on the model size, how long it takes to download the - * model, and the start-up time of the container.
- *
- * NaN indicates that the value is not available.
The minimum version of the hub content.
* @public */ - ModelSetupTime?: number | undefined; -} + ReferenceMinVersion?: string | undefined; -/** - *A list of environment parameters suggested by the Amazon SageMaker Inference Recommender.
- * @public - */ -export interface EnvironmentParameter { /** - *The environment key suggested by the Amazon SageMaker Inference Recommender.
+ *The support status of the hub content.
* @public */ - Key: string | undefined; + SupportStatus?: HubContentSupportStatus | undefined; /** - *The value type suggested by the Amazon SageMaker Inference Recommender.
+ *The searchable keywords for the hub content.
* @public */ - ValueType: string | undefined; + HubContentSearchKeywords?: string[] | undefined; /** - *The value suggested by the Amazon SageMaker Inference Recommender.
+ *The location of any dependencies that the hub content has, such as scripts, model artifacts, datasets, or notebooks.
* @public */ - Value: string | undefined; -} + HubContentDependencies?: HubContentDependency[] | undefined; -/** - *Defines the model configuration. Includes the specification name and environment parameters.
- * @public - */ -export interface ModelConfiguration { /** - *The inference specification name in the model package version.
+ *The status of the hub content.
* @public */ - InferenceSpecificationName?: string | undefined; + HubContentStatus: HubContentStatus | undefined; /** - *Defines the environment parameters that includes key, value types, and values.
+ *The failure reason if importing hub content failed.
* @public */ - EnvironmentParameters?: EnvironmentParameter[] | undefined; + FailureReason?: string | undefined; /** - *The name of the compilation job used to create the recommended model artifacts.
+ *The date and time that hub content was created.
* @public */ - CompilationJobName?: string | undefined; + CreationTime: Date | undefined; } /** - *A list of recommendations made by Amazon SageMaker Inference Recommender.
* @public */ -export interface InferenceRecommendation { - /** - *The recommendation ID which uniquely identifies each recommendation.
- * @public - */ - RecommendationId?: string | undefined; - - /** - *The metrics used to decide what recommendation to make.
- * @public - */ - Metrics?: RecommendationMetrics | undefined; - - /** - *Defines the endpoint configuration parameters.
- * @public - */ - EndpointConfiguration: EndpointOutputConfiguration | undefined; - +export interface DescribeHumanTaskUiRequest { /** - *Defines the model configuration.
+ *The name of the human task user interface + * (worker task template) you want information about.
* @public */ - ModelConfiguration: ModelConfiguration | undefined; + HumanTaskUiName: string | undefined; +} - /** - *A timestamp that shows when the benchmark completed.
- * @public - */ - InvocationEndTime?: Date | undefined; +/** + * @public + * @enum + */ +export const HumanTaskUiStatus = { + ACTIVE: "Active", + DELETING: "Deleting", +} as const; - /** - *A timestamp that shows when the benchmark started.
- * @public - */ - InvocationStartTime?: Date | undefined; -} +/** + * @public + */ +export type HumanTaskUiStatus = (typeof HumanTaskUiStatus)[keyof typeof HumanTaskUiStatus]; /** * @internal diff --git a/clients/client-sagemaker/src/models/models_3.ts b/clients/client-sagemaker/src/models/models_3.ts index d0d37bb9a795..376a995f6db7 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, + Autotune, BatchDataCaptureConfig, BatchStrategy, CandidateSortBy, @@ -29,6 +30,7 @@ import { Channel, CheckpointConfig, ClusterNodeSummary, + ClusterSchedulerConfigSummary, ClusterSortBy, ClusterSummary, CodeRepositorySortBy, @@ -37,16 +39,19 @@ import { CognitoConfig, CompilationJobStatus, CompilationJobSummary, + ComputeQuotaSummary, ContainerDefinition, ContextSummary, InferenceSpecification, - MetadataProperties, ModelApprovalStatus, ModelPackageStatus, + ObjectiveStatus, OutputDataConfig, OutputParameter, + ProductionVariantInstanceType, ResourceConfig, ResourceSpec, + SchedulerResourceStatus, StoppingCondition, Tag, TransformInput, @@ -58,26 +63,31 @@ import { import { _InstanceType, - DirectInternetAccess, DockerSettings, DriftCheckBaselines, EdgeOutputConfig, + EndpointInfo, ExecutionRoleIdentityConfig, FeatureDefinition, FeatureType, HumanTaskConfig, HyperParameterTrainingJobDefinition, HyperParameterTuningJobConfig, + HyperParameterTuningJobObjectiveType, HyperParameterTuningJobStrategyType, HyperParameterTuningJobWarmStartConfig, + InferenceComponentComputeResourceRequirements, + InferenceComponentStartupParameters, InferenceExecutionConfig, + InferenceExperimentDataStorageConfig, InferenceExperimentSchedule, InferenceExperimentType, - InstanceMetadataServiceConfiguration, + JobType, LabelingJobAlgorithmsConfig, LabelingJobInputConfig, LabelingJobOutputConfig, LabelingJobStoppingConditions, + MetadataProperties, ModelBiasAppSpecification, ModelBiasBaselineConfig, ModelBiasJobInput, @@ -87,6 +97,7 @@ import { ModelExplainabilityAppSpecification, ModelExplainabilityBaselineConfig, ModelExplainabilityJobInput, + ModelInfrastructureConfig, ModelLifeCycle, ModelMetrics, ModelPackageModelCard, @@ -103,25 +114,21 @@ import { MonitoringStoppingCondition, MonitoringType, NetworkConfig, - NotebookInstanceAcceleratorType, - NotebookInstanceLifecycleHook, OfflineStoreConfig, OnlineStoreConfig, - OptimizationConfig, - OptimizationJobDeploymentInstanceType, - OptimizationJobModelSource, - OptimizationJobOutputConfig, - OptimizationVpcConfig, + Processor, + ProductionVariantServerlessConfig, RecommendationJobInputConfig, RecommendationJobStoppingConditions, RecommendationJobType, ResourceLimits, RetryStrategy, - RootAccess, + ShadowModeConfig, SkipModelValidation, SourceAlgorithmSpecification, TrackingServerSize, UserSettings, + VendorGuidance, } from "./models_1"; import { @@ -131,11 +138,11 @@ import { DebugHookConfig, DebugRuleConfiguration, DebugRuleEvaluationStatus, + DeployedImage, DeploymentRecommendation, + DirectInternetAccess, DomainStatus, EdgePackagingJobStatus, - EndpointOutputConfiguration, - EndpointPerformance, EndpointStatus, ExperimentConfig, ExperimentSource, @@ -146,28 +153,28 @@ import { HubContentSupportStatus, HubContentType, HubStatus, - HyperParameterTrainingJobSummary, - HyperParameterTuningJobCompletionDetails, - HyperParameterTuningJobConsumedResources, - HyperParameterTuningJobStatus, - ImageStatus, - ImageVersionStatus, - InferenceComponentStatus, - InferenceExperimentStatus, - InferenceMetrics, - InferenceRecommendation, + HumanTaskUiStatus, InfraCheckConfig, + InstanceMetadataServiceConfiguration, LastUpdateStatus, MemberDefinition, ModelArtifacts, ModelClientConfig, - ModelConfiguration, + NotebookInstanceAcceleratorType, + NotebookInstanceLifecycleHook, NotificationConfiguration, - ObjectiveStatusCounters, OfflineStoreStatus, - OfflineStoreStatusValue, + OptimizationConfig, + OptimizationJobDeploymentInstanceType, + OptimizationJobModelSource, + OptimizationJobOutputConfig, + OptimizationVpcConfig, OwnershipSettings, ParallelismConfiguration, + PartnerAppAuthType, + PartnerAppConfig, + PartnerAppMaintenanceConfig, + PartnerAppType, ProcessingInput, ProcessingOutputConfig, ProcessingResources, @@ -175,8 +182,8 @@ import { ProductionVariantSummary, ProfilerConfig, ProfilerRuleConfiguration, - RecommendationMetrics, RemoteDebugConfig, + RootAccess, RuleEvaluationStatus, ServiceCatalogProvisioningDetails, SourceIpConfig, @@ -184,8 +191,6 @@ import { SpaceSharingSettings, StudioLifecycleConfigAppType, TensorBoardOutputConfig, - TrainingJobStatus, - TrainingJobStatusCounters, TrialComponentArtifact, TrialComponentParameterValue, TrialComponentStatus, @@ -193,191 +198,253 @@ import { } from "./models_2"; /** + *Container for user interface template information.
* @public - * @enum */ -export const RecommendationJobStatus = { - COMPLETED: "COMPLETED", - DELETED: "DELETED", - DELETING: "DELETING", - FAILED: "FAILED", - IN_PROGRESS: "IN_PROGRESS", - PENDING: "PENDING", - STOPPED: "STOPPED", - STOPPING: "STOPPING", -} as const; +export interface UiTemplateInfo { + /** + *The URL for the user interface template.
+ * @public + */ + Url?: string | undefined; -/** - * @public - */ -export type RecommendationJobStatus = (typeof RecommendationJobStatus)[keyof typeof RecommendationJobStatus]; + /** + *The SHA-256 digest of the contents of the template.
+ * @public + */ + ContentSha256?: string | undefined; +} /** * @public */ -export interface DescribeInferenceRecommendationsJobResponse { +export interface DescribeHumanTaskUiResponse { /** - *The name of the job. The name must be unique within an - * Amazon Web Services Region in the Amazon Web Services account.
+ *The Amazon Resource Name (ARN) of the human task user interface (worker task template).
* @public */ - JobName: string | undefined; + HumanTaskUiArn: string | undefined; /** - *The job description that you provided when you initiated the job.
+ *The name of the human task user interface (worker task template).
* @public */ - JobDescription?: string | undefined; + HumanTaskUiName: string | undefined; /** - *The job type that you provided when you initiated the job.
+ *The status of the human task user interface (worker task template). Valid values are listed below.
* @public */ - JobType: RecommendationJobType | undefined; + HumanTaskUiStatus?: HumanTaskUiStatus | undefined; /** - *The Amazon Resource Name (ARN) of the job.
+ *The timestamp when the human task user interface was created.
* @public */ - JobArn: string | undefined; + CreationTime: Date | undefined; /** - *The Amazon Resource Name (ARN) of the Amazon Web Services - * Identity and Access Management (IAM) role you provided when you initiated the job.
+ *Container for user interface template information.
* @public */ - RoleArn: string | undefined; + UiTemplate: UiTemplateInfo | undefined; +} +/** + * @public + */ +export interface DescribeHyperParameterTuningJobRequest { /** - *The status of the job.
+ *The name of the tuning job.
* @public */ - Status: RecommendationJobStatus | undefined; + HyperParameterTuningJobName: string | undefined; +} +/** + *Shows the latest objective metric emitted by a training job that was launched by a
+ * hyperparameter tuning job. You define the objective metric in the
+ * HyperParameterTuningJobObjective parameter of HyperParameterTuningJobConfig.
A timestamp that shows when the job was created.
+ *Select if you want to minimize or maximize the objective metric during hyperparameter + * tuning.
* @public */ - CreationTime: Date | undefined; + Type?: HyperParameterTuningJobObjectiveType | undefined; /** - *A timestamp that shows when the job completed.
+ *The name of the objective metric. For SageMaker built-in algorithms, metrics are defined + * per algorithm. See the metrics for XGBoost as an + * example. You can also use a custom algorithm for training and define your own metrics. + * For more information, see Define metrics and environment variables.
* @public */ - CompletionTime?: Date | undefined; + MetricName: string | undefined; /** - *A timestamp that shows when the job was last modified.
+ *The value of the objective metric.
* @public */ - LastModifiedTime: Date | undefined; + Value: number | undefined; +} +/** + * @public + * @enum + */ +export const TrainingJobStatus = { + COMPLETED: "Completed", + FAILED: "Failed", + IN_PROGRESS: "InProgress", + STOPPED: "Stopped", + STOPPING: "Stopping", +} as const; + +/** + * @public + */ +export type TrainingJobStatus = (typeof TrainingJobStatus)[keyof typeof TrainingJobStatus]; + +/** + *The container for the summary information about a training job.
+ * @public + */ +export interface HyperParameterTrainingJobSummary { /** - *If the job fails, provides information why the job failed.
+ *The training job definition name.
* @public */ - FailureReason?: string | undefined; + TrainingJobDefinitionName?: string | undefined; /** - *Returns information about the versioned model package Amazon Resource Name (ARN), - * the traffic pattern, and endpoint configurations you provided when you initiated the job.
+ *The name of the training job.
* @public */ - InputConfig: RecommendationJobInputConfig | undefined; + TrainingJobName: string | undefined; /** - *The stopping conditions that you provided when you initiated the job.
+ *The Amazon Resource Name (ARN) of the training job.
* @public */ - StoppingConditions?: RecommendationJobStoppingConditions | undefined; + TrainingJobArn: string | undefined; /** - *The recommendations made by Inference Recommender.
+ *The HyperParameter tuning job that launched the training job.
* @public */ - InferenceRecommendations?: InferenceRecommendation[] | undefined; + TuningJobName?: string | undefined; /** - *The performance results from running an Inference Recommender job on an existing endpoint.
+ *The date and time that the training job was created.
* @public */ - EndpointPerformances?: EndpointPerformance[] | undefined; -} + CreationTime: Date | undefined; -/** - * @public - */ -export interface DescribeLabelingJobRequest { /** - *The name of the labeling job to return information for.
+ *The date and time that the training job started.
* @public */ - LabelingJobName: string | undefined; -} + TrainingStartTime?: Date | undefined; -/** - *Provides a breakdown of the number of objects labeled.
- * @public - */ -export interface LabelCounters { /** - *The total number of objects labeled.
+ *Specifies the time when the training job ends on training instances. You are billed
+ * for the time interval between the value of TrainingStartTime and this time.
+ * For successful jobs and stopped jobs, this is the time after model artifacts are
+ * uploaded. For failed jobs, this is the time when SageMaker detects a job failure.
The total number of objects labeled by a human worker.
+ *The + * status + * of the training job.
* @public */ - HumanLabeled?: number | undefined; + TrainingJobStatus: TrainingJobStatus | undefined; /** - *The total number of objects labeled by automated data labeling.
+ *A + * list of the hyperparameters for which you specified ranges to + * search.
* @public */ - MachineLabeled?: number | undefined; + TunedHyperParameters: RecordThe total number of objects that could not be labeled due to an error.
+ *The + * reason that the training job failed. + *
* @public */ - FailedNonRetryableError?: number | undefined; + FailureReason?: string | undefined; /** - *The total number of objects not yet labeled.
+ *The FinalHyperParameterTuningJobObjectiveMetric object that specifies the + * value + * of the + * objective + * metric of the tuning job that launched this training job.
* @public */ - Unlabeled?: number | undefined; -} + FinalHyperParameterTuningJobObjectiveMetric?: FinalHyperParameterTuningJobObjectiveMetric | undefined; -/** - *Specifies the location of the output produced by the labeling job.
- * @public - */ -export interface LabelingJobOutput { /** - *The Amazon S3 bucket location of the manifest file for labeled data.
+ *The status of the objective metric for the training job:
+ *Succeeded: The + * final + * objective metric for the training job was evaluated by the + * hyperparameter tuning job and + * used + * in the hyperparameter tuning process.
+ *Pending: The training job is in progress and evaluation of its final objective + * metric is pending.
+ *Failed: + * The final objective metric for the training job was not evaluated, and was not + * used in the hyperparameter tuning process. This typically occurs when the + * training job failed or did not emit an objective + * metric.
+ *The total resources consumed by your hyperparameter tuning job.
+ * @public + */ +export interface HyperParameterTuningJobConsumedResources { /** - *The Amazon Resource Name (ARN) for the most recent SageMaker model trained as part of - * automated data labeling.
+ *The wall clock runtime in seconds used by your hyperparameter tuning job.
* @public */ - FinalActiveLearningModelArn?: string | undefined; + RuntimeInSeconds?: number | undefined; } /** * @public * @enum */ -export const LabelingJobStatus = { +export const HyperParameterTuningJobStatus = { COMPLETED: "Completed", + DELETE_FAILED: "DeleteFailed", + DELETING: "Deleting", FAILED: "Failed", - INITIALIZING: "Initializing", IN_PROGRESS: "InProgress", STOPPED: "Stopped", STOPPING: "Stopping", @@ -386,1383 +453,1424 @@ export const LabelingJobStatus = { /** * @public */ -export type LabelingJobStatus = (typeof LabelingJobStatus)[keyof typeof LabelingJobStatus]; +export type HyperParameterTuningJobStatus = + (typeof HyperParameterTuningJobStatus)[keyof typeof HyperParameterTuningJobStatus]; /** + *Specifies the number of training jobs that this hyperparameter tuning job launched, + * categorized by the status of their objective metric. The objective metric status shows + * whether the + * final + * objective metric for the training job has been evaluated by the + * tuning job and used in the hyperparameter tuning process.
* @public */ -export interface DescribeLabelingJobResponse { +export interface ObjectiveStatusCounters { /** - *The processing status of the labeling job.
+ *The number of training jobs whose final objective metric was evaluated by the + * hyperparameter tuning job and used in the hyperparameter tuning process.
* @public */ - LabelingJobStatus: LabelingJobStatus | undefined; + Succeeded?: number | undefined; /** - *Provides a breakdown of the number of data objects labeled by humans, the number of - * objects labeled by machine, the number of objects than couldn't be labeled, and the - * total number of objects labeled.
+ *The number of training jobs that are in progress and pending evaluation of their final + * objective metric.
* @public */ - LabelCounters: LabelCounters | undefined; + Pending?: number | undefined; /** - *If the job failed, the reason that it failed.
+ *The number of training jobs whose final objective metric was not evaluated and used in + * the hyperparameter tuning process. This typically occurs when the training job failed or + * did not emit an objective metric.
* @public */ - FailureReason?: string | undefined; + Failed?: number | undefined; +} +/** + *The numbers of training jobs launched by a hyperparameter tuning job, categorized by + * status.
+ * @public + */ +export interface TrainingJobStatusCounters { /** - *The date and time that the labeling job was created.
+ *The number of completed training jobs launched by the hyperparameter tuning + * job.
* @public */ - CreationTime: Date | undefined; + Completed?: number | undefined; /** - *The date and time that the labeling job was last updated.
+ *The number of in-progress training jobs launched by a hyperparameter tuning + * job.
* @public */ - LastModifiedTime: Date | undefined; + InProgress?: number | undefined; /** - *A unique identifier for work done as part of a labeling job.
+ *The number of training jobs that failed, but can be retried. A failed training job can + * be retried only if it failed because an internal service error occurred.
* @public */ - JobReferenceCode: string | undefined; + RetryableError?: number | undefined; /** - *The name assigned to the labeling job when it was created.
+ *The number of training jobs that failed and can't be retried. A failed training job + * can't be retried if it failed because a client error occurred.
* @public */ - LabelingJobName: string | undefined; + NonRetryableError?: number | undefined; /** - *The Amazon Resource Name (ARN) of the labeling job.
+ *The number of training jobs launched by a hyperparameter tuning job that were + * manually + * stopped.
* @public */ - LabelingJobArn: string | undefined; + Stopped?: number | undefined; +} +/** + *A structure that contains runtime information about both current and completed + * hyperparameter tuning jobs.
+ * @public + */ +export interface HyperParameterTuningJobCompletionDetails { /** - *The attribute used as the label in the output manifest file.
+ *The number of training jobs launched by a tuning job that are not improving (1% or + * less) as measured by model performance evaluated against an objective function.
* @public */ - LabelAttributeName?: string | undefined; + NumberOfTrainingJobsObjectiveNotImproving?: number | undefined; /** - *Input configuration information for the labeling job, such as the Amazon S3 location of the - * data objects and the location of the manifest file that describes the data - * objects.
+ *The time in timestamp format that AMT detected model convergence, as defined by a lack + * of significant improvement over time based on criteria developed over a wide range of + * diverse benchmarking tests.
* @public */ - InputConfig: LabelingJobInputConfig | undefined; + ConvergenceDetectedTime?: Date | undefined; +} +/** + * @public + */ +export interface DescribeHyperParameterTuningJobResponse { /** - *The location of the job's output data and the Amazon Web Services Key Management - * Service key ID for the key used to encrypt the output data, if any.
+ *The name of the hyperparameter tuning job.
* @public */ - OutputConfig: LabelingJobOutputConfig | undefined; + HyperParameterTuningJobName: string | undefined; /** - *The Amazon Resource Name (ARN) that SageMaker assumes to perform tasks on your behalf - * during data labeling.
+ *The Amazon Resource Name (ARN) of the tuning job.
* @public */ - RoleArn: string | undefined; + HyperParameterTuningJobArn: string | undefined; /** - *The S3 location of the JSON file that defines the categories used to label data - * objects. Please note the following label-category limits:
- *Semantic segmentation labeling jobs using automated labeling: 20 labels
- *Box bounding labeling jobs (all): 10 labels
- *The file is a JSON structure in the following format:
- *
- * \{
- *
- * "document-version": "2018-11-28"
- *
- * "labels": [
- *
- * \{
- *
- * "label": "label 1"
- *
- * \},
- *
- * \{
- *
- * "label": "label 2"
- *
- * \},
- *
- * ...
- *
- * \{
- *
- * "label": "label n"
- *
- * \}
- *
- * ]
- *
- * \}
- *
The HyperParameterTuningJobConfig object that specifies the configuration of + * the tuning job.
* @public */ - LabelCategoryConfigS3Uri?: string | undefined; + HyperParameterTuningJobConfig: HyperParameterTuningJobConfig | undefined; /** - *A set of conditions for stopping a labeling job. If any of the conditions are met, the - * job is automatically stopped.
+ *The HyperParameterTrainingJobDefinition object that specifies the definition of + * the training jobs that this tuning job launches.
* @public */ - StoppingConditions?: LabelingJobStoppingConditions | undefined; + TrainingJobDefinition?: HyperParameterTrainingJobDefinition | undefined; /** - *Configuration information for automated data labeling.
+ *A list of the HyperParameterTrainingJobDefinition objects launched for this tuning + * job.
* @public */ - LabelingJobAlgorithmsConfig?: LabelingJobAlgorithmsConfig | undefined; + TrainingJobDefinitions?: HyperParameterTrainingJobDefinition[] | undefined; /** - *Configuration information required for human workers to complete a labeling - * task.
+ *The status of the tuning job.
* @public */ - HumanTaskConfig: HumanTaskConfig | undefined; + HyperParameterTuningJobStatus: HyperParameterTuningJobStatus | undefined; /** - *An array of key-value pairs. You can use tags to categorize your Amazon Web Services - * resources in different ways, for example, by purpose, owner, or environment. For more - * information, see Tagging Amazon Web Services Resources.
+ *The date and time that the tuning job started.
* @public */ - Tags?: Tag[] | undefined; + CreationTime: Date | undefined; /** - *The location of the output produced by the labeling job.
+ *The date and time that the tuning job ended.
* @public */ - LabelingJobOutput?: LabelingJobOutput | undefined; -} + HyperParameterTuningEndTime?: Date | undefined; -/** - * @public - */ -export interface DescribeLineageGroupRequest { /** - *The name of the lineage group.
+ *The date and time that the status of the tuning job was modified.
* @public */ - LineageGroupName: string | undefined; -} + LastModifiedTime?: Date | undefined; -/** - * @public - */ -export interface DescribeLineageGroupResponse { /** - *The name of the lineage group.
+ *The TrainingJobStatusCounters object that specifies the number of training + * jobs, categorized by status, that this tuning job launched.
* @public */ - LineageGroupName?: string | undefined; + TrainingJobStatusCounters: TrainingJobStatusCounters | undefined; /** - *The Amazon Resource Name (ARN) of the lineage group.
+ *The ObjectiveStatusCounters object that specifies the number of training jobs, + * categorized by the status of their final objective metric, that this tuning job + * launched.
* @public */ - LineageGroupArn?: string | undefined; + ObjectiveStatusCounters: ObjectiveStatusCounters | undefined; /** - *The display name of the lineage group.
+ *A TrainingJobSummary object that describes the training job that completed + * with the best current HyperParameterTuningJobObjective.
* @public */ - DisplayName?: string | undefined; + BestTrainingJob?: HyperParameterTrainingJobSummary | undefined; /** - *The description of the lineage group.
+ *If the hyperparameter tuning job is an warm start tuning job with a
+ * WarmStartType of IDENTICAL_DATA_AND_ALGORITHM, this is the
+ * TrainingJobSummary for the training job with the best objective metric
+ * value of all training jobs launched by this tuning job and all parent jobs specified for
+ * the warm start tuning job.
The creation time of lineage group.
+ *The configuration for starting the hyperparameter parameter tuning job using one or + * more previous tuning jobs as a starting point. The results of previous tuning jobs are + * used to inform which combinations of hyperparameters to search over in the new tuning + * job.
* @public */ - CreationTime?: Date | undefined; + WarmStartConfig?: HyperParameterTuningJobWarmStartConfig | undefined; /** - *Information about the user who created or modified an experiment, trial, trial - * component, lineage group, project, or model card.
+ *A flag to indicate if autotune is enabled for the hyperparameter tuning job.
* @public */ - CreatedBy?: UserContext | undefined; + Autotune?: Autotune | undefined; /** - *The last modified time of the lineage group.
+ *If the tuning job failed, the reason it failed.
* @public */ - LastModifiedTime?: Date | undefined; + FailureReason?: string | undefined; /** - *Information about the user who created or modified an experiment, trial, trial - * component, lineage group, project, or model card.
+ *Tuning job completion information returned as the response from a hyperparameter + * tuning job. This information tells if your tuning job has or has not converged. It also + * includes the number of training jobs that have not improved model performance as + * evaluated against the objective function.
* @public */ - LastModifiedBy?: UserContext | undefined; -} + TuningJobCompletionDetails?: HyperParameterTuningJobCompletionDetails | undefined; -/** - * @public - */ -export interface DescribeMlflowTrackingServerRequest { /** - *The name of the MLflow Tracking Server to describe.
+ *The total resources consumed by your hyperparameter tuning job.
* @public */ - TrackingServerName: string | undefined; + ConsumedResources?: HyperParameterTuningJobConsumedResources | undefined; } -/** - * @public - * @enum - */ -export const IsTrackingServerActive = { - ACTIVE: "Active", - INACTIVE: "Inactive", -} as const; - /** * @public */ -export type IsTrackingServerActive = (typeof IsTrackingServerActive)[keyof typeof IsTrackingServerActive]; +export interface DescribeImageRequest { + /** + *The name of the image to describe.
+ * @public + */ + ImageName: string | undefined; +} /** * @public * @enum */ -export const TrackingServerStatus = { - CREATED: "Created", - CREATE_FAILED: "CreateFailed", - CREATING: "Creating", - DELETE_FAILED: "DeleteFailed", - DELETING: "Deleting", - MAINTENANCE_COMPLETE: "MaintenanceComplete", - MAINTENANCE_FAILED: "MaintenanceFailed", - MAINTENANCE_IN_PROGRESS: "MaintenanceInProgress", - STARTED: "Started", - STARTING: "Starting", - START_FAILED: "StartFailed", - STOPPED: "Stopped", - STOPPING: "Stopping", - STOP_FAILED: "StopFailed", - UPDATED: "Updated", - UPDATE_FAILED: "UpdateFailed", - UPDATING: "Updating", +export const ImageStatus = { + CREATED: "CREATED", + CREATE_FAILED: "CREATE_FAILED", + CREATING: "CREATING", + DELETE_FAILED: "DELETE_FAILED", + DELETING: "DELETING", + UPDATE_FAILED: "UPDATE_FAILED", + UPDATING: "UPDATING", } as const; /** * @public */ -export type TrackingServerStatus = (typeof TrackingServerStatus)[keyof typeof TrackingServerStatus]; +export type ImageStatus = (typeof ImageStatus)[keyof typeof ImageStatus]; /** * @public */ -export interface DescribeMlflowTrackingServerResponse { - /** - *The ARN of the described tracking server.
- * @public - */ - TrackingServerArn?: string | undefined; - - /** - *The name of the described tracking server.
- * @public - */ - TrackingServerName?: string | undefined; - +export interface DescribeImageResponse { /** - *The S3 URI of the general purpose bucket used as the MLflow Tracking Server - * artifact store.
- * @public - */ - ArtifactStoreUri?: string | undefined; - - /** - *The size of the described tracking server.
+ *When the image was created.
* @public */ - TrackingServerSize?: TrackingServerSize | undefined; + CreationTime?: Date | undefined; /** - *The MLflow version used for the described tracking server.
+ *The description of the image.
* @public */ - MlflowVersion?: string | undefined; + Description?: string | undefined; /** - *The Amazon Resource Name (ARN) for an IAM role in your account that the described MLflow Tracking Server - * uses to access the artifact store in Amazon S3.
+ *The name of the image as displayed.
* @public */ - RoleArn?: string | undefined; + DisplayName?: string | undefined; /** - *The current creation status of the described MLflow Tracking Server.
+ *When a create, update, or delete operation fails, the reason for the failure.
* @public */ - TrackingServerStatus?: TrackingServerStatus | undefined; + FailureReason?: string | undefined; /** - *Whether the described MLflow Tracking Server is currently active.
+ *The ARN of the image.
* @public */ - IsActive?: IsTrackingServerActive | undefined; + ImageArn?: string | undefined; /** - *The URL to connect to the MLflow user interface for the described tracking server.
+ *The name of the image.
* @public */ - TrackingServerUrl?: string | undefined; + ImageName?: string | undefined; /** - *The day and time of the week when weekly maintenance occurs on the described tracking server.
+ *The status of the image.
* @public */ - WeeklyMaintenanceWindowStart?: string | undefined; + ImageStatus?: ImageStatus | undefined; /** - *Whether automatic registration of new MLflow models to the SageMaker Model Registry is enabled.
+ *When the image was last modified.
* @public */ - AutomaticModelRegistration?: boolean | undefined; + LastModifiedTime?: Date | undefined; /** - *The timestamp of when the described MLflow Tracking Server was created.
+ *The ARN of the IAM role that enables Amazon SageMaker to perform tasks on your behalf.
* @public */ - CreationTime?: Date | undefined; + RoleArn?: string | undefined; +} +/** + * @public + */ +export interface DescribeImageVersionRequest { /** - *Information about the user who created or modified an experiment, trial, trial - * component, lineage group, project, or model card.
+ *The name of the image.
* @public */ - CreatedBy?: UserContext | undefined; + ImageName: string | undefined; /** - *The timestamp of when the described MLflow Tracking Server was last modified.
+ *The version of the image. If not specified, the latest version is described.
* @public */ - LastModifiedTime?: Date | undefined; + Version?: number | undefined; /** - *Information about the user who created or modified an experiment, trial, trial - * component, lineage group, project, or model card.
+ *The alias of the image version.
* @public */ - LastModifiedBy?: UserContext | undefined; + Alias?: string | undefined; } /** * @public + * @enum */ -export interface DescribeModelInput { - /** - *The name of the model.
- * @public - */ - ModelName: string | undefined; -} +export const ImageVersionStatus = { + CREATED: "CREATED", + CREATE_FAILED: "CREATE_FAILED", + CREATING: "CREATING", + DELETE_FAILED: "DELETE_FAILED", + DELETING: "DELETING", +} as const; /** * @public */ -export interface DescribeModelOutput { +export type ImageVersionStatus = (typeof ImageVersionStatus)[keyof typeof ImageVersionStatus]; + +/** + * @public + */ +export interface DescribeImageVersionResponse { /** - *Name of the SageMaker model.
+ *The registry path of the container image on which this image version is based.
* @public */ - ModelName: string | undefined; + BaseImage?: string | undefined; /** - *The location of the primary inference code, associated artifacts, and custom - * environment map that the inference code uses when it is deployed in production. - *
+ *The registry path of the container image that contains this image version.
* @public */ - PrimaryContainer?: ContainerDefinition | undefined; + ContainerImage?: string | undefined; /** - *The containers in the inference pipeline.
+ *When the version was created.
* @public */ - Containers?: ContainerDefinition[] | undefined; + CreationTime?: Date | undefined; /** - *Specifies details of how containers in a multi-container endpoint are called.
+ *When a create or delete operation fails, the reason for the failure.
* @public */ - InferenceExecutionConfig?: InferenceExecutionConfig | undefined; + FailureReason?: string | undefined; /** - *The Amazon Resource Name (ARN) of the IAM role that you specified for the - * model.
+ *The ARN of the image the version is based on.
* @public */ - ExecutionRoleArn?: string | undefined; + ImageArn?: string | undefined; /** - *A VpcConfig object that specifies the VPC that this model has access to. For - * more information, see Protect Endpoints by Using an Amazon Virtual - * Private Cloud - *
+ *The ARN of the version.
* @public */ - VpcConfig?: VpcConfig | undefined; + ImageVersionArn?: string | undefined; /** - *A timestamp that shows when the model was created.
+ *The status of the version.
* @public */ - CreationTime: Date | undefined; + ImageVersionStatus?: ImageVersionStatus | undefined; /** - *The Amazon Resource Name (ARN) of the model.
+ *When the version was last modified.
* @public */ - ModelArn: string | undefined; + LastModifiedTime?: Date | undefined; /** - *If True, no inbound or outbound network calls can be made to or from the
- * model container.
The version number.
* @public */ - EnableNetworkIsolation?: boolean | undefined; + Version?: number | undefined; /** - *A set of recommended deployment configurations for the model.
- * @public - */ - DeploymentRecommendation?: DeploymentRecommendation | undefined; -} + *The stability of the image version specified by the maintainer.
+ *
+ * NOT_PROVIDED: The maintainers did not provide a status for image version stability.
+ * STABLE: The image version is stable.
+ * TO_BE_ARCHIVED: The image version is set to be archived. Custom image versions that are set to be archived are automatically archived after three months.
+ * ARCHIVED: The image version is archived. Archived image versions are not searchable and are no longer actively supported.
The name of the model bias job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.
+ *Indicates SageMaker job type compatibility.
+ *
+ * TRAINING: The image version is compatible with SageMaker training jobs.
+ * INFERENCE: The image version is compatible with SageMaker inference jobs.
+ * NOTEBOOK_KERNEL: The image version is compatible with SageMaker notebook kernels.
The Amazon Resource Name (ARN) of the model bias job.
+ *The machine learning framework vended in the image version.
* @public */ - JobDefinitionArn: string | undefined; + MLFramework?: string | undefined; /** - *The name of the bias job definition. The name must be unique within an Amazon Web Services - * Region in the Amazon Web Services account.
+ *The supported programming language and its version.
* @public */ - JobDefinitionName: string | undefined; + ProgrammingLang?: string | undefined; /** - *The time at which the model bias job was created.
+ *Indicates CPU or GPU compatibility.
+ *
+ * CPU: The image version is compatible with CPU.
+ * GPU: The image version is compatible with GPU.
The baseline configuration for a model bias job.
+ *Indicates Horovod compatibility.
* @public */ - ModelBiasBaselineConfig?: ModelBiasBaselineConfig | undefined; + Horovod?: boolean | undefined; /** - *Configures the model bias job to run a specified Docker container image.
+ *The maintainer description of the image version.
* @public */ - ModelBiasAppSpecification: ModelBiasAppSpecification | undefined; + ReleaseNotes?: string | undefined; +} +/** + * @public + */ +export interface DescribeInferenceComponentInput { /** - *Inputs for the model bias job.
+ *The name of the inference component.
* @public */ - ModelBiasJobInput: ModelBiasJobInput | undefined; + InferenceComponentName: string | undefined; +} + +/** + * @public + * @enum + */ +export const InferenceComponentStatus = { + CREATING: "Creating", + DELETING: "Deleting", + FAILED: "Failed", + IN_SERVICE: "InService", + UPDATING: "Updating", +} as const; + +/** + * @public + */ +export type InferenceComponentStatus = (typeof InferenceComponentStatus)[keyof typeof InferenceComponentStatus]; +/** + *Details about the runtime settings for the model that is deployed with the inference + * component.
+ * @public + */ +export interface InferenceComponentRuntimeConfigSummary { /** - *The output configuration for monitoring jobs.
+ *The number of runtime copies of the model container that you requested to deploy with + * the inference component.
* @public */ - ModelBiasJobOutputConfig: MonitoringOutputConfig | undefined; + DesiredCopyCount?: number | undefined; /** - *Identifies the resources to deploy for a monitoring job.
+ *The number of runtime copies of the model container that are currently deployed.
* @public */ - JobResources: MonitoringResources | undefined; + CurrentCopyCount?: number | undefined; +} +/** + *Details about the resources that are deployed with this inference component.
+ * @public + */ +export interface InferenceComponentContainerSpecificationSummary { /** - *Networking options for a model bias job.
+ *Gets the Amazon EC2 Container Registry path of the docker image of the model that is hosted in this ProductionVariant.
+ *If you used the registry/repository[:tag] form to specify the image path
+ * of the primary container when you created the model hosted in this
+ * ProductionVariant, the path resolves to a path of the form
+ * registry/repository[@digest]. A digest is a hash value that identifies
+ * a specific version of an image. For information about Amazon ECR paths, see Pulling an Image in the Amazon ECR User Guide.
The Amazon Resource Name (ARN) of the IAM role that has read permission to the - * input data location and write permission to the output data location in Amazon S3.
+ *The Amazon S3 path where the model artifacts are stored.
* @public */ - RoleArn: string | undefined; + ArtifactUrl?: string | undefined; /** - *A time limit for how long the monitoring job is allowed to run before stopping.
+ *The environment variables to set in the Docker container.
* @public */ - StoppingCondition?: MonitoringStoppingCondition | undefined; + Environment?: RecordDetails about the resources that are deployed with this inference component.
* @public */ -export interface DescribeModelCardRequest { +export interface InferenceComponentSpecificationSummary { /** - *The name or Amazon Resource Name (ARN) of the model card to describe.
+ *The name of the SageMaker model object that is deployed with the inference + * component.
* @public */ - ModelCardName: string | undefined; + ModelName?: string | undefined; /** - *The version of the model card to describe. If a version is not provided, then the latest version of the model card is described.
+ *Details about the container that provides the runtime environment for the model that is + * deployed with the inference component.
* @public */ - ModelCardVersion?: number | undefined; -} + Container?: InferenceComponentContainerSpecificationSummary | undefined; -/** - * @public - * @enum - */ -export const ModelCardProcessingStatus = { - CONTENT_DELETED: "ContentDeleted", - DELETE_COMPLETED: "DeleteCompleted", - DELETE_FAILED: "DeleteFailed", - DELETE_INPROGRESS: "DeleteInProgress", - DELETE_PENDING: "DeletePending", - EXPORTJOBS_DELETED: "ExportJobsDeleted", -} as const; + /** + *Settings that take effect while the model container starts up.
+ * @public + */ + StartupParameters?: InferenceComponentStartupParameters | undefined; -/** - * @public - */ -export type ModelCardProcessingStatus = (typeof ModelCardProcessingStatus)[keyof typeof ModelCardProcessingStatus]; + /** + *The compute resources allocated to run the model, plus any + * adapter models, that you assign to the inference component.
+ * @public + */ + ComputeResourceRequirements?: InferenceComponentComputeResourceRequirements | undefined; + + /** + *The name of the base inference component that contains this inference component.
+ * @public + */ + BaseInferenceComponentName?: string | undefined; +} /** * @public */ -export interface DescribeModelCardResponse { +export interface DescribeInferenceComponentOutput { /** - *The Amazon Resource Name (ARN) of the model card.
+ *The name of the inference component.
* @public */ - ModelCardArn: string | undefined; + InferenceComponentName: string | undefined; /** - *The name of the model card.
+ *The Amazon Resource Name (ARN) of the inference component.
* @public */ - ModelCardName: string | undefined; + InferenceComponentArn: string | undefined; /** - *The version of the model card.
+ *The name of the endpoint that hosts the inference component.
* @public */ - ModelCardVersion: number | undefined; + EndpointName: string | undefined; /** - *The content of the model card.
+ *The Amazon Resource Name (ARN) of the endpoint that hosts the inference component.
* @public */ - Content: string | undefined; + EndpointArn: string | undefined; /** - *The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.
- *
- * Draft: The model card is a work in progress.
- * PendingReview: The model card is pending review.
- * Approved: The model card is approved.
- * Archived: The model card is archived. No more updates should be made to the model
- * card, but it can still be exported.
The name of the production variant that hosts the inference component.
* @public */ - ModelCardStatus: ModelCardStatus | undefined; + VariantName?: string | undefined; /** - *The security configuration used to protect model card content.
+ *If the inference component status is Failed, the reason for the
+ * failure.
The date and time the model card was created.
+ *Details about the resources that are deployed with this inference component.
* @public */ - CreationTime: Date | undefined; + Specification?: InferenceComponentSpecificationSummary | undefined; /** - *Information about the user who created or modified an experiment, trial, trial - * component, lineage group, project, or model card.
+ *Details about the runtime settings for the model that is deployed with the inference + * component.
* @public */ - CreatedBy: UserContext | undefined; + RuntimeConfig?: InferenceComponentRuntimeConfigSummary | undefined; /** - *The date and time the model card was last modified.
+ *The time when the inference component was created.
* @public */ - LastModifiedTime?: Date | undefined; + CreationTime: Date | undefined; /** - *Information about the user who created or modified an experiment, trial, trial - * component, lineage group, project, or model card.
+ *The time when the inference component was last updated.
* @public */ - LastModifiedBy?: UserContext | undefined; + LastModifiedTime: Date | undefined; /** - *The processing status of model card deletion. The ModelCardProcessingStatus updates throughout the different deletion steps.
- * DeletePending: Model card deletion request received.
- * DeleteInProgress: Model card deletion is in progress.
- * ContentDeleted: Deleted model card content.
- * ExportJobsDeleted: Deleted all export jobs associated with the model card.
- * DeleteCompleted: Successfully deleted the model card.
- * DeleteFailed: The model card failed to delete.
The status of the inference component.
* @public */ - ModelCardProcessingStatus?: ModelCardProcessingStatus | undefined; + InferenceComponentStatus?: InferenceComponentStatus | undefined; } /** * @public */ -export interface DescribeModelCardExportJobRequest { +export interface DescribeInferenceExperimentRequest { /** - *The Amazon Resource Name (ARN) of the model card export job to describe.
+ *The name of the inference experiment to describe.
* @public */ - ModelCardExportJobArn: string | undefined; + Name: string | undefined; } /** - *The artifacts of the model card export job.
+ *The metadata of the endpoint.
* @public */ -export interface ModelCardExportArtifacts { +export interface EndpointMetadata { /** - *The Amazon S3 URI of the exported model artifacts.
+ *The name of the endpoint.
* @public */ - S3ExportArtifacts: string | undefined; -} - -/** - * @public - * @enum - */ -export const ModelCardExportJobStatus = { - COMPLETED: "Completed", - FAILED: "Failed", - IN_PROGRESS: "InProgress", -} as const; - -/** - * @public - */ -export type ModelCardExportJobStatus = (typeof ModelCardExportJobStatus)[keyof typeof ModelCardExportJobStatus]; + EndpointName: string | undefined; -/** - * @public - */ -export interface DescribeModelCardExportJobResponse { /** - *The name of the model card export job to describe.
+ *The name of the endpoint configuration.
* @public */ - ModelCardExportJobName: string | undefined; + EndpointConfigName?: string | undefined; /** - *The Amazon Resource Name (ARN) of the model card export job.
+ *+ * The status of the endpoint. For possible values of the status of an endpoint, see EndpointSummary. + *
* @public */ - ModelCardExportJobArn: string | undefined; + EndpointStatus?: EndpointStatus | undefined; /** - *The completion status of the model card export job.
+ *
+ * If the status of the endpoint is Failed, or the status is InService but update
+ * operation fails, this provides the reason why it failed.
+ *
Summary of the deployment configuration of a model.
+ * @public + */ +export interface ModelVariantConfigSummary { + /** + *The name of the Amazon SageMaker Model entity.
+ * @public + */ + ModelName: string | undefined; + + /** + *The name of the variant.
+ * @public + */ + VariantName: string | undefined; + + /** + *The configuration of the infrastructure that the model has been deployed to.
+ * @public + */ + InfrastructureConfig: ModelInfrastructureConfig | undefined; + + /** + *The status of deployment for the model variant on the hosted inference endpoint.
*
- * InProgress: The model card export job is in progress.
Creating - Amazon SageMaker is preparing the model variant on the hosted inference endpoint.
+ *
*
- * Completed: The model card export job is complete.
InService - The model variant is running on the hosted inference endpoint.
+ *
*
- * Failed: The model card export job failed. To see the reason for the failure, see
- * the FailureReason field in the response to a
- * DescribeModelCardExportJob call.
Updating - Amazon SageMaker is updating the model variant on the hosted inference endpoint.
+ *
+ *
+ * Deleting - Amazon SageMaker is deleting the model variant on the hosted inference endpoint.
+ *
+ * Deleted - The model variant has been deleted on the hosted inference endpoint. This
+ * can only happen after stopping the experiment.
+ *
The name or Amazon Resource Name (ARN) of the model card that the model export job exports.
+ *The ARN of the inference experiment being described.
* @public */ - ModelCardName: string | undefined; + Arn: string | undefined; /** - *The version of the model card that the model export job exports.
+ *The name of the inference experiment.
* @public */ - ModelCardVersion: number | undefined; + Name: string | undefined; /** - *The export output details for the model card.
+ *The type of the inference experiment.
* @public */ - OutputConfig: ModelCardExportOutputConfig | undefined; + Type: InferenceExperimentType | undefined; /** - *The date and time that the model export job was created.
+ *The duration for which the inference experiment ran or will run.
* @public */ - CreatedAt: Date | undefined; + Schedule?: InferenceExperimentSchedule | undefined; /** - *The date and time that the model export job was last modified.
+ *+ * The status of the inference experiment. The following are the possible statuses for an inference + * experiment: + *
+ *
+ * Creating - Amazon SageMaker is creating your experiment.
+ *
+ * Created - Amazon SageMaker has finished the creation of your experiment and will begin the
+ * experiment at the scheduled time.
+ *
+ * Updating - When you make changes to your experiment, your experiment shows as updating.
+ *
+ * Starting - Amazon SageMaker is beginning your experiment.
+ *
+ * Running - Your experiment is in progress.
+ *
+ * Stopping - Amazon SageMaker is stopping your experiment.
+ *
+ * Completed - Your experiment has completed.
+ *
+ * Cancelled - When you conclude your experiment early using the StopInferenceExperiment API, or if any operation fails with an unexpected error, it shows
+ * as cancelled.
+ *
The failure reason if the model export job fails.
+ *
+ * The error message or client-specified Reason from the StopInferenceExperiment
+ * API, that explains the status of the inference experiment.
+ *
The exported model card artifacts.
+ *The description of the inference experiment.
* @public */ - ExportArtifacts?: ModelCardExportArtifacts | undefined; -} + Description?: string | undefined; -/** - * @public - */ -export interface DescribeModelExplainabilityJobDefinitionRequest { /** - *The name of the model explainability job definition. The name must be unique within an - * Amazon Web Services Region in the Amazon Web Services account.
+ *The timestamp at which you created the inference experiment.
* @public */ - JobDefinitionName: string | undefined; -} + CreationTime?: Date | undefined; -/** - * @public - */ -export interface DescribeModelExplainabilityJobDefinitionResponse { /** - *The Amazon Resource Name (ARN) of the model explainability job.
+ *+ * The timestamp at which the inference experiment was completed. + *
* @public */ - JobDefinitionArn: string | undefined; + CompletionTime?: Date | undefined; /** - *The name of the explainability job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.
+ *The timestamp at which you last modified the inference experiment.
* @public */ - JobDefinitionName: string | undefined; + LastModifiedTime?: Date | undefined; /** - *The time at which the model explainability job was created.
+ *+ * The ARN of the IAM role that Amazon SageMaker can assume to access model artifacts and container images, and manage + * Amazon SageMaker Inference endpoints for model deployment. + *
* @public */ - CreationTime: Date | undefined; + RoleArn?: string | undefined; /** - *The baseline configuration for a model explainability job.
+ *The metadata of the endpoint on which the inference experiment ran.
* @public */ - ModelExplainabilityBaselineConfig?: ModelExplainabilityBaselineConfig | undefined; + EndpointMetadata: EndpointMetadata | undefined; /** - *Configures the model explainability job to run a specified Docker container image.
+ *
+ * An array of ModelVariantConfigSummary objects. There is one for each variant in the inference
+ * experiment. Each ModelVariantConfigSummary object in the array describes the infrastructure
+ * configuration for deploying the corresponding variant.
+ *
Inputs for the model explainability job.
+ *The Amazon S3 location and configuration for storing inference request and response data.
* @public */ - ModelExplainabilityJobInput: ModelExplainabilityJobInput | undefined; + DataStorageConfig?: InferenceExperimentDataStorageConfig | undefined; /** - *The output configuration for monitoring jobs.
+ *
+ * The configuration of ShadowMode inference experiment type, which shows the production variant
+ * that takes all the inference requests, and the shadow variant to which Amazon SageMaker replicates a percentage of the
+ * inference requests. For the shadow variant it also shows the percentage of requests that Amazon SageMaker replicates.
+ *
Identifies the resources to deploy for a monitoring job.
+ *+ * The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on + * the storage volume attached to the ML compute instance that hosts the endpoint. For more information, see + * CreateInferenceExperiment. + *
* @public */ - JobResources: MonitoringResources | undefined; + KmsKey?: string | undefined; +} +/** + * @public + */ +export interface DescribeInferenceRecommendationsJobRequest { /** - *Networking options for a model explainability job.
+ *The name of the job. The name must be unique within an + * Amazon Web Services Region in the Amazon Web Services account.
* @public */ - NetworkConfig?: MonitoringNetworkConfig | undefined; + JobName: string | undefined; +} +/** + *The metrics for an existing endpoint compared in an Inference Recommender job.
+ * @public + */ +export interface InferenceMetrics { /** - *The Amazon Resource Name (ARN) of the IAM role that has read permission to the - * input data location and write permission to the output data location in Amazon S3.
+ *The expected maximum number of requests per minute for the instance.
* @public */ - RoleArn: string | undefined; + MaxInvocations: number | undefined; /** - *A time limit for how long the monitoring job is allowed to run before stopping.
+ *The expected model latency at maximum invocations per minute for the instance.
* @public */ - StoppingCondition?: MonitoringStoppingCondition | undefined; + ModelLatency: number | undefined; } /** + *The performance results from running an Inference Recommender job on an existing endpoint.
* @public */ -export interface DescribeModelPackageInput { +export interface EndpointPerformance { /** - *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).
+ *The metrics for an existing endpoint.
* @public */ - ModelPackageName: string | undefined; -} - -/** - * @public - * @enum - */ -export const DetailedModelPackageStatus = { - COMPLETED: "Completed", - FAILED: "Failed", - IN_PROGRESS: "InProgress", - NOT_STARTED: "NotStarted", -} as const; + Metrics: InferenceMetrics | undefined; -/** - * @public - */ -export type DetailedModelPackageStatus = (typeof DetailedModelPackageStatus)[keyof typeof DetailedModelPackageStatus]; + /** + *Details about a customer endpoint that was compared in an Inference Recommender job.
+ * @public + */ + EndpointInfo: EndpointInfo | undefined; +} /** - *Represents the overall status of a model package.
+ *The endpoint configuration made by Inference Recommender during a recommendation job.
* @public */ -export interface ModelPackageStatusItem { +export interface EndpointOutputConfiguration { /** - *The name of the model package for which the overall status is being reported.
+ *The name of the endpoint made during a recommendation job.
* @public */ - Name: string | undefined; + EndpointName: string | undefined; /** - *The current status.
+ *The name of the production variant (deployed model) made during a recommendation job.
* @public */ - Status: DetailedModelPackageStatus | undefined; + VariantName: string | undefined; /** - *if the overall status is Failed, the reason for the failure.
The instance type recommended by Amazon SageMaker Inference Recommender.
* @public */ - FailureReason?: string | undefined; -} + InstanceType?: ProductionVariantInstanceType | undefined; -/** - *Specifies the validation and image scan statuses of the model package.
- * @public - */ -export interface ModelPackageStatusDetails { /** - *The validation status of the model package.
+ *The number of instances recommended to launch initially.
* @public */ - ValidationStatuses: ModelPackageStatusItem[] | undefined; + InitialInstanceCount?: number | undefined; /** - *The status of the scan of the Docker image container for the model package.
+ *Specifies the serverless configuration for an endpoint variant.
* @public */ - ImageScanStatuses?: ModelPackageStatusItem[] | undefined; + ServerlessConfig?: ProductionVariantServerlessConfig | undefined; } /** + *The metrics of recommendations.
* @public */ -export interface DescribeModelPackageOutput { +export interface RecommendationMetrics { /** - *The name of the model package being described.
+ *Defines the cost per hour for the instance.
* @public */ - ModelPackageName: string | undefined; + CostPerHour?: number | undefined; /** - *If the model is a versioned model, the name of the model group that the versioned - * model belongs to.
+ *Defines the cost per inference for the instance .
* @public */ - ModelPackageGroupName?: string | undefined; + CostPerInference?: number | undefined; /** - *The version of the model package.
+ *The expected maximum number of requests per minute for the instance.
* @public */ - ModelPackageVersion?: number | undefined; + MaxInvocations?: number | undefined; /** - *The Amazon Resource Name (ARN) of the model package.
+ *The expected model latency at maximum invocation per minute for the instance.
* @public */ - ModelPackageArn: string | undefined; + ModelLatency?: number | undefined; /** - *A brief summary of the model package.
- * @public - */ - ModelPackageDescription?: string | undefined; - - /** - *A timestamp specifying when the model package was created.
- * @public - */ - CreationTime: Date | undefined; - - /** - *Details about inference jobs that you can run with models based on this model - * package.
+ *The expected CPU utilization at maximum invocations per minute for the instance.
+ *
+ * NaN indicates that the value is not available.
Details about the algorithm that was used to create the model package.
+ *The expected memory utilization at maximum invocations per minute for the instance.
+ *
+ * NaN indicates that the value is not available.
Configurations for one or more transform jobs that SageMaker runs to test the model - * package.
+ *The time it takes to launch new compute resources for a serverless endpoint. + * The time can vary depending on the model size, how long it takes to download the + * model, and the start-up time of the container.
+ *
+ * NaN indicates that the value is not available.
A list of environment parameters suggested by the Amazon SageMaker Inference Recommender.
+ * @public + */ +export interface EnvironmentParameter { /** - *The current status of the model package.
+ *The environment key suggested by the Amazon SageMaker Inference Recommender.
* @public */ - ModelPackageStatus: ModelPackageStatus | undefined; + Key: string | undefined; /** - *Details about the current status of the model package.
+ *The value type suggested by the Amazon SageMaker Inference Recommender.
* @public */ - ModelPackageStatusDetails: ModelPackageStatusDetails | undefined; + ValueType: string | undefined; /** - *Whether the model package is certified for listing on Amazon Web Services Marketplace.
+ *The value suggested by the Amazon SageMaker Inference Recommender.
* @public */ - CertifyForMarketplace?: boolean | undefined; + Value: string | undefined; +} +/** + *Defines the model configuration. Includes the specification name and environment parameters.
+ * @public + */ +export interface ModelConfiguration { /** - *The approval status of the model package.
+ *The inference specification name in the model package version.
* @public */ - ModelApprovalStatus?: ModelApprovalStatus | undefined; + InferenceSpecificationName?: string | undefined; /** - *Information about the user who created or modified an experiment, trial, trial - * component, lineage group, project, or model card.
+ *Defines the environment parameters that includes key, value types, and values.
* @public */ - CreatedBy?: UserContext | undefined; + EnvironmentParameters?: EnvironmentParameter[] | undefined; /** - *Metadata properties of the tracking entity, trial, or trial component.
+ *The name of the compilation job used to create the recommended model artifacts.
* @public */ - MetadataProperties?: MetadataProperties | undefined; + CompilationJobName?: string | undefined; +} +/** + *A list of recommendations made by Amazon SageMaker Inference Recommender.
+ * @public + */ +export interface InferenceRecommendation { /** - *Metrics for the model.
+ *The recommendation ID which uniquely identifies each recommendation.
* @public */ - ModelMetrics?: ModelMetrics | undefined; + RecommendationId?: string | undefined; /** - *The last time that the model package was modified.
+ *The metrics used to decide what recommendation to make.
* @public */ - LastModifiedTime?: Date | undefined; + Metrics?: RecommendationMetrics | undefined; /** - *Information about the user who created or modified an experiment, trial, trial - * component, lineage group, project, or model card.
+ *Defines the endpoint configuration parameters.
* @public */ - LastModifiedBy?: UserContext | undefined; + EndpointConfiguration: EndpointOutputConfiguration | undefined; /** - *A description provided for the model approval.
+ *Defines the model configuration.
* @public */ - ApprovalDescription?: string | undefined; + ModelConfiguration: ModelConfiguration | undefined; /** - *The machine learning domain of the model package you specified. Common machine - * learning domains include computer vision and natural language processing.
+ *A timestamp that shows when the benchmark completed.
* @public */ - Domain?: string | undefined; + InvocationEndTime?: Date | undefined; /** - *The machine learning task you specified that your model package accomplishes. - * Common machine learning tasks include object detection and image classification.
+ *A timestamp that shows when the benchmark started.
* @public */ - Task?: string | undefined; + InvocationStartTime?: Date | 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).
- * @public - */ - SamplePayloadUrl?: string | undefined; +/** + * @public + * @enum + */ +export const RecommendationJobStatus = { + COMPLETED: "COMPLETED", + DELETED: "DELETED", + DELETING: "DELETING", + FAILED: "FAILED", + IN_PROGRESS: "IN_PROGRESS", + PENDING: "PENDING", + STOPPED: "STOPPED", + STOPPING: "STOPPING", +} as const; - /** - *The metadata properties associated with the model package versions.
- * @public - */ - 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. - *
+ *The name of the job. The name must be unique within an + * Amazon Web Services Region in the Amazon Web Services account.
* @public */ - DriftCheckBaselines?: DriftCheckBaselines | undefined; + JobName: string | 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.
+ *The job description that you provided when you initiated the job.
* @public */ - AdditionalInferenceSpecifications?: AdditionalInferenceSpecificationDefinition[] | undefined; + JobDescription?: string | undefined; /** - *Indicates if you want to skip model validation.
+ *The job type that you provided when you initiated the job.
* @public */ - SkipModelValidation?: SkipModelValidation | undefined; + JobType: RecommendationJobType | undefined; /** - *The URI of the source for the model package.
+ *The Amazon Resource Name (ARN) of the job.
* @public */ - SourceUri?: string | undefined; + JobArn: string | undefined; /** - *The KMS Key ID (KMSKeyId) used for encryption of model package information.
The Amazon Resource Name (ARN) of the Amazon Web Services + * Identity and Access Management (IAM) role you provided when you initiated the job.
* @public */ - SecurityConfig?: ModelPackageSecurityConfig | undefined; + RoleArn: 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 status of the job.
* @public */ - ModelCard?: ModelPackageModelCard | undefined; + Status: RecommendationJobStatus | undefined; /** - *- * A structure describing the current state of the model in its life cycle. - *
+ *A timestamp that shows when the job was created.
* @public */ - ModelLifeCycle?: ModelLifeCycle | undefined; -} + CreationTime: Date | undefined; -/** - * @public - */ -export interface DescribeModelPackageGroupInput { /** - *The name of the model group to describe.
+ *A timestamp that shows when the job completed.
* @public */ - ModelPackageGroupName: string | undefined; -} - -/** - * @public - * @enum - */ -export const ModelPackageGroupStatus = { - COMPLETED: "Completed", - DELETE_FAILED: "DeleteFailed", - DELETING: "Deleting", - FAILED: "Failed", - IN_PROGRESS: "InProgress", - PENDING: "Pending", -} as const; - -/** - * @public - */ -export type ModelPackageGroupStatus = (typeof ModelPackageGroupStatus)[keyof typeof ModelPackageGroupStatus]; + CompletionTime?: Date | undefined; -/** - * @public - */ -export interface DescribeModelPackageGroupOutput { /** - *The name of the model group.
+ *A timestamp that shows when the job was last modified.
* @public */ - ModelPackageGroupName: string | undefined; + LastModifiedTime: Date | undefined; /** - *The Amazon Resource Name (ARN) of the model group.
+ *If the job fails, provides information why the job failed.
* @public */ - ModelPackageGroupArn: string | undefined; + FailureReason?: string | undefined; /** - *A description of the model group.
+ *Returns information about the versioned model package Amazon Resource Name (ARN), + * the traffic pattern, and endpoint configurations you provided when you initiated the job.
* @public */ - ModelPackageGroupDescription?: string | undefined; + InputConfig: RecommendationJobInputConfig | undefined; /** - *The time that the model group was created.
+ *The stopping conditions that you provided when you initiated the job.
* @public */ - CreationTime: Date | undefined; + StoppingConditions?: RecommendationJobStoppingConditions | undefined; /** - *Information about the user who created or modified an experiment, trial, trial - * component, lineage group, project, or model card.
+ *The recommendations made by Inference Recommender.
* @public */ - CreatedBy: UserContext | undefined; + InferenceRecommendations?: InferenceRecommendation[] | undefined; /** - *The status of the model group.
+ *The performance results from running an Inference Recommender job on an existing endpoint.
* @public */ - ModelPackageGroupStatus: ModelPackageGroupStatus | undefined; + EndpointPerformances?: EndpointPerformance[] | undefined; } /** * @public */ -export interface DescribeModelQualityJobDefinitionRequest { +export interface DescribeLabelingJobRequest { /** - *The name of the model quality job. The name must be unique within an Amazon Web Services - * Region in the Amazon Web Services account.
+ *The name of the labeling job to return information for.
* @public */ - JobDefinitionName: string | undefined; + LabelingJobName: string | undefined; } /** + *Provides a breakdown of the number of objects labeled.
* @public */ -export interface DescribeModelQualityJobDefinitionResponse { +export interface LabelCounters { /** - *The Amazon Resource Name (ARN) of the model quality job.
+ *The total number of objects labeled.
* @public */ - JobDefinitionArn: string | undefined; + TotalLabeled?: number | undefined; /** - *The name of the quality job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.
+ *The total number of objects labeled by a human worker.
* @public */ - JobDefinitionName: string | undefined; + HumanLabeled?: number | undefined; /** - *The time at which the model quality job was created.
+ *The total number of objects labeled by automated data labeling.
* @public */ - CreationTime: Date | undefined; + MachineLabeled?: number | undefined; /** - *The baseline configuration for a model quality job.
+ *The total number of objects that could not be labeled due to an error.
* @public */ - ModelQualityBaselineConfig?: ModelQualityBaselineConfig | undefined; + FailedNonRetryableError?: number | undefined; /** - *Configures the model quality job to run a specified Docker container image.
+ *The total number of objects not yet labeled.
* @public */ - ModelQualityAppSpecification: ModelQualityAppSpecification | undefined; + Unlabeled?: number | undefined; +} +/** + *Specifies the location of the output produced by the labeling job.
+ * @public + */ +export interface LabelingJobOutput { /** - *Inputs for the model quality job.
+ *The Amazon S3 bucket location of the manifest file for labeled data.
* @public */ - ModelQualityJobInput: ModelQualityJobInput | undefined; + OutputDatasetS3Uri: string | undefined; /** - *The output configuration for monitoring jobs.
+ *The Amazon Resource Name (ARN) for the most recent SageMaker model trained as part of + * automated data labeling.
* @public */ - ModelQualityJobOutputConfig: MonitoringOutputConfig | undefined; - - /** - *Identifies the resources to deploy for a monitoring job.
- * @public - */ - JobResources: MonitoringResources | undefined; - - /** - *Networking options for a model quality job.
- * @public - */ - NetworkConfig?: MonitoringNetworkConfig | undefined; - - /** - *The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can - * assume to perform tasks on your behalf.
- * @public - */ - RoleArn: string | undefined; - - /** - *A time limit for how long the monitoring job is allowed to run before stopping.
- * @public - */ - StoppingCondition?: MonitoringStoppingCondition | undefined; -} - -/** - * @public - */ -export interface DescribeMonitoringScheduleRequest { - /** - *Name of a previously created monitoring schedule.
- * @public - */ - MonitoringScheduleName: string | undefined; -} + FinalActiveLearningModelArn?: string | undefined; +} /** * @public * @enum */ -export const ExecutionStatus = { +export const LabelingJobStatus = { COMPLETED: "Completed", - COMPLETED_WITH_VIOLATIONS: "CompletedWithViolations", FAILED: "Failed", + INITIALIZING: "Initializing", IN_PROGRESS: "InProgress", - PENDING: "Pending", STOPPED: "Stopped", STOPPING: "Stopping", } as const; @@ -1770,692 +1878,685 @@ export const ExecutionStatus = { /** * @public */ -export type ExecutionStatus = (typeof ExecutionStatus)[keyof typeof ExecutionStatus]; +export type LabelingJobStatus = (typeof LabelingJobStatus)[keyof typeof LabelingJobStatus]; /** - *Summary of information about the last monitoring job to run.
* @public */ -export interface MonitoringExecutionSummary { - /** - *The name of the monitoring schedule.
- * @public - */ - MonitoringScheduleName: string | undefined; - +export interface DescribeLabelingJobResponse { /** - *The time the monitoring job was scheduled.
+ *The processing status of the labeling job.
* @public */ - ScheduledTime: Date | undefined; + LabelingJobStatus: LabelingJobStatus | undefined; /** - *The time at which the monitoring job was created.
+ *Provides a breakdown of the number of data objects labeled by humans, the number of + * objects labeled by machine, the number of objects than couldn't be labeled, and the + * total number of objects labeled.
* @public */ - CreationTime: Date | undefined; + LabelCounters: LabelCounters | undefined; /** - *A timestamp that indicates the last time the monitoring job was modified.
+ *If the job failed, the reason that it failed.
* @public */ - LastModifiedTime: Date | undefined; + FailureReason?: string | undefined; /** - *The status of the monitoring job.
+ *The date and time that the labeling job was created.
* @public */ - MonitoringExecutionStatus: ExecutionStatus | undefined; + CreationTime: Date | undefined; /** - *The Amazon Resource Name (ARN) of the monitoring job.
+ *The date and time that the labeling job was last updated.
* @public */ - ProcessingJobArn?: string | undefined; + LastModifiedTime: Date | undefined; /** - *The name of the endpoint used to run the monitoring job.
+ *A unique identifier for work done as part of a labeling job.
* @public */ - EndpointName?: string | undefined; + JobReferenceCode: string | undefined; /** - *Contains the reason a monitoring job failed, if it failed.
+ *The name assigned to the labeling job when it was created.
* @public */ - FailureReason?: string | undefined; + LabelingJobName: string | undefined; /** - *The name of the monitoring job.
+ *The Amazon Resource Name (ARN) of the labeling job.
* @public */ - MonitoringJobDefinitionName?: string | undefined; + LabelingJobArn: string | undefined; /** - *The type of the monitoring job.
+ *The attribute used as the label in the output manifest file.
* @public */ - MonitoringType?: MonitoringType | undefined; -} - -/** - * @public - * @enum - */ -export const ScheduleStatus = { - FAILED: "Failed", - PENDING: "Pending", - SCHEDULED: "Scheduled", - STOPPED: "Stopped", -} as const; - -/** - * @public - */ -export type ScheduleStatus = (typeof ScheduleStatus)[keyof typeof ScheduleStatus]; + LabelAttributeName?: string | undefined; -/** - * @public - */ -export interface DescribeMonitoringScheduleResponse { /** - *The Amazon Resource Name (ARN) of the monitoring schedule.
+ *Input configuration information for the labeling job, such as the Amazon S3 location of the + * data objects and the location of the manifest file that describes the data + * objects.
* @public */ - MonitoringScheduleArn: string | undefined; + InputConfig: LabelingJobInputConfig | undefined; /** - *Name of the monitoring schedule.
+ *The location of the job's output data and the Amazon Web Services Key Management + * Service key ID for the key used to encrypt the output data, if any.
* @public */ - MonitoringScheduleName: string | undefined; + OutputConfig: LabelingJobOutputConfig | undefined; /** - *The status of an monitoring job.
+ *The Amazon Resource Name (ARN) that SageMaker assumes to perform tasks on your behalf + * during data labeling.
* @public */ - MonitoringScheduleStatus: ScheduleStatus | undefined; + RoleArn: string | undefined; /** - *The type of the monitoring job that this schedule runs. This is one of the following - * values.
+ *The S3 location of the JSON file that defines the categories used to label data + * objects. Please note the following label-category limits:
*
- * DATA_QUALITY - The schedule is for a data quality monitoring
- * job.
- * MODEL_QUALITY - The schedule is for a model quality monitoring
- * job.
- * MODEL_BIAS - The schedule is for a bias monitoring job.
Semantic segmentation labeling jobs using automated labeling: 20 labels
*
- * MODEL_EXPLAINABILITY - The schedule is for an explainability
- * monitoring job.
Box bounding labeling jobs (all): 10 labels
*The file is a JSON structure in the following format:
+ *
+ * \{
+ *
+ * "document-version": "2018-11-28"
+ *
+ * "labels": [
+ *
+ * \{
+ *
+ * "label": "label 1"
+ *
+ * \},
+ *
+ * \{
+ *
+ * "label": "label 2"
+ *
+ * \},
+ *
+ * ...
+ *
+ * \{
+ *
+ * "label": "label n"
+ *
+ * \}
+ *
+ * ]
+ *
+ * \}
+ *
A string, up to one KB in size, that contains the reason a monitoring job failed, if it - * failed.
- * @public - */ - FailureReason?: string | undefined; + LabelCategoryConfigS3Uri?: string | undefined; /** - *The time at which the monitoring job was created.
+ *A set of conditions for stopping a labeling job. If any of the conditions are met, the + * job is automatically stopped.
* @public */ - CreationTime: Date | undefined; + StoppingConditions?: LabelingJobStoppingConditions | undefined; /** - *The time at which the monitoring job was last modified.
+ *Configuration information for automated data labeling.
* @public */ - LastModifiedTime: Date | undefined; + LabelingJobAlgorithmsConfig?: LabelingJobAlgorithmsConfig | undefined; /** - *The configuration object that specifies the monitoring schedule and defines the monitoring - * job.
+ *Configuration information required for human workers to complete a labeling + * task.
* @public */ - MonitoringScheduleConfig: MonitoringScheduleConfig | undefined; + HumanTaskConfig: HumanTaskConfig | undefined; /** - *The name of the endpoint for the monitoring job.
+ *An array of key-value pairs. You can use tags to categorize your Amazon Web Services + * resources in different ways, for example, by purpose, owner, or environment. For more + * information, see Tagging Amazon Web Services Resources.
* @public */ - EndpointName?: string | undefined; + Tags?: Tag[] | undefined; /** - *Describes metadata on the last execution to run, if there was one.
+ *The location of the output produced by the labeling job.
* @public */ - LastMonitoringExecutionSummary?: MonitoringExecutionSummary | undefined; + LabelingJobOutput?: LabelingJobOutput | undefined; } /** * @public */ -export interface DescribeNotebookInstanceInput { +export interface DescribeLineageGroupRequest { /** - *The name of the notebook instance that you want information about.
+ *The name of the lineage group.
* @public */ - NotebookInstanceName: string | undefined; + LineageGroupName: string | undefined; } -/** - * @public - * @enum - */ -export const NotebookInstanceStatus = { - Deleting: "Deleting", - Failed: "Failed", - InService: "InService", - Pending: "Pending", - Stopped: "Stopped", - Stopping: "Stopping", - Updating: "Updating", -} as const; - -/** - * @public - */ -export type NotebookInstanceStatus = (typeof NotebookInstanceStatus)[keyof typeof NotebookInstanceStatus]; - /** * @public */ -export interface DescribeNotebookInstanceOutput { +export interface DescribeLineageGroupResponse { /** - *The Amazon Resource Name (ARN) of the notebook instance.
+ *The name of the lineage group.
* @public */ - NotebookInstanceArn?: string | undefined; + LineageGroupName?: string | undefined; /** - *The name of the SageMaker notebook instance.
+ *The Amazon Resource Name (ARN) of the lineage group.
* @public */ - NotebookInstanceName?: string | undefined; + LineageGroupArn?: string | undefined; /** - *The status of the notebook instance.
+ *The display name of the lineage group.
* @public */ - NotebookInstanceStatus?: NotebookInstanceStatus | undefined; + DisplayName?: string | undefined; /** - *If status is Failed, the reason it failed.
The description of the lineage group.
* @public */ - FailureReason?: string | undefined; + Description?: string | undefined; /** - *The URL that you use to connect to the Jupyter notebook that is running in your - * notebook instance.
+ *The creation time of lineage group.
* @public */ - Url?: string | undefined; + CreationTime?: Date | undefined; /** - *The type of ML compute instance running on the notebook instance.
+ *Information about the user who created or modified an experiment, trial, trial + * component, lineage group, project, or model card.
* @public */ - InstanceType?: _InstanceType | undefined; + CreatedBy?: UserContext | undefined; /** - *The ID of the VPC subnet.
+ *The last modified time of the lineage group.
* @public */ - SubnetId?: string | undefined; + LastModifiedTime?: Date | undefined; /** - *The IDs of the VPC security groups.
+ *Information about the user who created or modified an experiment, trial, trial + * component, lineage group, project, or model card.
* @public */ - SecurityGroups?: string[] | undefined; + LastModifiedBy?: UserContext | undefined; +} +/** + * @public + */ +export interface DescribeMlflowTrackingServerRequest { /** - *The Amazon Resource Name (ARN) of the IAM role associated with the instance. - *
+ *The name of the MLflow Tracking Server to describe.
* @public */ - RoleArn?: string | undefined; + TrackingServerName: string | undefined; +} + +/** + * @public + * @enum + */ +export const IsTrackingServerActive = { + ACTIVE: "Active", + INACTIVE: "Inactive", +} as const; + +/** + * @public + */ +export type IsTrackingServerActive = (typeof IsTrackingServerActive)[keyof typeof IsTrackingServerActive]; + +/** + * @public + * @enum + */ +export const TrackingServerStatus = { + CREATED: "Created", + CREATE_FAILED: "CreateFailed", + CREATING: "Creating", + DELETE_FAILED: "DeleteFailed", + DELETING: "Deleting", + MAINTENANCE_COMPLETE: "MaintenanceComplete", + MAINTENANCE_FAILED: "MaintenanceFailed", + MAINTENANCE_IN_PROGRESS: "MaintenanceInProgress", + STARTED: "Started", + STARTING: "Starting", + START_FAILED: "StartFailed", + STOPPED: "Stopped", + STOPPING: "Stopping", + STOP_FAILED: "StopFailed", + UPDATED: "Updated", + UPDATE_FAILED: "UpdateFailed", + UPDATING: "Updating", +} as const; + +/** + * @public + */ +export type TrackingServerStatus = (typeof TrackingServerStatus)[keyof typeof TrackingServerStatus]; +/** + * @public + */ +export interface DescribeMlflowTrackingServerResponse { /** - *The Amazon Web Services KMS key ID SageMaker uses to encrypt data when - * storing it on the ML storage volume attached to the instance.
+ *The ARN of the described tracking server.
* @public */ - KmsKeyId?: string | undefined; + TrackingServerArn?: string | undefined; /** - *The network interface IDs that SageMaker created at the time of creating - * the instance.
+ *The name of the described tracking server.
* @public */ - NetworkInterfaceId?: string | undefined; + TrackingServerName?: string | undefined; /** - *A timestamp. Use this parameter to retrieve the time when the notebook instance was - * last modified.
+ *The S3 URI of the general purpose bucket used as the MLflow Tracking Server + * artifact store.
* @public */ - LastModifiedTime?: Date | undefined; + ArtifactStoreUri?: string | undefined; /** - *A timestamp. Use this parameter to return the time when the notebook instance was - * created
+ *The size of the described tracking server.
* @public */ - CreationTime?: Date | undefined; + TrackingServerSize?: TrackingServerSize | undefined; /** - *Returns the name of a notebook instance lifecycle configuration.
- *For information about notebook instance lifestyle configurations, see Step - * 2.1: (Optional) Customize a Notebook Instance - *
+ *The MLflow version used for the described tracking server.
* @public */ - NotebookInstanceLifecycleConfigName?: string | undefined; + MlflowVersion?: string | undefined; /** - *Describes whether SageMaker provides internet access to the notebook instance. - * If this value is set to Disabled, the notebook instance does not - * have internet access, and cannot connect to SageMaker training and endpoint - * services.
- *For more information, see Notebook Instances Are Internet-Enabled by Default.
+ *The Amazon Resource Name (ARN) for an IAM role in your account that the described MLflow Tracking Server + * uses to access the artifact store in Amazon S3.
* @public */ - DirectInternetAccess?: DirectInternetAccess | undefined; + RoleArn?: string | undefined; /** - *The size, in GB, of the ML storage volume attached to the notebook instance.
+ *The current creation status of the described MLflow Tracking Server.
* @public */ - VolumeSizeInGB?: number | undefined; + TrackingServerStatus?: TrackingServerStatus | undefined; /** - *This parameter is no longer supported. Elastic Inference (EI) is no longer - * available.
- *This parameter was used to specify a list of the EI instance types associated with - * this notebook instance.
+ *Whether the described MLflow Tracking Server is currently active.
* @public */ - AcceleratorTypes?: NotebookInstanceAcceleratorType[] | undefined; + IsActive?: IsTrackingServerActive | undefined; /** - *The Git repository associated with the notebook instance as its default code - * repository. This can be either the name of a Git repository stored as a resource in your - * account, or the URL of a Git repository in Amazon Web Services CodeCommit - * or in any other Git repository. When you open a notebook instance, it opens in the - * directory that contains this repository. For more information, see Associating Git - * Repositories with SageMaker Notebook Instances.
+ *The URL to connect to the MLflow user interface for the described tracking server.
* @public */ - DefaultCodeRepository?: string | undefined; + TrackingServerUrl?: string | undefined; /** - *An array of up to three Git repositories associated with the notebook instance. These - * can be either the names of Git repositories stored as resources in your account, or the - * URL of Git repositories in Amazon Web Services CodeCommit - * or in any other Git repository. These repositories are cloned at the same level as the - * default repository of your notebook instance. For more information, see Associating Git - * Repositories with SageMaker Notebook Instances.
+ *The day and time of the week when weekly maintenance occurs on the described tracking server.
* @public */ - AdditionalCodeRepositories?: string[] | undefined; + WeeklyMaintenanceWindowStart?: string | undefined; /** - *Whether root access is enabled or disabled for users of the notebook instance.
- *Lifecycle configurations need root access to be able to set up a notebook - * instance. Because of this, lifecycle configurations associated with a notebook - * instance always run with root access even if you disable root access for - * users.
- *Whether automatic registration of new MLflow models to the SageMaker Model Registry is enabled.
* @public */ - RootAccess?: RootAccess | undefined; + AutomaticModelRegistration?: boolean | undefined; /** - *The platform identifier of the notebook instance runtime environment.
+ *The timestamp of when the described MLflow Tracking Server was created.
* @public */ - PlatformIdentifier?: string | undefined; + CreationTime?: Date | undefined; /** - *Information on the IMDS configuration of the notebook instance
+ *Information about the user who created or modified an experiment, trial, trial + * component, lineage group, project, or model card.
* @public */ - InstanceMetadataServiceConfiguration?: InstanceMetadataServiceConfiguration | undefined; + CreatedBy?: UserContext | undefined; + + /** + *The timestamp of when the described MLflow Tracking Server was last modified.
+ * @public + */ + LastModifiedTime?: Date | undefined; + + /** + *Information about the user who created or modified an experiment, trial, trial + * component, lineage group, project, or model card.
+ * @public + */ + LastModifiedBy?: UserContext | undefined; } /** * @public */ -export interface DescribeNotebookInstanceLifecycleConfigInput { +export interface DescribeModelInput { /** - *The name of the lifecycle configuration to describe.
+ *The name of the model.
* @public */ - NotebookInstanceLifecycleConfigName: string | undefined; + ModelName: string | undefined; } /** * @public */ -export interface DescribeNotebookInstanceLifecycleConfigOutput { +export interface DescribeModelOutput { /** - *The Amazon Resource Name (ARN) of the lifecycle configuration.
+ *Name of the SageMaker model.
* @public */ - NotebookInstanceLifecycleConfigArn?: string | undefined; + ModelName: string | undefined; /** - *The name of the lifecycle configuration.
+ *The location of the primary inference code, associated artifacts, and custom + * environment map that the inference code uses when it is deployed in production. + *
* @public */ - NotebookInstanceLifecycleConfigName?: string | undefined; + PrimaryContainer?: ContainerDefinition | undefined; /** - *The shell script that runs only once, when you create a notebook instance.
+ *The containers in the inference pipeline.
* @public */ - OnCreate?: NotebookInstanceLifecycleHook[] | undefined; + Containers?: ContainerDefinition[] | undefined; /** - *The shell script that runs every time you start a notebook instance, including when - * you create the notebook instance.
+ *Specifies details of how containers in a multi-container endpoint are called.
* @public */ - OnStart?: NotebookInstanceLifecycleHook[] | undefined; + InferenceExecutionConfig?: InferenceExecutionConfig | undefined; /** - *A timestamp that tells when the lifecycle configuration was last modified.
+ *The Amazon Resource Name (ARN) of the IAM role that you specified for the + * model.
* @public */ - LastModifiedTime?: Date | undefined; + ExecutionRoleArn?: string | undefined; /** - *A timestamp that tells when the lifecycle configuration was created.
+ *A VpcConfig object that specifies the VPC that this model has access to. For + * more information, see Protect Endpoints by Using an Amazon Virtual + * Private Cloud + *
* @public */ - CreationTime?: Date | undefined; -} + VpcConfig?: VpcConfig | undefined; -/** - * @public - */ -export interface DescribeOptimizationJobRequest { /** - *The name that you assigned to the optimization job.
+ *A timestamp that shows when the model was created.
* @public */ - OptimizationJobName: string | undefined; + CreationTime: Date | undefined; + + /** + *The Amazon Resource Name (ARN) of the model.
+ * @public + */ + ModelArn: string | undefined; + + /** + *If True, no inbound or outbound network calls can be made to or from the
+ * model container.
A set of recommended deployment configurations for the model.
+ * @public + */ + DeploymentRecommendation?: DeploymentRecommendation | undefined; } /** - * @public - * @enum - */ -export const OptimizationJobStatus = { - COMPLETED: "COMPLETED", - FAILED: "FAILED", - INPROGRESS: "INPROGRESS", - STARTING: "STARTING", - STOPPED: "STOPPED", - STOPPING: "STOPPING", -} as const; - -/** - * @public - */ -export type OptimizationJobStatus = (typeof OptimizationJobStatus)[keyof typeof OptimizationJobStatus]; - -/** - *Output values produced by an optimization job.
* @public */ -export interface OptimizationOutput { +export interface DescribeModelBiasJobDefinitionRequest { /** - *The image that SageMaker recommends that you use to host the optimized model that you created - * with an optimization job.
+ *The name of the model bias job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.
* @public */ - RecommendedInferenceImage?: string | undefined; + JobDefinitionName: string | undefined; } /** * @public */ -export interface DescribeOptimizationJobResponse { - /** - *The Amazon Resource Name (ARN) of the optimization job.
- * @public - */ - OptimizationJobArn: string | undefined; - - /** - *The current status of the optimization job.
- * @public - */ - OptimizationJobStatus: OptimizationJobStatus | undefined; - +export interface DescribeModelBiasJobDefinitionResponse { /** - *The time when the optimization job started.
+ *The Amazon Resource Name (ARN) of the model bias job.
* @public */ - OptimizationStartTime?: Date | undefined; + JobDefinitionArn: string | undefined; /** - *The time when the optimization job finished processing.
+ *The name of the bias job definition. The name must be unique within an Amazon Web Services + * Region in the Amazon Web Services account.
* @public */ - OptimizationEndTime?: Date | undefined; + JobDefinitionName: string | undefined; /** - *The time when you created the optimization job.
+ *The time at which the model bias job was created.
* @public */ CreationTime: Date | undefined; /** - *The time when the optimization job was last updated.
- * @public - */ - LastModifiedTime: Date | undefined; - - /** - *If the optimization job status is FAILED, the reason for the
- * failure.
The name that you assigned to the optimization job.
- * @public - */ - OptimizationJobName: string | undefined; - - /** - *The location of the source model to optimize with an optimization job.
+ *The baseline configuration for a model bias job.
* @public */ - ModelSource: OptimizationJobModelSource | undefined; + ModelBiasBaselineConfig?: ModelBiasBaselineConfig | undefined; /** - *The environment variables to set in the model container.
+ *Configures the model bias job to run a specified Docker container image.
* @public */ - OptimizationEnvironment?: RecordThe type of instance that hosts the optimized model that you create with the optimization job.
+ *Inputs for the model bias job.
* @public */ - DeploymentInstanceType: OptimizationJobDeploymentInstanceType | undefined; + ModelBiasJobInput: ModelBiasJobInput | undefined; /** - *Settings for each of the optimization techniques that the job applies.
+ *The output configuration for monitoring jobs.
* @public */ - OptimizationConfigs: OptimizationConfig[] | undefined; + ModelBiasJobOutputConfig: MonitoringOutputConfig | undefined; /** - *Details for where to store the optimized model that you create with the optimization job.
+ *Identifies the resources to deploy for a monitoring job.
* @public */ - OutputConfig: OptimizationJobOutputConfig | undefined; + JobResources: MonitoringResources | undefined; /** - *Output values produced by an optimization job.
+ *Networking options for a model bias job.
* @public */ - OptimizationOutput?: OptimizationOutput | undefined; + NetworkConfig?: MonitoringNetworkConfig | undefined; /** - *The ARN of the IAM role that you assigned to the optimization job.
+ *The Amazon Resource Name (ARN) of the IAM role that has read permission to the + * input data location and write permission to the output data location in Amazon S3.
* @public */ RoleArn: string | undefined; /** - *Specifies a limit to how long a job can run. When the job reaches the time limit, SageMaker - * ends the job. Use this API to cap costs.
- *To stop a training job, SageMaker sends the algorithm the SIGTERM signal,
- * which delays job termination for 120 seconds. Algorithms can use this 120-second window
- * to save the model artifacts, so the results of training are not lost.
The training algorithms provided by SageMaker automatically save the intermediate results
- * of a model training job when possible. This attempt to save artifacts is only a best
- * effort case as model might not be in a state from which it can be saved. For example, if
- * training has just started, the model might not be ready to save. When saved, this
- * intermediate data is a valid model artifact. You can use it to create a model with
- * CreateModel.
The Neural Topic Model (NTM) currently does not support saving intermediate model - * artifacts. When training NTMs, make sure that the maximum runtime is sufficient for - * the training job to complete.
- *A VPC in Amazon VPC that your optimized model has access to.
+ *A time limit for how long the monitoring job is allowed to run before stopping.
* @public */ - VpcConfig?: OptimizationVpcConfig | undefined; + StoppingCondition?: MonitoringStoppingCondition | undefined; } /** * @public */ -export interface DescribePipelineRequest { +export interface DescribeModelCardRequest { /** - *The name or Amazon Resource Name (ARN) of the pipeline to describe.
+ *The name or Amazon Resource Name (ARN) of the model card to describe.
* @public */ - PipelineName: string | undefined; + ModelCardName: string | undefined; + + /** + *The version of the model card to describe. If a version is not provided, then the latest version of the model card is described.
+ * @public + */ + ModelCardVersion?: number | undefined; } /** * @public * @enum */ -export const PipelineStatus = { - ACTIVE: "Active", - DELETING: "Deleting", +export const ModelCardProcessingStatus = { + CONTENT_DELETED: "ContentDeleted", + DELETE_COMPLETED: "DeleteCompleted", + DELETE_FAILED: "DeleteFailed", + DELETE_INPROGRESS: "DeleteInProgress", + DELETE_PENDING: "DeletePending", + EXPORTJOBS_DELETED: "ExportJobsDeleted", } as const; /** * @public */ -export type PipelineStatus = (typeof PipelineStatus)[keyof typeof PipelineStatus]; +export type ModelCardProcessingStatus = (typeof ModelCardProcessingStatus)[keyof typeof ModelCardProcessingStatus]; /** * @public */ -export interface DescribePipelineResponse { +export interface DescribeModelCardResponse { /** - *The Amazon Resource Name (ARN) of the pipeline.
+ *The Amazon Resource Name (ARN) of the model card.
* @public */ - PipelineArn?: string | undefined; + ModelCardArn: string | undefined; /** - *The name of the pipeline.
+ *The name of the model card.
* @public */ - PipelineName?: string | undefined; + ModelCardName: string | undefined; /** - *The display name of the pipeline.
+ *The version of the model card.
* @public */ - PipelineDisplayName?: string | undefined; + ModelCardVersion: number | undefined; /** - *The JSON pipeline definition.
+ *The content of the model card.
* @public */ - PipelineDefinition?: string | undefined; + Content: string | undefined; /** - *The description of the pipeline.
+ *The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.
+ *
+ * Draft: The model card is a work in progress.
+ * PendingReview: The model card is pending review.
+ * Approved: The model card is approved.
+ * Archived: The model card is archived. No more updates should be made to the model
+ * card, but it can still be exported.
The Amazon Resource Name (ARN) that the pipeline uses to execute.
+ *The security configuration used to protect model card content.
* @public */ - RoleArn?: string | undefined; + SecurityConfig?: ModelCardSecurityConfig | undefined; /** - *The status of the pipeline execution.
+ *The date and time the model card was created.
* @public */ - PipelineStatus?: PipelineStatus | undefined; + CreationTime: Date | undefined; /** - *The time when the pipeline was created.
+ *Information about the user who created or modified an experiment, trial, trial + * component, lineage group, project, or model card.
* @public */ - CreationTime?: Date | undefined; + CreatedBy: UserContext | undefined; /** - *The time when the pipeline was last modified.
+ *The date and time the model card was last modified.
* @public */ LastModifiedTime?: Date | undefined; - /** - *The time when the pipeline was last run.
- * @public - */ - LastRunTime?: Date | undefined; - - /** - *Information about the user who created or modified an experiment, trial, trial - * component, lineage group, project, or model card.
- * @public - */ - CreatedBy?: UserContext | undefined; - /** *Information about the user who created or modified an experiment, trial, trial * component, lineage group, project, or model card.
@@ -2464,6036 +2565,5812 @@ export interface DescribePipelineResponse { LastModifiedBy?: UserContext | undefined; /** - *Lists the parallelism configuration applied to the pipeline.
+ *The processing status of model card deletion. The ModelCardProcessingStatus updates throughout the different deletion steps.
+ * DeletePending: Model card deletion request received.
+ * DeleteInProgress: Model card deletion is in progress.
+ * ContentDeleted: Deleted model card content.
+ * ExportJobsDeleted: Deleted all export jobs associated with the model card.
+ * DeleteCompleted: Successfully deleted the model card.
+ * DeleteFailed: The model card failed to delete.
The Amazon Resource Name (ARN) of the pipeline execution.
+ *The Amazon Resource Name (ARN) of the model card export job to describe.
* @public */ - PipelineExecutionArn: string | undefined; + ModelCardExportJobArn: string | undefined; } /** + *The artifacts of the model card export job.
* @public */ -export interface DescribePipelineDefinitionForExecutionResponse { +export interface ModelCardExportArtifacts { /** - *The JSON pipeline definition.
+ *The Amazon S3 URI of the exported model artifacts.
* @public */ - PipelineDefinition?: string | undefined; - - /** - *The time when the pipeline was created.
- * @public - */ - CreationTime?: Date | undefined; -} - -/** - * @public - */ -export interface DescribePipelineExecutionRequest { - /** - *The Amazon Resource Name (ARN) of the pipeline execution.
- * @public - */ - PipelineExecutionArn: string | undefined; + S3ExportArtifacts: string | undefined; } /** * @public * @enum */ -export const PipelineExecutionStatus = { - EXECUTING: "Executing", +export const ModelCardExportJobStatus = { + COMPLETED: "Completed", FAILED: "Failed", - STOPPED: "Stopped", - STOPPING: "Stopping", - SUCCEEDED: "Succeeded", + IN_PROGRESS: "InProgress", } as const; /** * @public */ -export type PipelineExecutionStatus = (typeof PipelineExecutionStatus)[keyof typeof PipelineExecutionStatus]; +export type ModelCardExportJobStatus = (typeof ModelCardExportJobStatus)[keyof typeof ModelCardExportJobStatus]; /** - *Specifies the names of the experiment and trial created by a pipeline.
* @public */ -export interface PipelineExperimentConfig { +export interface DescribeModelCardExportJobResponse { /** - *The name of the experiment.
+ *The name of the model card export job to describe.
* @public */ - ExperimentName?: string | undefined; + ModelCardExportJobName: string | undefined; /** - *The name of the trial.
+ *The Amazon Resource Name (ARN) of the model card export job.
* @public */ - TrialName?: string | undefined; -} + ModelCardExportJobArn: string | undefined; -/** - *A step selected to run in selective execution mode.
- * @public - */ -export interface SelectedStep { /** - *The name of the pipeline step.
+ *The completion status of the model card export job.
+ *
+ * InProgress: The model card export job is in progress.
+ * Completed: The model card export job is complete.
+ * Failed: The model card export job failed. To see the reason for the failure, see
+ * the FailureReason field in the response to a
+ * DescribeModelCardExportJob call.
The selective execution configuration applied to the pipeline run.
- * @public - */ -export interface SelectiveExecutionConfig { /** - *The ARN from a reference execution of the current pipeline.
- * Used to copy input collaterals needed for the selected steps to run.
- * The execution status of the pipeline can be either Failed
- * or Success.
This field is required if the steps you specify for
- * SelectedSteps depend on output collaterals from any non-specified pipeline
- * steps. For more information, see Selective
- * Execution for Pipeline Steps.
The name or Amazon Resource Name (ARN) of the model card that the model export job exports.
* @public */ - SourcePipelineExecutionArn?: string | undefined; + ModelCardName: string | undefined; /** - *A list of pipeline steps to run. All step(s) in all path(s) between - * two selected steps should be included.
+ *The version of the model card that the model export job exports.
* @public */ - SelectedSteps: SelectedStep[] | undefined; -} + ModelCardVersion: number | undefined; -/** - * @public - */ -export interface DescribePipelineExecutionResponse { /** - *The Amazon Resource Name (ARN) of the pipeline.
+ *The export output details for the model card.
* @public */ - PipelineArn?: string | undefined; + OutputConfig: ModelCardExportOutputConfig | undefined; /** - *The Amazon Resource Name (ARN) of the pipeline execution.
+ *The date and time that the model export job was created.
* @public */ - PipelineExecutionArn?: string | undefined; + CreatedAt: Date | undefined; /** - *The display name of the pipeline execution.
+ *The date and time that the model export job was last modified.
* @public */ - PipelineExecutionDisplayName?: string | undefined; + LastModifiedAt: Date | undefined; /** - *The status of the pipeline execution.
+ *The failure reason if the model export job fails.
* @public */ - PipelineExecutionStatus?: PipelineExecutionStatus | undefined; + FailureReason?: string | undefined; /** - *The description of the pipeline execution.
+ *The exported model card artifacts.
* @public */ - PipelineExecutionDescription?: string | undefined; + ExportArtifacts?: ModelCardExportArtifacts | undefined; +} +/** + * @public + */ +export interface DescribeModelExplainabilityJobDefinitionRequest { /** - *Specifies the names of the experiment and trial created by a pipeline.
+ *The name of the model explainability job definition. The name must be unique within an + * Amazon Web Services Region in the Amazon Web Services account.
* @public */ - PipelineExperimentConfig?: PipelineExperimentConfig | undefined; + JobDefinitionName: string | undefined; +} + +/** + * @public + */ +export interface DescribeModelExplainabilityJobDefinitionResponse { + /** + *The Amazon Resource Name (ARN) of the model explainability job.
+ * @public + */ + JobDefinitionArn: string | undefined; /** - *If the execution failed, a message describing why.
+ *The name of the explainability job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.
* @public */ - FailureReason?: string | undefined; + JobDefinitionName: string | undefined; /** - *The time when the pipeline execution was created.
+ *The time at which the model explainability job was created.
* @public */ - CreationTime?: Date | undefined; + CreationTime: Date | undefined; /** - *The time when the pipeline execution was modified last.
+ *The baseline configuration for a model explainability job.
* @public */ - LastModifiedTime?: Date | undefined; + ModelExplainabilityBaselineConfig?: ModelExplainabilityBaselineConfig | undefined; /** - *Information about the user who created or modified an experiment, trial, trial - * component, lineage group, project, or model card.
+ *Configures the model explainability job to run a specified Docker container image.
* @public */ - CreatedBy?: UserContext | undefined; + ModelExplainabilityAppSpecification: ModelExplainabilityAppSpecification | undefined; /** - *Information about the user who created or modified an experiment, trial, trial - * component, lineage group, project, or model card.
+ *Inputs for the model explainability job.
* @public */ - LastModifiedBy?: UserContext | undefined; + ModelExplainabilityJobInput: ModelExplainabilityJobInput | undefined; /** - *The parallelism configuration applied to the pipeline.
+ *The output configuration for monitoring jobs.
* @public */ - ParallelismConfiguration?: ParallelismConfiguration | undefined; + ModelExplainabilityJobOutputConfig: MonitoringOutputConfig | undefined; /** - *The selective execution configuration applied to the pipeline run.
+ *Identifies the resources to deploy for a monitoring job.
* @public */ - SelectiveExecutionConfig?: SelectiveExecutionConfig | undefined; + JobResources: MonitoringResources | undefined; + + /** + *Networking options for a model explainability job.
+ * @public + */ + NetworkConfig?: MonitoringNetworkConfig | undefined; + + /** + *The Amazon Resource Name (ARN) of the IAM role that has read permission to the + * input data location and write permission to the output data location in Amazon S3.
+ * @public + */ + RoleArn: string | undefined; + + /** + *A time limit for how long the monitoring job is allowed to run before stopping.
+ * @public + */ + StoppingCondition?: MonitoringStoppingCondition | undefined; } /** * @public */ -export interface DescribeProcessingJobRequest { +export interface DescribeModelPackageInput { /** - *The name of the processing job. The name must be unique within an Amazon Web Services Region in the - * Amazon Web Services account.
+ *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).
* @public */ - ProcessingJobName: string | undefined; + ModelPackageName: string | undefined; } /** * @public * @enum */ -export const ProcessingJobStatus = { +export const DetailedModelPackageStatus = { COMPLETED: "Completed", FAILED: "Failed", IN_PROGRESS: "InProgress", - STOPPED: "Stopped", - STOPPING: "Stopping", + NOT_STARTED: "NotStarted", } as const; /** * @public */ -export type ProcessingJobStatus = (typeof ProcessingJobStatus)[keyof typeof ProcessingJobStatus]; +export type DetailedModelPackageStatus = (typeof DetailedModelPackageStatus)[keyof typeof DetailedModelPackageStatus]; /** + *Represents the overall status of a model package.
* @public */ -export interface DescribeProcessingJobResponse { +export interface ModelPackageStatusItem { /** - *The inputs for a processing job.
+ *The name of the model package for which the overall status is being reported.
* @public */ - ProcessingInputs?: ProcessingInput[] | undefined; + Name: string | undefined; /** - *Output configuration for the processing job.
+ *The current status.
* @public */ - ProcessingOutputConfig?: ProcessingOutputConfig | undefined; + Status: DetailedModelPackageStatus | undefined; /** - *The name of the processing job. The name must be unique within an Amazon Web Services Region in the - * Amazon Web Services account.
+ *if the overall status is Failed, the reason for the failure.
Specifies the validation and image scan statuses of the model package.
+ * @public + */ +export interface ModelPackageStatusDetails { /** - *Identifies the resources, ML compute instances, and ML storage volumes to deploy for a - * processing job. In distributed training, you specify more than one instance.
+ *The validation status of the model package.
* @public */ - ProcessingResources: ProcessingResources | undefined; + ValidationStatuses: ModelPackageStatusItem[] | undefined; /** - *The time limit for how long the processing job is allowed to run.
+ *The status of the scan of the Docker image container for the model package.
* @public */ - StoppingCondition?: ProcessingStoppingCondition | undefined; + ImageScanStatuses?: ModelPackageStatusItem[] | undefined; +} +/** + * @public + */ +export interface DescribeModelPackageOutput { /** - *Configures the processing job to run a specified container image.
+ *The name of the model package being described.
* @public */ - AppSpecification: AppSpecification | undefined; + ModelPackageName: string | undefined; /** - *The environment variables set in the Docker container.
+ *If the model is a versioned model, the name of the model group that the versioned + * model belongs to.
* @public */ - Environment?: RecordNetworking options for a processing job.
+ *The version of the model package.
* @public */ - NetworkConfig?: NetworkConfig | undefined; + ModelPackageVersion?: number | undefined; /** - *The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on - * your behalf.
+ *The Amazon Resource Name (ARN) of the model package.
* @public */ - RoleArn?: string | undefined; + ModelPackageArn: string | undefined; /** - *The configuration information used to create an experiment.
+ *A brief summary of the model package.
* @public */ - ExperimentConfig?: ExperimentConfig | undefined; + ModelPackageDescription?: string | undefined; /** - *The Amazon Resource Name (ARN) of the processing job.
+ *A timestamp specifying when the model package was created.
* @public */ - ProcessingJobArn: string | undefined; + CreationTime: Date | undefined; /** - *Provides the status of a processing job.
+ *Details about inference jobs that you can run with models based on this model + * package.
* @public */ - ProcessingJobStatus: ProcessingJobStatus | undefined; + InferenceSpecification?: InferenceSpecification | undefined; /** - *An optional string, up to one KB in size, that contains metadata from the processing - * container when the processing job exits.
+ *Details about the algorithm that was used to create the model package.
* @public */ - ExitMessage?: string | undefined; + SourceAlgorithmSpecification?: SourceAlgorithmSpecification | undefined; /** - *A string, up to one KB in size, that contains the reason a processing job failed, if - * it failed.
+ *Configurations for one or more transform jobs that SageMaker runs to test the model + * package.
* @public */ - FailureReason?: string | undefined; + ValidationSpecification?: ModelPackageValidationSpecification | undefined; /** - *The time at which the processing job completed.
+ *The current status of the model package.
* @public */ - ProcessingEndTime?: Date | undefined; + ModelPackageStatus: ModelPackageStatus | undefined; /** - *The time at which the processing job started.
+ *Details about the current status of the model package.
* @public */ - ProcessingStartTime?: Date | undefined; + ModelPackageStatusDetails: ModelPackageStatusDetails | undefined; /** - *The time at which the processing job was last modified.
+ *Whether the model package is certified for listing on Amazon Web Services Marketplace.
* @public */ - LastModifiedTime?: Date | undefined; + CertifyForMarketplace?: boolean | undefined; /** - *The time at which the processing job was created.
+ *The approval status of the model package.
* @public */ - CreationTime: Date | undefined; + ModelApprovalStatus?: ModelApprovalStatus | undefined; /** - *The ARN of a monitoring schedule for an endpoint associated with this processing - * job.
+ *Information about the user who created or modified an experiment, trial, trial + * component, lineage group, project, or model card.
* @public */ - MonitoringScheduleArn?: string | undefined; + CreatedBy?: UserContext | undefined; /** - *The ARN of an AutoML job associated with this processing job.
+ *Metadata properties of the tracking entity, trial, or trial component.
* @public */ - AutoMLJobArn?: string | undefined; + MetadataProperties?: MetadataProperties | undefined; /** - *The ARN of a training job associated with this processing job.
+ *Metrics for the model.
* @public */ - TrainingJobArn?: string | undefined; -} + ModelMetrics?: ModelMetrics | undefined; -/** - * @public - */ -export interface DescribeProjectInput { /** - *The name of the project to describe.
+ *The last time that the model package was modified.
* @public */ - ProjectName: string | undefined; -} - -/** - * @public - * @enum - */ -export const ProjectStatus = { - CREATE_COMPLETED: "CreateCompleted", - CREATE_FAILED: "CreateFailed", - CREATE_IN_PROGRESS: "CreateInProgress", - DELETE_COMPLETED: "DeleteCompleted", - DELETE_FAILED: "DeleteFailed", - DELETE_IN_PROGRESS: "DeleteInProgress", - PENDING: "Pending", - UPDATE_COMPLETED: "UpdateCompleted", - UPDATE_FAILED: "UpdateFailed", - UPDATE_IN_PROGRESS: "UpdateInProgress", -} as const; - -/** - * @public - */ -export type ProjectStatus = (typeof ProjectStatus)[keyof typeof ProjectStatus]; + LastModifiedTime?: Date | undefined; -/** - *Details of a provisioned service catalog product. For information about service catalog, - * see What is Amazon Web Services Service - * Catalog.
- * @public - */ -export interface ServiceCatalogProvisionedProductDetails { /** - *The ID of the provisioned product.
+ *Information about the user who created or modified an experiment, trial, trial + * component, lineage group, project, or model card.
* @public */ - ProvisionedProductId?: string | undefined; + LastModifiedBy?: UserContext | undefined; /** - *The current status of the product.
- *
- * AVAILABLE - Stable state, ready to perform any operation. The most recent operation succeeded and completed.
- * UNDER_CHANGE - Transitive state. Operations performed might not have valid results. Wait for an AVAILABLE status before performing operations.
- * TAINTED - Stable state, ready to perform any operation. The stack has completed the requested operation but is not exactly what was requested. For example, a request to update to a new version failed and the stack rolled back to the current version.
- * ERROR - An unexpected error occurred. The provisioned product exists but the stack is not running. For example, CloudFormation received a parameter value that was not valid and could not launch the stack.
- * PLAN_IN_PROGRESS - Transitive state. The plan operations were performed to provision a new product, but resources have not yet been created. After reviewing the list of resources to be created, execute the plan. Wait for an AVAILABLE status before performing operations.
A description provided for the model approval.
* @public */ - ProvisionedProductStatusMessage?: string | undefined; -} + ApprovalDescription?: string | undefined; -/** - * @public - */ -export interface DescribeProjectOutput { /** - *The Amazon Resource Name (ARN) of the project.
+ *The machine learning domain of the model package you specified. Common machine + * learning domains include computer vision and natural language processing.
* @public */ - ProjectArn: string | undefined; + Domain?: string | undefined; /** - *The name of the project.
+ *The machine learning task you specified that your model package accomplishes. + * Common machine learning tasks include object detection and image classification.
* @public */ - ProjectName: string | undefined; + Task?: string | undefined; /** - *The ID of the project.
+ *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 */ - ProjectId: string | undefined; + SamplePayloadUrl?: string | undefined; /** - *The description of the project.
+ *The metadata properties associated with the model package versions.
* @public */ - ProjectDescription?: string | undefined; + CustomerMetadataProperties?: RecordInformation used to provision a service catalog product. For information, see What is Amazon Web Services Service - * Catalog.
+ *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 */ - ServiceCatalogProvisioningDetails: ServiceCatalogProvisioningDetails | undefined; + DriftCheckBaselines?: DriftCheckBaselines | undefined; /** - *Information about a provisioned service catalog product.
+ *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 */ - ServiceCatalogProvisionedProductDetails?: ServiceCatalogProvisionedProductDetails | undefined; + AdditionalInferenceSpecifications?: AdditionalInferenceSpecificationDefinition[] | undefined; /** - *The status of the project.
+ *Indicates if you want to skip model validation.
* @public */ - ProjectStatus: ProjectStatus | undefined; + SkipModelValidation?: SkipModelValidation | undefined; /** - *Information about the user who created or modified an experiment, trial, trial - * component, lineage group, project, or model card.
+ *The URI of the source for the model package.
* @public */ - CreatedBy?: UserContext | undefined; + SourceUri?: string | undefined; /** - *The time when the project was created.
+ *The KMS Key ID (KMSKeyId) used for encryption of model package information.
The timestamp when project was last modified.
+ *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.
Information about the user who created or modified an experiment, trial, trial - * component, lineage group, project, or model card.
+ *+ * A structure describing the current state of the model in its life cycle. + *
* @public */ - LastModifiedBy?: UserContext | undefined; + ModelLifeCycle?: ModelLifeCycle | undefined; } /** * @public */ -export interface DescribeSpaceRequest { - /** - *The ID of the associated domain.
- * @public - */ - DomainId: string | undefined; - +export interface DescribeModelPackageGroupInput { /** - *The name of the space.
+ *The name of the model group to describe.
* @public */ - SpaceName: string | undefined; + ModelPackageGroupName: string | undefined; } /** * @public * @enum */ -export const SpaceStatus = { - Delete_Failed: "Delete_Failed", - Deleting: "Deleting", - Failed: "Failed", - InService: "InService", - Pending: "Pending", - Update_Failed: "Update_Failed", - Updating: "Updating", +export const ModelPackageGroupStatus = { + COMPLETED: "Completed", + DELETE_FAILED: "DeleteFailed", + DELETING: "Deleting", + FAILED: "Failed", + IN_PROGRESS: "InProgress", + PENDING: "Pending", } as const; /** * @public */ -export type SpaceStatus = (typeof SpaceStatus)[keyof typeof SpaceStatus]; +export type ModelPackageGroupStatus = (typeof ModelPackageGroupStatus)[keyof typeof ModelPackageGroupStatus]; /** * @public */ -export interface DescribeSpaceResponse { +export interface DescribeModelPackageGroupOutput { /** - *The ID of the associated domain.
+ *The name of the model group.
* @public */ - DomainId?: string | undefined; + ModelPackageGroupName: string | undefined; /** - *The space's Amazon Resource Name (ARN).
+ *The Amazon Resource Name (ARN) of the model group.
* @public */ - SpaceArn?: string | undefined; + ModelPackageGroupArn: string | undefined; /** - *The name of the space.
+ *A description of the model group.
* @public */ - SpaceName?: string | undefined; + ModelPackageGroupDescription?: string | undefined; /** - *The ID of the space's profile in the Amazon EFS volume.
+ *The time that the model group was created.
* @public */ - HomeEfsFileSystemUid?: string | undefined; + CreationTime: Date | undefined; /** - *The status.
+ *Information about the user who created or modified an experiment, trial, trial + * component, lineage group, project, or model card.
* @public */ - Status?: SpaceStatus | undefined; + CreatedBy: UserContext | undefined; /** - *The last modified time.
+ *The status of the model group.
* @public */ - LastModifiedTime?: Date | undefined; + ModelPackageGroupStatus: ModelPackageGroupStatus | undefined; +} +/** + * @public + */ +export interface DescribeModelQualityJobDefinitionRequest { /** - *The creation time.
+ *The name of the model quality job. The name must be unique within an Amazon Web Services + * Region in the Amazon Web Services account.
* @public */ - CreationTime?: Date | undefined; - - /** - *The failure reason.
- * @public - */ - FailureReason?: string | undefined; - - /** - *A collection of space settings.
- * @public - */ - SpaceSettings?: SpaceSettings | undefined; + JobDefinitionName: string | undefined; +} +/** + * @public + */ +export interface DescribeModelQualityJobDefinitionResponse { /** - *The collection of ownership settings for a space.
+ *The Amazon Resource Name (ARN) of the model quality job.
* @public */ - OwnershipSettings?: OwnershipSettings | undefined; + JobDefinitionArn: string | undefined; /** - *The collection of space sharing settings for a space.
+ *The name of the quality job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.
* @public */ - SpaceSharingSettings?: SpaceSharingSettings | undefined; + JobDefinitionName: string | undefined; /** - *The name of the space that appears in the Amazon SageMaker Studio UI.
+ *The time at which the model quality job was created.
* @public */ - SpaceDisplayName?: string | undefined; + CreationTime: Date | undefined; /** - *Returns the URL of the space. If the space is created with Amazon Web Services IAM Identity - * Center (Successor to Amazon Web Services Single Sign-On) authentication, users can navigate to - * the URL after appending the respective redirect parameter for the application type to be - * federated through Amazon Web Services IAM Identity Center.
- *The following application types are supported:
- *Studio Classic: &redirect=JupyterServer
- *
JupyterLab: &redirect=JupyterLab
- *
Code Editor, based on Code-OSS, Visual Studio Code - Open Source:
- * &redirect=CodeEditor
- *
The baseline configuration for a model quality job.
* @public */ - Url?: string | undefined; -} + ModelQualityBaselineConfig?: ModelQualityBaselineConfig | undefined; -/** - * @public - */ -export interface DescribeStudioLifecycleConfigRequest { /** - *The name of the Amazon SageMaker Studio Lifecycle Configuration to describe.
+ *Configures the model quality job to run a specified Docker container image.
* @public */ - StudioLifecycleConfigName: string | undefined; -} + ModelQualityAppSpecification: ModelQualityAppSpecification | undefined; -/** - * @public - */ -export interface DescribeStudioLifecycleConfigResponse { /** - *The ARN of the Lifecycle Configuration to describe.
+ *Inputs for the model quality job.
* @public */ - StudioLifecycleConfigArn?: string | undefined; + ModelQualityJobInput: ModelQualityJobInput | undefined; /** - *The name of the Amazon SageMaker Studio Lifecycle Configuration that is - * described.
+ *The output configuration for monitoring jobs.
* @public */ - StudioLifecycleConfigName?: string | undefined; + ModelQualityJobOutputConfig: MonitoringOutputConfig | undefined; /** - *The creation time of the Amazon SageMaker Studio Lifecycle Configuration.
+ *Identifies the resources to deploy for a monitoring job.
* @public */ - CreationTime?: Date | undefined; + JobResources: MonitoringResources | undefined; /** - *This value is equivalent to CreationTime because Amazon SageMaker Studio Lifecycle - * Configurations are immutable.
+ *Networking options for a model quality job.
* @public */ - LastModifiedTime?: Date | undefined; + NetworkConfig?: MonitoringNetworkConfig | undefined; /** - *The content of your Amazon SageMaker Studio Lifecycle Configuration script.
+ *The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can + * assume to perform tasks on your behalf.
* @public */ - StudioLifecycleConfigContent?: string | undefined; + RoleArn: string | undefined; /** - *The App type that the Lifecycle Configuration is attached to.
+ *A time limit for how long the monitoring job is allowed to run before stopping.
* @public */ - StudioLifecycleConfigAppType?: StudioLifecycleConfigAppType | undefined; + StoppingCondition?: MonitoringStoppingCondition | undefined; } /** * @public */ -export interface DescribeSubscribedWorkteamRequest { +export interface DescribeMonitoringScheduleRequest { /** - *The Amazon Resource Name (ARN) of the subscribed work team to describe.
+ *Name of a previously created monitoring schedule.
* @public */ - WorkteamArn: string | undefined; + MonitoringScheduleName: string | undefined; } /** - *Describes a work team of a vendor that does the labelling job.
* @public + * @enum */ -export interface SubscribedWorkteam { +export const ExecutionStatus = { + COMPLETED: "Completed", + COMPLETED_WITH_VIOLATIONS: "CompletedWithViolations", + FAILED: "Failed", + IN_PROGRESS: "InProgress", + PENDING: "Pending", + STOPPED: "Stopped", + STOPPING: "Stopping", +} as const; + +/** + * @public + */ +export type ExecutionStatus = (typeof ExecutionStatus)[keyof typeof ExecutionStatus]; + +/** + *Summary of information about the last monitoring job to run.
+ * @public + */ +export interface MonitoringExecutionSummary { /** - *The Amazon Resource Name (ARN) of the vendor that you have subscribed.
+ *The name of the monitoring schedule.
* @public */ - WorkteamArn: string | undefined; + MonitoringScheduleName: string | undefined; /** - *The title of the service provided by the vendor in the Amazon Marketplace.
+ *The time the monitoring job was scheduled.
* @public */ - MarketplaceTitle?: string | undefined; + ScheduledTime: Date | undefined; /** - *The name of the vendor in the Amazon Marketplace.
+ *The time at which the monitoring job was created.
* @public */ - SellerName?: string | undefined; + CreationTime: Date | undefined; /** - *The description of the vendor from the Amazon Marketplace.
+ *A timestamp that indicates the last time the monitoring job was modified.
* @public */ - MarketplaceDescription?: string | undefined; + LastModifiedTime: Date | undefined; /** - *Marketplace product listing ID.
+ *The status of the monitoring job.
* @public */ - ListingId?: string | undefined; -} + MonitoringExecutionStatus: ExecutionStatus | undefined; -/** - * @public - */ -export interface DescribeSubscribedWorkteamResponse { /** - *A Workteam instance that contains information about the work team.
The Amazon Resource Name (ARN) of the monitoring job.
* @public */ - SubscribedWorkteam: SubscribedWorkteam | undefined; -} + ProcessingJobArn?: string | undefined; -/** - * @public - */ -export interface DescribeTrainingJobRequest { /** - *The name of the training job.
+ *The name of the endpoint used to run the monitoring job.
* @public */ - TrainingJobName: string | undefined; -} + EndpointName?: string | undefined; -/** - *The name, value, and date and time of a metric that was emitted to Amazon CloudWatch.
- * @public - */ -export interface MetricData { /** - *The name of the metric.
+ *Contains the reason a monitoring job failed, if it failed.
* @public */ - MetricName?: string | undefined; + FailureReason?: string | undefined; /** - *The value of the metric.
+ *The name of the monitoring job.
* @public */ - Value?: number | undefined; + MonitoringJobDefinitionName?: string | undefined; /** - *The date and time that the algorithm emitted the metric.
+ *The type of the monitoring job.
* @public */ - Timestamp?: Date | undefined; + MonitoringType?: MonitoringType | undefined; } /** - *Information about the status of the rule evaluation.
* @public + * @enum */ -export interface ProfilerRuleEvaluationStatus { +export const ScheduleStatus = { + FAILED: "Failed", + PENDING: "Pending", + SCHEDULED: "Scheduled", + STOPPED: "Stopped", +} as const; + +/** + * @public + */ +export type ScheduleStatus = (typeof ScheduleStatus)[keyof typeof ScheduleStatus]; + +/** + * @public + */ +export interface DescribeMonitoringScheduleResponse { /** - *The name of the rule configuration.
+ *The Amazon Resource Name (ARN) of the monitoring schedule.
* @public */ - RuleConfigurationName?: string | undefined; + MonitoringScheduleArn: string | undefined; /** - *The Amazon Resource Name (ARN) of the rule evaluation job.
+ *Name of the monitoring schedule.
* @public */ - RuleEvaluationJobArn?: string | undefined; + MonitoringScheduleName: string | undefined; /** - *Status of the rule evaluation.
+ *The status of an monitoring job.
* @public */ - RuleEvaluationStatus?: RuleEvaluationStatus | undefined; + MonitoringScheduleStatus: ScheduleStatus | undefined; /** - *Details from the rule evaluation.
+ *The type of the monitoring job that this schedule runs. This is one of the following + * values.
+ *
+ * DATA_QUALITY - The schedule is for a data quality monitoring
+ * job.
+ * MODEL_QUALITY - The schedule is for a model quality monitoring
+ * job.
+ * MODEL_BIAS - The schedule is for a bias monitoring job.
+ * MODEL_EXPLAINABILITY - The schedule is for an explainability
+ * monitoring job.
Timestamp when the rule evaluation status was last modified.
+ *A string, up to one KB in size, that contains the reason a monitoring job failed, if it + * failed.
* @public */ - LastModifiedTime?: Date | undefined; -} + FailureReason?: string | undefined; -/** - * @public - * @enum - */ -export const ProfilingStatus = { - DISABLED: "Disabled", - ENABLED: "Enabled", -} as const; - -/** - * @public - */ -export type ProfilingStatus = (typeof ProfilingStatus)[keyof typeof ProfilingStatus]; - -/** - * @public - * @enum - */ -export const SecondaryStatus = { - COMPLETED: "Completed", - DOWNLOADING: "Downloading", - DOWNLOADING_TRAINING_IMAGE: "DownloadingTrainingImage", - FAILED: "Failed", - INTERRUPTED: "Interrupted", - LAUNCHING_ML_INSTANCES: "LaunchingMLInstances", - MAX_RUNTIME_EXCEEDED: "MaxRuntimeExceeded", - MAX_WAIT_TIME_EXCEEDED: "MaxWaitTimeExceeded", - PENDING: "Pending", - PREPARING_TRAINING_STACK: "PreparingTrainingStack", - RESTARTING: "Restarting", - STARTING: "Starting", - STOPPED: "Stopped", - STOPPING: "Stopping", - TRAINING: "Training", - UPDATING: "Updating", - UPLOADING: "Uploading", -} as const; - -/** - * @public - */ -export type SecondaryStatus = (typeof SecondaryStatus)[keyof typeof SecondaryStatus]; - -/** - *An array element of SecondaryStatusTransitions for DescribeTrainingJob. It provides additional details about a status that the
- * training job has transitioned through. A training job can be in one of several states,
- * for example, starting, downloading, training, or uploading. Within each state, there are
- * a number of intermediate states. For example, within the starting state, SageMaker could be
- * starting the training job or launching the ML instances. These transitional states are
- * referred to as the job's secondary
- * status.
- *
Contains a secondary status information from a training - * job.
- *Status might be one of the following secondary statuses:
- *
- * Starting
- * - Starting the training job.
- * Downloading - An optional stage for algorithms that
- * support File training input mode. It indicates that
- * data is being downloaded to the ML storage volumes.
- * Training - Training is in progress.
- * Uploading - Training is complete and the model
- * artifacts are being uploaded to the S3 location.
- * Completed - The training job has completed.
- * Failed - The training job has failed. The reason for
- * the failure is returned in the FailureReason field of
- * DescribeTrainingJobResponse.
- * MaxRuntimeExceeded - The job stopped because it
- * exceeded the maximum allowed runtime.
- * Stopped - The training job has stopped.
- * Stopping - Stopping the training job.
We no longer support the following secondary statuses:
- *
- * LaunchingMLInstances
- *
- * PreparingTrainingStack
- *
- * DownloadingTrainingImage
- *
A timestamp that shows when the training job transitioned to the current secondary - * status state.
- * @public - */ - StartTime: Date | undefined; - - /** - *A timestamp that shows when the training job transitioned out of this secondary status - * state into another secondary status state or when the training job has ended.
- * @public - */ - EndTime?: Date | undefined; - - /** - *A detailed description of the progress within a secondary status. - *
- *SageMaker provides secondary statuses and status messages that apply to each of - * them:
- *Starting the training job.
- *Launching requested ML - * instances.
- *Insufficient - * capacity error from EC2 while launching instances, - * retrying!
- *Launched - * instance was unhealthy, replacing it!
- *Preparing the instances for training.
- *Training - * image download completed. Training in - * progress.
- *Status messages are subject to change. Therefore, we recommend not including them - * in code that programmatically initiates actions. For examples, don't use status - * messages in if statements.
- *To have an overview of your training job's progress, view
- * TrainingJobStatus and SecondaryStatus in DescribeTrainingJob, and StatusMessage together. For example,
- * at the start of a training job, you might see the following:
- * TrainingJobStatus - InProgress
- * SecondaryStatus - Training
- * StatusMessage - Downloading the training image
Status and billing information about the warm pool.
- * @public - */ -export interface WarmPoolStatus { - /** - *The status of the warm pool.
- *
- * InUse: The warm pool is in use for the training job.
- * Available: The warm pool is available to reuse for a matching
- * training job.
- * Reused: The warm pool moved to a matching training job for
- * reuse.
- * Terminated: The warm pool is no longer available. Warm pools are
- * unavailable if they are terminated by a user, terminated for a patch update, or
- * terminated for exceeding the specified
- * KeepAlivePeriodInSeconds.
The billable time in seconds used by the warm pool. Billable time refers to the - * absolute wall-clock time.
- *Multiply ResourceRetainedBillableTimeInSeconds by the number of instances
- * (InstanceCount) in your training cluster to get the total compute time
- * SageMaker bills you if you run warm pool training. The formula is as follows:
- * ResourceRetainedBillableTimeInSeconds * InstanceCount.
The name of the matching training job that reused the warm pool.
- * @public - */ - ReusedByJob?: string | undefined; -} - -/** - * @public - */ -export interface DescribeTrainingJobResponse { - /** - *Name of the model training job.
- * @public - */ - TrainingJobName: string | undefined; - - /** - *The Amazon Resource Name (ARN) of the training job.
- * @public - */ - TrainingJobArn: string | undefined; - - /** - *The Amazon Resource Name (ARN) of the associated hyperparameter tuning job if the - * training job was launched by a hyperparameter tuning job.
- * @public - */ - TuningJobArn?: string | undefined; - - /** - *The Amazon Resource Name (ARN) of the SageMaker Ground Truth labeling job that created the - * transform or training job.
- * @public - */ - LabelingJobArn?: string | undefined; - - /** - *The Amazon Resource Name (ARN) of an AutoML job.
- * @public - */ - AutoMLJobArn?: string | undefined; - - /** - *Information about the Amazon S3 location that is configured for storing model artifacts. - *
- * @public - */ - ModelArtifacts: ModelArtifacts | undefined; - - /** - *The status of the training job.
- *SageMaker provides the following training job statuses:
- *
- * InProgress - The training is in progress.
- * Completed - The training job has completed.
- * Failed - The training job has failed. To see the reason for the
- * failure, see the FailureReason field in the response to a
- * DescribeTrainingJobResponse call.
- * Stopping - The training job is stopping.
- * Stopped - The training job has stopped.
For more detailed information, see SecondaryStatus.
Provides detailed information about the state of the training job. For detailed
- * information on the secondary status of the training job, see StatusMessage
- * under SecondaryStatusTransition.
SageMaker provides primary statuses and secondary statuses that apply to each of - * them:
- *
- * Starting
- * - Starting the training job.
- * Downloading - An optional stage for algorithms that
- * support File training input mode. It indicates that
- * data is being downloaded to the ML storage volumes.
- * Training - Training is in progress.
- * Interrupted - The job stopped because the managed
- * spot training instances were interrupted.
- * Uploading - Training is complete and the model
- * artifacts are being uploaded to the S3 location.
- * Completed - The training job has completed.
- * Failed - The training job has failed. The reason for
- * the failure is returned in the FailureReason field of
- * DescribeTrainingJobResponse.
- * MaxRuntimeExceeded - The job stopped because it
- * exceeded the maximum allowed runtime.
- * MaxWaitTimeExceeded - The job stopped because it
- * exceeded the maximum allowed wait time.
- * Stopped - The training job has stopped.
- * Stopping - Stopping the training job.
Valid values for SecondaryStatus are subject to change.
We no longer support the following secondary statuses:
- *
- * LaunchingMLInstances
- *
- * PreparingTraining
- *
- * DownloadingTrainingImage
- *
The time at which the monitoring job was created.
+ * @public + */ + CreationTime: Date | undefined; /** - *If the training job failed, the reason it failed.
+ *The time at which the monitoring job was last modified.
* @public */ - FailureReason?: string | undefined; + LastModifiedTime: Date | undefined; /** - *Algorithm-specific parameters.
+ *The configuration object that specifies the monitoring schedule and defines the monitoring + * job.
* @public */ - HyperParameters?: RecordInformation about the algorithm used for training, and algorithm metadata. - *
+ *The name of the endpoint for the monitoring job.
* @public */ - AlgorithmSpecification: AlgorithmSpecification | undefined; + EndpointName?: string | undefined; /** - *The Amazon Web Services Identity and Access Management (IAM) role configured for - * the training job.
+ *Describes metadata on the last execution to run, if there was one.
* @public */ - RoleArn?: string | undefined; + LastMonitoringExecutionSummary?: MonitoringExecutionSummary | undefined; +} +/** + * @public + */ +export interface DescribeNotebookInstanceInput { /** - *An array of Channel objects that describes each data input channel.
- *
The name of the notebook instance that you want information about.
* @public */ - InputDataConfig?: Channel[] | undefined; + NotebookInstanceName: string | undefined; +} - /** - *The S3 path where model artifacts that you configured when creating the job are - * stored. SageMaker creates subfolders for model artifacts.
- * @public - */ - OutputDataConfig?: OutputDataConfig | undefined; +/** + * @public + * @enum + */ +export const NotebookInstanceStatus = { + Deleting: "Deleting", + Failed: "Failed", + InService: "InService", + Pending: "Pending", + Stopped: "Stopped", + Stopping: "Stopping", + Updating: "Updating", +} as const; + +/** + * @public + */ +export type NotebookInstanceStatus = (typeof NotebookInstanceStatus)[keyof typeof NotebookInstanceStatus]; +/** + * @public + */ +export interface DescribeNotebookInstanceOutput { /** - *Resources, including ML compute instances and ML storage volumes, that are - * configured for model training.
+ *The Amazon Resource Name (ARN) of the notebook instance.
* @public */ - ResourceConfig: ResourceConfig | undefined; + NotebookInstanceArn?: string | undefined; /** - *The status of the warm pool associated with the training job.
+ *The name of the SageMaker notebook instance.
* @public */ - WarmPoolStatus?: WarmPoolStatus | undefined; + NotebookInstanceName?: string | undefined; /** - *A VpcConfig object that specifies the VPC that this training job has access - * to. For more information, see Protect Training Jobs by Using an Amazon - * Virtual Private Cloud.
+ *The status of the notebook instance.
* @public */ - VpcConfig?: VpcConfig | undefined; + NotebookInstanceStatus?: NotebookInstanceStatus | undefined; /** - *Specifies a limit to how long a model training job can run. It also specifies how long - * a managed Spot training job has to complete. When the job reaches the time limit, SageMaker - * ends the training job. Use this API to cap model training costs.
- *To stop a job, SageMaker sends the algorithm the SIGTERM signal, which delays
- * job termination for 120 seconds. Algorithms can use this 120-second window to save the
- * model artifacts, so the results of training are not lost.
If status is Failed, the reason it failed.
A timestamp that indicates when the training job was created.
+ *The URL that you use to connect to the Jupyter notebook that is running in your + * notebook instance.
* @public */ - CreationTime: Date | undefined; + Url?: string | undefined; /** - *Indicates the time when the training job starts on training instances. You are
- * billed for the time interval between this time and the value of
- * TrainingEndTime. The start time in CloudWatch Logs might be later than this time.
- * The difference is due to the time it takes to download the training data and to the size
- * of the training container.
The type of ML compute instance running on the notebook instance.
* @public */ - TrainingStartTime?: Date | undefined; + InstanceType?: _InstanceType | undefined; /** - *Indicates the time when the training job ends on training instances. You are billed
- * for the time interval between the value of TrainingStartTime and this time.
- * For successful jobs and stopped jobs, this is the time after model artifacts are
- * uploaded. For failed jobs, this is the time when SageMaker detects a job failure.
The ID of the VPC subnet.
* @public */ - TrainingEndTime?: Date | undefined; + SubnetId?: string | undefined; /** - *A timestamp that indicates when the status of the training job was last - * modified.
+ *The IDs of the VPC security groups.
* @public */ - LastModifiedTime?: Date | undefined; + SecurityGroups?: string[] | undefined; /** - *A history of all of the secondary statuses that the training job has transitioned - * through.
+ *The Amazon Resource Name (ARN) of the IAM role associated with the instance. + *
* @public */ - SecondaryStatusTransitions?: SecondaryStatusTransition[] | undefined; + RoleArn?: string | undefined; /** - *A collection of MetricData objects that specify the names, values, and
- * dates and times that the training algorithm emitted to Amazon CloudWatch.
The Amazon Web Services KMS key ID SageMaker uses to encrypt data when + * storing it on the ML storage volume attached to the instance.
* @public */ - FinalMetricDataList?: MetricData[] | undefined; + KmsKeyId?: string | undefined; /** - *If you want to allow inbound or outbound network calls, except for calls between peers
- * within a training cluster for distributed training, choose True. If you
- * enable network isolation for training jobs that are configured to use a VPC, SageMaker
- * downloads and uploads customer data and model artifacts through the specified VPC, but
- * the training container does not have network access.
The network interface IDs that SageMaker created at the time of creating + * the instance.
* @public */ - EnableNetworkIsolation?: boolean | undefined; + NetworkInterfaceId?: string | undefined; /** - *To encrypt all communications between ML compute instances in distributed training,
- * choose True. Encryption provides greater security for distributed training,
- * but training might take longer. How long it takes depends on the amount of communication
- * between compute instances, especially if you use a deep learning algorithms in
- * distributed training.
A timestamp. Use this parameter to retrieve the time when the notebook instance was + * last modified.
* @public */ - EnableInterContainerTrafficEncryption?: boolean | undefined; + LastModifiedTime?: Date | undefined; /** - *A Boolean indicating whether managed spot training is enabled (True) or
- * not (False).
A timestamp. Use this parameter to return the time when the notebook instance was + * created
* @public */ - EnableManagedSpotTraining?: boolean | undefined; + CreationTime?: Date | undefined; /** - *Contains information about the output location for managed spot training checkpoint - * data.
+ *Returns the name of a notebook instance lifecycle configuration.
+ *For information about notebook instance lifestyle configurations, see Step + * 2.1: (Optional) Customize a Notebook Instance + *
* @public */ - CheckpointConfig?: CheckpointConfig | undefined; + NotebookInstanceLifecycleConfigName?: string | undefined; /** - *The training time in seconds.
+ *Describes whether SageMaker provides internet access to the notebook instance. + * If this value is set to Disabled, the notebook instance does not + * have internet access, and cannot connect to SageMaker training and endpoint + * services.
+ *For more information, see Notebook Instances Are Internet-Enabled by Default.
* @public */ - TrainingTimeInSeconds?: number | undefined; + DirectInternetAccess?: DirectInternetAccess | undefined; /** - *The billable time in seconds. Billable time refers to the absolute wall-clock - * time.
- *Multiply BillableTimeInSeconds by the number of instances
- * (InstanceCount) in your training cluster to get the total compute time
- * SageMaker bills you if you run distributed training. The formula is as follows:
- * BillableTimeInSeconds * InstanceCount .
You can calculate the savings from using managed spot training using the formula
- * (1 - BillableTimeInSeconds / TrainingTimeInSeconds) * 100. For example,
- * if BillableTimeInSeconds is 100 and TrainingTimeInSeconds is
- * 500, the savings is 80%.
The size, in GB, of the ML storage volume attached to the notebook instance.
* @public */ - BillableTimeInSeconds?: number | undefined; + VolumeSizeInGB?: number | undefined; /** - *Configuration information for the Amazon SageMaker Debugger hook parameters, metric and tensor collections, and
- * storage paths. To learn more about
- * how to configure the DebugHookConfig parameter,
- * see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.
This parameter is no longer supported. Elastic Inference (EI) is no longer + * available.
+ *This parameter was used to specify a list of the EI instance types associated with + * this notebook instance.
* @public */ - DebugHookConfig?: DebugHookConfig | undefined; + AcceleratorTypes?: NotebookInstanceAcceleratorType[] | undefined; /** - *Associates a SageMaker job as a trial component with an experiment and trial. Specified when - * you call the following APIs:
- *- * CreateProcessingJob - *
- *- * CreateTrainingJob - *
- *- * CreateTransformJob - *
- *The Git repository associated with the notebook instance as its default code + * repository. This can be either the name of a Git repository stored as a resource in your + * account, or the URL of a Git repository in Amazon Web Services CodeCommit + * or in any other Git repository. When you open a notebook instance, it opens in the + * directory that contains this repository. For more information, see Associating Git + * Repositories with SageMaker Notebook Instances.
* @public */ - ExperimentConfig?: ExperimentConfig | undefined; + DefaultCodeRepository?: string | undefined; /** - *Configuration information for Amazon SageMaker Debugger rules for debugging output tensors.
+ *An array of up to three Git repositories associated with the notebook instance. These + * can be either the names of Git repositories stored as resources in your account, or the + * URL of Git repositories in Amazon Web Services CodeCommit + * or in any other Git repository. These repositories are cloned at the same level as the + * default repository of your notebook instance. For more information, see Associating Git + * Repositories with SageMaker Notebook Instances.
* @public */ - DebugRuleConfigurations?: DebugRuleConfiguration[] | undefined; + AdditionalCodeRepositories?: string[] | undefined; /** - *Configuration of storage locations for the Amazon SageMaker Debugger TensorBoard output data.
+ *Whether root access is enabled or disabled for users of the notebook instance.
+ *Lifecycle configurations need root access to be able to set up a notebook + * instance. Because of this, lifecycle configurations associated with a notebook + * instance always run with root access even if you disable root access for + * users.
+ *Evaluation status of Amazon SageMaker Debugger rules for debugging on a training job.
+ *The platform identifier of the notebook instance runtime environment.
* @public */ - DebugRuleEvaluationStatuses?: DebugRuleEvaluationStatus[] | undefined; + PlatformIdentifier?: string | undefined; /** - *Configuration information for Amazon SageMaker Debugger system monitoring, framework profiling, and - * storage paths.
+ *Information on the IMDS configuration of the notebook instance
* @public */ - ProfilerConfig?: ProfilerConfig | undefined; + InstanceMetadataServiceConfiguration?: InstanceMetadataServiceConfiguration | undefined; +} +/** + * @public + */ +export interface DescribeNotebookInstanceLifecycleConfigInput { /** - *Configuration information for Amazon SageMaker Debugger rules for profiling system and framework - * metrics.
+ *The name of the lifecycle configuration to describe.
* @public */ - ProfilerRuleConfigurations?: ProfilerRuleConfiguration[] | undefined; + NotebookInstanceLifecycleConfigName: string | undefined; +} +/** + * @public + */ +export interface DescribeNotebookInstanceLifecycleConfigOutput { /** - *Evaluation status of Amazon SageMaker Debugger rules for profiling on a training job.
+ *The Amazon Resource Name (ARN) of the lifecycle configuration.
* @public */ - ProfilerRuleEvaluationStatuses?: ProfilerRuleEvaluationStatus[] | undefined; + NotebookInstanceLifecycleConfigArn?: string | undefined; /** - *Profiling status of a training job.
+ *The name of the lifecycle configuration.
* @public */ - ProfilingStatus?: ProfilingStatus | undefined; + NotebookInstanceLifecycleConfigName?: string | undefined; /** - *The environment variables to set in the Docker container.
+ *The shell script that runs only once, when you create a notebook instance.
* @public */ - Environment?: RecordThe number of times to retry the job when the job fails due to an
- * InternalServerError.
The shell script that runs every time you start a notebook instance, including when + * you create the notebook instance.
* @public */ - RetryStrategy?: RetryStrategy | undefined; + OnStart?: NotebookInstanceLifecycleHook[] | undefined; /** - *Configuration for remote debugging. To learn more about the remote debugging - * functionality of SageMaker, see Access a training container - * through Amazon Web Services Systems Manager (SSM) for remote - * debugging.
+ *A timestamp that tells when the lifecycle configuration was last modified.
* @public */ - RemoteDebugConfig?: RemoteDebugConfig | undefined; + LastModifiedTime?: Date | undefined; /** - *Contains information about the infrastructure health check configuration for the training job.
+ *A timestamp that tells when the lifecycle configuration was created.
* @public */ - InfraCheckConfig?: InfraCheckConfig | undefined; + CreationTime?: Date | undefined; } /** * @public */ -export interface DescribeTransformJobRequest { +export interface DescribeOptimizationJobRequest { /** - *The name of the transform job that you want to view details of.
+ *The name that you assigned to the optimization job.
* @public */ - TransformJobName: string | undefined; + OptimizationJobName: string | undefined; } /** * @public * @enum */ -export const TransformJobStatus = { - COMPLETED: "Completed", - FAILED: "Failed", - IN_PROGRESS: "InProgress", - STOPPED: "Stopped", - STOPPING: "Stopping", +export const OptimizationJobStatus = { + COMPLETED: "COMPLETED", + FAILED: "FAILED", + INPROGRESS: "INPROGRESS", + STARTING: "STARTING", + STOPPED: "STOPPED", + STOPPING: "STOPPING", } as const; /** * @public */ -export type TransformJobStatus = (typeof TransformJobStatus)[keyof typeof TransformJobStatus]; +export type OptimizationJobStatus = (typeof OptimizationJobStatus)[keyof typeof OptimizationJobStatus]; /** + *Output values produced by an optimization job.
* @public */ -export interface DescribeTransformJobResponse { - /** - *The name of the transform job.
- * @public - */ - TransformJobName: string | undefined; - - /** - *The Amazon Resource Name (ARN) of the transform job.
- * @public - */ - TransformJobArn: string | undefined; - - /** - *The
- * status of the transform job. If the transform job failed, the reason
- * is returned in the FailureReason field.
If the transform job failed, FailureReason describes
- * why
- * it failed. A transform job creates a log file, which includes error
- * messages, and stores it
- * as
- * an Amazon S3 object. For more information, see Log Amazon SageMaker Events with
- * Amazon CloudWatch.
The image that SageMaker recommends that you use to host the optimized model that you created + * with an optimization job.
* @public */ - FailureReason?: string | undefined; + RecommendedInferenceImage?: string | undefined; +} +/** + * @public + */ +export interface DescribeOptimizationJobResponse { /** - *The name of the model used in the transform job.
+ *The Amazon Resource Name (ARN) of the optimization job.
* @public */ - ModelName: string | undefined; + OptimizationJobArn: string | undefined; /** - *The - * maximum number - * of - * parallel requests on each instance node - * that can be launched in a transform job. The default value is 1.
+ *The current status of the optimization job.
* @public */ - MaxConcurrentTransforms?: number | undefined; + OptimizationJobStatus: OptimizationJobStatus | undefined; /** - *The timeout and maximum number of retries for processing a transform job - * invocation.
+ *The time when the optimization job started.
* @public */ - ModelClientConfig?: ModelClientConfig | undefined; + OptimizationStartTime?: Date | undefined; /** - *The - * maximum - * payload size, in MB, used in the - * transform job.
+ *The time when the optimization job finished processing.
* @public */ - MaxPayloadInMB?: number | undefined; + OptimizationEndTime?: Date | undefined; /** - *Specifies the number of records to include in a mini-batch for an HTTP inference - * request. - * A record - * is a single unit of input data that inference - * can be made on. For example, a single line in a CSV file is a record.
- *To enable the batch strategy, you must set SplitType
- * to
- * Line, RecordIO, or
- * TFRecord.
The time when you created the optimization job.
* @public */ - BatchStrategy?: BatchStrategy | undefined; + CreationTime: Date | undefined; /** - *The - * environment variables to set in the Docker container. We support up to 16 key and values - * entries in the map.
+ *The time when the optimization job was last updated.
* @public */ - Environment?: RecordDescribes the dataset to be transformed and the Amazon S3 location where it is - * stored.
+ *If the optimization job status is FAILED, the reason for the
+ * failure.
Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the - * transform job.
+ *The name that you assigned to the optimization job.
* @public */ - TransformOutput?: TransformOutput | undefined; + OptimizationJobName: string | undefined; /** - *Configuration to control how SageMaker captures inference data.
+ *The location of the source model to optimize with an optimization job.
* @public */ - DataCaptureConfig?: BatchDataCaptureConfig | undefined; + ModelSource: OptimizationJobModelSource | undefined; /** - *Describes - * the resources, including ML instance types and ML instance count, to - * use for the transform job.
+ *The environment variables to set in the model container.
* @public */ - TransformResources: TransformResources | undefined; + OptimizationEnvironment?: RecordA timestamp that shows when the transform Job was created.
+ *The type of instance that hosts the optimized model that you create with the optimization job.
* @public */ - CreationTime: Date | undefined; + DeploymentInstanceType: OptimizationJobDeploymentInstanceType | undefined; /** - *Indicates when the transform job starts
- * on
- * ML instances. You are billed for the time interval between this time
- * and the value of TransformEndTime.
Settings for each of the optimization techniques that the job applies.
* @public */ - TransformStartTime?: Date | undefined; + OptimizationConfigs: OptimizationConfig[] | undefined; /** - *Indicates when the transform job has been
- *
- * completed, or has stopped or failed. You are billed for the time
- * interval between this time and the value of TransformStartTime.
Details for where to store the optimized model that you create with the optimization job.
* @public */ - TransformEndTime?: Date | undefined; + OutputConfig: OptimizationJobOutputConfig | undefined; /** - *The Amazon Resource Name (ARN) of the Amazon SageMaker Ground Truth labeling job that created the - * transform or training job.
+ *Output values produced by an optimization job.
* @public */ - LabelingJobArn?: string | undefined; + OptimizationOutput?: OptimizationOutput | undefined; /** - *The Amazon Resource Name (ARN) of the AutoML transform job.
+ *The ARN of the IAM role that you assigned to the optimization job.
* @public */ - AutoMLJobArn?: string | undefined; + RoleArn: string | undefined; /** - *The data structure used to specify the data to be used for inference in a batch - * transform job and to associate the data that is relevant to the prediction results in - * the output. The input filter provided allows you to exclude input data that is not - * needed for inference in a batch transform job. The output filter provided allows you to - * include input data relevant to interpreting the predictions in the output from the job. - * For more information, see Associate Prediction - * Results with their Corresponding Input Records.
+ *Specifies a limit to how long a job can run. When the job reaches the time limit, SageMaker + * ends the job. Use this API to cap costs.
+ *To stop a training job, SageMaker sends the algorithm the SIGTERM signal,
+ * which delays job termination for 120 seconds. Algorithms can use this 120-second window
+ * to save the model artifacts, so the results of training are not lost.
The training algorithms provided by SageMaker automatically save the intermediate results
+ * of a model training job when possible. This attempt to save artifacts is only a best
+ * effort case as model might not be in a state from which it can be saved. For example, if
+ * training has just started, the model might not be ready to save. When saved, this
+ * intermediate data is a valid model artifact. You can use it to create a model with
+ * CreateModel.
The Neural Topic Model (NTM) currently does not support saving intermediate model + * artifacts. When training NTMs, make sure that the maximum runtime is sufficient for + * the training job to complete.
+ *Associates a SageMaker job as a trial component with an experiment and trial. Specified when - * you call the following APIs:
- *- * CreateProcessingJob - *
- *- * CreateTrainingJob - *
- *- * CreateTransformJob - *
- *A VPC in Amazon VPC that your optimized model has access to.
* @public */ - ExperimentConfig?: ExperimentConfig | undefined; + VpcConfig?: OptimizationVpcConfig | undefined; } /** * @public */ -export interface DescribeTrialRequest { +export interface DescribePartnerAppRequest { /** - *The name of the trial to describe.
+ *The ARN of the SageMaker Partner AI App to describe.
* @public */ - TrialName: string | undefined; + Arn: string | undefined; } /** - *The source of the trial.
+ *This is an error field object that contains the error code and the reason for an operation failure.
* @public */ -export interface TrialSource { +export interface ErrorInfo { /** - *The Amazon Resource Name (ARN) of the source.
+ *The error code for an invalid or failed operation.
* @public */ - SourceArn: string | undefined; + Code?: string | undefined; /** - *The source job type.
+ *The failure reason for the operation.
* @public */ - SourceType?: string | undefined; + Reason?: string | undefined; } /** * @public + * @enum */ -export interface DescribeTrialResponse { - /** - *The name of the trial.
- * @public - */ - TrialName?: string | undefined; - - /** - *The Amazon Resource Name (ARN) of the trial.
- * @public - */ - TrialArn?: string | undefined; +export const PartnerAppStatus = { + AVAILABLE: "Available", + CREATING: "Creating", + DELETED: "Deleted", + DELETING: "Deleting", + FAILED: "Failed", + UPDATE_FAILED: "UpdateFailed", + UPDATING: "Updating", +} as const; - /** - *The name of the trial as displayed. If DisplayName isn't specified,
- * TrialName is displayed.
The name of the experiment the trial is part of.
+ *The ARN of the SageMaker Partner AI App that was described.
* @public */ - ExperimentName?: string | undefined; + Arn?: string | undefined; /** - *The Amazon Resource Name (ARN) of the source and, optionally, the job type.
+ *The name of the SageMaker Partner AI App.
* @public */ - Source?: TrialSource | undefined; + Name?: string | undefined; /** - *When the trial was created.
+ *The type of SageMaker Partner AI App. Must be one of the following: lakera-guard, comet, deepchecks-llm-evaluation, or fiddler.
Who created the trial.
+ *The status of the SageMaker Partner AI App.
* @public */ - CreatedBy?: UserContext | undefined; + Status?: PartnerAppStatus | undefined; /** - *When the trial was last modified.
+ *The time that the SageMaker Partner AI App was created.
* @public */ - LastModifiedTime?: Date | undefined; + CreationTime?: Date | undefined; /** - *Who last modified the trial.
+ *The ARN of the IAM role associated with the SageMaker Partner AI App.
* @public */ - LastModifiedBy?: UserContext | undefined; + ExecutionRoleArn?: string | undefined; /** - *Metadata properties of the tracking entity, trial, or trial component.
+ *The URL of the SageMaker Partner AI App that the Application SDK uses to support in-app calls for the user.
* @public */ - MetadataProperties?: MetadataProperties | undefined; -} + BaseUrl?: string | undefined; -/** - * @public - */ -export interface DescribeTrialComponentRequest { /** - *The name of the trial component to describe.
+ *Maintenance configuration settings for the SageMaker Partner AI App.
* @public */ - TrialComponentName: string | undefined; -} + MaintenanceConfig?: PartnerAppMaintenanceConfig | undefined; -/** - *A summary of the metrics of a trial component.
- * @public - */ -export interface TrialComponentMetricSummary { /** - *The name of the metric.
+ *The instance type and size of the cluster attached to the SageMaker Partner AI App.
* @public */ - MetricName?: string | undefined; + Tier?: string | undefined; /** - *The Amazon Resource Name (ARN) of the source.
+ *The version of the SageMaker Partner AI App.
* @public */ - SourceArn?: string | undefined; + Version?: string | undefined; /** - *When the metric was last updated.
+ *Configuration settings for the SageMaker Partner AI App.
* @public */ - TimeStamp?: Date | undefined; + ApplicationConfig?: PartnerAppConfig | undefined; /** - *The maximum value of the metric.
+ *The authorization type that users use to access the SageMaker Partner AI App.
* @public */ - Max?: number | undefined; + AuthType?: PartnerAppAuthType | undefined; /** - *The minimum value of the metric.
+ *When set to TRUE, the SageMaker Partner AI App sets the Amazon Web Services IAM session name or the authenticated IAM user as the identity of the SageMaker Partner AI App user.
The most recent value of the metric.
+ *This is an error field object that contains the error code and the reason for an operation failure.
* @public */ - Last?: number | undefined; + Error?: ErrorInfo | undefined; +} +/** + * @public + */ +export interface DescribePipelineRequest { /** - *The number of samples used to generate the metric.
+ *The name or Amazon Resource Name (ARN) of the pipeline to describe.
* @public */ - Count?: number | undefined; + PipelineName: string | undefined; +} - /** - *The average value of the metric.
- * @public - */ - Avg?: number | undefined; +/** + * @public + * @enum + */ +export const PipelineStatus = { + ACTIVE: "Active", + DELETING: "Deleting", +} as const; - /** - *The standard deviation of the metric.
- * @public - */ - StdDev?: number | undefined; -} +/** + * @public + */ +export type PipelineStatus = (typeof PipelineStatus)[keyof typeof PipelineStatus]; /** - *The Amazon Resource Name (ARN) and job type of the source of a trial component.
* @public */ -export interface TrialComponentSource { +export interface DescribePipelineResponse { /** - *The source Amazon Resource Name (ARN).
+ *The Amazon Resource Name (ARN) of the pipeline.
* @public */ - SourceArn: string | undefined; + PipelineArn?: string | undefined; /** - *The source job type.
+ *The name of the pipeline.
* @public */ - SourceType?: string | undefined; -} + PipelineName?: string | undefined; -/** - * @public - */ -export interface DescribeTrialComponentResponse { /** - *The name of the trial component.
+ *The display name of the pipeline.
* @public */ - TrialComponentName?: string | undefined; + PipelineDisplayName?: string | undefined; /** - *The Amazon Resource Name (ARN) of the trial component.
+ *The JSON pipeline definition.
* @public */ - TrialComponentArn?: string | undefined; + PipelineDefinition?: string | undefined; /** - *The name of the component as displayed. If DisplayName isn't specified,
- * TrialComponentName is displayed.
The description of the pipeline.
* @public */ - DisplayName?: string | undefined; + PipelineDescription?: string | undefined; /** - *The Amazon Resource Name (ARN) of the source and, optionally, the job type.
+ *The Amazon Resource Name (ARN) that the pipeline uses to execute.
* @public */ - Source?: TrialComponentSource | undefined; + RoleArn?: string | undefined; /** - *The status of the component. States include:
- *InProgress
- *Completed
- *Failed
- *The status of the pipeline execution.
* @public */ - Status?: TrialComponentStatus | undefined; + PipelineStatus?: PipelineStatus | undefined; /** - *When the component started.
+ *The time when the pipeline was created.
* @public */ - StartTime?: Date | undefined; + CreationTime?: Date | undefined; /** - *When the component ended.
+ *The time when the pipeline was last modified.
* @public */ - EndTime?: Date | undefined; + LastModifiedTime?: Date | undefined; /** - *When the component was created.
+ *The time when the pipeline was last run.
* @public */ - CreationTime?: Date | undefined; + LastRunTime?: Date | undefined; /** - *Who created the trial component.
+ *Information about the user who created or modified an experiment, trial, trial + * component, lineage group, project, or model card.
* @public */ CreatedBy?: UserContext | undefined; /** - *When the component was last modified.
+ *Information about the user who created or modified an experiment, trial, trial + * component, lineage group, project, or model card.
* @public */ - LastModifiedTime?: Date | undefined; + LastModifiedBy?: UserContext | undefined; /** - *Who last modified the component.
+ *Lists the parallelism configuration applied to the pipeline.
* @public */ - LastModifiedBy?: UserContext | undefined; + ParallelismConfiguration?: ParallelismConfiguration | undefined; +} +/** + * @public + */ +export interface DescribePipelineDefinitionForExecutionRequest { /** - *The hyperparameters of the component.
+ *The Amazon Resource Name (ARN) of the pipeline execution.
* @public */ - Parameters?: RecordThe input artifacts of the component.
+ *The JSON pipeline definition.
* @public */ - InputArtifacts?: RecordThe output artifacts of the component.
+ *The time when the pipeline was created.
* @public */ - OutputArtifacts?: RecordMetadata properties of the tracking entity, trial, or trial component.
+ *The Amazon Resource Name (ARN) of the pipeline execution.
* @public */ - MetadataProperties?: MetadataProperties | undefined; + PipelineExecutionArn: string | undefined; +} + +/** + * @public + * @enum + */ +export const PipelineExecutionStatus = { + EXECUTING: "Executing", + FAILED: "Failed", + STOPPED: "Stopped", + STOPPING: "Stopping", + SUCCEEDED: "Succeeded", +} as const; + +/** + * @public + */ +export type PipelineExecutionStatus = (typeof PipelineExecutionStatus)[keyof typeof PipelineExecutionStatus]; +/** + *Specifies the names of the experiment and trial created by a pipeline.
+ * @public + */ +export interface PipelineExperimentConfig { /** - *The metrics for the component.
+ *The name of the experiment.
* @public */ - Metrics?: TrialComponentMetricSummary[] | undefined; + ExperimentName?: string | undefined; /** - *The Amazon Resource Name (ARN) of the lineage group.
+ *The name of the trial.
* @public */ - LineageGroupArn?: string | undefined; + TrialName?: string | undefined; +} +/** + *A step selected to run in selective execution mode.
+ * @public + */ +export interface SelectedStep { /** - *A list of ARNs and, if applicable, job types for multiple sources of an experiment - * run.
+ *The name of the pipeline step.
* @public */ - Sources?: TrialComponentSource[] | undefined; + StepName: string | undefined; } /** + *The selective execution configuration applied to the pipeline run.
* @public */ -export interface DescribeUserProfileRequest { +export interface SelectiveExecutionConfig { /** - *The domain ID.
+ *The ARN from a reference execution of the current pipeline.
+ * Used to copy input collaterals needed for the selected steps to run.
+ * The execution status of the pipeline can be either Failed
+ * or Success.
This field is required if the steps you specify for
+ * SelectedSteps depend on output collaterals from any non-specified pipeline
+ * steps. For more information, see Selective
+ * Execution for Pipeline Steps.
The user profile name. This value is not case sensitive.
+ *A list of pipeline steps to run. All step(s) in all path(s) between + * two selected steps should be included.
* @public */ - UserProfileName: string | undefined; + SelectedSteps: SelectedStep[] | undefined; } -/** - * @public - * @enum - */ -export const UserProfileStatus = { - Delete_Failed: "Delete_Failed", - Deleting: "Deleting", - Failed: "Failed", - InService: "InService", - Pending: "Pending", - Update_Failed: "Update_Failed", - Updating: "Updating", -} as const; - /** * @public */ -export type UserProfileStatus = (typeof UserProfileStatus)[keyof typeof UserProfileStatus]; +export interface DescribePipelineExecutionResponse { + /** + *The Amazon Resource Name (ARN) of the pipeline.
+ * @public + */ + PipelineArn?: string | undefined; -/** - * @public - */ -export interface DescribeUserProfileResponse { /** - *The ID of the domain that contains the profile.
+ *The Amazon Resource Name (ARN) of the pipeline execution.
* @public */ - DomainId?: string | undefined; + PipelineExecutionArn?: string | undefined; /** - *The user profile Amazon Resource Name (ARN).
+ *The display name of the pipeline execution.
* @public */ - UserProfileArn?: string | undefined; + PipelineExecutionDisplayName?: string | undefined; /** - *The user profile name.
+ *The status of the pipeline execution.
* @public */ - UserProfileName?: string | undefined; + PipelineExecutionStatus?: PipelineExecutionStatus | undefined; /** - *The ID of the user's profile in the Amazon Elastic File System volume.
+ *The description of the pipeline execution.
* @public */ - HomeEfsFileSystemUid?: string | undefined; + PipelineExecutionDescription?: string | undefined; /** - *The status.
+ *Specifies the names of the experiment and trial created by a pipeline.
* @public */ - Status?: UserProfileStatus | undefined; + PipelineExperimentConfig?: PipelineExperimentConfig | undefined; /** - *The last modified time.
+ *If the execution failed, a message describing why.
* @public */ - LastModifiedTime?: Date | undefined; + FailureReason?: string | undefined; /** - *The creation time.
+ *The time when the pipeline execution was created.
* @public */ CreationTime?: Date | undefined; /** - *The failure reason.
+ *The time when the pipeline execution was modified last.
* @public */ - FailureReason?: string | undefined; + LastModifiedTime?: Date | undefined; /** - *The IAM Identity Center user identifier.
+ *Information about the user who created or modified an experiment, trial, trial + * component, lineage group, project, or model card.
* @public */ - SingleSignOnUserIdentifier?: string | undefined; + CreatedBy?: UserContext | undefined; /** - *The IAM Identity Center user value.
+ *Information about the user who created or modified an experiment, trial, trial + * component, lineage group, project, or model card.
* @public */ - SingleSignOnUserValue?: string | undefined; + LastModifiedBy?: UserContext | undefined; /** - *A collection of settings.
+ *The parallelism configuration applied to the pipeline.
* @public */ - UserSettings?: UserSettings | undefined; -} + ParallelismConfiguration?: ParallelismConfiguration | undefined; -/** - * @public - */ -export interface DescribeWorkforceRequest { /** - *The name of the private workforce whose access you want to restrict.
- * WorkforceName is automatically set to default when a
- * workforce is created and cannot be modified.
The selective execution configuration applied to the pipeline run.
* @public */ - WorkforceName: string | undefined; + SelectiveExecutionConfig?: SelectiveExecutionConfig | undefined; } /** - *Your OIDC IdP workforce configuration.
* @public */ -export interface OidcConfigForResponse { +export interface DescribeProcessingJobRequest { /** - *The OIDC IdP client ID used to configure your private workforce.
+ *The name of the processing job. The name must be unique within an Amazon Web Services Region in the + * Amazon Web Services account.
* @public */ - ClientId?: string | undefined; + ProcessingJobName: string | undefined; +} - /** - *The OIDC IdP issuer used to configure your private workforce.
- * @public - */ - Issuer?: string | undefined; +/** + * @public + * @enum + */ +export const ProcessingJobStatus = { + COMPLETED: "Completed", + FAILED: "Failed", + IN_PROGRESS: "InProgress", + STOPPED: "Stopped", + STOPPING: "Stopping", +} as const; - /** - *The OIDC IdP authorization endpoint used to configure your private workforce.
- * @public - */ - AuthorizationEndpoint?: string | undefined; +/** + * @public + */ +export type ProcessingJobStatus = (typeof ProcessingJobStatus)[keyof typeof ProcessingJobStatus]; +/** + * @public + */ +export interface DescribeProcessingJobResponse { /** - *The OIDC IdP token endpoint used to configure your private workforce.
+ *The inputs for a processing job.
* @public */ - TokenEndpoint?: string | undefined; + ProcessingInputs?: ProcessingInput[] | undefined; /** - *The OIDC IdP user information endpoint used to configure your private workforce.
+ *Output configuration for the processing job.
* @public */ - UserInfoEndpoint?: string | undefined; + ProcessingOutputConfig?: ProcessingOutputConfig | undefined; /** - *The OIDC IdP logout endpoint used to configure your private workforce.
+ *The name of the processing job. The name must be unique within an Amazon Web Services Region in the + * Amazon Web Services account.
* @public */ - LogoutEndpoint?: string | undefined; + ProcessingJobName: string | undefined; /** - *The OIDC IdP JSON Web Key Set (Jwks) URI used to configure your private workforce.
+ *Identifies the resources, ML compute instances, and ML storage volumes to deploy for a + * processing job. In distributed training, you specify more than one instance.
* @public */ - JwksUri?: string | undefined; + ProcessingResources: ProcessingResources | undefined; /** - *An array of string identifiers used to refer to the specific pieces of user data or claims that the client application wants to access.
+ *The time limit for how long the processing job is allowed to run.
* @public */ - Scope?: string | undefined; + StoppingCondition?: ProcessingStoppingCondition | undefined; /** - *A string to string map of identifiers specific to the custom identity provider (IdP) being used.
+ *Configures the processing job to run a specified container image.
* @public */ - AuthenticationRequestExtraParams?: RecordA VpcConfig object that specifies the VPC that you want your workforce to connect to.
- * @public - */ -export interface WorkforceVpcConfigResponse { /** - *The ID of the VPC that the workforce uses for communication.
+ *The environment variables set in the Docker container.
* @public */ - VpcId: string | undefined; + Environment?: RecordThe VPC security group IDs, in the form sg-xxxxxxxx. The security groups must be for the same VPC as specified in the subnet.
+ *Networking options for a processing job.
* @public */ - SecurityGroupIds: string[] | undefined; + NetworkConfig?: NetworkConfig | undefined; /** - *The ID of the subnets in the VPC that you want to connect.
+ *The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on + * your behalf.
* @public */ - Subnets: string[] | undefined; + RoleArn?: string | undefined; /** - *The IDs for the VPC service endpoints of your VPC workforce when it is created and updated.
+ *The configuration information used to create an experiment.
* @public */ - VpcEndpointId?: string | undefined; -} + ExperimentConfig?: ExperimentConfig | undefined; -/** - *A single private workforce, which is automatically created when you create your first - * private work team. You can create one private work force in each Amazon Web Services Region. By default, - * any workforce-related API operation used in a specific region will apply to the - * workforce created in that region. To learn how to create a private workforce, see Create a Private Workforce.
- * @public - */ -export interface Workforce { /** - *The name of the private workforce.
+ *The Amazon Resource Name (ARN) of the processing job.
* @public */ - WorkforceName: string | undefined; + ProcessingJobArn: string | undefined; /** - *The Amazon Resource Name (ARN) of the private workforce.
+ *Provides the status of a processing job.
* @public */ - WorkforceArn: string | undefined; + ProcessingJobStatus: ProcessingJobStatus | undefined; /** - *The most recent date that UpdateWorkforce was used to - * successfully add one or more IP address ranges (CIDRs) to a private workforce's - * allow list.
+ *An optional string, up to one KB in size, that contains metadata from the processing + * container when the processing job exits.
* @public */ - LastUpdatedDate?: Date | undefined; + ExitMessage?: string | undefined; /** - *A list of one to ten IP address ranges (CIDRs) to be added to the - * workforce allow list. By default, a workforce isn't restricted to specific IP addresses.
+ *A string, up to one KB in size, that contains the reason a processing job failed, if + * it failed.
* @public */ - SourceIpConfig?: SourceIpConfig | undefined; + FailureReason?: string | undefined; /** - *The subdomain for your OIDC Identity Provider.
+ *The time at which the processing job completed.
* @public */ - SubDomain?: string | undefined; + ProcessingEndTime?: Date | undefined; /** - *The configuration of an Amazon Cognito workforce. - * A single Cognito workforce is created using and corresponds to a single - * - * Amazon Cognito user pool.
+ *The time at which the processing job started.
* @public */ - CognitoConfig?: CognitoConfig | undefined; + ProcessingStartTime?: Date | undefined; /** - *The configuration of an OIDC Identity Provider (IdP) private workforce.
+ *The time at which the processing job was last modified.
* @public */ - OidcConfig?: OidcConfigForResponse | undefined; + LastModifiedTime?: Date | undefined; /** - *The date that the workforce is created.
+ *The time at which the processing job was created.
* @public */ - CreateDate?: Date | undefined; + CreationTime: Date | undefined; /** - *The configuration of a VPC workforce.
+ *The ARN of a monitoring schedule for an endpoint associated with this processing + * job.
* @public */ - WorkforceVpcConfig?: WorkforceVpcConfigResponse | undefined; + MonitoringScheduleArn?: string | undefined; /** - *The status of your workforce.
+ *The ARN of an AutoML job associated with this processing job.
* @public */ - Status?: WorkforceStatus | undefined; + AutoMLJobArn?: string | undefined; /** - *The reason your workforce failed.
+ *The ARN of a training job associated with this processing job.
* @public */ - FailureReason?: string | undefined; + TrainingJobArn?: string | undefined; } /** * @public */ -export interface DescribeWorkforceResponse { +export interface DescribeProjectInput { /** - *A single private workforce, which is automatically created when you create your first - * private work team. You can create one private work force in each Amazon Web Services Region. By default, - * any workforce-related API operation used in a specific region will apply to the - * workforce created in that region. To learn how to create a private workforce, see Create a Private Workforce.
+ *The name of the project to describe.
* @public */ - Workforce: Workforce | undefined; + ProjectName: string | undefined; } /** * @public + * @enum */ -export interface DescribeWorkteamRequest { +export const ProjectStatus = { + CREATE_COMPLETED: "CreateCompleted", + CREATE_FAILED: "CreateFailed", + CREATE_IN_PROGRESS: "CreateInProgress", + DELETE_COMPLETED: "DeleteCompleted", + DELETE_FAILED: "DeleteFailed", + DELETE_IN_PROGRESS: "DeleteInProgress", + PENDING: "Pending", + UPDATE_COMPLETED: "UpdateCompleted", + UPDATE_FAILED: "UpdateFailed", + UPDATE_IN_PROGRESS: "UpdateInProgress", +} as const; + +/** + * @public + */ +export type ProjectStatus = (typeof ProjectStatus)[keyof typeof ProjectStatus]; + +/** + *Details of a provisioned service catalog product. For information about service catalog, + * see What is Amazon Web Services Service + * Catalog.
+ * @public + */ +export interface ServiceCatalogProvisionedProductDetails { /** - *The name of the work team to return a description of.
+ *The ID of the provisioned product.
* @public */ - WorkteamName: string | undefined; + ProvisionedProductId?: string | undefined; + + /** + *The current status of the product.
+ *
+ * AVAILABLE - Stable state, ready to perform any operation. The most recent operation succeeded and completed.
+ * UNDER_CHANGE - Transitive state. Operations performed might not have valid results. Wait for an AVAILABLE status before performing operations.
+ * TAINTED - Stable state, ready to perform any operation. The stack has completed the requested operation but is not exactly what was requested. For example, a request to update to a new version failed and the stack rolled back to the current version.
+ * ERROR - An unexpected error occurred. The provisioned product exists but the stack is not running. For example, CloudFormation received a parameter value that was not valid and could not launch the stack.
+ * PLAN_IN_PROGRESS - Transitive state. The plan operations were performed to provision a new product, but resources have not yet been created. After reviewing the list of resources to be created, execute the plan. Wait for an AVAILABLE status before performing operations.
Provides details about a labeling work team.
* @public */ -export interface Workteam { +export interface DescribeProjectOutput { /** - *The name of the work team.
+ *The Amazon Resource Name (ARN) of the project.
* @public */ - WorkteamName: string | undefined; + ProjectArn: string | undefined; /** - *A list of MemberDefinition objects that contains objects that identify
- * the workers that make up the work team.
Workforces can be created using Amazon Cognito or your own OIDC Identity Provider (IdP).
- * For private workforces created using Amazon Cognito use
- * CognitoMemberDefinition. For workforces created using your own OIDC identity
- * provider (IdP) use OidcMemberDefinition.
The name of the project.
* @public */ - MemberDefinitions: MemberDefinition[] | undefined; + ProjectName: string | undefined; /** - *The Amazon Resource Name (ARN) that identifies the work team.
+ *The ID of the project.
* @public */ - WorkteamArn: string | undefined; + ProjectId: string | undefined; /** - *The Amazon Resource Name (ARN) of the workforce.
+ *The description of the project.
* @public */ - WorkforceArn?: string | undefined; + ProjectDescription?: string | undefined; /** - *The Amazon Marketplace identifier for a vendor's work team.
+ *Information used to provision a service catalog product. For information, see What is Amazon Web Services Service + * Catalog.
* @public */ - ProductListingIds?: string[] | undefined; + ServiceCatalogProvisioningDetails: ServiceCatalogProvisioningDetails | undefined; /** - *A description of the work team.
+ *Information about a provisioned service catalog product.
* @public */ - Description: string | undefined; + ServiceCatalogProvisionedProductDetails?: ServiceCatalogProvisionedProductDetails | undefined; /** - *The URI of the labeling job's user interface. Workers open this URI to start labeling - * your data objects.
+ *The status of the project.
* @public */ - SubDomain?: string | undefined; + ProjectStatus: ProjectStatus | undefined; /** - *The date and time that the work team was created (timestamp).
+ *Information about the user who created or modified an experiment, trial, trial + * component, lineage group, project, or model card.
* @public */ - CreateDate?: Date | undefined; + CreatedBy?: UserContext | undefined; /** - *The date and time that the work team was last updated (timestamp).
+ *The time when the project was created.
* @public */ - LastUpdatedDate?: Date | undefined; + CreationTime: Date | undefined; /** - *Configures SNS notifications of available or expiring work items for work - * teams.
+ *The timestamp when project was last modified.
* @public */ - NotificationConfiguration?: NotificationConfiguration | undefined; + LastModifiedTime?: Date | undefined; /** - *Describes any access constraints that have been defined for Amazon S3 resources.
+ *Information about the user who created or modified an experiment, trial, trial + * component, lineage group, project, or model card.
* @public */ - WorkerAccessConfiguration?: WorkerAccessConfiguration | undefined; + LastModifiedBy?: UserContext | undefined; } /** * @public */ -export interface DescribeWorkteamResponse { +export interface DescribeSpaceRequest { /** - *A Workteam instance that contains information about the work team.
- *
The ID of the associated domain.
* @public */ - Workteam: Workteam | undefined; + DomainId: string | undefined; + + /** + *The name of the space.
+ * @public + */ + SpaceName: string | undefined; } /** - *Specifies the serverless update concurrency configuration for an endpoint variant.
* @public + * @enum */ -export interface ProductionVariantServerlessUpdateConfig { +export const SpaceStatus = { + Delete_Failed: "Delete_Failed", + Deleting: "Deleting", + Failed: "Failed", + InService: "InService", + Pending: "Pending", + Update_Failed: "Update_Failed", + Updating: "Updating", +} as const; + +/** + * @public + */ +export type SpaceStatus = (typeof SpaceStatus)[keyof typeof SpaceStatus]; + +/** + * @public + */ +export interface DescribeSpaceResponse { /** - *The updated maximum number of concurrent invocations your serverless endpoint can process.
+ *The ID of the associated domain.
* @public */ - MaxConcurrency?: number | undefined; + DomainId?: string | undefined; /** - *The updated amount of provisioned concurrency to allocate for the serverless endpoint.
- * Should be less than or equal to MaxConcurrency.
The space's Amazon Resource Name (ARN).
* @public */ - ProvisionedConcurrency?: number | undefined; -} + SpaceArn?: string | undefined; -/** - *Specifies weight and capacity values for a production variant.
- * @public - */ -export interface DesiredWeightAndCapacity { /** - *The name of the variant to update.
+ *The name of the space.
* @public */ - VariantName: string | undefined; + SpaceName?: string | undefined; /** - *The variant's weight.
+ *The ID of the space's profile in the Amazon EFS volume.
* @public */ - DesiredWeight?: number | undefined; + HomeEfsFileSystemUid?: string | undefined; /** - *The variant's capacity.
+ *The status.
* @public */ - DesiredInstanceCount?: number | undefined; + Status?: SpaceStatus | undefined; /** - *Specifies the serverless update concurrency configuration for an endpoint variant.
+ *The last modified time.
* @public */ - ServerlessUpdateConfig?: ProductionVariantServerlessUpdateConfig | undefined; -} + LastModifiedTime?: Date | undefined; -/** - *Information of a particular device.
- * @public - */ -export interface Device { /** - *The name of the device.
+ *The creation time.
* @public */ - DeviceName: string | undefined; + CreationTime?: Date | undefined; /** - *Description of the device.
+ *The failure reason.
* @public */ - Description?: string | undefined; + FailureReason?: string | undefined; /** - *Amazon Web Services Internet of Things (IoT) object name.
+ *A collection of space settings.
* @public */ - IotThingName?: string | undefined; -} - -/** - * @public - * @enum - */ -export const DeviceDeploymentStatus = { - Deployed: "DEPLOYED", - Failed: "FAILED", - InProgress: "INPROGRESS", - ReadyToDeploy: "READYTODEPLOY", - Stopped: "STOPPED", - Stopping: "STOPPING", -} as const; + SpaceSettings?: SpaceSettings | undefined; -/** - * @public - */ -export type DeviceDeploymentStatus = (typeof DeviceDeploymentStatus)[keyof typeof DeviceDeploymentStatus]; + /** + *The collection of ownership settings for a space.
+ * @public + */ + OwnershipSettings?: OwnershipSettings | undefined; -/** - *Contains information summarizing device details and deployment status.
- * @public - */ -export interface DeviceDeploymentSummary { /** - *The ARN of the edge deployment plan.
+ *The collection of space sharing settings for a space.
* @public */ - EdgeDeploymentPlanArn: string | undefined; + SpaceSharingSettings?: SpaceSharingSettings | undefined; /** - *The name of the edge deployment plan.
+ *The name of the space that appears in the Amazon SageMaker Studio UI.
* @public */ - EdgeDeploymentPlanName: string | undefined; + SpaceDisplayName?: string | undefined; /** - *The name of the stage in the edge deployment plan.
+ *Returns the URL of the space. If the space is created with Amazon Web Services IAM Identity + * Center (Successor to Amazon Web Services Single Sign-On) authentication, users can navigate to + * the URL after appending the respective redirect parameter for the application type to be + * federated through Amazon Web Services IAM Identity Center.
+ *The following application types are supported:
+ *Studio Classic: &redirect=JupyterServer
+ *
JupyterLab: &redirect=JupyterLab
+ *
Code Editor, based on Code-OSS, Visual Studio Code - Open Source:
+ * &redirect=CodeEditor
+ *
The name of the deployed stage.
+ *The name of the Amazon SageMaker Studio Lifecycle Configuration to describe.
* @public */ - DeployedStageName?: string | undefined; + StudioLifecycleConfigName: string | undefined; +} +/** + * @public + */ +export interface DescribeStudioLifecycleConfigResponse { /** - *The name of the fleet to which the device belongs to.
+ *The ARN of the Lifecycle Configuration to describe.
* @public */ - DeviceFleetName?: string | undefined; + StudioLifecycleConfigArn?: string | undefined; /** - *The name of the device.
+ *The name of the Amazon SageMaker Studio Lifecycle Configuration that is + * described.
* @public */ - DeviceName: string | undefined; + StudioLifecycleConfigName?: string | undefined; /** - *The ARN of the device.
+ *The creation time of the Amazon SageMaker Studio Lifecycle Configuration.
* @public */ - DeviceArn: string | undefined; + CreationTime?: Date | undefined; /** - *The deployment status of the device.
+ *This value is equivalent to CreationTime because Amazon SageMaker Studio Lifecycle + * Configurations are immutable.
* @public */ - DeviceDeploymentStatus?: DeviceDeploymentStatus | undefined; + LastModifiedTime?: Date | undefined; /** - *The detailed error message for the deployoment status result.
+ *The content of your Amazon SageMaker Studio Lifecycle Configuration script.
* @public */ - DeviceDeploymentStatusMessage?: string | undefined; + StudioLifecycleConfigContent?: string | undefined; /** - *The description of the device.
+ *The App type that the Lifecycle Configuration is attached to.
* @public */ - Description?: string | undefined; + StudioLifecycleConfigAppType?: StudioLifecycleConfigAppType | undefined; +} +/** + * @public + */ +export interface DescribeSubscribedWorkteamRequest { /** - *The time when the deployment on the device started.
+ *The Amazon Resource Name (ARN) of the subscribed work team to describe.
* @public */ - DeploymentStartTime?: Date | undefined; + WorkteamArn: string | undefined; } /** - *Summary of the device fleet.
+ *Describes a work team of a vendor that does the labelling job.
* @public */ -export interface DeviceFleetSummary { +export interface SubscribedWorkteam { /** - *Amazon Resource Name (ARN) of the device fleet.
+ *The Amazon Resource Name (ARN) of the vendor that you have subscribed.
* @public */ - DeviceFleetArn: string | undefined; + WorkteamArn: string | undefined; /** - *Name of the device fleet.
+ *The title of the service provided by the vendor in the Amazon Marketplace.
* @public */ - DeviceFleetName: string | undefined; + MarketplaceTitle?: string | undefined; /** - *Timestamp of when the device fleet was created.
+ *The name of the vendor in the Amazon Marketplace.
* @public */ - CreationTime?: Date | undefined; + SellerName?: string | undefined; /** - *Timestamp of when the device fleet was last updated.
+ *The description of the vendor from the Amazon Marketplace.
* @public */ - LastModifiedTime?: Date | undefined; + MarketplaceDescription?: string | undefined; + + /** + *Marketplace product listing ID.
+ * @public + */ + ListingId?: string | undefined; } /** - *Status of devices.
* @public */ -export interface DeviceStats { +export interface DescribeSubscribedWorkteamResponse { /** - *The number of devices connected with a heartbeat.
+ *A Workteam instance that contains information about the work team.
The number of registered devices.
+ *The name of the training job.
* @public */ - RegisteredDeviceCount: number | undefined; + TrainingJobName: string | undefined; } /** - *Summary of model on edge device.
+ *The name, value, and date and time of a metric that was emitted to Amazon CloudWatch.
* @public */ -export interface EdgeModelSummary { +export interface MetricData { /** - *The name of the model.
+ *The name of the metric.
* @public */ - ModelName: string | undefined; + MetricName?: string | undefined; /** - *The version model.
+ *The value of the metric.
* @public */ - ModelVersion: string | undefined; + Value?: number | undefined; + + /** + *The date and time that the algorithm emitted the metric.
+ * @public + */ + Timestamp?: Date | undefined; } /** - *Summary of the device.
+ *Information about the status of the rule evaluation.
* @public */ -export interface DeviceSummary { +export interface ProfilerRuleEvaluationStatus { /** - *The unique identifier of the device.
+ *The name of the rule configuration.
* @public */ - DeviceName: string | undefined; + RuleConfigurationName?: string | undefined; /** - *Amazon Resource Name (ARN) of the device.
+ *The Amazon Resource Name (ARN) of the rule evaluation job.
* @public */ - DeviceArn: string | undefined; + RuleEvaluationJobArn?: string | undefined; /** - *A description of the device.
+ *Status of the rule evaluation.
* @public */ - Description?: string | undefined; + RuleEvaluationStatus?: RuleEvaluationStatus | undefined; /** - *The name of the fleet the device belongs to.
+ *Details from the rule evaluation.
* @public */ - DeviceFleetName?: string | undefined; + StatusDetails?: string | undefined; /** - *The Amazon Web Services Internet of Things (IoT) object thing name associated with the device..
+ *Timestamp when the rule evaluation status was last modified.
* @public */ - IotThingName?: string | undefined; + LastModifiedTime?: Date | undefined; +} + +/** + * @public + * @enum + */ +export const ProfilingStatus = { + DISABLED: "Disabled", + ENABLED: "Enabled", +} as const; + +/** + * @public + */ +export type ProfilingStatus = (typeof ProfilingStatus)[keyof typeof ProfilingStatus]; + +/** + * @public + * @enum + */ +export const SecondaryStatus = { + COMPLETED: "Completed", + DOWNLOADING: "Downloading", + DOWNLOADING_TRAINING_IMAGE: "DownloadingTrainingImage", + FAILED: "Failed", + INTERRUPTED: "Interrupted", + LAUNCHING_ML_INSTANCES: "LaunchingMLInstances", + MAX_RUNTIME_EXCEEDED: "MaxRuntimeExceeded", + MAX_WAIT_TIME_EXCEEDED: "MaxWaitTimeExceeded", + PENDING: "Pending", + PREPARING_TRAINING_STACK: "PreparingTrainingStack", + RESTARTING: "Restarting", + STARTING: "Starting", + STOPPED: "Stopped", + STOPPING: "Stopping", + TRAINING: "Training", + UPDATING: "Updating", + UPLOADING: "Uploading", +} as const; +/** + * @public + */ +export type SecondaryStatus = (typeof SecondaryStatus)[keyof typeof SecondaryStatus]; + +/** + *An array element of SecondaryStatusTransitions for DescribeTrainingJob. It provides additional details about a status that the
+ * training job has transitioned through. A training job can be in one of several states,
+ * for example, starting, downloading, training, or uploading. Within each state, there are
+ * a number of intermediate states. For example, within the starting state, SageMaker could be
+ * starting the training job or launching the ML instances. These transitional states are
+ * referred to as the job's secondary
+ * status.
+ *
The timestamp of the last registration or de-reregistration.
+ *Contains a secondary status information from a training + * job.
+ *Status might be one of the following secondary statuses:
+ *
+ * Starting
+ * - Starting the training job.
+ * Downloading - An optional stage for algorithms that
+ * support File training input mode. It indicates that
+ * data is being downloaded to the ML storage volumes.
+ * Training - Training is in progress.
+ * Uploading - Training is complete and the model
+ * artifacts are being uploaded to the S3 location.
+ * Completed - The training job has completed.
+ * Failed - The training job has failed. The reason for
+ * the failure is returned in the FailureReason field of
+ * DescribeTrainingJobResponse.
+ * MaxRuntimeExceeded - The job stopped because it
+ * exceeded the maximum allowed runtime.
+ * Stopped - The training job has stopped.
+ * Stopping - Stopping the training job.
We no longer support the following secondary statuses:
+ *
+ * LaunchingMLInstances
+ *
+ * PreparingTrainingStack
+ *
+ * DownloadingTrainingImage
+ *
The last heartbeat received from the device.
+ *A timestamp that shows when the training job transitioned to the current secondary + * status state.
* @public */ - LatestHeartbeat?: Date | undefined; + StartTime: Date | undefined; /** - *Models on the device.
+ *A timestamp that shows when the training job transitioned out of this secondary status + * state into another secondary status state or when the training job has ended.
* @public */ - Models?: EdgeModelSummary[] | undefined; + EndTime?: Date | undefined; /** - *Edge Manager agent version.
+ *A detailed description of the progress within a secondary status. + *
+ *SageMaker provides secondary statuses and status messages that apply to each of + * them:
+ *Starting the training job.
+ *Launching requested ML + * instances.
+ *Insufficient + * capacity error from EC2 while launching instances, + * retrying!
+ *Launched + * instance was unhealthy, replacing it!
+ *Preparing the instances for training.
+ *Training + * image download completed. Training in + * progress.
+ *Status messages are subject to change. Therefore, we recommend not including them + * in code that programmatically initiates actions. For examples, don't use status + * messages in if statements.
+ *To have an overview of your training job's progress, view
+ * TrainingJobStatus and SecondaryStatus in DescribeTrainingJob, and StatusMessage together. For example,
+ * at the start of a training job, you might see the following:
+ * TrainingJobStatus - InProgress
+ * SecondaryStatus - Training
+ * StatusMessage - Downloading the training image
Status and billing information about the warm pool.
* @public */ -export interface DisassociateTrialComponentRequest { - /** - *The name of the component to disassociate from the trial.
- * @public - */ - TrialComponentName: string | undefined; - +export interface WarmPoolStatus { /** - *The name of the trial to disassociate from.
+ *The status of the warm pool.
+ *
+ * InUse: The warm pool is in use for the training job.
+ * Available: The warm pool is available to reuse for a matching
+ * training job.
+ * Reused: The warm pool moved to a matching training job for
+ * reuse.
+ * Terminated: The warm pool is no longer available. Warm pools are
+ * unavailable if they are terminated by a user, terminated for a patch update, or
+ * terminated for exceeding the specified
+ * KeepAlivePeriodInSeconds.
The Amazon Resource Name (ARN) of the trial component.
+ *The billable time in seconds used by the warm pool. Billable time refers to the + * absolute wall-clock time.
+ *Multiply ResourceRetainedBillableTimeInSeconds by the number of instances
+ * (InstanceCount) in your training cluster to get the total compute time
+ * SageMaker bills you if you run warm pool training. The formula is as follows:
+ * ResourceRetainedBillableTimeInSeconds * InstanceCount.
The Amazon Resource Name (ARN) of the trial.
+ *The name of the matching training job that reused the warm pool.
* @public */ - TrialArn?: string | undefined; + ReusedByJob?: string | undefined; } /** - *The domain's details.
* @public */ -export interface DomainDetails { - /** - *The domain's Amazon Resource Name (ARN).
- * @public - */ - DomainArn?: string | undefined; - - /** - *The domain ID.
- * @public - */ - DomainId?: string | undefined; - - /** - *The domain name.
- * @public - */ - DomainName?: string | undefined; - - /** - *The status.
- * @public - */ - Status?: DomainStatus | undefined; - - /** - *The creation time.
- * @public - */ - CreationTime?: Date | undefined; - - /** - *The last modified time.
- * @public - */ - LastModifiedTime?: Date | undefined; - +export interface DescribeTrainingJobResponse { /** - *The domain's URL.
+ *Name of the model training job.
* @public */ - Url?: string | undefined; -} + TrainingJobName: string | undefined; -/** - *A collection of settings that update the current configuration for the
- * RStudioServerPro Domain-level app.
The execution role for the RStudioServerPro Domain-level app.
The Amazon Resource Name (ARN) of the training job.
* @public */ - DomainExecutionRoleArn: string | undefined; + TrainingJobArn: string | undefined; /** - *Specifies the ARN's of a SageMaker image and SageMaker image version, and the instance type that - * the version runs on.
+ *The Amazon Resource Name (ARN) of the associated hyperparameter tuning job if the + * training job was launched by a hyperparameter tuning job.
* @public */ - DefaultResourceSpec?: ResourceSpec | undefined; + TuningJobArn?: string | undefined; /** - *A URL pointing to an RStudio Connect server.
+ *The Amazon Resource Name (ARN) of the SageMaker Ground Truth labeling job that created the + * transform or training job.
* @public */ - RStudioConnectUrl?: string | undefined; + LabelingJobArn?: string | undefined; /** - *A URL pointing to an RStudio Package Manager server.
+ *The Amazon Resource Name (ARN) of an AutoML job.
* @public */ - RStudioPackageManagerUrl?: string | undefined; -} + AutoMLJobArn?: string | undefined; -/** - *A collection of Domain configuration settings to update.
A collection of RStudioServerPro Domain-level app settings to update. A
- * single RStudioServerPro application is created for a domain.
Information about the Amazon S3 location that is configured for storing model artifacts. + *
* @public */ - RStudioServerProDomainSettingsForUpdate?: RStudioServerProDomainSettingsForUpdate | undefined; + ModelArtifacts: ModelArtifacts | undefined; /** - *The configuration for attaching a SageMaker user profile name to the execution
- * role as a sts:SourceIdentity key. This configuration can only be modified if there are no
- * apps in the InService or Pending state.
The status of the training job.
+ *SageMaker provides the following training job statuses:
+ *
+ * InProgress - The training is in progress.
+ * Completed - The training job has completed.
+ * Failed - The training job has failed. To see the reason for the
+ * failure, see the FailureReason field in the response to a
+ * DescribeTrainingJobResponse call.
+ * Stopping - The training job is stopping.
+ * Stopped - The training job has stopped.
For more detailed information, see SecondaryStatus.
The security groups for the Amazon Virtual Private Cloud that the Domain uses for
- * communication between Domain-level apps and user apps.
Provides detailed information about the state of the training job. For detailed
+ * information on the secondary status of the training job, see StatusMessage
+ * under SecondaryStatusTransition.
SageMaker provides primary statuses and secondary statuses that apply to each of + * them:
+ *
+ * Starting
+ * - Starting the training job.
+ * Downloading - An optional stage for algorithms that
+ * support File training input mode. It indicates that
+ * data is being downloaded to the ML storage volumes.
+ * Training - Training is in progress.
+ * Interrupted - The job stopped because the managed
+ * spot training instances were interrupted.
+ * Uploading - Training is complete and the model
+ * artifacts are being uploaded to the S3 location.
+ * Completed - The training job has completed.
+ * Failed - The training job has failed. The reason for
+ * the failure is returned in the FailureReason field of
+ * DescribeTrainingJobResponse.
+ * MaxRuntimeExceeded - The job stopped because it
+ * exceeded the maximum allowed runtime.
+ * MaxWaitTimeExceeded - The job stopped because it
+ * exceeded the maximum allowed wait time.
+ * Stopped - The training job has stopped.
+ * Stopping - Stopping the training job.
Valid values for SecondaryStatus are subject to change.
We no longer support the following secondary statuses:
+ *
+ * LaunchingMLInstances
+ *
+ * PreparingTraining
+ *
+ * DownloadingTrainingImage
+ *
A collection of settings that configure the domain's Docker interaction.
+ *If the training job failed, the reason it failed.
* @public */ - DockerSettings?: DockerSettings | undefined; + FailureReason?: string | undefined; /** - *A collection of settings that configure the Amazon Q experience within the domain.
+ *Algorithm-specific parameters.
* @public */ - AmazonQSettings?: AmazonQSettings | undefined; -} + HyperParameters?: RecordA specification for a predefined metric.
- * @public - */ -export interface PredefinedMetricSpecification { /** - *The metric type. You can only apply SageMaker metric types to SageMaker endpoints.
+ *Information about the algorithm used for training, and algorithm metadata. + *
* @public */ - PredefinedMetricType?: string | undefined; -} - -/** - *An object containing information about a metric.
- * @public - */ -export type MetricSpecification = - | MetricSpecification.CustomizedMember - | MetricSpecification.PredefinedMember - | MetricSpecification.$UnknownMember; + AlgorithmSpecification: AlgorithmSpecification | undefined; -/** - * @public - */ -export namespace MetricSpecification { /** - *Information about a predefined metric.
+ *The Amazon Web Services Identity and Access Management (IAM) role configured for + * the training job.
* @public */ - export interface PredefinedMember { - Predefined: PredefinedMetricSpecification; - Customized?: never; - $unknown?: never; - } + RoleArn?: string | undefined; /** - *Information about a customized metric.
+ *An array of Channel objects that describes each data input channel.
+ *
The S3 path where model artifacts that you configured when creating the job are + * stored. SageMaker creates subfolders for model artifacts.
* @public */ - export interface $UnknownMember { - Predefined?: never; - Customized?: never; - $unknown: [string, any]; - } - - export interface VisitorResources, including ML compute instances and ML storage volumes, that are + * configured for model training.
+ * @public + */ + ResourceConfig: ResourceConfig | undefined; -/** - *A target tracking scaling policy. Includes support for predefined or customized metrics.
- *When using the PutScalingPolicy API,
- * this parameter is required when you are creating a policy with the policy type TargetTrackingScaling.
An object containing information about a metric.
+ *The status of the warm pool associated with the training job.
* @public */ - MetricSpecification?: MetricSpecification | undefined; + WarmPoolStatus?: WarmPoolStatus | undefined; /** - *The recommended target value to specify for the metric when creating a scaling policy.
+ *A VpcConfig object that specifies the VPC that this training job has access + * to. For more information, see Protect Training Jobs by Using an Amazon + * Virtual Private Cloud.
* @public */ - TargetValue?: number | undefined; -} + VpcConfig?: VpcConfig | undefined; -/** - *An object containing a recommended scaling policy.
- * @public - */ -export type ScalingPolicy = ScalingPolicy.TargetTrackingMember | ScalingPolicy.$UnknownMember; + /** + *Specifies a limit to how long a model training job can run. It also specifies how long + * a managed Spot training job has to complete. When the job reaches the time limit, SageMaker + * ends the training job. Use this API to cap model training costs.
+ *To stop a job, SageMaker sends the algorithm the SIGTERM signal, which delays
+ * job termination for 120 seconds. Algorithms can use this 120-second window to save the
+ * model artifacts, so the results of training are not lost.
A target tracking scaling policy. Includes support for predefined or customized metrics.
+ *A timestamp that indicates when the training job was created.
* @public */ - export interface TargetTrackingMember { - TargetTracking: TargetTrackingScalingPolicyConfiguration; - $unknown?: never; - } + CreationTime: Date | undefined; /** + *Indicates the time when the training job starts on training instances. You are
+ * billed for the time interval between this time and the value of
+ * TrainingEndTime. The start time in CloudWatch Logs might be later than this time.
+ * The difference is due to the time it takes to download the training data and to the size
+ * of the training container.
Indicates the time when the training job ends on training instances. You are billed
+ * for the time interval between the value of TrainingStartTime and this time.
+ * For successful jobs and stopped jobs, this is the time after model artifacts are
+ * uploaded. For failed jobs, this is the time when SageMaker detects a job failure.
A timestamp that indicates when the status of the training job was last + * modified.
+ * @public + */ + LastModifiedTime?: Date | undefined; -/** - *An object with the recommended values for you to specify when creating an autoscaling policy.
- * @public - */ -export interface DynamicScalingConfiguration { /** - *The recommended minimum capacity to specify for your autoscaling policy.
+ *A history of all of the secondary statuses that the training job has transitioned + * through.
* @public */ - MinCapacity?: number | undefined; + SecondaryStatusTransitions?: SecondaryStatusTransition[] | undefined; /** - *The recommended maximum capacity to specify for your autoscaling policy.
+ *A collection of MetricData objects that specify the names, values, and
+ * dates and times that the training algorithm emitted to Amazon CloudWatch.
The recommended scale in cooldown time for your autoscaling policy.
+ *If you want to allow inbound or outbound network calls, except for calls between peers
+ * within a training cluster for distributed training, choose True. If you
+ * enable network isolation for training jobs that are configured to use a VPC, SageMaker
+ * downloads and uploads customer data and model artifacts through the specified VPC, but
+ * the training container does not have network access.
The recommended scale out cooldown time for your autoscaling policy.
+ *To encrypt all communications between ML compute instances in distributed training,
+ * choose True. Encryption provides greater security for distributed training,
+ * but training might take longer. How long it takes depends on the amount of communication
+ * between compute instances, especially if you use a deep learning algorithms in
+ * distributed training.
An object of the scaling policies for each metric.
+ *A Boolean indicating whether managed spot training is enabled (True) or
+ * not (False).
A directed edge connecting two lineage entities.
- * @public - */ -export interface Edge { /** - *The Amazon Resource Name (ARN) of the source lineage entity of the directed edge.
+ *Contains information about the output location for managed spot training checkpoint + * data.
* @public */ - SourceArn?: string | undefined; + CheckpointConfig?: CheckpointConfig | undefined; /** - *The Amazon Resource Name (ARN) of the destination lineage entity of the directed edge.
+ *The training time in seconds.
* @public */ - DestinationArn?: string | undefined; + TrainingTimeInSeconds?: number | undefined; /** - *The type of the Association(Edge) between the source and destination. For example ContributedTo,
- * Produced, or DerivedFrom.
The billable time in seconds. Billable time refers to the absolute wall-clock + * time.
+ *Multiply BillableTimeInSeconds by the number of instances
+ * (InstanceCount) in your training cluster to get the total compute time
+ * SageMaker bills you if you run distributed training. The formula is as follows:
+ * BillableTimeInSeconds * InstanceCount .
You can calculate the savings from using managed spot training using the formula
+ * (1 - BillableTimeInSeconds / TrainingTimeInSeconds) * 100. For example,
+ * if BillableTimeInSeconds is 100 and TrainingTimeInSeconds is
+ * 500, the savings is 80%.
Contains information summarizing an edge deployment plan.
- * @public - */ -export interface EdgeDeploymentPlanSummary { /** - *The ARN of the edge deployment plan.
+ *Configuration information for the Amazon SageMaker Debugger hook parameters, metric and tensor collections, and
+ * storage paths. To learn more about
+ * how to configure the DebugHookConfig parameter,
+ * see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.
The name of the edge deployment plan.
+ *Associates a SageMaker job as a trial component with an experiment and trial. Specified when + * you call the following APIs:
+ *+ * CreateProcessingJob + *
+ *+ * CreateTrainingJob + *
+ *+ * CreateTransformJob + *
+ *The name of the device fleet used for the deployment.
+ *Configuration information for Amazon SageMaker Debugger rules for debugging output tensors.
* @public */ - DeviceFleetName: string | undefined; + DebugRuleConfigurations?: DebugRuleConfiguration[] | undefined; /** - *The number of edge devices with the successful deployment.
+ *Configuration of storage locations for the Amazon SageMaker Debugger TensorBoard output data.
* @public */ - EdgeDeploymentSuccess: number | undefined; + TensorBoardOutputConfig?: TensorBoardOutputConfig | undefined; /** - *The number of edge devices yet to pick up the deployment, or in progress.
+ *Evaluation status of Amazon SageMaker Debugger rules for debugging on a training job.
* @public */ - EdgeDeploymentPending: number | undefined; + DebugRuleEvaluationStatuses?: DebugRuleEvaluationStatus[] | undefined; /** - *The number of edge devices that failed the deployment.
+ *Configuration information for Amazon SageMaker Debugger system monitoring, framework profiling, and + * storage paths.
* @public */ - EdgeDeploymentFailed: number | undefined; + ProfilerConfig?: ProfilerConfig | undefined; /** - *The time when the edge deployment plan was created.
+ *Configuration information for Amazon SageMaker Debugger rules for profiling system and framework + * metrics.
* @public */ - CreationTime?: Date | undefined; + ProfilerRuleConfigurations?: ProfilerRuleConfiguration[] | undefined; /** - *The time when the edge deployment plan was last updated.
+ *Evaluation status of Amazon SageMaker Debugger rules for profiling on a training job.
* @public */ - LastModifiedTime?: Date | undefined; -} + ProfilerRuleEvaluationStatuses?: ProfilerRuleEvaluationStatus[] | undefined; -/** - *Status of edge devices with this model.
- * @public - */ -export interface EdgeModelStat { /** - *The name of the model.
+ *Profiling status of a training job.
* @public */ - ModelName: string | undefined; + ProfilingStatus?: ProfilingStatus | undefined; /** - *The model version.
+ *The environment variables to set in the Docker container.
* @public */ - ModelVersion: string | undefined; + Environment?: RecordThe number of devices that have this model version and do not have a heart beat.
+ *The number of times to retry the job when the job fails due to an
+ * InternalServerError.
The number of devices that have this model version and have a heart beat.
+ *Configuration for remote debugging. To learn more about the remote debugging + * functionality of SageMaker, see Access a training container + * through Amazon Web Services Systems Manager (SSM) for remote + * debugging.
* @public */ - ConnectedDeviceCount: number | undefined; + RemoteDebugConfig?: RemoteDebugConfig | undefined; /** - *The number of devices that have this model version, a heart beat, and are currently running.
+ *Contains information about the infrastructure health check configuration for the training job.
* @public */ - ActiveDeviceCount: number | undefined; + InfraCheckConfig?: InfraCheckConfig | undefined; +} +/** + * @public + */ +export interface DescribeTrainingPlanRequest { /** - *The number of devices with this model version and are producing sample data.
+ *The name of the training plan to describe.
* @public */ - SamplingDeviceCount: number | undefined; + TrainingPlanName: string | undefined; } /** - *Summary of edge packaging job.
+ * @public + * @enum + */ +export const ReservedCapacityInstanceType = { + ML_P4D_24XLARGE: "ml.p4d.24xlarge", + ML_P5EN_48XLARGE: "ml.p5en.48xlarge", + ML_P5E_48XLARGE: "ml.p5e.48xlarge", + ML_P5_48XLARGE: "ml.p5.48xlarge", + ML_TRN2_48XLARGE: "ml.trn2.48xlarge", +} as const; + +/** + * @public + */ +export type ReservedCapacityInstanceType = + (typeof ReservedCapacityInstanceType)[keyof typeof ReservedCapacityInstanceType]; + +/** + * @public + * @enum + */ +export const ReservedCapacityStatus = { + ACTIVE: "Active", + EXPIRED: "Expired", + FAILED: "Failed", + PENDING: "Pending", + SCHEDULED: "Scheduled", +} as const; + +/** + * @public + */ +export type ReservedCapacityStatus = (typeof ReservedCapacityStatus)[keyof typeof ReservedCapacityStatus]; + +/** + *Details of a reserved capacity for the training plan.
+ *For more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using
+ * Amazon SageMaker Training Plan, see
+ * CreateTrainingPlan
+ * .
The Amazon Resource Name (ARN) of the edge packaging job.
+ *The Amazon Resource Name (ARN); of the reserved capacity.
* @public */ - EdgePackagingJobArn: string | undefined; + ReservedCapacityArn: string | undefined; /** - *The name of the edge packaging job.
+ *The instance type for the reserved capacity.
* @public */ - EdgePackagingJobName: string | undefined; + InstanceType: ReservedCapacityInstanceType | undefined; /** - *The status of the edge packaging job.
+ *The total number of instances in the reserved capacity.
* @public */ - EdgePackagingJobStatus: EdgePackagingJobStatus | undefined; + TotalInstanceCount: number | undefined; /** - *The name of the SageMaker Neo compilation job.
+ *The current status of the reserved capacity.
* @public */ - CompilationJobName?: string | undefined; + Status: ReservedCapacityStatus | undefined; /** - *The name of the model.
+ *The availability zone for the reserved capacity.
* @public */ - ModelName?: string | undefined; + AvailabilityZone?: string | undefined; /** - *The version of the model.
+ *The number of whole hours in the total duration for this reserved capacity.
* @public */ - ModelVersion?: string | undefined; + DurationHours?: number | undefined; /** - *The timestamp of when the job was created.
+ *The additional minutes beyond whole hours in the total duration for this reserved + * capacity.
* @public */ - CreationTime?: Date | undefined; + DurationMinutes?: number | undefined; /** - *The timestamp of when the edge packaging job was last updated.
+ *The start time of the reserved capacity.
* @public */ - LastModifiedTime?: Date | undefined; + StartTime?: Date | undefined; + + /** + *The end time of the reserved capacity.
+ * @public + */ + EndTime?: Date | undefined; } /** - *The configurations and outcomes of an Amazon EMR step execution.
* @public + * @enum */ -export interface EMRStepMetadata { +export const TrainingPlanStatus = { + ACTIVE: "Active", + EXPIRED: "Expired", + FAILED: "Failed", + PENDING: "Pending", + SCHEDULED: "Scheduled", +} as const; + +/** + * @public + */ +export type TrainingPlanStatus = (typeof TrainingPlanStatus)[keyof typeof TrainingPlanStatus]; + +/** + * @public + * @enum + */ +export const SageMakerResourceName = { + HYPERPOD_CLUSTER: "hyperpod-cluster", + TRAINING_JOB: "training-job", +} as const; + +/** + * @public + */ +export type SageMakerResourceName = (typeof SageMakerResourceName)[keyof typeof SageMakerResourceName]; + +/** + * @public + */ +export interface DescribeTrainingPlanResponse { /** - *The identifier of the EMR cluster.
+ *The Amazon Resource Name (ARN); of the training plan.
* @public */ - ClusterId?: string | undefined; + TrainingPlanArn: string | undefined; /** - *The identifier of the EMR cluster step.
+ *The name of the training plan.
* @public */ - StepId?: string | undefined; + TrainingPlanName: string | undefined; /** - *The name of the EMR cluster step.
+ *The current status of the training plan (e.g., Pending, Active, Expired). To see the
+ * complete list of status values available for a training plan, refer to the
+ * Status attribute within the
+ * TrainingPlanSummary
+ * object.
The path to the log file where the cluster step's failure root cause - * is recorded.
+ *A message providing additional information about the current status of the training + * plan.
* @public */ - LogFilePath?: string | undefined; -} - -/** - * @public - */ -export interface EnableSagemakerServicecatalogPortfolioInput {} - -/** - * @public - */ -export interface EnableSagemakerServicecatalogPortfolioOutput {} + StatusMessage?: string | undefined; -/** - *A schedule for a model monitoring job. For information about model monitor, see - * Amazon SageMaker Model - * Monitor.
- * @public - */ -export interface MonitoringSchedule { /** - *The Amazon Resource Name (ARN) of the monitoring schedule.
+ *The number of whole hours in the total duration for this training plan.
* @public */ - MonitoringScheduleArn?: string | undefined; + DurationHours?: number | undefined; /** - *The name of the monitoring schedule.
+ *The additional minutes beyond whole hours in the total duration for this training + * plan.
* @public */ - MonitoringScheduleName?: string | undefined; + DurationMinutes?: number | undefined; /** - *The status of the monitoring schedule. This can be one of the following values.
- *
- * PENDING - The schedule is pending being created.
- * FAILED - The schedule failed.
- * SCHEDULED - The schedule was successfully created.
- * STOPPED - The schedule was stopped.
The start time of the training plan.
* @public */ - MonitoringScheduleStatus?: ScheduleStatus | undefined; + StartTime?: Date | undefined; /** - *The type of the monitoring job definition to schedule.
+ *The end time of the training plan.
* @public */ - MonitoringType?: MonitoringType | undefined; + EndTime?: Date | undefined; /** - *If the monitoring schedule failed, the reason it failed.
+ *The upfront fee for the training plan.
* @public */ - FailureReason?: string | undefined; + UpfrontFee?: string | undefined; /** - *The time that the monitoring schedule was created.
+ *The currency code for the upfront fee (e.g., USD).
* @public */ - CreationTime?: Date | undefined; + CurrencyCode?: string | undefined; /** - *The last time the monitoring schedule was changed.
+ *The total number of instances reserved in this training plan.
* @public */ - LastModifiedTime?: Date | undefined; + TotalInstanceCount?: number | undefined; /** - *Configures the monitoring schedule and defines the monitoring job.
+ *The number of instances currently available for use in this training plan.
* @public */ - MonitoringScheduleConfig?: MonitoringScheduleConfig | undefined; + AvailableInstanceCount?: number | undefined; /** - *The endpoint that hosts the model being monitored.
+ *The number of instances currently in use from this training plan.
* @public */ - EndpointName?: string | undefined; + InUseInstanceCount?: number | undefined; /** - *Summary of information about the last monitoring job to run.
+ *The target resources (e.g., SageMaker Training Jobs, SageMaker HyperPod) that can use this training + * plan.
+ *Training plans are specific to their target resource.
+ *A training plan designed for SageMaker training jobs can only be used to schedule and + * run training jobs.
+ *A training plan for HyperPod clusters can be used exclusively to provide + * compute resources to a cluster's instance group.
+ *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 list of Reserved Capacity providing the underlying compute resources of the plan. + *
* @public */ - Tags?: Tag[] | undefined; + ReservedCapacitySummaries?: ReservedCapacitySummary[] | undefined; } /** - *A hosted endpoint for real-time inference.
* @public */ -export interface Endpoint { +export interface DescribeTransformJobRequest { /** - *The name of the endpoint.
+ *The name of the transform job that you want to view details of.
* @public */ - EndpointName: string | undefined; + TransformJobName: string | undefined; +} + +/** + * @public + * @enum + */ +export const TransformJobStatus = { + COMPLETED: "Completed", + FAILED: "Failed", + IN_PROGRESS: "InProgress", + STOPPED: "Stopped", + STOPPING: "Stopping", +} as const; + +/** + * @public + */ +export type TransformJobStatus = (typeof TransformJobStatus)[keyof typeof TransformJobStatus]; +/** + * @public + */ +export interface DescribeTransformJobResponse { /** - *The Amazon Resource Name (ARN) of the endpoint.
+ *The name of the transform job.
* @public */ - EndpointArn: string | undefined; + TransformJobName: string | undefined; /** - *The endpoint configuration associated with the endpoint.
+ *The Amazon Resource Name (ARN) of the transform job.
* @public */ - EndpointConfigName: string | undefined; + TransformJobArn: string | undefined; /** - *A list of the production variants hosted on the endpoint. Each production variant is a - * model.
+ *The
+ * status of the transform job. If the transform job failed, the reason
+ * is returned in the FailureReason field.
The currently active data capture configuration used by your Endpoint.
+ *If the transform job failed, FailureReason describes
+ * why
+ * it failed. A transform job creates a log file, which includes error
+ * messages, and stores it
+ * as
+ * an Amazon S3 object. For more information, see Log Amazon SageMaker Events with
+ * Amazon CloudWatch.
The status of the endpoint.
+ *The name of the model used in the transform job.
* @public */ - EndpointStatus: EndpointStatus | undefined; + ModelName: string | undefined; /** - *If the endpoint failed, the reason it failed.
+ *The + * maximum number + * of + * parallel requests on each instance node + * that can be launched in a transform job. The default value is 1.
* @public */ - FailureReason?: string | undefined; + MaxConcurrentTransforms?: number | undefined; /** - *The time that the endpoint was created.
+ *The timeout and maximum number of retries for processing a transform job + * invocation.
* @public */ - CreationTime: Date | undefined; + ModelClientConfig?: ModelClientConfig | undefined; /** - *The last time the endpoint was modified.
+ *The + * maximum + * payload size, in MB, used in the + * transform job.
* @public */ - LastModifiedTime: Date | undefined; + MaxPayloadInMB?: number | undefined; /** - *A list of monitoring schedules for the endpoint. For information about model - * monitoring, see Amazon SageMaker Model Monitor.
+ *Specifies the number of records to include in a mini-batch for an HTTP inference + * request. + * A record + * is a single unit of input data that inference + * can be made on. For example, a single line in a CSV file is a record.
+ *To enable the batch strategy, you must set SplitType
+ * to
+ * Line, RecordIO, or
+ * TFRecord.
A list of the tags associated with the endpoint. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General - * Reference Guide.
+ *The + * environment variables to set in the Docker container. We support up to 16 key and values + * entries in the map.
* @public */ - Tags?: Tag[] | undefined; + Environment?: RecordA list of the shadow variants hosted on the endpoint. Each shadow variant is a model - * in shadow mode with production traffic replicated from the production variant.
+ *Describes the dataset to be transformed and the Amazon S3 location where it is + * stored.
* @public - */ - ShadowProductionVariants?: ProductionVariantSummary[] | undefined; -} - -/** - * @public - * @enum - */ -export const EndpointConfigSortKey = { - CreationTime: "CreationTime", - Name: "Name", -} as const; - -/** - * @public - */ -export type EndpointConfigSortKey = (typeof EndpointConfigSortKey)[keyof typeof EndpointConfigSortKey]; - -/** - *Metadata for an endpoint configuration step.
- * @public - */ -export interface EndpointConfigStepMetadata { + */ + TransformInput: TransformInput | undefined; + /** - *The Amazon Resource Name (ARN) of the endpoint configuration used in the step.
+ *Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the + * transform job.
* @public */ - Arn?: string | undefined; -} + TransformOutput?: TransformOutput | undefined; -/** - *Provides summary information for an endpoint configuration.
- * @public - */ -export interface EndpointConfigSummary { /** - *The name of the endpoint configuration.
+ *Configuration to control how SageMaker captures inference data.
* @public */ - EndpointConfigName: string | undefined; + DataCaptureConfig?: BatchDataCaptureConfig | undefined; /** - *The Amazon Resource Name (ARN) of the endpoint configuration.
+ *Describes + * the resources, including ML instance types and ML instance count, to + * use for the transform job.
* @public */ - EndpointConfigArn: string | undefined; + TransformResources: TransformResources | undefined; /** - *A timestamp that shows when the endpoint configuration was created.
+ *A timestamp that shows when the transform Job was created.
* @public */ CreationTime: Date | undefined; -} - -/** - * @public - * @enum - */ -export const EndpointSortKey = { - CreationTime: "CreationTime", - Name: "Name", - Status: "Status", -} as const; - -/** - * @public - */ -export type EndpointSortKey = (typeof EndpointSortKey)[keyof typeof EndpointSortKey]; -/** - *Metadata for an endpoint step.
- * @public - */ -export interface EndpointStepMetadata { /** - *The Amazon Resource Name (ARN) of the endpoint in the step.
+ *Indicates when the transform job starts
+ * on
+ * ML instances. You are billed for the time interval between this time
+ * and the value of TransformEndTime.
Provides summary information for an endpoint.
- * @public - */ -export interface EndpointSummary { /** - *The name of the endpoint.
+ *Indicates when the transform job has been
+ *
+ * completed, or has stopped or failed. You are billed for the time
+ * interval between this time and the value of TransformStartTime.
The Amazon Resource Name (ARN) of the endpoint.
+ *The Amazon Resource Name (ARN) of the Amazon SageMaker Ground Truth labeling job that created the + * transform or training job.
* @public */ - EndpointArn: string | undefined; + LabelingJobArn?: string | undefined; /** - *A timestamp that shows when the endpoint was created.
+ *The Amazon Resource Name (ARN) of the AutoML transform job.
* @public */ - CreationTime: Date | undefined; + AutoMLJobArn?: string | undefined; /** - *A timestamp that shows when the endpoint was last modified.
+ *The data structure used to specify the data to be used for inference in a batch + * transform job and to associate the data that is relevant to the prediction results in + * the output. The input filter provided allows you to exclude input data that is not + * needed for inference in a batch transform job. The output filter provided allows you to + * include input data relevant to interpreting the predictions in the output from the job. + * For more information, see Associate Prediction + * Results with their Corresponding Input Records.
* @public */ - LastModifiedTime: Date | undefined; + DataProcessing?: DataProcessing | undefined; /** - *The status of the endpoint.
+ *Associates a SageMaker job as a trial component with an experiment and trial. Specified when + * you call the following APIs:
*
- * OutOfService: Endpoint is not available to take incoming
- * requests.
- * Creating: CreateEndpoint is executing.
- * Updating: UpdateEndpoint or UpdateEndpointWeightsAndCapacities is executing.
- * SystemUpdating: Endpoint is undergoing maintenance and cannot be
- * updated or deleted or re-scaled until it has completed. This maintenance
- * operation does not change any customer-specified values such as VPC config, KMS
- * encryption, model, instance type, or instance count.
- * RollingBack: Endpoint fails to scale up or down or change its
- * variant weight and is in the process of rolling back to its previous
- * configuration. Once the rollback completes, endpoint returns to an
- * InService status. This transitional status only applies to an
- * endpoint that has autoscaling enabled and is undergoing variant weight or
- * capacity changes as part of an UpdateEndpointWeightsAndCapacities call or when the UpdateEndpointWeightsAndCapacities operation is called
- * explicitly.
- * InService: Endpoint is available to process incoming
- * requests.
- * Deleting: DeleteEndpoint is executing.
- * Failed: Endpoint could not be created, updated, or re-scaled. Use
- * DescribeEndpointOutput$FailureReason for information about the
- * failure. DeleteEndpoint is the only operation that can be performed on a
- * failed endpoint.
To get a list of endpoints with a specified status, use the StatusEquals
- * filter with a call to ListEndpoints.
The properties of an experiment as returned by the Search API.
* @public */ -export interface Experiment { +export interface DescribeTrialRequest { /** - *The name of the experiment.
+ *The name of the trial to describe.
* @public */ - ExperimentName?: string | undefined; + TrialName: string | undefined; +} +/** + *The source of the trial.
+ * @public + */ +export interface TrialSource { /** - *The Amazon Resource Name (ARN) of the experiment.
+ *The Amazon Resource Name (ARN) of the source.
* @public */ - ExperimentArn?: string | undefined; + SourceArn: string | undefined; /** - *The name of the experiment as displayed. If DisplayName isn't specified,
- * ExperimentName is displayed.
The source job type.
+ * @public + */ + SourceType?: string | undefined; +} + +/** + * @public + */ +export interface DescribeTrialResponse { + /** + *The name of the trial.
+ * @public + */ + TrialName?: string | undefined; + + /** + *The Amazon Resource Name (ARN) of the trial.
+ * @public + */ + TrialArn?: string | undefined; + + /** + *The name of the trial as displayed. If DisplayName isn't specified,
+ * TrialName is displayed.
The source of the experiment.
+ *The name of the experiment the trial is part of.
* @public */ - Source?: ExperimentSource | undefined; + ExperimentName?: string | undefined; /** - *The description of the experiment.
+ *The Amazon Resource Name (ARN) of the source and, optionally, the job type.
* @public */ - Description?: string | undefined; + Source?: TrialSource | undefined; /** - *When the experiment was created.
+ *When the trial was created.
* @public */ CreationTime?: Date | undefined; /** - *Who created the experiment.
+ *Who created the trial.
* @public */ CreatedBy?: UserContext | undefined; /** - *When the experiment was last modified.
+ *When the trial was last modified.
* @public */ LastModifiedTime?: Date | undefined; /** - *Information about the user who created or modified an experiment, trial, trial - * component, lineage group, project, or model card.
+ *Who last modified the trial.
* @public */ LastModifiedBy?: UserContext | undefined; /** - *The list of tags that are associated with the experiment. You can use Search API to search on the tags.
+ *Metadata properties of the tracking entity, trial, or trial component.
* @public */ - Tags?: Tag[] | undefined; + MetadataProperties?: MetadataProperties | undefined; } /** - *A summary of the properties of an experiment. To get the complete set of properties, call
- * the DescribeExperiment API and provide the
- * ExperimentName.
The Amazon Resource Name (ARN) of the experiment.
+ *The name of the trial component to describe.
* @public */ - ExperimentArn?: string | undefined; + TrialComponentName: string | undefined; +} +/** + *A summary of the metrics of a trial component.
+ * @public + */ +export interface TrialComponentMetricSummary { /** - *The name of the experiment.
+ *The name of the metric.
* @public */ - ExperimentName?: string | undefined; + MetricName?: string | undefined; /** - *The name of the experiment as displayed. If DisplayName isn't specified,
- * ExperimentName is displayed.
The Amazon Resource Name (ARN) of the source.
* @public */ - DisplayName?: string | undefined; + SourceArn?: string | undefined; /** - *The source of the experiment.
+ *When the metric was last updated.
* @public */ - ExperimentSource?: ExperimentSource | undefined; + TimeStamp?: Date | undefined; /** - *When the experiment was created.
+ *The maximum value of the metric.
* @public */ - CreationTime?: Date | undefined; + Max?: number | undefined; + + /** + *The minimum value of the metric.
+ * @public + */ + Min?: number | undefined; + + /** + *The most recent value of the metric.
+ * @public + */ + Last?: number | undefined; + + /** + *The number of samples used to generate the metric.
+ * @public + */ + Count?: number | undefined; + + /** + *The average value of the metric.
+ * @public + */ + Avg?: number | undefined; /** - *When the experiment was last modified.
+ *The standard deviation of the metric.
* @public */ - LastModifiedTime?: Date | undefined; + StdDev?: number | undefined; } /** - *The container for the metadata for Fail step.
+ *The Amazon Resource Name (ARN) and job type of the source of a trial component.
* @public */ -export interface FailStepMetadata { +export interface TrialComponentSource { /** - *A message that you define and then is processed and rendered by - * the Fail step when the error occurs.
+ *The source Amazon Resource Name (ARN).
* @public */ - ErrorMessage?: string | undefined; + SourceArn: string | undefined; + + /** + *The source job type.
+ * @public + */ + SourceType?: string | undefined; } /** - *Amazon SageMaker Feature Store stores features in a collection called Feature Group. A - * Feature Group can be visualized as a table which has rows, with a unique identifier for - * each row where each column in the table is a feature. In principle, a Feature Group is - * composed of features and values per features.
* @public */ -export interface FeatureGroup { +export interface DescribeTrialComponentResponse { /** - *The Amazon Resource Name (ARN) of a FeatureGroup.
The name of the trial component.
* @public */ - FeatureGroupArn?: string | undefined; + TrialComponentName?: string | undefined; /** - *The name of the FeatureGroup.
The Amazon Resource Name (ARN) of the trial component.
* @public */ - FeatureGroupName?: string | undefined; + TrialComponentArn?: string | undefined; /** - *The name of the Feature whose value uniquely identifies a
- * Record defined in the FeatureGroup
- * FeatureDefinitions.
The name of the component as displayed. If DisplayName isn't specified,
+ * TrialComponentName is displayed.
The name of the feature that stores the EventTime of a Record in a
- * FeatureGroup.
A EventTime is point in time when a new event occurs that corresponds to
- * the creation or update of a Record in FeatureGroup. All
- * Records in the FeatureGroup must have a corresponding
- * EventTime.
The Amazon Resource Name (ARN) of the source and, optionally, the job type.
* @public */ - EventTimeFeatureName?: string | undefined; + Source?: TrialComponentSource | undefined; /** - *A list of Features. Each Feature must include a
- * FeatureName and a FeatureType.
Valid FeatureTypes are Integral, Fractional and
- * String.
- * FeatureNames cannot be any of the following: is_deleted,
- * write_time, api_invocation_time.
You can create up to 2,500 FeatureDefinitions per
- * FeatureGroup.
The status of the component. States include:
+ *InProgress
+ *Completed
+ *Failed
+ *The time a FeatureGroup was created.
When the component started.
+ * @public + */ + StartTime?: Date | undefined; + + /** + *When the component ended.
+ * @public + */ + EndTime?: Date | undefined; + + /** + *When the component was created.
* @public */ CreationTime?: Date | undefined; /** - *A timestamp indicating the last time you updated the feature group.
+ *Who created the trial component.
* @public */ - LastModifiedTime?: Date | undefined; + CreatedBy?: UserContext | undefined; /** - *Use this to specify the Amazon Web Services Key Management Service (KMS) Key ID, or
- * KMSKeyId, for at rest data encryption. You can turn
- * OnlineStore on or off by specifying the EnableOnlineStore flag
- * at General Assembly.
The default value is False.
When the component was last modified.
* @public */ - OnlineStoreConfig?: OnlineStoreConfig | undefined; + LastModifiedTime?: Date | undefined; /** - *The configuration of an OfflineStore.
Provide an OfflineStoreConfig in a request to
- * CreateFeatureGroup to create an OfflineStore.
To encrypt an OfflineStore using at rest data encryption, specify Amazon Web Services Key Management Service (KMS) key ID, or KMSKeyId, in
- * S3StorageConfig.
Who last modified the component.
* @public */ - OfflineStoreConfig?: OfflineStoreConfig | undefined; + LastModifiedBy?: UserContext | undefined; /** - *The Amazon Resource Name (ARN) of the IAM execution role used to create the feature - * group.
+ *The hyperparameters of the component.
* @public */ - RoleArn?: string | undefined; + Parameters?: RecordA FeatureGroup status.
The input artifacts of the component.
* @public */ - FeatureGroupStatus?: FeatureGroupStatus | undefined; + InputArtifacts?: RecordThe status of OfflineStore.
The output artifacts of the component.
* @public */ - OfflineStoreStatus?: OfflineStoreStatus | undefined; + OutputArtifacts?: RecordA value that indicates whether the feature group was updated successfully.
+ *Metadata properties of the tracking entity, trial, or trial component.
* @public */ - LastUpdateStatus?: LastUpdateStatus | undefined; + MetadataProperties?: MetadataProperties | undefined; /** - *The reason that the FeatureGroup failed to be replicated in the
- * OfflineStore. This is failure may be due to a failure to create a
- * FeatureGroup in or delete a FeatureGroup from the
- * OfflineStore.
The metrics for the component.
* @public */ - FailureReason?: string | undefined; + Metrics?: TrialComponentMetricSummary[] | undefined; /** - *A free form description of a FeatureGroup.
The Amazon Resource Name (ARN) of the lineage group.
* @public */ - Description?: string | undefined; + LineageGroupArn?: string | undefined; /** - *Tags used to define a FeatureGroup.
A list of ARNs and, if applicable, job types for multiple sources of an experiment + * run.
* @public */ - Tags?: Tag[] | undefined; + Sources?: TrialComponentSource[] | undefined; } /** * @public - * @enum */ -export const FeatureGroupSortBy = { - CREATION_TIME: "CreationTime", - FEATURE_GROUP_STATUS: "FeatureGroupStatus", - NAME: "Name", - OFFLINE_STORE_STATUS: "OfflineStoreStatus", -} as const; +export interface DescribeUserProfileRequest { + /** + *The domain ID.
+ * @public + */ + DomainId: string | undefined; -/** - * @public - */ -export type FeatureGroupSortBy = (typeof FeatureGroupSortBy)[keyof typeof FeatureGroupSortBy]; + /** + *The user profile name. This value is not case sensitive.
+ * @public + */ + UserProfileName: string | undefined; +} /** * @public * @enum */ -export const FeatureGroupSortOrder = { - ASCENDING: "Ascending", - DESCENDING: "Descending", +export const UserProfileStatus = { + Delete_Failed: "Delete_Failed", + Deleting: "Deleting", + Failed: "Failed", + InService: "InService", + Pending: "Pending", + Update_Failed: "Update_Failed", + Updating: "Updating", } as const; /** * @public */ -export type FeatureGroupSortOrder = (typeof FeatureGroupSortOrder)[keyof typeof FeatureGroupSortOrder]; +export type UserProfileStatus = (typeof UserProfileStatus)[keyof typeof UserProfileStatus]; /** - *The name, ARN, CreationTime, FeatureGroup values,
- * LastUpdatedTime and EnableOnlineStorage status of a
- * FeatureGroup.
The name of FeatureGroup.
The ID of the domain that contains the profile.
* @public */ - FeatureGroupName: string | undefined; + DomainId?: string | undefined; /** - *Unique identifier for the FeatureGroup.
The user profile Amazon Resource Name (ARN).
* @public */ - FeatureGroupArn: string | undefined; + UserProfileArn?: string | undefined; /** - *A timestamp indicating the time of creation time of the
- * FeatureGroup.
The user profile name.
* @public */ - CreationTime: Date | undefined; + UserProfileName?: string | undefined; /** - *The status of a FeatureGroup. The status can be any of the following:
- * Creating, Created, CreateFail,
- * Deleting or DetailFail.
The ID of the user's profile in the Amazon Elastic File System volume.
* @public */ - FeatureGroupStatus?: FeatureGroupStatus | undefined; + HomeEfsFileSystemUid?: string | undefined; /** - *Notifies you if replicating data into the OfflineStore has failed. Returns
- * either: Active or Blocked.
The status.
* @public */ - OfflineStoreStatus?: OfflineStoreStatus | undefined; -} + Status?: UserProfileStatus | undefined; -/** - *The metadata for a feature. It can either be metadata that you specify, or metadata that - * is updated automatically.
- * @public - */ -export interface FeatureMetadata { /** - *The Amazon Resource Number (ARN) of the feature group.
+ *The last modified time.
* @public */ - FeatureGroupArn?: string | undefined; + LastModifiedTime?: Date | undefined; /** - *The name of the feature group containing the feature.
+ *The creation time.
* @public */ - FeatureGroupName?: string | undefined; + CreationTime?: Date | undefined; + + /** + *The failure reason.
+ * @public + */ + FailureReason?: string | undefined; + + /** + *The IAM Identity Center user identifier.
+ * @public + */ + SingleSignOnUserIdentifier?: string | undefined; + + /** + *The IAM Identity Center user value.
+ * @public + */ + SingleSignOnUserValue?: string | undefined; + + /** + *A collection of settings.
+ * @public + */ + UserSettings?: UserSettings | undefined; +} + +/** + * @public + */ +export interface DescribeWorkforceRequest { + /** + *The name of the private workforce whose access you want to restrict.
+ * WorkforceName is automatically set to default when a
+ * workforce is created and cannot be modified.
Your OIDC IdP workforce configuration.
+ * @public + */ +export interface OidcConfigForResponse { /** - *The name of feature.
+ *The OIDC IdP client ID used to configure your private workforce.
* @public */ - FeatureName?: string | undefined; + ClientId?: string | undefined; /** - *The data type of the feature.
+ *The OIDC IdP issuer used to configure your private workforce.
* @public */ - FeatureType?: FeatureType | undefined; + Issuer?: string | undefined; /** - *A timestamp indicating when the feature was created.
+ *The OIDC IdP authorization endpoint used to configure your private workforce.
* @public */ - CreationTime?: Date | undefined; + AuthorizationEndpoint?: string | undefined; /** - *A timestamp indicating when the feature was last modified.
+ *The OIDC IdP token endpoint used to configure your private workforce.
* @public */ - LastModifiedTime?: Date | undefined; + TokenEndpoint?: string | undefined; /** - *An optional description that you specify to better describe the feature.
+ *The OIDC IdP user information endpoint used to configure your private workforce.
* @public */ - Description?: string | undefined; + UserInfoEndpoint?: string | undefined; /** - *Optional key-value pairs that you specify to better describe the feature.
+ *The OIDC IdP logout endpoint used to configure your private workforce.
* @public */ - Parameters?: FeatureParameter[] | undefined; -} - -/** - * @public - * @enum - */ -export const Operator = { - CONTAINS: "Contains", - EQUALS: "Equals", - EXISTS: "Exists", - GREATER_THAN: "GreaterThan", - GREATER_THAN_OR_EQUAL_TO: "GreaterThanOrEqualTo", - IN: "In", - LESS_THAN: "LessThan", - LESS_THAN_OR_EQUAL_TO: "LessThanOrEqualTo", - NOT_EQUALS: "NotEquals", - NOT_EXISTS: "NotExists", -} as const; - -/** - * @public - */ -export type Operator = (typeof Operator)[keyof typeof Operator]; + LogoutEndpoint?: string | undefined; -/** - *A conditional statement for a search expression that includes a resource property, a - * Boolean operator, and a value. Resources that match the statement are returned in the - * results from the Search API.
- *If you specify a Value, but not an Operator, SageMaker uses the
- * equals operator.
In search, there are several property types:
- *To define a metric filter, enter a value using the form
- * "Metrics., where "accuracy" metric greater than
- * "0.9":
- * \{
- *
- * "Name": "Metrics.accuracy",
- *
- * "Operator": "GreaterThan",
- *
- * "Value": "0.9"
- *
- * \}
- *
To define a hyperparameter filter, enter a value with the form
- * "HyperParameters.. Decimal hyperparameter
- * values are treated as a decimal in a comparison if the specified
- * Value is also a decimal value. If the specified
- * Value is an integer, the decimal hyperparameter values are
- * treated as integers. For example, the following filter is satisfied by
- * training jobs with a "learning_rate" hyperparameter that is
- * less than "0.5":
- * \{
- *
- * "Name": "HyperParameters.learning_rate",
- *
- * "Operator": "LessThan",
- *
- * "Value": "0.5"
- *
- * \}
- *
To define a tag filter, enter a value with the form
- * Tags..
A resource property name. For example, TrainingJobName. For
- * valid property names, see SearchRecord.
- * You must specify a valid property for the resource.
The OIDC IdP JSON Web Key Set (Jwks) URI used to configure your private workforce.
* @public */ - Name: string | undefined; + JwksUri?: string | undefined; /** - *A Boolean binary operator that is used to evaluate the filter. The operator field - * contains one of the following values:
- *The value of Name equals Value.
The value of Name doesn't equal Value.
The Name property exists.
The Name property does not exist.
The value of Name is greater than Value.
- * Not supported for text properties.
The value of Name is greater than or equal to Value.
- * Not supported for text properties.
The value of Name is less than Value.
- * Not supported for text properties.
The value of Name is less than or equal to Value.
- * Not supported for text properties.
The value of Name is one of the comma delimited strings in
- * Value. Only supported for text properties.
The value of Name contains the string Value.
- * Only supported for text properties.
A SearchExpression can include the Contains operator
- * multiple times when the value of Name is one of the following:
- * Experiment.DisplayName
- *
- * Experiment.ExperimentName
- *
- * Experiment.Tags
- *
- * Trial.DisplayName
- *
- * Trial.TrialName
- *
- * Trial.Tags
- *
- * TrialComponent.DisplayName
- *
- * TrialComponent.TrialComponentName
- *
- * TrialComponent.Tags
- *
- * TrialComponent.InputArtifacts
- *
- * TrialComponent.OutputArtifacts
- *
A SearchExpression can include only one Contains operator
- * for all other values of Name. In these cases, if you include multiple
- * Contains operators in the SearchExpression, the result is
- * the following error message: "'CONTAINS' operator usage limit of 1
- * exceeded."
An array of string identifiers used to refer to the specific pieces of user data or claims that the client application wants to access.
* @public */ - Operator?: Operator | undefined; + Scope?: string | undefined; /** - *A value used with Name and Operator to determine which
- * resources satisfy the filter's condition. For numerical properties, Value
- * must be an integer or floating-point decimal. For timestamp properties,
- * Value must be an ISO 8601 date-time string of the following format:
- * YYYY-mm-dd'T'HH:MM:SS.
A string to string map of identifiers specific to the custom identity provider (IdP) being used.
* @public */ - Value?: string | undefined; + AuthenticationRequestExtraParams?: RecordContains summary information about the flow definition.
+ * @public + * @enum + */ +export const WorkforceStatus = { + ACTIVE: "Active", + DELETING: "Deleting", + FAILED: "Failed", + INITIALIZING: "Initializing", + UPDATING: "Updating", +} as const; + +/** * @public */ -export interface FlowDefinitionSummary { - /** - *The name of the flow definition.
- * @public - */ - FlowDefinitionName: string | undefined; - - /** - *The Amazon Resource Name (ARN) of the flow definition.
- * @public - */ - FlowDefinitionArn: string | undefined; +export type WorkforceStatus = (typeof WorkforceStatus)[keyof typeof WorkforceStatus]; +/** + *A VpcConfig object that specifies the VPC that you want your workforce to connect to.
+ * @public + */ +export interface WorkforceVpcConfigResponse { /** - *The status of the flow definition. Valid values:
+ *The ID of the VPC that the workforce uses for communication.
* @public */ - FlowDefinitionStatus: FlowDefinitionStatus | undefined; + VpcId: string | undefined; /** - *The timestamp when SageMaker created the flow definition.
+ *The VPC security group IDs, in the form sg-xxxxxxxx. The security groups must be for the same VPC as specified in the subnet.
* @public */ - CreationTime: Date | undefined; + SecurityGroupIds: string[] | undefined; /** - *The reason why the flow definition creation failed. A failure reason is returned only when the flow definition status is Failed.
The ID of the subnets in the VPC that you want to connect.
* @public */ - FailureReason?: string | undefined; -} + Subnets: string[] | undefined; -/** - * @public - */ -export interface GetDeviceFleetReportRequest { /** - *The name of the fleet.
+ *The IDs for the VPC service endpoints of your VPC workforce when it is created and updated.
* @public */ - DeviceFleetName: string | undefined; + VpcEndpointId?: string | undefined; } /** + *A single private workforce, which is automatically created when you create your first + * private work team. You can create one private work force in each Amazon Web Services Region. By default, + * any workforce-related API operation used in a specific region will apply to the + * workforce created in that region. To learn how to create a private workforce, see Create a Private Workforce.
* @public */ -export interface GetDeviceFleetReportResponse { +export interface Workforce { /** - *The Amazon Resource Name (ARN) of the device.
+ *The name of the private workforce.
* @public */ - DeviceFleetArn: string | undefined; + WorkforceName: string | undefined; /** - *The name of the fleet.
+ *The Amazon Resource Name (ARN) of the private workforce.
* @public */ - DeviceFleetName: string | undefined; + WorkforceArn: string | undefined; /** - *The output configuration for storing sample data collected by the fleet.
+ *The most recent date that UpdateWorkforce was used to + * successfully add one or more IP address ranges (CIDRs) to a private workforce's + * allow list.
* @public */ - OutputConfig?: EdgeOutputConfig | undefined; + LastUpdatedDate?: Date | undefined; /** - *Description of the fleet.
+ *A list of one to ten IP address ranges (CIDRs) to be added to the + * workforce allow list. By default, a workforce isn't restricted to specific IP addresses.
* @public */ - Description?: string | undefined; + SourceIpConfig?: SourceIpConfig | undefined; /** - *Timestamp of when the report was generated.
+ *The subdomain for your OIDC Identity Provider.
* @public */ - ReportGenerated?: Date | undefined; + SubDomain?: string | undefined; /** - *Status of devices.
+ *The configuration of an Amazon Cognito workforce. + * A single Cognito workforce is created using and corresponds to a single + * + * Amazon Cognito user pool.
* @public */ - DeviceStats?: DeviceStats | undefined; + CognitoConfig?: CognitoConfig | undefined; /** - *The versions of Edge Manager agent deployed on the fleet.
+ *The configuration of an OIDC Identity Provider (IdP) private workforce.
* @public */ - AgentVersions?: AgentVersion[] | undefined; + OidcConfig?: OidcConfigForResponse | undefined; /** - *Status of model on device.
+ *The date that the workforce is created.
* @public */ - ModelStats?: EdgeModelStat[] | undefined; -} + CreateDate?: Date | undefined; -/** - * @public - */ -export interface GetLineageGroupPolicyRequest { /** - *The name or Amazon Resource Name (ARN) of the lineage group.
+ *The configuration of a VPC workforce.
* @public */ - LineageGroupName: string | undefined; -} + WorkforceVpcConfig?: WorkforceVpcConfigResponse | undefined; -/** - * @public - */ -export interface GetLineageGroupPolicyResponse { /** - *The Amazon Resource Name (ARN) of the lineage group.
+ *The status of your workforce.
* @public */ - LineageGroupArn?: string | undefined; + Status?: WorkforceStatus | undefined; /** - *The resource policy that gives access to the lineage group in another account.
+ *The reason your workforce failed.
* @public */ - ResourcePolicy?: string | undefined; + FailureReason?: string | undefined; } /** * @public */ -export interface GetModelPackageGroupPolicyInput { +export interface DescribeWorkforceResponse { /** - *The name of the model group for which to get the resource policy.
+ *A single private workforce, which is automatically created when you create your first + * private work team. You can create one private work force in each Amazon Web Services Region. By default, + * any workforce-related API operation used in a specific region will apply to the + * workforce created in that region. To learn how to create a private workforce, see Create a Private Workforce.
* @public */ - ModelPackageGroupName: string | undefined; + Workforce: Workforce | undefined; } /** * @public */ -export interface GetModelPackageGroupPolicyOutput { +export interface DescribeWorkteamRequest { /** - *The resource policy for the model group.
+ *The name of the work team to return a description of.
* @public */ - ResourcePolicy: string | undefined; + WorkteamName: string | undefined; } /** + *Provides details about a labeling work team.
* @public */ -export interface GetSagemakerServicecatalogPortfolioStatusInput {} +export interface Workteam { + /** + *The name of the work team.
+ * @public + */ + WorkteamName: string | undefined; -/** - * @public - * @enum - */ -export const SagemakerServicecatalogStatus = { - DISABLED: "Disabled", - ENABLED: "Enabled", -} as const; + /** + *A list of MemberDefinition objects that contains objects that identify
+ * the workers that make up the work team.
Workforces can be created using Amazon Cognito or your own OIDC Identity Provider (IdP).
+ * For private workforces created using Amazon Cognito use
+ * CognitoMemberDefinition. For workforces created using your own OIDC identity
+ * provider (IdP) use OidcMemberDefinition.
The Amazon Resource Name (ARN) that identifies the work team.
+ * @public + */ + WorkteamArn: string | undefined; -/** - * @public - */ -export interface GetSagemakerServicecatalogPortfolioStatusOutput { /** - *Whether Service Catalog is enabled or disabled in SageMaker.
+ *The Amazon Resource Name (ARN) of the workforce.
* @public */ - Status?: SagemakerServicecatalogStatus | undefined; -} + WorkforceArn?: string | undefined; -/** - *An object where you specify the anticipated traffic pattern for an endpoint.
- * @public - */ -export interface ScalingPolicyObjective { /** - *The minimum number of expected requests to your endpoint per minute.
+ *The Amazon Marketplace identifier for a vendor's work team.
* @public */ - MinInvocationsPerMinute?: number | undefined; + ProductListingIds?: string[] | undefined; /** - *The maximum number of expected requests to your endpoint per minute.
+ *A description of the work team.
* @public */ - MaxInvocationsPerMinute?: number | undefined; -} + Description: string | undefined; -/** - * @public - */ -export interface GetScalingConfigurationRecommendationRequest { /** - *The name of a previously completed Inference Recommender job.
+ *The URI of the labeling job's user interface. Workers open this URI to start labeling + * your data objects.
* @public */ - InferenceRecommendationsJobName: string | undefined; + SubDomain?: string | undefined; /** - *The recommendation ID of a previously completed inference recommendation. This ID should come from one of the
- * recommendations returned by the job specified in the InferenceRecommendationsJobName field.
Specify either this field or the EndpointName field.
The date and time that the work team was created (timestamp).
* @public */ - RecommendationId?: string | undefined; + CreateDate?: Date | undefined; /** - *The name of an endpoint benchmarked during a previously completed inference recommendation job. This name should come from one of the
- * recommendations returned by the job specified in the InferenceRecommendationsJobName field.
Specify either this field or the RecommendationId field.
The date and time that the work team was last updated (timestamp).
* @public */ - EndpointName?: string | undefined; + LastUpdatedDate?: Date | undefined; /** - *The percentage of how much utilization you want an instance to use before autoscaling. The default value is 50%.
+ *Configures SNS notifications of available or expiring work items for work + * teams.
* @public */ - TargetCpuUtilizationPerCore?: number | undefined; + NotificationConfiguration?: NotificationConfiguration | undefined; /** - *An object where you specify the anticipated traffic pattern for an endpoint.
+ *Describes any access constraints that have been defined for Amazon S3 resources.
* @public */ - ScalingPolicyObjective?: ScalingPolicyObjective | undefined; + WorkerAccessConfiguration?: WorkerAccessConfiguration | undefined; } /** - *The metric for a scaling policy.
* @public */ -export interface ScalingPolicyMetric { +export interface DescribeWorkteamResponse { /** - *The number of invocations sent to a model, normalized by InstanceCount
- * in each ProductionVariant. 1/numberOfInstances is sent as the value on each
- * request, where numberOfInstances is the number of active instances for the
- * ProductionVariant behind the endpoint at the time of the request.
A Workteam instance that contains information about the work team.
+ *
Specifies the serverless update concurrency configuration for an endpoint variant.
+ * @public + */ +export interface ProductionVariantServerlessUpdateConfig { /** - *The interval of time taken by a model to respond as viewed from SageMaker. - * This interval includes the local communication times taken to send the request - * and to fetch the response from the container of a model and the time taken to - * complete the inference in the container.
+ *The updated maximum number of concurrent invocations your serverless endpoint can process.
* @public */ - ModelLatency?: number | undefined; + MaxConcurrency?: number | undefined; + + /** + *The updated amount of provisioned concurrency to allocate for the serverless endpoint.
+ * Should be less than or equal to MaxConcurrency.
Specifies weight and capacity values for a production variant.
* @public */ -export interface GetScalingConfigurationRecommendationResponse { +export interface DesiredWeightAndCapacity { /** - *The name of a previously completed Inference Recommender job.
+ *The name of the variant to update.
* @public */ - InferenceRecommendationsJobName?: string | undefined; + VariantName: string | undefined; /** - *The recommendation ID of a previously completed inference recommendation.
+ *The variant's weight.
* @public */ - RecommendationId?: string | undefined; + DesiredWeight?: number | undefined; /** - *The name of an endpoint benchmarked during a previously completed Inference Recommender job.
+ *The variant's capacity.
* @public */ - EndpointName?: string | undefined; + DesiredInstanceCount?: number | undefined; /** - *The percentage of how much utilization you want an instance to use before autoscaling, which you specified in the request. The default value is 50%.
+ *Specifies the serverless update concurrency configuration for an endpoint variant.
* @public */ - TargetCpuUtilizationPerCore?: number | undefined; + ServerlessUpdateConfig?: ProductionVariantServerlessUpdateConfig | undefined; +} +/** + *Information of a particular device.
+ * @public + */ +export interface Device { /** - *An object representing the anticipated traffic pattern for an endpoint that you specified in the request.
+ *The name of the device.
* @public */ - ScalingPolicyObjective?: ScalingPolicyObjective | undefined; + DeviceName: string | undefined; /** - *An object with a list of metrics that were benchmarked during the previously completed Inference Recommender job.
+ *Description of the device.
* @public */ - Metric?: ScalingPolicyMetric | undefined; + Description?: string | undefined; /** - *An object with the recommended values for you to specify when creating an autoscaling policy.
+ *Amazon Web Services Internet of Things (IoT) object name.
* @public */ - DynamicScalingConfiguration?: DynamicScalingConfiguration | undefined; + IotThingName?: string | undefined; } /** * @public * @enum */ -export const ResourceType = { - ENDPOINT: "Endpoint", - EXPERIMENT: "Experiment", - EXPERIMENT_TRIAL: "ExperimentTrial", - EXPERIMENT_TRIAL_COMPONENT: "ExperimentTrialComponent", - FEATURE_GROUP: "FeatureGroup", - FEATURE_METADATA: "FeatureMetadata", - HYPER_PARAMETER_TUNING_JOB: "HyperParameterTuningJob", - IMAGE: "Image", - IMAGE_VERSION: "ImageVersion", - MODEL: "Model", - MODEL_CARD: "ModelCard", - MODEL_PACKAGE: "ModelPackage", - MODEL_PACKAGE_GROUP: "ModelPackageGroup", - PIPELINE: "Pipeline", - PIPELINE_EXECUTION: "PipelineExecution", - PROJECT: "Project", - TRAINING_JOB: "TrainingJob", +export const DeviceDeploymentStatus = { + Deployed: "DEPLOYED", + Failed: "FAILED", + InProgress: "INPROGRESS", + ReadyToDeploy: "READYTODEPLOY", + Stopped: "STOPPED", + Stopping: "STOPPING", } as const; /** * @public */ -export type ResourceType = (typeof ResourceType)[keyof typeof ResourceType]; - -/** - *Part of the SuggestionQuery type. Specifies a hint for retrieving property
- * names that begin with the specified text.
Text that begins a property's name.
- * @public - */ - PropertyNameHint: string | undefined; -} +export type DeviceDeploymentStatus = (typeof DeviceDeploymentStatus)[keyof typeof DeviceDeploymentStatus]; /** - *Specified in the GetSearchSuggestions request. - * Limits the property names that are included in the response.
+ *Contains information summarizing device details and deployment status.
* @public */ -export interface SuggestionQuery { +export interface DeviceDeploymentSummary { /** - *Defines a property name hint. Only property - * names that begin with the specified hint are included in the response.
+ *The ARN of the edge deployment plan.
* @public */ - PropertyNameQuery?: PropertyNameQuery | undefined; -} + EdgeDeploymentPlanArn: string | undefined; -/** - * @public - */ -export interface GetSearchSuggestionsRequest { /** - *The name of the SageMaker resource to search for.
+ *The name of the edge deployment plan.
* @public */ - Resource: ResourceType | undefined; + EdgeDeploymentPlanName: string | undefined; /** - *Limits the property names that are included in the response.
+ *The name of the stage in the edge deployment plan.
* @public */ - SuggestionQuery?: SuggestionQuery | undefined; -} + StageName: string | undefined; -/** - *A property name returned from a GetSearchSuggestions call that specifies
- * a value in the PropertyNameQuery field.
A suggested property name based on what you entered in the search textbox in the SageMaker - * console.
+ *The name of the deployed stage.
* @public */ - PropertyName?: string | undefined; -} + DeployedStageName?: string | undefined; -/** - * @public - */ -export interface GetSearchSuggestionsResponse { /** - *A list of property names for a Resource that match a
- * SuggestionQuery.
The name of the fleet to which the device belongs to.
* @public */ - PropertyNameSuggestions?: PropertyNameSuggestion[] | undefined; -} + DeviceFleetName?: string | undefined; -/** - *Specifies configuration details for a Git repository when the repository is - * updated.
- * @public - */ -export interface GitConfigForUpdate { /** - *The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that
- * contains the credentials used to access the git repository. The secret must have a
- * staging label of AWSCURRENT and must be in the following format:
- * \{"username": UserName, "password":
- * Password\}
- *
The name of the device.
* @public */ - SecretArn?: string | undefined; -} + DeviceName: string | undefined; -/** - *Information about hub content.
- * @public - */ -export interface HubContentInfo { /** - *The name of the hub content.
+ *The ARN of the device.
* @public */ - HubContentName: string | undefined; + DeviceArn: string | undefined; /** - *The Amazon Resource Name (ARN) of the hub content.
+ *The deployment status of the device.
* @public */ - HubContentArn: string | undefined; + DeviceDeploymentStatus?: DeviceDeploymentStatus | undefined; /** - *The ARN of the public hub content.
+ *The detailed error message for the deployoment status result.
* @public */ - SageMakerPublicHubContentArn?: string | undefined; + DeviceDeploymentStatusMessage?: string | undefined; /** - *The version of the hub content.
+ *The description of the device.
* @public */ - HubContentVersion: string | undefined; + Description?: string | undefined; /** - *The type of hub content.
+ *The time when the deployment on the device started.
* @public */ - HubContentType: HubContentType | undefined; + DeploymentStartTime?: Date | undefined; +} +/** + *Summary of the device fleet.
+ * @public + */ +export interface DeviceFleetSummary { /** - *The version of the hub content document schema.
+ *Amazon Resource Name (ARN) of the device fleet.
* @public */ - DocumentSchemaVersion: string | undefined; + DeviceFleetArn: string | undefined; /** - *The display name of the hub content.
+ *Name of the device fleet.
* @public */ - HubContentDisplayName?: string | undefined; + DeviceFleetName: string | undefined; /** - *A description of the hub content.
+ *Timestamp of when the device fleet was created.
* @public */ - HubContentDescription?: string | undefined; + CreationTime?: Date | undefined; /** - *The support status of the hub content.
+ *Timestamp of when the device fleet was last updated.
* @public */ - SupportStatus?: HubContentSupportStatus | undefined; + LastModifiedTime?: Date | undefined; +} +/** + *Status of devices.
+ * @public + */ +export interface DeviceStats { /** - *The searchable keywords for the hub content.
+ *The number of devices connected with a heartbeat.
* @public */ - HubContentSearchKeywords?: string[] | undefined; + ConnectedDeviceCount: number | undefined; /** - *The status of the hub content.
+ *The number of registered devices.
* @public */ - HubContentStatus: HubContentStatus | undefined; + RegisteredDeviceCount: number | undefined; +} +/** + *Summary of model on edge device.
+ * @public + */ +export interface EdgeModelSummary { /** - *The date and time that the hub content was created.
+ *The name of the model.
* @public */ - CreationTime: Date | undefined; + ModelName: string | undefined; /** - *The date and time when the hub content was originally created, before any updates or revisions.
+ *The version model.
* @public */ - OriginalCreationTime?: Date | undefined; + ModelVersion: string | undefined; } /** - * @public - * @enum - */ -export const HubContentSortBy = { - CREATION_TIME: "CreationTime", - HUB_CONTENT_NAME: "HubContentName", - HUB_CONTENT_STATUS: "HubContentStatus", -} as const; - -/** + *Summary of the device.
* @public */ -export type HubContentSortBy = (typeof HubContentSortBy)[keyof typeof HubContentSortBy]; +export interface DeviceSummary { + /** + *The unique identifier of the device.
+ * @public + */ + DeviceName: string | undefined; -/** - *Information about a hub.
- * @public - */ -export interface HubInfo { /** - *The name of the hub.
+ *Amazon Resource Name (ARN) of the device.
* @public */ - HubName: string | undefined; + DeviceArn: string | undefined; /** - *The Amazon Resource Name (ARN) of the hub.
+ *A description of the device.
* @public */ - HubArn: string | undefined; + Description?: string | undefined; /** - *The display name of the hub.
+ *The name of the fleet the device belongs to.
* @public */ - HubDisplayName?: string | undefined; + DeviceFleetName?: string | undefined; /** - *A description of the hub.
+ *The Amazon Web Services Internet of Things (IoT) object thing name associated with the device..
* @public */ - HubDescription?: string | undefined; + IotThingName?: string | undefined; /** - *The searchable keywords for the hub.
+ *The timestamp of the last registration or de-reregistration.
* @public */ - HubSearchKeywords?: string[] | undefined; + RegistrationTime?: Date | undefined; /** - *The status of the hub.
+ *The last heartbeat received from the device.
* @public */ - HubStatus: HubStatus | undefined; + LatestHeartbeat?: Date | undefined; /** - *The date and time that the hub was created.
+ *Models on the device.
* @public */ - CreationTime: Date | undefined; + Models?: EdgeModelSummary[] | undefined; /** - *The date and time that the hub was last modified.
+ *Edge Manager agent version.
* @public */ - LastModifiedTime: Date | undefined; + AgentVersion?: string | undefined; } /** * @public * @enum */ -export const HubSortBy = { - ACCOUNT_ID_OWNER: "AccountIdOwner", - CREATION_TIME: "CreationTime", - HUB_NAME: "HubName", - HUB_STATUS: "HubStatus", +export const Direction = { + ASCENDANTS: "Ascendants", + BOTH: "Both", + DESCENDANTS: "Descendants", } as const; /** * @public */ -export type HubSortBy = (typeof HubSortBy)[keyof typeof HubSortBy]; +export type Direction = (typeof Direction)[keyof typeof Direction]; /** - *Container for human task user interface information.
* @public */ -export interface HumanTaskUiSummary { +export interface DisableSagemakerServicecatalogPortfolioInput {} + +/** + * @public + */ +export interface DisableSagemakerServicecatalogPortfolioOutput {} + +/** + * @public + */ +export interface DisassociateTrialComponentRequest { /** - *The name of the human task user interface.
+ *The name of the component to disassociate from the trial.
* @public */ - HumanTaskUiName: string | undefined; + TrialComponentName: string | undefined; /** - *The Amazon Resource Name (ARN) of the human task user interface.
+ *The name of the trial to disassociate from.
* @public */ - HumanTaskUiArn: string | undefined; + TrialName: string | undefined; +} +/** + * @public + */ +export interface DisassociateTrialComponentResponse { /** - *A timestamp when SageMaker created the human task user interface.
+ *The Amazon Resource Name (ARN) of the trial component.
* @public */ - CreationTime: Date | undefined; + TrialComponentArn?: string | undefined; + + /** + *The Amazon Resource Name (ARN) of the trial.
+ * @public + */ + TrialArn?: string | undefined; } /** - *An entity returned by the SearchRecord API - * containing the properties of a hyperparameter tuning job.
+ *The domain's details.
* @public */ -export interface HyperParameterTuningJobSearchEntity { +export interface DomainDetails { /** - *The name of a hyperparameter tuning job.
+ *The domain's Amazon Resource Name (ARN).
* @public */ - HyperParameterTuningJobName?: string | undefined; + DomainArn?: string | undefined; /** - *The Amazon Resource Name (ARN) of a hyperparameter tuning job.
+ *The domain ID.
* @public */ - HyperParameterTuningJobArn?: string | undefined; + DomainId?: string | undefined; /** - *Configures a hyperparameter tuning job.
+ *The domain name.
* @public */ - HyperParameterTuningJobConfig?: HyperParameterTuningJobConfig | undefined; + DomainName?: string | undefined; /** - *Defines - * the training jobs launched by a hyperparameter tuning job.
+ *The status.
* @public */ - TrainingJobDefinition?: HyperParameterTrainingJobDefinition | undefined; + Status?: DomainStatus | undefined; /** - *The job definitions included in a hyperparameter tuning job.
+ *The creation time.
* @public */ - TrainingJobDefinitions?: HyperParameterTrainingJobDefinition[] | undefined; + CreationTime?: Date | undefined; /** - *The status of a hyperparameter tuning job.
+ *The last modified time.
* @public */ - HyperParameterTuningJobStatus?: HyperParameterTuningJobStatus | undefined; + LastModifiedTime?: Date | undefined; /** - *The time that a hyperparameter tuning job was created.
+ *The domain's URL.
* @public */ - CreationTime?: Date | undefined; + Url?: string | undefined; +} +/** + *A collection of settings that update the current configuration for the
+ * RStudioServerPro Domain-level app.
The time that a hyperparameter tuning job ended.
+ *The execution role for the RStudioServerPro Domain-level app.
The time that a hyperparameter tuning job was last modified.
+ *Specifies the ARN's of a SageMaker image and SageMaker image version, and the instance type that + * the version runs on.
* @public */ - LastModifiedTime?: Date | undefined; + DefaultResourceSpec?: ResourceSpec | undefined; /** - *The numbers of training jobs launched by a hyperparameter tuning job, categorized by - * status.
+ *A URL pointing to an RStudio Connect server.
* @public */ - TrainingJobStatusCounters?: TrainingJobStatusCounters | undefined; + RStudioConnectUrl?: string | undefined; /** - *Specifies the number of training jobs that this hyperparameter tuning job launched, - * categorized by the status of their objective metric. The objective metric status shows - * whether the - * final - * objective metric for the training job has been evaluated by the - * tuning job and used in the hyperparameter tuning process.
+ *A URL pointing to an RStudio Package Manager server.
* @public */ - ObjectiveStatusCounters?: ObjectiveStatusCounters | undefined; + RStudioPackageManagerUrl?: string | undefined; +} +/** + *A collection of Domain configuration settings to update.
The container for the summary information about a training job.
+ *A collection of RStudioServerPro Domain-level app settings to update. A
+ * single RStudioServerPro application is created for a domain.
The container for the summary information about a training job.
+ *The configuration for attaching a SageMaker user profile name to the execution
+ * role as a sts:SourceIdentity key. This configuration can only be modified if there are no
+ * apps in the InService or Pending state.
Specifies the configuration for a hyperparameter tuning job that uses one or more - * previous hyperparameter tuning jobs as a starting point. The results of previous tuning - * jobs are used to inform which combinations of hyperparameters to search over in the new - * tuning job.
- *All training jobs launched by the new hyperparameter tuning job are evaluated by using - * the objective metric, and the training job that performs the best is compared to the - * best training jobs from the parent tuning jobs. From these, the training job that - * performs the best as measured by the objective metric is returned as the overall best - * training job.
- *All training jobs launched by parent hyperparameter tuning jobs and the new - * hyperparameter tuning jobs count against the limit of training jobs for the tuning - * job.
- *The security groups for the Amazon Virtual Private Cloud that the Domain uses for
+ * communication between Domain-level apps and user apps.
The error that was created when a hyperparameter tuning job failed.
+ *A collection of settings that configure the domain's Docker interaction.
* @public */ - FailureReason?: string | undefined; + DockerSettings?: DockerSettings | undefined; /** - *Information about either a current or completed hyperparameter tuning job.
+ *A collection of settings that configure the Amazon Q experience within the domain.
* @public */ - TuningJobCompletionDetails?: HyperParameterTuningJobCompletionDetails | undefined; + AmazonQSettings?: AmazonQSettings | undefined; +} +/** + *A specification for a predefined metric.
+ * @public + */ +export interface PredefinedMetricSpecification { /** - *The total amount of resources consumed by a hyperparameter tuning job.
+ *The metric type. You can only apply SageMaker metric types to SageMaker endpoints.
* @public */ - ConsumedResources?: HyperParameterTuningJobConsumedResources | undefined; + PredefinedMetricType?: string | undefined; +} + +/** + *An object containing information about a metric.
+ * @public + */ +export type MetricSpecification = + | MetricSpecification.CustomizedMember + | MetricSpecification.PredefinedMember + | MetricSpecification.$UnknownMember; +/** + * @public + */ +export namespace MetricSpecification { /** - *The tags associated with a hyperparameter tuning job. For more information see Tagging Amazon Web Services resources.
+ *Information about a predefined metric.
* @public */ - Tags?: Tag[] | undefined; + export interface PredefinedMember { + Predefined: PredefinedMetricSpecification; + Customized?: never; + $unknown?: never; + } + + /** + *Information about a customized metric.
+ * @public + */ + export interface CustomizedMember { + Predefined?: never; + Customized: CustomizedMetricSpecification; + $unknown?: never; + } + + /** + * @public + */ + export interface $UnknownMember { + Predefined?: never; + Customized?: never; + $unknown: [string, any]; + } + + export interface VisitorA target tracking scaling policy. Includes support for predefined or customized metrics.
+ *When using the PutScalingPolicy API,
+ * this parameter is required when you are creating a policy with the policy type TargetTrackingScaling.
An object containing information about a metric.
+ * @public + */ + MetricSpecification?: MetricSpecification | undefined; + + /** + *The recommended target value to specify for the metric when creating a scaling policy.
+ * @public + */ + TargetValue?: number | undefined; +} /** + *An object containing a recommended scaling policy.
* @public */ -export type HyperParameterTuningJobSortByOptions = - (typeof HyperParameterTuningJobSortByOptions)[keyof typeof HyperParameterTuningJobSortByOptions]; +export type ScalingPolicy = ScalingPolicy.TargetTrackingMember | ScalingPolicy.$UnknownMember; /** - *Provides summary information about a hyperparameter tuning job.
* @public */ -export interface HyperParameterTuningJobSummary { +export namespace ScalingPolicy { /** - *The name of the tuning job.
+ *A target tracking scaling policy. Includes support for predefined or customized metrics.
* @public */ - HyperParameterTuningJobName: string | undefined; + export interface TargetTrackingMember { + TargetTracking: TargetTrackingScalingPolicyConfiguration; + $unknown?: never; + } /** - *The - * Amazon - * Resource Name (ARN) of the tuning job.
* @public */ - HyperParameterTuningJobArn: string | undefined; + export interface $UnknownMember { + TargetTracking?: never; + $unknown: [string, any]; + } + + export interface VisitorAn object with the recommended values for you to specify when creating an autoscaling policy.
+ * @public + */ +export interface DynamicScalingConfiguration { /** - *The status of the - * tuning - * job.
+ *The recommended minimum capacity to specify for your autoscaling policy.
* @public */ - HyperParameterTuningJobStatus: HyperParameterTuningJobStatus | undefined; + MinCapacity?: number | undefined; /** - *Specifies the search strategy hyperparameter tuning uses to choose which - * hyperparameters to - * evaluate - * at each iteration.
+ *The recommended maximum capacity to specify for your autoscaling policy.
* @public */ - Strategy: HyperParameterTuningJobStrategyType | undefined; + MaxCapacity?: number | undefined; /** - *The date and time that the tuning job was created.
+ *The recommended scale in cooldown time for your autoscaling policy.
* @public */ - CreationTime: Date | undefined; + ScaleInCooldown?: number | undefined; /** - *The date and time that the tuning job ended.
+ *The recommended scale out cooldown time for your autoscaling policy.
* @public */ - HyperParameterTuningEndTime?: Date | undefined; + ScaleOutCooldown?: number | undefined; /** - *The date and time that the tuning job was - * modified.
+ *An object of the scaling policies for each metric.
* @public */ - LastModifiedTime?: Date | undefined; + ScalingPolicies?: ScalingPolicy[] | undefined; +} +/** + *A directed edge connecting two lineage entities.
+ * @public + */ +export interface Edge { /** - *The TrainingJobStatusCounters object that specifies the numbers of training - * jobs, categorized by status, that this tuning job launched.
+ *The Amazon Resource Name (ARN) of the source lineage entity of the directed edge.
* @public */ - TrainingJobStatusCounters: TrainingJobStatusCounters | undefined; + SourceArn?: string | undefined; /** - *The ObjectiveStatusCounters object that specifies the numbers of training jobs, - * categorized by objective metric status, that this tuning job launched.
+ *The Amazon Resource Name (ARN) of the destination lineage entity of the directed edge.
* @public */ - ObjectiveStatusCounters: ObjectiveStatusCounters | undefined; + DestinationArn?: string | undefined; /** - *The ResourceLimits - * object that specifies the maximum number of training jobs and parallel training jobs - * allowed for this tuning job.
+ *The type of the Association(Edge) between the source and destination. For example ContributedTo,
+ * Produced, or DerivedFrom.
A SageMaker image. A SageMaker image represents a set of container images that are derived from
- * a common base container image. Each of these container images is represented by a SageMaker
- * ImageVersion.
Contains information summarizing an edge deployment plan.
* @public */ -export interface Image { +export interface EdgeDeploymentPlanSummary { /** - *When the image was created.
+ *The ARN of the edge deployment plan.
* @public */ - CreationTime: Date | undefined; + EdgeDeploymentPlanArn: string | undefined; /** - *The description of the image.
+ *The name of the edge deployment plan.
* @public */ - Description?: string | undefined; + EdgeDeploymentPlanName: string | undefined; /** - *The name of the image as displayed.
+ *The name of the device fleet used for the deployment.
* @public */ - DisplayName?: string | undefined; + DeviceFleetName: string | undefined; /** - *When a create, update, or delete operation fails, the reason for the failure.
+ *The number of edge devices with the successful deployment.
* @public */ - FailureReason?: string | undefined; + EdgeDeploymentSuccess: number | undefined; /** - *The ARN of the image.
+ *The number of edge devices yet to pick up the deployment, or in progress.
* @public */ - ImageArn: string | undefined; + EdgeDeploymentPending: number | undefined; /** - *The name of the image.
+ *The number of edge devices that failed the deployment.
* @public */ - ImageName: string | undefined; + EdgeDeploymentFailed: number | undefined; /** - *The status of the image.
+ *The time when the edge deployment plan was created.
* @public */ - ImageStatus: ImageStatus | undefined; + CreationTime?: Date | undefined; /** - *When the image was last modified.
+ *The time when the edge deployment plan was last updated.
* @public */ - LastModifiedTime: Date | undefined; + LastModifiedTime?: Date | undefined; } /** - * @public - * @enum - */ -export const ImageSortBy = { - CREATION_TIME: "CREATION_TIME", - IMAGE_NAME: "IMAGE_NAME", - LAST_MODIFIED_TIME: "LAST_MODIFIED_TIME", -} as const; - -/** - * @public - */ -export type ImageSortBy = (typeof ImageSortBy)[keyof typeof ImageSortBy]; - -/** - * @public - * @enum - */ -export const ImageSortOrder = { - ASCENDING: "ASCENDING", - DESCENDING: "DESCENDING", -} as const; - -/** - * @public - */ -export type ImageSortOrder = (typeof ImageSortOrder)[keyof typeof ImageSortOrder]; - -/** - *A version of a SageMaker Image. A version represents an existing container
- * image.
Status of edge devices with this model.
* @public */ -export interface ImageVersion { - /** - *When the version was created.
- * @public - */ - CreationTime: Date | undefined; - +export interface EdgeModelStat { /** - *When a create or delete operation fails, the reason for the failure.
+ *The name of the model.
* @public */ - FailureReason?: string | undefined; + ModelName: string | undefined; /** - *The ARN of the image the version is based on.
+ *The model version.
* @public */ - ImageArn: string | undefined; + ModelVersion: string | undefined; /** - *The ARN of the version.
+ *The number of devices that have this model version and do not have a heart beat.
* @public */ - ImageVersionArn: string | undefined; + OfflineDeviceCount: number | undefined; /** - *The status of the version.
+ *The number of devices that have this model version and have a heart beat.
* @public */ - ImageVersionStatus: ImageVersionStatus | undefined; + ConnectedDeviceCount: number | undefined; /** - *When the version was last modified.
+ *The number of devices that have this model version, a heart beat, and are currently running.
* @public */ - LastModifiedTime: Date | undefined; + ActiveDeviceCount: number | undefined; /** - *The version number.
+ *The number of devices with this model version and are producing sample data.
* @public */ - Version: number | undefined; + SamplingDeviceCount: number | undefined; } /** - * @public - * @enum - */ -export const ImageVersionSortBy = { - CREATION_TIME: "CREATION_TIME", - LAST_MODIFIED_TIME: "LAST_MODIFIED_TIME", - VERSION: "VERSION", -} as const; - -/** - * @public - */ -export type ImageVersionSortBy = (typeof ImageVersionSortBy)[keyof typeof ImageVersionSortBy]; - -/** - * @public - * @enum - */ -export const ImageVersionSortOrder = { - ASCENDING: "ASCENDING", - DESCENDING: "DESCENDING", -} as const; - -/** - * @public - */ -export type ImageVersionSortOrder = (typeof ImageVersionSortOrder)[keyof typeof ImageVersionSortOrder]; - -/** + *Summary of edge packaging job.
* @public */ -export interface ImportHubContentRequest { - /** - *The name of the hub content to import.
- * @public - */ - HubContentName: string | undefined; - +export interface EdgePackagingJobSummary { /** - *The version of the hub content to import.
+ *The Amazon Resource Name (ARN) of the edge packaging job.
* @public */ - HubContentVersion?: string | undefined; + EdgePackagingJobArn: string | undefined; /** - *The type of hub content to import.
+ *The name of the edge packaging job.
* @public */ - HubContentType: HubContentType | undefined; + EdgePackagingJobName: string | undefined; /** - *The version of the hub content schema to import.
+ *The status of the edge packaging job.
* @public */ - DocumentSchemaVersion: string | undefined; + EdgePackagingJobStatus: EdgePackagingJobStatus | undefined; /** - *The name of the hub to import content into.
+ *The name of the SageMaker Neo compilation job.
* @public */ - HubName: string | undefined; + CompilationJobName?: string | undefined; /** - *The display name of the hub content to import.
+ *The name of the model.
* @public */ - HubContentDisplayName?: string | undefined; + ModelName?: string | undefined; /** - *A description of the hub content to import.
+ *The version of the model.
* @public */ - HubContentDescription?: string | undefined; + ModelVersion?: string | undefined; /** - *A string that provides a description of the hub content. This string can include links, tables, and standard markdown formating.
+ *The timestamp of when the job was created.
* @public */ - HubContentMarkdown?: string | undefined; + CreationTime?: Date | undefined; /** - *The hub content document that describes information about the hub content such as type, associated containers, scripts, and more.
+ *The timestamp of when the edge packaging job was last updated.
* @public */ - HubContentDocument: string | undefined; + LastModifiedTime?: Date | undefined; +} +/** + *The configurations and outcomes of an Amazon EMR step execution.
+ * @public + */ +export interface EMRStepMetadata { /** - *The searchable keywords of the hub content.
+ *The identifier of the EMR cluster.
* @public */ - HubContentSearchKeywords?: string[] | undefined; + ClusterId?: string | undefined; /** - *Any tags associated with the hub content.
+ *The identifier of the EMR cluster step.
* @public */ - Tags?: Tag[] | undefined; -} + StepId?: string | undefined; -/** - * @public - */ -export interface ImportHubContentResponse { /** - *The ARN of the hub that the content was imported into.
+ *The name of the EMR cluster step.
* @public */ - HubArn: string | undefined; + StepName?: string | undefined; /** - *The ARN of the hub content that was imported.
+ *The path to the log file where the cluster step's failure root cause + * is recorded.
* @public */ - HubContentArn: string | undefined; + LogFilePath?: string | undefined; } /** * @public - * @enum */ -export const InferenceComponentSortKey = { - CreationTime: "CreationTime", - Name: "Name", - Status: "Status", -} as const; +export interface EnableSagemakerServicecatalogPortfolioInput {} /** * @public */ -export type InferenceComponentSortKey = (typeof InferenceComponentSortKey)[keyof typeof InferenceComponentSortKey]; +export interface EnableSagemakerServicecatalogPortfolioOutput {} /** - *A summary of the properties of an inference component.
+ *A schedule for a model monitoring job. For information about model monitor, see + * Amazon SageMaker Model + * Monitor.
* @public */ -export interface InferenceComponentSummary { +export interface MonitoringSchedule { /** - *The time when the inference component was created.
+ *The Amazon Resource Name (ARN) of the monitoring schedule.
* @public */ - CreationTime: Date | undefined; + MonitoringScheduleArn?: string | undefined; /** - *The Amazon Resource Name (ARN) of the inference component.
+ *The name of the monitoring schedule.
* @public */ - InferenceComponentArn: string | undefined; + MonitoringScheduleName?: string | undefined; /** - *The name of the inference component.
+ *The status of the monitoring schedule. This can be one of the following values.
+ *
+ * PENDING - The schedule is pending being created.
+ * FAILED - The schedule failed.
+ * SCHEDULED - The schedule was successfully created.
+ * STOPPED - The schedule was stopped.
The Amazon Resource Name (ARN) of the endpoint that hosts the inference component.
+ *The type of the monitoring job definition to schedule.
* @public */ - EndpointArn: string | undefined; + MonitoringType?: MonitoringType | undefined; /** - *The name of the endpoint that hosts the inference component.
+ *If the monitoring schedule failed, the reason it failed.
* @public */ - EndpointName: string | undefined; + FailureReason?: string | undefined; /** - *The name of the production variant that hosts the inference component.
+ *The time that the monitoring schedule was created.
* @public */ - VariantName: string | undefined; + CreationTime?: Date | undefined; /** - *The status of the inference component.
+ *The last time the monitoring schedule was changed.
* @public */ - InferenceComponentStatus?: InferenceComponentStatus | undefined; + LastModifiedTime?: Date | undefined; /** - *The time when the inference component was last updated.
+ *Configures the monitoring schedule and defines the monitoring job.
* @public */ - LastModifiedTime: Date | undefined; -} + MonitoringScheduleConfig?: MonitoringScheduleConfig | undefined; -/** - *Lists a summary of properties of an inference experiment.
- * @public - */ -export interface InferenceExperimentSummary { /** - *The name of the inference experiment.
+ *The endpoint that hosts the model being monitored.
* @public */ - Name: string | undefined; + EndpointName?: string | undefined; /** - *The type of the inference experiment.
+ *Summary of information about the last monitoring job to run.
* @public */ - Type: InferenceExperimentType | undefined; + LastMonitoringExecutionSummary?: MonitoringExecutionSummary | undefined; /** - *The duration for which the inference experiment ran or will run.
- *The maximum duration that you can set for an inference experiment is 30 days.
+ *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.
* @public */ - Schedule?: InferenceExperimentSchedule | undefined; + Tags?: Tag[] | undefined; +} +/** + *A hosted endpoint for real-time inference.
+ * @public + */ +export interface Endpoint { /** - *The status of the inference experiment.
+ *The name of the endpoint.
* @public */ - Status: InferenceExperimentStatus | undefined; + EndpointName: string | undefined; /** - *The error message for the inference experiment status result.
+ *The Amazon Resource Name (ARN) of the endpoint.
* @public */ - StatusReason?: string | undefined; + EndpointArn: string | undefined; /** - *The description of the inference experiment.
+ *The endpoint configuration associated with the endpoint.
* @public */ - Description?: string | undefined; + EndpointConfigName: string | undefined; /** - *The timestamp at which the inference experiment was created.
+ *A list of the production variants hosted on the endpoint. Each production variant is a + * model.
* @public */ - CreationTime: Date | undefined; + ProductionVariants?: ProductionVariantSummary[] | undefined; /** - *The timestamp at which the inference experiment was completed.
+ *The currently active data capture configuration used by your Endpoint.
* @public */ - CompletionTime?: Date | undefined; + DataCaptureConfig?: DataCaptureConfigSummary | undefined; /** - *The timestamp when you last modified the inference experiment.
+ *The status of the endpoint.
* @public */ - LastModifiedTime: Date | undefined; + EndpointStatus: EndpointStatus | undefined; /** - *- * The ARN of the IAM role that Amazon SageMaker can assume to access model artifacts and container images, and manage - * Amazon SageMaker Inference endpoints for model deployment. - *
+ *If the endpoint failed, the reason it failed.
* @public */ - RoleArn?: string | undefined; -} - -/** - * @public - * @enum - */ -export const InferenceExperimentStopDesiredState = { - CANCELLED: "Cancelled", - COMPLETED: "Completed", -} as const; - -/** - * @public - */ -export type InferenceExperimentStopDesiredState = - (typeof InferenceExperimentStopDesiredState)[keyof typeof InferenceExperimentStopDesiredState]; + FailureReason?: string | undefined; -/** - *A structure that contains a list of recommendation jobs.
- * @public - */ -export interface InferenceRecommendationsJob { /** - *The name of the job.
+ *The time that the endpoint was created.
* @public */ - JobName: string | undefined; + CreationTime: Date | undefined; /** - *The job description.
+ *The last time the endpoint was modified.
* @public */ - JobDescription: string | undefined; + LastModifiedTime: Date | undefined; /** - *The recommendation job type.
+ *A list of monitoring schedules for the endpoint. For information about model + * monitoring, see Amazon SageMaker Model Monitor.
* @public */ - JobType: RecommendationJobType | undefined; + MonitoringSchedules?: MonitoringSchedule[] | undefined; /** - *The Amazon Resource Name (ARN) of the recommendation job.
+ *A list of the tags associated with the endpoint. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General + * Reference Guide.
* @public */ - JobArn: string | undefined; + Tags?: Tag[] | undefined; /** - *The status of the job.
+ *A list of the shadow variants hosted on the endpoint. Each shadow variant is a model + * in shadow mode with production traffic replicated from the production variant.
* @public */ - Status: RecommendationJobStatus | undefined; + ShadowProductionVariants?: ProductionVariantSummary[] | undefined; +} - /** - *A timestamp that shows when the job was created.
- * @public - */ - CreationTime: Date | undefined; +/** + * @public + * @enum + */ +export const EndpointConfigSortKey = { + CreationTime: "CreationTime", + Name: "Name", +} as const; - /** - *A timestamp that shows when the job completed.
- * @public - */ - CompletionTime?: Date | undefined; +/** + * @public + */ +export type EndpointConfigSortKey = (typeof EndpointConfigSortKey)[keyof typeof EndpointConfigSortKey]; +/** + *Metadata for an endpoint configuration step.
+ * @public + */ +export interface EndpointConfigStepMetadata { /** - *The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker - * to perform tasks on your behalf.
+ *The Amazon Resource Name (ARN) of the endpoint configuration used in the step.
* @public */ - RoleArn: string | undefined; + Arn?: string | undefined; +} +/** + *Provides summary information for an endpoint configuration.
+ * @public + */ +export interface EndpointConfigSummary { /** - *A timestamp that shows when the job was last modified.
+ *The name of the endpoint configuration.
* @public */ - LastModifiedTime: Date | undefined; + EndpointConfigName: string | undefined; /** - *If the job fails, provides information why the job failed.
+ *The Amazon Resource Name (ARN) of the endpoint configuration.
* @public */ - FailureReason?: string | undefined; + EndpointConfigArn: string | undefined; /** - *The name of the created model.
+ *A timestamp that shows when the endpoint configuration was created.
* @public */ - ModelName?: string | undefined; + CreationTime: Date | 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).
- * @public - */ - SamplePayloadUrl?: string | undefined; +/** + * @public + * @enum + */ +export const EndpointSortKey = { + CreationTime: "CreationTime", + Name: "Name", + Status: "Status", +} as const; + +/** + * @public + */ +export type EndpointSortKey = (typeof EndpointSortKey)[keyof typeof EndpointSortKey]; +/** + *Metadata for an endpoint step.
+ * @public + */ +export interface EndpointStepMetadata { /** - *The Amazon Resource Name (ARN) of a versioned model package.
+ *The Amazon Resource Name (ARN) of the endpoint in the step.
* @public */ - ModelPackageVersionArn?: string | undefined; + Arn?: string | undefined; } /** - *The details for a specific benchmark from an Inference Recommender job.
+ *Provides summary information for an endpoint.
* @public */ -export interface RecommendationJobInferenceBenchmark { +export interface EndpointSummary { /** - *The metrics of recommendations.
+ *The name of the endpoint.
* @public */ - Metrics?: RecommendationMetrics | undefined; + EndpointName: string | undefined; /** - *The metrics for an existing endpoint compared in an Inference Recommender job.
+ *The Amazon Resource Name (ARN) of the endpoint.
* @public */ - EndpointMetrics?: InferenceMetrics | undefined; + EndpointArn: string | undefined; /** - *The endpoint configuration made by Inference Recommender during a recommendation job.
+ *A timestamp that shows when the endpoint was created.
* @public */ - EndpointConfiguration?: EndpointOutputConfiguration | undefined; + CreationTime: Date | undefined; /** - *Defines the model configuration. Includes the specification name and environment parameters.
+ *A timestamp that shows when the endpoint was last modified.
* @public */ - ModelConfiguration: ModelConfiguration | undefined; + LastModifiedTime: Date | undefined; /** - *The reason why a benchmark failed.
+ *The status of the endpoint.
+ *
+ * OutOfService: Endpoint is not available to take incoming
+ * requests.
+ * Creating: CreateEndpoint is executing.
+ * Updating: UpdateEndpoint or UpdateEndpointWeightsAndCapacities is executing.
+ * SystemUpdating: Endpoint is undergoing maintenance and cannot be
+ * updated or deleted or re-scaled until it has completed. This maintenance
+ * operation does not change any customer-specified values such as VPC config, KMS
+ * encryption, model, instance type, or instance count.
+ * RollingBack: Endpoint fails to scale up or down or change its
+ * variant weight and is in the process of rolling back to its previous
+ * configuration. Once the rollback completes, endpoint returns to an
+ * InService status. This transitional status only applies to an
+ * endpoint that has autoscaling enabled and is undergoing variant weight or
+ * capacity changes as part of an UpdateEndpointWeightsAndCapacities call or when the UpdateEndpointWeightsAndCapacities operation is called
+ * explicitly.
+ * InService: Endpoint is available to process incoming
+ * requests.
+ * Deleting: DeleteEndpoint is executing.
+ * Failed: Endpoint could not be created, updated, or re-scaled. Use
+ * DescribeEndpointOutput$FailureReason for information about the
+ * failure. DeleteEndpoint is the only operation that can be performed on a
+ * failed endpoint.
To get a list of endpoints with a specified status, use the StatusEquals
+ * filter with a call to ListEndpoints.
The properties of an experiment as returned by the Search API.
+ * @public + */ +export interface Experiment { /** - *A timestamp that shows when the benchmark completed.
+ *The name of the experiment.
* @public */ - InvocationEndTime?: Date | undefined; + ExperimentName?: string | undefined; /** - *A timestamp that shows when the benchmark started.
+ *The Amazon Resource Name (ARN) of the experiment.
* @public */ - InvocationStartTime?: Date | undefined; -} - -/** - * @public - * @enum - */ -export const RecommendationStepType = { - BENCHMARK: "BENCHMARK", -} as const; + ExperimentArn?: string | undefined; -/** - * @public - */ -export type RecommendationStepType = (typeof RecommendationStepType)[keyof typeof RecommendationStepType]; + /** + *The name of the experiment as displayed. If DisplayName isn't specified,
+ * ExperimentName is displayed.
A returned array object for the Steps response field in the
- * ListInferenceRecommendationsJobSteps API command.
The type of the subtask.
- *
- * BENCHMARK: Evaluate the performance of your model on different instance types.
The source of the experiment.
* @public */ - StepType: RecommendationStepType | undefined; + Source?: ExperimentSource | undefined; /** - *The name of the Inference Recommender job.
+ *The description of the experiment.
* @public */ - JobName: string | undefined; + Description?: string | undefined; /** - *The current status of the benchmark.
+ *When the experiment was created.
* @public */ - Status: RecommendationJobStatus | undefined; + CreationTime?: Date | undefined; /** - *The details for a specific benchmark.
+ *Who created the experiment.
* @public */ - InferenceBenchmark?: RecommendationJobInferenceBenchmark | undefined; -} + CreatedBy?: UserContext | undefined; -/** - *Provides counts for human-labeled tasks in the labeling job.
- * @public - */ -export interface LabelCountersForWorkteam { /** - *The total number of data objects labeled by a human worker.
+ *When the experiment was last modified.
* @public */ - HumanLabeled?: number | undefined; + LastModifiedTime?: Date | undefined; /** - *The total number of data objects that need to be labeled by a human worker.
+ *Information about the user who created or modified an experiment, trial, trial + * component, lineage group, project, or model card.
* @public */ - PendingHuman?: number | undefined; + LastModifiedBy?: UserContext | undefined; /** - *The total number of tasks in the labeling job.
+ *The list of tags that are associated with the experiment. You can use Search API to search on the tags.
* @public */ - Total?: number | undefined; + Tags?: Tag[] | undefined; } /** - *Provides summary information for a work team.
+ *A summary of the properties of an experiment. To get the complete set of properties, call
+ * the DescribeExperiment API and provide the
+ * ExperimentName.
The name of the labeling job that the work team is assigned to.
+ *The Amazon Resource Name (ARN) of the experiment.
* @public */ - LabelingJobName?: string | undefined; + ExperimentArn?: string | undefined; /** - *A unique identifier for a labeling job. You can use this to refer to a specific - * labeling job.
+ *The name of the experiment.
* @public */ - JobReferenceCode: string | undefined; + ExperimentName?: string | undefined; /** - *The Amazon Web Services account ID of the account used to start the labeling - * job.
+ *The name of the experiment as displayed. If DisplayName isn't specified,
+ * ExperimentName is displayed.
The date and time that the labeling job was created.
+ *The source of the experiment.
* @public */ - CreationTime: Date | undefined; + ExperimentSource?: ExperimentSource | undefined; /** - *Provides information about the progress of a labeling job.
+ *When the experiment was created.
* @public */ - LabelCounters?: LabelCountersForWorkteam | undefined; + CreationTime?: Date | undefined; /** - *The configured number of workers per data object.
+ *When the experiment was last modified.
* @public */ - NumberOfHumanWorkersPerDataObject?: number | undefined; + LastModifiedTime?: Date | undefined; } /** - *Provides summary information about a labeling job.
+ *The container for the metadata for Fail step.
* @public */ -export interface LabelingJobSummary { - /** - *The name of the labeling job.
- * @public - */ - LabelingJobName: string | undefined; - - /** - *The Amazon Resource Name (ARN) assigned to the labeling job when it was - * created.
- * @public - */ - LabelingJobArn: string | undefined; - +export interface FailStepMetadata { /** - *The date and time that the job was created (timestamp).
+ *A message that you define and then is processed and rendered by + * the Fail step when the error occurs.
* @public */ - CreationTime: Date | undefined; + ErrorMessage?: string | undefined; +} +/** + *Amazon SageMaker Feature Store stores features in a collection called Feature Group. A + * Feature Group can be visualized as a table which has rows, with a unique identifier for + * each row where each column in the table is a feature. In principle, a Feature Group is + * composed of features and values per features.
+ * @public + */ +export interface FeatureGroup { /** - *The date and time that the job was last modified (timestamp).
+ *The Amazon Resource Name (ARN) of a FeatureGroup.
The current status of the labeling job.
+ *The name of the FeatureGroup.
Counts showing the progress of the labeling job.
+ *The name of the Feature whose value uniquely identifies a
+ * Record defined in the FeatureGroup
+ * FeatureDefinitions.
The Amazon Resource Name (ARN) of the work team assigned to the job.
+ *The name of the feature that stores the EventTime of a Record in a
+ * FeatureGroup.
A EventTime is point in time when a new event occurs that corresponds to
+ * the creation or update of a Record in FeatureGroup. All
+ * Records in the FeatureGroup must have a corresponding
+ * EventTime.
The Amazon Resource Name (ARN) of a Lambda function. The function is run before each - * data object is sent to a worker.
+ *A list of Features. Each Feature must include a
+ * FeatureName and a FeatureType.
Valid FeatureTypes are Integral, Fractional and
+ * String.
+ * FeatureNames cannot be any of the following: is_deleted,
+ * write_time, api_invocation_time.
You can create up to 2,500 FeatureDefinitions per
+ * FeatureGroup.
The Amazon Resource Name (ARN) of the Lambda function used to consolidate the - * annotations from individual workers into a label for a data object. For more - * information, see Annotation - * Consolidation.
+ *The time a FeatureGroup was created.
If the LabelingJobStatus field is Failed, this field
- * contains a description of the error.
A timestamp indicating the last time you updated the feature group.
* @public */ - FailureReason?: string | undefined; + LastModifiedTime?: Date | undefined; /** - *The location of the output produced by the labeling job.
+ *Use this to specify the Amazon Web Services Key Management Service (KMS) Key ID, or
+ * KMSKeyId, for at rest data encryption. You can turn
+ * OnlineStore on or off by specifying the EnableOnlineStore flag
+ * at General Assembly.
The default value is False.
Input configuration for the labeling job.
+ *The configuration of an OfflineStore.
Provide an OfflineStoreConfig in a request to
+ * CreateFeatureGroup to create an OfflineStore.
To encrypt an OfflineStore using at rest data encryption, specify Amazon Web Services Key Management Service (KMS) key ID, or KMSKeyId, in
+ * S3StorageConfig.
Metadata for a Lambda step.
- * @public - */ -export interface LambdaStepMetadata { /** - *The Amazon Resource Name (ARN) of the Lambda function that was run by this step execution.
+ *The Amazon Resource Name (ARN) of the IAM execution role used to create the feature + * group.
* @public */ - Arn?: string | undefined; + RoleArn?: string | undefined; /** - *A list of the output parameters of the Lambda step.
+ *A FeatureGroup status.
Lists a summary of the properties of a lineage group. A lineage group provides a group of shareable lineage entity - * resources.
- * @public - */ -export interface LineageGroupSummary { /** - *The Amazon Resource Name (ARN) of the lineage group resource.
+ *The status of OfflineStore.
The name or Amazon Resource Name (ARN) of the lineage group.
+ *A value that indicates whether the feature group was updated successfully.
* @public */ - LineageGroupName?: string | undefined; + LastUpdateStatus?: LastUpdateStatus | undefined; /** - *The display name of the lineage group summary.
+ *The reason that the FeatureGroup failed to be replicated in the
+ * OfflineStore. This is failure may be due to a failure to create a
+ * FeatureGroup in or delete a FeatureGroup from the
+ * OfflineStore.
The creation time of the lineage group summary.
+ *A free form description of a FeatureGroup.
The last modified time of the lineage group summary.
+ *Tags used to define a FeatureGroup.
The name, ARN, CreationTime, FeatureGroup values,
+ * LastUpdatedTime and EnableOnlineStorage status of a
+ * FeatureGroup.
A filter that returns only actions with the specified source URI.
- * @public - */ - SourceUri?: string | undefined; - - /** - *A filter that returns only actions of the specified type.
- * @public - */ - ActionType?: string | undefined; - - /** - *A filter that returns only actions created on or after the specified time.
- * @public - */ - CreatedAfter?: Date | undefined; - +export interface FeatureGroupSummary { /** - *A filter that returns only actions created on or before the specified time.
+ *The name of FeatureGroup.
The property used to sort results. The default value is CreationTime.
Unique identifier for the FeatureGroup.
The sort order. The default value is Descending.
A timestamp indicating the time of creation time of the
+ * FeatureGroup.
If the previous call to ListActions didn't return the full set of actions,
- * the call returns a token for getting the next set of actions.
The status of a FeatureGroup. The status can be any of the following:
+ * Creating, Created, CreateFail,
+ * Deleting or DetailFail.
The maximum number of actions to return in the response. The default value is 10.
+ *Notifies you if replicating data into the OfflineStore has failed. Returns
+ * either: Active or Blocked.
The metadata for a feature. It can either be metadata that you specify, or metadata that + * is updated automatically.
* @public */ -export interface ListActionsResponse { +export interface FeatureMetadata { /** - *A list of actions and their properties.
+ *The Amazon Resource Number (ARN) of the feature group.
* @public */ - ActionSummaries?: ActionSummary[] | undefined; + FeatureGroupArn?: string | undefined; /** - *A token for getting the next set of actions, if there are any.
+ *The name of the feature group containing the feature.
* @public */ - NextToken?: string | undefined; -} + FeatureGroupName?: string | undefined; -/** - * @public - */ -export interface ListAlgorithmsInput { /** - *A filter that returns only algorithms created after the specified time - * (timestamp).
+ *The name of feature.
* @public */ - CreationTimeAfter?: Date | undefined; + FeatureName?: string | undefined; /** - *A filter that returns only algorithms created before the specified time - * (timestamp).
+ *The data type of the feature.
* @public */ - CreationTimeBefore?: Date | undefined; + FeatureType?: FeatureType | undefined; /** - *The maximum number of algorithms to return in the response.
+ *A timestamp indicating when the feature was created.
* @public */ - MaxResults?: number | undefined; + CreationTime?: Date | undefined; /** - *A string in the algorithm name. This filter returns only algorithms whose name - * contains the specified string.
+ *A timestamp indicating when the feature was last modified.
* @public */ - NameContains?: string | undefined; + LastModifiedTime?: Date | undefined; /** - *If the response to a previous ListAlgorithms request was truncated, the
- * response includes a NextToken. To retrieve the next set of algorithms, use
- * the token in the next request.
An optional description that you specify to better describe the feature.
* @public */ - NextToken?: string | undefined; + Description?: string | undefined; /** - *The parameter by which to sort the results. The default is
- * CreationTime.
Optional key-value pairs that you specify to better describe the feature.
* @public */ - SortBy?: AlgorithmSortBy | undefined; + Parameters?: FeatureParameter[] | undefined; +} + +/** + * @public + * @enum + */ +export const Operator = { + CONTAINS: "Contains", + EQUALS: "Equals", + EXISTS: "Exists", + GREATER_THAN: "GreaterThan", + GREATER_THAN_OR_EQUAL_TO: "GreaterThanOrEqualTo", + IN: "In", + LESS_THAN: "LessThan", + LESS_THAN_OR_EQUAL_TO: "LessThanOrEqualTo", + NOT_EQUALS: "NotEquals", + NOT_EXISTS: "NotExists", +} as const; + +/** + * @public + */ +export type Operator = (typeof Operator)[keyof typeof Operator]; +/** + *A conditional statement for a search expression that includes a resource property, a + * Boolean operator, and a value. Resources that match the statement are returned in the + * results from the Search API.
+ *If you specify a Value, but not an Operator, SageMaker uses the
+ * equals operator.
In search, there are several property types:
+ *To define a metric filter, enter a value using the form
+ * "Metrics., where "accuracy" metric greater than
+ * "0.9":
+ * \{
+ *
+ * "Name": "Metrics.accuracy",
+ *
+ * "Operator": "GreaterThan",
+ *
+ * "Value": "0.9"
+ *
+ * \}
+ *
To define a hyperparameter filter, enter a value with the form
+ * "HyperParameters.. Decimal hyperparameter
+ * values are treated as a decimal in a comparison if the specified
+ * Value is also a decimal value. If the specified
+ * Value is an integer, the decimal hyperparameter values are
+ * treated as integers. For example, the following filter is satisfied by
+ * training jobs with a "learning_rate" hyperparameter that is
+ * less than "0.5":
+ * \{
+ *
+ * "Name": "HyperParameters.learning_rate",
+ *
+ * "Operator": "LessThan",
+ *
+ * "Value": "0.5"
+ *
+ * \}
+ *
To define a tag filter, enter a value with the form
+ * Tags..
The sort order for the results. The default is Ascending.
A resource property name. For example, TrainingJobName. For
+ * valid property names, see SearchRecord.
+ * You must specify a valid property for the resource.
>An array of AlgorithmSummary objects, each of which lists an
- * algorithm.
A Boolean binary operator that is used to evaluate the filter. The operator field + * contains one of the following values:
+ *The value of Name equals Value.
The value of Name doesn't equal Value.
The Name property exists.
The Name property does not exist.
The value of Name is greater than Value.
+ * Not supported for text properties.
The value of Name is greater than or equal to Value.
+ * Not supported for text properties.
The value of Name is less than Value.
+ * Not supported for text properties.
The value of Name is less than or equal to Value.
+ * Not supported for text properties.
The value of Name is one of the comma delimited strings in
+ * Value. Only supported for text properties.
The value of Name contains the string Value.
+ * Only supported for text properties.
A SearchExpression can include the Contains operator
+ * multiple times when the value of Name is one of the following:
+ * Experiment.DisplayName
+ *
+ * Experiment.ExperimentName
+ *
+ * Experiment.Tags
+ *
+ * Trial.DisplayName
+ *
+ * Trial.TrialName
+ *
+ * Trial.Tags
+ *
+ * TrialComponent.DisplayName
+ *
+ * TrialComponent.TrialComponentName
+ *
+ * TrialComponent.Tags
+ *
+ * TrialComponent.InputArtifacts
+ *
+ * TrialComponent.OutputArtifacts
+ *
A SearchExpression can include only one Contains operator
+ * for all other values of Name. In these cases, if you include multiple
+ * Contains operators in the SearchExpression, the result is
+ * the following error message: "'CONTAINS' operator usage limit of 1
+ * exceeded."
If the response is truncated, SageMaker returns this token. To retrieve the next set of - * algorithms, use it in the subsequent request.
+ *A value used with Name and Operator to determine which
+ * resources satisfy the filter's condition. For numerical properties, Value
+ * must be an integer or floating-point decimal. For timestamp properties,
+ * Value must be an ISO 8601 date-time string of the following format:
+ * YYYY-mm-dd'T'HH:MM:SS.
Contains summary information about the flow definition.
* @public */ -export interface ListAliasesRequest { +export interface FlowDefinitionSummary { /** - *The name of the image.
+ *The name of the flow definition.
* @public */ - ImageName: string | undefined; + FlowDefinitionName: string | undefined; /** - *The alias of the image version.
+ *The Amazon Resource Name (ARN) of the flow definition.
* @public */ - Alias?: string | undefined; + FlowDefinitionArn: string | undefined; /** - *The version of the image. If image version is not specified, the aliases of all versions of the image are listed.
+ *The status of the flow definition. Valid values:
* @public */ - Version?: number | undefined; + FlowDefinitionStatus: FlowDefinitionStatus | undefined; /** - *The maximum number of aliases to return.
+ *The timestamp when SageMaker created the flow definition.
* @public */ - MaxResults?: number | undefined; + CreationTime: Date | undefined; /** - *If the previous call to ListAliases didn't return the full set of
- * aliases, the call returns a token for retrieving the next set of aliases.
The reason why the flow definition creation failed. A failure reason is returned only when the flow definition status is Failed.
A list of SageMaker image version aliases.
- * @public - */ - SageMakerImageVersionAliases?: string[] | undefined; - +export interface GetDeviceFleetReportRequest { /** - *A token for getting the next set of aliases, if more aliases exist.
+ *The name of the fleet.
* @public */ - NextToken?: string | undefined; + DeviceFleetName: string | undefined; } /** - * @public - */ -export interface ListAppImageConfigsRequest { - /** - *The total number of items to return in the response. If the total
- * number of items available is more than the value specified, a NextToken
- * is provided in the response. To resume pagination, provide the NextToken
- * value in the as part of a subsequent call. The default value is 10.
If the previous call to ListImages didn't return the full set of
- * AppImageConfigs, the call returns a token for getting the next set of AppImageConfigs.
A filter that returns only AppImageConfigs whose name contains the specified string.
- * @public - */ - NameContains?: string | undefined; - - /** - *A filter that returns only AppImageConfigs created on or before the specified time.
- * @public - */ - CreationTimeBefore?: Date | undefined; - - /** - *A filter that returns only AppImageConfigs created on or after the specified time.
- * @public - */ - CreationTimeAfter?: Date | undefined; - - /** - *A filter that returns only AppImageConfigs modified on or before the specified time.
- * @public - */ - ModifiedTimeBefore?: Date | undefined; - - /** - *A filter that returns only AppImageConfigs modified on or after the specified time.
- * @public - */ - ModifiedTimeAfter?: Date | undefined; - + * @public + */ +export interface GetDeviceFleetReportResponse { /** - *The property used to sort results. The default value is CreationTime.
The Amazon Resource Name (ARN) of the device.
* @public */ - SortBy?: AppImageConfigSortKey | undefined; + DeviceFleetArn: string | undefined; /** - *The sort order. The default value is Descending.
The name of the fleet.
* @public */ - SortOrder?: SortOrder | undefined; -} + DeviceFleetName: string | undefined; -/** - * @public - */ -export interface ListAppImageConfigsResponse { /** - *A token for getting the next set of AppImageConfigs, if there are any.
+ *The output configuration for storing sample data collected by the fleet.
* @public */ - NextToken?: string | undefined; + OutputConfig?: EdgeOutputConfig | undefined; /** - *A list of AppImageConfigs and their properties.
+ *Description of the fleet.
* @public */ - AppImageConfigs?: AppImageConfigDetails[] | undefined; -} + Description?: string | undefined; -/** - * @public - */ -export interface ListAppsRequest { /** - *If the previous response was truncated, you will receive this token. Use it in your next - * request to receive the next set of results.
+ *Timestamp of when the report was generated.
* @public */ - NextToken?: string | undefined; + ReportGenerated?: Date | undefined; /** - *This parameter defines the maximum number of results that can be return in a single
- * response. The MaxResults parameter is an upper bound, not a target. If there are
- * more results available than the value specified, a NextToken is provided in the
- * response. The NextToken indicates that the user should get the next set of
- * results by providing this token as a part of a subsequent call. The default value for
- * MaxResults is 10.
Status of devices.
* @public */ - MaxResults?: number | undefined; + DeviceStats?: DeviceStats | undefined; /** - *The sort order for the results. The default is Ascending.
+ *The versions of Edge Manager agent deployed on the fleet.
* @public */ - SortOrder?: SortOrder | undefined; + AgentVersions?: AgentVersion[] | undefined; /** - *The parameter by which to sort the results. The default is CreationTime.
+ *Status of model on device.
* @public */ - SortBy?: AppSortKey | undefined; + ModelStats?: EdgeModelStat[] | undefined; +} +/** + * @public + */ +export interface GetLineageGroupPolicyRequest { /** - *A parameter to search for the domain ID.
+ *The name or Amazon Resource Name (ARN) of the lineage group.
* @public */ - DomainIdEquals?: string | undefined; + LineageGroupName: string | undefined; +} +/** + * @public + */ +export interface GetLineageGroupPolicyResponse { /** - *A parameter to search by user profile name. If SpaceNameEquals is set, then
- * this value cannot be set.
The Amazon Resource Name (ARN) of the lineage group.
* @public */ - UserProfileNameEquals?: string | undefined; + LineageGroupArn?: string | undefined; /** - *A parameter to search by space name. If UserProfileNameEquals is set, then
- * this value cannot be set.
The resource policy that gives access to the lineage group in another account.
* @public */ - SpaceNameEquals?: string | undefined; + ResourcePolicy?: string | undefined; } /** * @public */ -export interface ListAppsResponse { +export interface GetModelPackageGroupPolicyInput { /** - *The list of apps.
+ *The name of the model group for which to get the resource policy.
* @public */ - Apps?: AppDetails[] | undefined; + ModelPackageGroupName: string | undefined; +} +/** + * @public + */ +export interface GetModelPackageGroupPolicyOutput { /** - *If the previous response was truncated, you will receive this token. Use it in your next - * request to receive the next set of results.
+ *The resource policy for the model group.
* @public */ - NextToken?: string | undefined; + ResourcePolicy: string | undefined; } +/** + * @public + */ +export interface GetSagemakerServicecatalogPortfolioStatusInput {} + /** * @public * @enum */ -export const SortArtifactsBy = { - CREATION_TIME: "CreationTime", +export const SagemakerServicecatalogStatus = { + DISABLED: "Disabled", + ENABLED: "Enabled", } as const; /** * @public */ -export type SortArtifactsBy = (typeof SortArtifactsBy)[keyof typeof SortArtifactsBy]; +export type SagemakerServicecatalogStatus = + (typeof SagemakerServicecatalogStatus)[keyof typeof SagemakerServicecatalogStatus]; /** * @public */ -export interface ListArtifactsRequest { +export interface GetSagemakerServicecatalogPortfolioStatusOutput { /** - *A filter that returns only artifacts with the specified source URI.
+ *Whether Service Catalog is enabled or disabled in SageMaker.
* @public */ - SourceUri?: string | undefined; + Status?: SagemakerServicecatalogStatus | undefined; +} +/** + *An object where you specify the anticipated traffic pattern for an endpoint.
+ * @public + */ +export interface ScalingPolicyObjective { /** - *A filter that returns only artifacts of the specified type.
+ *The minimum number of expected requests to your endpoint per minute.
* @public */ - ArtifactType?: string | undefined; + MinInvocationsPerMinute?: number | undefined; /** - *A filter that returns only artifacts created on or after the specified time.
+ *The maximum number of expected requests to your endpoint per minute.
* @public */ - CreatedAfter?: Date | undefined; + MaxInvocationsPerMinute?: number | undefined; +} +/** + * @public + */ +export interface GetScalingConfigurationRecommendationRequest { /** - *A filter that returns only artifacts created on or before the specified time.
+ *The name of a previously completed Inference Recommender job.
* @public */ - CreatedBefore?: Date | undefined; + InferenceRecommendationsJobName: string | undefined; /** - *The property used to sort results. The default value is CreationTime.
The recommendation ID of a previously completed inference recommendation. This ID should come from one of the
+ * recommendations returned by the job specified in the InferenceRecommendationsJobName field.
Specify either this field or the EndpointName field.
The sort order. The default value is Descending.
The name of an endpoint benchmarked during a previously completed inference recommendation job. This name should come from one of the
+ * recommendations returned by the job specified in the InferenceRecommendationsJobName field.
Specify either this field or the RecommendationId field.
If the previous call to ListArtifacts didn't return the full set of artifacts,
- * the call returns a token for getting the next set of artifacts.
The percentage of how much utilization you want an instance to use before autoscaling. The default value is 50%.
* @public */ - NextToken?: string | undefined; + TargetCpuUtilizationPerCore?: number | undefined; /** - *The maximum number of artifacts to return in the response. The default value is 10.
+ *An object where you specify the anticipated traffic pattern for an endpoint.
* @public */ - MaxResults?: number | undefined; + ScalingPolicyObjective?: ScalingPolicyObjective | undefined; } /** + *The metric for a scaling policy.
* @public */ -export interface ListArtifactsResponse { +export interface ScalingPolicyMetric { /** - *A list of artifacts and their properties.
+ *The number of invocations sent to a model, normalized by InstanceCount
+ * in each ProductionVariant. 1/numberOfInstances is sent as the value on each
+ * request, where numberOfInstances is the number of active instances for the
+ * ProductionVariant behind the endpoint at the time of the request.
A token for getting the next set of artifacts, if there are any.
+ *The interval of time taken by a model to respond as viewed from SageMaker. + * This interval includes the local communication times taken to send the request + * and to fetch the response from the container of a model and the time taken to + * complete the inference in the container.
* @public */ - NextToken?: string | undefined; + ModelLatency?: number | undefined; } -/** - * @public - * @enum - */ -export const SortAssociationsBy = { - CREATION_TIME: "CreationTime", - DESTINATION_ARN: "DestinationArn", - DESTINATION_TYPE: "DestinationType", - SOURCE_ARN: "SourceArn", - SOURCE_TYPE: "SourceType", -} as const; - /** * @public */ -export type SortAssociationsBy = (typeof SortAssociationsBy)[keyof typeof SortAssociationsBy]; +export interface GetScalingConfigurationRecommendationResponse { + /** + *The name of a previously completed Inference Recommender job.
+ * @public + */ + InferenceRecommendationsJobName?: string | undefined; -/** - * @public - */ -export interface ListAssociationsRequest { /** - *A filter that returns only associations with the specified source ARN.
+ *The recommendation ID of a previously completed inference recommendation.
* @public */ - SourceArn?: string | undefined; + RecommendationId?: string | undefined; /** - *A filter that returns only associations with the specified destination Amazon Resource Name (ARN).
+ *The name of an endpoint benchmarked during a previously completed Inference Recommender job.
* @public */ - DestinationArn?: string | undefined; + EndpointName?: string | undefined; /** - *A filter that returns only associations with the specified source type.
+ *The percentage of how much utilization you want an instance to use before autoscaling, which you specified in the request. The default value is 50%.
* @public */ - SourceType?: string | undefined; + TargetCpuUtilizationPerCore?: number | undefined; /** - *A filter that returns only associations with the specified destination type.
+ *An object representing the anticipated traffic pattern for an endpoint that you specified in the request.
* @public */ - DestinationType?: string | undefined; + ScalingPolicyObjective?: ScalingPolicyObjective | undefined; /** - *A filter that returns only associations of the specified type.
+ *An object with a list of metrics that were benchmarked during the previously completed Inference Recommender job.
* @public */ - AssociationType?: AssociationEdgeType | undefined; + Metric?: ScalingPolicyMetric | undefined; /** - *A filter that returns only associations created on or after the specified time.
+ *An object with the recommended values for you to specify when creating an autoscaling policy.
* @public */ - CreatedAfter?: Date | undefined; + DynamicScalingConfiguration?: DynamicScalingConfiguration | undefined; +} + +/** + * @public + * @enum + */ +export const ResourceType = { + ENDPOINT: "Endpoint", + EXPERIMENT: "Experiment", + EXPERIMENT_TRIAL: "ExperimentTrial", + EXPERIMENT_TRIAL_COMPONENT: "ExperimentTrialComponent", + FEATURE_GROUP: "FeatureGroup", + FEATURE_METADATA: "FeatureMetadata", + HYPER_PARAMETER_TUNING_JOB: "HyperParameterTuningJob", + IMAGE: "Image", + IMAGE_VERSION: "ImageVersion", + MODEL: "Model", + MODEL_CARD: "ModelCard", + MODEL_PACKAGE: "ModelPackage", + MODEL_PACKAGE_GROUP: "ModelPackageGroup", + PIPELINE: "Pipeline", + PIPELINE_EXECUTION: "PipelineExecution", + PROJECT: "Project", + TRAINING_JOB: "TrainingJob", +} as const; + +/** + * @public + */ +export type ResourceType = (typeof ResourceType)[keyof typeof ResourceType]; +/** + *Part of the SuggestionQuery type. Specifies a hint for retrieving property
+ * names that begin with the specified text.
A filter that returns only associations created on or before the specified time.
+ *Text that begins a property's name.
* @public */ - CreatedBefore?: Date | undefined; + PropertyNameHint: string | undefined; +} +/** + *Specified in the GetSearchSuggestions request. + * Limits the property names that are included in the response.
+ * @public + */ +export interface SuggestionQuery { /** - *The property used to sort results. The default value is CreationTime.
Defines a property name hint. Only property + * names that begin with the specified hint are included in the response.
* @public */ - SortBy?: SortAssociationsBy | undefined; + PropertyNameQuery?: PropertyNameQuery | undefined; +} +/** + * @public + */ +export interface GetSearchSuggestionsRequest { /** - *The sort order. The default value is Descending.
The name of the SageMaker resource to search for.
* @public */ - SortOrder?: SortOrder | undefined; + Resource: ResourceType | undefined; /** - *If the previous call to ListAssociations didn't return the full set of associations,
- * the call returns a token for getting the next set of associations.
Limits the property names that are included in the response.
* @public */ - NextToken?: string | undefined; + SuggestionQuery?: SuggestionQuery | undefined; +} +/** + *A property name returned from a GetSearchSuggestions call that specifies
+ * a value in the PropertyNameQuery field.
The maximum number of associations to return in the response. The default value is 10.
+ *A suggested property name based on what you entered in the search textbox in the SageMaker + * console.
* @public */ - MaxResults?: number | undefined; + PropertyName?: string | undefined; } /** * @public */ -export interface ListAssociationsResponse { +export interface GetSearchSuggestionsResponse { /** - *A list of associations and their properties.
+ *A list of property names for a Resource that match a
+ * SuggestionQuery.
Specifies configuration details for a Git repository when the repository is + * updated.
+ * @public + */ +export interface GitConfigForUpdate { /** - *A token for getting the next set of associations, if there are any.
+ *The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that
+ * contains the credentials used to access the git repository. The secret must have a
+ * staging label of AWSCURRENT and must be in the following format:
+ * \{"username": UserName, "password":
+ * Password\}
+ *
Information about hub content.
* @public */ -export interface ListAutoMLJobsRequest { +export interface HubContentInfo { /** - *Request a list of jobs, using a filter for time.
+ *The name of the hub content.
* @public */ - CreationTimeAfter?: Date | undefined; + HubContentName: string | undefined; /** - *Request a list of jobs, using a filter for time.
+ *The Amazon Resource Name (ARN) of the hub content.
* @public */ - CreationTimeBefore?: Date | undefined; + HubContentArn: string | undefined; /** - *Request a list of jobs, using a filter for time.
+ *The ARN of the public hub content.
* @public */ - LastModifiedTimeAfter?: Date | undefined; + SageMakerPublicHubContentArn?: string | undefined; /** - *Request a list of jobs, using a filter for time.
+ *The version of the hub content.
* @public */ - LastModifiedTimeBefore?: Date | undefined; + HubContentVersion: string | undefined; /** - *Request a list of jobs, using a search filter for name.
+ *The type of hub content.
* @public */ - NameContains?: string | undefined; + HubContentType: HubContentType | undefined; /** - *Request a list of jobs, using a filter for status.
+ *The version of the hub content document schema.
* @public */ - StatusEquals?: AutoMLJobStatus | undefined; + DocumentSchemaVersion: string | undefined; /** - *The sort order for the results. The default is Descending.
The display name of the hub content.
* @public */ - SortOrder?: AutoMLSortOrder | undefined; + HubContentDisplayName?: string | undefined; /** - *The parameter by which to sort the results. The default is Name.
A description of the hub content.
* @public */ - SortBy?: AutoMLSortBy | undefined; + HubContentDescription?: string | undefined; /** - *Request a list of jobs up to a specified limit.
+ *The support status of the hub content.
* @public */ - MaxResults?: number | undefined; + SupportStatus?: HubContentSupportStatus | undefined; /** - *If the previous response was truncated, you receive this token. Use it in your next - * request to receive the next set of results.
+ *The searchable keywords for the hub content.
* @public */ - NextToken?: string | undefined; -} + HubContentSearchKeywords?: string[] | undefined; -/** - * @public - */ -export interface ListAutoMLJobsResponse { /** - *Returns a summary list of jobs.
+ *The status of the hub content.
* @public */ - AutoMLJobSummaries: AutoMLJobSummary[] | undefined; + HubContentStatus: HubContentStatus | undefined; /** - *If the previous response was truncated, you receive this token. Use it in your next - * request to receive the next set of results.
+ *The date and time that the hub content was created.
* @public */ - NextToken?: string | undefined; + CreationTime: Date | undefined; + + /** + *The date and time when the hub content was originally created, before any updates or revisions.
+ * @public + */ + OriginalCreationTime?: Date | undefined; } /** * @public + * @enum */ -export interface ListCandidatesForAutoMLJobRequest { +export const HubContentSortBy = { + CREATION_TIME: "CreationTime", + HUB_CONTENT_NAME: "HubContentName", + HUB_CONTENT_STATUS: "HubContentStatus", +} as const; + +/** + * @public + */ +export type HubContentSortBy = (typeof HubContentSortBy)[keyof typeof HubContentSortBy]; + +/** + *Information about a hub.
+ * @public + */ +export interface HubInfo { /** - *List the candidates created for the job by providing the job's name.
+ *The name of the hub.
* @public */ - AutoMLJobName: string | undefined; + HubName: string | undefined; /** - *List the candidates for the job and filter by status.
+ *The Amazon Resource Name (ARN) of the hub.
* @public */ - StatusEquals?: CandidateStatus | undefined; + HubArn: string | undefined; /** - *List the candidates for the job and filter by candidate name.
+ *The display name of the hub.
* @public */ - CandidateNameEquals?: string | undefined; + HubDisplayName?: string | undefined; /** - *The sort order for the results. The default is Ascending.
A description of the hub.
* @public */ - SortOrder?: AutoMLSortOrder | undefined; + HubDescription?: string | undefined; /** - *The parameter by which to sort the results. The default is
- * Descending.
The searchable keywords for the hub.
* @public */ - SortBy?: CandidateSortBy | undefined; + HubSearchKeywords?: string[] | undefined; /** - *List the job's candidates up to a specified limit.
+ *The status of the hub.
* @public */ - MaxResults?: number | undefined; + HubStatus: HubStatus | undefined; /** - *If the previous response was truncated, you receive this token. Use it in your next - * request to receive the next set of results.
+ *The date and time that the hub was created.
* @public */ - NextToken?: string | undefined; + CreationTime: Date | undefined; + + /** + *The date and time that the hub was last modified.
+ * @public + */ + LastModifiedTime: Date | undefined; } /** * @public + * @enum */ -export interface ListCandidatesForAutoMLJobResponse { +export const HubSortBy = { + ACCOUNT_ID_OWNER: "AccountIdOwner", + CREATION_TIME: "CreationTime", + HUB_NAME: "HubName", + HUB_STATUS: "HubStatus", +} as const; + +/** + * @public + */ +export type HubSortBy = (typeof HubSortBy)[keyof typeof HubSortBy]; + +/** + *Container for human task user interface information.
+ * @public + */ +export interface HumanTaskUiSummary { /** - *Summaries about the AutoMLCandidates.
The name of the human task user interface.
* @public */ - Candidates: AutoMLCandidate[] | undefined; + HumanTaskUiName: string | undefined; /** - *If the previous response was truncated, you receive this token. Use it in your next - * request to receive the next set of results.
+ *The Amazon Resource Name (ARN) of the human task user interface.
* @public */ - NextToken?: string | undefined; + HumanTaskUiArn: string | undefined; + + /** + *A timestamp when SageMaker created the human task user interface.
+ * @public + */ + CreationTime: Date | undefined; } /** + *An entity returned by the SearchRecord API + * containing the properties of a hyperparameter tuning job.
* @public */ -export interface ListClusterNodesRequest { +export interface HyperParameterTuningJobSearchEntity { /** - *The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster in which you want to retrieve the - * list of nodes.
+ *The name of a hyperparameter tuning job.
* @public */ - ClusterName: string | undefined; - - /** - *A filter that returns nodes in a SageMaker HyperPod cluster created after the specified time. - * Timestamps are formatted according to the ISO 8601 standard.
- *Acceptable formats include:
- *
- * YYYY-MM-DDThh:mm:ss.sssTZD (UTC), for example,
- * 2014-10-01T20:30:00.000Z
- *
- * YYYY-MM-DDThh:mm:ss.sssTZD (with offset), for example,
- * 2014-10-01T12:30:00.000-08:00
- *
- * YYYY-MM-DD, for example, 2014-10-01
- *
Unix time in seconds, for example, 1412195400. This is also referred
- * to as Unix Epoch time and represents the number of seconds since midnight, January 1,
- * 1970 UTC.
For more information about the timestamp format, see Timestamp in the Amazon Web Services Command Line Interface User - * Guide.
+ HyperParameterTuningJobName?: string | undefined; + + /** + *The Amazon Resource Name (ARN) of a hyperparameter tuning job.
* @public */ - CreationTimeAfter?: Date | undefined; + HyperParameterTuningJobArn?: string | undefined; /** - *A filter that returns nodes in a SageMaker HyperPod cluster created before the specified time. The
- * acceptable formats are the same as the timestamp formats for
- * CreationTimeAfter. For more information about the timestamp format, see Timestamp in the Amazon Web Services Command Line Interface User
- * Guide.
Configures a hyperparameter tuning job.
* @public */ - CreationTimeBefore?: Date | undefined; + HyperParameterTuningJobConfig?: HyperParameterTuningJobConfig | undefined; /** - *A filter that returns the instance groups whose name contain a specified string.
+ *Defines + * the training jobs launched by a hyperparameter tuning job.
* @public */ - InstanceGroupNameContains?: string | undefined; + TrainingJobDefinition?: HyperParameterTrainingJobDefinition | undefined; /** - *The maximum number of nodes to return in the response.
+ *The job definitions included in a hyperparameter tuning job.
* @public */ - MaxResults?: number | undefined; + TrainingJobDefinitions?: HyperParameterTrainingJobDefinition[] | undefined; /** - *If the result of the previous ListClusterNodes request was truncated, the
- * response includes a NextToken. To retrieve the next set of cluster nodes, use
- * the token in the next request.
The status of a hyperparameter tuning job.
* @public */ - NextToken?: string | undefined; + HyperParameterTuningJobStatus?: HyperParameterTuningJobStatus | undefined; /** - *The field by which to sort results. The default value is
- * CREATION_TIME.
The time that a hyperparameter tuning job was created.
* @public */ - SortBy?: ClusterSortBy | undefined; + CreationTime?: Date | undefined; /** - *The sort order for results. The default value is Ascending.
The time that a hyperparameter tuning job ended.
* @public */ - SortOrder?: SortOrder | undefined; -} + HyperParameterTuningEndTime?: Date | undefined; -/** - * @public - */ -export interface ListClusterNodesResponse { /** - *The next token specified for listing instances in a SageMaker HyperPod cluster.
+ *The time that a hyperparameter tuning job was last modified.
* @public */ - NextToken: string | undefined; + LastModifiedTime?: Date | undefined; /** - *The summaries of listed instances in a SageMaker HyperPod cluster
+ *The numbers of training jobs launched by a hyperparameter tuning job, categorized by + * status.
* @public */ - ClusterNodeSummaries: ClusterNodeSummary[] | undefined; -} + TrainingJobStatusCounters?: TrainingJobStatusCounters | undefined; -/** - * @public - */ -export interface ListClustersRequest { /** - *Set a start time for the time range during which you want to list SageMaker HyperPod clusters. - * Timestamps are formatted according to the ISO 8601 standard.
- *Acceptable formats include:
- *
- * YYYY-MM-DDThh:mm:ss.sssTZD (UTC), for example,
- * 2014-10-01T20:30:00.000Z
- *
- * YYYY-MM-DDThh:mm:ss.sssTZD (with offset), for example,
- * 2014-10-01T12:30:00.000-08:00
- *
- * YYYY-MM-DD, for example, 2014-10-01
- *
Unix time in seconds, for example, 1412195400. This is also referred
- * to as Unix Epoch time and represents the number of seconds since midnight, January 1,
- * 1970 UTC.
For more information about the timestamp format, see Timestamp in the Amazon Web Services Command Line Interface User - * Guide.
+ *Specifies the number of training jobs that this hyperparameter tuning job launched, + * categorized by the status of their objective metric. The objective metric status shows + * whether the + * final + * objective metric for the training job has been evaluated by the + * tuning job and used in the hyperparameter tuning process.
* @public */ - CreationTimeAfter?: Date | undefined; + ObjectiveStatusCounters?: ObjectiveStatusCounters | undefined; /** - *Set an end time for the time range during which you want to list SageMaker HyperPod clusters. A
- * filter that returns nodes in a SageMaker HyperPod cluster created before the specified time. The
- * acceptable formats are the same as the timestamp formats for
- * CreationTimeAfter. For more information about the timestamp format, see Timestamp in the Amazon Web Services Command Line Interface User
- * Guide.
The container for the summary information about a training job.
* @public */ - CreationTimeBefore?: Date | undefined; + BestTrainingJob?: HyperParameterTrainingJobSummary | undefined; /** - *Set the maximum number of SageMaker HyperPod clusters to list.
+ *The container for the summary information about a training job.
* @public */ - MaxResults?: number | undefined; + OverallBestTrainingJob?: HyperParameterTrainingJobSummary | undefined; /** - *Set the maximum number of instances to print in the list.
+ *Specifies the configuration for a hyperparameter tuning job that uses one or more + * previous hyperparameter tuning jobs as a starting point. The results of previous tuning + * jobs are used to inform which combinations of hyperparameters to search over in the new + * tuning job.
+ *All training jobs launched by the new hyperparameter tuning job are evaluated by using + * the objective metric, and the training job that performs the best is compared to the + * best training jobs from the parent tuning jobs. From these, the training job that + * performs the best as measured by the objective metric is returned as the overall best + * training job.
+ *All training jobs launched by parent hyperparameter tuning jobs and the new + * hyperparameter tuning jobs count against the limit of training jobs for the tuning + * job.
+ *Set the next token to retrieve the list of SageMaker HyperPod clusters.
+ *The error that was created when a hyperparameter tuning job failed.
* @public */ - NextToken?: string | undefined; + FailureReason?: string | undefined; /** - *The field by which to sort results. The default value is
- * CREATION_TIME.
Information about either a current or completed hyperparameter tuning job.
* @public */ - SortBy?: ClusterSortBy | undefined; + TuningJobCompletionDetails?: HyperParameterTuningJobCompletionDetails | undefined; /** - *The sort order for results. The default value is Ascending.
The total amount of resources consumed by a hyperparameter tuning job.
* @public */ - SortOrder?: SortOrder | undefined; + ConsumedResources?: HyperParameterTuningJobConsumedResources | undefined; + + /** + *The tags associated with a hyperparameter tuning job. For more information see Tagging Amazon Web Services resources.
+ * @public + */ + Tags?: Tag[] | undefined; } /** * @public + * @enum */ -export interface ListClustersResponse { +export const HyperParameterTuningJobSortByOptions = { + CreationTime: "CreationTime", + Name: "Name", + Status: "Status", +} as const; + +/** + * @public + */ +export type HyperParameterTuningJobSortByOptions = + (typeof HyperParameterTuningJobSortByOptions)[keyof typeof HyperParameterTuningJobSortByOptions]; + +/** + *Provides summary information about a hyperparameter tuning job.
+ * @public + */ +export interface HyperParameterTuningJobSummary { /** - *If the result of the previous ListClusters request was truncated, the
- * response includes a NextToken. To retrieve the next set of clusters, use the
- * token in the next request.
The name of the tuning job.
* @public */ - NextToken: string | undefined; + HyperParameterTuningJobName: string | undefined; /** - *The summaries of listed SageMaker HyperPod clusters.
+ *The + * Amazon + * Resource Name (ARN) of the tuning job.
* @public */ - ClusterSummaries: ClusterSummary[] | undefined; -} + HyperParameterTuningJobArn: string | undefined; -/** - * @public - */ -export interface ListCodeRepositoriesInput { /** - *A filter that returns only Git repositories that were created after the specified - * time.
+ *The status of the + * tuning + * job.
* @public */ - CreationTimeAfter?: Date | undefined; + HyperParameterTuningJobStatus: HyperParameterTuningJobStatus | undefined; /** - *A filter that returns only Git repositories that were created before the specified - * time.
+ *Specifies the search strategy hyperparameter tuning uses to choose which + * hyperparameters to + * evaluate + * at each iteration.
* @public */ - CreationTimeBefore?: Date | undefined; + Strategy: HyperParameterTuningJobStrategyType | undefined; /** - *A filter that returns only Git repositories that were last modified after the - * specified time.
+ *The date and time that the tuning job was created.
* @public */ - LastModifiedTimeAfter?: Date | undefined; + CreationTime: Date | undefined; /** - *A filter that returns only Git repositories that were last modified before the - * specified time.
+ *The date and time that the tuning job ended.
* @public */ - LastModifiedTimeBefore?: Date | undefined; + HyperParameterTuningEndTime?: Date | undefined; /** - *The maximum number of Git repositories to return in the response.
+ *The date and time that the tuning job was + * modified.
* @public */ - MaxResults?: number | undefined; + LastModifiedTime?: Date | undefined; /** - *A string in the Git repositories name. This filter returns only repositories whose - * name contains the specified string.
+ *The TrainingJobStatusCounters object that specifies the numbers of training + * jobs, categorized by status, that this tuning job launched.
* @public */ - NameContains?: string | undefined; + TrainingJobStatusCounters: TrainingJobStatusCounters | undefined; /** - *If the result of a ListCodeRepositoriesOutput request was truncated, the
- * response includes a NextToken. To get the next set of Git repositories, use
- * the token in the next request.
The ObjectiveStatusCounters object that specifies the numbers of training jobs, + * categorized by objective metric status, that this tuning job launched.
+ * @public + */ + ObjectiveStatusCounters: ObjectiveStatusCounters | undefined; + + /** + *The ResourceLimits + * object that specifies the maximum number of training jobs and parallel training jobs + * allowed for this tuning job.
+ * @public + */ + ResourceLimits?: ResourceLimits | undefined; +} + +/** + *A SageMaker image. A SageMaker image represents a set of container images that are derived from
+ * a common base container image. Each of these container images is represented by a SageMaker
+ * ImageVersion.
When the image was created.
+ * @public + */ + CreationTime: Date | undefined; + + /** + *The description of the image.
+ * @public + */ + Description?: string | undefined; + + /** + *The name of the image as displayed.
+ * @public + */ + DisplayName?: string | undefined; + + /** + *When a create, update, or delete operation fails, the reason for the failure.
* @public */ - NextToken?: string | undefined; + FailureReason?: string | undefined; /** - *The field to sort results by. The default is Name.
The ARN of the image.
* @public */ - SortBy?: CodeRepositorySortBy | undefined; + ImageArn: string | undefined; /** - *The sort order for results. The default is Ascending.
The name of the image.
* @public */ - SortOrder?: CodeRepositorySortOrder | undefined; -} + ImageName: string | undefined; -/** - * @public - */ -export interface ListCodeRepositoriesOutput { /** - *Gets a list of summaries of the Git repositories. Each summary specifies the following - * values for the repository:
- *Name
- *Amazon Resource Name (ARN)
- *Creation time
- *Last modified time
- *Configuration information, including the URL location of the repository and - * the ARN of the Amazon Web Services Secrets Manager secret that contains the - * credentials used to access the repository.
- *The status of the image.
* @public */ - CodeRepositorySummaryList: CodeRepositorySummary[] | undefined; + ImageStatus: ImageStatus | undefined; /** - *If the result of a ListCodeRepositoriesOutput request was truncated, the
- * response includes a NextToken. To get the next set of Git repositories, use
- * the token in the next request.
When the image was last modified.
* @public */ - NextToken?: string | undefined; + LastModifiedTime: Date | undefined; } /** * @public * @enum */ -export const ListCompilationJobsSortBy = { - CREATION_TIME: "CreationTime", - NAME: "Name", - STATUS: "Status", +export const ImageSortBy = { + CREATION_TIME: "CREATION_TIME", + IMAGE_NAME: "IMAGE_NAME", + LAST_MODIFIED_TIME: "LAST_MODIFIED_TIME", } as const; /** * @public */ -export type ListCompilationJobsSortBy = (typeof ListCompilationJobsSortBy)[keyof typeof ListCompilationJobsSortBy]; +export type ImageSortBy = (typeof ImageSortBy)[keyof typeof ImageSortBy]; /** * @public + * @enum */ -export interface ListCompilationJobsRequest { - /** - *If the result of the previous ListCompilationJobs request was truncated,
- * the response includes a NextToken. To retrieve the next set of model
- * compilation jobs, use the token in the next request.
The maximum number of model compilation jobs to return in the response.
- * @public - */ - MaxResults?: number | undefined; +export const ImageSortOrder = { + ASCENDING: "ASCENDING", + DESCENDING: "DESCENDING", +} as const; - /** - *A filter that returns the model compilation jobs that were created after a specified - * time.
- * @public - */ - CreationTimeAfter?: Date | undefined; +/** + * @public + */ +export type ImageSortOrder = (typeof ImageSortOrder)[keyof typeof ImageSortOrder]; +/** + *A version of a SageMaker Image. A version represents an existing container
+ * image.
A filter that returns the model compilation jobs that were created before a specified - * time.
+ *When the version was created.
* @public */ - CreationTimeBefore?: Date | undefined; + CreationTime: Date | undefined; /** - *A filter that returns the model compilation jobs that were modified after a specified - * time.
+ *When a create or delete operation fails, the reason for the failure.
* @public */ - LastModifiedTimeAfter?: Date | undefined; + FailureReason?: string | undefined; /** - *A filter that returns the model compilation jobs that were modified before a specified - * time.
+ *The ARN of the image the version is based on.
* @public */ - LastModifiedTimeBefore?: Date | undefined; + ImageArn: string | undefined; /** - *A filter that returns the model compilation jobs whose name contains a specified - * string.
+ *The ARN of the version.
* @public */ - NameContains?: string | undefined; + ImageVersionArn: string | undefined; /** - *A filter that retrieves model compilation jobs with a specific
- * CompilationJobStatus status.
The status of the version.
* @public */ - StatusEquals?: CompilationJobStatus | undefined; + ImageVersionStatus: ImageVersionStatus | undefined; /** - *The field by which to sort results. The default is CreationTime.
When the version was last modified.
* @public */ - SortBy?: ListCompilationJobsSortBy | undefined; + LastModifiedTime: Date | undefined; /** - *The sort order for results. The default is Ascending.
The version number.
* @public */ - SortOrder?: SortOrder | undefined; + Version: number | undefined; } /** * @public + * @enum */ -export interface ListCompilationJobsResponse { - /** - *An array of CompilationJobSummary objects, each describing a model compilation job. - *
- * @public - */ - CompilationJobSummaries: CompilationJobSummary[] | undefined; +export const ImageVersionSortBy = { + CREATION_TIME: "CREATION_TIME", + LAST_MODIFIED_TIME: "LAST_MODIFIED_TIME", + VERSION: "VERSION", +} as const; - /** - *If the response is truncated, Amazon SageMaker returns this NextToken. To retrieve
- * the next set of model compilation jobs, use this token in the next request.
A filter that returns only contexts with the specified source URI.
+ *The name of the hub content to import.
* @public */ - SourceUri?: string | undefined; + HubContentName: string | undefined; /** - *A filter that returns only contexts of the specified type.
+ *The version of the hub content to import.
* @public */ - ContextType?: string | undefined; + HubContentVersion?: string | undefined; /** - *A filter that returns only contexts created on or after the specified time.
+ *The type of hub content to import.
* @public */ - CreatedAfter?: Date | undefined; + HubContentType: HubContentType | undefined; /** - *A filter that returns only contexts created on or before the specified time.
+ *The version of the hub content schema to import.
* @public */ - CreatedBefore?: Date | undefined; + DocumentSchemaVersion: string | undefined; /** - *The property used to sort results. The default value is CreationTime.
The name of the hub to import content into.
* @public */ - SortBy?: SortContextsBy | undefined; + HubName: string | undefined; /** - *The sort order. The default value is Descending.
The display name of the hub content to import.
* @public */ - SortOrder?: SortOrder | undefined; + HubContentDisplayName?: string | undefined; /** - *If the previous call to ListContexts didn't return the full set of contexts,
- * the call returns a token for getting the next set of contexts.
A description of the hub content to import.
* @public */ - NextToken?: string | undefined; + HubContentDescription?: string | undefined; /** - *The maximum number of contexts to return in the response. The default value is 10.
+ *A string that provides a description of the hub content. This string can include links, tables, and standard markdown formating.
* @public */ - MaxResults?: number | undefined; + HubContentMarkdown?: string | undefined; + + /** + *The hub content document that describes information about the hub content such as type, associated containers, scripts, and more.
+ * @public + */ + HubContentDocument: string | undefined; + + /** + *The searchable keywords of the hub content.
+ * @public + */ + HubContentSearchKeywords?: string[] | undefined; + + /** + *Any tags associated with the hub content.
+ * @public + */ + Tags?: Tag[] | undefined; } /** * @public */ -export interface ListContextsResponse { +export interface ImportHubContentResponse { /** - *A list of contexts and their properties.
+ *The ARN of the hub that the content was imported into.
* @public */ - ContextSummaries?: ContextSummary[] | undefined; + HubArn: string | undefined; /** - *A token for getting the next set of contexts, if there are any.
+ *The ARN of the hub content that was imported.
* @public */ - NextToken?: string | undefined; + HubContentArn: string | undefined; } /** * @public * @enum */ -export const MonitoringJobDefinitionSortKey = { - CREATION_TIME: "CreationTime", - NAME: "Name", +export const InferenceComponentSortKey = { + CreationTime: "CreationTime", + Name: "Name", + Status: "Status", } as const; /** * @public */ -export type MonitoringJobDefinitionSortKey = - (typeof MonitoringJobDefinitionSortKey)[keyof typeof MonitoringJobDefinitionSortKey]; +export type InferenceComponentSortKey = (typeof InferenceComponentSortKey)[keyof typeof InferenceComponentSortKey]; /** + *A summary of the properties of an inference component.
* @public */ -export interface ListDataQualityJobDefinitionsRequest { +export interface InferenceComponentSummary { + /** + *The time when the inference component was created.
+ * @public + */ + CreationTime: Date | undefined; + + /** + *The Amazon Resource Name (ARN) of the inference component.
+ * @public + */ + InferenceComponentArn: string | undefined; + + /** + *The name of the inference component.
+ * @public + */ + InferenceComponentName: string | undefined; + + /** + *The Amazon Resource Name (ARN) of the endpoint that hosts the inference component.
+ * @public + */ + EndpointArn: string | undefined; + /** - *A filter that lists the data quality job definitions associated with the specified - * endpoint.
+ *The name of the endpoint that hosts the inference component.
* @public */ - EndpointName?: string | undefined; + EndpointName: string | undefined; /** - *The field to sort results by. The default is CreationTime.
The name of the production variant that hosts the inference component.
* @public */ - SortBy?: MonitoringJobDefinitionSortKey | undefined; + VariantName: string | undefined; /** - *Whether to sort the results in Ascending or Descending order.
- * The default is Descending.
The status of the inference component.
* @public */ - SortOrder?: SortOrder | undefined; + InferenceComponentStatus?: InferenceComponentStatus | undefined; /** - *If the result of the previous ListDataQualityJobDefinitions request was
- * truncated, the response includes a NextToken. To retrieve the next set of
- * transform jobs, use the token in the next request.>
The time when the inference component was last updated.
* @public */ - NextToken?: string | undefined; + LastModifiedTime: Date | undefined; +} +/** + *Lists a summary of properties of an inference experiment.
+ * @public + */ +export interface InferenceExperimentSummary { /** - *The maximum number of data quality monitoring job definitions to return in the - * response.
+ *The name of the inference experiment.
* @public */ - MaxResults?: number | undefined; + Name: string | undefined; /** - *A string in the data quality monitoring job definition name. This filter returns only - * data quality monitoring job definitions whose name contains the specified string.
+ *The type of the inference experiment.
* @public */ - NameContains?: string | undefined; + Type: InferenceExperimentType | undefined; /** - *A filter that returns only data quality monitoring job definitions created before the - * specified time.
+ *The duration for which the inference experiment ran or will run.
+ *The maximum duration that you can set for an inference experiment is 30 days.
* @public */ - CreationTimeBefore?: Date | undefined; + Schedule?: InferenceExperimentSchedule | undefined; /** - *A filter that returns only data quality monitoring job definitions created after the - * specified time.
+ *The status of the inference experiment.
* @public */ - CreationTimeAfter?: Date | undefined; -} + Status: InferenceExperimentStatus | undefined; -/** - *Summary information about a monitoring job.
- * @public - */ -export interface MonitoringJobDefinitionSummary { /** - *The name of the monitoring job.
+ *The error message for the inference experiment status result.
* @public */ - MonitoringJobDefinitionName: string | undefined; + StatusReason?: string | undefined; /** - *The Amazon Resource Name (ARN) of the monitoring job.
+ *The description of the inference experiment.
* @public */ - MonitoringJobDefinitionArn: string | undefined; + Description?: string | undefined; /** - *The time that the monitoring job was created.
+ *The timestamp at which the inference experiment was created.
* @public */ CreationTime: Date | undefined; /** - *The name of the endpoint that the job monitors.
+ *The timestamp at which the inference experiment was completed.
* @public */ - EndpointName: string | undefined; -} + CompletionTime?: Date | undefined; -/** - * @public - */ -export interface ListDataQualityJobDefinitionsResponse { /** - *A list of data quality monitoring job definitions.
+ *The timestamp when you last modified the inference experiment.
* @public */ - JobDefinitionSummaries: MonitoringJobDefinitionSummary[] | undefined; + LastModifiedTime: Date | undefined; /** - *If the result of the previous 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.
+ * The ARN of the IAM role that Amazon SageMaker can assume to access model artifacts and container images, and manage + * Amazon SageMaker Inference endpoints for model deployment. + *
* @public */ - NextToken?: string | undefined; + RoleArn?: string | undefined; } /** * @public * @enum */ -export const ListDeviceFleetsSortBy = { - CreationTime: "CREATION_TIME", - LastModifiedTime: "LAST_MODIFIED_TIME", - Name: "NAME", +export const InferenceExperimentStopDesiredState = { + CANCELLED: "Cancelled", + COMPLETED: "Completed", } as const; /** * @public */ -export type ListDeviceFleetsSortBy = (typeof ListDeviceFleetsSortBy)[keyof typeof ListDeviceFleetsSortBy]; +export type InferenceExperimentStopDesiredState = + (typeof InferenceExperimentStopDesiredState)[keyof typeof InferenceExperimentStopDesiredState]; /** + *A structure that contains a list of recommendation jobs.
* @public */ -export interface ListDeviceFleetsRequest { +export interface InferenceRecommendationsJob { /** - *The response from the last list when returning a list large enough to need tokening.
+ *The name of the job.
* @public */ - NextToken?: string | undefined; + JobName: string | undefined; /** - *The maximum number of results to select.
+ *The job description.
* @public */ - MaxResults?: number | undefined; + JobDescription: string | undefined; /** - *Filter fleets where packaging job was created after specified time.
+ *The recommendation job type.
* @public */ - CreationTimeAfter?: Date | undefined; + JobType: RecommendationJobType | undefined; /** - *Filter fleets where the edge packaging job was created before specified time.
+ *The Amazon Resource Name (ARN) of the recommendation job.
* @public */ - CreationTimeBefore?: Date | undefined; + JobArn: string | undefined; /** - *Select fleets where the job was updated after X
+ *The status of the job.
* @public */ - LastModifiedTimeAfter?: Date | undefined; + Status: RecommendationJobStatus | undefined; /** - *Select fleets where the job was updated before X
+ *A timestamp that shows when the job was created.
* @public */ - LastModifiedTimeBefore?: Date | undefined; + CreationTime: Date | undefined; /** - *Filter for fleets containing this name in their fleet device name.
+ *A timestamp that shows when the job completed.
* @public */ - NameContains?: string | undefined; + CompletionTime?: Date | undefined; /** - *The column to sort by.
+ *The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker + * to perform tasks on your behalf.
* @public */ - SortBy?: ListDeviceFleetsSortBy | undefined; + RoleArn: string | undefined; /** - *What direction to sort in.
+ *A timestamp that shows when the job was last modified.
* @public */ - SortOrder?: SortOrder | undefined; -} + LastModifiedTime: Date | undefined; -/** - * @public - */ -export interface ListDeviceFleetsResponse { /** - *Summary of the device fleet.
+ *If the job fails, provides information why the job failed.
* @public */ - DeviceFleetSummaries: DeviceFleetSummary[] | undefined; + FailureReason?: string | undefined; /** - *The response from the last list when returning a list large enough to need tokening.
+ *The name of the created model.
* @public */ - NextToken?: string | undefined; + ModelName?: 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).
+ * @public + */ + SamplePayloadUrl?: string | undefined; + + /** + *The Amazon Resource Name (ARN) of a versioned model package.
+ * @public + */ + ModelPackageVersionArn?: string | undefined; } /** + *The details for a specific benchmark from an Inference Recommender job.
* @public */ -export interface ListDevicesRequest { +export interface RecommendationJobInferenceBenchmark { /** - *The response from the last list when returning a list large enough to need tokening.
+ *The metrics of recommendations.
* @public */ - NextToken?: string | undefined; + Metrics?: RecommendationMetrics | undefined; /** - *Maximum number of results to select.
+ *The metrics for an existing endpoint compared in an Inference Recommender job.
* @public */ - MaxResults?: number | undefined; + EndpointMetrics?: InferenceMetrics | undefined; /** - *Select fleets where the job was updated after X
+ *The endpoint configuration made by Inference Recommender during a recommendation job.
* @public */ - LatestHeartbeatAfter?: Date | undefined; + EndpointConfiguration?: EndpointOutputConfiguration | undefined; /** - *A filter that searches devices that contains this name in any of their models.
+ *Defines the model configuration. Includes the specification name and environment parameters.
* @public */ - ModelName?: string | undefined; + ModelConfiguration: ModelConfiguration | undefined; /** - *Filter for fleets containing this name in their device fleet name.
+ *The reason why a benchmark failed.
* @public */ - DeviceFleetName?: string | undefined; -} + FailureReason?: string | undefined; -/** - * @public - */ -export interface ListDevicesResponse { /** - *Summary of devices.
+ *A timestamp that shows when the benchmark completed.
* @public */ - DeviceSummaries: DeviceSummary[] | undefined; + InvocationEndTime?: Date | undefined; /** - *The response from the last list when returning a list large enough to need tokening.
+ *A timestamp that shows when the benchmark started.
* @public */ - NextToken?: string | undefined; + InvocationStartTime?: Date | undefined; } /** + * @public + * @enum + */ +export const RecommendationStepType = { + BENCHMARK: "BENCHMARK", +} as const; + +/** + * @public + */ +export type RecommendationStepType = (typeof RecommendationStepType)[keyof typeof RecommendationStepType]; + +/** + *A returned array object for the Steps response field in the
+ * ListInferenceRecommendationsJobSteps API command.
If the previous response was truncated, you will receive this token. Use it in your next - * request to receive the next set of results.
+ *The type of the subtask.
+ *
+ * BENCHMARK: Evaluate the performance of your model on different instance types.
This parameter defines the maximum number of results that can be return in a single
- * response. The MaxResults parameter is an upper bound, not a target. If there are
- * more results available than the value specified, a NextToken is provided in the
- * response. The NextToken indicates that the user should get the next set of
- * results by providing this token as a part of a subsequent call. The default value for
- * MaxResults is 10.
The name of the Inference Recommender job.
* @public */ - MaxResults?: number | undefined; -} + JobName: string | undefined; -/** - * @public - */ -export interface ListDomainsResponse { /** - *The list of domains.
+ *The current status of the benchmark.
* @public */ - Domains?: DomainDetails[] | undefined; + Status: RecommendationJobStatus | undefined; /** - *If the previous response was truncated, you will receive this token. Use it in your next - * request to receive the next set of results.
+ *The details for a specific benchmark.
* @public */ - NextToken?: string | undefined; + InferenceBenchmark?: RecommendationJobInferenceBenchmark | undefined; } /** + *Provides counts for human-labeled tasks in the labeling job.
* @public - * @enum */ -export const ListEdgeDeploymentPlansSortBy = { - CreationTime: "CREATION_TIME", - DeviceFleetName: "DEVICE_FLEET_NAME", - LastModifiedTime: "LAST_MODIFIED_TIME", - Name: "NAME", -} as const; +export interface LabelCountersForWorkteam { + /** + *The total number of data objects labeled by a human worker.
+ * @public + */ + HumanLabeled?: number | undefined; -/** - * @public - */ -export type ListEdgeDeploymentPlansSortBy = - (typeof ListEdgeDeploymentPlansSortBy)[keyof typeof ListEdgeDeploymentPlansSortBy]; + /** + *The total number of data objects that need to be labeled by a human worker.
+ * @public + */ + PendingHuman?: number | undefined; + + /** + *The total number of tasks in the labeling job.
+ * @public + */ + Total?: number | undefined; +} /** + *Provides summary information for a work team.
* @public */ -export interface ListEdgeDeploymentPlansRequest { +export interface LabelingJobForWorkteamSummary { /** - *The response from the last list when returning a list large enough to need - * tokening.
+ *The name of the labeling job that the work team is assigned to.
* @public */ - NextToken?: string | undefined; + LabelingJobName?: string | undefined; /** - *The maximum number of results to select (50 by default).
+ *A unique identifier for a labeling job. You can use this to refer to a specific + * labeling job.
* @public */ - MaxResults?: number | undefined; + JobReferenceCode: string | undefined; /** - *Selects edge deployment plans created after this time.
+ *The Amazon Web Services account ID of the account used to start the labeling + * job.
* @public */ - CreationTimeAfter?: Date | undefined; + WorkRequesterAccountId: string | undefined; /** - *Selects edge deployment plans created before this time.
+ *The date and time that the labeling job was created.
* @public */ - CreationTimeBefore?: Date | undefined; + CreationTime: Date | undefined; /** - *Selects edge deployment plans that were last updated after this time.
+ *Provides information about the progress of a labeling job.
* @public */ - LastModifiedTimeAfter?: Date | undefined; + LabelCounters?: LabelCountersForWorkteam | undefined; /** - *Selects edge deployment plans that were last updated before this time.
+ *The configured number of workers per data object.
* @public */ - LastModifiedTimeBefore?: Date | undefined; + NumberOfHumanWorkersPerDataObject?: number | undefined; +} +/** + *Provides summary information about a labeling job.
+ * @public + */ +export interface LabelingJobSummary { /** - *Selects edge deployment plans with names containing this name.
+ *The name of the labeling job.
* @public */ - NameContains?: string | undefined; + LabelingJobName: string | undefined; /** - *Selects edge deployment plans with a device fleet name containing this name.
+ *The Amazon Resource Name (ARN) assigned to the labeling job when it was + * created.
* @public */ - DeviceFleetNameContains?: string | undefined; + LabelingJobArn: string | undefined; /** - *The column by which to sort the edge deployment plans. Can be one of
- * NAME, DEVICEFLEETNAME, CREATIONTIME,
- * LASTMODIFIEDTIME.
The date and time that the job was created (timestamp).
* @public */ - SortBy?: ListEdgeDeploymentPlansSortBy | undefined; + CreationTime: Date | undefined; /** - *The direction of the sorting (ascending or descending).
+ *The date and time that the job was last modified (timestamp).
* @public */ - SortOrder?: SortOrder | undefined; -} + LastModifiedTime: Date | undefined; -/** - * @public - */ -export interface ListEdgeDeploymentPlansResponse { /** - *List of summaries of edge deployment plans.
+ *The current status of the labeling job.
* @public */ - EdgeDeploymentPlanSummaries: EdgeDeploymentPlanSummary[] | undefined; + LabelingJobStatus: LabelingJobStatus | undefined; /** - *The token to use when calling the next page of results.
+ *Counts showing the progress of the labeling job.
* @public */ - NextToken?: string | undefined; -} - -/** - * @public - * @enum - */ -export const ListEdgePackagingJobsSortBy = { - CreationTime: "CREATION_TIME", - EdgePackagingJobStatus: "STATUS", - LastModifiedTime: "LAST_MODIFIED_TIME", - ModelName: "MODEL_NAME", - Name: "NAME", -} as const; - -/** - * @public - */ -export type ListEdgePackagingJobsSortBy = - (typeof ListEdgePackagingJobsSortBy)[keyof typeof ListEdgePackagingJobsSortBy]; + LabelCounters: LabelCounters | undefined; -/** - * @public - */ -export interface ListEdgePackagingJobsRequest { /** - *The response from the last list when returning a list large enough to need tokening.
+ *The Amazon Resource Name (ARN) of the work team assigned to the job.
* @public */ - NextToken?: string | undefined; + WorkteamArn: string | undefined; /** - *Maximum number of results to select.
+ *The Amazon Resource Name (ARN) of a Lambda function. The function is run before each + * data object is sent to a worker.
* @public */ - MaxResults?: number | undefined; + PreHumanTaskLambdaArn?: string | undefined; /** - *Select jobs where the job was created after specified time.
+ *The Amazon Resource Name (ARN) of the Lambda function used to consolidate the + * annotations from individual workers into a label for a data object. For more + * information, see Annotation + * Consolidation.
* @public */ - CreationTimeAfter?: Date | undefined; + AnnotationConsolidationLambdaArn?: string | undefined; /** - *Select jobs where the job was created before specified time.
+ *If the LabelingJobStatus field is Failed, this field
+ * contains a description of the error.
Select jobs where the job was updated after specified time.
+ *The location of the output produced by the labeling job.
* @public */ - LastModifiedTimeAfter?: Date | undefined; + LabelingJobOutput?: LabelingJobOutput | undefined; /** - *Select jobs where the job was updated before specified time.
+ *Input configuration for the labeling job.
* @public */ - LastModifiedTimeBefore?: Date | undefined; + InputConfig?: LabelingJobInputConfig | undefined; +} +/** + *Metadata for a Lambda step.
+ * @public + */ +export interface LambdaStepMetadata { /** - *Filter for jobs containing this name in their packaging job name.
+ *The Amazon Resource Name (ARN) of the Lambda function that was run by this step execution.
* @public */ - NameContains?: string | undefined; + Arn?: string | undefined; /** - *Filter for jobs where the model name contains this string.
+ *A list of the output parameters of the Lambda step.
* @public */ - ModelNameContains?: string | undefined; + OutputParameters?: OutputParameter[] | undefined; +} +/** + *Lists a summary of the properties of a lineage group. A lineage group provides a group of shareable lineage entity + * resources.
+ * @public + */ +export interface LineageGroupSummary { /** - *The job status to filter for.
+ *The Amazon Resource Name (ARN) of the lineage group resource.
* @public */ - StatusEquals?: EdgePackagingJobStatus | undefined; + LineageGroupArn?: string | undefined; /** - *Use to specify what column to sort by.
+ *The name or Amazon Resource Name (ARN) of the lineage group.
* @public */ - SortBy?: ListEdgePackagingJobsSortBy | undefined; + LineageGroupName?: string | undefined; /** - *What direction to sort by.
+ *The display name of the lineage group summary.
* @public */ - SortOrder?: SortOrder | undefined; -} + DisplayName?: string | undefined; -/** - * @public - */ -export interface ListEdgePackagingJobsResponse { /** - *Summaries of edge packaging jobs.
+ *The creation time of the lineage group summary.
* @public */ - EdgePackagingJobSummaries: EdgePackagingJobSummary[] | undefined; + CreationTime?: Date | undefined; /** - *Token to use when calling the next page of results.
+ *The last modified time of the lineage group summary.
* @public */ - NextToken?: string | undefined; + LastModifiedTime?: Date | undefined; } /** * @public * @enum */ -export const OrderKey = { - Ascending: "Ascending", - Descending: "Descending", +export const LineageType = { + ACTION: "Action", + ARTIFACT: "Artifact", + CONTEXT: "Context", + TRIAL_COMPONENT: "TrialComponent", +} as const; + +/** + * @public + */ +export type LineageType = (typeof LineageType)[keyof typeof LineageType]; + +/** + * @public + * @enum + */ +export const SortActionsBy = { + CREATION_TIME: "CreationTime", + NAME: "Name", +} as const; + +/** + * @public + */ +export type SortActionsBy = (typeof SortActionsBy)[keyof typeof SortActionsBy]; + +/** + * @public + * @enum + */ +export const SortOrder = { + ASCENDING: "Ascending", + DESCENDING: "Descending", } as const; /** * @public */ -export type OrderKey = (typeof OrderKey)[keyof typeof OrderKey]; +export type SortOrder = (typeof SortOrder)[keyof typeof SortOrder]; /** * @public */ -export interface ListEndpointConfigsInput { +export interface ListActionsRequest { /** - *The field to sort results by. The default is CreationTime.
A filter that returns only actions with the specified source URI.
* @public */ - SortBy?: EndpointConfigSortKey | undefined; + SourceUri?: string | undefined; /** - *The sort order for results. The default is Descending.
A filter that returns only actions of the specified type.
* @public */ - SortOrder?: OrderKey | undefined; + ActionType?: string | undefined; /** - *If the result of the previous ListEndpointConfig request was
- * truncated, the response includes a NextToken. To retrieve the next set of
- * endpoint configurations, use the token in the next request.
A filter that returns only actions created on or after the specified time.
* @public */ - NextToken?: string | undefined; + CreatedAfter?: Date | undefined; /** - *The maximum number of training jobs to return in the response.
+ *A filter that returns only actions created on or before the specified time.
* @public */ - MaxResults?: number | undefined; + CreatedBefore?: Date | undefined; /** - *A string in the endpoint configuration name. This filter returns only endpoint - * configurations whose name contains the specified string.
+ *The property used to sort results. The default value is CreationTime.
A filter that returns only endpoint configurations created before the specified - * time (timestamp).
+ *The sort order. The default value is Descending.
If the previous call to ListActions didn't return the full set of actions,
+ * the call returns a token for getting the next set of actions.
A filter that returns only endpoint configurations with a creation time greater - * than or equal to the specified time (timestamp).
+ *The maximum number of actions to return in the response. The default value is 10.
* @public */ - CreationTimeAfter?: Date | undefined; + MaxResults?: number | undefined; } /** * @public */ -export interface ListEndpointConfigsOutput { +export interface ListActionsResponse { /** - *An array of endpoint configurations.
+ *A list of actions and their properties.
* @public */ - EndpointConfigs: EndpointConfigSummary[] | undefined; + ActionSummaries?: ActionSummary[] | undefined; /** - *If the response is truncated, SageMaker returns this token. To retrieve the next set of - * endpoint configurations, use it in the subsequent request
+ *A token for getting the next set of actions, if there are any.
* @public */ NextToken?: string | undefined; @@ -10298,163 +10462,123 @@ export interface ListEndpointConfigsOutput { /** * @public */ -export interface ListEndpointsInput { - /** - *Sorts the list of results. The default is CreationTime.
The sort order for results. The default is Descending.
A filter that returns only algorithms created after the specified time + * (timestamp).
* @public */ - SortOrder?: OrderKey | undefined; + CreationTimeAfter?: Date | undefined; /** - *If the result of a ListEndpoints request was truncated, the response
- * includes a NextToken. To retrieve the next set of endpoints, use the token
- * in the next request.
A filter that returns only algorithms created before the specified time + * (timestamp).
* @public */ - NextToken?: string | undefined; + CreationTimeBefore?: Date | undefined; /** - *The maximum number of endpoints to return in the response. This value defaults to - * 10.
+ *The maximum number of algorithms to return in the response.
* @public */ MaxResults?: number | undefined; /** - *A string in endpoint names. This filter returns only endpoints whose name contains - * the specified string.
+ *A string in the algorithm name. This filter returns only algorithms whose name + * contains the specified string.
* @public */ NameContains?: string | undefined; /** - *A filter that returns only endpoints that were created before the specified time - * (timestamp).
- * @public - */ - CreationTimeBefore?: Date | undefined; - - /** - *A filter that returns only endpoints with a creation time greater than or equal to - * the specified time (timestamp).
- * @public - */ - CreationTimeAfter?: Date | undefined; - - /** - *A filter that returns only endpoints that were modified before the specified - * timestamp.
+ *If the response to a previous ListAlgorithms request was truncated, the
+ * response includes a NextToken. To retrieve the next set of algorithms, use
+ * the token in the next request.
A filter that returns only endpoints that were modified after the specified - * timestamp.
+ *The parameter by which to sort the results. The default is
+ * CreationTime.
A filter that returns only endpoints with the specified status.
+ *The sort order for the results. The default is Ascending.
An array or endpoint objects.
+ *>An array of AlgorithmSummary objects, each of which lists an
+ * algorithm.
If the response is truncated, SageMaker returns this token. To retrieve the next set of - * training jobs, use it in the subsequent request.
+ *If the response is truncated, SageMaker returns this token. To retrieve the next set of + * algorithms, use it in the subsequent request.
* @public */ NextToken?: string | undefined; } -/** - * @public - * @enum - */ -export const SortExperimentsBy = { - CREATION_TIME: "CreationTime", - NAME: "Name", -} as const; - /** * @public */ -export type SortExperimentsBy = (typeof SortExperimentsBy)[keyof typeof SortExperimentsBy]; - -/** - * @public - */ -export interface ListExperimentsRequest { - /** - *A filter that returns only experiments created after the specified time.
- * @public - */ - CreatedAfter?: Date | undefined; - +export interface ListAliasesRequest { /** - *A filter that returns only experiments created before the specified time.
+ *The name of the image.
* @public */ - CreatedBefore?: Date | undefined; + ImageName: string | undefined; /** - *The property used to sort results. The default value is CreationTime.
The alias of the image version.
* @public */ - SortBy?: SortExperimentsBy | undefined; + Alias?: string | undefined; /** - *The sort order. The default value is Descending.
The version of the image. If image version is not specified, the aliases of all versions of the image are listed.
* @public */ - SortOrder?: SortOrder | undefined; + Version?: number | undefined; /** - *If the previous call to ListExperiments didn't return the full set of
- * experiments, the call returns a token for getting the next set of experiments.
The maximum number of aliases to return.
* @public */ - NextToken?: string | undefined; + MaxResults?: number | undefined; /** - *The maximum number of experiments to return in the response. The default value is - * 10.
+ *If the previous call to ListAliases didn't return the full set of
+ * aliases, the call returns a token for retrieving the next set of aliases.
A list of the summaries of your experiments.
+ *A list of SageMaker image version aliases.
* @public */ - ExperimentSummaries?: ExperimentSummary[] | undefined; + SageMakerImageVersionAliases?: string[] | undefined; /** - *A token for getting the next set of experiments, if there are any.
+ *A token for getting the next set of aliases, if more aliases exist.
* @public */ NextToken?: string | undefined; @@ -10463,300 +10587,341 @@ export interface ListExperimentsResponse { /** * @public */ -export interface ListFeatureGroupsRequest { +export interface ListAppImageConfigsRequest { /** - *A string that partially matches one or more FeatureGroups names. Filters
- * FeatureGroups by name.
The total number of items to return in the response. If the total
+ * number of items available is more than the value specified, a NextToken
+ * is provided in the response. To resume pagination, provide the NextToken
+ * value in the as part of a subsequent call. The default value is 10.
A FeatureGroup status. Filters by FeatureGroup status.
If the previous call to ListImages didn't return the full set of
+ * AppImageConfigs, the call returns a token for getting the next set of AppImageConfigs.
An OfflineStore status. Filters by OfflineStore status.
- *
A filter that returns only AppImageConfigs whose name contains the specified string.
* @public */ - OfflineStoreStatusEquals?: OfflineStoreStatusValue | undefined; + NameContains?: string | undefined; /** - *Use this parameter to search for FeatureGroupss created after a specific
- * date and time.
A filter that returns only AppImageConfigs created on or before the specified time.
* @public */ - CreationTimeAfter?: Date | undefined; + CreationTimeBefore?: Date | undefined; /** - *Use this parameter to search for FeatureGroupss created before a specific
- * date and time.
A filter that returns only AppImageConfigs created on or after the specified time.
* @public */ - CreationTimeBefore?: Date | undefined; + CreationTimeAfter?: Date | undefined; /** - *The order in which feature groups are listed.
+ *A filter that returns only AppImageConfigs modified on or before the specified time.
* @public */ - SortOrder?: FeatureGroupSortOrder | undefined; + ModifiedTimeBefore?: Date | undefined; /** - *The value on which the feature group list is sorted.
+ *A filter that returns only AppImageConfigs modified on or after the specified time.
* @public */ - SortBy?: FeatureGroupSortBy | undefined; + ModifiedTimeAfter?: Date | undefined; /** - *The maximum number of results returned by ListFeatureGroups.
The property used to sort results. The default value is CreationTime.
A token to resume pagination of ListFeatureGroups results.
The sort order. The default value is Descending.
A summary of feature groups.
+ *A token for getting the next set of AppImageConfigs, if there are any.
* @public */ - FeatureGroupSummaries: FeatureGroupSummary[] | undefined; + NextToken?: string | undefined; /** - *A token to resume pagination of ListFeatureGroups results.
A list of AppImageConfigs and their properties.
* @public */ - NextToken?: string | undefined; + AppImageConfigs?: AppImageConfigDetails[] | undefined; } /** * @public */ -export interface ListFlowDefinitionsRequest { +export interface ListAppsRequest { /** - *A filter that returns only flow definitions with a creation time greater than or equal to the specified timestamp.
+ *If the previous response was truncated, you will receive this token. Use it in your next + * request to receive the next set of results.
* @public */ - CreationTimeAfter?: Date | undefined; + NextToken?: string | undefined; /** - *A filter that returns only flow definitions that were created before the specified timestamp.
+ *This parameter defines the maximum number of results that can be return in a single
+ * response. The MaxResults parameter is an upper bound, not a target. If there are
+ * more results available than the value specified, a NextToken is provided in the
+ * response. The NextToken indicates that the user should get the next set of
+ * results by providing this token as a part of a subsequent call. The default value for
+ * MaxResults is 10.
An optional value that specifies whether you want the results sorted in Ascending or Descending order.
The sort order for the results. The default is Ascending.
* @public */ SortOrder?: SortOrder | undefined; /** - *A token to resume pagination.
+ *The parameter by which to sort the results. The default is CreationTime.
* @public */ - NextToken?: string | undefined; + SortBy?: AppSortKey | undefined; /** - *The total number of items to return. If the total number of available items is more than the value specified in MaxResults, then a NextToken will be provided in the output that you can use to resume pagination.
A parameter to search for the domain ID.
* @public */ - MaxResults?: number | undefined; -} + DomainIdEquals?: string | undefined; -/** - * @public - */ -export interface ListFlowDefinitionsResponse { /** - *An array of objects describing the flow definitions.
+ *A parameter to search by user profile name. If SpaceNameEquals is set, then
+ * this value cannot be set.
A token to resume pagination.
+ *A parameter to search by space name. If UserProfileNameEquals is set, then
+ * this value cannot be set.
The name of the hub to list the contents of.
+ *The list of apps.
* @public */ - HubName: string | undefined; + Apps?: AppDetails[] | undefined; /** - *The type of hub content to list.
+ *If the previous response was truncated, you will receive this token. Use it in your next + * request to receive the next set of results.
* @public */ - HubContentType: HubContentType | undefined; + NextToken?: string | undefined; +} + +/** + * @public + * @enum + */ +export const SortArtifactsBy = { + CREATION_TIME: "CreationTime", +} as const; + +/** + * @public + */ +export type SortArtifactsBy = (typeof SortArtifactsBy)[keyof typeof SortArtifactsBy]; +/** + * @public + */ +export interface ListArtifactsRequest { /** - *Only list hub content if the name contains the specified string.
+ *A filter that returns only artifacts with the specified source URI.
* @public */ - NameContains?: string | undefined; + SourceUri?: string | undefined; /** - *The upper bound of the hub content schema verion.
+ *A filter that returns only artifacts of the specified type.
* @public */ - MaxSchemaVersion?: string | undefined; + ArtifactType?: string | undefined; /** - *Only list hub content that was created before the time specified.
+ *A filter that returns only artifacts created on or after the specified time.
* @public */ - CreationTimeBefore?: Date | undefined; + CreatedAfter?: Date | undefined; /** - *Only list hub content that was created after the time specified.
+ *A filter that returns only artifacts created on or before the specified time.
* @public */ - CreationTimeAfter?: Date | undefined; + CreatedBefore?: Date | undefined; /** - *Sort hub content versions by either name or creation time.
+ *The property used to sort results. The default value is CreationTime.
Sort hubs by ascending or descending order.
+ *The sort order. The default value is Descending.
The maximum amount of hub content to list.
+ *If the previous call to ListArtifacts didn't return the full set of artifacts,
+ * the call returns a token for getting the next set of artifacts.
If the response to a previous ListHubContents request was truncated, the response includes a NextToken. To retrieve the next set of hub content, use the token in the next request.
The maximum number of artifacts to return in the response. The default value is 10.
* @public */ - NextToken?: string | undefined; + MaxResults?: number | undefined; } /** * @public */ -export interface ListHubContentsResponse { +export interface ListArtifactsResponse { /** - *The summaries of the listed hub content.
+ *A list of artifacts and their properties.
* @public */ - HubContentSummaries: HubContentInfo[] | undefined; + ArtifactSummaries?: ArtifactSummary[] | undefined; /** - *If the response is truncated, SageMaker returns this token. To retrieve the next set of hub content, use it in the subsequent request.
+ *A token for getting the next set of artifacts, if there are any.
* @public */ NextToken?: string | undefined; } +/** + * @public + * @enum + */ +export const SortAssociationsBy = { + CREATION_TIME: "CreationTime", + DESTINATION_ARN: "DestinationArn", + DESTINATION_TYPE: "DestinationType", + SOURCE_ARN: "SourceArn", + SOURCE_TYPE: "SourceType", +} as const; + /** * @public */ -export interface ListHubContentVersionsRequest { +export type SortAssociationsBy = (typeof SortAssociationsBy)[keyof typeof SortAssociationsBy]; + +/** + * @public + */ +export interface ListAssociationsRequest { /** - *The name of the hub to list the content versions of.
+ *A filter that returns only associations with the specified source ARN.
* @public */ - HubName: string | undefined; + SourceArn?: string | undefined; /** - *The type of hub content to list versions of.
+ *A filter that returns only associations with the specified destination Amazon Resource Name (ARN).
* @public */ - HubContentType: HubContentType | undefined; + DestinationArn?: string | undefined; /** - *The name of the hub content.
+ *A filter that returns only associations with the specified source type.
* @public */ - HubContentName: string | undefined; + SourceType?: string | undefined; /** - *The lower bound of the hub content versions to list.
+ *A filter that returns only associations with the specified destination type.
* @public */ - MinVersion?: string | undefined; + DestinationType?: string | undefined; /** - *The upper bound of the hub content schema version.
+ *A filter that returns only associations of the specified type.
* @public */ - MaxSchemaVersion?: string | undefined; + AssociationType?: AssociationEdgeType | undefined; /** - *Only list hub content versions that were created before the time specified.
+ *A filter that returns only associations created on or after the specified time.
* @public */ - CreationTimeBefore?: Date | undefined; + CreatedAfter?: Date | undefined; /** - *Only list hub content versions that were created after the time specified.
+ *A filter that returns only associations created on or before the specified time.
* @public */ - CreationTimeAfter?: Date | undefined; + CreatedBefore?: Date | undefined; /** - *Sort hub content versions by either name or creation time.
+ *The property used to sort results. The default value is CreationTime.
Sort hub content versions by ascending or descending order.
+ *The sort order. The default value is Descending.
The maximum number of hub content versions to list.
+ *If the previous call to ListAssociations didn't return the full set of associations,
+ * the call returns a token for getting the next set of associations.
If the response to a previous ListHubContentVersions request was truncated, the response includes a NextToken. To retrieve the next set of hub content versions, use the token in the next request.
The maximum number of associations to return in the response. The default value is 10.
* @public */ - NextToken?: string | undefined; + MaxResults?: number | undefined; } /** * @public */ -export interface ListHubContentVersionsResponse { +export interface ListAssociationsResponse { /** - *The summaries of the listed hub content versions.
+ *A list of associations and their properties.
* @public */ - HubContentSummaries: HubContentInfo[] | undefined; + AssociationSummaries?: AssociationSummary[] | undefined; /** - *If the response is truncated, SageMaker returns this token. To retrieve the next set of hub content versions, use it in the subsequent request.
+ *A token for getting the next set of associations, if there are any.
* @public */ NextToken?: string | undefined; @@ -10765,57 +10930,64 @@ export interface ListHubContentVersionsResponse { /** * @public */ -export interface ListHubsRequest { +export interface ListAutoMLJobsRequest { /** - *Only list hubs with names that contain the specified string.
+ *Request a list of jobs, using a filter for time.
* @public */ - NameContains?: string | undefined; + CreationTimeAfter?: Date | undefined; /** - *Only list hubs that were created before the time specified.
+ *Request a list of jobs, using a filter for time.
* @public */ CreationTimeBefore?: Date | undefined; /** - *Only list hubs that were created after the time specified.
+ *Request a list of jobs, using a filter for time.
* @public */ - CreationTimeAfter?: Date | undefined; + LastModifiedTimeAfter?: Date | undefined; /** - *Only list hubs that were last modified before the time specified.
+ *Request a list of jobs, using a filter for time.
* @public */ LastModifiedTimeBefore?: Date | undefined; /** - *Only list hubs that were last modified after the time specified.
+ *Request a list of jobs, using a search filter for name.
* @public */ - LastModifiedTimeAfter?: Date | undefined; + NameContains?: string | undefined; /** - *Sort hubs by either name or creation time.
+ *Request a list of jobs, using a filter for status.
* @public */ - SortBy?: HubSortBy | undefined; + StatusEquals?: AutoMLJobStatus | undefined; /** - *Sort hubs by ascending or descending order.
+ *The sort order for the results. The default is Descending.
The parameter by which to sort the results. The default is Name.
The maximum number of hubs to list.
+ *Request a list of jobs up to a specified limit.
* @public */ MaxResults?: number | undefined; /** - *If the response to a previous ListHubs request was truncated, the response includes a NextToken. To retrieve the next set of hubs, use the token in the next request.
If the previous response was truncated, you receive this token. Use it in your next + * request to receive the next set of results.
* @public */ NextToken?: string | undefined; @@ -10824,15 +10996,16 @@ export interface ListHubsRequest { /** * @public */ -export interface ListHubsResponse { +export interface ListAutoMLJobsResponse { /** - *The summaries of the listed hubs.
+ *Returns a summary list of jobs.
* @public */ - HubSummaries: HubInfo[] | undefined; + AutoMLJobSummaries: AutoMLJobSummary[] | undefined; /** - *If the response is truncated, SageMaker returns this token. To retrieve the next set of hubs, use it in the subsequent request.
+ *If the previous response was truncated, you receive this token. Use it in your next + * request to receive the next set of results.
* @public */ NextToken?: string | undefined; @@ -10841,50 +11014,47 @@ export interface ListHubsResponse { /** * @public */ -export interface ListHumanTaskUisRequest { +export interface ListCandidatesForAutoMLJobRequest { /** - *A filter that returns only human task user interfaces with a creation time greater than or equal to the specified timestamp.
+ *List the candidates created for the job by providing the job's name.
* @public */ - CreationTimeAfter?: Date | undefined; + AutoMLJobName: string | undefined; /** - *A filter that returns only human task user interfaces that were created before the specified timestamp.
+ *List the candidates for the job and filter by status.
* @public */ - CreationTimeBefore?: Date | undefined; + StatusEquals?: CandidateStatus | undefined; /** - *An optional value that specifies whether you want the results sorted in Ascending or Descending order.
List the candidates for the job and filter by candidate name.
* @public */ - SortOrder?: SortOrder | undefined; + CandidateNameEquals?: string | undefined; /** - *A token to resume pagination.
+ *The sort order for the results. The default is Ascending.
The total number of items to return. If the total number of available items is more than the value specified in MaxResults, then a NextToken will be provided in the output that you can use to resume pagination.
The parameter by which to sort the results. The default is
+ * Descending.
An array of objects describing the human task user interfaces.
+ *List the job's candidates up to a specified limit.
* @public */ - HumanTaskUiSummaries: HumanTaskUiSummary[] | undefined; + MaxResults?: number | undefined; /** - *A token to resume pagination.
+ *If the previous response was truncated, you receive this token. Use it in your next + * request to receive the next set of results.
* @public */ NextToken?: string | undefined; @@ -10893,248 +11063,328 @@ export interface ListHumanTaskUisResponse { /** * @public */ -export interface ListHyperParameterTuningJobsRequest { +export interface ListCandidatesForAutoMLJobResponse { /** - *If the result of the previous ListHyperParameterTuningJobs request was
- * truncated, the response includes a NextToken. To retrieve the next set of
- * tuning jobs, use the token in the next request.
Summaries about the AutoMLCandidates.
The - * maximum number of tuning jobs to return. The default value is - * 10.
+ *If the previous response was truncated, you receive this token. Use it in your next + * request to receive the next set of results.
* @public */ - MaxResults?: number | undefined; + NextToken?: string | undefined; +} +/** + * @public + */ +export interface ListClusterNodesRequest { /** - *The field to sort results by. The default is Name.
The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster in which you want to retrieve the + * list of nodes.
* @public */ - SortBy?: HyperParameterTuningJobSortByOptions | undefined; + ClusterName: string | undefined; /** - *The sort order for results. The default is Ascending.
A filter that returns nodes in a SageMaker HyperPod cluster created after the specified time. + * Timestamps are formatted according to the ISO 8601 standard.
+ *Acceptable formats include:
+ *
+ * YYYY-MM-DDThh:mm:ss.sssTZD (UTC), for example,
+ * 2014-10-01T20:30:00.000Z
+ *
+ * YYYY-MM-DDThh:mm:ss.sssTZD (with offset), for example,
+ * 2014-10-01T12:30:00.000-08:00
+ *
+ * YYYY-MM-DD, for example, 2014-10-01
+ *
Unix time in seconds, for example, 1412195400. This is also referred
+ * to as Unix Epoch time and represents the number of seconds since midnight, January 1,
+ * 1970 UTC.
For more information about the timestamp format, see Timestamp in the Amazon Web Services Command Line Interface User + * Guide.
* @public */ - SortOrder?: SortOrder | undefined; + CreationTimeAfter?: Date | undefined; /** - *A string in the tuning job name. This filter returns only tuning jobs whose name - * contains the specified string.
+ *A filter that returns nodes in a SageMaker HyperPod cluster created before the specified time. The
+ * acceptable formats are the same as the timestamp formats for
+ * CreationTimeAfter. For more information about the timestamp format, see Timestamp in the Amazon Web Services Command Line Interface User
+ * Guide.
A filter that returns only tuning jobs that were created after the specified - * time.
+ *A filter that returns the instance groups whose name contain a specified string.
* @public */ - CreationTimeAfter?: Date | undefined; + InstanceGroupNameContains?: string | undefined; /** - *A filter that returns only tuning jobs that were created before the specified - * time.
+ *The maximum number of nodes to return in the response.
* @public */ - CreationTimeBefore?: Date | undefined; + MaxResults?: number | undefined; /** - *A filter that returns only tuning jobs that were modified after the specified - * time.
+ *If the result of the previous ListClusterNodes request was truncated, the
+ * response includes a NextToken. To retrieve the next set of cluster nodes, use
+ * the token in the next request.
A filter that returns only tuning jobs that were modified before the specified - * time.
+ *The field by which to sort results. The default value is
+ * CREATION_TIME.
A filter that returns only tuning jobs with the specified status.
+ *The sort order for results. The default value is Ascending.
A list of HyperParameterTuningJobSummary objects that
- * describe
- * the tuning jobs that the ListHyperParameterTuningJobs
- * request returned.
The next token specified for listing instances in a SageMaker HyperPod cluster.
* @public */ - HyperParameterTuningJobSummaries: HyperParameterTuningJobSummary[] | undefined; + NextToken: string | undefined; /** - *If the result of this ListHyperParameterTuningJobs request was truncated,
- * the response includes a NextToken. To retrieve the next set of tuning jobs,
- * use the token in the next request.
The summaries of listed instances in a SageMaker HyperPod cluster
* @public */ - NextToken?: string | undefined; + ClusterNodeSummaries: ClusterNodeSummary[] | undefined; } /** * @public */ -export interface ListImagesRequest { +export interface ListClustersRequest { /** - *A filter that returns only images created on or after the specified time.
+ *Set a start time for the time range during which you want to list SageMaker HyperPod clusters. + * Timestamps are formatted according to the ISO 8601 standard.
+ *Acceptable formats include:
+ *
+ * YYYY-MM-DDThh:mm:ss.sssTZD (UTC), for example,
+ * 2014-10-01T20:30:00.000Z
+ *
+ * YYYY-MM-DDThh:mm:ss.sssTZD (with offset), for example,
+ * 2014-10-01T12:30:00.000-08:00
+ *
+ * YYYY-MM-DD, for example, 2014-10-01
+ *
Unix time in seconds, for example, 1412195400. This is also referred
+ * to as Unix Epoch time and represents the number of seconds since midnight, January 1,
+ * 1970 UTC.
For more information about the timestamp format, see Timestamp in the Amazon Web Services Command Line Interface User + * Guide.
* @public */ CreationTimeAfter?: Date | undefined; /** - *A filter that returns only images created on or before the specified time.
+ *Set an end time for the time range during which you want to list SageMaker HyperPod clusters. A
+ * filter that returns nodes in a SageMaker HyperPod cluster created before the specified time. The
+ * acceptable formats are the same as the timestamp formats for
+ * CreationTimeAfter. For more information about the timestamp format, see Timestamp in the Amazon Web Services Command Line Interface User
+ * Guide.
A filter that returns only images modified on or after the specified time.
- * @public - */ - LastModifiedTimeAfter?: Date | undefined; - - /** - *A filter that returns only images modified on or before the specified time.
+ *Set the maximum number of SageMaker HyperPod clusters to list.
* @public */ - LastModifiedTimeBefore?: Date | undefined; + MaxResults?: number | undefined; /** - *The maximum number of images to return in the response. The default value is 10.
+ *Set the maximum number of instances to print in the list.
* @public */ - MaxResults?: number | undefined; + NameContains?: string | undefined; /** - *A filter that returns only images whose name contains the specified string.
+ *Set the next token to retrieve the list of SageMaker HyperPod clusters.
* @public */ - NameContains?: string | undefined; + NextToken?: string | undefined; /** - *If the previous call to ListImages didn't return the full set of images,
- * the call returns a token for getting the next set of images.
The field by which to sort results. The default value is
+ * CREATION_TIME.
The property used to sort results. The default value is CREATION_TIME.
The sort order for results. The default value is Ascending.
The sort order. The default value is DESCENDING.
The Amazon Resource Name (ARN); of the training plan to filter clusters by. For more information about
+ * reserving GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see
+ * CreateTrainingPlan
+ * .
A list of images and their properties.
+ *If the result of the previous ListClusters request was truncated, the
+ * response includes a NextToken. To retrieve the next set of clusters, use the
+ * token in the next request.
A token for getting the next set of images, if there are any.
+ *The summaries of listed SageMaker HyperPod clusters.
* @public */ - NextToken?: string | undefined; + ClusterSummaries: ClusterSummary[] | undefined; } +/** + * @public + * @enum + */ +export const SortClusterSchedulerConfigBy = { + CREATION_TIME: "CreationTime", + NAME: "Name", + STATUS: "Status", +} as const; + +/** + * @public + */ +export type SortClusterSchedulerConfigBy = + (typeof SortClusterSchedulerConfigBy)[keyof typeof SortClusterSchedulerConfigBy]; + /** * @public */ -export interface ListImageVersionsRequest { +export interface ListClusterSchedulerConfigsRequest { /** - *A filter that returns only versions created on or after the specified time.
+ *Filter for after this creation time. The input for this parameter is a Unix timestamp. + * To convert a date and time into a Unix timestamp, see EpochConverter.
* @public */ - CreationTimeAfter?: Date | undefined; + CreatedAfter?: Date | undefined; /** - *A filter that returns only versions created on or before the specified time.
+ *Filter for before this creation time. The input for this parameter is a Unix timestamp. + * To convert a date and time into a Unix timestamp, see EpochConverter.
* @public */ - CreationTimeBefore?: Date | undefined; + CreatedBefore?: Date | undefined; /** - *The name of the image to list the versions of.
+ *Filter for name containing this string.
* @public */ - ImageName: string | undefined; + NameContains?: string | undefined; /** - *A filter that returns only versions modified on or after the specified time.
+ *Filter for ARN of the cluster.
* @public */ - LastModifiedTimeAfter?: Date | undefined; + ClusterArn?: string | undefined; /** - *A filter that returns only versions modified on or before the specified time.
+ *Filter for status.
* @public */ - LastModifiedTimeBefore?: Date | undefined; + Status?: SchedulerResourceStatus | undefined; /** - *The maximum number of versions to return in the response. The default value is 10.
+ *Filter for sorting the list by a given value. For example, sort by name, creation time, + * or status.
* @public */ - MaxResults?: number | undefined; + SortBy?: SortClusterSchedulerConfigBy | undefined; /** - *If the previous call to ListImageVersions didn't return the full set of
- * versions, the call returns a token for getting the next set of versions.
The order of the list. By default, listed in Descending order according to
+ * by SortBy. To change the list order, you can specify SortOrder to
+ * be Ascending.
The property used to sort results. The default value is CREATION_TIME.
If the previous response was truncated, you will receive this token. Use it in your next + * request to receive the next set of results.
* @public */ - SortBy?: ImageVersionSortBy | undefined; + NextToken?: string | undefined; /** - *The sort order. The default value is DESCENDING.
The maximum number of cluster policies to list.
* @public */ - SortOrder?: ImageVersionSortOrder | undefined; + MaxResults?: number | undefined; } /** * @public */ -export interface ListImageVersionsResponse { +export interface ListClusterSchedulerConfigsResponse { /** - *A list of versions and their properties.
+ *Summaries of the cluster policies.
* @public */ - ImageVersions?: ImageVersion[] | undefined; + ClusterSchedulerConfigSummaries?: ClusterSchedulerConfigSummary[] | undefined; /** - *A token for getting the next set of versions, if there are any.
+ *If the previous response was truncated, you will receive this token. Use it in your next + * request to receive the next set of results.
* @public */ NextToken?: string | undefined; @@ -11143,105 +11393,103 @@ export interface ListImageVersionsResponse { /** * @public */ -export interface ListInferenceComponentsInput { - /** - *The field by which to sort the inference components in the response. The default is
- * CreationTime.
The sort order for results. The default is Descending.
A token that you use to get the next set of results following a truncated response. If - * the response to the previous request was truncated, that response provides the value for - * this token.
- * @public - */ - NextToken?: string | undefined; - +export interface ListCodeRepositoriesInput { /** - *The maximum number of inference components to return in the response. This value - * defaults to 10.
+ *A filter that returns only Git repositories that were created after the specified + * time.
* @public */ - MaxResults?: number | undefined; + CreationTimeAfter?: Date | undefined; /** - *Filters the results to only those inference components with a name that contains the - * specified string.
+ *A filter that returns only Git repositories that were created before the specified + * time.
* @public */ - NameContains?: string | undefined; + CreationTimeBefore?: Date | undefined; /** - *Filters the results to only those inference components that were created before the - * specified time.
+ *A filter that returns only Git repositories that were last modified after the + * specified time.
* @public */ - CreationTimeBefore?: Date | undefined; + LastModifiedTimeAfter?: Date | undefined; /** - *Filters the results to only those inference components that were created after the - * specified time.
+ *A filter that returns only Git repositories that were last modified before the + * specified time.
* @public */ - CreationTimeAfter?: Date | undefined; + LastModifiedTimeBefore?: Date | undefined; /** - *Filters the results to only those inference components that were updated before the - * specified time.
+ *The maximum number of Git repositories to return in the response.
* @public */ - LastModifiedTimeBefore?: Date | undefined; + MaxResults?: number | undefined; /** - *Filters the results to only those inference components that were updated after the - * specified time.
+ *A string in the Git repositories name. This filter returns only repositories whose + * name contains the specified string.
* @public */ - LastModifiedTimeAfter?: Date | undefined; + NameContains?: string | undefined; /** - *Filters the results to only those inference components with the specified status.
+ *If the result of a ListCodeRepositoriesOutput request was truncated, the
+ * response includes a NextToken. To get the next set of Git repositories, use
+ * the token in the next request.
An endpoint name to filter the listed inference components. The response includes only - * those inference components that are hosted at the specified endpoint.
+ *The field to sort results by. The default is Name.
A production variant name to filter the listed inference components. The response - * includes only those inference components that are hosted at the specified variant.
+ *The sort order for results. The default is Ascending.
A list of inference components and their properties that matches any of the filters you - * specified in the request.
+ *Gets a list of summaries of the Git repositories. Each summary specifies the following + * values for the repository:
+ *Name
+ *Amazon Resource Name (ARN)
+ *Creation time
+ *Last modified time
+ *Configuration information, including the URL location of the repository and + * the ARN of the Amazon Web Services Secrets Manager secret that contains the + * credentials used to access the repository.
+ *The token to use in a subsequent request to get the next set of results following a - * truncated response.
+ *If the result of a ListCodeRepositoriesOutput request was truncated, the
+ * response includes a NextToken. To get the next set of Git repositories, use
+ * the token in the next request.
Selects inference experiments whose names contain this name.
- * @public - */ - NameContains?: string | undefined; - +export interface ListCompilationJobsRequest { /** - *- * Selects inference experiments of this type. For the possible types of inference experiments, see CreateInferenceExperiment. - *
+ *If the result of the previous ListCompilationJobs request was truncated,
+ * the response includes a NextToken. To retrieve the next set of model
+ * compilation jobs, use the token in the next request.
- * Selects inference experiments which are in this status. For the possible statuses, see DescribeInferenceExperiment. - *
+ *The maximum number of model compilation jobs to return in the response.
* @public */ - StatusEquals?: InferenceExperimentStatus | undefined; + MaxResults?: number | undefined; /** - *Selects inference experiments which were created after this timestamp.
+ *A filter that returns the model compilation jobs that were created after a specified + * time.
* @public */ CreationTimeAfter?: Date | undefined; /** - *Selects inference experiments which were created before this timestamp.
+ *A filter that returns the model compilation jobs that were created before a specified + * time.
* @public */ CreationTimeBefore?: Date | undefined; /** - *Selects inference experiments which were last modified after this timestamp.
+ *A filter that returns the model compilation jobs that were modified after a specified + * time.
* @public */ LastModifiedTimeAfter?: Date | undefined; /** - *Selects inference experiments which were last modified before this timestamp.
+ *A filter that returns the model compilation jobs that were modified before a specified + * time.
* @public */ LastModifiedTimeBefore?: Date | undefined; /** - *The column by which to sort the listed inference experiments.
+ *A filter that returns the model compilation jobs whose name contains a specified + * string.
* @public */ - SortBy?: SortInferenceExperimentsBy | undefined; + NameContains?: string | undefined; /** - *The direction of sorting (ascending or descending).
+ *A filter that retrieves model compilation jobs with a specific
+ * CompilationJobStatus status.
- * The response from the last list when returning a list large enough to need tokening. - *
+ *The field by which to sort results. The default is CreationTime.
The maximum number of results to select.
+ *The sort order for results. The default is Ascending.
List of inference experiments.
+ *An array of CompilationJobSummary objects, each describing a model compilation job. + *
* @public */ - InferenceExperiments?: InferenceExperimentSummary[] | undefined; + CompilationJobSummaries: CompilationJobSummary[] | undefined; /** - *The token to use when calling the next page of results.
+ *If the response is truncated, Amazon SageMaker returns this NextToken. To retrieve
+ * the next set of model compilation jobs, use this token in the next request.
A filter that returns only jobs created after the specified time (timestamp).
- * @public - */ - CreationTimeAfter?: Date | undefined; - +export interface ListComputeQuotasRequest { /** - *A filter that returns only jobs created before the specified time (timestamp).
+ *Filter for after this creation time. The input for this parameter is a Unix timestamp. + * To convert a date and time into a Unix timestamp, see EpochConverter.
* @public */ - CreationTimeBefore?: Date | undefined; + CreatedAfter?: Date | undefined; /** - *A filter that returns only jobs that were last modified after the specified time (timestamp).
+ *Filter for before this creation time. The input for this parameter is a Unix timestamp. + * To convert a date and time into a Unix timestamp, see EpochConverter.
* @public */ - LastModifiedTimeAfter?: Date | undefined; + CreatedBefore?: Date | undefined; /** - *A filter that returns only jobs that were last modified before the specified time (timestamp).
+ *Filter for name containing this string.
* @public */ - LastModifiedTimeBefore?: Date | undefined; + NameContains?: string | undefined; /** - *A string in the job name. This filter returns only recommendations whose name contains the specified string.
+ *Filter for status.
* @public */ - NameContains?: string | undefined; + Status?: SchedulerResourceStatus | undefined; /** - *A filter that retrieves only inference recommendations jobs with a specific status.
+ *Filter for ARN of the cluster.
* @public */ - StatusEquals?: RecommendationJobStatus | undefined; + ClusterArn?: string | undefined; /** - *The parameter by which to sort the results.
+ *Filter for sorting the list by a given value. For example, sort by name, creation time, + * or status.
* @public */ - SortBy?: ListInferenceRecommendationsJobsSortBy | undefined; + SortBy?: SortQuotaBy | undefined; /** - *The sort order for the results.
+ *The order of the list. By default, listed in Descending order according to
+ * by SortBy. To change the list order, you can specify SortOrder to
+ * be Ascending.
If the response to a previous ListInferenceRecommendationsJobsRequest request
- * was truncated, the response includes a NextToken. To retrieve the next set
- * of recommendations, use the token in the next request.
If the previous response was truncated, you will receive this token. Use it in your next + * request to receive the next set of results.
* @public */ NextToken?: string | undefined; /** - *The maximum number of recommendations to return in the response.
+ *The maximum number of compute allocation definitions to list.
* @public */ MaxResults?: number | undefined; +} +/** + * @public + */ +export interface ListComputeQuotasResponse { /** - *A filter that returns only jobs that were created for this model.
+ *Summaries of the compute allocation definitions.
* @public */ - ModelNameEquals?: string | undefined; + ComputeQuotaSummaries?: ComputeQuotaSummary[] | undefined; /** - *A filter that returns only jobs that were created for this versioned model package.
+ *If the previous response was truncated, you will receive this token. Use it in your next + * request to receive the next set of results.
* @public */ - ModelPackageVersionArnEquals?: string | undefined; + NextToken?: string | undefined; } +/** + * @public + * @enum + */ +export const SortContextsBy = { + CREATION_TIME: "CreationTime", + NAME: "Name", +} as const; + +/** + * @public + */ +export type SortContextsBy = (typeof SortContextsBy)[keyof typeof SortContextsBy]; + /** * @public */ -export interface ListInferenceRecommendationsJobsResponse { +export interface ListContextsRequest { /** - *The recommendations created from the Amazon SageMaker Inference Recommender job.
+ *A filter that returns only contexts with the specified source URI.
* @public */ - InferenceRecommendationsJobs: InferenceRecommendationsJob[] | undefined; + SourceUri?: string | undefined; /** - *A token for getting the next set of recommendations, if there are any.
+ *A filter that returns only contexts of the specified type.
* @public */ - NextToken?: string | undefined; -} + ContextType?: string | undefined; -/** - * @public - */ -export interface ListInferenceRecommendationsJobStepsRequest { /** - *The name for the Inference Recommender job.
+ *A filter that returns only contexts created on or after the specified time.
* @public */ - JobName: string | undefined; + CreatedAfter?: Date | undefined; /** - *A filter to return benchmarks of a specified status. If this field is left empty, then all benchmarks are returned.
+ *A filter that returns only contexts created on or before the specified time.
* @public */ - Status?: RecommendationJobStatus | undefined; + CreatedBefore?: Date | undefined; /** - *A filter to return details about the specified type of subtask.
- *
- * BENCHMARK: Evaluate the performance of your model on different instance types.
The property used to sort results. The default value is CreationTime.
The maximum number of results to return.
+ *The sort order. The default value is Descending.
A token that you can specify to return more results from the list. Specify this field if you have a token that was returned from a previous request.
+ *If the previous call to ListContexts didn't return the full set of contexts,
+ * the call returns a token for getting the next set of contexts.
The maximum number of contexts to return in the response. The default value is 10.
+ * @public + */ + MaxResults?: number | undefined; } /** * @public */ -export interface ListInferenceRecommendationsJobStepsResponse { +export interface ListContextsResponse { /** - *A list of all subtask details in Inference Recommender.
+ *A list of contexts and their properties.
* @public */ - Steps?: InferenceRecommendationsJobStep[] | undefined; + ContextSummaries?: ContextSummary[] | undefined; /** - *A token that you can specify in your next request to return more results from the list.
+ *A token for getting the next set of contexts, if there are any.
* @public */ NextToken?: string | undefined; @@ -11526,103 +11790,122 @@ export interface ListInferenceRecommendationsJobStepsResponse { * @public * @enum */ -export const SortBy = { +export const MonitoringJobDefinitionSortKey = { CREATION_TIME: "CreationTime", NAME: "Name", - STATUS: "Status", } as const; /** * @public */ -export type SortBy = (typeof SortBy)[keyof typeof SortBy]; +export type MonitoringJobDefinitionSortKey = + (typeof MonitoringJobDefinitionSortKey)[keyof typeof MonitoringJobDefinitionSortKey]; /** * @public */ -export interface ListLabelingJobsRequest { +export interface ListDataQualityJobDefinitionsRequest { /** - *A filter that returns only labeling jobs created after the specified time - * (timestamp).
+ *A filter that lists the data quality job definitions associated with the specified + * endpoint.
* @public */ - CreationTimeAfter?: Date | undefined; + EndpointName?: string | undefined; /** - *A filter that returns only labeling jobs created before the specified time - * (timestamp).
+ *The field to sort results by. The default is CreationTime.
A filter that returns only labeling jobs modified after the specified time - * (timestamp).
+ *Whether to sort the results in Ascending or Descending order.
+ * The default is Descending.
A filter that returns only labeling jobs modified before the specified time - * (timestamp).
+ *If the result of the previous ListDataQualityJobDefinitions request was
+ * truncated, the response includes a NextToken. To retrieve the next set of
+ * transform jobs, use the token in the next request.>
The maximum number of labeling jobs to return in each page of the response.
+ *The maximum number of data quality monitoring job definitions to return in the + * response.
* @public */ MaxResults?: number | undefined; /** - *If the result of the previous ListLabelingJobs request was truncated, the
- * response includes a NextToken. To retrieve the next set of labeling jobs,
- * use the token in the next request.
A string in the data quality monitoring job definition name. This filter returns only + * data quality monitoring job definitions whose name contains the specified string.
* @public */ - NextToken?: string | undefined; + NameContains?: string | undefined; /** - *A string in the labeling job name. This filter returns only labeling jobs whose name - * contains the specified string.
+ *A filter that returns only data quality monitoring job definitions created before the + * specified time.
* @public */ - NameContains?: string | undefined; + CreationTimeBefore?: Date | undefined; /** - *The field to sort results by. The default is CreationTime.
A filter that returns only data quality monitoring job definitions created after the + * specified time.
+ * @public + */ + CreationTimeAfter?: Date | undefined; +} + +/** + *Summary information about a monitoring job.
+ * @public + */ +export interface MonitoringJobDefinitionSummary { + /** + *The name of the monitoring job.
* @public */ - SortBy?: SortBy | undefined; + MonitoringJobDefinitionName: string | undefined; /** - *The sort order for results. The default is Ascending.
The Amazon Resource Name (ARN) of the monitoring job.
* @public */ - SortOrder?: SortOrder | undefined; + MonitoringJobDefinitionArn: string | undefined; + + /** + *The time that the monitoring job was created.
+ * @public + */ + CreationTime: Date | undefined; /** - *A filter that retrieves only labeling jobs with a specific status.
+ *The name of the endpoint that the job monitors.
* @public */ - StatusEquals?: LabelingJobStatus | undefined; + EndpointName: string | undefined; } /** * @public */ -export interface ListLabelingJobsResponse { +export interface ListDataQualityJobDefinitionsResponse { /** - *An array of LabelingJobSummary objects, each describing a labeling
- * job.
A list of data quality monitoring job definitions.
* @public */ - LabelingJobSummaryList?: LabelingJobSummary[] | undefined; + JobDefinitionSummaries: MonitoringJobDefinitionSummary[] | undefined; /** - *If the response is truncated, SageMaker returns this token. To retrieve the next set of - * labeling jobs, use it in the subsequent request.
+ *If the result of the previous 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.
The Amazon Resource Name (ARN) of the work team for which you want to see labeling - * jobs for.
+ *The response from the last list when returning a list large enough to need tokening.
* @public */ - WorkteamArn: string | undefined; + NextToken?: string | undefined; /** - *The maximum number of labeling jobs to return in each page of the response.
+ *The maximum number of results to select.
* @public */ MaxResults?: number | undefined; /** - *If the result of the previous ListLabelingJobsForWorkteam request was
- * truncated, the response includes a NextToken. To retrieve the next set of
- * labeling jobs, use the token in the next request.
A filter that returns only labeling jobs created after the specified time - * (timestamp).
+ *Filter fleets where packaging job was created after specified time.
* @public */ CreationTimeAfter?: Date | undefined; /** - *A filter that returns only labeling jobs created before the specified time - * (timestamp).
+ *Filter fleets where the edge packaging job was created before specified time.
* @public */ CreationTimeBefore?: Date | undefined; /** - *A filter the limits jobs to only the ones whose job reference code contains the - * specified string.
- * @public - */ - JobReferenceCodeContains?: string | undefined; - - /** - *The field to sort results by. The default is CreationTime.
The sort order for results. The default is Ascending.
An array of LabelingJobSummary objects, each describing a labeling
- * job.
If the response is truncated, SageMaker returns this token. To retrieve the next set of - * labeling jobs, use it in the subsequent request.
+ *Select fleets where the job was updated after X
* @public */ - NextToken?: string | undefined; -} - -/** - * @public - * @enum - */ -export const SortLineageGroupsBy = { - CREATION_TIME: "CreationTime", - NAME: "Name", -} as const; - -/** - * @public - */ -export type SortLineageGroupsBy = (typeof SortLineageGroupsBy)[keyof typeof SortLineageGroupsBy]; + LastModifiedTimeAfter?: Date | undefined; -/** - * @public - */ -export interface ListLineageGroupsRequest { /** - *A timestamp to filter against lineage groups created after a certain point in time.
+ *Select fleets where the job was updated before X
* @public */ - CreatedAfter?: Date | undefined; + LastModifiedTimeBefore?: Date | undefined; /** - *A timestamp to filter against lineage groups created before a certain point in time.
+ *Filter for fleets containing this name in their fleet device name.
* @public */ - CreatedBefore?: Date | undefined; + NameContains?: string | undefined; /** - *The parameter by which to sort the results. The default is
- * CreationTime.
The column to sort by.
* @public */ - SortBy?: SortLineageGroupsBy | undefined; + SortBy?: ListDeviceFleetsSortBy | undefined; /** - *The sort order for the results. The default is Ascending.
What direction to sort in.
* @public */ SortOrder?: SortOrder | undefined; - - /** - *If the response is truncated, SageMaker returns this token. To retrieve the next set of - * algorithms, use it in the subsequent request.
- * @public - */ - NextToken?: string | undefined; - - /** - *The maximum number of endpoints to return in the response. This value defaults to - * 10.
- * @public - */ - MaxResults?: number | undefined; } /** diff --git a/clients/client-sagemaker/src/models/models_4.ts b/clients/client-sagemaker/src/models/models_4.ts index be8b37a2f451..e4d803b79a87 100644 --- a/clients/client-sagemaker/src/models/models_4.ts +++ b/clients/client-sagemaker/src/models/models_4.ts @@ -5,8 +5,6 @@ import { ActionStatus, AdditionalInferenceSpecificationDefinition, AlgorithmSpecification, - AppNetworkAccessType, - AppSecurityGroupManagement, AppSpecification, AppType, AutoMLJobStepMetadata, @@ -18,15 +16,9 @@ import { Channel, CheckpointConfig, ClarifyCheckStepMetadata, - ClusterInstanceGroupSpecification, - ClusterNodeRecovery, - CodeEditorAppImageConfig, ConditionStepMetadata, ContainerDefinition, InferenceSpecification, - JupyterLabAppImageConfig, - KernelGatewayImageConfig, - MetadataProperties, ModelApprovalStatus, ModelPackageStatus, OutputDataConfig, @@ -43,18 +35,10 @@ import { import { _InstanceType, - DefaultSpaceSettings, - DeploymentConfig, DriftCheckBaselines, - EdgeOutputConfig, - FeatureDefinition, - InferenceComponentRuntimeConfig, - InferenceComponentSpecification, InferenceExecutionConfig, - InferenceExperimentDataStorageConfig, - InferenceExperimentSchedule, - InstanceMetadataServiceConfiguration, - JobType, + InferenceExperimentType, + MetadataProperties, ModelCardSecurityConfig, ModelCardStatus, ModelLifeCycle, @@ -67,22 +51,11 @@ import { MonitoringScheduleConfig, MonitoringType, NetworkConfig, - NotebookInstanceAcceleratorType, - NotebookInstanceLifecycleHook, - OptimizationJobDeploymentInstanceType, - Processor, RetryStrategy, - RootAccess, - ShadowModeConfig, SkipModelValidation, SourceAlgorithmSpecification, - TagPropagation, - ThroughputMode, - TrackingServerSize, TtlDuration, UiTemplate, - UserSettings, - VendorGuidance, } from "./models_1"; import { @@ -92,54 +65,89 @@ import { DebugRuleConfiguration, DebugRuleEvaluationStatus, DeploymentRecommendation, + EdgePackagingJobStatus, EndpointStatus, ExperimentConfig, - FeatureParameter, - HyperParameterTrainingJobSummary, + FeatureGroupStatus, + HubContentType, ModelArtifacts, ModelClientConfig, + OfflineStoreStatusValue, + OptimizationJobDeploymentInstanceType, ParallelismConfiguration, - PipelineDefinitionS3Location, + PartnerAppType, ProcessingInput, ProcessingOutputConfig, ProcessingResources, ProcessingStoppingCondition, ProfilerConfig, - ProfilerRuleConfiguration, - ProvisioningParameter, ServiceCatalogProvisioningDetails, SharingType, - SpaceSettings, SpaceStorageSettings, StudioLifecycleConfigAppType, TensorBoardOutputConfig, - TrainingJobStatus, TrialComponentArtifact, TrialComponentParameterValue, TrialComponentStatus, } from "./models_2"; import { - DesiredWeightAndCapacity, Device, DeviceDeploymentSummary, + DeviceFleetSummary, + DeviceSummary, Direction, - DomainSettingsForUpdate, + DomainDetails, Edge, + EdgeDeploymentPlanSummary, + EdgePackagingJobSummary, EMRStepMetadata, Endpoint, + EndpointConfigSortKey, EndpointConfigStepMetadata, + EndpointConfigSummary, + EndpointSortKey, EndpointStepMetadata, + EndpointSummary, ExecutionStatus, Experiment, + ExperimentSummary, FailStepMetadata, FeatureGroup, + FeatureGroupSortBy, + FeatureGroupSortOrder, + FeatureGroupSummary, FeatureMetadata, Filter, - GitConfigForUpdate, + FlowDefinitionSummary, + HubContentInfo, + HubContentSortBy, + HubInfo, + HubSortBy, + HumanTaskUiSummary, + HyperParameterTrainingJobSummary, HyperParameterTuningJobSearchEntity, + HyperParameterTuningJobSortByOptions, + HyperParameterTuningJobStatus, + HyperParameterTuningJobSummary, + Image, + ImageSortBy, + ImageSortOrder, + ImageVersion, + ImageVersionSortBy, + ImageVersionSortOrder, + InferenceComponentSortKey, + InferenceComponentStatus, + InferenceComponentSummary, + InferenceExperimentStatus, InferenceExperimentStopDesiredState, + InferenceExperimentSummary, + InferenceRecommendationsJob, + InferenceRecommendationsJobStep, IsTrackingServerActive, + LabelingJobForWorkteamSummary, + LabelingJobStatus, + LabelingJobSummary, LambdaStepMetadata, LineageGroupSummary, LineageType, @@ -152,22 +160,28 @@ import { MonitoringJobDefinitionSummary, NotebookInstanceStatus, OptimizationJobStatus, - OrderKey, + PartnerAppStatus, PipelineExecutionStatus, PipelineExperimentConfig, PipelineStatus, ProcessingJobStatus, ProjectStatus, + RecommendationJobStatus, + RecommendationStepType, + ReservedCapacityInstanceType, + ReservedCapacitySummary, + SageMakerResourceName, ScheduleStatus, SecondaryStatus, SecondaryStatusTransition, SelectiveExecutionConfig, ServiceCatalogProvisionedProductDetails, - SortBy, SortOrder, SpaceStatus, SubscribedWorkteam, TrackingServerStatus, + TrainingJobStatus, + TrainingPlanStatus, TransformJobStatus, TrialComponentMetricSummary, TrialComponentSource, @@ -182,231 +196,210 @@ import { /** * @public */ -export interface ListLineageGroupsResponse { +export interface ListDeviceFleetsResponse { /** - *A list of lineage groups and their properties.
+ *Summary of the device fleet.
* @public */ - LineageGroupSummaries?: LineageGroupSummary[] | undefined; + DeviceFleetSummaries: DeviceFleetSummary[] | undefined; /** - *If the response is truncated, SageMaker returns this token. To retrieve the next set of - * algorithms, use it in the subsequent request.
+ *The response from the last list when returning a list large enough to need tokening.
* @public */ NextToken?: string | undefined; } -/** - * @public - * @enum - */ -export const SortTrackingServerBy = { - CREATION_TIME: "CreationTime", - NAME: "Name", - STATUS: "Status", -} as const; - -/** - * @public - */ -export type SortTrackingServerBy = (typeof SortTrackingServerBy)[keyof typeof SortTrackingServerBy]; - /** * @public */ -export interface ListMlflowTrackingServersRequest { +export interface ListDevicesRequest { /** - *Use the CreatedAfter filter to only list tracking servers created after a
- * specific date and time. Listed tracking servers are shown with a date and time such as
- * "2024-03-16T01:46:56+00:00". The CreatedAfter parameter takes in a
- * Unix timestamp. To convert a date and time into a Unix timestamp, see EpochConverter.
The response from the last list when returning a list large enough to need tokening.
* @public */ - CreatedAfter?: Date | undefined; + NextToken?: string | undefined; /** - *Use the CreatedBefore filter to only list tracking servers created before a
- * specific date and time. Listed tracking servers are shown with a date and time such as
- * "2024-03-16T01:46:56+00:00". The CreatedBefore parameter takes in
- * a Unix timestamp. To convert a date and time into a Unix timestamp, see EpochConverter.
Maximum number of results to select.
* @public */ - CreatedBefore?: Date | undefined; + MaxResults?: number | undefined; /** - *Filter for tracking servers with a specified creation status.
+ *Select fleets where the job was updated after X
* @public */ - TrackingServerStatus?: TrackingServerStatus | undefined; + LatestHeartbeatAfter?: Date | undefined; /** - *Filter for tracking servers using the specified MLflow version.
+ *A filter that searches devices that contains this name in any of their models.
* @public */ - MlflowVersion?: string | undefined; + ModelName?: string | undefined; /** - *Filter for trackings servers sorting by name, creation time, or creation status.
+ *Filter for fleets containing this name in their device fleet name.
* @public */ - SortBy?: SortTrackingServerBy | undefined; + DeviceFleetName?: string | undefined; +} +/** + * @public + */ +export interface ListDevicesResponse { /** - *Change the order of the listed tracking servers. By default, tracking servers are listed in Descending order by creation time.
- * To change the list order, you can specify SortOrder to be Ascending.
Summary of devices.
* @public */ - SortOrder?: SortOrder | undefined; + DeviceSummaries: DeviceSummary[] | undefined; /** - *If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.
+ *The response from the last list when returning a list large enough to need tokening.
* @public */ NextToken?: string | undefined; - - /** - *The maximum number of tracking servers to list.
- * @public - */ - MaxResults?: number | undefined; } /** - *The summary of the tracking server to list.
* @public */ -export interface TrackingServerSummary { +export interface ListDomainsRequest { /** - *The ARN of a listed tracking server.
- * @public - */ - TrackingServerArn?: string | undefined; - - /** - *The name of a listed tracking server.
+ *If the previous response was truncated, you will receive this token. Use it in your next + * request to receive the next set of results.
* @public */ - TrackingServerName?: string | undefined; + NextToken?: string | undefined; /** - *The creation time of a listed tracking server.
+ *This parameter defines the maximum number of results that can be return in a single
+ * response. The MaxResults parameter is an upper bound, not a target. If there are
+ * more results available than the value specified, a NextToken is provided in the
+ * response. The NextToken indicates that the user should get the next set of
+ * results by providing this token as a part of a subsequent call. The default value for
+ * MaxResults is 10.
The last modified time of a listed tracking server.
+ *The list of domains.
* @public */ - LastModifiedTime?: Date | undefined; + Domains?: DomainDetails[] | undefined; /** - *The creation status of a listed tracking server.
+ *If the previous response was truncated, you will receive this token. Use it in your next + * request to receive the next set of results.
* @public */ - TrackingServerStatus?: TrackingServerStatus | undefined; + NextToken?: string | undefined; +} - /** - *The activity status of a listed tracking server.
- * @public - */ - IsActive?: IsTrackingServerActive | undefined; +/** + * @public + * @enum + */ +export const ListEdgeDeploymentPlansSortBy = { + CreationTime: "CREATION_TIME", + DeviceFleetName: "DEVICE_FLEET_NAME", + LastModifiedTime: "LAST_MODIFIED_TIME", + Name: "NAME", +} as const; - /** - *The MLflow version used for a listed tracking server.
- * @public - */ - MlflowVersion?: string | undefined; -} +/** + * @public + */ +export type ListEdgeDeploymentPlansSortBy = + (typeof ListEdgeDeploymentPlansSortBy)[keyof typeof ListEdgeDeploymentPlansSortBy]; /** * @public */ -export interface ListMlflowTrackingServersResponse { +export interface ListEdgeDeploymentPlansRequest { /** - *A list of tracking servers according to chosen filters.
+ *The response from the last list when returning a list large enough to need + * tokening.
* @public */ - TrackingServerSummaries?: TrackingServerSummary[] | undefined; + NextToken?: string | undefined; /** - *If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.
+ *The maximum number of results to select (50 by default).
* @public */ - NextToken?: string | undefined; -} + MaxResults?: number | undefined; -/** - * @public - */ -export interface ListModelBiasJobDefinitionsRequest { /** - *Name of the endpoint to monitor for model bias.
+ *Selects edge deployment plans created after this time.
* @public */ - EndpointName?: string | undefined; + CreationTimeAfter?: Date | undefined; /** - *Whether to sort results by the Name or CreationTime field.
- * The default is CreationTime.
Selects edge deployment plans created before this time.
* @public */ - SortBy?: MonitoringJobDefinitionSortKey | undefined; + CreationTimeBefore?: Date | undefined; /** - *Whether to sort the results in Ascending or Descending order.
- * The default is Descending.
Selects edge deployment plans that were last updated after this time.
* @public */ - SortOrder?: SortOrder | undefined; + LastModifiedTimeAfter?: Date | undefined; /** - *The token returned if the response is truncated. To retrieve the next set of job executions, use - * it in the next request.
+ *Selects edge deployment plans that were last updated before this time.
* @public */ - NextToken?: string | undefined; + LastModifiedTimeBefore?: Date | undefined; /** - *The maximum number of model bias jobs to return in the response. The default value is - * 10.
+ *Selects edge deployment plans with names containing this name.
* @public */ - MaxResults?: number | undefined; + NameContains?: string | undefined; /** - *Filter for model bias jobs whose name contains a specified string.
+ *Selects edge deployment plans with a device fleet name containing this name.
* @public */ - NameContains?: string | undefined; + DeviceFleetNameContains?: string | undefined; /** - *A filter that returns only model bias jobs created before a specified time.
+ *The column by which to sort the edge deployment plans. Can be one of
+ * NAME, DEVICEFLEETNAME, CREATIONTIME,
+ * LASTMODIFIEDTIME.
A filter that returns only model bias jobs created after a specified time.
+ *The direction of the sorting (ascending or descending).
* @public */ - CreationTimeAfter?: Date | undefined; + SortOrder?: SortOrder | undefined; } /** * @public */ -export interface ListModelBiasJobDefinitionsResponse { +export interface ListEdgeDeploymentPlansResponse { /** - *A JSON array in which each element is a summary for a model bias jobs.
+ *List of summaries of edge deployment plans.
* @public */ - JobDefinitionSummaries: MonitoringJobDefinitionSummary[] | undefined; + EdgeDeploymentPlanSummaries: EdgeDeploymentPlanSummary[] | undefined; /** - *The token returned if the response is truncated. To retrieve the next set of job executions, use - * it in the next request.
+ *The token to use when calling the next page of results.
* @public */ NextToken?: string | undefined; @@ -416,316 +409,278 @@ export interface ListModelBiasJobDefinitionsResponse { * @public * @enum */ -export const ModelCardExportJobSortBy = { - CREATION_TIME: "CreationTime", - NAME: "Name", - STATUS: "Status", -} as const; - -/** - * @public - */ -export type ModelCardExportJobSortBy = (typeof ModelCardExportJobSortBy)[keyof typeof ModelCardExportJobSortBy]; - -/** - * @public - * @enum - */ -export const ModelCardExportJobSortOrder = { - ASCENDING: "Ascending", - DESCENDING: "Descending", +export const ListEdgePackagingJobsSortBy = { + CreationTime: "CREATION_TIME", + EdgePackagingJobStatus: "STATUS", + LastModifiedTime: "LAST_MODIFIED_TIME", + ModelName: "MODEL_NAME", + Name: "NAME", } as const; /** * @public */ -export type ModelCardExportJobSortOrder = - (typeof ModelCardExportJobSortOrder)[keyof typeof ModelCardExportJobSortOrder]; +export type ListEdgePackagingJobsSortBy = + (typeof ListEdgePackagingJobsSortBy)[keyof typeof ListEdgePackagingJobsSortBy]; /** * @public */ -export interface ListModelCardExportJobsRequest { +export interface ListEdgePackagingJobsRequest { /** - *List export jobs for the model card with the specified name.
+ *The response from the last list when returning a list large enough to need tokening.
* @public */ - ModelCardName: string | undefined; + NextToken?: string | undefined; /** - *List export jobs for the model card with the specified version.
+ *Maximum number of results to select.
* @public */ - ModelCardVersion?: number | undefined; + MaxResults?: number | undefined; /** - *Only list model card export jobs that were created after the time specified.
+ *Select jobs where the job was created after specified time.
* @public */ CreationTimeAfter?: Date | undefined; /** - *Only list model card export jobs that were created before the time specified.
+ *Select jobs where the job was created before specified time.
* @public */ CreationTimeBefore?: Date | undefined; /** - *Only list model card export jobs with names that contain the specified string.
+ *Select jobs where the job was updated after specified time.
* @public */ - ModelCardExportJobNameContains?: string | undefined; + LastModifiedTimeAfter?: Date | undefined; /** - *Only list model card export jobs with the specified status.
+ *Select jobs where the job was updated before specified time.
* @public */ - StatusEquals?: ModelCardExportJobStatus | undefined; + LastModifiedTimeBefore?: Date | undefined; /** - *Sort model card export jobs by either name or creation time. Sorts by creation time by default.
+ *Filter for jobs containing this name in their packaging job name.
* @public */ - SortBy?: ModelCardExportJobSortBy | undefined; + NameContains?: string | undefined; /** - *Sort model card export jobs by ascending or descending order.
+ *Filter for jobs where the model name contains this string.
* @public */ - SortOrder?: ModelCardExportJobSortOrder | undefined; + ModelNameContains?: string | undefined; /** - *If the response to a previous ListModelCardExportJobs request was
- * truncated, the response includes a NextToken. To retrieve the next set of
- * model card export jobs, use the token in the next request.
The job status to filter for.
* @public */ - NextToken?: string | undefined; + StatusEquals?: EdgePackagingJobStatus | undefined; /** - *The maximum number of model card export jobs to list.
+ *Use to specify what column to sort by.
* @public */ - MaxResults?: number | undefined; + SortBy?: ListEdgePackagingJobsSortBy | undefined; + + /** + *What direction to sort by.
+ * @public + */ + SortOrder?: SortOrder | undefined; } /** - *The summary of the Amazon SageMaker Model Card export job.
* @public */ -export interface ModelCardExportJobSummary { +export interface ListEdgePackagingJobsResponse { /** - *The name of the model card export job.
+ *Summaries of edge packaging jobs.
* @public */ - ModelCardExportJobName: string | undefined; + EdgePackagingJobSummaries: EdgePackagingJobSummary[] | undefined; /** - *The Amazon Resource Name (ARN) of the model card export job.
+ *Token to use when calling the next page of results.
* @public */ - ModelCardExportJobArn: string | undefined; + NextToken?: string | undefined; +} + +/** + * @public + * @enum + */ +export const OrderKey = { + Ascending: "Ascending", + Descending: "Descending", +} as const; + +/** + * @public + */ +export type OrderKey = (typeof OrderKey)[keyof typeof OrderKey]; +/** + * @public + */ +export interface ListEndpointConfigsInput { /** - *The completion status of the model card export job.
+ *The field to sort results by. The default is CreationTime.
The name of the model card that the export job exports.
+ *The sort order for results. The default is Descending.
The version of the model card that the export job exports.
+ *If the result of the previous ListEndpointConfig request was
+ * truncated, the response includes a NextToken. To retrieve the next set of
+ * endpoint configurations, use the token in the next request.
The date and time that the model card export job was created.
+ *The maximum number of training jobs to return in the response.
* @public */ - CreatedAt: Date | undefined; + MaxResults?: number | undefined; /** - *The date and time that the model card export job was last modified..
+ *A string in the endpoint configuration name. This filter returns only endpoint + * configurations whose name contains the specified string.
* @public */ - LastModifiedAt: Date | undefined; -} + NameContains?: string | undefined; -/** - * @public - */ -export interface ListModelCardExportJobsResponse { /** - *The summaries of the listed model card export jobs.
+ *A filter that returns only endpoint configurations created before the specified + * time (timestamp).
* @public */ - ModelCardExportJobSummaries: ModelCardExportJobSummary[] | undefined; + CreationTimeBefore?: Date | undefined; /** - *If the response is truncated, SageMaker returns this token. To retrieve the next set of model - * card export jobs, use it in the subsequent request.
+ *A filter that returns only endpoint configurations with a creation time greater + * than or equal to the specified time (timestamp).
* @public */ - NextToken?: string | undefined; + CreationTimeAfter?: Date | undefined; } -/** - * @public - * @enum - */ -export const ModelCardSortBy = { - CREATION_TIME: "CreationTime", - NAME: "Name", -} as const; - -/** - * @public - */ -export type ModelCardSortBy = (typeof ModelCardSortBy)[keyof typeof ModelCardSortBy]; - -/** - * @public - * @enum - */ -export const ModelCardSortOrder = { - ASCENDING: "Ascending", - DESCENDING: "Descending", -} as const; - -/** - * @public - */ -export type ModelCardSortOrder = (typeof ModelCardSortOrder)[keyof typeof ModelCardSortOrder]; - /** * @public */ -export interface ListModelCardsRequest { - /** - *Only list model cards that were created after the time specified.
- * @public - */ - CreationTimeAfter?: Date | undefined; - +export interface ListEndpointConfigsOutput { /** - *Only list model cards that were created before the time specified.
+ *An array of endpoint configurations.
* @public */ - CreationTimeBefore?: Date | undefined; + EndpointConfigs: EndpointConfigSummary[] | undefined; /** - *The maximum number of model cards to list.
+ *If the response is truncated, SageMaker returns this token. To retrieve the next set of + * endpoint configurations, use it in the subsequent request
* @public */ - MaxResults?: number | undefined; + NextToken?: string | undefined; +} +/** + * @public + */ +export interface ListEndpointsInput { /** - *Only list model cards with names that contain the specified string.
+ *Sorts the list of results. The default is CreationTime.
Only list model cards with the specified approval status.
+ *The sort order for results. The default is Descending.
If the response to a previous ListModelCards request was truncated, the
- * response includes a NextToken. To retrieve the next set of model cards, use
- * the token in the next request.
If the result of a ListEndpoints request was truncated, the response
+ * includes a NextToken. To retrieve the next set of endpoints, use the token
+ * in the next request.
Sort model cards by either name or creation time. Sorts by creation time by default.
+ *The maximum number of endpoints to return in the response. This value defaults to + * 10.
* @public */ - SortBy?: ModelCardSortBy | undefined; + MaxResults?: number | undefined; /** - *Sort model cards by ascending or descending order.
+ *A string in endpoint names. This filter returns only endpoints whose name contains + * the specified string.
* @public */ - SortOrder?: ModelCardSortOrder | undefined; -} + NameContains?: string | undefined; -/** - *A summary of the model card.
- * @public - */ -export interface ModelCardSummary { /** - *The name of the model card.
+ *A filter that returns only endpoints that were created before the specified time + * (timestamp).
* @public */ - ModelCardName: string | undefined; + CreationTimeBefore?: Date | undefined; /** - *The Amazon Resource Name (ARN) of the model card.
+ *A filter that returns only endpoints with a creation time greater than or equal to + * the specified time (timestamp).
* @public */ - ModelCardArn: string | undefined; + CreationTimeAfter?: Date | undefined; /** - *The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.
- *
- * Draft: The model card is a work in progress.
- * PendingReview: The model card is pending review.
- * Approved: The model card is approved.
- * Archived: The model card is archived. No more updates should be made to the model
- * card, but it can still be exported.
A filter that returns only endpoints that were modified before the specified + * timestamp.
* @public */ - ModelCardStatus: ModelCardStatus | undefined; + LastModifiedTimeBefore?: Date | undefined; /** - *The date and time that the model card was created.
+ *A filter that returns only endpoints that were modified after the specified + * timestamp.
* @public */ - CreationTime: Date | undefined; + LastModifiedTimeAfter?: Date | undefined; /** - *The date and time that the model card was last modified.
+ *A filter that returns only endpoints with the specified status.
* @public */ - LastModifiedTime?: Date | undefined; + StatusEquals?: EndpointStatus | undefined; } /** * @public */ -export interface ListModelCardsResponse { +export interface ListEndpointsOutput { /** - *The summaries of the listed model cards.
+ *An array or endpoint objects.
* @public */ - ModelCardSummaries: ModelCardSummary[] | undefined; + Endpoints: EndpointSummary[] | undefined; /** - *If the response is truncated, SageMaker returns this token. To retrieve the next set of model - * cards, use it in the subsequent request.
+ *If the response is truncated, SageMaker returns this token. To retrieve the next set of + * training jobs, use it in the subsequent request.
* @public */ NextToken?: string | undefined; @@ -735,144 +690,151 @@ export interface ListModelCardsResponse { * @public * @enum */ -export const ModelCardVersionSortBy = { - VERSION: "Version", +export const SortExperimentsBy = { + CREATION_TIME: "CreationTime", + NAME: "Name", } as const; /** * @public */ -export type ModelCardVersionSortBy = (typeof ModelCardVersionSortBy)[keyof typeof ModelCardVersionSortBy]; +export type SortExperimentsBy = (typeof SortExperimentsBy)[keyof typeof SortExperimentsBy]; /** * @public */ -export interface ListModelCardVersionsRequest { +export interface ListExperimentsRequest { /** - *Only list model card versions that were created after the time specified.
+ *A filter that returns only experiments created after the specified time.
* @public */ - CreationTimeAfter?: Date | undefined; + CreatedAfter?: Date | undefined; /** - *Only list model card versions that were created before the time specified.
+ *A filter that returns only experiments created before the specified time.
* @public */ - CreationTimeBefore?: Date | undefined; + CreatedBefore?: Date | undefined; /** - *The maximum number of model card versions to list.
+ *The property used to sort results. The default value is CreationTime.
List model card versions for the model card with the specified name or Amazon Resource Name (ARN).
+ *The sort order. The default value is Descending.
Only list model card versions with the specified approval status.
+ *If the previous call to ListExperiments didn't return the full set of
+ * experiments, the call returns a token for getting the next set of experiments.
If the response to a previous ListModelCardVersions request was truncated,
- * the response includes a NextToken. To retrieve the next set of model card
- * versions, use the token in the next request.
The maximum number of experiments to return in the response. The default value is + * 10.
* @public */ - NextToken?: string | undefined; + MaxResults?: number | undefined; +} +/** + * @public + */ +export interface ListExperimentsResponse { /** - *Sort listed model card versions by version. Sorts by version by default.
+ *A list of the summaries of your experiments.
* @public */ - SortBy?: ModelCardVersionSortBy | undefined; + ExperimentSummaries?: ExperimentSummary[] | undefined; /** - *Sort model card versions by ascending or descending order.
+ *A token for getting the next set of experiments, if there are any.
* @public */ - SortOrder?: ModelCardSortOrder | undefined; + NextToken?: string | undefined; } /** - *A summary of a specific version of the model card.
* @public */ -export interface ModelCardVersionSummary { +export interface ListFeatureGroupsRequest { /** - *The name of the model card.
+ *A string that partially matches one or more FeatureGroups names. Filters
+ * FeatureGroups by name.
The Amazon Resource Name (ARN) of the model card.
+ *A FeatureGroup status. Filters by FeatureGroup status.
The approval status of the model card version within your organization. Different organizations might have different criteria for model card review and approval.
- *
- * Draft: The model card is a work in progress.
- * PendingReview: The model card is pending review.
- * Approved: The model card is approved.
- * Archived: The model card is archived. No more updates should be made to the model
- * card, but it can still be exported.
An OfflineStore status. Filters by OfflineStore status.
+ *
A version of the model card.
+ *Use this parameter to search for FeatureGroupss created after a specific
+ * date and time.
The date and time that the model card version was created.
+ *Use this parameter to search for FeatureGroupss created before a specific
+ * date and time.
The time date and time that the model card version was last modified.
+ *The order in which feature groups are listed.
* @public */ - LastModifiedTime?: Date | undefined; + SortOrder?: FeatureGroupSortOrder | undefined; + + /** + *The value on which the feature group list is sorted.
+ * @public + */ + SortBy?: FeatureGroupSortBy | undefined; + + /** + *The maximum number of results returned by ListFeatureGroups.
A token to resume pagination of ListFeatureGroups results.
The summaries of the listed versions of the model card.
+ *A summary of feature groups.
* @public */ - ModelCardVersionSummaryList: ModelCardVersionSummary[] | undefined; + FeatureGroupSummaries: FeatureGroupSummary[] | undefined; /** - *If the response is truncated, SageMaker returns this token. To retrieve the next set of model - * card versions, use it in the subsequent request.
+ *A token to resume pagination of ListFeatureGroups results.
Name of the endpoint to monitor for model explainability.
+ *A filter that returns only flow definitions with a creation time greater than or equal to the specified timestamp.
* @public */ - EndpointName?: string | undefined; + CreationTimeAfter?: Date | undefined; /** - *Whether to sort results by the Name or CreationTime field.
- * The default is CreationTime.
A filter that returns only flow definitions that were created before the specified timestamp.
* @public */ - SortBy?: MonitoringJobDefinitionSortKey | undefined; + CreationTimeBefore?: Date | undefined; /** - *Whether to sort the results in Ascending or Descending order.
- * The default is Descending.
An optional value that specifies whether you want the results sorted in Ascending or Descending order.
The token returned if the response is truncated. To retrieve the next set of job executions, use - * it in the next request.
+ *A token to resume pagination.
* @public */ NextToken?: string | undefined; /** - *The maximum number of jobs to return in the response. The default value is 10.
+ *The total number of items to return. If the total number of available items is more than the value specified in MaxResults, then a NextToken will be provided in the output that you can use to resume pagination.
Filter for model explainability jobs whose name contains a specified string.
- * @public - */ - NameContains?: string | undefined; - - /** - *A filter that returns only model explainability jobs created before a specified - * time.
+ *An array of objects describing the flow definitions.
* @public */ - CreationTimeBefore?: Date | undefined; + FlowDefinitionSummaries: FlowDefinitionSummary[] | undefined; /** - *A filter that returns only model explainability jobs created after a specified - * time.
+ *A token to resume pagination.
* @public */ - CreationTimeAfter?: Date | undefined; + NextToken?: string | undefined; } /** * @public */ -export interface ListModelExplainabilityJobDefinitionsResponse { +export interface ListHubContentsRequest { /** - *A JSON array in which each element is a summary for a explainability bias jobs.
+ *The name of the hub to list the contents of.
* @public */ - JobDefinitionSummaries: MonitoringJobDefinitionSummary[] | undefined; + HubName: string | undefined; /** - *The token returned if the response is truncated. To retrieve the next set of job executions, use - * it in the next request.
+ *The type of hub content to list.
* @public */ - NextToken?: string | undefined; -} + HubContentType: HubContentType | undefined; -/** - * @public - * @enum - */ -export const ModelMetadataFilterType = { - DOMAIN: "Domain", - FRAMEWORK: "Framework", - FRAMEWORKVERSION: "FrameworkVersion", - TASK: "Task", -} as const; + /** + *Only list hub content if the name contains the specified string.
+ * @public + */ + NameContains?: string | undefined; -/** - * @public - */ -export type ModelMetadataFilterType = (typeof ModelMetadataFilterType)[keyof typeof ModelMetadataFilterType]; + /** + *The upper bound of the hub content schema verion.
+ * @public + */ + MaxSchemaVersion?: string | undefined; -/** - *Part of the search expression. You can specify the name and value - * (domain, task, framework, framework version, task, and model).
- * @public - */ -export interface ModelMetadataFilter { /** - *The name of the of the model to filter by.
+ *Only list hub content that was created before the time specified.
* @public */ - Name: ModelMetadataFilterType | undefined; + CreationTimeBefore?: Date | undefined; /** - *The value to filter the model metadata.
+ *Only list hub content that was created after the time specified.
* @public */ - Value: string | undefined; + CreationTimeAfter?: Date | undefined; + + /** + *Sort hub content versions by either name or creation time.
+ * @public + */ + SortBy?: HubContentSortBy | undefined; + + /** + *Sort hubs by ascending or descending order.
+ * @public + */ + SortOrder?: SortOrder | undefined; + + /** + *The maximum amount of hub content to list.
+ * @public + */ + MaxResults?: number | undefined; + + /** + *If the response to a previous ListHubContents request was truncated, the response includes a NextToken. To retrieve the next set of hub content, use the token in the next request.
One or more filters that searches for the specified resource or resources in - * a search. All resource objects that satisfy the expression's condition are - * included in the search results
* @public */ -export interface ModelMetadataSearchExpression { +export interface ListHubContentsResponse { /** - *A list of filter objects.
+ *The summaries of the listed hub content.
* @public */ - Filters?: ModelMetadataFilter[] | undefined; + HubContentSummaries: HubContentInfo[] | undefined; + + /** + *If the response is truncated, SageMaker returns this token. To retrieve the next set of hub content, use it in the subsequent request.
+ * @public + */ + NextToken?: string | undefined; } /** * @public */ -export interface ListModelMetadataRequest { +export interface ListHubContentVersionsRequest { /** - *One or more filters that searches for the specified resource or resources - * in a search. All resource objects that satisfy the expression's condition are - * included in the search results. Specify the Framework, FrameworkVersion, Domain - * or Task to filter supported. Filter names and values are case-sensitive.
+ *The name of the hub to list the content versions of.
* @public */ - SearchExpression?: ModelMetadataSearchExpression | undefined; + HubName: string | undefined; /** - *If the response to a previous ListModelMetadataResponse request was truncated,
- * the response includes a NextToken. To retrieve the next set of model metadata,
- * use the token in the next request.
The type of hub content to list versions of.
* @public */ - NextToken?: string | undefined; + HubContentType: HubContentType | undefined; /** - *The maximum number of models to return in the response.
+ *The name of the hub content.
* @public */ - MaxResults?: number | undefined; -} + HubContentName: string | undefined; -/** - *A summary of the model metadata.
- * @public - */ -export interface ModelMetadataSummary { /** - *The machine learning domain of the model.
+ *The lower bound of the hub content versions to list.
* @public */ - Domain: string | undefined; + MinVersion?: string | undefined; /** - *The machine learning framework of the model.
+ *The upper bound of the hub content schema version.
* @public */ - Framework: string | undefined; + MaxSchemaVersion?: string | undefined; /** - *The machine learning task of the model.
+ *Only list hub content versions that were created before the time specified.
* @public */ - Task: string | undefined; + CreationTimeBefore?: Date | undefined; /** - *The name of the model.
+ *Only list hub content versions that were created after the time specified.
* @public */ - Model: string | undefined; + CreationTimeAfter?: Date | undefined; /** - *The framework version of the model.
+ *Sort hub content versions by either name or creation time.
* @public */ - FrameworkVersion: string | undefined; -} + SortBy?: HubContentSortBy | undefined; -/** - * @public - */ -export interface ListModelMetadataResponse { /** - *A structure that holds model metadata.
+ *Sort hub content versions by ascending or descending order.
* @public */ - ModelMetadataSummaries: ModelMetadataSummary[] | undefined; + SortOrder?: SortOrder | undefined; /** - *A token for getting the next set of recommendations, if there are any.
+ *The maximum number of hub content versions to list.
+ * @public + */ + MaxResults?: number | undefined; + + /** + *If the response to a previous ListHubContentVersions request was truncated, the response includes a NextToken. To retrieve the next set of hub content versions, use the token in the next request.
The summaries of the listed hub content versions.
+ * @public + */ + HubContentSummaries: HubContentInfo[] | undefined; -/** - * @public - */ -export type ModelPackageGroupSortBy = (typeof ModelPackageGroupSortBy)[keyof typeof ModelPackageGroupSortBy]; + /** + *If the response is truncated, SageMaker returns this token. To retrieve the next set of hub content versions, use it in the subsequent request.
+ * @public + */ + NextToken?: string | undefined; +} /** * @public */ -export interface ListModelPackageGroupsInput { +export interface ListHubsRequest { /** - *A filter that returns only model groups created after the specified time.
+ *Only list hubs with names that contain the specified string.
* @public */ - CreationTimeAfter?: Date | undefined; + NameContains?: string | undefined; /** - *A filter that returns only model groups created before the specified time.
+ *Only list hubs that were created before the time specified.
* @public */ CreationTimeBefore?: Date | undefined; /** - *The maximum number of results to return in the response.
+ *Only list hubs that were created after the time specified.
* @public */ - MaxResults?: number | undefined; + CreationTimeAfter?: Date | undefined; /** - *A string in the model group name. This filter returns only model groups whose name - * contains the specified string.
+ *Only list hubs that were last modified before the time specified.
* @public */ - NameContains?: string | undefined; + LastModifiedTimeBefore?: Date | undefined; /** - *If the result of the previous ListModelPackageGroups request was
- * truncated, the response includes a NextToken. To retrieve the next set of
- * model groups, use the token in the next request.
Only list hubs that were last modified after the time specified.
* @public */ - NextToken?: string | undefined; + LastModifiedTimeAfter?: Date | undefined; /** - *The field to sort results by. The default is CreationTime.
Sort hubs by either name or creation time.
* @public */ - SortBy?: ModelPackageGroupSortBy | undefined; + SortBy?: HubSortBy | undefined; /** - *The sort order for results. The default is Ascending.
Sort hubs by ascending or descending order.
* @public */ SortOrder?: SortOrder | undefined; /** - *A filter that returns either model groups shared with you or model groups in
- * your own account. When the value is 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.
The maximum number of hubs to list.
* @public */ - CrossAccountFilterOption?: CrossAccountFilterOption | undefined; + MaxResults?: number | undefined; + + /** + *If the response to a previous ListHubs request was truncated, the response includes a NextToken. To retrieve the next set of hubs, use the token in the next request.
Summary information about a model group.
* @public */ -export interface ModelPackageGroupSummary { +export interface ListHubsResponse { /** - *The name of the model group.
+ *The summaries of the listed hubs.
* @public */ - ModelPackageGroupName: string | undefined; + HubSummaries: HubInfo[] | undefined; /** - *The Amazon Resource Name (ARN) of the model group.
+ *If the response is truncated, SageMaker returns this token. To retrieve the next set of hubs, use it in the subsequent request.
* @public */ - ModelPackageGroupArn: string | undefined; + NextToken?: string | undefined; +} +/** + * @public + */ +export interface ListHumanTaskUisRequest { /** - *A description of the model group.
+ *A filter that returns only human task user interfaces with a creation time greater than or equal to the specified timestamp.
* @public */ - ModelPackageGroupDescription?: string | undefined; + CreationTimeAfter?: Date | undefined; /** - *The time that the model group was created.
+ *A filter that returns only human task user interfaces that were created before the specified timestamp.
* @public */ - CreationTime: Date | undefined; + CreationTimeBefore?: Date | undefined; /** - *The status of the model group.
+ *An optional value that specifies whether you want the results sorted in Ascending or Descending order.
A list of summaries of the model groups in your Amazon Web Services account.
+ *A token to resume pagination.
* @public */ - ModelPackageGroupSummaryList: ModelPackageGroupSummary[] | undefined; + NextToken?: string | undefined; /** - *If the response is truncated, SageMaker returns this token. To retrieve the next set - * of model groups, use it in the subsequent request.
+ *The total number of items to return. If the total number of available items is more than the value specified in MaxResults, then a NextToken will be provided in the output that you can use to resume pagination.
An array of objects describing the human task user interfaces.
+ * @public + */ + HumanTaskUiSummaries: HumanTaskUiSummary[] | undefined; -/** - * @public - * @enum - */ -export const ModelPackageSortBy = { - CREATION_TIME: "CreationTime", - NAME: "Name", -} as const; + /** + *A token to resume pagination.
+ * @public + */ + NextToken?: string | undefined; +} /** * @public */ -export type ModelPackageSortBy = (typeof ModelPackageSortBy)[keyof typeof ModelPackageSortBy]; +export interface ListHyperParameterTuningJobsRequest { + /** + *If the result of the previous ListHyperParameterTuningJobs request was
+ * truncated, the response includes a NextToken. To retrieve the next set of
+ * tuning jobs, use the token in the next request.
A filter that returns only model packages created after the specified time - * (timestamp).
+ *The + * maximum number of tuning jobs to return. The default value is + * 10.
* @public */ - CreationTimeAfter?: Date | undefined; + MaxResults?: number | undefined; /** - *A filter that returns only model packages created before the specified time - * (timestamp).
+ *The field to sort results by. The default is Name.
The maximum number of model packages to return in the response.
+ *The sort order for results. The default is Ascending.
A string in the model package name. This filter returns only model packages whose name + *
A string in the tuning job name. This filter returns only tuning jobs whose name * contains the specified string.
* @public */ NameContains?: string | undefined; /** - *A filter that returns only the model packages with the specified approval - * status.
+ *A filter that returns only tuning jobs that were created after the specified + * time.
* @public */ - ModelApprovalStatus?: ModelApprovalStatus | undefined; + CreationTimeAfter?: Date | undefined; /** - *A filter that returns only model versions that belong to the specified model group.
+ *A filter that returns only tuning jobs that were created before the specified + * time.
* @public */ - ModelPackageGroupName?: string | undefined; + CreationTimeBefore?: Date | undefined; /** - *A filter that returns only the model packages of the specified type. This can be one - * of the following values.
- *
- * UNVERSIONED - List only unversioined models.
- * This is the default value if no ModelPackageType is specified.
- * VERSIONED - List only versioned models.
- * BOTH - List both versioned and unversioned models.
A filter that returns only tuning jobs that were modified after the specified + * time.
* @public */ - ModelPackageType?: ModelPackageType | undefined; + LastModifiedTimeAfter?: Date | undefined; /** - *If the response to a previous ListModelPackages request was truncated,
- * the response includes a NextToken. To retrieve the next set of model
- * packages, use the token in the next request.
A filter that returns only tuning jobs that were modified before the specified + * time.
* @public */ - NextToken?: string | undefined; + LastModifiedTimeBefore?: Date | undefined; /** - *The parameter by which to sort the results. The default is
- * CreationTime.
A filter that returns only tuning jobs with the specified status.
* @public */ - SortBy?: ModelPackageSortBy | undefined; + StatusEquals?: HyperParameterTuningJobStatus | undefined; +} + +/** + * @public + */ +export interface ListHyperParameterTuningJobsResponse { + /** + *A list of HyperParameterTuningJobSummary objects that
+ * describe
+ * the tuning jobs that the ListHyperParameterTuningJobs
+ * request returned.
The sort order for the results. The default is Ascending.
If the result of this ListHyperParameterTuningJobs request was truncated,
+ * the response includes a NextToken. To retrieve the next set of tuning jobs,
+ * use the token in the next request.
Provides summary information about a model package.
* @public */ -export interface ModelPackageSummary { +export interface ListImagesRequest { /** - *The name of the model package.
+ *A filter that returns only images created on or after the specified time.
* @public */ - ModelPackageName?: string | undefined; + CreationTimeAfter?: Date | undefined; /** - *If the model package is a versioned model, the model group that the versioned model - * belongs to.
+ *A filter that returns only images created on or before the specified time.
* @public */ - ModelPackageGroupName?: string | undefined; + CreationTimeBefore?: Date | undefined; /** - *If the model package is a versioned model, the version of the model.
+ *A filter that returns only images modified on or after the specified time.
* @public */ - ModelPackageVersion?: number | undefined; + LastModifiedTimeAfter?: Date | undefined; /** - *The Amazon Resource Name (ARN) of the model package.
+ *A filter that returns only images modified on or before the specified time.
* @public */ - ModelPackageArn: string | undefined; + LastModifiedTimeBefore?: Date | undefined; /** - *A brief description of the model package.
+ *The maximum number of images to return in the response. The default value is 10.
* @public */ - ModelPackageDescription?: string | undefined; + MaxResults?: number | undefined; /** - *A timestamp that shows when the model package was created.
+ *A filter that returns only images whose name contains the specified string.
* @public */ - CreationTime: Date | undefined; + NameContains?: string | undefined; /** - *The overall status of the model package.
+ *If the previous call to ListImages didn't return the full set of images,
+ * the call returns a token for getting the next set of images.
The approval status of the model. This can be one of the following values.
- *
- * APPROVED - The model is approved
- * REJECTED - The model is rejected.
- * PENDING_MANUAL_APPROVAL - The model is waiting for manual
- * approval.
The property used to sort results. The default value is CREATION_TIME.
The sort order. The default value is DESCENDING.
An array of ModelPackageSummary objects, each of which lists a model
- * package.
A list of images and their properties.
* @public */ - ModelPackageSummaryList: ModelPackageSummary[] | undefined; + Images?: Image[] | undefined; /** - *If the response is truncated, SageMaker returns this token. To retrieve the next set of - * model packages, use it in the subsequent request.
+ *A token for getting the next set of images, if there are any.
* @public */ NextToken?: string | undefined; @@ -1421,105 +1366,90 @@ export interface ListModelPackagesOutput { /** * @public */ -export interface ListModelQualityJobDefinitionsRequest { +export interface ListImageVersionsRequest { /** - *A filter that returns only model quality monitoring job definitions that are associated - * with the specified endpoint.
+ *A filter that returns only versions created on or after the specified time.
* @public */ - EndpointName?: string | undefined; + CreationTimeAfter?: Date | undefined; /** - *The field to sort results by. The default is CreationTime.
A filter that returns only versions created on or before the specified time.
* @public */ - SortBy?: MonitoringJobDefinitionSortKey | undefined; + CreationTimeBefore?: Date | undefined; /** - *Whether to sort the results in Ascending or Descending order.
- * The default is Descending.
The name of the image to list the versions of.
* @public */ - SortOrder?: SortOrder | undefined; + ImageName: string | undefined; /** - *If the result of the previous ListModelQualityJobDefinitions request was
- * truncated, the response includes a NextToken. To retrieve the next set of
- * model quality monitoring job definitions, use the token in the next request.
A filter that returns only versions modified on or after the specified time.
* @public */ - NextToken?: string | undefined; + LastModifiedTimeAfter?: Date | undefined; /** - *The maximum number of results to return in a call to
- * ListModelQualityJobDefinitions.
A filter that returns only versions modified on or before the specified time.
+ * @public + */ + LastModifiedTimeBefore?: Date | undefined; + + /** + *The maximum number of versions to return in the response. The default value is 10.
* @public */ MaxResults?: number | undefined; /** - *A string in the transform job name. This filter returns only model quality monitoring - * job definitions whose name contains the specified string.
+ *If the previous call to ListImageVersions didn't return the full set of
+ * versions, the call returns a token for getting the next set of versions.
A filter that returns only model quality monitoring job definitions created before the - * specified time.
+ *The property used to sort results. The default value is CREATION_TIME.
A filter that returns only model quality monitoring job definitions created after the - * specified time.
+ *The sort order. The default value is DESCENDING.
A list of summaries of model quality monitoring job definitions.
+ *A list of versions and their properties.
* @public */ - JobDefinitionSummaries: MonitoringJobDefinitionSummary[] | undefined; + ImageVersions?: ImageVersion[] | undefined; /** - *If the response is truncated, Amazon SageMaker returns this token. To retrieve the - * next set of model quality monitoring job definitions, use it in the next request.
+ *A token for getting the next set of versions, if there are any.
* @public */ NextToken?: string | undefined; } -/** - * @public - * @enum - */ -export const ModelSortKey = { - CreationTime: "CreationTime", - Name: "Name", -} as const; - -/** - * @public - */ -export type ModelSortKey = (typeof ModelSortKey)[keyof typeof ModelSortKey]; - /** * @public */ -export interface ListModelsInput { +export interface ListInferenceComponentsInput { /** - *Sorts the list of results. The default is CreationTime.
The field by which to sort the inference components in the response. The default is
+ * CreationTime.
The sort order for results. The default is Descending.
If the response to a previous ListModels request was truncated, the
- * response includes a NextToken. To retrieve the next set of models, use the
- * token in the next request.
A token that you use to get the next set of results following a truncated response. If + * the response to the previous request was truncated, that response provides the value for + * this token.
* @public */ NextToken?: string | undefined; /** - *The maximum number of models to return in the response.
+ *The maximum number of inference components to return in the response. This value + * defaults to 10.
* @public */ MaxResults?: number | undefined; /** - *A string in the model name. This filter returns only models whose name contains the - * specified string.
+ *Filters the results to only those inference components with a name that contains the + * specified string.
* @public */ NameContains?: string | undefined; /** - *A filter that returns only models created before the specified time - * (timestamp).
+ *Filters the results to only those inference components that were created before the + * specified time.
* @public */ CreationTimeBefore?: Date | undefined; /** - *A filter that returns only models with a creation time greater than or equal to the - * specified time (timestamp).
+ *Filters the results to only those inference components that were created after the + * specified time.
* @public */ CreationTimeAfter?: Date | undefined; -} -/** - *Provides summary information about a model.
- * @public - */ -export interface ModelSummary { /** - *The name of the model that you want a summary for.
+ *Filters the results to only those inference components that were updated before the + * specified time.
* @public */ - ModelName: string | undefined; + LastModifiedTimeBefore?: Date | undefined; /** - *The Amazon Resource Name (ARN) of the model.
+ *Filters the results to only those inference components that were updated after the + * specified time.
* @public */ - ModelArn: string | undefined; + LastModifiedTimeAfter?: Date | undefined; /** - *A timestamp that indicates when the model was created.
+ *Filters the results to only those inference components with the specified status.
* @public */ - CreationTime: Date | undefined; + StatusEquals?: InferenceComponentStatus | undefined; + + /** + *An endpoint name to filter the listed inference components. The response includes only + * those inference components that are hosted at the specified endpoint.
+ * @public + */ + EndpointNameEquals?: string | undefined; + + /** + *A production variant name to filter the listed inference components. The response + * includes only those inference components that are hosted at the specified variant.
+ * @public + */ + VariantNameEquals?: string | undefined; } /** * @public */ -export interface ListModelsOutput { +export interface ListInferenceComponentsOutput { /** - *An array of ModelSummary objects, each of which lists a
- * model.
A list of inference components and their properties that matches any of the filters you + * specified in the request.
* @public */ - Models: ModelSummary[] | undefined; + InferenceComponents: InferenceComponentSummary[] | undefined; /** - *If the response is truncated, SageMaker returns this token. To retrieve the next set of - * models, use it in the subsequent request.
+ *The token to use in a subsequent request to get the next set of results following a + * truncated response.
* @public */ NextToken?: string | undefined; @@ -1610,259 +1551,272 @@ export interface ListModelsOutput { * @public * @enum */ -export const MonitoringAlertHistorySortKey = { - CreationTime: "CreationTime", - Status: "Status", +export const SortInferenceExperimentsBy = { + CREATION_TIME: "CreationTime", + NAME: "Name", + STATUS: "Status", } as const; /** * @public */ -export type MonitoringAlertHistorySortKey = - (typeof MonitoringAlertHistorySortKey)[keyof typeof MonitoringAlertHistorySortKey]; +export type SortInferenceExperimentsBy = (typeof SortInferenceExperimentsBy)[keyof typeof SortInferenceExperimentsBy]; /** * @public - * @enum */ -export const MonitoringAlertStatus = { - IN_ALERT: "InAlert", - OK: "OK", -} as const; +export interface ListInferenceExperimentsRequest { + /** + *Selects inference experiments whose names contain this name.
+ * @public + */ + NameContains?: string | undefined; -/** - * @public - */ -export type MonitoringAlertStatus = (typeof MonitoringAlertStatus)[keyof typeof MonitoringAlertStatus]; + /** + *+ * Selects inference experiments of this type. For the possible types of inference experiments, see CreateInferenceExperiment. + *
+ * @public + */ + Type?: InferenceExperimentType | undefined; -/** - * @public - */ -export interface ListMonitoringAlertHistoryRequest { /** - *The name of a monitoring schedule.
+ *+ * Selects inference experiments which are in this status. For the possible statuses, see DescribeInferenceExperiment. + *
* @public */ - MonitoringScheduleName?: string | undefined; + StatusEquals?: InferenceExperimentStatus | undefined; /** - *The name of a monitoring alert.
+ *Selects inference experiments which were created after this timestamp.
* @public */ - MonitoringAlertName?: string | undefined; + CreationTimeAfter?: Date | undefined; /** - *The field used to sort results. The default is CreationTime.
Selects inference experiments which were created before this timestamp.
* @public */ - SortBy?: MonitoringAlertHistorySortKey | undefined; + CreationTimeBefore?: Date | undefined; /** - *The sort order, whether Ascending or Descending, of the alert
- * history. The default is Descending.
Selects inference experiments which were last modified after this timestamp.
* @public */ - SortOrder?: SortOrder | undefined; + LastModifiedTimeAfter?: Date | undefined; /** - *If the result of the previous ListMonitoringAlertHistory request was
- * truncated, the response includes a NextToken. To retrieve the next set of
- * alerts in the history, use the token in the next request.
Selects inference experiments which were last modified before this timestamp.
* @public */ - NextToken?: string | undefined; + LastModifiedTimeBefore?: Date | undefined; /** - *The maximum number of results to display. The default is 100.
+ *The column by which to sort the listed inference experiments.
* @public */ - MaxResults?: number | undefined; + SortBy?: SortInferenceExperimentsBy | undefined; /** - *A filter that returns only alerts created on or before the specified time.
+ *The direction of sorting (ascending or descending).
* @public */ - CreationTimeBefore?: Date | undefined; + SortOrder?: SortOrder | undefined; /** - *A filter that returns only alerts created on or after the specified time.
+ *+ * The response from the last list when returning a list large enough to need tokening. + *
* @public */ - CreationTimeAfter?: Date | undefined; + NextToken?: string | undefined; /** - *A filter that retrieves only alerts with a specific status.
+ *The maximum number of results to select.
* @public */ - StatusEquals?: MonitoringAlertStatus | undefined; + MaxResults?: number | undefined; } /** - *Provides summary information of an alert's history.
* @public */ -export interface MonitoringAlertHistorySummary { +export interface ListInferenceExperimentsResponse { /** - *The name of a monitoring schedule.
+ *List of inference experiments.
* @public */ - MonitoringScheduleName: string | undefined; + InferenceExperiments?: InferenceExperimentSummary[] | undefined; /** - *The name of a monitoring alert.
+ *The token to use when calling the next page of results.
* @public */ - MonitoringAlertName: string | undefined; + NextToken?: string | undefined; +} - /** - *A timestamp that indicates when the first alert transition occurred in an alert history.
- * An alert transition can be from status InAlert to OK,
- * or from OK to InAlert.
A filter that returns only jobs created after the specified time (timestamp).
* @public */ - CreationTime: Date | undefined; + CreationTimeAfter?: Date | undefined; /** - *The current alert status of an alert.
+ *A filter that returns only jobs created before the specified time (timestamp).
* @public */ - AlertStatus: MonitoringAlertStatus | undefined; -} + CreationTimeBefore?: Date | undefined; -/** - * @public - */ -export interface ListMonitoringAlertHistoryResponse { /** - *An alert history for a model monitoring schedule.
+ *A filter that returns only jobs that were last modified after the specified time (timestamp).
* @public */ - MonitoringAlertHistory?: MonitoringAlertHistorySummary[] | undefined; + LastModifiedTimeAfter?: Date | undefined; /** - *If the response is truncated, SageMaker returns this token. To retrieve the next set of - * alerts, use it in the subsequent request.
+ *A filter that returns only jobs that were last modified before the specified time (timestamp).
* @public */ - NextToken?: string | undefined; -} + LastModifiedTimeBefore?: Date | undefined; -/** - * @public - */ -export interface ListMonitoringAlertsRequest { /** - *The name of a monitoring schedule.
+ *A string in the job name. This filter returns only recommendations whose name contains the specified string.
* @public */ - MonitoringScheduleName: string | undefined; + NameContains?: string | undefined; /** - *If the result of the previous ListMonitoringAlerts request was truncated,
- * the response includes a NextToken. To retrieve the next set of alerts in the
- * history, use the token in the next request.
A filter that retrieves only inference recommendations jobs with a specific status.
+ * @public + */ + StatusEquals?: RecommendationJobStatus | undefined; + + /** + *The parameter by which to sort the results.
+ * @public + */ + SortBy?: ListInferenceRecommendationsJobsSortBy | undefined; + + /** + *The sort order for the results.
+ * @public + */ + SortOrder?: SortOrder | undefined; + + /** + *If the response to a previous ListInferenceRecommendationsJobsRequest request
+ * was truncated, the response includes a NextToken. To retrieve the next set
+ * of recommendations, use the token in the next request.
The maximum number of results to display. The default is 100.
+ *The maximum number of recommendations to return in the response.
* @public */ MaxResults?: number | undefined; -} -/** - *An alert action taken to light up an icon on the Amazon SageMaker Model Dashboard when an alert goes into
- * InAlert status.
Indicates whether the alert action is turned on.
+ *A filter that returns only jobs that were created for this model.
* @public */ - Enabled?: boolean | undefined; -} + ModelNameEquals?: string | undefined; -/** - *A list of alert actions taken in response to an alert going into
- * InAlert status.
An alert action taken to light up an icon on the Model Dashboard when an alert goes into
- * InAlert status.
A filter that returns only jobs that were created for this versioned model package.
* @public */ - ModelDashboardIndicator?: ModelDashboardIndicatorAction | undefined; + ModelPackageVersionArnEquals?: string | undefined; } /** - *Provides summary information about a monitor alert.
* @public */ -export interface MonitoringAlertSummary { +export interface ListInferenceRecommendationsJobsResponse { /** - *The name of a monitoring alert.
+ *The recommendations created from the Amazon SageMaker Inference Recommender job.
* @public */ - MonitoringAlertName: string | undefined; + InferenceRecommendationsJobs: InferenceRecommendationsJob[] | undefined; /** - *A timestamp that indicates when a monitor alert was created.
+ *A token for getting the next set of recommendations, if there are any.
* @public */ - CreationTime: Date | undefined; + NextToken?: string | undefined; +} +/** + * @public + */ +export interface ListInferenceRecommendationsJobStepsRequest { /** - *A timestamp that indicates when a monitor alert was last updated.
+ *The name for the Inference Recommender job.
* @public */ - LastModifiedTime: Date | undefined; + JobName: string | undefined; /** - *The current status of an alert.
+ *A filter to return benchmarks of a specified status. If this field is left empty, then all benchmarks are returned.
* @public */ - AlertStatus: MonitoringAlertStatus | undefined; + Status?: RecommendationJobStatus | undefined; /** - *Within EvaluationPeriod, how many execution failures will raise an
- * alert.
A filter to return details about the specified type of subtask.
+ *
+ * BENCHMARK: Evaluate the performance of your model on different instance types.
The number of most recent monitoring executions to consider when evaluating alert - * status.
+ *The maximum number of results to return.
* @public */ - EvaluationPeriod: number | undefined; + MaxResults?: number | undefined; /** - *A list of alert actions taken in response to an alert going into
- * InAlert status.
A token that you can specify to return more results from the list. Specify this field if you have a token that was returned from a previous request.
* @public */ - Actions: MonitoringAlertActions | undefined; + NextToken?: string | undefined; } /** * @public */ -export interface ListMonitoringAlertsResponse { +export interface ListInferenceRecommendationsJobStepsResponse { /** - *A JSON array where each element is a summary for a monitoring alert.
+ *A list of all subtask details in Inference Recommender.
* @public */ - MonitoringAlertSummaries?: MonitoringAlertSummary[] | undefined; + Steps?: InferenceRecommendationsJobStep[] | undefined; /** - *If the response is truncated, SageMaker returns this token. To retrieve the next set of - * alerts, use it in the subsequent request.
+ *A token that you can specify in your next request to return more results from the list.
* @public */ NextToken?: string | undefined; @@ -1872,130 +1826,103 @@ export interface ListMonitoringAlertsResponse { * @public * @enum */ -export const MonitoringExecutionSortKey = { +export const SortBy = { CREATION_TIME: "CreationTime", - SCHEDULED_TIME: "ScheduledTime", + NAME: "Name", STATUS: "Status", } as const; /** * @public */ -export type MonitoringExecutionSortKey = (typeof MonitoringExecutionSortKey)[keyof typeof MonitoringExecutionSortKey]; +export type SortBy = (typeof SortBy)[keyof typeof SortBy]; /** * @public */ -export interface ListMonitoringExecutionsRequest { +export interface ListLabelingJobsRequest { /** - *Name of a specific schedule to fetch jobs for.
- * @public - */ - MonitoringScheduleName?: string | undefined; - - /** - *Name of a specific endpoint to fetch jobs for.
+ *A filter that returns only labeling jobs created after the specified time + * (timestamp).
* @public */ - EndpointName?: string | undefined; + CreationTimeAfter?: Date | undefined; /** - *Whether to sort the results by the Status, CreationTime, or
- * ScheduledTime field. The default is CreationTime.
A filter that returns only labeling jobs created before the specified time + * (timestamp).
* @public */ - SortBy?: MonitoringExecutionSortKey | undefined; + CreationTimeBefore?: Date | undefined; /** - *Whether to sort the results in Ascending or Descending order.
- * The default is Descending.
A filter that returns only labeling jobs modified after the specified time + * (timestamp).
* @public */ - SortOrder?: SortOrder | undefined; + LastModifiedTimeAfter?: Date | undefined; /** - *The token returned if the response is truncated. To retrieve the next set of job executions, use - * it in the next request.
+ *A filter that returns only labeling jobs modified before the specified time + * (timestamp).
* @public */ - NextToken?: string | undefined; + LastModifiedTimeBefore?: Date | undefined; /** - *The maximum number of jobs to return in the response. The default value is 10.
+ *The maximum number of labeling jobs to return in each page of the response.
* @public */ MaxResults?: number | undefined; /** - *Filter for jobs scheduled before a specified time.
- * @public - */ - ScheduledTimeBefore?: Date | undefined; - - /** - *Filter for jobs scheduled after a specified time.
- * @public - */ - ScheduledTimeAfter?: Date | undefined; - - /** - *A filter that returns only jobs created before a specified time.
- * @public - */ - CreationTimeBefore?: Date | undefined; - - /** - *A filter that returns only jobs created after a specified time.
- * @public - */ - CreationTimeAfter?: Date | undefined; - - /** - *A filter that returns only jobs modified after a specified time.
+ *If the result of the previous ListLabelingJobs request was truncated, the
+ * response includes a NextToken. To retrieve the next set of labeling jobs,
+ * use the token in the next request.
A filter that returns only jobs modified before a specified time.
+ *A string in the labeling job name. This filter returns only labeling jobs whose name + * contains the specified string.
* @public */ - LastModifiedTimeAfter?: Date | undefined; + NameContains?: string | undefined; /** - *A filter that retrieves only jobs with a specific status.
+ *The field to sort results by. The default is CreationTime.
Gets a list of the monitoring job runs of the specified monitoring job - * definitions.
+ *The sort order for results. The default is Ascending.
A filter that returns only the monitoring job runs of the specified monitoring - * type.
+ *A filter that retrieves only labeling jobs with a specific status.
* @public */ - MonitoringTypeEquals?: MonitoringType | undefined; + StatusEquals?: LabelingJobStatus | undefined; } /** * @public */ -export interface ListMonitoringExecutionsResponse { +export interface ListLabelingJobsResponse { /** - *A JSON array in which each element is a summary for a monitoring execution.
+ *An array of LabelingJobSummary objects, each describing a labeling
+ * job.
The token returned if the response is truncated. To retrieve the next set of job executions, use - * it in the next request.
+ *If the response is truncated, SageMaker returns this token. To retrieve the next set of + * labeling jobs, use it in the subsequent request.
* @public */ NextToken?: string | undefined; @@ -2005,172 +1932,165 @@ export interface ListMonitoringExecutionsResponse { * @public * @enum */ -export const MonitoringScheduleSortKey = { +export const ListLabelingJobsForWorkteamSortByOptions = { CREATION_TIME: "CreationTime", - NAME: "Name", - STATUS: "Status", } as const; /** * @public */ -export type MonitoringScheduleSortKey = (typeof MonitoringScheduleSortKey)[keyof typeof MonitoringScheduleSortKey]; +export type ListLabelingJobsForWorkteamSortByOptions = + (typeof ListLabelingJobsForWorkteamSortByOptions)[keyof typeof ListLabelingJobsForWorkteamSortByOptions]; /** * @public */ -export interface ListMonitoringSchedulesRequest { - /** - *Name of a specific endpoint to fetch schedules for.
- * @public - */ - EndpointName?: string | undefined; - +export interface ListLabelingJobsForWorkteamRequest { /** - *Whether to sort the results by the Status, CreationTime, or
- * ScheduledTime field. The default is CreationTime.
The Amazon Resource Name (ARN) of the work team for which you want to see labeling + * jobs for.
* @public */ - SortBy?: MonitoringScheduleSortKey | undefined; + WorkteamArn: string | undefined; /** - *Whether to sort the results in Ascending or Descending order.
- * The default is Descending.
The maximum number of labeling jobs to return in each page of the response.
* @public */ - SortOrder?: SortOrder | undefined; + MaxResults?: number | undefined; /** - *The token returned if the response is truncated. To retrieve the next set of job executions, use - * it in the next request.
+ *If the result of the previous ListLabelingJobsForWorkteam request was
+ * truncated, the response includes a NextToken. To retrieve the next set of
+ * labeling jobs, use the token in the next request.
The maximum number of jobs to return in the response. The default value is 10.
- * @public - */ - MaxResults?: number | undefined; - - /** - *Filter for monitoring schedules whose name contains a specified string.
+ *A filter that returns only labeling jobs created after the specified time + * (timestamp).
* @public */ - NameContains?: string | undefined; + CreationTimeAfter?: Date | undefined; /** - *A filter that returns only monitoring schedules created before a specified time.
+ *A filter that returns only labeling jobs created before the specified time + * (timestamp).
* @public */ CreationTimeBefore?: Date | undefined; /** - *A filter that returns only monitoring schedules created after a specified time.
+ *A filter the limits jobs to only the ones whose job reference code contains the + * specified string.
* @public */ - CreationTimeAfter?: Date | undefined; + JobReferenceCodeContains?: string | undefined; /** - *A filter that returns only monitoring schedules modified before a specified time.
+ *The field to sort results by. The default is CreationTime.
A filter that returns only monitoring schedules modified after a specified time.
+ *The sort order for results. The default is Ascending.
A filter that returns only monitoring schedules modified before a specified time.
+ *An array of LabelingJobSummary objects, each describing a labeling
+ * job.
Gets a list of the monitoring schedules for the specified monitoring job - * definition.
+ *If the response is truncated, SageMaker returns this token. To retrieve the next set of + * labeling jobs, use it in the subsequent request.
* @public */ - MonitoringJobDefinitionName?: string | undefined; - - /** - *A filter that returns only the monitoring schedules for the specified monitoring - * type.
- * @public - */ - MonitoringTypeEquals?: MonitoringType | undefined; -} + NextToken?: string | undefined; +} /** - *Summarizes the monitoring schedule.
* @public + * @enum */ -export interface MonitoringScheduleSummary { - /** - *The name of the monitoring schedule.
- * @public - */ - MonitoringScheduleName: string | undefined; +export const SortLineageGroupsBy = { + CREATION_TIME: "CreationTime", + NAME: "Name", +} as const; - /** - *The Amazon Resource Name (ARN) of the monitoring schedule.
- * @public - */ - MonitoringScheduleArn: string | undefined; +/** + * @public + */ +export type SortLineageGroupsBy = (typeof SortLineageGroupsBy)[keyof typeof SortLineageGroupsBy]; +/** + * @public + */ +export interface ListLineageGroupsRequest { /** - *The creation time of the monitoring schedule.
+ *A timestamp to filter against lineage groups created after a certain point in time.
* @public */ - CreationTime: Date | undefined; + CreatedAfter?: Date | undefined; /** - *The last time the monitoring schedule was modified.
+ *A timestamp to filter against lineage groups created before a certain point in time.
* @public */ - LastModifiedTime: Date | undefined; + CreatedBefore?: Date | undefined; /** - *The status of the monitoring schedule.
+ *The parameter by which to sort the results. The default is
+ * CreationTime.
The name of the endpoint using the monitoring schedule.
+ *The sort order for the results. The default is Ascending.
The name of the monitoring job definition that the schedule is for.
+ *If the response is truncated, SageMaker returns this token. To retrieve the next set of + * algorithms, use it in the subsequent request.
* @public */ - MonitoringJobDefinitionName?: string | undefined; + NextToken?: string | undefined; /** - *The type of the monitoring job definition that the schedule is for.
+ *The maximum number of endpoints to return in the response. This value defaults to + * 10.
* @public */ - MonitoringType?: MonitoringType | undefined; + MaxResults?: number | undefined; } /** * @public */ -export interface ListMonitoringSchedulesResponse { +export interface ListLineageGroupsResponse { /** - *A JSON array in which each element is a summary for a monitoring schedule.
+ *A list of lineage groups and their properties.
* @public */ - MonitoringScheduleSummaries: MonitoringScheduleSummary[] | undefined; + LineageGroupSummaries?: LineageGroupSummary[] | undefined; /** - *The token returned if the response is truncated. To retrieve the next set of job executions, use - * it in the next request.
+ *If the response is truncated, SageMaker returns this token. To retrieve the next set of + * algorithms, use it in the subsequent request.
* @public */ NextToken?: string | undefined; @@ -2180,551 +2100,531 @@ export interface ListMonitoringSchedulesResponse { * @public * @enum */ -export const NotebookInstanceLifecycleConfigSortKey = { +export const SortTrackingServerBy = { CREATION_TIME: "CreationTime", - LAST_MODIFIED_TIME: "LastModifiedTime", NAME: "Name", + STATUS: "Status", } as const; /** * @public */ -export type NotebookInstanceLifecycleConfigSortKey = - (typeof NotebookInstanceLifecycleConfigSortKey)[keyof typeof NotebookInstanceLifecycleConfigSortKey]; - -/** - * @public - * @enum - */ -export const NotebookInstanceLifecycleConfigSortOrder = { - ASCENDING: "Ascending", - DESCENDING: "Descending", -} as const; - -/** - * @public - */ -export type NotebookInstanceLifecycleConfigSortOrder = - (typeof NotebookInstanceLifecycleConfigSortOrder)[keyof typeof NotebookInstanceLifecycleConfigSortOrder]; +export type SortTrackingServerBy = (typeof SortTrackingServerBy)[keyof typeof SortTrackingServerBy]; /** * @public */ -export interface ListNotebookInstanceLifecycleConfigsInput { - /** - *If the result of a ListNotebookInstanceLifecycleConfigs request was
- * truncated, the response includes a NextToken. To get the next set of
- * lifecycle configurations, use the token in the next request.
The maximum number of lifecycle configurations to return in the response.
+ *Use the CreatedAfter filter to only list tracking servers created after a
+ * specific date and time. Listed tracking servers are shown with a date and time such as
+ * "2024-03-16T01:46:56+00:00". The CreatedAfter parameter takes in a
+ * Unix timestamp. To convert a date and time into a Unix timestamp, see EpochConverter.
Sorts the list of results. The default is CreationTime.
Use the CreatedBefore filter to only list tracking servers created before a
+ * specific date and time. Listed tracking servers are shown with a date and time such as
+ * "2024-03-16T01:46:56+00:00". The CreatedBefore parameter takes in
+ * a Unix timestamp. To convert a date and time into a Unix timestamp, see EpochConverter.
The sort order for results.
+ *Filter for tracking servers with a specified creation status.
* @public */ - SortOrder?: NotebookInstanceLifecycleConfigSortOrder | undefined; + TrackingServerStatus?: TrackingServerStatus | undefined; /** - *A string in the lifecycle configuration name. This filter returns only lifecycle - * configurations whose name contains the specified string.
+ *Filter for tracking servers using the specified MLflow version.
* @public */ - NameContains?: string | undefined; + MlflowVersion?: string | undefined; /** - *A filter that returns only lifecycle configurations that were created before the - * specified time (timestamp).
+ *Filter for trackings servers sorting by name, creation time, or creation status.
* @public */ - CreationTimeBefore?: Date | undefined; + SortBy?: SortTrackingServerBy | undefined; /** - *A filter that returns only lifecycle configurations that were created after the - * specified time (timestamp).
+ *Change the order of the listed tracking servers. By default, tracking servers are listed in Descending order by creation time.
+ * To change the list order, you can specify SortOrder to be Ascending.
A filter that returns only lifecycle configurations that were modified before the - * specified time (timestamp).
+ *If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.
* @public */ - LastModifiedTimeBefore?: Date | undefined; + NextToken?: string | undefined; /** - *A filter that returns only lifecycle configurations that were modified after the - * specified time (timestamp).
+ *The maximum number of tracking servers to list.
* @public */ - LastModifiedTimeAfter?: Date | undefined; + MaxResults?: number | undefined; } /** - *Provides a summary of a notebook instance lifecycle configuration.
+ *The summary of the tracking server to list.
* @public */ -export interface NotebookInstanceLifecycleConfigSummary { +export interface TrackingServerSummary { /** - *The name of the lifecycle configuration.
+ *The ARN of a listed tracking server.
* @public */ - NotebookInstanceLifecycleConfigName: string | undefined; + TrackingServerArn?: string | undefined; /** - *The Amazon Resource Name (ARN) of the lifecycle configuration.
+ *The name of a listed tracking server.
* @public */ - NotebookInstanceLifecycleConfigArn: string | undefined; + TrackingServerName?: string | undefined; /** - *A timestamp that tells when the lifecycle configuration was created.
+ *The creation time of a listed tracking server.
* @public */ CreationTime?: Date | undefined; /** - *A timestamp that tells when the lifecycle configuration was last modified.
+ *The last modified time of a listed tracking server.
* @public */ LastModifiedTime?: Date | undefined; -} -/** - * @public - */ -export interface ListNotebookInstanceLifecycleConfigsOutput { /** - *If the response is truncated, SageMaker returns this token. To get the next - * set of lifecycle configurations, use it in the next request.
+ *The creation status of a listed tracking server.
* @public */ - NextToken?: string | undefined; + TrackingServerStatus?: TrackingServerStatus | undefined; /** - *An array of NotebookInstanceLifecycleConfiguration objects, each listing
- * a lifecycle configuration.
The activity status of a listed tracking server.
* @public */ - NotebookInstanceLifecycleConfigs?: NotebookInstanceLifecycleConfigSummary[] | undefined; -} + IsActive?: IsTrackingServerActive | undefined; -/** - * @public - * @enum - */ -export const NotebookInstanceSortKey = { - CREATION_TIME: "CreationTime", - NAME: "Name", - STATUS: "Status", -} as const; + /** + *The MLflow version used for a listed tracking server.
+ * @public + */ + MlflowVersion?: string | undefined; +} /** * @public */ -export type NotebookInstanceSortKey = (typeof NotebookInstanceSortKey)[keyof typeof NotebookInstanceSortKey]; +export interface ListMlflowTrackingServersResponse { + /** + *A list of tracking servers according to chosen filters.
+ * @public + */ + TrackingServerSummaries?: TrackingServerSummary[] | undefined; -/** - * @public - * @enum - */ -export const NotebookInstanceSortOrder = { - ASCENDING: "Ascending", - DESCENDING: "Descending", -} as const; + /** + *If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.
+ * @public + */ + NextToken?: string | undefined; +} /** * @public */ -export type NotebookInstanceSortOrder = (typeof NotebookInstanceSortOrder)[keyof typeof NotebookInstanceSortOrder]; +export interface ListModelBiasJobDefinitionsRequest { + /** + *Name of the endpoint to monitor for model bias.
+ * @public + */ + EndpointName?: string | undefined; -/** - * @public - */ -export interface ListNotebookInstancesInput { /** - * If the previous call to the ListNotebookInstances is truncated, the
- * response includes a NextToken. You can use this token in your subsequent
- * ListNotebookInstances request to fetch the next set of notebook
- * instances.
You might specify a filter or a sort order in your request. When response is - * truncated, you must use the same values for the filer and sort order in the next - * request.
- *Whether to sort results by the Name or CreationTime field.
+ * The default is CreationTime.
The maximum number of notebook instances to return.
+ *Whether to sort the results in Ascending or Descending order.
+ * The default is Descending.
The field to sort results by. The default is Name.
The token returned if the response is truncated. To retrieve the next set of job executions, use + * it in the next request.
* @public */ - SortBy?: NotebookInstanceSortKey | undefined; + NextToken?: string | undefined; /** - *The sort order for results.
+ *The maximum number of model bias jobs to return in the response. The default value is + * 10.
* @public */ - SortOrder?: NotebookInstanceSortOrder | undefined; + MaxResults?: number | undefined; /** - *A string in the notebook instances' name. This filter returns only notebook - * instances whose name contains the specified string.
+ *Filter for model bias jobs whose name contains a specified string.
* @public */ NameContains?: string | undefined; /** - *A filter that returns only notebook instances that were created before the - * specified time (timestamp).
+ *A filter that returns only model bias jobs created before a specified time.
* @public */ CreationTimeBefore?: Date | undefined; /** - *A filter that returns only notebook instances that were created after the specified - * time (timestamp).
+ *A filter that returns only model bias jobs created after a specified time.
* @public */ CreationTimeAfter?: Date | undefined; +} - /** - *A filter that returns only notebook instances that were modified before the - * specified time (timestamp).
+/** + * @public + */ +export interface ListModelBiasJobDefinitionsResponse { + /** + *A JSON array in which each element is a summary for a model bias jobs.
* @public */ - LastModifiedTimeBefore?: Date | undefined; + JobDefinitionSummaries: MonitoringJobDefinitionSummary[] | undefined; /** - *A filter that returns only notebook instances that were modified after the - * specified time (timestamp).
+ *The token returned if the response is truncated. To retrieve the next set of job executions, use + * it in the next request.
* @public */ - LastModifiedTimeAfter?: Date | undefined; + NextToken?: string | undefined; +} + +/** + * @public + * @enum + */ +export const ModelCardExportJobSortBy = { + CREATION_TIME: "CreationTime", + NAME: "Name", + STATUS: "Status", +} as const; + +/** + * @public + */ +export type ModelCardExportJobSortBy = (typeof ModelCardExportJobSortBy)[keyof typeof ModelCardExportJobSortBy]; + +/** + * @public + * @enum + */ +export const ModelCardExportJobSortOrder = { + ASCENDING: "Ascending", + DESCENDING: "Descending", +} as const; +/** + * @public + */ +export type ModelCardExportJobSortOrder = + (typeof ModelCardExportJobSortOrder)[keyof typeof ModelCardExportJobSortOrder]; + +/** + * @public + */ +export interface ListModelCardExportJobsRequest { /** - *A filter that returns only notebook instances with the specified status.
+ *List export jobs for the model card with the specified name.
* @public */ - StatusEquals?: NotebookInstanceStatus | undefined; + ModelCardName: string | undefined; /** - *A string in the name of a notebook instances lifecycle configuration associated with - * this notebook instance. This filter returns only notebook instances associated with a - * lifecycle configuration with a name that contains the specified string.
+ *List export jobs for the model card with the specified version.
* @public */ - NotebookInstanceLifecycleConfigNameContains?: string | undefined; + ModelCardVersion?: number | undefined; /** - *A string in the name or URL of a Git repository associated with this notebook - * instance. This filter returns only notebook instances associated with a git repository - * with a name that contains the specified string.
+ *Only list model card export jobs that were created after the time specified.
* @public */ - DefaultCodeRepositoryContains?: string | undefined; + CreationTimeAfter?: Date | undefined; /** - *A filter that returns only notebook instances with associated with the specified git - * repository.
+ *Only list model card export jobs that were created before the time specified.
* @public */ - AdditionalCodeRepositoryEquals?: string | undefined; -} + CreationTimeBefore?: Date | undefined; -/** - *Provides summary information for an SageMaker notebook instance.
- * @public - */ -export interface NotebookInstanceSummary { /** - *The name of the notebook instance that you want a summary for.
+ *Only list model card export jobs with names that contain the specified string.
* @public */ - NotebookInstanceName: string | undefined; + ModelCardExportJobNameContains?: string | undefined; /** - *The Amazon Resource Name (ARN) of the notebook instance.
+ *Only list model card export jobs with the specified status.
* @public */ - NotebookInstanceArn: string | undefined; + StatusEquals?: ModelCardExportJobStatus | undefined; /** - *The status of the notebook instance.
+ *Sort model card export jobs by either name or creation time. Sorts by creation time by default.
* @public */ - NotebookInstanceStatus?: NotebookInstanceStatus | undefined; + SortBy?: ModelCardExportJobSortBy | undefined; /** - *The URL that you use to connect to the Jupyter notebook running in your notebook - * instance.
+ *Sort model card export jobs by ascending or descending order.
* @public */ - Url?: string | undefined; + SortOrder?: ModelCardExportJobSortOrder | undefined; /** - *The type of ML compute instance that the notebook instance is running on.
+ *If the response to a previous ListModelCardExportJobs request was
+ * truncated, the response includes a NextToken. To retrieve the next set of
+ * model card export jobs, use the token in the next request.
A timestamp that shows when the notebook instance was created.
+ *The maximum number of model card export jobs to list.
* @public */ - CreationTime?: Date | undefined; + MaxResults?: number | undefined; +} +/** + *The summary of the Amazon SageMaker Model Card export job.
+ * @public + */ +export interface ModelCardExportJobSummary { /** - *A timestamp that shows when the notebook instance was last modified.
+ *The name of the model card export job.
* @public */ - LastModifiedTime?: Date | undefined; + ModelCardExportJobName: string | undefined; /** - *The name of a notebook instance lifecycle configuration associated with this notebook - * instance.
- *For information about notebook instance lifestyle configurations, see Step - * 2.1: (Optional) Customize a Notebook Instance.
+ *The Amazon Resource Name (ARN) of the model card export job.
* @public */ - NotebookInstanceLifecycleConfigName?: string | undefined; + ModelCardExportJobArn: string | undefined; /** - *The Git repository associated with the notebook instance as its default code - * repository. This can be either the name of a Git repository stored as a resource in your - * account, or the URL of a Git repository in Amazon Web Services CodeCommit - * or in any other Git repository. When you open a notebook instance, it opens in the - * directory that contains this repository. For more information, see Associating Git - * Repositories with SageMaker Notebook Instances.
+ *The completion status of the model card export job.
* @public */ - DefaultCodeRepository?: string | undefined; + Status: ModelCardExportJobStatus | undefined; /** - *An array of up to three Git repositories associated with the notebook instance. These - * can be either the names of Git repositories stored as resources in your account, or the - * URL of Git repositories in Amazon Web Services CodeCommit - * or in any other Git repository. These repositories are cloned at the same level as the - * default repository of your notebook instance. For more information, see Associating Git - * Repositories with SageMaker Notebook Instances.
+ *The name of the model card that the export job exports.
* @public */ - AdditionalCodeRepositories?: string[] | undefined; + ModelCardName: string | undefined; + + /** + *The version of the model card that the export job exports.
+ * @public + */ + ModelCardVersion: number | undefined; + + /** + *The date and time that the model card export job was created.
+ * @public + */ + CreatedAt: Date | undefined; + + /** + *The date and time that the model card export job was last modified..
+ * @public + */ + LastModifiedAt: Date | undefined; } /** * @public */ -export interface ListNotebookInstancesOutput { +export interface ListModelCardExportJobsResponse { /** - *If the response to the previous ListNotebookInstances request was
- * truncated, SageMaker returns this token. To retrieve the next set of notebook
- * instances, use the token in the next request.
The summaries of the listed model card export jobs.
* @public */ - NextToken?: string | undefined; + ModelCardExportJobSummaries: ModelCardExportJobSummary[] | undefined; /** - *An array of NotebookInstanceSummary objects, one for each notebook
- * instance.
If the response is truncated, SageMaker returns this token. To retrieve the next set of model + * card export jobs, use it in the subsequent request.
* @public */ - NotebookInstances?: NotebookInstanceSummary[] | undefined; + NextToken?: string | undefined; } /** * @public * @enum */ -export const ListOptimizationJobsSortBy = { +export const ModelCardSortBy = { CREATION_TIME: "CreationTime", NAME: "Name", - STATUS: "Status", } as const; /** * @public */ -export type ListOptimizationJobsSortBy = (typeof ListOptimizationJobsSortBy)[keyof typeof ListOptimizationJobsSortBy]; +export type ModelCardSortBy = (typeof ModelCardSortBy)[keyof typeof ModelCardSortBy]; /** * @public + * @enum */ -export interface ListOptimizationJobsRequest { - /** - *A token that you use to get the next set of results following a truncated response. If - * the response to the previous request was truncated, that response provides the value for - * this token.
- * @public - */ - NextToken?: string | undefined; +export const ModelCardSortOrder = { + ASCENDING: "Ascending", + DESCENDING: "Descending", +} as const; - /** - *The maximum number of optimization jobs to return in the response. The default is - * 50.
- * @public - */ - MaxResults?: number | undefined; +/** + * @public + */ +export type ModelCardSortOrder = (typeof ModelCardSortOrder)[keyof typeof ModelCardSortOrder]; +/** + * @public + */ +export interface ListModelCardsRequest { /** - *Filters the results to only those optimization jobs that were created after the - * specified time.
+ *Only list model cards that were created after the time specified.
* @public */ CreationTimeAfter?: Date | undefined; /** - *Filters the results to only those optimization jobs that were created before the - * specified time.
+ *Only list model cards that were created before the time specified.
* @public */ CreationTimeBefore?: Date | undefined; /** - *Filters the results to only those optimization jobs that were updated after the - * specified time.
- * @public - */ - LastModifiedTimeAfter?: Date | undefined; - - /** - *Filters the results to only those optimization jobs that were updated before the - * specified time.
+ *The maximum number of model cards to list.
* @public */ - LastModifiedTimeBefore?: Date | undefined; + MaxResults?: number | undefined; /** - *Filters the results to only those optimization jobs that apply the specified
- * optimization techniques. You can specify either Quantization or
- * Compilation.
Only list model cards with names that contain the specified string.
* @public */ - OptimizationContains?: string | undefined; + NameContains?: string | undefined; /** - *Filters the results to only those optimization jobs with a name that contains the - * specified string.
+ *Only list model cards with the specified approval status.
* @public */ - NameContains?: string | undefined; + ModelCardStatus?: ModelCardStatus | undefined; /** - *Filters the results to only those optimization jobs with the specified status.
+ *If the response to a previous ListModelCards request was truncated, the
+ * response includes a NextToken. To retrieve the next set of model cards, use
+ * the token in the next request.
The field by which to sort the optimization jobs in the response. The default is
- * CreationTime
- *
Sort model cards by either name or creation time. Sorts by creation time by default.
* @public */ - SortBy?: ListOptimizationJobsSortBy | undefined; + SortBy?: ModelCardSortBy | undefined; /** - *The sort order for results. The default is Ascending
- *
Sort model cards by ascending or descending order.
* @public */ - SortOrder?: SortOrder | undefined; + SortOrder?: ModelCardSortOrder | undefined; } /** - *Summarizes an optimization job by providing some of its key properties.
+ *A summary of the model card.
* @public */ -export interface OptimizationJobSummary { +export interface ModelCardSummary { /** - *The name that you assigned to the optimization job.
+ *The name of the model card.
* @public */ - OptimizationJobName: string | undefined; - - /** - *The Amazon Resource Name (ARN) of the optimization job.
- * @public - */ - OptimizationJobArn: string | undefined; - - /** - *The time when you created the optimization job.
- * @public - */ - CreationTime: Date | undefined; + ModelCardName: string | undefined; /** - *The current status of the optimization job.
+ *The Amazon Resource Name (ARN) of the model card.
* @public */ - OptimizationJobStatus: OptimizationJobStatus | undefined; + ModelCardArn: string | undefined; /** - *The time when the optimization job started.
+ *The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.
+ *
+ * Draft: The model card is a work in progress.
+ * PendingReview: The model card is pending review.
+ * Approved: The model card is approved.
+ * Archived: The model card is archived. No more updates should be made to the model
+ * card, but it can still be exported.
The time when the optimization job finished processing.
+ *The date and time that the model card was created.
* @public */ - OptimizationEndTime?: Date | undefined; + CreationTime: Date | undefined; /** - *The time when the optimization job was last updated.
+ *The date and time that the model card was last modified.
* @public */ LastModifiedTime?: Date | undefined; - - /** - *The type of instance that hosts the optimized model that you create with the optimization job.
- * @public - */ - DeploymentInstanceType: OptimizationJobDeploymentInstanceType | undefined; - - /** - *The optimization techniques that are applied by the optimization job.
- * @public - */ - OptimizationTypes: string[] | undefined; } /** * @public */ -export interface ListOptimizationJobsResponse { +export interface ListModelCardsResponse { /** - *A list of optimization jobs and their properties that matches any of the filters you - * specified in the request.
+ *The summaries of the listed model cards.
* @public */ - OptimizationJobSummaries: OptimizationJobSummary[] | undefined; + ModelCardSummaries: ModelCardSummary[] | undefined; /** - *The token to use in a subsequent request to get the next set of results following a - * truncated response.
+ *If the response is truncated, SageMaker returns this token. To retrieve the next set of model + * cards, use it in the subsequent request.
* @public */ NextToken?: string | undefined; @@ -2734,123 +2634,144 @@ export interface ListOptimizationJobsResponse { * @public * @enum */ -export const SortPipelineExecutionsBy = { - CREATION_TIME: "CreationTime", - PIPELINE_EXECUTION_ARN: "PipelineExecutionArn", +export const ModelCardVersionSortBy = { + VERSION: "Version", } as const; /** * @public */ -export type SortPipelineExecutionsBy = (typeof SortPipelineExecutionsBy)[keyof typeof SortPipelineExecutionsBy]; +export type ModelCardVersionSortBy = (typeof ModelCardVersionSortBy)[keyof typeof ModelCardVersionSortBy]; /** * @public */ -export interface ListPipelineExecutionsRequest { +export interface ListModelCardVersionsRequest { /** - *The name or Amazon Resource Name (ARN) of the pipeline.
+ *Only list model card versions that were created after the time specified.
* @public */ - PipelineName: string | undefined; + CreationTimeAfter?: Date | undefined; /** - *A filter that returns the pipeline executions that were created after a specified - * time.
+ *Only list model card versions that were created before the time specified.
* @public */ - CreatedAfter?: Date | undefined; + CreationTimeBefore?: Date | undefined; /** - *A filter that returns the pipeline executions that were created before a specified - * time.
+ *The maximum number of model card versions to list.
* @public */ - CreatedBefore?: Date | undefined; + MaxResults?: number | undefined; /** - *The field by which to sort results. The default is CreatedTime.
List model card versions for the model card with the specified name or Amazon Resource Name (ARN).
* @public */ - SortBy?: SortPipelineExecutionsBy | undefined; + ModelCardName: string | undefined; /** - *The sort order for results.
+ *Only list model card versions with the specified approval status.
* @public */ - SortOrder?: SortOrder | undefined; + ModelCardStatus?: ModelCardStatus | undefined; /** - *If the result of the previous ListPipelineExecutions request was truncated,
- * the response includes a NextToken. To retrieve the next set of pipeline executions, use the token in the next request.
If the response to a previous ListModelCardVersions request was truncated,
+ * the response includes a NextToken. To retrieve the next set of model card
+ * versions, use the token in the next request.
The maximum number of pipeline executions to return in the response.
+ *Sort listed model card versions by version. Sorts by version by default.
* @public */ - MaxResults?: number | undefined; + SortBy?: ModelCardVersionSortBy | undefined; + + /** + *Sort model card versions by ascending or descending order.
+ * @public + */ + SortOrder?: ModelCardSortOrder | undefined; } /** - *A pipeline execution summary.
+ *A summary of a specific version of the model card.
* @public */ -export interface PipelineExecutionSummary { +export interface ModelCardVersionSummary { /** - *The Amazon Resource Name (ARN) of the pipeline execution.
+ *The name of the model card.
* @public */ - PipelineExecutionArn?: string | undefined; + ModelCardName: string | undefined; /** - *The start time of the pipeline execution.
+ *The Amazon Resource Name (ARN) of the model card.
* @public */ - StartTime?: Date | undefined; + ModelCardArn: string | undefined; /** - *The status of the pipeline execution.
+ *The approval status of the model card version within your organization. Different organizations might have different criteria for model card review and approval.
+ *
+ * Draft: The model card is a work in progress.
+ * PendingReview: The model card is pending review.
+ * Approved: The model card is approved.
+ * Archived: The model card is archived. No more updates should be made to the model
+ * card, but it can still be exported.
The description of the pipeline execution.
+ *A version of the model card.
* @public */ - PipelineExecutionDescription?: string | undefined; + ModelCardVersion: number | undefined; /** - *The display name of the pipeline execution.
+ *The date and time that the model card version was created.
* @public */ - PipelineExecutionDisplayName?: string | undefined; + CreationTime: Date | undefined; /** - *A message generated by SageMaker Pipelines describing why the pipeline execution failed.
+ *The time date and time that the model card version was last modified.
* @public */ - PipelineExecutionFailureReason?: string | undefined; + LastModifiedTime?: Date | undefined; } /** * @public */ -export interface ListPipelineExecutionsResponse { +export interface ListModelCardVersionsResponse { /** - *Contains a sorted list of pipeline execution summary objects matching the specified - * filters. Each run summary includes the Amazon Resource Name (ARN) of the pipeline execution, the run date, - * and the status. This list can be empty.
+ *The summaries of the listed versions of the model card.
* @public */ - PipelineExecutionSummaries?: PipelineExecutionSummary[] | undefined; + ModelCardVersionSummaryList: ModelCardVersionSummary[] | undefined; /** - *If the result of the previous ListPipelineExecutions request was truncated,
- * the response includes a NextToken. To retrieve the next set of pipeline executions, use the token in the next request.
If the response is truncated, SageMaker returns this token. To retrieve the next set of model + * card versions, use it in the subsequent request.
* @public */ NextToken?: string | undefined; @@ -2859,528 +2780,357 @@ export interface ListPipelineExecutionsResponse { /** * @public */ -export interface ListPipelineExecutionStepsRequest { - /** - *The Amazon Resource Name (ARN) of the pipeline execution.
- * @public - */ - PipelineExecutionArn?: string | undefined; - +export interface ListModelExplainabilityJobDefinitionsRequest { /** - *If the result of the previous ListPipelineExecutionSteps request was truncated,
- * the response includes a NextToken. To retrieve the next set of pipeline execution steps, use the token in the next request.
Name of the endpoint to monitor for model explainability.
* @public */ - NextToken?: string | undefined; + EndpointName?: string | undefined; /** - *The maximum number of pipeline execution steps to return in the response.
+ *Whether to sort results by the Name or CreationTime field.
+ * The default is CreationTime.
The field by which to sort results. The default is CreatedTime.
Whether to sort the results in Ascending or Descending order.
+ * The default is Descending.
Metadata for Model steps.
- * @public - */ -export interface ModelStepMetadata { /** - *The Amazon Resource Name (ARN) of the created model.
+ *The token returned if the response is truncated. To retrieve the next set of job executions, use + * it in the next request.
* @public */ - Arn?: string | undefined; -} + NextToken?: string | undefined; -/** - *Metadata for a processing job step.
- * @public - */ -export interface ProcessingJobStepMetadata { /** - *The Amazon Resource Name (ARN) of the processing job.
+ *The maximum number of jobs to return in the response. The default value is 10.
* @public */ - Arn?: string | undefined; -} + MaxResults?: number | undefined; -/** - *Container for the metadata for a Quality check step. For more information, see - * the topic on QualityCheck step in the Amazon SageMaker Developer Guide. - *
- * @public - */ -export interface QualityCheckStepMetadata { /** - *The type of the Quality check step.
+ *Filter for model explainability jobs whose name contains a specified string.
* @public */ - CheckType?: string | undefined; + NameContains?: string | undefined; /** - *The Amazon S3 URI of the baseline statistics file used for the drift check.
+ *A filter that returns only model explainability jobs created before a specified + * time.
* @public */ - BaselineUsedForDriftCheckStatistics?: string | undefined; + CreationTimeBefore?: Date | undefined; /** - *The Amazon S3 URI of the baseline constraints file used for the drift check.
+ *A filter that returns only model explainability jobs created after a specified + * time.
* @public */ - BaselineUsedForDriftCheckConstraints?: string | undefined; + CreationTimeAfter?: Date | undefined; +} +/** + * @public + */ +export interface ListModelExplainabilityJobDefinitionsResponse { /** - *The Amazon S3 URI of the newly calculated baseline statistics file.
+ *A JSON array in which each element is a summary for a explainability bias jobs.
* @public */ - CalculatedBaselineStatistics?: string | undefined; + JobDefinitionSummaries: MonitoringJobDefinitionSummary[] | undefined; /** - *The Amazon S3 URI of the newly calculated baseline constraints file.
+ *The token returned if the response is truncated. To retrieve the next set of job executions, use + * it in the next request.
* @public */ - CalculatedBaselineConstraints?: string | undefined; + NextToken?: string | undefined; +} - /** - *The model package group name.
- * @public - */ - ModelPackageGroupName?: string | undefined; - - /** - *The Amazon S3 URI of violation report if violations are detected.
- * @public - */ - ViolationReport?: string | undefined; +/** + * @public + * @enum + */ +export const ModelMetadataFilterType = { + DOMAIN: "Domain", + FRAMEWORK: "Framework", + FRAMEWORKVERSION: "FrameworkVersion", + TASK: "Task", +} as const; - /** - *The Amazon Resource Name (ARN) of the Quality check processing job that was run by this step execution.
- * @public - */ - CheckJobArn?: string | undefined; +/** + * @public + */ +export type ModelMetadataFilterType = (typeof ModelMetadataFilterType)[keyof typeof ModelMetadataFilterType]; +/** + *Part of the search expression. You can specify the name and value + * (domain, task, framework, framework version, task, and model).
+ * @public + */ +export interface ModelMetadataFilter { /** - *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.
The name of the of the model to filter by.
* @public */ - SkipCheck?: boolean | undefined; + Name: ModelMetadataFilterType | undefined; /** - *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 and
- * BaselineUsedForDriftCheckStatistics properties.
The value to filter the model metadata.
* @public */ - RegisterNewBaseline?: boolean | undefined; + Value: string | undefined; } /** - *Metadata for a register model job step.
+ *One or more filters that searches for the specified resource or resources in + * a search. All resource objects that satisfy the expression's condition are + * included in the search results
* @public */ -export interface RegisterModelStepMetadata { +export interface ModelMetadataSearchExpression { /** - *The Amazon Resource Name (ARN) of the model package.
+ *A list of filter objects.
* @public */ - Arn?: string | undefined; + Filters?: ModelMetadataFilter[] | undefined; } /** - *Metadata for a training job step.
* @public */ -export interface TrainingJobStepMetadata { +export interface ListModelMetadataRequest { /** - *The Amazon Resource Name (ARN) of the training job that was run by this step execution.
+ *One or more filters that searches for the specified resource or resources + * in a search. All resource objects that satisfy the expression's condition are + * included in the search results. Specify the Framework, FrameworkVersion, Domain + * or Task to filter supported. Filter names and values are case-sensitive.
* @public */ - Arn?: string | undefined; -} + SearchExpression?: ModelMetadataSearchExpression | undefined; -/** - *Metadata for a transform job step.
- * @public - */ -export interface TransformJobStepMetadata { /** - *The Amazon Resource Name (ARN) of the transform job that was run by this step execution.
+ *If the response to a previous ListModelMetadataResponse request was truncated,
+ * the response includes a NextToken. To retrieve the next set of model metadata,
+ * use the token in the next request.
Metadata for a tuning step.
- * @public - */ -export interface TuningJobStepMetaData { /** - *The Amazon Resource Name (ARN) of the tuning job that was run by this step execution.
+ *The maximum number of models to return in the response.
* @public */ - Arn?: string | undefined; + MaxResults?: number | undefined; } /** - *Metadata for a step execution.
+ *A summary of the model metadata.
* @public */ -export interface PipelineExecutionStepMetadata { +export interface ModelMetadataSummary { /** - *The Amazon Resource Name (ARN) of the training job that was run by this step execution.
+ *The machine learning domain of the model.
* @public */ - TrainingJob?: TrainingJobStepMetadata | undefined; + Domain: string | undefined; /** - *The Amazon Resource Name (ARN) of the processing job that was run by this step execution.
+ *The machine learning framework of the model.
* @public */ - ProcessingJob?: ProcessingJobStepMetadata | undefined; + Framework: string | undefined; /** - *The Amazon Resource Name (ARN) of the transform job that was run by this step execution.
+ *The machine learning task of the model.
* @public */ - TransformJob?: TransformJobStepMetadata | undefined; + Task: string | undefined; /** - *The Amazon Resource Name (ARN) of the tuning job that was run by this step execution.
+ *The name of the model.
* @public */ - TuningJob?: TuningJobStepMetaData | undefined; + Model: string | undefined; /** - *The Amazon Resource Name (ARN) of the model that was created by this step execution.
+ *The framework version of the model.
* @public */ - Model?: ModelStepMetadata | undefined; + FrameworkVersion: string | undefined; +} +/** + * @public + */ +export interface ListModelMetadataResponse { /** - *The Amazon Resource Name (ARN) of the model package that the model was registered to by this step execution.
+ *A structure that holds model metadata.
* @public */ - RegisterModel?: RegisterModelStepMetadata | undefined; + ModelMetadataSummaries: ModelMetadataSummary[] | undefined; /** - *The outcome of the condition evaluation that was run by this step execution.
+ *A token for getting the next set of recommendations, if there are any.
* @public */ - Condition?: ConditionStepMetadata | undefined; + NextToken?: string | undefined; +} - /** - *The URL of the Amazon SQS queue used by this step execution, the pipeline generated token, - * and a list of output parameters.
- * @public - */ - Callback?: CallbackStepMetadata | undefined; +/** + * @public + * @enum + */ +export const ModelPackageGroupSortBy = { + CREATION_TIME: "CreationTime", + NAME: "Name", +} as const; + +/** + * @public + */ +export type ModelPackageGroupSortBy = (typeof ModelPackageGroupSortBy)[keyof typeof ModelPackageGroupSortBy]; +/** + * @public + */ +export interface ListModelPackageGroupsInput { /** - *The Amazon Resource Name (ARN) of the Lambda function that was run by this step execution and a list of - * output parameters.
+ *A filter that returns only model groups created after the specified time.
* @public */ - Lambda?: LambdaStepMetadata | undefined; + CreationTimeAfter?: Date | undefined; /** - *The configurations and outcomes of an Amazon EMR step execution.
+ *A filter that returns only model groups created before the specified time.
* @public */ - EMR?: EMRStepMetadata | undefined; + CreationTimeBefore?: Date | undefined; /** - *The configurations and outcomes of the check step execution. This includes:
- *The type of the check conducted.
- *The Amazon S3 URIs of baseline constraints and statistics files to be used for the drift check.
- *The Amazon S3 URIs of newly calculated baseline constraints and statistics.
- *The model package group name provided.
- *The Amazon S3 URI of the violation report if violations detected.
- *The Amazon Resource Name (ARN) of check processing job initiated by the step execution.
- *The Boolean flags indicating if the drift check is skipped.
- *If step property BaselineUsedForDriftCheck is set the same as
- * CalculatedBaseline.
The maximum number of results to return in the response.
* @public */ - QualityCheck?: QualityCheckStepMetadata | undefined; + MaxResults?: number | undefined; /** - *Container for the metadata for a Clarify check step. The configurations - * and outcomes of the check step execution. This includes:
- *The type of the check conducted,
- *The Amazon S3 URIs of baseline constraints and statistics files to be used for the drift check.
- *The Amazon S3 URIs of newly calculated baseline constraints and statistics.
- *The model package group name provided.
- *The Amazon S3 URI of the violation report if violations detected.
- *The Amazon Resource Name (ARN) of check processing job initiated by the step execution.
- *The boolean flags indicating if the drift check is skipped.
- *If step property BaselineUsedForDriftCheck is set the same as
- * CalculatedBaseline.
A string in the model group name. This filter returns only model groups whose name + * contains the specified string.
* @public */ - ClarifyCheck?: ClarifyCheckStepMetadata | undefined; + NameContains?: string | undefined; /** - *The configurations and outcomes of a Fail step execution.
+ *If the result of the previous ListModelPackageGroups request was
+ * truncated, the response includes a NextToken. To retrieve the next set of
+ * model groups, use the token in the next request.
The Amazon Resource Name (ARN) of the AutoML job that was run by this step.
+ *The field to sort results by. The default is CreationTime.
The endpoint that was invoked during this step execution.
+ *The sort order for results. The default is Ascending.
The endpoint configuration used to create an endpoint during this step execution.
+ *A filter that returns either model groups shared with you or model groups in
+ * your own account. When the value is 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.
The ARN from an execution of the current pipeline.
+ *Summary information about a model group.
* @public */ -export interface SelectiveExecutionResult { +export interface ModelPackageGroupSummary { /** - *The ARN from an execution of the current pipeline.
+ *The name of the model group.
* @public */ - SourcePipelineExecutionArn?: string | undefined; -} - -/** - * @public - * @enum - */ -export const StepStatus = { - EXECUTING: "Executing", - FAILED: "Failed", - STARTING: "Starting", - STOPPED: "Stopped", - STOPPING: "Stopping", - SUCCEEDED: "Succeeded", -} as const; - -/** - * @public - */ -export type StepStatus = (typeof StepStatus)[keyof typeof StepStatus]; - -/** - *An execution of a step in a pipeline.
- * @public - */ -export interface PipelineExecutionStep { - /** - *The name of the step that is executed.
- * @public - */ - StepName?: string | undefined; - - /** - *The display name of the step.
- * @public - */ - StepDisplayName?: string | undefined; - - /** - *The description of the step.
- * @public - */ - StepDescription?: string | undefined; - - /** - *The time that the step started executing.
- * @public - */ - StartTime?: Date | undefined; - - /** - *The time that the step stopped executing.
- * @public - */ - EndTime?: Date | undefined; - - /** - *The status of the step execution.
- * @public - */ - StepStatus?: StepStatus | undefined; - - /** - *If this pipeline execution step was cached, details on the cache hit.
- * @public - */ - CacheHitResult?: CacheHitResult | undefined; - - /** - *The reason why the step failed execution. This is only returned if the step failed its execution.
- * @public - */ - FailureReason?: string | undefined; - - /** - *Metadata to run the pipeline step.
- * @public - */ - Metadata?: PipelineExecutionStepMetadata | undefined; + ModelPackageGroupName: string | undefined; /** - *The current attempt of the execution step. For more information, see Retry Policy for SageMaker Pipelines steps.
+ *The Amazon Resource Name (ARN) of the model group.
* @public */ - AttemptCount?: number | undefined; + ModelPackageGroupArn: string | undefined; /** - *The ARN from an execution of the current pipeline from which - * results are reused for this step.
+ *A description of the model group.
* @public */ - SelectiveExecutionResult?: SelectiveExecutionResult | undefined; -} + ModelPackageGroupDescription?: string | undefined; -/** - * @public - */ -export interface ListPipelineExecutionStepsResponse { /** - *A list of PipeLineExecutionStep objects. Each
- * PipeLineExecutionStep consists of StepName, StartTime, EndTime, StepStatus,
- * and Metadata. Metadata is an object with properties for each job that contains relevant
- * information about the job created by the step.
The time that the model group was created.
* @public */ - PipelineExecutionSteps?: PipelineExecutionStep[] | undefined; + CreationTime: Date | undefined; /** - *If the result of the previous ListPipelineExecutionSteps request was truncated,
- * the response includes a NextToken. To retrieve the next set of pipeline execution steps, use the token in the next request.
The status of the model group.
* @public */ - NextToken?: string | undefined; + ModelPackageGroupStatus: ModelPackageGroupStatus | undefined; } /** * @public */ -export interface ListPipelineParametersForExecutionRequest { +export interface ListModelPackageGroupsOutput { /** - *The Amazon Resource Name (ARN) of the pipeline execution.
+ *A list of summaries of the model groups in your Amazon Web Services account.
* @public */ - PipelineExecutionArn: string | undefined; + ModelPackageGroupSummaryList: ModelPackageGroupSummary[] | undefined; /** - *If the result of the previous ListPipelineParametersForExecution request was truncated,
- * the response includes a NextToken. To retrieve the next set of parameters, use the token in the next request.
If the response is truncated, SageMaker returns this token. To retrieve the next set + * of model groups, use it in the subsequent request.
* @public */ NextToken?: string | undefined; - - /** - *The maximum number of parameters to return in the response.
- * @public - */ - MaxResults?: number | undefined; } /** - *Assigns a value to a named Pipeline parameter.
* @public + * @enum */ -export interface Parameter { - /** - *The name of the parameter to assign a value to. This - * parameter name must match a named parameter in the - * pipeline definition.
- * @public - */ - Name: string | undefined; - - /** - *The literal value for the parameter.
- * @public - */ - Value: string | undefined; -} +export const ModelPackageType = { + BOTH: "Both", + UNVERSIONED: "Unversioned", + VERSIONED: "Versioned", +} as const; /** * @public */ -export interface ListPipelineParametersForExecutionResponse { - /** - *Contains a list of pipeline parameters. This list can be empty.
- * @public - */ - PipelineParameters?: Parameter[] | undefined; - - /** - *If the result of the previous ListPipelineParametersForExecution request was truncated,
- * the response includes a NextToken. To retrieve the next set of parameters, use the token in the next request.
The prefix of the pipeline name.
+ *A filter that returns only model packages created after the specified time + * (timestamp).
* @public */ - PipelineNamePrefix?: string | undefined; + CreationTimeAfter?: Date | undefined; /** - *A filter that returns the pipelines that were created after a specified - * time.
+ *A filter that returns only model packages created before the specified time + * (timestamp).
* @public */ - CreatedAfter?: Date | undefined; + CreationTimeBefore?: Date | undefined; /** - *A filter that returns the pipelines that were created before a specified - * time.
+ *The maximum number of model packages to return in the response.
* @public */ - CreatedBefore?: Date | undefined; + MaxResults?: number | undefined; /** - *The field by which to sort results. The default is CreatedTime.
A string in the model package name. This filter returns only model packages whose name + * contains the specified string.
* @public */ - SortBy?: SortPipelinesBy | undefined; + NameContains?: string | undefined; /** - *The sort order for results.
+ *A filter that returns only the model packages with the specified approval + * status.
* @public */ - SortOrder?: SortOrder | undefined; + ModelApprovalStatus?: ModelApprovalStatus | undefined; /** - *If the result of the previous ListPipelines request was truncated,
- * the response includes a NextToken. To retrieve the next set of pipelines, use the token in the next request.
A filter that returns only model versions that belong to the specified model group.
* @public */ - NextToken?: string | undefined; + ModelPackageGroupName?: string | undefined; /** - *The maximum number of pipelines to return in the response.
+ *A filter that returns only the model packages of the specified type. This can be one + * of the following values.
+ *
+ * UNVERSIONED - List only unversioined models.
+ * This is the default value if no ModelPackageType is specified.
+ * VERSIONED - List only versioned models.
+ * BOTH - List both versioned and unversioned models.
A summary of a pipeline.
- * @public - */ -export interface PipelineSummary { /** - *The Amazon Resource Name (ARN) of the pipeline.
+ *If the response to a previous ListModelPackages request was truncated,
+ * the response includes a NextToken. To retrieve the next set of model
+ * packages, use the token in the next request.
The name of the pipeline.
+ *The parameter by which to sort the results. The default is
+ * CreationTime.
The display name of the pipeline.
+ *The sort order for the results. The default is Ascending.
Provides summary information about a model package.
+ * @public + */ +export interface ModelPackageSummary { /** - *The description of the pipeline.
+ *The name of the model package.
* @public */ - PipelineDescription?: string | undefined; + ModelPackageName?: string | undefined; /** - *The Amazon Resource Name (ARN) that the pipeline used to execute.
+ *If the model package is a versioned model, the model group that the versioned model + * belongs to.
* @public */ - RoleArn?: string | undefined; + ModelPackageGroupName?: string | undefined; /** - *The creation time of the pipeline.
+ *If the model package is a versioned model, the version of the model.
* @public */ - CreationTime?: Date | undefined; + ModelPackageVersion?: number | undefined; /** - *The time that the pipeline was last modified.
+ *The Amazon Resource Name (ARN) of the model package.
* @public */ - LastModifiedTime?: Date | undefined; + ModelPackageArn: string | undefined; /** - *The last time that a pipeline execution began.
+ *A brief description of the model package.
* @public */ - LastExecutionTime?: Date | undefined; + ModelPackageDescription?: string | undefined; + + /** + *A timestamp that shows when the model package was created.
+ * @public + */ + CreationTime: Date | undefined; + + /** + *The overall status of the model package.
+ * @public + */ + ModelPackageStatus: ModelPackageStatus | undefined; + + /** + *The approval status of the model. This can be one of the following values.
+ *
+ * APPROVED - The model is approved
+ * REJECTED - The model is rejected.
+ * PENDING_MANUAL_APPROVAL - The model is waiting for manual
+ * approval.
Contains a sorted list of PipelineSummary objects matching the specified
- * filters. Each PipelineSummary consists of PipelineArn, PipelineName,
- * ExperimentName, PipelineDescription, CreationTime, LastModifiedTime, LastRunTime, and
- * RoleArn. This list can be empty.
An array of ModelPackageSummary objects, each of which lists a model
+ * package.
If the result of the previous ListPipelines request was truncated,
- * the response includes a NextToken. To retrieve the next set of pipelines, use the token in the next request.
If the response is truncated, SageMaker returns this token. To retrieve the next set of + * model packages, use it in the subsequent request.
* @public */ NextToken?: string | undefined; @@ -3518,141 +3320,186 @@ export interface ListPipelinesResponse { /** * @public */ -export interface ListProcessingJobsRequest { +export interface ListModelQualityJobDefinitionsRequest { /** - *A filter that returns only processing jobs created after the specified time.
+ *A filter that returns only model quality monitoring job definitions that are associated + * with the specified endpoint.
* @public */ - CreationTimeAfter?: Date | undefined; + EndpointName?: string | undefined; /** - *A filter that returns only processing jobs created after the specified time.
+ *The field to sort results by. The default is CreationTime.
A filter that returns only processing jobs modified after the specified time.
+ *Whether to sort the results in Ascending or Descending order.
+ * The default is Descending.
A filter that returns only processing jobs modified before the specified time.
+ *If the result of the previous ListModelQualityJobDefinitions request was
+ * truncated, the response includes a NextToken. To retrieve the next set of
+ * model quality monitoring job definitions, use the token in the next request.
A string in the processing job name. This filter returns only processing jobs whose - * name contains the specified string.
+ *The maximum number of results to return in a call to
+ * ListModelQualityJobDefinitions.
A filter that retrieves only processing jobs with a specific status.
+ *A string in the transform job name. This filter returns only model quality monitoring + * job definitions whose name contains the specified string.
* @public */ - StatusEquals?: ProcessingJobStatus | undefined; + NameContains?: string | undefined; /** - *The field to sort results by. The default is CreationTime.
A filter that returns only model quality monitoring job definitions created before the + * specified time.
* @public */ - SortBy?: SortBy | undefined; + CreationTimeBefore?: Date | undefined; /** - *The sort order for results. The default is Ascending.
A filter that returns only model quality monitoring job definitions created after the + * specified time.
* @public */ - SortOrder?: SortOrder | undefined; + CreationTimeAfter?: Date | undefined; +} +/** + * @public + */ +export interface ListModelQualityJobDefinitionsResponse { /** - *If the result of the previous ListProcessingJobs request was truncated,
- * the response includes a NextToken. To retrieve the next set of processing
- * jobs, use the token in the next request.
A list of summaries of model quality monitoring job definitions.
* @public */ - NextToken?: string | undefined; + JobDefinitionSummaries: MonitoringJobDefinitionSummary[] | undefined; /** - *The maximum number of processing jobs to return in the response.
+ *If the response is truncated, Amazon SageMaker returns this token. To retrieve the + * next set of model quality monitoring job definitions, use it in the next request.
* @public */ - MaxResults?: number | undefined; + NextToken?: string | undefined; } /** - *Summary of information about a processing job.
* @public + * @enum */ -export interface ProcessingJobSummary { +export const ModelSortKey = { + CreationTime: "CreationTime", + Name: "Name", +} as const; + +/** + * @public + */ +export type ModelSortKey = (typeof ModelSortKey)[keyof typeof ModelSortKey]; + +/** + * @public + */ +export interface ListModelsInput { /** - *The name of the processing job.
+ *Sorts the list of results. The default is CreationTime.
The Amazon Resource Name (ARN) of the processing job..
+ *The sort order for results. The default is Descending.
The time at which the processing job was created.
+ *If the response to a previous ListModels request was truncated, the
+ * response includes a NextToken. To retrieve the next set of models, use the
+ * token in the next request.
The time at which the processing job completed.
+ *The maximum number of models to return in the response.
* @public */ - ProcessingEndTime?: Date | undefined; + MaxResults?: number | undefined; /** - *A timestamp that indicates the last time the processing job was modified.
+ *A string in the model name. This filter returns only models whose name contains the + * specified string.
* @public */ - LastModifiedTime?: Date | undefined; + NameContains?: string | undefined; /** - *The status of the processing job.
+ *A filter that returns only models created before the specified time + * (timestamp).
* @public */ - ProcessingJobStatus: ProcessingJobStatus | undefined; + CreationTimeBefore?: Date | undefined; /** - *A string, up to one KB in size, that contains the reason a processing job failed, if - * it failed.
+ *A filter that returns only models with a creation time greater than or equal to the + * specified time (timestamp).
* @public */ - FailureReason?: string | undefined; + CreationTimeAfter?: Date | undefined; +} +/** + *Provides summary information about a model.
+ * @public + */ +export interface ModelSummary { /** - *An optional string, up to one KB in size, that contains metadata from the processing - * container when the processing job exits.
+ *The name of the model that you want a summary for.
* @public */ - ExitMessage?: string | undefined; + ModelName: string | undefined; + + /** + *The Amazon Resource Name (ARN) of the model.
+ * @public + */ + ModelArn: string | undefined; + + /** + *A timestamp that indicates when the model was created.
+ * @public + */ + CreationTime: Date | undefined; } /** * @public */ -export interface ListProcessingJobsResponse { +export interface ListModelsOutput { /** - *An array of ProcessingJobSummary objects, each listing a processing
- * job.
An array of ModelSummary objects, each of which lists a
+ * model.
If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of - * processing jobs, use it in the subsequent request.
+ *If the response is truncated, SageMaker returns this token. To retrieve the next set of + * models, use it in the subsequent request.
* @public */ NextToken?: string | undefined; @@ -3662,264 +3509,259 @@ export interface ListProcessingJobsResponse { * @public * @enum */ -export const ProjectSortBy = { - CREATION_TIME: "CreationTime", - NAME: "Name", +export const MonitoringAlertHistorySortKey = { + CreationTime: "CreationTime", + Status: "Status", } as const; /** * @public */ -export type ProjectSortBy = (typeof ProjectSortBy)[keyof typeof ProjectSortBy]; +export type MonitoringAlertHistorySortKey = + (typeof MonitoringAlertHistorySortKey)[keyof typeof MonitoringAlertHistorySortKey]; /** * @public * @enum */ -export const ProjectSortOrder = { - ASCENDING: "Ascending", - DESCENDING: "Descending", +export const MonitoringAlertStatus = { + IN_ALERT: "InAlert", + OK: "OK", } as const; /** * @public */ -export type ProjectSortOrder = (typeof ProjectSortOrder)[keyof typeof ProjectSortOrder]; +export type MonitoringAlertStatus = (typeof MonitoringAlertStatus)[keyof typeof MonitoringAlertStatus]; /** * @public */ -export interface ListProjectsInput { +export interface ListMonitoringAlertHistoryRequest { /** - *A filter that returns the projects that were created after a specified - * time.
+ *The name of a monitoring schedule.
* @public */ - CreationTimeAfter?: Date | undefined; + MonitoringScheduleName?: string | undefined; /** - *A filter that returns the projects that were created before a specified - * time.
+ *The name of a monitoring alert.
* @public */ - CreationTimeBefore?: Date | undefined; + MonitoringAlertName?: string | undefined; /** - *The maximum number of projects to return in the response.
+ *The field used to sort results. The default is CreationTime.
A filter that returns the projects whose name contains a specified - * string.
+ *The sort order, whether Ascending or Descending, of the alert
+ * history. The default is Descending.
If the result of the previous ListProjects request was truncated,
- * the response includes a NextToken. To retrieve the next set of projects, use the token in the next request.
If the result of the previous ListMonitoringAlertHistory request was
+ * truncated, the response includes a NextToken. To retrieve the next set of
+ * alerts in the history, use the token in the next request.
The field by which to sort results. The default is CreationTime.
The maximum number of results to display. The default is 100.
* @public */ - SortBy?: ProjectSortBy | undefined; + MaxResults?: number | undefined; /** - *The sort order for results. The default is Ascending.
A filter that returns only alerts created on or before the specified time.
* @public */ - SortOrder?: ProjectSortOrder | undefined; -} + CreationTimeBefore?: Date | undefined; -/** - *Information about a project.
- * @public - */ -export interface ProjectSummary { /** - *The name of the project.
+ *A filter that returns only alerts created on or after the specified time.
* @public */ - ProjectName: string | undefined; + CreationTimeAfter?: Date | undefined; /** - *The description of the project.
+ *A filter that retrieves only alerts with a specific status.
* @public */ - ProjectDescription?: string | undefined; + StatusEquals?: MonitoringAlertStatus | undefined; +} +/** + *Provides summary information of an alert's history.
+ * @public + */ +export interface MonitoringAlertHistorySummary { /** - *The Amazon Resource Name (ARN) of the project.
+ *The name of a monitoring schedule.
* @public */ - ProjectArn: string | undefined; + MonitoringScheduleName: string | undefined; /** - *The ID of the project.
+ *The name of a monitoring alert.
* @public */ - ProjectId: string | undefined; + MonitoringAlertName: string | undefined; /** - *The time that the project was created.
+ *A timestamp that indicates when the first alert transition occurred in an alert history.
+ * An alert transition can be from status InAlert to OK,
+ * or from OK to InAlert.
The status of the project.
+ *The current alert status of an alert.
* @public */ - ProjectStatus: ProjectStatus | undefined; + AlertStatus: MonitoringAlertStatus | undefined; } /** * @public */ -export interface ListProjectsOutput { +export interface ListMonitoringAlertHistoryResponse { /** - *A list of summaries of projects.
+ *An alert history for a model monitoring schedule.
* @public */ - ProjectSummaryList: ProjectSummary[] | undefined; + MonitoringAlertHistory?: MonitoringAlertHistorySummary[] | undefined; /** - *If the result of the previous ListCompilationJobs request was truncated,
- * the response includes a NextToken. To retrieve the next set of model
- * compilation jobs, use the token in the next request.
If the response is truncated, SageMaker returns this token. To retrieve the next set of + * alerts, use it in the subsequent request.
* @public */ NextToken?: string | undefined; } -/** - * @public - * @enum - */ -export const ResourceCatalogSortBy = { - CREATION_TIME: "CreationTime", -} as const; - -/** - * @public - */ -export type ResourceCatalogSortBy = (typeof ResourceCatalogSortBy)[keyof typeof ResourceCatalogSortBy]; - -/** - * @public - * @enum - */ -export const ResourceCatalogSortOrder = { - ASCENDING: "Ascending", - DESCENDING: "Descending", -} as const; - /** * @public */ -export type ResourceCatalogSortOrder = (typeof ResourceCatalogSortOrder)[keyof typeof ResourceCatalogSortOrder]; +export interface ListMonitoringAlertsRequest { + /** + *The name of a monitoring schedule.
+ * @public + */ + MonitoringScheduleName: string | undefined; -/** - * @public - */ -export interface ListResourceCatalogsRequest { /** - * A string that partially matches one or more ResourceCatalogs names.
- * Filters ResourceCatalog by name.
If the result of the previous ListMonitoringAlerts request was truncated,
+ * the response includes a NextToken. To retrieve the next set of alerts in the
+ * history, use the token in the next request.
Use this parameter to search for ResourceCatalogs created after a
- * specific date and time.
The maximum number of results to display. The default is 100.
* @public */ - CreationTimeAfter?: Date | undefined; + MaxResults?: number | undefined; +} +/** + *An alert action taken to light up an icon on the Amazon SageMaker Model Dashboard when an alert goes into
+ * InAlert status.
Use this parameter to search for ResourceCatalogs created before a
- * specific date and time.
Indicates whether the alert action is turned on.
* @public */ - CreationTimeBefore?: Date | undefined; + Enabled?: boolean | undefined; +} +/** + *A list of alert actions taken in response to an alert going into
+ * InAlert status.
The order in which the resource catalogs are listed.
+ *An alert action taken to light up an icon on the Model Dashboard when an alert goes into
+ * InAlert status.
Provides summary information about a monitor alert.
+ * @public + */ +export interface MonitoringAlertSummary { /** - *The value on which the resource catalog list is sorted.
+ *The name of a monitoring alert.
* @public */ - SortBy?: ResourceCatalogSortBy | undefined; + MonitoringAlertName: string | undefined; /** - * The maximum number of results returned by ListResourceCatalogs.
A timestamp that indicates when a monitor alert was created.
* @public */ - MaxResults?: number | undefined; + CreationTime: Date | undefined; /** - * A token to resume pagination of ListResourceCatalogs results.
A timestamp that indicates when a monitor alert was last updated.
* @public */ - NextToken?: string | undefined; -} + LastModifiedTime: Date | undefined; -/** - * A resource catalog containing all of the resources of a specific resource type within
- * a resource owner account. For an example on sharing the Amazon SageMaker Feature Store
- * DefaultFeatureGroupCatalog, see Share Amazon SageMaker Catalog resource type in the Amazon SageMaker Developer Guide.
- *
The Amazon Resource Name (ARN) of the ResourceCatalog.
The current status of an alert.
* @public */ - ResourceCatalogArn: string | undefined; + AlertStatus: MonitoringAlertStatus | undefined; /** - * The name of the ResourceCatalog.
Within EvaluationPeriod, how many execution failures will raise an
+ * alert.
A free form description of the ResourceCatalog.
The number of most recent monitoring executions to consider when evaluating alert + * status.
* @public */ - Description: string | undefined; + EvaluationPeriod: number | undefined; /** - * The time the ResourceCatalog was created.
A list of alert actions taken in response to an alert going into
+ * InAlert status.
A list of the requested ResourceCatalogs.
A JSON array where each element is a summary for a monitoring alert.
* @public */ - ResourceCatalogs?: ResourceCatalog[] | undefined; + MonitoringAlertSummaries?: MonitoringAlertSummary[] | undefined; /** - * A token to resume pagination of ListResourceCatalogs results.
If the response is truncated, SageMaker returns this token. To retrieve the next set of + * alerts, use it in the subsequent request.
* @public */ NextToken?: string | undefined; @@ -3929,179 +3771,130 @@ export interface ListResourceCatalogsResponse { * @public * @enum */ -export const SpaceSortKey = { - CreationTime: "CreationTime", - LastModifiedTime: "LastModifiedTime", +export const MonitoringExecutionSortKey = { + CREATION_TIME: "CreationTime", + SCHEDULED_TIME: "ScheduledTime", + STATUS: "Status", } as const; /** * @public */ -export type SpaceSortKey = (typeof SpaceSortKey)[keyof typeof SpaceSortKey]; +export type MonitoringExecutionSortKey = (typeof MonitoringExecutionSortKey)[keyof typeof MonitoringExecutionSortKey]; /** * @public */ -export interface ListSpacesRequest { +export interface ListMonitoringExecutionsRequest { /** - *If the previous response was truncated, you will receive this token. Use it in your next - * request to receive the next set of results.
+ *Name of a specific schedule to fetch jobs for.
* @public */ - NextToken?: string | undefined; + MonitoringScheduleName?: string | undefined; /** - *This parameter defines the maximum number of results that can be return in a single
- * response. The MaxResults parameter is an upper bound, not a target. If there are
- * more results available than the value specified, a NextToken is provided in the
- * response. The NextToken indicates that the user should get the next set of
- * results by providing this token as a part of a subsequent call. The default value for
- * MaxResults is 10.
Name of a specific endpoint to fetch jobs for.
* @public */ - MaxResults?: number | undefined; + EndpointName?: string | undefined; /** - *The sort order for the results. The default is Ascending.
Whether to sort the results by the Status, CreationTime, or
+ * ScheduledTime field. The default is CreationTime.
The parameter by which to sort the results. The default is
- * CreationTime.
Whether to sort the results in Ascending or Descending order.
+ * The default is Descending.
A parameter to search for the domain ID.
+ *The token returned if the response is truncated. To retrieve the next set of job executions, use + * it in the next request.
* @public */ - DomainIdEquals?: string | undefined; + NextToken?: string | undefined; /** - *A parameter by which to filter the results.
+ *The maximum number of jobs to return in the response. The default value is 10.
* @public */ - SpaceNameContains?: string | undefined; -} + MaxResults?: number | undefined; -/** - *Specifies summary information about the ownership settings.
- * @public - */ -export interface OwnershipSettingsSummary { /** - *The user profile who is the owner of the space.
+ *Filter for jobs scheduled before a specified time.
* @public */ - OwnerUserProfileName?: string | undefined; -} + ScheduledTimeBefore?: Date | undefined; -/** - *Specifies summary information about the space settings.
- * @public - */ -export interface SpaceSettingsSummary { /** - *The type of app created within the space.
+ *Filter for jobs scheduled after a specified time.
* @public */ - AppType?: AppType | undefined; + ScheduledTimeAfter?: Date | undefined; /** - *The storage settings for a space.
+ *A filter that returns only jobs created before a specified time.
* @public */ - SpaceStorageSettings?: SpaceStorageSettings | undefined; -} + CreationTimeBefore?: Date | undefined; -/** - *Specifies summary information about the space sharing settings.
- * @public - */ -export interface SpaceSharingSettingsSummary { /** - *Specifies the sharing type of the space.
+ *A filter that returns only jobs created after a specified time.
* @public */ - SharingType?: SharingType | undefined; -} + CreationTimeAfter?: Date | undefined; -/** - *The space's details.
- * @public - */ -export interface SpaceDetails { /** - *The ID of the associated domain.
+ *A filter that returns only jobs modified after a specified time.
* @public */ - DomainId?: string | undefined; + LastModifiedTimeBefore?: Date | undefined; /** - *The name of the space.
+ *A filter that returns only jobs modified before a specified time.
* @public */ - SpaceName?: string | undefined; + LastModifiedTimeAfter?: Date | undefined; /** - *The status.
+ *A filter that retrieves only jobs with a specific status.
* @public */ - Status?: SpaceStatus | undefined; - - /** - *The creation time.
- * @public - */ - CreationTime?: Date | undefined; - - /** - *The last modified time.
- * @public - */ - LastModifiedTime?: Date | undefined; - - /** - *Specifies summary information about the space settings.
- * @public - */ - SpaceSettingsSummary?: SpaceSettingsSummary | undefined; - - /** - *Specifies summary information about the space sharing settings.
- * @public - */ - SpaceSharingSettingsSummary?: SpaceSharingSettingsSummary | undefined; + StatusEquals?: ExecutionStatus | undefined; /** - *Specifies summary information about the ownership settings.
+ *Gets a list of the monitoring job runs of the specified monitoring job + * definitions.
* @public */ - OwnershipSettingsSummary?: OwnershipSettingsSummary | undefined; + MonitoringJobDefinitionName?: string | undefined; /** - *The name of the space that appears in the Studio UI.
+ *A filter that returns only the monitoring job runs of the specified monitoring + * type.
* @public */ - SpaceDisplayName?: string | undefined; + MonitoringTypeEquals?: MonitoringType | undefined; } /** * @public */ -export interface ListSpacesResponse { +export interface ListMonitoringExecutionsResponse { /** - *The list of spaces.
+ *A JSON array in which each element is a summary for a monitoring execution.
* @public */ - Spaces?: SpaceDetails[] | undefined; + MonitoringExecutionSummaries: MonitoringExecutionSummary[] | undefined; /** - *If the previous response was truncated, you will receive this token. Use it in your next - * request to receive the next set of results.
+ *The token returned if the response is truncated. To retrieve the next set of job executions, use + * it in the next request.
* @public */ NextToken?: string | undefined; @@ -4109,243 +3902,174 @@ export interface ListSpacesResponse { /** * @public + * @enum */ -export interface ListStageDevicesRequest { - /** - *The response from the last list when returning a list large enough to neeed - * tokening.
- * @public - */ - NextToken?: string | undefined; - - /** - *The maximum number of requests to select.
- * @public - */ - MaxResults?: number | undefined; +export const MonitoringScheduleSortKey = { + CREATION_TIME: "CreationTime", + NAME: "Name", + STATUS: "Status", +} as const; - /** - *The name of the edge deployment plan.
- * @public - */ - EdgeDeploymentPlanName: string | undefined; +/** + * @public + */ +export type MonitoringScheduleSortKey = (typeof MonitoringScheduleSortKey)[keyof typeof MonitoringScheduleSortKey]; +/** + * @public + */ +export interface ListMonitoringSchedulesRequest { /** - *Toggle for excluding devices deployed in other stages.
+ *Name of a specific endpoint to fetch schedules for.
* @public */ - ExcludeDevicesDeployedInOtherStage?: boolean | undefined; + EndpointName?: string | undefined; /** - *The name of the stage in the deployment.
+ *Whether to sort the results by the Status, CreationTime, or
+ * ScheduledTime field. The default is CreationTime.
List of summaries of devices allocated to the stage.
+ *Whether to sort the results in Ascending or Descending order.
+ * The default is Descending.
The token to use when calling the next page of results.
+ *The token returned if the response is truncated. To retrieve the next set of job executions, use + * it in the next request.
* @public */ NextToken?: string | undefined; -} - -/** - * @public - * @enum - */ -export const StudioLifecycleConfigSortKey = { - CreationTime: "CreationTime", - LastModifiedTime: "LastModifiedTime", - Name: "Name", -} as const; - -/** - * @public - */ -export type StudioLifecycleConfigSortKey = - (typeof StudioLifecycleConfigSortKey)[keyof typeof StudioLifecycleConfigSortKey]; -/** - * @public - */ -export interface ListStudioLifecycleConfigsRequest { /** - *The total number of items to return in the response. If the total number of items
- * available is more than the value specified, a NextToken is provided in the
- * response. To resume pagination, provide the NextToken value in the as part of a
- * subsequent call. The default value is 10.
The maximum number of jobs to return in the response. The default value is 10.
* @public */ MaxResults?: number | undefined; /** - *If the previous call to ListStudioLifecycleConfigs didn't return the full set of Lifecycle - * Configurations, the call returns a token for getting the next set of Lifecycle - * Configurations.
- * @public - */ - NextToken?: string | undefined; - - /** - *A string in the Lifecycle Configuration name. This filter returns only Lifecycle - * Configurations whose name contains the specified string.
+ *Filter for monitoring schedules whose name contains a specified string.
* @public */ NameContains?: string | undefined; /** - *A parameter to search for the App Type to which the Lifecycle Configuration is - * attached.
+ *A filter that returns only monitoring schedules created before a specified time.
* @public */ - AppTypeEquals?: StudioLifecycleConfigAppType | undefined; + CreationTimeBefore?: Date | undefined; /** - *A filter that returns only Lifecycle Configurations created on or before the specified - * time.
+ *A filter that returns only monitoring schedules created after a specified time.
* @public */ - CreationTimeBefore?: Date | undefined; + CreationTimeAfter?: Date | undefined; /** - *A filter that returns only Lifecycle Configurations created on or after the specified - * time.
+ *A filter that returns only monitoring schedules modified before a specified time.
* @public */ - CreationTimeAfter?: Date | undefined; + LastModifiedTimeBefore?: Date | undefined; /** - *A filter that returns only Lifecycle Configurations modified before the specified - * time.
+ *A filter that returns only monitoring schedules modified after a specified time.
* @public */ - ModifiedTimeBefore?: Date | undefined; + LastModifiedTimeAfter?: Date | undefined; /** - *A filter that returns only Lifecycle Configurations modified after the specified - * time.
+ *A filter that returns only monitoring schedules modified before a specified time.
* @public */ - ModifiedTimeAfter?: Date | undefined; + StatusEquals?: ScheduleStatus | undefined; /** - *The property used to sort results. The default value is CreationTime.
+ *Gets a list of the monitoring schedules for the specified monitoring job + * definition.
* @public */ - SortBy?: StudioLifecycleConfigSortKey | undefined; + MonitoringJobDefinitionName?: string | undefined; /** - *The sort order. The default value is Descending.
+ *A filter that returns only the monitoring schedules for the specified monitoring + * type.
* @public */ - SortOrder?: SortOrder | undefined; + MonitoringTypeEquals?: MonitoringType | undefined; } /** - *Details of the Amazon SageMaker Studio Lifecycle Configuration.
+ *Summarizes the monitoring schedule.
* @public */ -export interface StudioLifecycleConfigDetails { - /** - *The Amazon Resource Name (ARN) of the Lifecycle Configuration.
- * @public - */ - StudioLifecycleConfigArn?: string | undefined; - - /** - *The name of the Amazon SageMaker Studio Lifecycle Configuration.
- * @public - */ - StudioLifecycleConfigName?: string | undefined; - +export interface MonitoringScheduleSummary { /** - *The creation time of the Amazon SageMaker Studio Lifecycle Configuration.
+ *The name of the monitoring schedule.
* @public */ - CreationTime?: Date | undefined; + MonitoringScheduleName: string | undefined; /** - *This value is equivalent to CreationTime because Amazon SageMaker Studio Lifecycle - * Configurations are immutable.
+ *The Amazon Resource Name (ARN) of the monitoring schedule.
* @public */ - LastModifiedTime?: Date | undefined; + MonitoringScheduleArn: string | undefined; /** - *The App type to which the Lifecycle Configuration is attached.
+ *The creation time of the monitoring schedule.
* @public */ - StudioLifecycleConfigAppType?: StudioLifecycleConfigAppType | undefined; -} + CreationTime: Date | undefined; -/** - * @public - */ -export interface ListStudioLifecycleConfigsResponse { /** - *If the previous response was truncated, you will receive this token. Use it in your next - * request to receive the next set of results.
+ *The last time the monitoring schedule was modified.
* @public */ - NextToken?: string | undefined; + LastModifiedTime: Date | undefined; /** - *A list of Lifecycle Configurations and their properties.
+ *The status of the monitoring schedule.
* @public */ - StudioLifecycleConfigs?: StudioLifecycleConfigDetails[] | undefined; -} + MonitoringScheduleStatus: ScheduleStatus | undefined; -/** - * @public - */ -export interface ListSubscribedWorkteamsRequest { /** - *A string in the work team name. This filter returns only work teams whose name - * contains the specified string.
+ *The name of the endpoint using the monitoring schedule.
* @public */ - NameContains?: string | undefined; + EndpointName?: string | undefined; /** - *If the result of the previous ListSubscribedWorkteams request was
- * truncated, the response includes a NextToken. To retrieve the next set of
- * labeling jobs, use the token in the next request.
The name of the monitoring job definition that the schedule is for.
* @public */ - NextToken?: string | undefined; + MonitoringJobDefinitionName?: string | undefined; /** - *The maximum number of work teams to return in each page of the response.
+ *The type of the monitoring job definition that the schedule is for.
* @public */ - MaxResults?: number | undefined; + MonitoringType?: MonitoringType | undefined; } /** * @public */ -export interface ListSubscribedWorkteamsResponse { +export interface ListMonitoringSchedulesResponse { /** - *An array of Workteam objects, each describing a work team.
A JSON array in which each element is a summary for a monitoring schedule.
* @public */ - SubscribedWorkteams: SubscribedWorkteam[] | undefined; + MonitoringScheduleSummaries: MonitoringScheduleSummary[] | undefined; /** - *If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of - * work teams, use it in the subsequent request.
+ *The token returned if the response is truncated. To retrieve the next set of job executions, use + * it in the next request.
* @public */ NextToken?: string | undefined; @@ -4353,740 +4077,630 @@ export interface ListSubscribedWorkteamsResponse { /** * @public + * @enum */ -export interface ListTagsInput { - /** - *The Amazon Resource Name (ARN) of the resource whose tags you want to - * retrieve.
- * @public - */ - ResourceArn: string | undefined; - - /** - * If the response to the previous ListTags request is truncated, SageMaker
- * returns this token. To retrieve the next set of tags, use it in the subsequent request.
- *
Maximum number of tags to return.
- * @public - */ - MaxResults?: number | undefined; -} +/** + * @public + */ +export type NotebookInstanceLifecycleConfigSortKey = + (typeof NotebookInstanceLifecycleConfigSortKey)[keyof typeof NotebookInstanceLifecycleConfigSortKey]; /** * @public + * @enum */ -export interface ListTagsOutput { - /** - *An array of Tag objects, each with a tag key and a value.
If response is truncated, SageMaker includes a token in the response. You can use this - * token in your subsequent request to fetch next set of tokens.
- * @public - */ - NextToken?: string | undefined; -} +/** + * @public + */ +export type NotebookInstanceLifecycleConfigSortOrder = + (typeof NotebookInstanceLifecycleConfigSortOrder)[keyof typeof NotebookInstanceLifecycleConfigSortOrder]; /** * @public */ -export interface ListTrainingJobsRequest { +export interface ListNotebookInstanceLifecycleConfigsInput { /** - *If the result of the previous ListTrainingJobs request was truncated,
- * the response includes a NextToken. To retrieve the next set of training
- * jobs, use the token in the next request.
If the result of a ListNotebookInstanceLifecycleConfigs request was
+ * truncated, the response includes a NextToken. To get the next set of
+ * lifecycle configurations, use the token in the next request.
The maximum number of training jobs to return in the response.
+ *The maximum number of lifecycle configurations to return in the response.
* @public */ MaxResults?: number | undefined; /** - *A filter that returns only training jobs created after the specified time - * (timestamp).
- * @public - */ - CreationTimeAfter?: Date | undefined; - - /** - *A filter that returns only training jobs created before the specified time - * (timestamp).
- * @public - */ - CreationTimeBefore?: Date | undefined; - - /** - *A filter that returns only training jobs modified after the specified time - * (timestamp).
+ *Sorts the list of results. The default is CreationTime.
A filter that returns only training jobs modified before the specified time - * (timestamp).
+ *The sort order for results.
* @public */ - LastModifiedTimeBefore?: Date | undefined; + SortOrder?: NotebookInstanceLifecycleConfigSortOrder | undefined; /** - *A string in the training job name. This filter returns only training jobs whose - * name contains the specified string.
+ *A string in the lifecycle configuration name. This filter returns only lifecycle + * configurations whose name contains the specified string.
* @public */ NameContains?: string | undefined; /** - *A filter that retrieves only training jobs with a specific status.
+ *A filter that returns only lifecycle configurations that were created before the + * specified time (timestamp).
* @public */ - StatusEquals?: TrainingJobStatus | undefined; + CreationTimeBefore?: Date | undefined; /** - *The field to sort results by. The default is CreationTime.
A filter that returns only lifecycle configurations that were created after the + * specified time (timestamp).
* @public */ - SortBy?: SortBy | undefined; + CreationTimeAfter?: Date | undefined; /** - *The sort order for results. The default is Ascending.
A filter that returns only lifecycle configurations that were modified before the + * specified time (timestamp).
* @public */ - SortOrder?: SortOrder | undefined; + LastModifiedTimeBefore?: Date | undefined; /** - *A filter that retrieves only training jobs with a specific warm pool status.
+ *A filter that returns only lifecycle configurations that were modified after the + * specified time (timestamp).
* @public */ - WarmPoolStatusEquals?: WarmPoolResourceStatus | undefined; + LastModifiedTimeAfter?: Date | undefined; } /** - *Provides summary information about a training job.
+ *Provides a summary of a notebook instance lifecycle configuration.
* @public */ -export interface TrainingJobSummary { - /** - *The name of the training job that you want a summary for.
- * @public - */ - TrainingJobName: string | undefined; - +export interface NotebookInstanceLifecycleConfigSummary { /** - *The Amazon Resource Name (ARN) of the training job.
+ *The name of the lifecycle configuration.
* @public */ - TrainingJobArn: string | undefined; + NotebookInstanceLifecycleConfigName: string | undefined; /** - *A timestamp that shows when the training job was created.
+ *The Amazon Resource Name (ARN) of the lifecycle configuration.
* @public */ - CreationTime: Date | undefined; + NotebookInstanceLifecycleConfigArn: string | undefined; /** - *A timestamp that shows when the training job ended. This field is set only if the
- * training job has one of the terminal statuses (Completed,
- * Failed, or Stopped).
A timestamp that tells when the lifecycle configuration was created.
* @public */ - TrainingEndTime?: Date | undefined; + CreationTime?: Date | undefined; /** - *Timestamp when the training job was last modified.
+ *A timestamp that tells when the lifecycle configuration was last modified.
* @public */ LastModifiedTime?: Date | undefined; - - /** - *The status of the training job.
- * @public - */ - TrainingJobStatus: TrainingJobStatus | undefined; - - /** - *The secondary status of the training job.
- * @public - */ - SecondaryStatus?: SecondaryStatus | undefined; - - /** - *The status of the warm pool associated with the training job.
- * @public - */ - WarmPoolStatus?: WarmPoolStatus | undefined; } /** * @public */ -export interface ListTrainingJobsResponse { +export interface ListNotebookInstanceLifecycleConfigsOutput { /** - *An array of TrainingJobSummary objects, each listing a training
- * job.
If the response is truncated, SageMaker returns this token. To get the next + * set of lifecycle configurations, use it in the next request.
* @public */ - TrainingJobSummaries: TrainingJobSummary[] | undefined; + NextToken?: string | undefined; /** - *If the response is truncated, SageMaker returns this token. To retrieve the next set of - * training jobs, use it in the subsequent request.
+ *An array of NotebookInstanceLifecycleConfiguration objects, each listing
+ * a lifecycle configuration.
The name of the tuning job whose training jobs you want to list.
- * @public - */ - HyperParameterTuningJobName: string | undefined; +export const NotebookInstanceSortOrder = { + ASCENDING: "Ascending", + DESCENDING: "Descending", +} as const; + +/** + * @public + */ +export type NotebookInstanceSortOrder = (typeof NotebookInstanceSortOrder)[keyof typeof NotebookInstanceSortOrder]; +/** + * @public + */ +export interface ListNotebookInstancesInput { /** - *If the result of the previous ListTrainingJobsForHyperParameterTuningJob
- * request was truncated, the response includes a NextToken. To retrieve the
- * next set of training jobs, use the token in the next request.
If the previous call to the ListNotebookInstances is truncated, the
+ * response includes a NextToken. You can use this token in your subsequent
+ * ListNotebookInstances request to fetch the next set of notebook
+ * instances.
You might specify a filter or a sort order in your request. When response is + * truncated, you must use the same values for the filer and sort order in the next + * request.
+ *The maximum number of training jobs to return. The default value is 10.
+ *The maximum number of notebook instances to return.
* @public */ MaxResults?: number | undefined; - /** - *A filter that returns only training jobs with the specified status.
- * @public - */ - StatusEquals?: TrainingJobStatus | undefined; - /** *The field to sort results by. The default is Name.
If the value of this field is FinalObjectiveMetricValue, any training
- * jobs that did not return an objective metric are not listed.
The sort order for results. The default is Ascending.
The sort order for results.
* @public */ - SortOrder?: SortOrder | undefined; -} + SortOrder?: NotebookInstanceSortOrder | undefined; -/** - * @public - */ -export interface ListTrainingJobsForHyperParameterTuningJobResponse { /** - *A list of TrainingJobSummary objects that
- * describe
- * the training jobs that the
- * ListTrainingJobsForHyperParameterTuningJob request returned.
A string in the notebook instances' name. This filter returns only notebook + * instances whose name contains the specified string.
* @public */ - TrainingJobSummaries: HyperParameterTrainingJobSummary[] | undefined; + NameContains?: string | undefined; /** - *If the result of this ListTrainingJobsForHyperParameterTuningJob request
- * was truncated, the response includes a NextToken. To retrieve the next set
- * of training jobs, use the token in the next request.
A filter that returns only notebook instances that were created before the + * specified time (timestamp).
* @public */ - NextToken?: string | undefined; -} + CreationTimeBefore?: Date | undefined; -/** - * @public - */ -export interface ListTransformJobsRequest { /** - *A filter that returns only transform jobs created after the specified time.
+ *A filter that returns only notebook instances that were created after the specified + * time (timestamp).
* @public */ CreationTimeAfter?: Date | undefined; /** - *A filter that returns only transform jobs created before the specified time.
+ *A filter that returns only notebook instances that were modified before the + * specified time (timestamp).
* @public */ - CreationTimeBefore?: Date | undefined; + LastModifiedTimeBefore?: Date | undefined; /** - *A filter that returns only transform jobs modified after the specified time.
+ *A filter that returns only notebook instances that were modified after the + * specified time (timestamp).
* @public */ LastModifiedTimeAfter?: Date | undefined; /** - *A filter that returns only transform jobs modified before the specified time.
+ *A filter that returns only notebook instances with the specified status.
* @public */ - LastModifiedTimeBefore?: Date | undefined; + StatusEquals?: NotebookInstanceStatus | undefined; /** - *A string in the transform job name. This filter returns only transform jobs whose name - * contains the specified string.
+ *A string in the name of a notebook instances lifecycle configuration associated with + * this notebook instance. This filter returns only notebook instances associated with a + * lifecycle configuration with a name that contains the specified string.
* @public */ - NameContains?: string | undefined; + NotebookInstanceLifecycleConfigNameContains?: string | undefined; /** - *A filter that retrieves only transform jobs with a specific status.
+ *A string in the name or URL of a Git repository associated with this notebook + * instance. This filter returns only notebook instances associated with a git repository + * with a name that contains the specified string.
* @public */ - StatusEquals?: TransformJobStatus | undefined; + DefaultCodeRepositoryContains?: string | undefined; /** - *The field to sort results by. The default is CreationTime.
A filter that returns only notebook instances with associated with the specified git + * repository.
* @public */ - SortBy?: SortBy | undefined; + AdditionalCodeRepositoryEquals?: string | undefined; +} +/** + *Provides summary information for an SageMaker notebook instance.
+ * @public + */ +export interface NotebookInstanceSummary { /** - *The sort order for results. The default is Descending.
The name of the notebook instance that you want a summary for.
* @public */ - SortOrder?: SortOrder | undefined; + NotebookInstanceName: string | undefined; /** - *If the result of the previous ListTransformJobs request was truncated,
- * the response includes a NextToken. To retrieve the next set of transform
- * jobs, use the token in the next request.
The Amazon Resource Name (ARN) of the notebook instance.
* @public */ - NextToken?: string | undefined; + NotebookInstanceArn: string | undefined; /** - *The maximum number of transform jobs to return in the response. The default value is 10.
The status of the notebook instance.
* @public */ - MaxResults?: number | undefined; -} + NotebookInstanceStatus?: NotebookInstanceStatus | undefined; -/** - *Provides a
- * summary
- * of a transform job. Multiple TransformJobSummary objects are returned as a
- * list after in response to a ListTransformJobs call.
The name of the transform job.
+ *The URL that you use to connect to the Jupyter notebook running in your notebook + * instance.
* @public */ - TransformJobName: string | undefined; + Url?: string | undefined; /** - *The Amazon Resource Name (ARN) of the transform job.
+ *The type of ML compute instance that the notebook instance is running on.
* @public */ - TransformJobArn: string | undefined; + InstanceType?: _InstanceType | undefined; /** - *A timestamp that shows when the transform Job was created.
+ *A timestamp that shows when the notebook instance was created.
* @public */ - CreationTime: Date | undefined; + CreationTime?: Date | undefined; /** - *Indicates when the transform - * job - * ends on compute instances. For successful jobs and stopped jobs, this - * is the exact time - * recorded - * after the results are uploaded. For failed jobs, this is when Amazon SageMaker - * detected that the job failed.
+ *A timestamp that shows when the notebook instance was last modified.
* @public */ - TransformEndTime?: Date | undefined; + LastModifiedTime?: Date | undefined; /** - *Indicates when the transform job was last modified.
+ *The name of a notebook instance lifecycle configuration associated with this notebook + * instance.
+ *For information about notebook instance lifestyle configurations, see Step + * 2.1: (Optional) Customize a Notebook Instance.
* @public */ - LastModifiedTime?: Date | undefined; + NotebookInstanceLifecycleConfigName?: string | undefined; /** - *The status of the transform job.
+ *The Git repository associated with the notebook instance as its default code + * repository. This can be either the name of a Git repository stored as a resource in your + * account, or the URL of a Git repository in Amazon Web Services CodeCommit + * or in any other Git repository. When you open a notebook instance, it opens in the + * directory that contains this repository. For more information, see Associating Git + * Repositories with SageMaker Notebook Instances.
* @public */ - TransformJobStatus: TransformJobStatus | undefined; + DefaultCodeRepository?: string | undefined; /** - *If the transform job failed, - * the - * reason it failed.
+ *An array of up to three Git repositories associated with the notebook instance. These + * can be either the names of Git repositories stored as resources in your account, or the + * URL of Git repositories in Amazon Web Services CodeCommit + * or in any other Git repository. These repositories are cloned at the same level as the + * default repository of your notebook instance. For more information, see Associating Git + * Repositories with SageMaker Notebook Instances.
* @public */ - FailureReason?: string | undefined; + AdditionalCodeRepositories?: string[] | undefined; } /** * @public */ -export interface ListTransformJobsResponse { +export interface ListNotebookInstancesOutput { /** - *An array of
- * TransformJobSummary
- * objects.
If the response to the previous ListNotebookInstances request was
+ * truncated, SageMaker returns this token. To retrieve the next set of notebook
+ * instances, use the token in the next request.
If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of - * transform jobs, use it in the next request.
+ *An array of NotebookInstanceSummary objects, one for each notebook
+ * instance.
A filter that returns only components that are part of the specified experiment. If you
- * specify ExperimentName, you can't filter by SourceArn or
- * TrialName.
A token that you use to get the next set of results following a truncated response. If + * the response to the previous request was truncated, that response provides the value for + * this token.
* @public */ - ExperimentName?: string | undefined; + NextToken?: string | undefined; /** - *A filter that returns only components that are part of the specified trial. If you specify
- * TrialName, you can't filter by ExperimentName or
- * SourceArn.
The maximum number of optimization jobs to return in the response. The default is + * 50.
* @public */ - TrialName?: string | undefined; + MaxResults?: number | undefined; /** - *A filter that returns only components that have the specified source Amazon Resource Name (ARN).
- * If you specify SourceArn, you can't filter by ExperimentName
- * or TrialName.
Filters the results to only those optimization jobs that were created after the + * specified time.
* @public */ - SourceArn?: string | undefined; + CreationTimeAfter?: Date | undefined; /** - *A filter that returns only components created after the specified time.
+ *Filters the results to only those optimization jobs that were created before the + * specified time.
* @public */ - CreatedAfter?: Date | undefined; + CreationTimeBefore?: Date | undefined; /** - *A filter that returns only components created before the specified time.
+ *Filters the results to only those optimization jobs that were updated after the + * specified time.
* @public */ - CreatedBefore?: Date | undefined; + LastModifiedTimeAfter?: Date | undefined; /** - *The property used to sort results. The default value is CreationTime.
Filters the results to only those optimization jobs that were updated before the + * specified time.
* @public */ - SortBy?: SortTrialComponentsBy | undefined; + LastModifiedTimeBefore?: Date | undefined; /** - *The sort order. The default value is Descending.
Filters the results to only those optimization jobs that apply the specified
+ * optimization techniques. You can specify either Quantization or
+ * Compilation.
The maximum number of components to return in the response. The default value is - * 10.
+ *Filters the results to only those optimization jobs with a name that contains the + * specified string.
* @public */ - MaxResults?: number | undefined; + NameContains?: string | undefined; /** - *If the previous call to ListTrialComponents didn't return the full set of
- * components, the call returns a token for getting the next set of components.
Filters the results to only those optimization jobs with the specified status.
* @public */ - NextToken?: string | undefined; -} + StatusEquals?: OptimizationJobStatus | undefined; -/** - *A summary of the properties of a trial component. To get all the properties, call the
- * DescribeTrialComponent API and provide the
- * TrialComponentName.
The name of the trial component.
+ *The field by which to sort the optimization jobs in the response. The default is
+ * CreationTime
+ *
The Amazon Resource Name (ARN) of the trial component.
+ *The sort order for results. The default is Ascending
+ *
Summarizes an optimization job by providing some of its key properties.
+ * @public + */ +export interface OptimizationJobSummary { /** - *The name of the component as displayed. If DisplayName isn't specified,
- * TrialComponentName is displayed.
The name that you assigned to the optimization job.
* @public */ - DisplayName?: string | undefined; + OptimizationJobName: string | undefined; /** - *The Amazon Resource Name (ARN) and job type of the source of a trial component.
+ *The Amazon Resource Name (ARN) of the optimization job.
* @public */ - TrialComponentSource?: TrialComponentSource | undefined; + OptimizationJobArn: string | undefined; /** - *The status of the component. States include:
- *InProgress
- *Completed
- *Failed
- *The time when you created the optimization job.
* @public */ - Status?: TrialComponentStatus | undefined; + CreationTime: Date | undefined; /** - *When the component started.
+ *The current status of the optimization job.
* @public */ - StartTime?: Date | undefined; + OptimizationJobStatus: OptimizationJobStatus | undefined; /** - *When the component ended.
+ *The time when the optimization job started.
* @public */ - EndTime?: Date | undefined; + OptimizationStartTime?: Date | undefined; /** - *When the component was created.
+ *The time when the optimization job finished processing.
* @public */ - CreationTime?: Date | undefined; + OptimizationEndTime?: Date | undefined; /** - *Who created the trial component.
+ *The time when the optimization job was last updated.
* @public */ - CreatedBy?: UserContext | undefined; + LastModifiedTime?: Date | undefined; /** - *When the component was last modified.
+ *The type of instance that hosts the optimized model that you create with the optimization job.
* @public */ - LastModifiedTime?: Date | undefined; + DeploymentInstanceType: OptimizationJobDeploymentInstanceType | undefined; /** - *Who last modified the component.
+ *The optimization techniques that are applied by the optimization job.
* @public */ - LastModifiedBy?: UserContext | undefined; + OptimizationTypes: string[] | undefined; } /** * @public */ -export interface ListTrialComponentsResponse { +export interface ListOptimizationJobsResponse { /** - *A list of the summaries of your trial components.
+ *A list of optimization jobs and their properties that matches any of the filters you + * specified in the request.
* @public */ - TrialComponentSummaries?: TrialComponentSummary[] | undefined; + OptimizationJobSummaries: OptimizationJobSummary[] | undefined; /** - *A token for getting the next set of components, if there are any.
+ *The token to use in a subsequent request to get the next set of results following a + * truncated response.
* @public */ NextToken?: string | undefined; } -/** - * @public - * @enum - */ -export const SortTrialsBy = { - CREATION_TIME: "CreationTime", - NAME: "Name", -} as const; - -/** - * @public - */ -export type SortTrialsBy = (typeof SortTrialsBy)[keyof typeof SortTrialsBy]; - /** * @public */ -export interface ListTrialsRequest { - /** - *A filter that returns only trials that are part of the specified experiment.
- * @public - */ - ExperimentName?: string | undefined; - - /** - *A filter that returns only trials that are associated with the specified trial - * component.
- * @public - */ - TrialComponentName?: string | undefined; - +export interface ListPartnerAppsRequest { /** - *A filter that returns only trials created after the specified time.
- * @public - */ - CreatedAfter?: Date | undefined; - - /** - *A filter that returns only trials created before the specified time.
- * @public - */ - CreatedBefore?: Date | undefined; - - /** - *The property used to sort results. The default value is CreationTime.
The sort order. The default value is Descending.
The maximum number of trials to return in the response. The default value is 10.
+ *This parameter defines the maximum number of results that can be returned in a single
+ * response. The MaxResults parameter is an upper bound, not a target. If there are
+ * more results available than the value specified, a NextToken is provided in the
+ * response. The NextToken indicates that the user should get the next set of
+ * results by providing this token as a part of a subsequent call. The default value for
+ * MaxResults is 10.
If the previous call to ListTrials didn't return the full set of trials, the
- * call returns a token for getting the next set of trials.
If the previous response was truncated, you will receive this token. Use it in your next + * request to receive the next set of results.
* @public */ NextToken?: string | undefined; } /** - *A summary of the properties of a trial. To get the complete set of properties, call the
- * DescribeTrial API and provide the TrialName.
A subset of information related to a SageMaker Partner AI App. This information is used as part of the ListPartnerApps API response.
The Amazon Resource Name (ARN) of the trial.
+ *The ARN of the SageMaker Partner AI App.
* @public */ - TrialArn?: string | undefined; + Arn?: string | undefined; /** - *The name of the trial.
+ *The name of the SageMaker Partner AI App.
* @public */ - TrialName?: string | undefined; + Name?: string | undefined; /** - *The name of the trial as displayed. If DisplayName isn't specified,
- * TrialName is displayed.
The type of SageMaker Partner AI App to create. Must be one of the following: lakera-guard, comet, deepchecks-llm-evaluation, or fiddler.
The source of the trial.
+ *The status of the SageMaker Partner AI App.
* @public */ - TrialSource?: TrialSource | undefined; + Status?: PartnerAppStatus | undefined; /** - *When the trial was created.
+ *The creation time of the SageMaker Partner AI App.
* @public */ CreationTime?: Date | undefined; - - /** - *When the trial was last modified.
- * @public - */ - LastModifiedTime?: Date | undefined; } /** * @public */ -export interface ListTrialsResponse { +export interface ListPartnerAppsResponse { /** - *A list of the summaries of your trials.
+ *The information related to each of the SageMaker Partner AI Apps in an account.
* @public */ - TrialSummaries?: TrialSummary[] | undefined; + Summaries?: PartnerAppSummary[] | undefined; /** - *A token for getting the next set of trials, if there are any.
+ *If the previous response was truncated, you will receive this token. Use it in your next + * request to receive the next set of results.
* @public */ NextToken?: string | undefined; @@ -5096,5045 +4710,5994 @@ export interface ListTrialsResponse { * @public * @enum */ -export const UserProfileSortKey = { - CreationTime: "CreationTime", - LastModifiedTime: "LastModifiedTime", +export const SortPipelineExecutionsBy = { + CREATION_TIME: "CreationTime", + PIPELINE_EXECUTION_ARN: "PipelineExecutionArn", } as const; /** * @public */ -export type UserProfileSortKey = (typeof UserProfileSortKey)[keyof typeof UserProfileSortKey]; +export type SortPipelineExecutionsBy = (typeof SortPipelineExecutionsBy)[keyof typeof SortPipelineExecutionsBy]; /** * @public */ -export interface ListUserProfilesRequest { +export interface ListPipelineExecutionsRequest { /** - *If the previous response was truncated, you will receive this token. Use it in your next - * request to receive the next set of results.
+ *The name or Amazon Resource Name (ARN) of the pipeline.
* @public */ - NextToken?: string | undefined; + PipelineName: string | undefined; /** - *This parameter defines the maximum number of results that can be return in a single
- * response. The MaxResults parameter is an upper bound, not a target. If there are
- * more results available than the value specified, a NextToken is provided in the
- * response. The NextToken indicates that the user should get the next set of
- * results by providing this token as a part of a subsequent call. The default value for
- * MaxResults is 10.
A filter that returns the pipeline executions that were created after a specified + * time.
* @public */ - MaxResults?: number | undefined; + CreatedAfter?: Date | undefined; /** - *The sort order for the results. The default is Ascending.
+ *A filter that returns the pipeline executions that were created before a specified + * time.
* @public */ - SortOrder?: SortOrder | undefined; + CreatedBefore?: Date | undefined; /** - *The parameter by which to sort the results. The default is CreationTime.
+ *The field by which to sort results. The default is CreatedTime.
A parameter by which to filter the results.
+ *The sort order for results.
* @public */ - DomainIdEquals?: string | undefined; + SortOrder?: SortOrder | undefined; /** - *A parameter by which to filter the results.
+ *If the result of the previous ListPipelineExecutions request was truncated,
+ * the response includes a NextToken. To retrieve the next set of pipeline executions, use the token in the next request.
The maximum number of pipeline executions to return in the response.
+ * @public + */ + MaxResults?: number | undefined; } /** - *The user profile details.
+ *A pipeline execution summary.
* @public */ -export interface UserProfileDetails { +export interface PipelineExecutionSummary { /** - *The domain ID.
+ *The Amazon Resource Name (ARN) of the pipeline execution.
* @public */ - DomainId?: string | undefined; + PipelineExecutionArn?: string | undefined; /** - *The user profile name.
+ *The start time of the pipeline execution.
* @public */ - UserProfileName?: string | undefined; + StartTime?: Date | undefined; /** - *The status.
+ *The status of the pipeline execution.
* @public */ - Status?: UserProfileStatus | undefined; + PipelineExecutionStatus?: PipelineExecutionStatus | undefined; /** - *The creation time.
+ *The description of the pipeline execution.
* @public */ - CreationTime?: Date | undefined; + PipelineExecutionDescription?: string | undefined; /** - *The last modified time.
+ *The display name of the pipeline execution.
* @public */ - LastModifiedTime?: Date | undefined; + PipelineExecutionDisplayName?: string | undefined; + + /** + *A message generated by SageMaker Pipelines describing why the pipeline execution failed.
+ * @public + */ + PipelineExecutionFailureReason?: string | undefined; } /** * @public */ -export interface ListUserProfilesResponse { +export interface ListPipelineExecutionsResponse { /** - *The list of user profiles.
+ *Contains a sorted list of pipeline execution summary objects matching the specified + * filters. Each run summary includes the Amazon Resource Name (ARN) of the pipeline execution, the run date, + * and the status. This list can be empty.
* @public */ - UserProfiles?: UserProfileDetails[] | undefined; + PipelineExecutionSummaries?: PipelineExecutionSummary[] | undefined; /** - *If the previous response was truncated, you will receive this token. Use it in your next - * request to receive the next set of results.
+ *If the result of the previous ListPipelineExecutions request was truncated,
+ * the response includes a NextToken. To retrieve the next set of pipeline executions, use the token in the next request.
Sort workforces using the workforce name or creation date.
- * @public - */ - SortBy?: ListWorkforcesSortByOptions | undefined; - +export interface ListPipelineExecutionStepsRequest { /** - *Sort workforces in ascending or descending order.
+ *The Amazon Resource Name (ARN) of the pipeline execution.
* @public */ - SortOrder?: SortOrder | undefined; + PipelineExecutionArn?: string | undefined; /** - *A filter you can use to search for workforces using part of the workforce name.
+ *If the result of the previous ListPipelineExecutionSteps request was truncated,
+ * the response includes a NextToken. To retrieve the next set of pipeline execution steps, use the token in the next request.
A token to resume pagination.
+ *The maximum number of pipeline execution steps to return in the response.
* @public */ - NextToken?: string | undefined; + MaxResults?: number | undefined; /** - *The maximum number of workforces returned in the response.
+ *The field by which to sort results. The default is CreatedTime.
Metadata for Model steps.
* @public */ -export interface ListWorkforcesResponse { - /** - *A list containing information about your workforce.
- * @public - */ - Workforces: Workforce[] | undefined; - +export interface ModelStepMetadata { /** - *A token to resume pagination.
+ *The Amazon Resource Name (ARN) of the created model.
* @public */ - NextToken?: string | undefined; + Arn?: string | undefined; } /** - * @public - * @enum - */ -export const ListWorkteamsSortByOptions = { - CreateDate: "CreateDate", - Name: "Name", -} as const; - -/** + *Metadata for a processing job step.
* @public */ -export type ListWorkteamsSortByOptions = (typeof ListWorkteamsSortByOptions)[keyof typeof ListWorkteamsSortByOptions]; +export interface ProcessingJobStepMetadata { + /** + *The Amazon Resource Name (ARN) of the processing job.
+ * @public + */ + Arn?: string | undefined; +} /** + *Container for the metadata for a Quality check step. For more information, see + * the topic on QualityCheck step in the Amazon SageMaker Developer Guide. + *
* @public */ -export interface ListWorkteamsRequest { +export interface QualityCheckStepMetadata { /** - *The field to sort results by. The default is CreationTime.
The type of the Quality check step.
* @public */ - SortBy?: ListWorkteamsSortByOptions | undefined; + CheckType?: string | undefined; /** - *The sort order for results. The default is Ascending.
The Amazon S3 URI of the baseline statistics file used for the drift check.
* @public */ - SortOrder?: SortOrder | undefined; + BaselineUsedForDriftCheckStatistics?: string | undefined; /** - *A string in the work team's name. This filter returns only work teams whose name - * contains the specified string.
+ *The Amazon S3 URI of the baseline constraints file used for the drift check.
* @public */ - NameContains?: string | undefined; + BaselineUsedForDriftCheckConstraints?: string | undefined; /** - *If the result of the previous ListWorkteams request was truncated, the
- * response includes a NextToken. To retrieve the next set of labeling jobs,
- * use the token in the next request.
The Amazon S3 URI of the newly calculated baseline statistics file.
* @public */ - NextToken?: string | undefined; + CalculatedBaselineStatistics?: string | undefined; /** - *The maximum number of work teams to return in each page of the response.
+ *The Amazon S3 URI of the newly calculated baseline constraints file.
* @public */ - MaxResults?: number | undefined; -} + CalculatedBaselineConstraints?: string | undefined; -/** - * @public - */ -export interface ListWorkteamsResponse { /** - *An array of Workteam objects, each describing a work team.
The model package group name.
* @public */ - Workteams: Workteam[] | undefined; + ModelPackageGroupName?: string | undefined; /** - *If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of - * work teams, use it in the subsequent request.
+ *The Amazon S3 URI of violation report if violations are detected.
* @public */ - NextToken?: string | undefined; -} + ViolationReport?: string | undefined; -/** - *The properties of a model as returned by the Search API.
- * @public - */ -export interface Model { /** - *The name of the model.
+ *The Amazon Resource Name (ARN) of the Quality check processing job that was run by this step execution.
* @public */ - ModelName?: string | undefined; + CheckJobArn?: string | undefined; /** - *Describes the container, as part of model definition.
+ *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.
The containers in the inference pipeline.
+ *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 and
+ * BaselineUsedForDriftCheckStatistics properties.
Metadata for a register model job step.
+ * @public + */ +export interface RegisterModelStepMetadata { /** - *Specifies details about how containers in a multi-container endpoint are run.
+ *The Amazon Resource Name (ARN) of the model package.
* @public */ - InferenceExecutionConfig?: InferenceExecutionConfig | undefined; + Arn?: string | undefined; +} +/** + *Metadata for a training job step.
+ * @public + */ +export interface TrainingJobStepMetadata { /** - *The Amazon Resource Name (ARN) of the IAM role that you specified for the - * model.
+ *The Amazon Resource Name (ARN) of the training job that was run by this step execution.
* @public */ - ExecutionRoleArn?: string | undefined; + Arn?: string | undefined; +} +/** + *Metadata for a transform job step.
+ * @public + */ +export interface TransformJobStepMetadata { /** - *Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources - * have access to. You can control access to and from your resources by configuring a VPC. - * For more information, see Give SageMaker Access to - * Resources in your Amazon VPC.
+ *The Amazon Resource Name (ARN) of the transform job that was run by this step execution.
* @public */ - VpcConfig?: VpcConfig | undefined; + Arn?: string | undefined; +} +/** + *Metadata for a tuning step.
+ * @public + */ +export interface TuningJobStepMetaData { /** - *A timestamp that indicates when the model was created.
+ *The Amazon Resource Name (ARN) of the tuning job that was run by this step execution.
* @public */ - CreationTime?: Date | undefined; + Arn?: string | undefined; +} +/** + *Metadata for a step execution.
+ * @public + */ +export interface PipelineExecutionStepMetadata { /** - *The Amazon Resource Name (ARN) of the model.
+ *The Amazon Resource Name (ARN) of the training job that was run by this step execution.
* @public */ - ModelArn?: string | undefined; + TrainingJob?: TrainingJobStepMetadata | undefined; /** - *Isolates the model container. No inbound or outbound network calls can be made to or - * from the model container.
+ *The Amazon Resource Name (ARN) of the processing job that was run by this step execution.
* @public */ - EnableNetworkIsolation?: boolean | undefined; + ProcessingJob?: ProcessingJobStepMetadata | 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.
+ *The Amazon Resource Name (ARN) of the transform job that was run by this step execution.
* @public */ - Tags?: Tag[] | undefined; + TransformJob?: TransformJobStepMetadata | undefined; /** - *A set of recommended deployment configurations for the model.
+ *The Amazon Resource Name (ARN) of the tuning job that was run by this step execution.
* @public */ - DeploymentRecommendation?: DeploymentRecommendation | undefined; -} + TuningJob?: TuningJobStepMetaData | undefined; -/** - *An Amazon SageMaker Model Card.
- * @public - */ -export interface ModelCard { /** - *The Amazon Resource Name (ARN) of the model card.
+ *The Amazon Resource Name (ARN) of the model that was created by this step execution.
* @public */ - ModelCardArn?: string | undefined; + Model?: ModelStepMetadata | undefined; /** - *The unique name of the model card.
+ *The Amazon Resource Name (ARN) of the model package that the model was registered to by this step execution.
* @public */ - ModelCardName?: string | undefined; + RegisterModel?: RegisterModelStepMetadata | undefined; /** - *The version of the model card.
+ *The outcome of the condition evaluation that was run by this step execution.
* @public */ - ModelCardVersion?: number | undefined; + Condition?: ConditionStepMetadata | undefined; /** - *The content of the model card. Content uses the model card JSON schema and provided as a string.
+ *The URL of the Amazon SQS queue used by this step execution, the pipeline generated token, + * and a list of output parameters.
* @public */ - Content?: string | undefined; + Callback?: CallbackStepMetadata | undefined; /** - *The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.
+ *The Amazon Resource Name (ARN) of the Lambda function that was run by this step execution and a list of + * output parameters.
+ * @public + */ + Lambda?: LambdaStepMetadata | undefined; + + /** + *The configurations and outcomes of an Amazon EMR step execution.
+ * @public + */ + EMR?: EMRStepMetadata | undefined; + + /** + *The configurations and outcomes of the check step execution. This includes:
*
- * Draft: The model card is a work in progress.
The type of the check conducted.
*
- * PendingReview: The model card is pending review.
The Amazon S3 URIs of baseline constraints and statistics files to be used for the drift check.
*
- * Approved: The model card is approved.
The Amazon S3 URIs of newly calculated baseline constraints and statistics.
*
- * Archived: The model card is archived. No more updates should be made to the model
- * card, but it can still be exported.
The model package group name provided.
+ *The Amazon S3 URI of the violation report if violations detected.
+ *The Amazon Resource Name (ARN) of check processing job initiated by the step execution.
+ *The Boolean flags indicating if the drift check is skipped.
+ *If step property BaselineUsedForDriftCheck is set the same as
+ * CalculatedBaseline.
The security configuration used to protect model card data.
+ *Container for the metadata for a Clarify check step. The configurations + * and outcomes of the check step execution. This includes:
+ *The type of the check conducted,
+ *The Amazon S3 URIs of baseline constraints and statistics files to be used for the drift check.
+ *The Amazon S3 URIs of newly calculated baseline constraints and statistics.
+ *The model package group name provided.
+ *The Amazon S3 URI of the violation report if violations detected.
+ *The Amazon Resource Name (ARN) of check processing job initiated by the step execution.
+ *The boolean flags indicating if the drift check is skipped.
+ *If step property BaselineUsedForDriftCheck is set the same as
+ * CalculatedBaseline.
The date and time that the model card was created.
+ *The configurations and outcomes of a Fail step execution.
* @public */ - CreationTime?: Date | undefined; + Fail?: FailStepMetadata | undefined; /** - *Information about the user who created or modified an experiment, trial, trial - * component, lineage group, project, or model card.
+ *The Amazon Resource Name (ARN) of the AutoML job that was run by this step.
* @public */ - CreatedBy?: UserContext | undefined; + AutoMLJob?: AutoMLJobStepMetadata | undefined; /** - *The date and time that the model card was last modified.
+ *The endpoint that was invoked during this step execution.
* @public */ - LastModifiedTime?: Date | undefined; + Endpoint?: EndpointStepMetadata | undefined; /** - *Information about the user who created or modified an experiment, trial, trial - * component, lineage group, project, or model card.
+ *The endpoint configuration used to create an endpoint during this step execution.
* @public */ - LastModifiedBy?: UserContext | undefined; + EndpointConfig?: EndpointConfigStepMetadata | undefined; +} +/** + *The ARN from an execution of the current pipeline.
+ * @public + */ +export interface SelectiveExecutionResult { /** - *Key-value pairs used to manage metadata for the model card.
+ *The ARN from an execution of the current pipeline.
* @public */ - Tags?: Tag[] | undefined; + SourcePipelineExecutionArn?: string | undefined; +} - /** - *The unique name (ID) of the model.
- * @public - */ - ModelId?: string | undefined; +/** + * @public + * @enum + */ +export const StepStatus = { + EXECUTING: "Executing", + FAILED: "Failed", + STARTING: "Starting", + STOPPED: "Stopped", + STOPPING: "Stopping", + SUCCEEDED: "Succeeded", +} as const; + +/** + * @public + */ +export type StepStatus = (typeof StepStatus)[keyof typeof StepStatus]; +/** + *An execution of a step in a pipeline.
+ * @public + */ +export interface PipelineExecutionStep { /** - *The risk rating of the model. Different organizations might have different criteria for model card risk ratings. For more information, see Risk ratings.
+ *The name of the step that is executed.
* @public */ - RiskRating?: string | undefined; + StepName?: string | undefined; /** - *The model package group that contains the model package. Only relevant for model cards created for model packages in the Amazon SageMaker Model Registry. - *
+ *The display name of the step.
* @public */ - ModelPackageGroupName?: string | undefined; -} + StepDisplayName?: string | undefined; -/** - *An endpoint that hosts a model displayed in the Amazon SageMaker Model Dashboard.
- * @public - */ -export interface ModelDashboardEndpoint { /** - *The endpoint name.
+ *The description of the step.
* @public */ - EndpointName: string | undefined; + StepDescription?: string | undefined; /** - *The Amazon Resource Name (ARN) of the endpoint.
+ *The time that the step started executing.
* @public */ - EndpointArn: string | undefined; + StartTime?: Date | undefined; /** - *A timestamp that indicates when the endpoint was created.
+ *The time that the step stopped executing.
* @public */ - CreationTime: Date | undefined; + EndTime?: Date | undefined; /** - *The last time the endpoint was modified.
+ *The status of the step execution.
* @public */ - LastModifiedTime: Date | undefined; + StepStatus?: StepStatus | undefined; /** - *The endpoint status.
+ *If this pipeline execution step was cached, details on the cache hit.
* @public */ - EndpointStatus: EndpointStatus | undefined; -} + CacheHitResult?: CacheHitResult | undefined; -/** - *A batch transform job. For information about SageMaker batch transform, see Use Batch - * Transform.
- * @public - */ -export interface TransformJob { /** - *The name of the transform job.
+ *The reason why the step failed execution. This is only returned if the step failed its execution.
* @public */ - TransformJobName?: string | undefined; + FailureReason?: string | undefined; /** - *The Amazon Resource Name (ARN) of the transform job.
+ *Metadata to run the pipeline step.
* @public */ - TransformJobArn?: string | undefined; + Metadata?: PipelineExecutionStepMetadata | undefined; /** - *The status of the transform job.
- *Transform job statuses are:
- *
- * InProgress - The job is in progress.
- * Completed - The job has completed.
- * Failed - The transform job has failed. To see the reason for the failure,
- * see the FailureReason field in the response to a
- * DescribeTransformJob call.
- * Stopping - The transform job is stopping.
- * Stopped - The transform job has stopped.
The current attempt of the execution step. For more information, see Retry Policy for SageMaker Pipelines steps.
* @public */ - TransformJobStatus?: TransformJobStatus | undefined; + AttemptCount?: number | undefined; /** - *If the transform job failed, the reason it failed.
+ *The ARN from an execution of the current pipeline from which + * results are reused for this step.
* @public */ - FailureReason?: string | undefined; + SelectiveExecutionResult?: SelectiveExecutionResult | undefined; +} +/** + * @public + */ +export interface ListPipelineExecutionStepsResponse { /** - *The name of the model associated with the transform job.
+ *A list of PipeLineExecutionStep objects. Each
+ * PipeLineExecutionStep consists of StepName, StartTime, EndTime, StepStatus,
+ * and Metadata. Metadata is an object with properties for each job that contains relevant
+ * information about the job created by the step.
The maximum number of parallel requests that can be sent to each instance in a transform
- * job. If MaxConcurrentTransforms is set to 0 or left unset, SageMaker checks the
- * optional execution-parameters to determine the settings for your chosen algorithm. If the
- * execution-parameters endpoint is not enabled, the default value is 1. For built-in algorithms,
- * you don't need to set a value for MaxConcurrentTransforms.
If the result of the previous ListPipelineExecutionSteps request was truncated,
+ * the response includes a NextToken. To retrieve the next set of pipeline execution steps, use the token in the next request.
Configures the timeout and maximum number of retries for processing a transform job - * invocation.
+ *The Amazon Resource Name (ARN) of the pipeline execution.
* @public */ - ModelClientConfig?: ModelClientConfig | undefined; + PipelineExecutionArn: string | undefined; /** - *The maximum allowed size of the payload, in MB. A payload is the data portion of a record
- * (without metadata). The value in MaxPayloadInMB must be greater than, or equal
- * to, the size of a single record. To estimate the size of a record in MB, divide the size of
- * your dataset by the number of records. To ensure that the records fit within the maximum
- * payload size, we recommend using a slightly larger value. The default value is 6 MB. For cases
- * where the payload might be arbitrarily large and is transmitted using HTTP chunked encoding,
- * set the value to 0. This feature works only in supported algorithms. Currently, SageMaker built-in
- * algorithms do not support HTTP chunked encoding.
If the result of the previous ListPipelineParametersForExecution request was truncated,
+ * the response includes a NextToken. To retrieve the next set of parameters, use the token in the next request.
Specifies the number of records to include in a mini-batch for an HTTP inference request. - * A record is a single unit of input data that inference can be made on. For example, a single - * line in a CSV file is a record.
+ *The maximum number of parameters to return in the response.
* @public */ - BatchStrategy?: BatchStrategy | undefined; + MaxResults?: number | undefined; +} +/** + *Assigns a value to a named Pipeline parameter.
+ * @public + */ +export interface Parameter { /** - *The environment variables to set in the Docker container. We support up to 16 key and - * values entries in the map.
+ *The name of the parameter to assign a value to. This + * parameter name must match a named parameter in the + * pipeline definition.
* @public */ - Environment?: RecordDescribes the input source of a transform job and the way the transform job consumes - * it.
+ *The literal value for the parameter.
* @public */ - TransformInput?: TransformInput | undefined; + Value: string | undefined; +} +/** + * @public + */ +export interface ListPipelineParametersForExecutionResponse { /** - *Describes the results of a transform job.
+ *Contains a list of pipeline parameters. This list can be empty.
* @public */ - TransformOutput?: TransformOutput | undefined; + PipelineParameters?: Parameter[] | undefined; /** - *Configuration to control how SageMaker captures inference data for batch transform jobs.
+ *If the result of the previous ListPipelineParametersForExecution request was truncated,
+ * the response includes a NextToken. To retrieve the next set of parameters, use the token in the next request.
Describes the resources, including ML instance types and ML instance count, to use for - * transform job.
+ *The prefix of the pipeline name.
* @public */ - TransformResources?: TransformResources | undefined; + PipelineNamePrefix?: string | undefined; /** - *A timestamp that shows when the transform Job was created.
+ *A filter that returns the pipelines that were created after a specified + * time.
* @public */ - CreationTime?: Date | undefined; + CreatedAfter?: Date | undefined; /** - *Indicates when the transform job starts on ML instances. You are billed for the time
- * interval between this time and the value of TransformEndTime.
A filter that returns the pipelines that were created before a specified + * time.
* @public */ - TransformStartTime?: Date | undefined; + CreatedBefore?: Date | undefined; /** - *Indicates when the transform job has been completed, or has stopped or failed. You are
- * billed for the time interval between this time and the value of
- * TransformStartTime.
The field by which to sort results. The default is CreatedTime.
The Amazon Resource Name (ARN) of the labeling job that created the transform job.
+ *The sort order for results.
* @public */ - LabelingJobArn?: string | undefined; + SortOrder?: SortOrder | undefined; /** - *The Amazon Resource Name (ARN) of the AutoML job that created the transform job.
+ *If the result of the previous ListPipelines request was truncated,
+ * the response includes a NextToken. To retrieve the next set of pipelines, use the token in the next request.
The data structure used to specify the data to be used for inference in a batch - * transform job and to associate the data that is relevant to the prediction results in - * the output. The input filter provided allows you to exclude input data that is not - * needed for inference in a batch transform job. The output filter provided allows you to - * include input data relevant to interpreting the predictions in the output from the job. - * For more information, see Associate Prediction - * Results with their Corresponding Input Records.
+ *The maximum number of pipelines to return in the response.
* @public */ - DataProcessing?: DataProcessing | undefined; + MaxResults?: number | undefined; +} +/** + *A summary of a pipeline.
+ * @public + */ +export interface PipelineSummary { /** - *Associates a SageMaker job as a trial component with an experiment and trial. Specified when - * you call the following APIs:
- *- * CreateProcessingJob - *
- *- * CreateTrainingJob - *
- *- * CreateTransformJob - *
- *A list of tags associated with the transform job.
+ *The Amazon Resource Name (ARN) of the pipeline.
* @public */ - Tags?: Tag[] | undefined; -} + PipelineArn?: string | undefined; -/** - *The model card for a model displayed in the Amazon SageMaker Model Dashboard.
- * @public - */ -export interface ModelDashboardModelCard { /** - *The Amazon Resource Name (ARN) for a model card.
+ *The name of the pipeline.
* @public */ - ModelCardArn?: string | undefined; + PipelineName?: string | undefined; /** - *The name of a model card.
+ *The display name of the pipeline.
* @public */ - ModelCardName?: string | undefined; + PipelineDisplayName?: string | undefined; /** - *The model card version.
+ *The description of the pipeline.
* @public */ - ModelCardVersion?: number | undefined; + PipelineDescription?: string | undefined; /** - *The model card status.
+ *The Amazon Resource Name (ARN) that the pipeline used to execute.
* @public */ - ModelCardStatus?: ModelCardStatus | undefined; + RoleArn?: string | undefined; /** - *The KMS Key ID (KMSKeyId) for encryption of model card information.
The creation time of the pipeline.
* @public */ - SecurityConfig?: ModelCardSecurityConfig | undefined; + CreationTime?: Date | undefined; /** - *A timestamp that indicates when the model card was created.
+ *The time that the pipeline was last modified.
* @public */ - CreationTime?: Date | undefined; + LastModifiedTime?: Date | undefined; /** - *Information about the user who created or modified an experiment, trial, trial - * component, lineage group, project, or model card.
+ *The last time that a pipeline execution began.
* @public */ - CreatedBy?: UserContext | undefined; + LastExecutionTime?: Date | undefined; +} +/** + * @public + */ +export interface ListPipelinesResponse { /** - *A timestamp that indicates when the model card was last updated.
+ *Contains a sorted list of PipelineSummary objects matching the specified
+ * filters. Each PipelineSummary consists of PipelineArn, PipelineName,
+ * ExperimentName, PipelineDescription, CreationTime, LastModifiedTime, LastRunTime, and
+ * RoleArn. This list can be empty.
Information about the user who created or modified an experiment, trial, trial - * component, lineage group, project, or model card.
+ *If the result of the previous ListPipelines request was truncated,
+ * the response includes a NextToken. To retrieve the next set of pipelines, use the token in the next request.
The tags associated with a model card.
+ *A filter that returns only processing jobs created after the specified time.
* @public */ - Tags?: Tag[] | undefined; + CreationTimeAfter?: Date | undefined; /** - *For models created in SageMaker, this is the model ARN. For models created - * outside of SageMaker, this is a user-customized string.
+ *A filter that returns only processing jobs created after the specified time.
* @public */ - ModelId?: string | undefined; + CreationTimeBefore?: Date | undefined; /** - *A model card's risk rating. Can be low, medium, or high.
+ *A filter that returns only processing jobs modified after the specified time.
* @public */ - RiskRating?: string | undefined; -} + LastModifiedTimeAfter?: Date | undefined; -/** - *A monitoring schedule for a model displayed in the Amazon SageMaker Model Dashboard.
- * @public - */ -export interface ModelDashboardMonitoringSchedule { /** - *The Amazon Resource Name (ARN) of a monitoring schedule.
+ *A filter that returns only processing jobs modified before the specified time.
* @public */ - MonitoringScheduleArn?: string | undefined; + LastModifiedTimeBefore?: Date | undefined; /** - *The name of a monitoring schedule.
+ *A string in the processing job name. This filter returns only processing jobs whose + * name contains the specified string.
* @public */ - MonitoringScheduleName?: string | undefined; + NameContains?: string | undefined; /** - *The status of the monitoring schedule.
+ *A filter that retrieves only processing jobs with a specific status.
* @public */ - MonitoringScheduleStatus?: ScheduleStatus | undefined; + StatusEquals?: ProcessingJobStatus | undefined; /** - *The monitor type of a model monitor.
+ *The field to sort results by. The default is CreationTime.
If a monitoring job failed, provides the reason.
+ *The sort order for results. The default is Ascending.
A timestamp that indicates when the monitoring schedule was created.
+ *If the result of the previous ListProcessingJobs request was truncated,
+ * the response includes a NextToken. To retrieve the next set of processing
+ * jobs, use the token in the next request.
A timestamp that indicates when the monitoring schedule was last updated.
+ *The maximum number of processing jobs to return in the response.
* @public */ - LastModifiedTime?: Date | undefined; + MaxResults?: number | undefined; +} +/** + *Summary of information about a processing job.
+ * @public + */ +export interface ProcessingJobSummary { /** - *Configures the monitoring schedule and defines the monitoring job.
+ *The name of the processing job.
* @public */ - MonitoringScheduleConfig?: MonitoringScheduleConfig | undefined; + ProcessingJobName: string | undefined; /** - *The endpoint which is monitored.
+ *The Amazon Resource Name (ARN) of the processing job..
* @public */ - EndpointName?: string | undefined; + ProcessingJobArn: string | undefined; /** - *A JSON array where each element is a summary for a monitoring alert.
+ *The time at which the processing job was created.
* @public */ - MonitoringAlertSummaries?: MonitoringAlertSummary[] | undefined; + CreationTime: Date | undefined; /** - *Summary of information about the last monitoring job to run.
+ *The time at which the processing job completed.
* @public */ - LastMonitoringExecutionSummary?: MonitoringExecutionSummary | undefined; + ProcessingEndTime?: Date | undefined; /** - *Input object for the batch transform job.
+ *A timestamp that indicates the last time the processing job was modified.
* @public */ - BatchTransformInput?: BatchTransformInput | undefined; -} + LastModifiedTime?: Date | undefined; -/** - *A model displayed in the Amazon SageMaker Model Dashboard.
- * @public - */ -export interface ModelDashboardModel { /** - *A model displayed in the Model Dashboard.
+ *The status of the processing job.
* @public */ - Model?: Model | undefined; + ProcessingJobStatus: ProcessingJobStatus | undefined; /** - *The endpoints that host a model.
+ *A string, up to one KB in size, that contains the reason a processing job failed, if + * it failed.
* @public */ - Endpoints?: ModelDashboardEndpoint[] | undefined; + FailureReason?: string | undefined; /** - *A batch transform job. For information about SageMaker batch transform, see Use Batch - * Transform.
+ *An optional string, up to one KB in size, that contains metadata from the processing + * container when the processing job exits.
* @public */ - LastBatchTransformJob?: TransformJob | undefined; + ExitMessage?: string | undefined; +} +/** + * @public + */ +export interface ListProcessingJobsResponse { /** - *The monitoring schedules for a model.
+ *An array of ProcessingJobSummary objects, each listing a processing
+ * job.
The model card for a model.
+ *If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of + * processing jobs, use it in the subsequent request.
* @public */ - ModelCard?: ModelDashboardModelCard | undefined; + NextToken?: string | undefined; } /** - *A versioned model that can be deployed for SageMaker inference.
* @public + * @enum */ -export interface ModelPackage { +export const ProjectSortBy = { + CREATION_TIME: "CreationTime", + NAME: "Name", +} as const; + +/** + * @public + */ +export type ProjectSortBy = (typeof ProjectSortBy)[keyof typeof ProjectSortBy]; + +/** + * @public + * @enum + */ +export const ProjectSortOrder = { + ASCENDING: "Ascending", + DESCENDING: "Descending", +} as const; + +/** + * @public + */ +export type ProjectSortOrder = (typeof ProjectSortOrder)[keyof typeof ProjectSortOrder]; + +/** + * @public + */ +export interface ListProjectsInput { /** - *The name of the model.
+ *A filter that returns the projects that were created after a specified + * time.
* @public */ - ModelPackageName?: string | undefined; + CreationTimeAfter?: Date | undefined; /** - *The model group to which the model belongs.
+ *A filter that returns the projects that were created before a specified + * time.
* @public */ - ModelPackageGroupName?: string | undefined; + CreationTimeBefore?: Date | undefined; /** - *The version number of a versioned model.
+ *The maximum number of projects to return in the response.
* @public */ - ModelPackageVersion?: number | undefined; + MaxResults?: number | undefined; /** - *The Amazon Resource Name (ARN) of the model package.
+ *A filter that returns the projects whose name contains a specified + * string.
* @public */ - ModelPackageArn?: string | undefined; + NameContains?: string | undefined; /** - *The description of the model package.
+ *If the result of the previous ListProjects request was truncated,
+ * the response includes a NextToken. To retrieve the next set of projects, use the token in the next request.
The time that the model package was created.
+ *The field by which to sort results. The default is CreationTime.
Defines how to perform inference generation after a training job is run.
+ *The sort order for results. The default is Ascending.
Information about a project.
+ * @public + */ +export interface ProjectSummary { /** - *A list of algorithms that were used to create a model package.
+ *The name of the project.
* @public */ - SourceAlgorithmSpecification?: SourceAlgorithmSpecification | undefined; + ProjectName: string | undefined; /** - *Specifies batch transform jobs that SageMaker runs to validate your model package.
+ *The description of the project.
* @public */ - ValidationSpecification?: ModelPackageValidationSpecification | undefined; + ProjectDescription?: string | undefined; /** - *The status of the model package. This can be one of the following values.
- *
- * PENDING - The model package is pending being created.
- * IN_PROGRESS - The model package is in the process of being
- * created.
- * COMPLETED - The model package was successfully created.
- * FAILED - The model package failed.
- * DELETING - The model package is in the process of being deleted.
The Amazon Resource Name (ARN) of the project.
* @public */ - ModelPackageStatus?: ModelPackageStatus | undefined; + ProjectArn: string | undefined; /** - *Specifies the validation and image scan statuses of the model package.
+ *The ID of the project.
* @public */ - ModelPackageStatusDetails?: ModelPackageStatusDetails | undefined; + ProjectId: string | undefined; /** - *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.
+ *The time that the project was created.
* @public */ - CertifyForMarketplace?: boolean | undefined; + CreationTime: Date | undefined; /** - *The approval status of the model. This can be one of the following values.
- *
- * APPROVED - The model is approved
- * REJECTED - The model is rejected.
- * PENDING_MANUAL_APPROVAL - The model is waiting for manual
- * approval.
The status of the project.
* @public */ - ModelApprovalStatus?: ModelApprovalStatus | undefined; + ProjectStatus: ProjectStatus | undefined; +} +/** + * @public + */ +export interface ListProjectsOutput { /** - *Information about the user who created or modified an experiment, trial, trial component, lineage group, or project.
+ *A list of summaries of projects.
* @public */ - CreatedBy?: UserContext | undefined; + ProjectSummaryList: ProjectSummary[] | undefined; /** - *Metadata properties of the tracking entity, trial, or trial component.
+ *If the result of the previous ListCompilationJobs request was truncated,
+ * the response includes a NextToken. To retrieve the next set of model
+ * compilation jobs, use the token in the next request.
Metrics for the model.
- * @public - */ - ModelMetrics?: ModelMetrics | undefined; +/** + * @public + * @enum + */ +export const ResourceCatalogSortBy = { + CREATION_TIME: "CreationTime", +} as const; - /** - *The last time the model package was modified.
- * @public - */ - LastModifiedTime?: Date | undefined; +/** + * @public + */ +export type ResourceCatalogSortBy = (typeof ResourceCatalogSortBy)[keyof typeof ResourceCatalogSortBy]; - /** - *Information about the user who created or modified an experiment, trial, trial component, lineage group, or project.
- * @public - */ - LastModifiedBy?: UserContext | undefined; +/** + * @public + * @enum + */ +export const ResourceCatalogSortOrder = { + ASCENDING: "Ascending", + DESCENDING: "Descending", +} as const; + +/** + * @public + */ +export type ResourceCatalogSortOrder = (typeof ResourceCatalogSortOrder)[keyof typeof ResourceCatalogSortOrder]; +/** + * @public + */ +export interface ListResourceCatalogsRequest { /** - *A description provided when the model approval is set.
+ * A string that partially matches one or more ResourceCatalogs names.
+ * Filters ResourceCatalog by name.
The machine learning domain of your model package and its components. Common - * machine learning domains include computer vision and natural language processing.
+ * Use this parameter to search for ResourceCatalogs created after a
+ * specific date and time.
The machine learning task your model package accomplishes. Common machine - * learning tasks include object detection and image classification.
+ * Use this parameter to search for ResourceCatalogs created before a
+ * specific date and time.
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 order in which the resource catalogs are listed.
* @public */ - SamplePayloadUrl?: string | undefined; + SortOrder?: ResourceCatalogSortOrder | undefined; /** - *An array of additional Inference Specification objects.
+ *The value on which the resource catalog list is sorted.
* @public */ - AdditionalInferenceSpecifications?: AdditionalInferenceSpecificationDefinition[] | undefined; + SortBy?: ResourceCatalogSortBy | undefined; /** - *The URI of the source for the model package.
+ * The maximum number of results returned by ListResourceCatalogs.
An optional Key Management Service - * key to encrypt, decrypt, and re-encrypt model package information for regulated workloads with - * highly sensitive data.
+ * A token to resume pagination of ListResourceCatalogs results.
A resource catalog containing all of the resources of a specific resource type within
+ * a resource owner account. For an example on sharing the Amazon SageMaker Feature Store
+ * DefaultFeatureGroupCatalog, see Share Amazon SageMaker Catalog resource type in the Amazon SageMaker Developer Guide.
+ *
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 Amazon Resource Name (ARN) of the ResourceCatalog.
- * A structure describing the current state of the model in its life cycle. - *
+ * The name of the ResourceCatalog.
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 free form description of the ResourceCatalog.
The metadata properties for the model package.
+ * The time the ResourceCatalog was created.
Represents the drift check baselines that can be used when the model monitor is set using the model package.
+ * A list of the requested ResourceCatalogs.
Indicates if you want to skip model validation.
+ * A token to resume pagination of ListResourceCatalogs results.
A group of versioned models in the model registry.
* @public + * @enum */ -export interface ModelPackageGroup { +export const SpaceSortKey = { + CreationTime: "CreationTime", + LastModifiedTime: "LastModifiedTime", +} as const; + +/** + * @public + */ +export type SpaceSortKey = (typeof SpaceSortKey)[keyof typeof SpaceSortKey]; + +/** + * @public + */ +export interface ListSpacesRequest { /** - *The name of the model group.
+ *If the previous response was truncated, you will receive this token. Use it in your next + * request to receive the next set of results.
* @public */ - ModelPackageGroupName?: string | undefined; + NextToken?: string | undefined; /** - *The Amazon Resource Name (ARN) of the model group.
+ *This parameter defines the maximum number of results that can be return in a single
+ * response. The MaxResults parameter is an upper bound, not a target. If there are
+ * more results available than the value specified, a NextToken is provided in the
+ * response. The NextToken indicates that the user should get the next set of
+ * results by providing this token as a part of a subsequent call. The default value for
+ * MaxResults is 10.
The description for the model group.
+ *The sort order for the results. The default is Ascending.
The time that the model group was created.
+ *The parameter by which to sort the results. The default is
+ * CreationTime.
Information about the user who created or modified an experiment, trial, trial - * component, lineage group, project, or model card.
- * @public - */ - CreatedBy?: UserContext | undefined; + SortBy?: SpaceSortKey | undefined; /** - *The status of the model group. This can be one of the following values.
- *
- * PENDING - The model group is pending being created.
- * IN_PROGRESS - The model group is in the process of being
- * created.
- * COMPLETED - The model group was successfully created.
- * FAILED - The model group failed.
- * DELETING - The model group is in the process of being deleted.
- * DELETE_FAILED - SageMaker failed to delete the model group.
A parameter to search for the domain ID.
* @public */ - ModelPackageGroupStatus?: ModelPackageGroupStatus | undefined; + DomainIdEquals?: string | 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 parameter by which to filter the results.
* @public */ - Tags?: Tag[] | undefined; + SpaceNameContains?: string | undefined; } /** - * @public - * @enum - */ -export const ModelVariantAction = { - PROMOTE: "Promote", - REMOVE: "Remove", - RETAIN: "Retain", -} as const; - -/** + *Specifies summary information about the ownership settings.
* @public */ -export type ModelVariantAction = (typeof ModelVariantAction)[keyof typeof ModelVariantAction]; +export interface OwnershipSettingsSummary { + /** + *The user profile who is the owner of the space.
+ * @public + */ + OwnerUserProfileName?: string | undefined; +} /** - *A list of nested Filter objects. A resource must satisfy the conditions - * of all filters to be included in the results returned from the Search API.
- *For example, to filter on a training job's InputDataConfig property with a
- * specific channel name and S3Uri prefix, define the following filters:
- * '\{Name:"InputDataConfig.ChannelName", "Operator":"Equals", "Value":"train"\}',
- *
- * '\{Name:"InputDataConfig.DataSource.S3DataSource.S3Uri", "Operator":"Contains",
- * "Value":"mybucket/catdata"\}'
- *
Specifies summary information about the space settings.
* @public */ -export interface NestedFilters { +export interface SpaceSettingsSummary { /** - *The name of the property to use in the nested filters. The value must match a listed property name,
- * such as InputDataConfig.
The type of app created within the space.
* @public */ - NestedPropertyName: string | undefined; + AppType?: AppType | undefined; /** - *A list of filters. Each filter acts on a property. Filters must contain at least one
- * Filters value. For example, a NestedFilters call might
- * include a filter on the PropertyName parameter of the
- * InputDataConfig property:
- * InputDataConfig.DataSource.S3DataSource.S3Uri.
The storage settings for a space.
* @public */ - Filters: Filter[] | undefined; + SpaceStorageSettings?: SpaceStorageSettings | undefined; } /** - *Updates the feature group online store configuration.
+ *Specifies summary information about the space sharing settings.
* @public */ -export interface OnlineStoreConfigUpdate { +export interface SpaceSharingSettingsSummary { /** - *Time to live duration, where the record is hard deleted after the expiration time is
- * reached; ExpiresAt = EventTime + TtlDuration. For
- * information on HardDelete, see the DeleteRecord API in the Amazon SageMaker API Reference guide.
Specifies the sharing type of the space.
* @public */ - TtlDuration?: TtlDuration | undefined; + SharingType?: SharingType | undefined; } /** - *The trial that a trial component is associated with and the experiment the trial is part - * of. A component might not be associated with a trial. A component can be associated with - * multiple trials.
+ *The space's details.
* @public */ -export interface Parent { +export interface SpaceDetails { /** - *The name of the trial.
+ *The ID of the associated domain.
* @public */ - TrialName?: string | undefined; + DomainId?: string | undefined; /** - *The name of the experiment.
+ *The name of the space.
* @public */ - ExperimentName?: string | undefined; -} + SpaceName?: string | undefined; -/** - *A SageMaker Model Building Pipeline instance.
- * @public - */ -export interface Pipeline { /** - *The Amazon Resource Name (ARN) of the pipeline.
+ *The status.
* @public */ - PipelineArn?: string | undefined; + Status?: SpaceStatus | undefined; /** - *The name of the pipeline.
+ *The creation time.
* @public */ - PipelineName?: string | undefined; + CreationTime?: Date | undefined; /** - *The display name of the pipeline.
+ *The last modified time.
* @public */ - PipelineDisplayName?: string | undefined; + LastModifiedTime?: Date | undefined; /** - *The description of the pipeline.
+ *Specifies summary information about the space settings.
* @public */ - PipelineDescription?: string | undefined; + SpaceSettingsSummary?: SpaceSettingsSummary | undefined; /** - *The Amazon Resource Name (ARN) of the role that created the pipeline.
+ *Specifies summary information about the space sharing settings.
* @public */ - RoleArn?: string | undefined; + SpaceSharingSettingsSummary?: SpaceSharingSettingsSummary | undefined; /** - *The status of the pipeline.
+ *Specifies summary information about the ownership settings.
* @public */ - PipelineStatus?: PipelineStatus | undefined; + OwnershipSettingsSummary?: OwnershipSettingsSummary | undefined; /** - *The creation time of the pipeline.
+ *The name of the space that appears in the Studio UI.
* @public */ - CreationTime?: Date | undefined; + SpaceDisplayName?: string | undefined; +} +/** + * @public + */ +export interface ListSpacesResponse { /** - *The time that the pipeline was last modified.
+ *The list of spaces.
* @public */ - LastModifiedTime?: Date | undefined; + Spaces?: SpaceDetails[] | undefined; /** - *The time when the pipeline was last run.
+ *If the previous response was truncated, you will receive this token. Use it in your next + * request to receive the next set of results.
* @public */ - LastRunTime?: Date | undefined; + NextToken?: string | undefined; +} +/** + * @public + */ +export interface ListStageDevicesRequest { /** - *Information about the user who created or modified an experiment, trial, trial - * component, lineage group, project, or model card.
+ *The response from the last list when returning a list large enough to neeed + * tokening.
* @public */ - CreatedBy?: UserContext | undefined; + NextToken?: string | undefined; /** - *Information about the user who created or modified an experiment, trial, trial - * component, lineage group, project, or model card.
+ *The maximum number of requests to select.
* @public */ - LastModifiedBy?: UserContext | undefined; + MaxResults?: number | undefined; /** - *The parallelism configuration applied to the pipeline.
+ *The name of the edge deployment plan.
* @public */ - ParallelismConfiguration?: ParallelismConfiguration | undefined; + EdgeDeploymentPlanName: string | undefined; /** - *A list of tags that apply to the pipeline.
+ *Toggle for excluding devices deployed in other stages.
* @public */ - Tags?: Tag[] | undefined; + ExcludeDevicesDeployedInOtherStage?: boolean | undefined; + + /** + *The name of the stage in the deployment.
+ * @public + */ + StageName: string | undefined; } /** - *An execution of a pipeline.
* @public */ -export interface PipelineExecution { +export interface ListStageDevicesResponse { /** - *The Amazon Resource Name (ARN) of the pipeline that was executed.
+ *List of summaries of devices allocated to the stage.
* @public */ - PipelineArn?: string | undefined; + DeviceDeploymentSummaries: DeviceDeploymentSummary[] | undefined; /** - *The Amazon Resource Name (ARN) of the pipeline execution.
+ *The token to use when calling the next page of results.
* @public */ - PipelineExecutionArn?: string | undefined; + NextToken?: string | undefined; +} + +/** + * @public + * @enum + */ +export const StudioLifecycleConfigSortKey = { + CreationTime: "CreationTime", + LastModifiedTime: "LastModifiedTime", + Name: "Name", +} as const; + +/** + * @public + */ +export type StudioLifecycleConfigSortKey = + (typeof StudioLifecycleConfigSortKey)[keyof typeof StudioLifecycleConfigSortKey]; +/** + * @public + */ +export interface ListStudioLifecycleConfigsRequest { /** - *The display name of the pipeline execution.
+ *The total number of items to return in the response. If the total number of items
+ * available is more than the value specified, a NextToken is provided in the
+ * response. To resume pagination, provide the NextToken value in the as part of a
+ * subsequent call. The default value is 10.
The status of the pipeline status.
+ *If the previous call to ListStudioLifecycleConfigs didn't return the full set of Lifecycle + * Configurations, the call returns a token for getting the next set of Lifecycle + * Configurations.
* @public */ - PipelineExecutionStatus?: PipelineExecutionStatus | undefined; + NextToken?: string | undefined; /** - *The description of the pipeline execution.
+ *A string in the Lifecycle Configuration name. This filter returns only Lifecycle + * Configurations whose name contains the specified string.
* @public */ - PipelineExecutionDescription?: string | undefined; + NameContains?: string | undefined; /** - *Specifies the names of the experiment and trial created by a pipeline.
+ *A parameter to search for the App Type to which the Lifecycle Configuration is + * attached.
* @public */ - PipelineExperimentConfig?: PipelineExperimentConfig | undefined; + AppTypeEquals?: StudioLifecycleConfigAppType | undefined; /** - *If the execution failed, a message describing why.
- * @public + *A filter that returns only Lifecycle Configurations created on or before the specified + * time.
+ * @public */ - FailureReason?: string | undefined; + CreationTimeBefore?: Date | undefined; /** - *The creation time of the pipeline execution.
+ *A filter that returns only Lifecycle Configurations created on or after the specified + * time.
* @public */ - CreationTime?: Date | undefined; + CreationTimeAfter?: Date | undefined; /** - *The time that the pipeline execution was last modified.
+ *A filter that returns only Lifecycle Configurations modified before the specified + * time.
* @public */ - LastModifiedTime?: Date | undefined; + ModifiedTimeBefore?: Date | undefined; /** - *Information about the user who created or modified an experiment, trial, trial - * component, lineage group, project, or model card.
+ *A filter that returns only Lifecycle Configurations modified after the specified + * time.
* @public */ - CreatedBy?: UserContext | undefined; + ModifiedTimeAfter?: Date | undefined; /** - *Information about the user who created or modified an experiment, trial, trial - * component, lineage group, project, or model card.
+ *The property used to sort results. The default value is CreationTime.
* @public */ - LastModifiedBy?: UserContext | undefined; + SortBy?: StudioLifecycleConfigSortKey | undefined; /** - *The parallelism configuration applied to the pipeline execution.
+ *The sort order. The default value is Descending.
* @public */ - ParallelismConfiguration?: ParallelismConfiguration | undefined; + SortOrder?: SortOrder | undefined; +} +/** + *Details of the Amazon SageMaker Studio Lifecycle Configuration.
+ * @public + */ +export interface StudioLifecycleConfigDetails { /** - *The selective execution configuration applied to the pipeline run.
+ *The Amazon Resource Name (ARN) of the Lifecycle Configuration.
* @public */ - SelectiveExecutionConfig?: SelectiveExecutionConfig | undefined; + StudioLifecycleConfigArn?: string | undefined; /** - *Contains a list of pipeline parameters. This list can be empty.
+ *The name of the Amazon SageMaker Studio Lifecycle Configuration.
* @public */ - PipelineParameters?: Parameter[] | undefined; -} + StudioLifecycleConfigName?: string | undefined; -/** - *An Amazon SageMaker processing job that is used to analyze data and evaluate models. For more information, - * see Process - * Data and Evaluate Models.
- * @public - */ -export interface ProcessingJob { /** - *List of input configurations for the processing job.
+ *The creation time of the Amazon SageMaker Studio Lifecycle Configuration.
* @public */ - ProcessingInputs?: ProcessingInput[] | undefined; + CreationTime?: Date | undefined; /** - *Configuration for uploading output from the processing container.
+ *This value is equivalent to CreationTime because Amazon SageMaker Studio Lifecycle + * Configurations are immutable.
* @public */ - ProcessingOutputConfig?: ProcessingOutputConfig | undefined; + LastModifiedTime?: Date | undefined; /** - *The name of the processing job.
+ *The App type to which the Lifecycle Configuration is attached.
* @public */ - ProcessingJobName?: string | undefined; + StudioLifecycleConfigAppType?: StudioLifecycleConfigAppType | undefined; +} +/** + * @public + */ +export interface ListStudioLifecycleConfigsResponse { /** - *Identifies the resources, ML compute instances, and ML storage volumes to deploy for a - * processing job. In distributed training, you specify more than one instance.
+ *If the previous response was truncated, you will receive this token. Use it in your next + * request to receive the next set of results.
* @public */ - ProcessingResources?: ProcessingResources | undefined; + NextToken?: string | undefined; /** - *Configures conditions under which the processing job should be stopped, such as how long - * the processing job has been running. After the condition is met, the processing job is stopped.
+ *A list of Lifecycle Configurations and their properties.
* @public */ - StoppingCondition?: ProcessingStoppingCondition | undefined; + StudioLifecycleConfigs?: StudioLifecycleConfigDetails[] | undefined; +} +/** + * @public + */ +export interface ListSubscribedWorkteamsRequest { /** - *Configuration to run a processing job in a specified container image.
+ *A string in the work team name. This filter returns only work teams whose name + * contains the specified string.
* @public */ - AppSpecification?: AppSpecification | undefined; + NameContains?: string | undefined; /** - *Sets the environment variables in the Docker container.
+ *If the result of the previous ListSubscribedWorkteams request was
+ * truncated, the response includes a NextToken. To retrieve the next set of
+ * labeling jobs, use the token in the next request.
Networking options for a job, such as network traffic encryption between containers, - * whether to allow inbound and outbound network calls to and from containers, and the VPC - * subnets and security groups to use for VPC-enabled jobs.
+ *The maximum number of work teams to return in each page of the response.
* @public */ - NetworkConfig?: NetworkConfig | undefined; + MaxResults?: number | undefined; +} +/** + * @public + */ +export interface ListSubscribedWorkteamsResponse { /** - *The ARN of the role used to create the processing job.
+ *An array of Workteam objects, each describing a work team.
Associates a SageMaker job as a trial component with an experiment and trial. Specified when - * you call the following APIs:
- *- * CreateProcessingJob - *
- *- * CreateTrainingJob - *
- *- * CreateTransformJob - *
- *If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of + * work teams, use it in the subsequent request.
* @public */ - ExperimentConfig?: ExperimentConfig | undefined; + NextToken?: string | undefined; +} +/** + * @public + */ +export interface ListTagsInput { /** - *The ARN of the processing job.
+ *The Amazon Resource Name (ARN) of the resource whose tags you want to + * retrieve.
* @public */ - ProcessingJobArn?: string | undefined; + ResourceArn: string | undefined; /** - *The status of the processing job.
+ * If the response to the previous ListTags request is truncated, SageMaker
+ * returns this token. To retrieve the next set of tags, use it in the subsequent request.
+ *
A string, up to one KB in size, that contains metadata from the processing - * container when the processing job exits.
+ *Maximum number of tags to return.
* @public */ - ExitMessage?: string | undefined; + MaxResults?: number | undefined; +} +/** + * @public + */ +export interface ListTagsOutput { /** - *A string, up to one KB in size, that contains the reason a processing job failed, if - * it failed.
+ *An array of Tag objects, each with a tag key and a value.
The time that the processing job ended.
+ *If response is truncated, SageMaker includes a token in the response. You can use this + * token in your subsequent request to fetch next set of tokens.
* @public */ - ProcessingEndTime?: Date | undefined; + NextToken?: string | undefined; +} +/** + * @public + */ +export interface ListTrainingJobsRequest { /** - *The time that the processing job started.
+ *If the result of the previous ListTrainingJobs request was truncated,
+ * the response includes a NextToken. To retrieve the next set of training
+ * jobs, use the token in the next request.
The time the processing job was last modified.
+ *The maximum number of training jobs to return in the response.
* @public */ - LastModifiedTime?: Date | undefined; + MaxResults?: number | undefined; /** - *The time the processing job was created.
+ *A filter that returns only training jobs created after the specified time + * (timestamp).
* @public */ - CreationTime?: Date | undefined; + CreationTimeAfter?: Date | undefined; /** - *The ARN of a monitoring schedule for an endpoint associated with this processing - * job.
+ *A filter that returns only training jobs created before the specified time + * (timestamp).
* @public */ - MonitoringScheduleArn?: string | undefined; + CreationTimeBefore?: Date | undefined; /** - *The Amazon Resource Name (ARN) of the AutoML job associated with this processing job.
+ *A filter that returns only training jobs modified after the specified time + * (timestamp).
* @public */ - AutoMLJobArn?: string | undefined; + LastModifiedTimeAfter?: Date | undefined; /** - *The ARN of the training job associated with this processing job.
+ *A filter that returns only training jobs modified before the specified time + * (timestamp).
* @public */ - TrainingJobArn?: string | undefined; + LastModifiedTimeBefore?: Date | undefined; /** - *An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management - * User Guide.
+ *A string in the training job name. This filter returns only training jobs whose + * name contains the specified string.
* @public */ - Tags?: Tag[] | undefined; -} + NameContains?: string | undefined; -/** - *Configuration information for updating the Amazon SageMaker Debugger profile parameters, system and framework metrics configurations, and - * storage paths.
- * @public - */ -export interface ProfilerConfigForUpdate { /** - *Path to Amazon S3 storage location for system and framework metrics.
+ *A filter that retrieves only training jobs with a specific status.
* @public */ - S3OutputPath?: string | undefined; + StatusEquals?: TrainingJobStatus | undefined; /** - *A time interval for capturing system metrics in milliseconds. Available values are - * 100, 200, 500, 1000 (1 second), 5000 (5 seconds), and 60000 (1 minute) milliseconds. The default value is 500 milliseconds.
+ *The field to sort results by. The default is CreationTime.
Configuration information for capturing framework metrics. Available key strings for different profiling options are
- * DetailedProfilingConfig, PythonProfilingConfig, and DataLoaderProfilingConfig.
- * The following codes are configuration structures for the ProfilingParameters parameter. To learn more about
- * how to configure the ProfilingParameters parameter,
- * see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.
- *
The sort order for results. The default is Ascending.
To turn off Amazon SageMaker Debugger monitoring and profiling while a training job is in progress, set to True.
A filter that retrieves only training jobs with a specific warm pool status.
* @public */ - DisableProfiler?: boolean | undefined; + WarmPoolStatusEquals?: WarmPoolResourceStatus | undefined; + + /** + *The Amazon Resource Name (ARN); of the training plan to filter training jobs by. For more information
+ * about reserving GPU capacity for your SageMaker training jobs using Amazon SageMaker Training Plan, see
+ * CreateTrainingPlan
+ * .
The properties of a project as returned by the Search API.
+ *Provides summary information about a training job.
* @public */ -export interface Project { +export interface TrainingJobSummary { /** - *The Amazon Resource Name (ARN) of the project.
+ *The name of the training job that you want a summary for.
* @public */ - ProjectArn?: string | undefined; + TrainingJobName: string | undefined; /** - *The name of the project.
+ *The Amazon Resource Name (ARN) of the training job.
* @public */ - ProjectName?: string | undefined; - - /** - *The ID of the project.
- * @public - */ - ProjectId?: string | undefined; + TrainingJobArn: string | undefined; /** - *The description of the project.
+ *A timestamp that shows when the training job was created.
* @public */ - ProjectDescription?: string | undefined; + CreationTime: Date | undefined; /** - *Details that you specify to provision a service catalog product. For information about - * service catalog, see What is Amazon Web Services Service - * Catalog.
+ *A timestamp that shows when the training job ended. This field is set only if the
+ * training job has one of the terminal statuses (Completed,
+ * Failed, or Stopped).
Details of a provisioned service catalog product. For information about service catalog, - * see What is Amazon Web Services Service - * Catalog.
+ *Timestamp when the training job was last modified.
* @public */ - ServiceCatalogProvisionedProductDetails?: ServiceCatalogProvisionedProductDetails | undefined; + LastModifiedTime?: Date | undefined; /** - *The status of the project.
+ *The status of the training job.
* @public */ - ProjectStatus?: ProjectStatus | undefined; + TrainingJobStatus: TrainingJobStatus | undefined; /** - *Who created the project.
+ *The secondary status of the training job.
* @public */ - CreatedBy?: UserContext | undefined; + SecondaryStatus?: SecondaryStatus | undefined; /** - *A timestamp specifying when the project was created.
+ *The status of the warm pool associated with the training job.
* @public */ - CreationTime?: Date | undefined; + WarmPoolStatus?: WarmPoolStatus | undefined; /** - *An array of key-value pairs. You can use tags to categorize your Amazon Web Services - * resources in different ways, for example, by purpose, owner, or environment. For more - * information, see Tagging Amazon Web Services Resources.
+ *The Amazon Resource Name (ARN); of the training plan associated with this training job.
+ *For more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using
+ * Amazon SageMaker Training Plan, see
+ * CreateTrainingPlan
+ * .
A timestamp container for when the project was last modified.
+ *An array of TrainingJobSummary objects, each listing a training
+ * job.
Information about the user who created or modified an experiment, trial, trial - * component, lineage group, project, or model card.
+ *If the response is truncated, SageMaker returns this token. To retrieve the next set of + * training jobs, use it in the subsequent request.
* @public */ - LastModifiedBy?: UserContext | undefined; + NextToken?: string | undefined; } /** * @public + * @enum */ -export interface PutModelPackageGroupPolicyInput { +export const TrainingJobSortByOptions = { + CreationTime: "CreationTime", + FinalObjectiveMetricValue: "FinalObjectiveMetricValue", + Name: "Name", + Status: "Status", +} as const; + +/** + * @public + */ +export type TrainingJobSortByOptions = (typeof TrainingJobSortByOptions)[keyof typeof TrainingJobSortByOptions]; + +/** + * @public + */ +export interface ListTrainingJobsForHyperParameterTuningJobRequest { /** - *The name of the model group to add a resource policy to.
+ *The name of the tuning job whose training jobs you want to list.
* @public */ - ModelPackageGroupName: string | undefined; + HyperParameterTuningJobName: string | undefined; /** - *The resource policy for the model group.
+ *If the result of the previous ListTrainingJobsForHyperParameterTuningJob
+ * request was truncated, the response includes a NextToken. To retrieve the
+ * next set of training jobs, use the token in the next request.
The Amazon Resource Name (ARN) of the model package group.
+ *The maximum number of training jobs to return. The default value is 10.
* @public */ - ModelPackageGroupArn: string | undefined; -} + MaxResults?: number | undefined; -/** - *A set of filters to narrow the set of lineage entities connected to the StartArn(s) returned by the
- * QueryLineage API action.
Filter the lineage entities connected to the StartArn by type. For example: DataSet,
- * Model, Endpoint, or ModelDeployment.
A filter that returns only training jobs with the specified status.
* @public */ - Types?: string[] | undefined; + StatusEquals?: TrainingJobStatus | undefined; /** - *Filter the lineage entities connected to the StartArn(s) by the type of the lineage entity.
The field to sort results by. The default is Name.
If the value of this field is FinalObjectiveMetricValue, any training
+ * jobs that did not return an objective metric are not listed.
Filter the lineage entities connected to the StartArn(s) by created date.
The sort order for results. The default is Ascending.
Filter the lineage entities connected to the StartArn(s) after the create date.
A list of TrainingJobSummary objects that
+ * describe
+ * the training jobs that the
+ * ListTrainingJobsForHyperParameterTuningJob request returned.
Filter the lineage entities connected to the StartArn(s) before the last modified date.
If the result of this ListTrainingJobsForHyperParameterTuningJob request
+ * was truncated, the response includes a NextToken. To retrieve the next set
+ * of training jobs, use the token in the next request.
A filter to apply when listing or searching for training plans.
+ *For more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using
+ * Amazon SageMaker Training Plan, see
+ * CreateTrainingPlan
+ * .
Filter the lineage entities connected to the StartArn(s) after the last modified date.
The name of the filter field (e.g., Status, InstanceType).
* @public */ - ModifiedAfter?: Date | undefined; + Name: TrainingPlanFilterName | undefined; /** - *Filter the lineage entities connected to the StartArn(s) by a set if property key value pairs.
- * If multiple pairs are provided, an entity is included in the results if it matches any of the provided pairs.
The value to filter by for the specified field.
* @public */ - Properties?: RecordA list of resource Amazon Resource Name (ARN) that represent the starting point for your lineage query.
+ *A token to continue pagination if more results are available.
* @public */ - StartArns?: string[] | undefined; + NextToken?: string | undefined; /** - *Associations between lineage entities have a direction. This parameter determines the direction from the - * StartArn(s) that the query traverses.
+ *The maximum number of results to return in the response.
* @public */ - Direction?: Direction | undefined; + MaxResults?: number | undefined; /** - * Setting this value to True retrieves not only the entities of interest but also the
- * Associations and
- * lineage entities on the path. Set to False to only return lineage entities that match your query.
Filter to list only training plans with an actual start time after this date.
* @public */ - IncludeEdges?: boolean | undefined; + StartTimeAfter?: Date | undefined; /** - *A set of filtering parameters that allow you to specify which entities should be returned.
- *Properties - Key-value pairs to match on the lineage entities' properties.
- *LineageTypes - A set of lineage entity types to match on. For example: TrialComponent,
- * Artifact, or Context.
CreatedBefore - Filter entities created before this date.
- *ModifiedBefore - Filter entities modified before this date.
- *ModifiedAfter - Filter entities modified after this date.
- *Filter to list only training plans with an actual start time before this date.
* @public */ - Filters?: QueryFilters | undefined; + StartTimeBefore?: Date | undefined; /** - *The maximum depth in lineage relationships from the StartArns that are traversed. Depth is a measure of the number
- * of Associations from the StartArn entity to the matched results.
The training plan field to sort the results by (e.g., StartTime, Status).
* @public */ - MaxDepth?: number | undefined; + SortBy?: TrainingPlanSortBy | undefined; /** - *Limits the number of vertices in the results. Use the NextToken in a response to to retrieve the next page of results.
The order to sort the results (Ascending or Descending).
* @public */ - MaxResults?: number | undefined; + SortOrder?: TrainingPlanSortOrder | undefined; /** - *Limits the number of vertices in the request. Use the NextToken in a response to to retrieve the next page of results.
Additional filters to apply to the list of training plans.
* @public */ - NextToken?: string | undefined; + Filters?: TrainingPlanFilter[] | undefined; } /** - *A lineage entity connected to the starting entity(ies).
+ *Details of the training plan.
+ *For more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using
+ * Amazon SageMaker Training Plan, see
+ * CreateTrainingPlan
+ * .
The Amazon Resource Name (ARN) of the lineage entity resource.
+ *The Amazon Resource Name (ARN); of the training plan.
* @public */ - Arn?: string | undefined; + TrainingPlanArn: string | undefined; /** - *The type of the lineage entity resource. For example: DataSet, Model, Endpoint,
- * etc...
The name of the training plan.
* @public */ - Type?: string | undefined; + TrainingPlanName: string | undefined; /** - *The type of resource of the lineage entity.
+ *The current status of the training plan (e.g., Pending, Active, Expired). To see the
+ * complete list of status values available for a training plan, refer to the
+ * Status attribute within the
+ * TrainingPlanSummary
+ * object.
A list of vertices connected to the start entity(ies) in the lineage graph.
+ *A message providing additional information about the current status of the training + * plan.
* @public */ - Vertices?: Vertex[] | undefined; + StatusMessage?: string | undefined; /** - *A list of edges that connect vertices in the response.
+ *The number of whole hours in the total duration for this training plan.
* @public */ - Edges?: Edge[] | undefined; + DurationHours?: number | undefined; /** - *Limits the number of vertices in the response. Use the NextToken in a response to to retrieve the next page of results.
The additional minutes beyond whole hours in the total duration for this training + * plan.
* @public */ - NextToken?: string | undefined; -} + DurationMinutes?: number | undefined; -/** - * @public - */ -export interface RegisterDevicesRequest { /** - *The name of the fleet.
+ *The start time of the training plan.
* @public */ - DeviceFleetName: string | undefined; + StartTime?: Date | undefined; /** - *A list of devices to register with SageMaker Edge Manager.
+ *The end time of the training plan.
* @public */ - Devices: Device[] | undefined; + EndTime?: Date | undefined; /** - *The tags associated with devices.
+ *The upfront fee for the training plan.
* @public */ - Tags?: Tag[] | undefined; -} + UpfrontFee?: string | undefined; -/** - *Configuration for remote debugging for the UpdateTrainingJob API. To learn more about the remote debugging - * functionality of SageMaker, see Access a training container - * through Amazon Web Services Systems Manager (SSM) for remote - * debugging.
- * @public - */ -export interface RemoteDebugConfigForUpdate { /** - *If set to True, enables remote debugging.
+ *The currency code for the upfront fee (e.g., USD).
* @public */ - EnableRemoteDebug?: boolean | undefined; -} + CurrencyCode?: string | undefined; -/** - *Contains input values for a task.
- * @public - */ -export interface RenderableTask { /** - *A JSON object that contains values for the variables defined in the template. It is
- * made available to the template under the substitution variable task.input.
- * For example, if you define a variable task.input.text in your template, you
- * can supply the variable in the JSON object as "text": "sample text".
The total number of instances reserved in this training plan.
* @public */ - Input: string | undefined; + TotalInstanceCount?: number | undefined; + + /** + *The number of instances currently available for use in this training plan.
+ * @public + */ + AvailableInstanceCount?: number | undefined; + + /** + *The number of instances currently in use from this training plan.
+ * @public + */ + InUseInstanceCount?: number | undefined; + + /** + *The target resources (e.g., training jobs, HyperPod clusters) that can use this training + * plan.
+ *Training plans are specific to their target resource.
+ *A training plan designed for SageMaker training jobs can only be used to schedule and + * run training jobs.
+ *A training plan for HyperPod clusters can be used exclusively to provide + * compute resources to a cluster's instance group.
+ *A list of reserved capacities associated with this training plan, including details such + * as instance types, counts, and availability zones.
+ * @public + */ + ReservedCapacitySummaries?: ReservedCapacitySummary[] | undefined; } /** - *A description of an error that occurred while rendering the template.
* @public */ -export interface RenderingError { +export interface ListTrainingPlansResponse { /** - *A unique identifier for a specific class of errors.
+ *A token to continue pagination if more results are available.
* @public */ - Code: string | undefined; + NextToken?: string | undefined; /** - *A human-readable message describing the error.
+ *A list of summary information for the training plans.
* @public */ - Message: string | undefined; + TrainingPlanSummaries: TrainingPlanSummary[] | undefined; } /** * @public */ -export interface RenderUiTemplateRequest { +export interface ListTransformJobsRequest { /** - *A Template object containing the worker UI template to render.
A filter that returns only transform jobs created after the specified time.
* @public */ - UiTemplate?: UiTemplate | undefined; + CreationTimeAfter?: Date | undefined; /** - *A RenderableTask object containing a representative task to
- * render.
A filter that returns only transform jobs created before the specified time.
* @public */ - Task: RenderableTask | undefined; + CreationTimeBefore?: Date | undefined; /** - *The Amazon Resource Name (ARN) that has access to the S3 objects that are used by the - * template.
+ *A filter that returns only transform jobs modified after the specified time.
* @public */ - RoleArn: string | undefined; + LastModifiedTimeAfter?: Date | undefined; /** - *The HumanTaskUiArn of the worker UI that you want to render. Do not
- * provide a HumanTaskUiArn if you use the UiTemplate
- * parameter.
See a list of available Human Ui Amazon Resource Names (ARNs) in UiConfig.
+ *A filter that returns only transform jobs modified before the specified time.
* @public */ - HumanTaskUiArn?: string | undefined; -} + LastModifiedTimeBefore?: Date | undefined; -/** - * @public - */ -export interface RenderUiTemplateResponse { /** - *A Liquid template that renders the HTML for the worker UI.
+ *A string in the transform job name. This filter returns only transform jobs whose name + * contains the specified string.
* @public */ - RenderedContent: string | undefined; + NameContains?: string | undefined; /** - *A list of one or more RenderingError objects if any were encountered
- * while rendering the template. If there were no errors, the list is empty.
A filter that retrieves only transform jobs with a specific status.
* @public */ - Errors: RenderingError[] | undefined; -} + StatusEquals?: TransformJobStatus | undefined; -/** - *The ResourceConfig to update KeepAlivePeriodInSeconds. Other
- * fields in the ResourceConfig cannot be updated.
The KeepAlivePeriodInSeconds value specified in the
- * ResourceConfig to update.
The field to sort results by. The default is CreationTime.
The sort order for results. The default is Descending.
If the result of the previous ListTransformJobs request was truncated,
+ * the response includes a NextToken. To retrieve the next set of transform
+ * jobs, use the token in the next request.
The maximum number of transform jobs to return in the response. The default value is 10.
Provides a
+ * summary
+ * of a transform job. Multiple TransformJobSummary objects are returned as a
+ * list after in response to a ListTransformJobs call.
The Amazon Resource Name (ARN) of the pipeline execution.
+ *The name of the transform job.
* @public */ - PipelineExecutionArn: string | undefined; + TransformJobName: string | undefined; /** - *A unique, case-sensitive identifier that you provide to ensure the idempotency of the - * operation. An idempotent operation completes no more than once.
+ *The Amazon Resource Name (ARN) of the transform job.
* @public */ - ClientRequestToken?: string | undefined; + TransformJobArn: string | undefined; /** - *This configuration, if specified, overrides the parallelism configuration - * of the parent pipeline.
+ *A timestamp that shows when the transform Job was created.
* @public */ - ParallelismConfiguration?: ParallelismConfiguration | undefined; + CreationTime: Date | undefined; + + /** + *Indicates when the transform + * job + * ends on compute instances. For successful jobs and stopped jobs, this + * is the exact time + * recorded + * after the results are uploaded. For failed jobs, this is when Amazon SageMaker + * detected that the job failed.
+ * @public + */ + TransformEndTime?: Date | undefined; + + /** + *Indicates when the transform job was last modified.
+ * @public + */ + LastModifiedTime?: Date | undefined; + + /** + *The status of the transform job.
+ * @public + */ + TransformJobStatus: TransformJobStatus | undefined; + + /** + *If the transform job failed, + * the + * reason it failed.
+ * @public + */ + FailureReason?: string | undefined; } /** * @public */ -export interface RetryPipelineExecutionResponse { +export interface ListTransformJobsResponse { /** - *The Amazon Resource Name (ARN) of the pipeline execution.
+ *An array of
+ * TransformJobSummary
+ * objects.
If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of + * transform jobs, use it in the next request.
+ * @public + */ + NextToken?: string | undefined; } /** * @public * @enum */ -export const SearchSortOrder = { - ASCENDING: "Ascending", - DESCENDING: "Descending", +export const SortTrialComponentsBy = { + CREATION_TIME: "CreationTime", + NAME: "Name", } as const; /** * @public */ -export type SearchSortOrder = (typeof SearchSortOrder)[keyof typeof SearchSortOrder]; +export type SortTrialComponentsBy = (typeof SortTrialComponentsBy)[keyof typeof SortTrialComponentsBy]; /** - *The list of key-value pairs used to filter your search results. If a search result contains a key from your list, it is included in the final search response if the value associated with the key in the result matches the value you specified. - * If the value doesn't match, the result is excluded from the search response. Any resources that don't have a key from the list that you've provided will also be included in the search response.
* @public */ -export interface VisibilityConditions { +export interface ListTrialComponentsRequest { /** - *The key that specifies the tag that you're using to filter the search results. It must be in the following format: Tags..
A filter that returns only components that are part of the specified experiment. If you
+ * specify ExperimentName, you can't filter by SourceArn or
+ * TrialName.
The value for the tag that you're using to filter the search results.
+ *A filter that returns only components that are part of the specified trial. If you specify
+ * TrialName, you can't filter by ExperimentName or
+ * SourceArn.
Contains information about a training job.
- * @public - */ -export interface TrainingJob { /** - *The name of the training job.
+ *A filter that returns only components that have the specified source Amazon Resource Name (ARN).
+ * If you specify SourceArn, you can't filter by ExperimentName
+ * or TrialName.
The Amazon Resource Name (ARN) of the training job.
+ *A filter that returns only components created after the specified time.
* @public */ - TrainingJobArn?: string | undefined; + CreatedAfter?: Date | undefined; /** - *The Amazon Resource Name (ARN) of the associated hyperparameter tuning job if the - * training job was launched by a hyperparameter tuning job.
+ *A filter that returns only components created before the specified time.
* @public */ - TuningJobArn?: string | undefined; + CreatedBefore?: Date | undefined; /** - *The Amazon Resource Name (ARN) of the labeling job.
+ *The property used to sort results. The default value is CreationTime.
The Amazon Resource Name (ARN) of the job.
+ *The sort order. The default value is Descending.
Information about the Amazon S3 location that is configured for storing model - * artifacts.
+ *The maximum number of components to return in the response. The default value is + * 10.
* @public */ - ModelArtifacts?: ModelArtifacts | undefined; + MaxResults?: number | undefined; /** - *The status of the - * training - * job.
- *Training job statuses are:
- *
- * InProgress - The training is in progress.
- * Completed - The training job has completed.
If the previous call to ListTrialComponents didn't return the full set of
+ * components, the call returns a token for getting the next set of components.
A summary of the properties of a trial component. To get all the properties, call the
+ * DescribeTrialComponent API and provide the
+ * TrialComponentName.
The name of the trial component.
+ * @public + */ + TrialComponentName?: string | undefined; + + /** + *The Amazon Resource Name (ARN) of the trial component.
+ * @public + */ + TrialComponentArn?: string | undefined; + + /** + *The name of the component as displayed. If DisplayName isn't specified,
+ * TrialComponentName is displayed.
The Amazon Resource Name (ARN) and job type of the source of a trial component.
+ * @public + */ + TrialComponentSource?: TrialComponentSource | undefined; + + /** + *The status of the component. States include:
+ *InProgress
+ *Completed
+ *Failed
+ *When the component started.
+ * @public + */ + StartTime?: Date | undefined; + + /** + *When the component ended.
+ * @public + */ + EndTime?: Date | undefined; + + /** + *When the component was created.
+ * @public + */ + CreationTime?: Date | undefined; + + /** + *Who created the trial component.
+ * @public + */ + CreatedBy?: UserContext | undefined; + + /** + *When the component was last modified.
+ * @public + */ + LastModifiedTime?: Date | undefined; + + /** + *Who last modified the component.
+ * @public + */ + LastModifiedBy?: UserContext | undefined; +} + +/** + * @public + */ +export interface ListTrialComponentsResponse { + /** + *A list of the summaries of your trial components.
+ * @public + */ + TrialComponentSummaries?: TrialComponentSummary[] | undefined; + + /** + *A token for getting the next set of components, if there are any.
+ * @public + */ + NextToken?: string | undefined; +} + +/** + * @public + * @enum + */ +export const SortTrialsBy = { + CREATION_TIME: "CreationTime", + NAME: "Name", +} as const; + +/** + * @public + */ +export type SortTrialsBy = (typeof SortTrialsBy)[keyof typeof SortTrialsBy]; + +/** + * @public + */ +export interface ListTrialsRequest { + /** + *A filter that returns only trials that are part of the specified experiment.
+ * @public + */ + ExperimentName?: string | undefined; + + /** + *A filter that returns only trials that are associated with the specified trial + * component.
+ * @public + */ + TrialComponentName?: string | undefined; + + /** + *A filter that returns only trials created after the specified time.
+ * @public + */ + CreatedAfter?: Date | undefined; + + /** + *A filter that returns only trials created before the specified time.
+ * @public + */ + CreatedBefore?: Date | undefined; + + /** + *The property used to sort results. The default value is CreationTime.
The sort order. The default value is Descending.
The maximum number of trials to return in the response. The default value is 10.
+ * @public + */ + MaxResults?: number | undefined; + + /** + *If the previous call to ListTrials didn't return the full set of trials, the
+ * call returns a token for getting the next set of trials.
A summary of the properties of a trial. To get the complete set of properties, call the
+ * DescribeTrial API and provide the TrialName.
The Amazon Resource Name (ARN) of the trial.
+ * @public + */ + TrialArn?: string | undefined; + + /** + *The name of the trial.
+ * @public + */ + TrialName?: string | undefined; + + /** + *The name of the trial as displayed. If DisplayName isn't specified,
+ * TrialName is displayed.
The source of the trial.
+ * @public + */ + TrialSource?: TrialSource | undefined; + + /** + *When the trial was created.
+ * @public + */ + CreationTime?: Date | undefined; + + /** + *When the trial was last modified.
+ * @public + */ + LastModifiedTime?: Date | undefined; +} + +/** + * @public + */ +export interface ListTrialsResponse { + /** + *A list of the summaries of your trials.
+ * @public + */ + TrialSummaries?: TrialSummary[] | undefined; + + /** + *A token for getting the next set of trials, if there are any.
+ * @public + */ + NextToken?: string | undefined; +} + +/** + * @public + * @enum + */ +export const UserProfileSortKey = { + CreationTime: "CreationTime", + LastModifiedTime: "LastModifiedTime", +} as const; + +/** + * @public + */ +export type UserProfileSortKey = (typeof UserProfileSortKey)[keyof typeof UserProfileSortKey]; + +/** + * @public + */ +export interface ListUserProfilesRequest { + /** + *If the previous response was truncated, you will receive this token. Use it in your next + * request to receive the next set of results.
+ * @public + */ + NextToken?: string | undefined; + + /** + *This parameter defines the maximum number of results that can be return in a single
+ * response. The MaxResults parameter is an upper bound, not a target. If there are
+ * more results available than the value specified, a NextToken is provided in the
+ * response. The NextToken indicates that the user should get the next set of
+ * results by providing this token as a part of a subsequent call. The default value for
+ * MaxResults is 10.
The sort order for the results. The default is Ascending.
+ * @public + */ + SortOrder?: SortOrder | undefined; + + /** + *The parameter by which to sort the results. The default is CreationTime.
+ * @public + */ + SortBy?: UserProfileSortKey | undefined; + + /** + *A parameter by which to filter the results.
+ * @public + */ + DomainIdEquals?: string | undefined; + + /** + *A parameter by which to filter the results.
+ * @public + */ + UserProfileNameContains?: string | undefined; +} + +/** + *The user profile details.
+ * @public + */ +export interface UserProfileDetails { + /** + *The domain ID.
+ * @public + */ + DomainId?: string | undefined; + + /** + *The user profile name.
+ * @public + */ + UserProfileName?: string | undefined; + + /** + *The status.
+ * @public + */ + Status?: UserProfileStatus | undefined; + + /** + *The creation time.
+ * @public + */ + CreationTime?: Date | undefined; + + /** + *The last modified time.
+ * @public + */ + LastModifiedTime?: Date | undefined; +} + +/** + * @public + */ +export interface ListUserProfilesResponse { + /** + *The list of user profiles.
+ * @public + */ + UserProfiles?: UserProfileDetails[] | undefined; + + /** + *If the previous response was truncated, you will receive this token. Use it in your next + * request to receive the next set of results.
+ * @public + */ + NextToken?: string | undefined; +} + +/** + * @public + * @enum + */ +export const ListWorkforcesSortByOptions = { + CreateDate: "CreateDate", + Name: "Name", +} as const; + +/** + * @public + */ +export type ListWorkforcesSortByOptions = + (typeof ListWorkforcesSortByOptions)[keyof typeof ListWorkforcesSortByOptions]; + +/** + * @public + */ +export interface ListWorkforcesRequest { + /** + *Sort workforces using the workforce name or creation date.
+ * @public + */ + SortBy?: ListWorkforcesSortByOptions | undefined; + + /** + *Sort workforces in ascending or descending order.
+ * @public + */ + SortOrder?: SortOrder | undefined; + + /** + *A filter you can use to search for workforces using part of the workforce name.
+ * @public + */ + NameContains?: string | undefined; + + /** + *A token to resume pagination.
+ * @public + */ + NextToken?: string | undefined; + + /** + *The maximum number of workforces returned in the response.
+ * @public + */ + MaxResults?: number | undefined; +} + +/** + * @public + */ +export interface ListWorkforcesResponse { + /** + *A list containing information about your workforce.
+ * @public + */ + Workforces: Workforce[] | undefined; + + /** + *A token to resume pagination.
+ * @public + */ + NextToken?: string | undefined; +} + +/** + * @public + * @enum + */ +export const ListWorkteamsSortByOptions = { + CreateDate: "CreateDate", + Name: "Name", +} as const; + +/** + * @public + */ +export type ListWorkteamsSortByOptions = (typeof ListWorkteamsSortByOptions)[keyof typeof ListWorkteamsSortByOptions]; + +/** + * @public + */ +export interface ListWorkteamsRequest { + /** + *The field to sort results by. The default is CreationTime.
The sort order for results. The default is Ascending.
A string in the work team's name. This filter returns only work teams whose name + * contains the specified string.
+ * @public + */ + NameContains?: string | undefined; + + /** + *If the result of the previous ListWorkteams request was truncated, the
+ * response includes a NextToken. To retrieve the next set of labeling jobs,
+ * use the token in the next request.
The maximum number of work teams to return in each page of the response.
+ * @public + */ + MaxResults?: number | undefined; +} + +/** + * @public + */ +export interface ListWorkteamsResponse { + /** + *An array of Workteam objects, each describing a work team.
If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of + * work teams, use it in the subsequent request.
+ * @public + */ + NextToken?: string | undefined; +} + +/** + *The properties of a model as returned by the Search API.
+ * @public + */ +export interface Model { + /** + *The name of the model.
+ * @public + */ + ModelName?: string | undefined; + + /** + *Describes the container, as part of model definition.
+ * @public + */ + PrimaryContainer?: ContainerDefinition | undefined; + + /** + *The containers in the inference pipeline.
+ * @public + */ + Containers?: ContainerDefinition[] | undefined; + + /** + *Specifies details about how containers in a multi-container endpoint are run.
+ * @public + */ + InferenceExecutionConfig?: InferenceExecutionConfig | undefined; + + /** + *The Amazon Resource Name (ARN) of the IAM role that you specified for the + * model.
+ * @public + */ + ExecutionRoleArn?: string | undefined; + + /** + *Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources + * have access to. You can control access to and from your resources by configuring a VPC. + * For more information, see Give SageMaker Access to + * Resources in your Amazon VPC.
+ * @public + */ + VpcConfig?: VpcConfig | undefined; + + /** + *A timestamp that indicates when the model was created.
+ * @public + */ + CreationTime?: Date | undefined; + + /** + *The Amazon Resource Name (ARN) of the model.
+ * @public + */ + ModelArn?: string | undefined; + + /** + *Isolates the model container. No inbound or outbound network calls can be made to or + * from the model container.
+ * @public + */ + EnableNetworkIsolation?: 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.
+ * @public + */ + Tags?: Tag[] | undefined; + + /** + *A set of recommended deployment configurations for the model.
+ * @public + */ + DeploymentRecommendation?: DeploymentRecommendation | undefined; +} + +/** + *An Amazon SageMaker Model Card.
+ * @public + */ +export interface ModelCard { + /** + *The Amazon Resource Name (ARN) of the model card.
+ * @public + */ + ModelCardArn?: string | undefined; + + /** + *The unique name of the model card.
+ * @public + */ + ModelCardName?: string | undefined; + + /** + *The version of the model card.
+ * @public + */ + ModelCardVersion?: number | undefined; + + /** + *The content of the model card. Content uses the model card JSON schema and provided as a string.
+ * @public + */ + Content?: string | undefined; + + /** + *The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.
+ *
+ * Draft: The model card is a work in progress.
- * Failed - The training job has failed. To see the reason for the
- * failure, see the FailureReason field in the response to a
- * DescribeTrainingJobResponse call.
PendingReview: The model card is pending review.
*
- * Stopping - The training job is stopping.
Approved: The model card is approved.
*
- * Stopped - The training job has stopped.
Archived: The model card is archived. No more updates should be made to the model
+ * card, but it can still be exported.
* For
- * more detailed information, see SecondaryStatus.
The security configuration used to protect model card data.
+ * @public + */ + SecurityConfig?: ModelCardSecurityConfig | undefined; + + /** + *The date and time that the model card was created.
+ * @public + */ + CreationTime?: Date | undefined; + + /** + *Information about the user who created or modified an experiment, trial, trial + * component, lineage group, project, or model card.
+ * @public + */ + CreatedBy?: UserContext | undefined; + + /** + *The date and time that the model card was last modified.
+ * @public + */ + LastModifiedTime?: Date | undefined; + + /** + *Information about the user who created or modified an experiment, trial, trial + * component, lineage group, project, or model card.
+ * @public + */ + LastModifiedBy?: UserContext | undefined; + + /** + *Key-value pairs used to manage metadata for the model card.
+ * @public + */ + Tags?: Tag[] | undefined; + + /** + *The unique name (ID) of the model.
+ * @public + */ + ModelId?: string | undefined; + + /** + *The risk rating of the model. Different organizations might have different criteria for model card risk ratings. For more information, see Risk ratings.
+ * @public + */ + RiskRating?: string | undefined; + + /** + *The model package group that contains the model package. Only relevant for model cards created for model packages in the Amazon SageMaker Model Registry. + *
+ * @public + */ + ModelPackageGroupName?: string | undefined; +} + +/** + *An endpoint that hosts a model displayed in the Amazon SageMaker Model Dashboard.
+ * @public + */ +export interface ModelDashboardEndpoint { + /** + *The endpoint name.
+ * @public + */ + EndpointName: string | undefined; + + /** + *The Amazon Resource Name (ARN) of the endpoint.
+ * @public + */ + EndpointArn: string | undefined; + + /** + *A timestamp that indicates when the endpoint was created.
+ * @public + */ + CreationTime: Date | undefined; + + /** + *The last time the endpoint was modified.
+ * @public + */ + LastModifiedTime: Date | undefined; + + /** + *The endpoint status.
+ * @public + */ + EndpointStatus: EndpointStatus | undefined; +} + +/** + *A batch transform job. For information about SageMaker batch transform, see Use Batch + * Transform.
+ * @public + */ +export interface TransformJob { + /** + *The name of the transform job.
+ * @public + */ + TransformJobName?: string | undefined; + + /** + *The Amazon Resource Name (ARN) of the transform job.
+ * @public + */ + TransformJobArn?: string | undefined; + + /** + *The status of the transform job.
+ *Transform job statuses are:
+ *
+ * InProgress - The job is in progress.
+ * Completed - The job has completed.
+ * Failed - The transform job has failed. To see the reason for the failure,
+ * see the FailureReason field in the response to a
+ * DescribeTransformJob call.
+ * Stopping - The transform job is stopping.
+ * Stopped - The transform job has stopped.
If the transform job failed, the reason it failed.
+ * @public + */ + FailureReason?: string | undefined; + + /** + *The name of the model associated with the transform job.
+ * @public + */ + ModelName?: string | undefined; + + /** + *The maximum number of parallel requests that can be sent to each instance in a transform
+ * job. If MaxConcurrentTransforms is set to 0 or left unset, SageMaker checks the
+ * optional execution-parameters to determine the settings for your chosen algorithm. If the
+ * execution-parameters endpoint is not enabled, the default value is 1. For built-in algorithms,
+ * you don't need to set a value for MaxConcurrentTransforms.
Configures the timeout and maximum number of retries for processing a transform job + * invocation.
+ * @public + */ + ModelClientConfig?: ModelClientConfig | undefined; + + /** + *The maximum allowed size of the payload, in MB. A payload is the data portion of a record
+ * (without metadata). The value in MaxPayloadInMB must be greater than, or equal
+ * to, the size of a single record. To estimate the size of a record in MB, divide the size of
+ * your dataset by the number of records. To ensure that the records fit within the maximum
+ * payload size, we recommend using a slightly larger value. The default value is 6 MB. For cases
+ * where the payload might be arbitrarily large and is transmitted using HTTP chunked encoding,
+ * set the value to 0. This feature works only in supported algorithms. Currently, SageMaker built-in
+ * algorithms do not support HTTP chunked encoding.
Specifies the number of records to include in a mini-batch for an HTTP inference request. + * A record is a single unit of input data that inference can be made on. For example, a single + * line in a CSV file is a record.
+ * @public + */ + BatchStrategy?: BatchStrategy | undefined; + + /** + *The environment variables to set in the Docker container. We support up to 16 key and + * values entries in the map.
+ * @public + */ + Environment?: RecordDescribes the input source of a transform job and the way the transform job consumes + * it.
+ * @public + */ + TransformInput?: TransformInput | undefined; + + /** + *Describes the results of a transform job.
+ * @public + */ + TransformOutput?: TransformOutput | undefined; + + /** + *Configuration to control how SageMaker captures inference data for batch transform jobs.
+ * @public + */ + DataCaptureConfig?: BatchDataCaptureConfig | undefined; + + /** + *Describes the resources, including ML instance types and ML instance count, to use for + * transform job.
+ * @public + */ + TransformResources?: TransformResources | undefined; + + /** + *A timestamp that shows when the transform Job was created.
+ * @public + */ + CreationTime?: Date | undefined; + + /** + *Indicates when the transform job starts on ML instances. You are billed for the time
+ * interval between this time and the value of TransformEndTime.
Indicates when the transform job has been completed, or has stopped or failed. You are
+ * billed for the time interval between this time and the value of
+ * TransformStartTime.
Provides detailed information about the state of the training job. For detailed
- * information about the secondary status of the training job, see
- * StatusMessage under SecondaryStatusTransition.
SageMaker provides primary statuses and secondary statuses that apply to each of - * them:
- *
- * Starting
- * - Starting the training job.
- * Downloading - An optional stage for algorithms that
- * support File training input mode. It indicates that
- * data is being downloaded to the ML storage volumes.
- * Training - Training is in progress.
- * Uploading - Training is complete and the model
- * artifacts are being uploaded to the S3 location.
- * Completed - The training job has completed.
- * Failed - The training job has failed. The reason for
- * the failure is returned in the FailureReason field of
- * DescribeTrainingJobResponse.
- * MaxRuntimeExceeded - The job stopped because it
- * exceeded the maximum allowed runtime.
- * Stopped - The training job has stopped.
- * Stopping - Stopping the training job.
Valid values for SecondaryStatus are subject to change.
We no longer support the following secondary statuses:
+ *The Amazon Resource Name (ARN) of the labeling job that created the transform job.
+ * @public + */ + LabelingJobArn?: string | undefined; + + /** + *The Amazon Resource Name (ARN) of the AutoML job that created the transform job.
+ * @public + */ + AutoMLJobArn?: string | undefined; + + /** + *The data structure used to specify the data to be used for inference in a batch + * transform job and to associate the data that is relevant to the prediction results in + * the output. The input filter provided allows you to exclude input data that is not + * needed for inference in a batch transform job. The output filter provided allows you to + * include input data relevant to interpreting the predictions in the output from the job. + * For more information, see Associate Prediction + * Results with their Corresponding Input Records.
+ * @public + */ + DataProcessing?: DataProcessing | undefined; + + /** + *Associates a SageMaker job as a trial component with an experiment and trial. Specified when + * you call the following APIs:
*
- * LaunchingMLInstances
+ * CreateProcessingJob
*
- * PreparingTrainingStack
+ * CreateTrainingJob
*
- * DownloadingTrainingImage
+ * CreateTransformJob
*
If the training job failed, the reason it failed.
+ *A list of tags associated with the transform job.
+ * @public + */ + Tags?: Tag[] | undefined; +} + +/** + *The model card for a model displayed in the Amazon SageMaker Model Dashboard.
+ * @public + */ +export interface ModelDashboardModelCard { + /** + *The Amazon Resource Name (ARN) for a model card.
+ * @public + */ + ModelCardArn?: string | undefined; + + /** + *The name of a model card.
+ * @public + */ + ModelCardName?: string | undefined; + + /** + *The model card version.
+ * @public + */ + ModelCardVersion?: number | undefined; + + /** + *The model card status.
+ * @public + */ + ModelCardStatus?: ModelCardStatus | undefined; + + /** + *The KMS Key ID (KMSKeyId) for encryption of model card information.
A timestamp that indicates when the model card was created.
+ * @public + */ + CreationTime?: Date | undefined; + + /** + *Information about the user who created or modified an experiment, trial, trial + * component, lineage group, project, or model card.
+ * @public + */ + CreatedBy?: UserContext | undefined; + + /** + *A timestamp that indicates when the model card was last updated.
+ * @public + */ + LastModifiedTime?: Date | undefined; + + /** + *Information about the user who created or modified an experiment, trial, trial + * component, lineage group, project, or model card.
+ * @public + */ + LastModifiedBy?: UserContext | undefined; + + /** + *The tags associated with a model card.
+ * @public + */ + Tags?: Tag[] | undefined; + + /** + *For models created in SageMaker, this is the model ARN. For models created + * outside of SageMaker, this is a user-customized string.
+ * @public + */ + ModelId?: string | undefined; + + /** + *A model card's risk rating. Can be low, medium, or high.
+ * @public + */ + RiskRating?: string | undefined; +} + +/** + *A monitoring schedule for a model displayed in the Amazon SageMaker Model Dashboard.
+ * @public + */ +export interface ModelDashboardMonitoringSchedule { + /** + *The Amazon Resource Name (ARN) of a monitoring schedule.
+ * @public + */ + MonitoringScheduleArn?: string | undefined; + + /** + *The name of a monitoring schedule.
+ * @public + */ + MonitoringScheduleName?: string | undefined; + + /** + *The status of the monitoring schedule.
+ * @public + */ + MonitoringScheduleStatus?: ScheduleStatus | undefined; + + /** + *The monitor type of a model monitor.
+ * @public + */ + MonitoringType?: MonitoringType | undefined; + + /** + *If a monitoring job failed, provides the reason.
* @public */ FailureReason?: string | undefined; /** - *Algorithm-specific parameters.
+ *A timestamp that indicates when the monitoring schedule was created.
* @public */ - HyperParameters?: RecordInformation about the algorithm used for training, and algorithm metadata.
+ *A timestamp that indicates when the monitoring schedule was last updated.
* @public */ - AlgorithmSpecification?: AlgorithmSpecification | undefined; + LastModifiedTime?: Date | undefined; /** - *The Amazon Web Services Identity and Access Management (IAM) role configured for the - * training job.
+ *Configures the monitoring schedule and defines the monitoring job.
* @public */ - RoleArn?: string | undefined; + MonitoringScheduleConfig?: MonitoringScheduleConfig | undefined; /** - *An array of Channel objects that describes each data input
- * channel.
Your input must be in the same Amazon Web Services region as your training job.
+ *The endpoint which is monitored.
* @public */ - InputDataConfig?: Channel[] | undefined; + EndpointName?: string | undefined; /** - *The S3 path where model artifacts that you configured when creating the job are - * stored. SageMaker creates subfolders for model artifacts.
+ *A JSON array where each element is a summary for a monitoring alert.
* @public */ - OutputDataConfig?: OutputDataConfig | undefined; + MonitoringAlertSummaries?: MonitoringAlertSummary[] | undefined; /** - *Resources, including ML compute instances and ML storage volumes, that are configured - * for model training.
+ *Summary of information about the last monitoring job to run.
* @public */ - ResourceConfig?: ResourceConfig | undefined; + LastMonitoringExecutionSummary?: MonitoringExecutionSummary | undefined; /** - *A VpcConfig object that specifies the VPC that this training job has access - * to. For more information, see Protect Training Jobs by Using an Amazon - * Virtual Private Cloud.
+ *Input object for the batch transform job.
* @public */ - VpcConfig?: VpcConfig | undefined; + BatchTransformInput?: BatchTransformInput | undefined; +} +/** + *A model displayed in the Amazon SageMaker Model Dashboard.
+ * @public + */ +export interface ModelDashboardModel { /** - *Specifies a limit to how long a model training job can run. It also specifies how long - * a managed Spot training job has to complete. When the job reaches the time limit, SageMaker - * ends the training job. Use this API to cap model training costs.
- *To stop a job, SageMaker sends the algorithm the SIGTERM signal, which delays
- * job termination for 120 seconds. Algorithms can use this 120-second window to save the
- * model artifacts, so the results of training are not lost.
A model displayed in the Model Dashboard.
* @public */ - StoppingCondition?: StoppingCondition | undefined; + Model?: Model | undefined; /** - *A timestamp that indicates when the training job was created.
+ *The endpoints that host a model.
* @public */ - CreationTime?: Date | undefined; + Endpoints?: ModelDashboardEndpoint[] | undefined; /** - *Indicates the time when the training job starts on training instances. You are billed
- * for the time interval between this time and the value of TrainingEndTime.
- * The start time in CloudWatch Logs might be later than this time. The difference is due to the time
- * it takes to download the training data and to the size of the training container.
A batch transform job. For information about SageMaker batch transform, see Use Batch + * Transform.
* @public */ - TrainingStartTime?: Date | undefined; + LastBatchTransformJob?: TransformJob | undefined; /** - *Indicates the time when the training job ends on training instances. You are billed
- * for the time interval between the value of TrainingStartTime and this time.
- * For successful jobs and stopped jobs, this is the time after model artifacts are
- * uploaded. For failed jobs, this is the time when SageMaker detects a job failure.
The monitoring schedules for a model.
* @public */ - TrainingEndTime?: Date | undefined; + MonitoringSchedules?: ModelDashboardMonitoringSchedule[] | undefined; /** - *A timestamp that indicates when the status of the training job was last - * modified.
+ *The model card for a model.
* @public */ - LastModifiedTime?: Date | undefined; + ModelCard?: ModelDashboardModelCard | undefined; +} +/** + *A versioned model that can be deployed for SageMaker inference.
+ * @public + */ +export interface ModelPackage { /** - *A history of all of the secondary statuses that the training job has transitioned - * through.
+ *The name of the model.
* @public */ - SecondaryStatusTransitions?: SecondaryStatusTransition[] | undefined; + ModelPackageName?: string | undefined; /** - *A list of final metric values that are set when the training job completes. Used only - * if the training job was configured to use metrics.
+ *The model group to which the model belongs.
* @public */ - FinalMetricDataList?: MetricData[] | undefined; + ModelPackageGroupName?: string | undefined; /** - *If the TrainingJob was created with network isolation, the value is set
- * to true. If network isolation is enabled, nodes can't communicate beyond
- * the VPC they run in.
The version number of a versioned model.
* @public */ - EnableNetworkIsolation?: boolean | undefined; + ModelPackageVersion?: number | undefined; /** - *To encrypt all communications between ML compute instances in distributed training,
- * choose True. Encryption provides greater security for distributed training,
- * but training might take longer. How long it takes depends on the amount of communication
- * between compute instances, especially if you use a deep learning algorithm in
- * distributed training.
The Amazon Resource Name (ARN) of the model package.
* @public */ - EnableInterContainerTrafficEncryption?: boolean | undefined; + ModelPackageArn?: string | undefined; /** - *When true, enables managed spot training using Amazon EC2 Spot instances to run - * training jobs instead of on-demand instances. For more information, see Managed Spot Training.
+ *The description of the model package.
* @public */ - EnableManagedSpotTraining?: boolean | undefined; + ModelPackageDescription?: string | undefined; /** - *Contains information about the output location for managed spot training checkpoint - * data.
+ *The time that the model package was created.
* @public */ - CheckpointConfig?: CheckpointConfig | undefined; + CreationTime?: Date | undefined; /** - *The training time in seconds.
+ *Defines how to perform inference generation after a training job is run.
* @public */ - TrainingTimeInSeconds?: number | undefined; + InferenceSpecification?: InferenceSpecification | undefined; /** - *The billable time in seconds.
+ *A list of algorithms that were used to create a model package.
* @public */ - BillableTimeInSeconds?: number | undefined; + SourceAlgorithmSpecification?: SourceAlgorithmSpecification | undefined; /** - *Configuration information for the Amazon SageMaker Debugger hook parameters, metric and tensor collections, and
- * storage paths. To learn more about
- * how to configure the DebugHookConfig parameter,
- * see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.
Specifies batch transform jobs that SageMaker runs to validate your model package.
* @public */ - DebugHookConfig?: DebugHookConfig | undefined; + ValidationSpecification?: ModelPackageValidationSpecification | undefined; /** - *Associates a SageMaker job as a trial component with an experiment and trial. Specified when - * you call the following APIs:
+ *The status of the model package. This can be one of the following values.
*- * CreateProcessingJob - *
+ *PENDING - The model package is pending being created.
* - * CreateTrainingJob - *
+ *IN_PROGRESS - The model package is in the process of being
+ * created.
* - * CreateTransformJob - *
+ *COMPLETED - The model package was successfully created.
+ *
+ * FAILED - The model package failed.
+ * DELETING - The model package is in the process of being deleted.
Information about the debug rule configuration.
- * @public - */ - DebugRuleConfigurations?: DebugRuleConfiguration[] | undefined; - - /** - *Configuration of storage locations for the Amazon SageMaker Debugger TensorBoard output data.
- * @public - */ - TensorBoardOutputConfig?: TensorBoardOutputConfig | undefined; - - /** - *Information about the evaluation status of the rules for the training job.
- * @public - */ - DebugRuleEvaluationStatuses?: DebugRuleEvaluationStatus[] | undefined; + ModelPackageStatus?: ModelPackageStatus | undefined; /** - *Configuration information for Amazon SageMaker Debugger system monitoring, framework profiling, and - * storage paths.
+ *Specifies the validation and image scan statuses of the model package.
* @public */ - ProfilerConfig?: ProfilerConfig | undefined; + ModelPackageStatusDetails?: ModelPackageStatusDetails | undefined; /** - *The environment variables to set in the Docker container.
+ *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 */ - Environment?: RecordThe number of times to retry the job when the job fails due to an
- * InternalServerError.
The approval status of the model. This can be one of the following values.
+ *
+ * APPROVED - The model is approved
+ * REJECTED - The model is rejected.
+ * PENDING_MANUAL_APPROVAL - The model is waiting for manual
+ * approval.
An array of key-value pairs. You can use tags to categorize your Amazon Web Services - * resources in different ways, for example, by purpose, owner, or environment. For more - * information, see Tagging Amazon Web Services Resources.
+ *Information about the user who created or modified an experiment, trial, trial component, lineage group, or project.
* @public */ - Tags?: Tag[] | undefined; -} + CreatedBy?: UserContext | undefined; -/** - *A short summary of a trial component.
- * @public - */ -export interface TrialComponentSimpleSummary { /** - *The name of the trial component.
+ *Metadata properties of the tracking entity, trial, or trial component.
* @public */ - TrialComponentName?: string | undefined; + MetadataProperties?: MetadataProperties | undefined; /** - *The Amazon Resource Name (ARN) of the trial component.
+ *Metrics for the model.
* @public */ - TrialComponentArn?: string | undefined; + ModelMetrics?: ModelMetrics | undefined; /** - *The Amazon Resource Name (ARN) and job type of the source of a trial component.
+ *The last time the model package was modified.
* @public */ - TrialComponentSource?: TrialComponentSource | undefined; + LastModifiedTime?: Date | undefined; /** - *When the component was created.
+ *Information about the user who created or modified an experiment, trial, trial component, lineage group, or project.
* @public */ - CreationTime?: Date | undefined; + LastModifiedBy?: UserContext | undefined; /** - *Information about the user who created or modified an experiment, trial, trial - * component, lineage group, project, or model card.
+ *A description provided when the model approval is set.
* @public */ - CreatedBy?: UserContext | undefined; -} + ApprovalDescription?: string | undefined; -/** - *The properties of a trial as returned by the Search API.
- * @public - */ -export interface Trial { /** - *The name of the trial.
+ *The machine learning domain of your model package and its components. Common + * machine learning domains include computer vision and natural language processing.
* @public */ - TrialName?: string | undefined; + Domain?: string | undefined; /** - *The Amazon Resource Name (ARN) of the trial.
+ *The machine learning task your model package accomplishes. Common machine + * learning tasks include object detection and image classification.
* @public */ - TrialArn?: string | undefined; + Task?: string | undefined; /** - *The name of the trial as displayed. If DisplayName isn't specified,
- * TrialName is displayed.
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 */ - DisplayName?: string | undefined; + SamplePayloadUrl?: string | undefined; /** - *The name of the experiment the trial is part of.
+ *An array of additional Inference Specification objects.
* @public */ - ExperimentName?: string | undefined; + AdditionalInferenceSpecifications?: AdditionalInferenceSpecificationDefinition[] | undefined; /** - *The source of the trial.
+ *The URI of the source for the model package.
* @public */ - Source?: TrialSource | undefined; + SourceUri?: string | undefined; /** - *When the trial was created.
+ *An optional Key Management Service + * key to encrypt, decrypt, and re-encrypt model package information for regulated workloads with + * highly sensitive data.
* @public */ - CreationTime?: Date | undefined; + SecurityConfig?: ModelPackageSecurityConfig | undefined; /** - *Who created the trial.
+ *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.
Who last modified the trial.
+ *+ * A structure describing the current state of the model in its life cycle. + *
* @public */ - LastModifiedTime?: Date | undefined; + ModelLifeCycle?: ModelLifeCycle | undefined; /** - *Information about the user who created or modified an experiment, trial, trial - * component, lineage group, project, or model card.
+ *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 */ - LastModifiedBy?: UserContext | undefined; + Tags?: Tag[] | undefined; /** - *Metadata properties of the tracking entity, trial, or trial component.
+ *The metadata properties for the model package.
* @public */ - MetadataProperties?: MetadataProperties | undefined; + CustomerMetadataProperties?: RecordThe list of tags that are associated with the trial. You can use Search - * API to search on the tags.
+ *Represents the drift check baselines that can be used when the model monitor is set using the model package.
* @public */ - Tags?: Tag[] | undefined; + DriftCheckBaselines?: DriftCheckBaselines | undefined; /** - *A list of the components associated with the trial. For each component, a summary of the - * component's properties is included.
+ *Indicates if you want to skip model validation.
* @public */ - TrialComponentSummaries?: TrialComponentSimpleSummary[] | undefined; + SkipModelValidation?: SkipModelValidation | undefined; } /** - *Detailed information about the source of a trial component. Either
- * ProcessingJob or TrainingJob is returned.
A group of versioned models in the model registry.
* @public */ -export interface TrialComponentSourceDetail { +export interface ModelPackageGroup { /** - *The Amazon Resource Name (ARN) of the source.
+ *The name of the model group.
* @public */ - SourceArn?: string | undefined; + ModelPackageGroupName?: string | undefined; /** - *Information about a training job that's the source of a trial component.
+ *The Amazon Resource Name (ARN) of the model group.
* @public */ - TrainingJob?: TrainingJob | undefined; + ModelPackageGroupArn?: string | undefined; /** - *Information about a processing job that's the source of a trial component.
+ *The description for the model group.
* @public */ - ProcessingJob?: ProcessingJob | undefined; + ModelPackageGroupDescription?: string | undefined; /** - *Information about a transform job that's the source of a trial component.
+ *The time that the model group was created.
* @public */ - TransformJob?: TransformJob | undefined; -} + CreationTime?: Date | undefined; -/** - *The properties of a trial component as returned by the Search - * API.
- * @public - */ -export interface TrialComponent { /** - *The name of the trial component.
+ *Information about the user who created or modified an experiment, trial, trial + * component, lineage group, project, or model card.
* @public */ - TrialComponentName?: string | undefined; + CreatedBy?: UserContext | undefined; /** - *The name of the component as displayed. If DisplayName isn't specified,
- * TrialComponentName is displayed.
The status of the model group. This can be one of the following values.
+ *
+ * PENDING - The model group is pending being created.
+ * IN_PROGRESS - The model group is in the process of being
+ * created.
+ * COMPLETED - The model group was successfully created.
+ * FAILED - The model group failed.
+ * DELETING - The model group is in the process of being deleted.
+ * DELETE_FAILED - SageMaker failed to delete the model group.
The Amazon Resource Name (ARN) of the trial component.
+ *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 */ - TrialComponentArn?: string | undefined; + Tags?: Tag[] | undefined; +} + +/** + * @public + * @enum + */ +export const ModelVariantAction = { + PROMOTE: "Promote", + REMOVE: "Remove", + RETAIN: "Retain", +} as const; + +/** + * @public + */ +export type ModelVariantAction = (typeof ModelVariantAction)[keyof typeof ModelVariantAction]; +/** + *A list of nested Filter objects. A resource must satisfy the conditions + * of all filters to be included in the results returned from the Search API.
+ *For example, to filter on a training job's InputDataConfig property with a
+ * specific channel name and S3Uri prefix, define the following filters:
+ * '\{Name:"InputDataConfig.ChannelName", "Operator":"Equals", "Value":"train"\}',
+ *
+ * '\{Name:"InputDataConfig.DataSource.S3DataSource.S3Uri", "Operator":"Contains",
+ * "Value":"mybucket/catdata"\}'
+ *
The Amazon Resource Name (ARN) and job type of the source of the component.
+ *The name of the property to use in the nested filters. The value must match a listed property name,
+ * such as InputDataConfig.
The status of the trial component.
+ *A list of filters. Each filter acts on a property. Filters must contain at least one
+ * Filters value. For example, a NestedFilters call might
+ * include a filter on the PropertyName parameter of the
+ * InputDataConfig property:
+ * InputDataConfig.DataSource.S3DataSource.S3Uri.
Updates the feature group online store configuration.
+ * @public + */ +export interface OnlineStoreConfigUpdate { /** - *When the component started.
+ *Time to live duration, where the record is hard deleted after the expiration time is
+ * reached; ExpiresAt = EventTime + TtlDuration. For
+ * information on HardDelete, see the DeleteRecord API in the Amazon SageMaker API Reference guide.
The trial that a trial component is associated with and the experiment the trial is part + * of. A component might not be associated with a trial. A component can be associated with + * multiple trials.
+ * @public + */ +export interface Parent { /** - *When the component ended.
+ *The name of the trial.
* @public */ - EndTime?: Date | undefined; + TrialName?: string | undefined; /** - *When the component was created.
+ *The name of the experiment.
* @public */ - CreationTime?: Date | undefined; + ExperimentName?: string | undefined; +} +/** + *A SageMaker Model Building Pipeline instance.
+ * @public + */ +export interface Pipeline { /** - *Who created the trial component.
+ *The Amazon Resource Name (ARN) of the pipeline.
* @public */ - CreatedBy?: UserContext | undefined; + PipelineArn?: string | undefined; /** - *When the component was last modified.
+ *The name of the pipeline.
* @public */ - LastModifiedTime?: Date | undefined; + PipelineName?: string | undefined; /** - *Information about the user who created or modified an experiment, trial, trial - * component, lineage group, project, or model card.
+ *The display name of the pipeline.
* @public */ - LastModifiedBy?: UserContext | undefined; + PipelineDisplayName?: string | undefined; /** - *The hyperparameters of the component.
+ *The description of the pipeline.
* @public */ - Parameters?: RecordThe input artifacts of the component.
+ *The Amazon Resource Name (ARN) of the role that created the pipeline.
* @public */ - InputArtifacts?: RecordThe output artifacts of the component.
+ *The status of the pipeline.
* @public */ - OutputArtifacts?: RecordThe metrics for the component.
+ *The creation time of the pipeline.
* @public */ - Metrics?: TrialComponentMetricSummary[] | undefined; + CreationTime?: Date | undefined; /** - *Metadata properties of the tracking entity, trial, or trial component.
+ *The time that the pipeline was last modified.
* @public */ - MetadataProperties?: MetadataProperties | undefined; + LastModifiedTime?: Date | undefined; /** - *Details of the source of the component.
+ *The time when the pipeline was last run.
* @public */ - SourceDetail?: TrialComponentSourceDetail | undefined; + LastRunTime?: Date | undefined; /** - *The Amazon Resource Name (ARN) of the lineage group resource.
+ *Information about the user who created or modified an experiment, trial, trial + * component, lineage group, project, or model card.
* @public */ - LineageGroupArn?: string | undefined; + CreatedBy?: UserContext | undefined; /** - *The list of tags that are associated with the component. You can use Search API to search on the tags.
+ *Information about the user who created or modified an experiment, trial, trial + * component, lineage group, project, or model card.
* @public */ - Tags?: Tag[] | undefined; + LastModifiedBy?: UserContext | undefined; /** - *An array of the parents of the component. A parent is a trial the component is associated - * with and the experiment the trial is part of. A component might not have any parents.
+ *The parallelism configuration applied to the pipeline.
* @public */ - Parents?: Parent[] | undefined; + ParallelismConfiguration?: ParallelismConfiguration | undefined; /** - *The name of the experiment run.
+ *A list of tags that apply to the pipeline.
* @public */ - RunName?: string | undefined; + Tags?: Tag[] | undefined; } /** - *A single resource returned as part of the Search API response.
+ *An execution of a pipeline.
* @public - */ -export interface SearchRecord { - /** - *The properties of a training job.
- * @public - */ - TrainingJob?: TrainingJob | undefined; - + */ +export interface PipelineExecution { /** - *The properties of an experiment.
+ *The Amazon Resource Name (ARN) of the pipeline that was executed.
* @public */ - Experiment?: Experiment | undefined; + PipelineArn?: string | undefined; /** - *The properties of a trial.
+ *The Amazon Resource Name (ARN) of the pipeline execution.
* @public */ - Trial?: Trial | undefined; + PipelineExecutionArn?: string | undefined; /** - *The properties of a trial component.
+ *The display name of the pipeline execution.
* @public */ - TrialComponent?: TrialComponent | undefined; + PipelineExecutionDisplayName?: string | undefined; /** - *A hosted endpoint for real-time inference.
+ *The status of the pipeline status.
* @public */ - Endpoint?: Endpoint | undefined; + PipelineExecutionStatus?: PipelineExecutionStatus | undefined; /** - *A versioned model that can be deployed for SageMaker inference.
+ *The description of the pipeline execution.
* @public */ - ModelPackage?: ModelPackage | undefined; + PipelineExecutionDescription?: string | undefined; /** - *A group of versioned models in the model registry.
+ *Specifies the names of the experiment and trial created by a pipeline.
* @public */ - ModelPackageGroup?: ModelPackageGroup | undefined; + PipelineExperimentConfig?: PipelineExperimentConfig | undefined; /** - *A SageMaker Model Building Pipeline instance.
+ *If the execution failed, a message describing why.
* @public */ - Pipeline?: Pipeline | undefined; + FailureReason?: string | undefined; /** - *An execution of a pipeline.
+ *The creation time of the pipeline execution.
* @public */ - PipelineExecution?: PipelineExecution | undefined; + CreationTime?: Date | undefined; /** - *Amazon SageMaker Feature Store stores features in a collection called Feature Group. A - * Feature Group can be visualized as a table which has rows, with a unique identifier for - * each row where each column in the table is a feature. In principle, a Feature Group is - * composed of features and values per features.
+ *The time that the pipeline execution was last modified.
* @public */ - FeatureGroup?: FeatureGroup | undefined; + LastModifiedTime?: Date | undefined; /** - *The feature metadata used to search through the features.
+ *Information about the user who created or modified an experiment, trial, trial + * component, lineage group, project, or model card.
* @public */ - FeatureMetadata?: FeatureMetadata | undefined; + CreatedBy?: UserContext | undefined; /** - *The properties of a project.
+ *Information about the user who created or modified an experiment, trial, trial + * component, lineage group, project, or model card.
* @public */ - Project?: Project | undefined; + LastModifiedBy?: UserContext | undefined; /** - *The properties of a hyperparameter tuning job.
+ *The parallelism configuration applied to the pipeline execution.
* @public */ - HyperParameterTuningJob?: HyperParameterTuningJobSearchEntity | undefined; + ParallelismConfiguration?: ParallelismConfiguration | undefined; /** - *An Amazon SageMaker Model Card that documents details about a machine learning model.
+ *The selective execution configuration applied to the pipeline run.
* @public */ - ModelCard?: ModelCard | undefined; + SelectiveExecutionConfig?: SelectiveExecutionConfig | undefined; /** - *A model displayed in the Amazon SageMaker Model Dashboard.
+ *Contains a list of pipeline parameters. This list can be empty.
* @public */ - Model?: ModelDashboardModel | undefined; + PipelineParameters?: Parameter[] | undefined; } /** + *An Amazon SageMaker processing job that is used to analyze data and evaluate models. For more information, + * see Process + * Data and Evaluate Models.
* @public */ -export interface SearchResponse { +export interface ProcessingJob { /** - *A list of SearchRecord objects.
List of input configurations for the processing job.
* @public */ - Results?: SearchRecord[] | undefined; + ProcessingInputs?: ProcessingInput[] | undefined; /** - *If the result of the previous Search request was truncated, the response
- * includes a NextToken. To retrieve the next set of results, use the token in the next
- * request.
Configuration for uploading output from the processing container.
* @public */ - NextToken?: string | undefined; -} + ProcessingOutputConfig?: ProcessingOutputConfig | undefined; -/** - * @public - */ -export interface SendPipelineExecutionStepFailureRequest { /** - *The pipeline generated token from the Amazon SQS queue.
+ *The name of the processing job.
* @public */ - CallbackToken: string | undefined; + ProcessingJobName?: string | undefined; /** - *A message describing why the step failed.
+ *Identifies the resources, ML compute instances, and ML storage volumes to deploy for a + * processing job. In distributed training, you specify more than one instance.
* @public */ - FailureReason?: string | undefined; + ProcessingResources?: ProcessingResources | undefined; /** - *A unique, case-sensitive identifier that you provide to ensure the idempotency of the - * operation. An idempotent operation completes no more than one time.
+ *Configures conditions under which the processing job should be stopped, such as how long + * the processing job has been running. After the condition is met, the processing job is stopped.
* @public */ - ClientRequestToken?: string | undefined; -} + StoppingCondition?: ProcessingStoppingCondition | undefined; -/** - * @public - */ -export interface SendPipelineExecutionStepFailureResponse { /** - *The Amazon Resource Name (ARN) of the pipeline execution.
+ *Configuration to run a processing job in a specified container image.
* @public */ - PipelineExecutionArn?: string | undefined; -} + AppSpecification?: AppSpecification | undefined; -/** - * @public - */ -export interface SendPipelineExecutionStepSuccessRequest { /** - *The pipeline generated token from the Amazon SQS queue.
+ *Sets the environment variables in the Docker container.
* @public */ - CallbackToken: string | undefined; + Environment?: RecordA list of the output parameters of the callback step.
+ *Networking options for a job, such as network traffic encryption between containers, + * whether to allow inbound and outbound network calls to and from containers, and the VPC + * subnets and security groups to use for VPC-enabled jobs.
* @public */ - OutputParameters?: OutputParameter[] | undefined; + NetworkConfig?: NetworkConfig | undefined; /** - *A unique, case-sensitive identifier that you provide to ensure the idempotency of the - * operation. An idempotent operation completes no more than one time.
+ *The ARN of the role used to create the processing job.
* @public */ - ClientRequestToken?: string | undefined; -} + RoleArn?: string | undefined; -/** - * @public - */ -export interface SendPipelineExecutionStepSuccessResponse { /** - *The Amazon Resource Name (ARN) of the pipeline execution.
+ *Associates a SageMaker job as a trial component with an experiment and trial. Specified when + * you call the following APIs:
+ *+ * CreateProcessingJob + *
+ *+ * CreateTrainingJob + *
+ *+ * CreateTransformJob + *
+ *The name of the edge deployment plan to start.
+ *The ARN of the processing job.
* @public */ - EdgeDeploymentPlanName: string | undefined; + ProcessingJobArn?: string | undefined; /** - *The name of the stage to start.
+ *The status of the processing job.
* @public */ - StageName: string | undefined; -} + ProcessingJobStatus?: ProcessingJobStatus | undefined; -/** - * @public - */ -export interface StartInferenceExperimentRequest { /** - *The name of the inference experiment to start.
+ *A string, up to one KB in size, that contains metadata from the processing + * container when the processing job exits.
* @public */ - Name: string | undefined; -} + ExitMessage?: string | undefined; -/** - * @public - */ -export interface StartInferenceExperimentResponse { /** - *The ARN of the started inference experiment to start.
+ *A string, up to one KB in size, that contains the reason a processing job failed, if + * it failed.
* @public */ - InferenceExperimentArn: string | undefined; -} + FailureReason?: string | undefined; -/** - * @public - */ -export interface StartMlflowTrackingServerRequest { /** - *The name of the tracking server to start.
+ *The time that the processing job ended.
* @public */ - TrackingServerName: string | undefined; -} + ProcessingEndTime?: Date | undefined; -/** - * @public - */ -export interface StartMlflowTrackingServerResponse { /** - *The ARN of the started tracking server.
+ *The time that the processing job started.
* @public */ - TrackingServerArn?: string | undefined; -} + ProcessingStartTime?: Date | undefined; -/** - * @public - */ -export interface StartMonitoringScheduleRequest { /** - *The name of the schedule to start.
+ *The time the processing job was last modified.
* @public */ - MonitoringScheduleName: string | undefined; -} + LastModifiedTime?: Date | undefined; -/** - * @public - */ -export interface StartNotebookInstanceInput { /** - *The name of the notebook instance to start.
+ *The time the processing job was created.
* @public */ - NotebookInstanceName: string | undefined; -} + CreationTime?: Date | undefined; -/** - * @public - */ -export interface StartPipelineExecutionRequest { /** - *The name or Amazon Resource Name (ARN) of the pipeline.
+ *The ARN of a monitoring schedule for an endpoint associated with this processing + * job.
* @public */ - PipelineName: string | undefined; + MonitoringScheduleArn?: string | undefined; /** - *The display name of the pipeline execution.
+ *The Amazon Resource Name (ARN) of the AutoML job associated with this processing job.
* @public */ - PipelineExecutionDisplayName?: string | undefined; + AutoMLJobArn?: string | undefined; /** - *Contains a list of pipeline parameters. This list can be empty.
+ *The ARN of the training job associated with this processing job.
* @public */ - PipelineParameters?: Parameter[] | undefined; + TrainingJobArn?: string | undefined; /** - *The description of the pipeline execution.
+ *An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management + * User Guide.
+ * @public + */ + Tags?: Tag[] | undefined; +} + +/** + *Configuration information for updating the Amazon SageMaker Debugger profile parameters, system and framework metrics configurations, and + * storage paths.
+ * @public + */ +export interface ProfilerConfigForUpdate { + /** + *Path to Amazon S3 storage location for system and framework metrics.
* @public */ - PipelineExecutionDescription?: string | undefined; + S3OutputPath?: string | undefined; /** - *A unique, case-sensitive identifier that you provide to ensure the idempotency of the - * operation. An idempotent operation completes no more than once.
+ *A time interval for capturing system metrics in milliseconds. Available values are + * 100, 200, 500, 1000 (1 second), 5000 (5 seconds), and 60000 (1 minute) milliseconds. The default value is 500 milliseconds.
* @public */ - ClientRequestToken?: string | undefined; + ProfilingIntervalInMilliseconds?: number | undefined; /** - *This configuration, if specified, overrides the parallelism configuration - * of the parent pipeline for this specific run.
+ *Configuration information for capturing framework metrics. Available key strings for different profiling options are
+ * DetailedProfilingConfig, PythonProfilingConfig, and DataLoaderProfilingConfig.
+ * The following codes are configuration structures for the ProfilingParameters parameter. To learn more about
+ * how to configure the ProfilingParameters parameter,
+ * see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.
+ *
The selective execution configuration applied to the pipeline run.
+ *To turn off Amazon SageMaker Debugger monitoring and profiling while a training job is in progress, set to True.
The properties of a project as returned by the Search API.
* @public */ -export interface StartPipelineExecutionResponse { +export interface Project { /** - *The Amazon Resource Name (ARN) of the pipeline execution.
+ *The Amazon Resource Name (ARN) of the project.
* @public */ - PipelineExecutionArn?: string | undefined; -} + ProjectArn?: string | undefined; -/** - * @public - */ -export interface StopAutoMLJobRequest { /** - *The name of the object you are requesting.
+ *The name of the project.
* @public */ - AutoMLJobName: string | undefined; -} + ProjectName?: string | undefined; -/** - * @public - */ -export interface StopCompilationJobRequest { /** - *The name of the model compilation job to stop.
+ *The ID of the project.
* @public */ - CompilationJobName: string | undefined; -} + ProjectId?: string | undefined; -/** - * @public - */ -export interface StopEdgeDeploymentStageRequest { /** - *The name of the edge deployment plan to stop.
+ *The description of the project.
* @public */ - EdgeDeploymentPlanName: string | undefined; + ProjectDescription?: string | undefined; /** - *The name of the stage to stop.
+ *Details that you specify to provision a service catalog product. For information about + * service catalog, see What is Amazon Web Services Service + * Catalog.
* @public */ - StageName: string | undefined; -} + ServiceCatalogProvisioningDetails?: ServiceCatalogProvisioningDetails | undefined; -/** - * @public - */ -export interface StopEdgePackagingJobRequest { /** - *The name of the edge packaging job.
+ *Details of a provisioned service catalog product. For information about service catalog, + * see What is Amazon Web Services Service + * Catalog.
* @public */ - EdgePackagingJobName: string | undefined; -} + ServiceCatalogProvisionedProductDetails?: ServiceCatalogProvisionedProductDetails | undefined; -/** - * @public - */ -export interface StopHyperParameterTuningJobRequest { /** - *The name of the tuning job to stop.
+ *The status of the project.
* @public */ - HyperParameterTuningJobName: string | undefined; -} + ProjectStatus?: ProjectStatus | undefined; -/** - * @public - */ -export interface StopInferenceExperimentRequest { /** - *The name of the inference experiment to stop.
+ *Who created the project.
* @public */ - Name: string | undefined; + CreatedBy?: UserContext | undefined; /** - *- * Array of key-value pairs, with names of variants mapped to actions. The possible actions are the following: - *
- *
- * Promote - Promote the shadow variant to a production variant
- * Remove - Delete the variant
- * Retain - Keep the variant as it is
A timestamp specifying when the project was created.
* @public */ - ModelVariantActions: Record
- * An array of ModelVariantConfig objects. There is one for each variant that you want to deploy
- * after the inference experiment stops. Each ModelVariantConfig describes the infrastructure
- * configuration for deploying the corresponding variant.
- *
An array of key-value pairs. You can use tags to categorize your Amazon Web Services + * resources in different ways, for example, by purpose, owner, or environment. For more + * information, see Tagging Amazon Web Services Resources.
* @public */ - DesiredModelVariants?: ModelVariantConfig[] | undefined; + Tags?: Tag[] | undefined; /** - *- * The desired state of the experiment after stopping. The possible states are the following: - *
- *
- * Completed: The experiment completed successfully
- * Cancelled: The experiment was canceled
A timestamp container for when the project was last modified.
* @public */ - DesiredState?: InferenceExperimentStopDesiredState | undefined; + LastModifiedTime?: Date | undefined; /** - *The reason for stopping the experiment.
+ *Information about the user who created or modified an experiment, trial, trial + * component, lineage group, project, or model card.
* @public */ - Reason?: string | undefined; + LastModifiedBy?: UserContext | undefined; } /** * @public */ -export interface StopInferenceExperimentResponse { +export interface PutModelPackageGroupPolicyInput { /** - *The ARN of the stopped inference experiment.
+ *The name of the model group to add a resource policy to.
* @public */ - InferenceExperimentArn: string | undefined; -} + ModelPackageGroupName: string | undefined; -/** - * @public - */ -export interface StopInferenceRecommendationsJobRequest { /** - *The name of the job you want to stop.
+ *The resource policy for the model group.
* @public */ - JobName: string | undefined; + ResourcePolicy: string | undefined; } /** * @public */ -export interface StopLabelingJobRequest { +export interface PutModelPackageGroupPolicyOutput { /** - *The name of the labeling job to stop.
+ *The Amazon Resource Name (ARN) of the model package group.
* @public */ - LabelingJobName: string | undefined; + ModelPackageGroupArn: string | undefined; } /** + *A set of filters to narrow the set of lineage entities connected to the StartArn(s) returned by the
+ * QueryLineage API action.
The name of the tracking server to stop.
+ *Filter the lineage entities connected to the StartArn by type. For example: DataSet,
+ * Model, Endpoint, or ModelDeployment.
The ARN of the stopped tracking server.
+ *Filter the lineage entities connected to the StartArn(s) by the type of the lineage entity.
The name of the schedule to stop.
+ *Filter the lineage entities connected to the StartArn(s) by created date.
The name of the notebook instance to terminate.
+ *Filter the lineage entities connected to the StartArn(s) after the create date.
The name that you assigned to the optimization job.
+ *Filter the lineage entities connected to the StartArn(s) before the last modified date.
The Amazon Resource Name (ARN) of the pipeline execution.
+ *Filter the lineage entities connected to the StartArn(s) after the last modified date.
A unique, case-sensitive identifier that you provide to ensure the idempotency of the - * operation. An idempotent operation completes no more than once.
+ *Filter the lineage entities connected to the StartArn(s) by a set if property key value pairs.
+ * If multiple pairs are provided, an entity is included in the results if it matches any of the provided pairs.
The Amazon Resource Name (ARN) of the pipeline execution.
+ *A list of resource Amazon Resource Name (ARN) that represent the starting point for your lineage query.
+ * @public + */ + StartArns?: string[] | undefined; + + /** + *Associations between lineage entities have a direction. This parameter determines the direction from the + * StartArn(s) that the query traverses.
+ * @public + */ + Direction?: Direction | undefined; + + /** + * Setting this value to True retrieves not only the entities of interest but also the
+ * Associations and
+ * lineage entities on the path. Set to False to only return lineage entities that match your query.
A set of filtering parameters that allow you to specify which entities should be returned.
+ *Properties - Key-value pairs to match on the lineage entities' properties.
+ *LineageTypes - A set of lineage entity types to match on. For example: TrialComponent,
+ * Artifact, or Context.
CreatedBefore - Filter entities created before this date.
+ *ModifiedBefore - Filter entities modified before this date.
+ *ModifiedAfter - Filter entities modified after this date.
+ *The name of the processing job to stop.
+ *The maximum depth in lineage relationships from the StartArns that are traversed. Depth is a measure of the number
+ * of Associations from the StartArn entity to the matched results.
The name of the training job to stop.
+ *Limits the number of vertices in the results. Use the NextToken in a response to to retrieve the next page of results.
The name of the batch transform job to stop.
+ *Limits the number of vertices in the request. Use the NextToken in a response to to retrieve the next page of results.
A lineage entity connected to the starting entity(ies).
* @public */ -export interface UpdateActionRequest { +export interface Vertex { /** - *The name of the action to update.
+ *The Amazon Resource Name (ARN) of the lineage entity resource.
* @public */ - ActionName: string | undefined; + Arn?: string | undefined; /** - *The new description for the action.
+ *The type of the lineage entity resource. For example: DataSet, Model, Endpoint,
+ * etc...
The new status for the action.
+ *The type of resource of the lineage entity.
* @public */ - Status?: ActionStatus | undefined; + LineageType?: LineageType | undefined; +} +/** + * @public + */ +export interface QueryLineageResponse { /** - *The new list of properties. Overwrites the current property list.
+ *A list of vertices connected to the start entity(ies) in the lineage graph.
* @public */ - Properties?: RecordA list of properties to remove.
+ *A list of edges that connect vertices in the response.
* @public */ - PropertiesToRemove?: string[] | undefined; -} + Edges?: Edge[] | undefined; -/** - * @public - */ -export interface UpdateActionResponse { /** - *The Amazon Resource Name (ARN) of the action.
+ *Limits the number of vertices in the response. Use the NextToken in a response to to retrieve the next page of results.
The name of the AppImageConfig to update.
- * @public - */ - AppImageConfigName: string | undefined; - +export interface RegisterDevicesRequest { /** - *The new KernelGateway app to run on the image.
+ *The name of the fleet.
* @public */ - KernelGatewayImageConfig?: KernelGatewayImageConfig | undefined; + DeviceFleetName: string | undefined; /** - *The JupyterLab app running on the image.
+ *A list of devices to register with SageMaker Edge Manager.
* @public */ - JupyterLabAppImageConfig?: JupyterLabAppImageConfig | undefined; + Devices: Device[] | undefined; /** - *The Code Editor app running on the image.
+ *The tags associated with devices.
* @public */ - CodeEditorAppImageConfig?: CodeEditorAppImageConfig | undefined; + Tags?: Tag[] | undefined; } /** + *Configuration for remote debugging for the UpdateTrainingJob API. To learn more about the remote debugging + * functionality of SageMaker, see Access a training container + * through Amazon Web Services Systems Manager (SSM) for remote + * debugging.
* @public */ -export interface UpdateAppImageConfigResponse { +export interface RemoteDebugConfigForUpdate { /** - *The ARN for the AppImageConfig.
+ *If set to True, enables remote debugging.
* @public */ - AppImageConfigArn?: string | undefined; + EnableRemoteDebug?: boolean | undefined; } /** + *Contains input values for a task.
* @public */ -export interface UpdateArtifactRequest { - /** - *The Amazon Resource Name (ARN) of the artifact to update.
- * @public - */ - ArtifactArn: string | undefined; - - /** - *The new name for the artifact.
- * @public - */ - ArtifactName?: string | undefined; - - /** - *The new list of properties. Overwrites the current property list.
- * @public - */ - Properties?: RecordA list of properties to remove.
+ *A JSON object that contains values for the variables defined in the template. It is
+ * made available to the template under the substitution variable task.input.
+ * For example, if you define a variable task.input.text in your template, you
+ * can supply the variable in the JSON object as "text": "sample text".
A description of an error that occurred while rendering the template.
* @public */ -export interface UpdateArtifactResponse { +export interface RenderingError { + /** + *A unique identifier for a specific class of errors.
+ * @public + */ + Code: string | undefined; + /** - *The Amazon Resource Name (ARN) of the artifact.
+ *A human-readable message describing the error.
* @public */ - ArtifactArn?: string | undefined; + Message: string | undefined; } /** * @public */ -export interface UpdateClusterRequest { +export interface RenderUiTemplateRequest { /** - *Specify the name of the SageMaker HyperPod cluster you want to update.
+ *A Template object containing the worker UI template to render.
Specify the instance groups to update.
+ *A RenderableTask object containing a representative task to
+ * render.
The node recovery mode to be applied to the SageMaker HyperPod cluster.
+ *The Amazon Resource Name (ARN) that has access to the S3 objects that are used by the + * template.
* @public */ - NodeRecovery?: ClusterNodeRecovery | undefined; -} + RoleArn: string | undefined; -/** - * @public - */ -export interface UpdateClusterResponse { /** - *The Amazon Resource Name (ARN) of the updated SageMaker HyperPod cluster.
+ *The HumanTaskUiArn of the worker UI that you want to render. Do not
+ * provide a HumanTaskUiArn if you use the UiTemplate
+ * parameter.
See a list of available Human Ui Amazon Resource Names (ARNs) in UiConfig.
* @public */ - ClusterArn: string | undefined; + HumanTaskUiArn?: string | undefined; } /** * @public */ -export interface UpdateClusterSoftwareRequest { +export interface RenderUiTemplateResponse { /** - *Specify the name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster you want to update for security - * patching.
+ *A Liquid template that renders the HTML for the worker UI.
* @public */ - ClusterName: string | undefined; -} + RenderedContent: string | undefined; -/** - * @public - */ -export interface UpdateClusterSoftwareResponse { /** - *The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster being updated for security patching.
+ *A list of one or more RenderingError objects if any were encountered
+ * while rendering the template. If there were no errors, the list is empty.
Details about a reserved capacity offering for a training plan offering.
+ *For more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using
+ * Amazon SageMaker Training Plan, see
+ * CreateTrainingPlan
+ * .
The name of the Git repository to update.
+ *The instance type for the reserved capacity offering.
* @public */ - CodeRepositoryName: string | undefined; + InstanceType: ReservedCapacityInstanceType | undefined; /** - *The configuration of the git repository, including the URL and the Amazon Resource
- * Name (ARN) of the Amazon Web Services Secrets Manager secret that contains the
- * credentials used to access the repository. The secret must have a staging label of
- * AWSCURRENT and must be in the following format:
- * \{"username": UserName, "password":
- * Password\}
- *
The number of instances in the reserved capacity offering.
* @public */ - GitConfig?: GitConfigForUpdate | undefined; -} + InstanceCount: number | undefined; -/** - * @public - */ -export interface UpdateCodeRepositoryOutput { /** - *The ARN of the Git repository.
+ *The availability zone for the reserved capacity offering.
* @public */ - CodeRepositoryArn: string | undefined; -} + AvailabilityZone?: string | undefined; -/** - * @public - */ -export interface UpdateContextRequest { /** - *The name of the context to update.
+ *The number of whole hours in the total duration for this reserved capacity + * offering.
* @public */ - ContextName: string | undefined; + DurationHours?: number | undefined; /** - *The new description for the context.
+ *The additional minutes beyond whole hours in the total duration for this reserved + * capacity offering.
* @public */ - Description?: string | undefined; + DurationMinutes?: number | undefined; /** - *The new list of properties. Overwrites the current property list.
+ *The start time of the reserved capacity offering.
* @public */ - Properties?: RecordA list of properties to remove.
+ *The end time of the reserved capacity offering.
* @public */ - PropertiesToRemove?: string[] | undefined; + EndTime?: Date | undefined; } /** + *The ResourceConfig to update KeepAlivePeriodInSeconds. Other
+ * fields in the ResourceConfig cannot be updated.
The Amazon Resource Name (ARN) of the context.
+ *The KeepAlivePeriodInSeconds value specified in the
+ * ResourceConfig to update.
The name of the fleet.
- * @public - */ - DeviceFleetName: string | undefined; - +export interface RetryPipelineExecutionRequest { /** - *The Amazon Resource Name (ARN) of the device.
+ *The Amazon Resource Name (ARN) of the pipeline execution.
* @public */ - RoleArn?: string | undefined; + PipelineExecutionArn: string | undefined; /** - *Description of the fleet.
+ *A unique, case-sensitive identifier that you provide to ensure the idempotency of the + * operation. An idempotent operation completes no more than once.
* @public */ - Description?: string | undefined; + ClientRequestToken?: string | undefined; /** - *Output configuration for storing sample data collected by the fleet.
+ *This configuration, if specified, overrides the parallelism configuration + * of the parent pipeline.
* @public */ - OutputConfig: EdgeOutputConfig | undefined; + ParallelismConfiguration?: ParallelismConfiguration | undefined; +} +/** + * @public + */ +export interface RetryPipelineExecutionResponse { /** - *Whether to create an Amazon Web Services IoT Role Alias during device fleet creation. - * The name of the role alias generated will match this pattern: - * "SageMakerEdge-\{DeviceFleetName\}".
- *For example, if your device fleet is called "demo-fleet", the name of - * the role alias will be "SageMakerEdge-demo-fleet".
+ *The Amazon Resource Name (ARN) of the pipeline execution.
* @public */ - EnableIotRoleAlias?: boolean | undefined; + PipelineExecutionArn?: string | undefined; } /** + * @public + * @enum + */ +export const SearchSortOrder = { + ASCENDING: "Ascending", + DESCENDING: "Descending", +} as const; + +/** + * @public + */ +export type SearchSortOrder = (typeof SearchSortOrder)[keyof typeof SearchSortOrder]; + +/** + *The list of key-value pairs used to filter your search results. If a search result contains a key from your list, it is included in the final search response if the value associated with the key in the result matches the value you specified. + * If the value doesn't match, the result is excluded from the search response. Any resources that don't have a key from the list that you've provided will also be included in the search response.
* @public */ -export interface UpdateDevicesRequest { +export interface VisibilityConditions { /** - *The name of the fleet the devices belong to.
+ *The key that specifies the tag that you're using to filter the search results. It must be in the following format: Tags..
List of devices to register with Edge Manager agent.
+ *The value for the tag that you're using to filter the search results.
* @public */ - Devices: Device[] | undefined; + Value?: string | undefined; } /** + *Contains information about a training job.
* @public */ -export interface UpdateDomainRequest { +export interface TrainingJob { /** - *The ID of the domain to be updated.
+ *The name of the training job.
* @public */ - DomainId: string | undefined; + TrainingJobName?: string | undefined; /** - *A collection of settings.
+ *The Amazon Resource Name (ARN) of the training job.
* @public */ - DefaultUserSettings?: UserSettings | undefined; + TrainingJobArn?: string | undefined; /** - *A collection of DomainSettings configuration values to update.
The Amazon Resource Name (ARN) of the associated hyperparameter tuning job if the + * training job was launched by a hyperparameter tuning job.
* @public */ - DomainSettingsForUpdate?: DomainSettingsForUpdate | undefined; + TuningJobArn?: string | undefined; /** - *The entity that creates and manages the required security groups for inter-app
- * communication in VPCOnly mode. Required when
- * CreateDomain.AppNetworkAccessType is VPCOnly and
- * DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is
- * provided. If setting up the domain for use with RStudio, this value must be set to
- * Service.
The Amazon Resource Name (ARN) of the labeling job.
* @public */ - AppSecurityGroupManagement?: AppSecurityGroupManagement | undefined; + LabelingJobArn?: string | undefined; /** - *The default settings for shared spaces that users create in the domain.
+ *The Amazon Resource Name (ARN) of the job.
* @public */ - DefaultSpaceSettings?: DefaultSpaceSettings | undefined; + AutoMLJobArn?: string | undefined; /** - *The VPC subnets that Studio uses for communication.
- *If removing subnets, ensure there are no apps in the InService,
- * Pending, or Deleting state.
Information about the Amazon S3 location that is configured for storing model + * artifacts.
* @public */ - SubnetIds?: string[] | undefined; + ModelArtifacts?: ModelArtifacts | undefined; /** - *Specifies the VPC used for non-EFS traffic.
+ *The status of the + * training + * job.
+ *Training job statuses are:
*
- * PublicInternetOnly - Non-EFS traffic is through a VPC managed by Amazon SageMaker, which allows direct internet access.
InProgress - The training is in progress.
+ *
+ * Completed - The training job has completed.
+ * Failed - The training job has failed. To see the reason for the
+ * failure, see the FailureReason field in the response to a
+ * DescribeTrainingJobResponse call.
+ * Stopping - The training job is stopping.
- * VpcOnly - All Studio traffic is through the specified VPC and
- * subnets.
Stopped - The training job has stopped.
* This configuration can only be modified if there are no apps in the
- * InService, Pending, or Deleting state. The
- * configuration cannot be updated if
- * DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is already
- * set or DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is
- * provided as part of the same request.
Indicates whether custom tag propagation is supported for the domain. Defaults to
- * DISABLED.
The Amazon Resource Name (ARN) of the domain.
+ *For
+ * more detailed information, see SecondaryStatus.
Specifies a production variant property type for an Endpoint.
- *If you are updating an endpoint with the RetainAllVariantProperties
- * option of UpdateEndpointInput set to true, the
- * VariantProperty objects listed in the
- * ExcludeRetainedVariantProperties parameter of UpdateEndpointInput override the existing variant properties of the
- * endpoint.
The type of variant property. The supported values are:
+ * Provides detailed information about the state of the training job. For detailed
+ * information about the secondary status of the training job, see
+ * StatusMessage under SecondaryStatusTransition.
SageMaker provides primary statuses and secondary statuses that apply to each of + * them:
+ *
+ * Starting
+ * - Starting the training job.
+ * Downloading - An optional stage for algorithms that
+ * support File training input mode. It indicates that
+ * data is being downloaded to the ML storage volumes.
+ * Training - Training is in progress.
+ * Uploading - Training is complete and the model
+ * artifacts are being uploaded to the S3 location.
+ * Completed - The training job has completed.
+ * Failed - The training job has failed. The reason for
+ * the failure is returned in the FailureReason field of
+ * DescribeTrainingJobResponse.
+ * MaxRuntimeExceeded - The job stopped because it
+ * exceeded the maximum allowed runtime.
+ * Stopped - The training job has stopped.
+ * Stopping - Stopping the training job.
Valid values for SecondaryStatus are subject to change.
We no longer support the following secondary statuses:
*
- * DesiredInstanceCount: Overrides the existing variant instance
- * counts using the InitialInstanceCount values in the
- * ProductionVariants of CreateEndpointConfig.
LaunchingMLInstances
+ *
*
- * DesiredWeight: Overrides the existing variant weights using the
- * InitialVariantWeight values in the
- * ProductionVariants of CreateEndpointConfig.
PreparingTrainingStack
+ *
*
- * DataCaptureConfig: (Not currently supported.)
DownloadingTrainingImage
+ *
* The name of the endpoint whose configuration you want to update.
- * @public - */ - EndpointName: string | undefined; - - /** - *The name of the new endpoint configuration.
- * @public - */ - EndpointConfigName: string | undefined; + SecondaryStatus?: SecondaryStatus | undefined; /** - *When updating endpoint resources, enables or disables the retention of variant properties, such as the instance count or the variant weight. To
- * retain the variant properties of an endpoint when updating it, set
- * RetainAllVariantProperties to true. To use the variant
- * properties specified in a new EndpointConfig call when updating an
- * endpoint, set RetainAllVariantProperties to false. The default
- * is false.
If the training job failed, the reason it failed.
* @public */ - RetainAllVariantProperties?: boolean | undefined; + FailureReason?: string | undefined; /** - *When you are updating endpoint resources with RetainAllVariantProperties,
- * whose value is set to true, ExcludeRetainedVariantProperties
- * specifies the list of type VariantProperty
- * to override with the values provided by EndpointConfig. If you don't
- * specify a value for ExcludeRetainedVariantProperties, no variant properties
- * are overridden.
Algorithm-specific parameters.
* @public */ - ExcludeRetainedVariantProperties?: VariantProperty[] | undefined; + HyperParameters?: RecordThe deployment configuration for an endpoint, which contains the desired deployment - * strategy and rollback configurations.
+ *Information about the algorithm used for training, and algorithm metadata.
* @public */ - DeploymentConfig?: DeploymentConfig | undefined; + AlgorithmSpecification?: AlgorithmSpecification | undefined; /** - *Specifies whether to reuse the last deployment configuration. The default value is - * false (the configuration is not reused).
+ *The Amazon Web Services Identity and Access Management (IAM) role configured for the + * training job.
* @public */ - RetainDeploymentConfig?: boolean | undefined; -} + RoleArn?: string | undefined; -/** - * @public - */ -export interface UpdateEndpointOutput { /** - *The Amazon Resource Name (ARN) of the endpoint.
+ *An array of Channel objects that describes each data input
+ * channel.
Your input must be in the same Amazon Web Services region as your training job.
* @public */ - EndpointArn: string | undefined; -} + InputDataConfig?: Channel[] | undefined; -/** - * @public - */ -export interface UpdateEndpointWeightsAndCapacitiesInput { /** - *The name of an existing SageMaker endpoint.
+ *The S3 path where model artifacts that you configured when creating the job are + * stored. SageMaker creates subfolders for model artifacts.
* @public */ - EndpointName: string | undefined; + OutputDataConfig?: OutputDataConfig | undefined; /** - *An object that provides new capacity and weight values for a variant.
+ *Resources, including ML compute instances and ML storage volumes, that are configured + * for model training.
* @public */ - DesiredWeightsAndCapacities: DesiredWeightAndCapacity[] | undefined; -} + ResourceConfig?: ResourceConfig | undefined; -/** - * @public - */ -export interface UpdateEndpointWeightsAndCapacitiesOutput { /** - *The Amazon Resource Name (ARN) of the updated endpoint.
+ *A VpcConfig object that specifies the VPC that this training job has access + * to. For more information, see Protect Training Jobs by Using an Amazon + * Virtual Private Cloud.
* @public */ - EndpointArn: string | undefined; -} + VpcConfig?: VpcConfig | undefined; -/** - * @public - */ -export interface UpdateExperimentRequest { /** - *The name of the experiment to update.
+ *Specifies a limit to how long a model training job can run. It also specifies how long + * a managed Spot training job has to complete. When the job reaches the time limit, SageMaker + * ends the training job. Use this API to cap model training costs.
+ *To stop a job, SageMaker sends the algorithm the SIGTERM signal, which delays
+ * job termination for 120 seconds. Algorithms can use this 120-second window to save the
+ * model artifacts, so the results of training are not lost.
The name of the experiment as displayed. The name doesn't need to be unique. If
- * DisplayName isn't specified, ExperimentName is displayed.
A timestamp that indicates when the training job was created.
* @public */ - DisplayName?: string | undefined; + CreationTime?: Date | undefined; /** - *The description of the experiment.
+ *Indicates the time when the training job starts on training instances. You are billed
+ * for the time interval between this time and the value of TrainingEndTime.
+ * The start time in CloudWatch Logs might be later than this time. The difference is due to the time
+ * it takes to download the training data and to the size of the training container.
The Amazon Resource Name (ARN) of the experiment.
+ *Indicates the time when the training job ends on training instances. You are billed
+ * for the time interval between the value of TrainingStartTime and this time.
+ * For successful jobs and stopped jobs, this is the time after model artifacts are
+ * uploaded. For failed jobs, this is the time when SageMaker detects a job failure.
The new throughput configuration for the feature group. You can switch between on-demand - * and provisioned modes or update the read / write capacity of provisioned feature groups. - * You can switch a feature group to on-demand only once in a 24 hour period.
- * @public - */ -export interface ThroughputConfigUpdate { /** - *Target throughput mode of the feature group. Throughput update is an asynchronous
- * operation, and the outcome should be monitored by polling LastUpdateStatus
- * field in DescribeFeatureGroup response. You cannot update a feature group's
- * throughput while another update is in progress.
A timestamp that indicates when the status of the training job was last + * modified.
* @public */ - ThroughputMode?: ThroughputMode | undefined; + LastModifiedTime?: Date | undefined; /** - *For provisioned feature groups with online store enabled, this indicates the read - * throughput you are billed for and can consume without throttling.
+ *A history of all of the secondary statuses that the training job has transitioned + * through.
* @public */ - ProvisionedReadCapacityUnits?: number | undefined; + SecondaryStatusTransitions?: SecondaryStatusTransition[] | undefined; /** - *For provisioned feature groups, this indicates the write throughput you are billed for - * and can consume without throttling.
+ *A list of final metric values that are set when the training job completes. Used only + * if the training job was configured to use metrics.
* @public */ - ProvisionedWriteCapacityUnits?: number | undefined; -} + FinalMetricDataList?: MetricData[] | undefined; -/** - * @public - */ -export interface UpdateFeatureGroupRequest { /** - *The name or Amazon Resource Name (ARN) of the feature group that you're updating.
+ *If the TrainingJob was created with network isolation, the value is set
+ * to true. If network isolation is enabled, nodes can't communicate beyond
+ * the VPC they run in.
Updates the feature group. Updating a feature group is an asynchronous operation. When - * you get an HTTP 200 response, you've made a valid request. It takes some time after you've - * made a valid request for Feature Store to update the feature group.
+ *To encrypt all communications between ML compute instances in distributed training,
+ * choose True. Encryption provides greater security for distributed training,
+ * but training might take longer. How long it takes depends on the amount of communication
+ * between compute instances, especially if you use a deep learning algorithm in
+ * distributed training.
Updates the feature group online store configuration.
+ *When true, enables managed spot training using Amazon EC2 Spot instances to run + * training jobs instead of on-demand instances. For more information, see Managed Spot Training.
* @public */ - OnlineStoreConfig?: OnlineStoreConfigUpdate | undefined; + EnableManagedSpotTraining?: boolean | undefined; /** - *The new throughput configuration for the feature group. You can switch between on-demand - * and provisioned modes or update the read / write capacity of provisioned feature groups. - * You can switch a feature group to on-demand only once in a 24 hour period.
+ *Contains information about the output location for managed spot training checkpoint + * data.
* @public */ - ThroughputConfig?: ThroughputConfigUpdate | undefined; -} + CheckpointConfig?: CheckpointConfig | undefined; -/** - * @public - */ -export interface UpdateFeatureGroupResponse { /** - *The Amazon Resource Number (ARN) of the feature group that you're updating.
+ *The training time in seconds.
* @public */ - FeatureGroupArn: string | undefined; -} + TrainingTimeInSeconds?: number | undefined; -/** - * @public - */ -export interface UpdateFeatureMetadataRequest { /** - *The name or Amazon Resource Name (ARN) of the feature group containing the feature that - * you're updating.
+ *The billable time in seconds.
* @public */ - FeatureGroupName: string | undefined; + BillableTimeInSeconds?: number | undefined; /** - *The name of the feature that you're updating.
+ *Configuration information for the Amazon SageMaker Debugger hook parameters, metric and tensor collections, and
+ * storage paths. To learn more about
+ * how to configure the DebugHookConfig parameter,
+ * see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.
A description that you can write to better describe the feature.
+ *Associates a SageMaker job as a trial component with an experiment and trial. Specified when + * you call the following APIs:
+ *+ * CreateProcessingJob + *
+ *+ * CreateTrainingJob + *
+ *+ * CreateTransformJob + *
+ *A list of key-value pairs that you can add to better describe the feature.
+ *Information about the debug rule configuration.
* @public */ - ParameterAdditions?: FeatureParameter[] | undefined; + DebugRuleConfigurations?: DebugRuleConfiguration[] | undefined; /** - *A list of parameter keys that you can specify to remove parameters that describe your - * feature.
+ *Configuration of storage locations for the Amazon SageMaker Debugger TensorBoard output data.
* @public */ - ParameterRemovals?: string[] | undefined; -} + TensorBoardOutputConfig?: TensorBoardOutputConfig | undefined; -/** - * @public - */ -export interface UpdateHubRequest { /** - *The name of the hub to update.
+ *Information about the evaluation status of the rules for the training job.
* @public */ - HubName: string | undefined; + DebugRuleEvaluationStatuses?: DebugRuleEvaluationStatus[] | undefined; /** - *A description of the updated hub.
+ *Configuration information for Amazon SageMaker Debugger system monitoring, framework profiling, and + * storage paths.
* @public */ - HubDescription?: string | undefined; + ProfilerConfig?: ProfilerConfig | undefined; /** - *The display name of the hub.
+ *The environment variables to set in the Docker container.
* @public */ - HubDisplayName?: string | undefined; + Environment?: RecordThe searchable keywords for the hub.
+ *The number of times to retry the job when the job fails due to an
+ * InternalServerError.
The Amazon Resource Name (ARN) of the updated hub.
+ *An array of key-value pairs. You can use tags to categorize your Amazon Web Services + * resources in different ways, for example, by purpose, owner, or environment. For more + * information, see Tagging Amazon Web Services Resources.
* @public */ - HubArn: string | undefined; + Tags?: Tag[] | undefined; } /** + *A short summary of a trial component.
* @public */ -export interface UpdateImageRequest { - /** - *A list of properties to delete. Only the Description and
- * DisplayName properties can be deleted.
The new description for the image.
+ *The name of the trial component.
* @public */ - Description?: string | undefined; + TrialComponentName?: string | undefined; /** - *The new display name for the image.
+ *The Amazon Resource Name (ARN) of the trial component.
* @public */ - DisplayName?: string | undefined; + TrialComponentArn?: string | undefined; /** - *The name of the image to update.
+ *The Amazon Resource Name (ARN) and job type of the source of a trial component.
* @public */ - ImageName: string | undefined; + TrialComponentSource?: TrialComponentSource | undefined; /** - *The new ARN for the IAM role that enables Amazon SageMaker to perform tasks on your behalf.
+ *When the component was created.
* @public */ - RoleArn?: string | undefined; -} + CreationTime?: Date | undefined; -/** - * @public - */ -export interface UpdateImageResponse { /** - *The ARN of the image.
+ *Information about the user who created or modified an experiment, trial, trial + * component, lineage group, project, or model card.
* @public */ - ImageArn?: string | undefined; + CreatedBy?: UserContext | undefined; } /** + *The properties of a trial as returned by the Search API.
* @public */ -export interface UpdateImageVersionRequest { - /** - *The name of the image.
- * @public - */ - ImageName: string | undefined; - +export interface Trial { /** - *The alias of the image version.
+ *The name of the trial.
* @public */ - Alias?: string | undefined; + TrialName?: string | undefined; /** - *The version of the image.
+ *The Amazon Resource Name (ARN) of the trial.
* @public */ - Version?: number | undefined; + TrialArn?: string | undefined; /** - *A list of aliases to add.
+ *The name of the trial as displayed. If DisplayName isn't specified,
+ * TrialName is displayed.
A list of aliases to delete.
+ *The name of the experiment the trial is part of.
* @public */ - AliasesToDelete?: string[] | undefined; + ExperimentName?: string | undefined; /** - *The availability of the image version specified by the maintainer.
- *
- * NOT_PROVIDED: The maintainers did not provide a status for image version stability.
- * STABLE: The image version is stable.
- * TO_BE_ARCHIVED: The image version is set to be archived. Custom image versions that are set to be archived are automatically archived after three months.
- * ARCHIVED: The image version is archived. Archived image versions are not searchable and are no longer actively supported.
The source of the trial.
* @public */ - VendorGuidance?: VendorGuidance | undefined; + Source?: TrialSource | undefined; /** - *Indicates SageMaker job type compatibility.
- *
- * TRAINING: The image version is compatible with SageMaker training jobs.
- * INFERENCE: The image version is compatible with SageMaker inference jobs.
- * NOTEBOOK_KERNEL: The image version is compatible with SageMaker notebook kernels.
When the trial was created.
* @public */ - JobType?: JobType | undefined; + CreationTime?: Date | undefined; /** - *The machine learning framework vended in the image version.
+ *Who created the trial.
* @public */ - MLFramework?: string | undefined; + CreatedBy?: UserContext | undefined; /** - *The supported programming language and its version.
+ *Who last modified the trial.
* @public */ - ProgrammingLang?: string | undefined; + LastModifiedTime?: Date | undefined; /** - *Indicates CPU or GPU compatibility.
- *
- * CPU: The image version is compatible with CPU.
- * GPU: The image version is compatible with GPU.
Information about the user who created or modified an experiment, trial, trial + * component, lineage group, project, or model card.
* @public */ - Processor?: Processor | undefined; + LastModifiedBy?: UserContext | undefined; /** - *Indicates Horovod compatibility.
+ *Metadata properties of the tracking entity, trial, or trial component.
* @public */ - Horovod?: boolean | undefined; + MetadataProperties?: MetadataProperties | undefined; /** - *The maintainer description of the image version.
+ *The list of tags that are associated with the trial. You can use Search + * API to search on the tags.
* @public */ - ReleaseNotes?: string | undefined; -} + Tags?: Tag[] | undefined; -/** - * @public - */ -export interface UpdateImageVersionResponse { /** - *The ARN of the image version.
+ *A list of the components associated with the trial. For each component, a summary of the + * component's properties is included.
* @public */ - ImageVersionArn?: string | undefined; + TrialComponentSummaries?: TrialComponentSimpleSummary[] | undefined; } /** + *Detailed information about the source of a trial component. Either
+ * ProcessingJob or TrainingJob is returned.
The name of the inference component.
+ *The Amazon Resource Name (ARN) of the source.
* @public */ - InferenceComponentName: string | undefined; + SourceArn?: string | undefined; /** - *Details about the resources to deploy with this inference component, including the - * model, container, and compute resources.
+ *Information about a training job that's the source of a trial component.
* @public */ - Specification?: InferenceComponentSpecification | undefined; + TrainingJob?: TrainingJob | undefined; /** - *Runtime settings for a model that is deployed with an inference component.
+ *Information about a processing job that's the source of a trial component.
* @public */ - RuntimeConfig?: InferenceComponentRuntimeConfig | undefined; -} + ProcessingJob?: ProcessingJob | undefined; -/** - * @public - */ -export interface UpdateInferenceComponentOutput { /** - *The Amazon Resource Name (ARN) of the inference component.
+ *Information about a transform job that's the source of a trial component.
* @public */ - InferenceComponentArn: string | undefined; + TransformJob?: TransformJob | undefined; } /** + *The properties of a trial component as returned by the Search + * API.
* @public */ -export interface UpdateInferenceComponentRuntimeConfigInput { - /** - *The name of the inference component to update.
- * @public - */ - InferenceComponentName: string | undefined; - +export interface TrialComponent { /** - *Runtime settings for a model that is deployed with an inference component.
+ *The name of the trial component.
* @public */ - DesiredRuntimeConfig: InferenceComponentRuntimeConfig | undefined; -} + TrialComponentName?: string | undefined; -/** - * @public - */ -export interface UpdateInferenceComponentRuntimeConfigOutput { /** - *The Amazon Resource Name (ARN) of the inference component.
+ *The name of the component as displayed. If DisplayName isn't specified,
+ * TrialComponentName is displayed.
The name of the inference experiment to be updated.
+ *The Amazon Resource Name (ARN) of the trial component.
* @public */ - Name: string | undefined; + TrialComponentArn?: string | undefined; /** - *
- * The duration for which the inference experiment will run. If the status of the inference experiment is
- * Created, then you can update both the start and end dates. If the status of the inference
- * experiment is Running, then you can update only the end date.
- *
The Amazon Resource Name (ARN) and job type of the source of the component.
* @public */ - Schedule?: InferenceExperimentSchedule | undefined; + Source?: TrialComponentSource | undefined; /** - *The description of the inference experiment.
+ *The status of the trial component.
* @public */ - Description?: string | undefined; + Status?: TrialComponentStatus | undefined; /** - *
- * An array of ModelVariantConfig objects. There is one for each variant, whose infrastructure
- * configuration you want to update.
- *
When the component started.
* @public */ - ModelVariants?: ModelVariantConfig[] | undefined; + StartTime?: Date | undefined; /** - *The Amazon S3 location and configuration for storing inference request and response data.
+ *When the component ended.
* @public */ - DataStorageConfig?: InferenceExperimentDataStorageConfig | undefined; + EndTime?: Date | undefined; /** - *
- * The configuration of ShadowMode inference experiment type. Use this field to specify a
- * production variant which takes all the inference requests, and a shadow variant to which Amazon SageMaker replicates a
- * percentage of the inference requests. For the shadow variant also specify the percentage of requests that
- * Amazon SageMaker replicates.
- *
When the component was created.
* @public */ - ShadowModeConfig?: ShadowModeConfig | undefined; -} + CreationTime?: Date | undefined; -/** - * @public - */ -export interface UpdateInferenceExperimentResponse { /** - *The ARN of the updated inference experiment.
+ *Who created the trial component.
* @public */ - InferenceExperimentArn: string | undefined; -} + CreatedBy?: UserContext | undefined; -/** - * @public - */ -export interface UpdateMlflowTrackingServerRequest { /** - *The name of the MLflow Tracking Server to update.
+ *When the component was last modified.
* @public */ - TrackingServerName: string | undefined; + LastModifiedTime?: Date | undefined; /** - *The new S3 URI for the general purpose bucket to use as the artifact store for the MLflow - * Tracking Server.
+ *Information about the user who created or modified an experiment, trial, trial + * component, lineage group, project, or model card.
* @public */ - ArtifactStoreUri?: string | undefined; + LastModifiedBy?: UserContext | undefined; /** - *The new size for the MLflow Tracking Server.
+ *The hyperparameters of the component.
* @public */ - TrackingServerSize?: TrackingServerSize | undefined; + Parameters?: RecordWhether to enable or disable automatic registration of new MLflow models to the SageMaker Model Registry.
- * To enable automatic model registration, set this value to True.
- * To disable automatic model registration, set this value to False.
- * If not specified, AutomaticModelRegistration defaults to False
- *
The input artifacts of the component.
* @public */ - AutomaticModelRegistration?: boolean | undefined; + InputArtifacts?: RecordThe new weekly maintenance window start day and time to update. The maintenance window day and time should be - * in Coordinated Universal Time (UTC) 24-hour standard time. For example: TUE:03:30.
+ *The output artifacts of the component.
* @public */ - WeeklyMaintenanceWindowStart?: string | undefined; -} + OutputArtifacts?: RecordThe ARN of the updated MLflow Tracking Server.
+ *The metrics for the component.
* @public */ - TrackingServerArn?: string | undefined; -} + Metrics?: TrialComponentMetricSummary[] | undefined; -/** - * @public - */ -export interface UpdateModelCardRequest { /** - *The name or Amazon Resource Name (ARN) of the model card to update.
+ *Metadata properties of the tracking entity, trial, or trial component.
* @public */ - ModelCardName: string | undefined; + MetadataProperties?: MetadataProperties | undefined; /** - *The updated model card content. Content must be in model card JSON schema and provided as a string.
- *When updating model card content, be sure to include the full content and not just updated content.
+ *Details of the source of the component.
* @public */ - Content?: string | undefined; + SourceDetail?: TrialComponentSourceDetail | undefined; /** - *The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.
- *
- * Draft: The model card is a work in progress.
- * PendingReview: The model card is pending review.
- * Approved: The model card is approved.
- * Archived: The model card is archived. No more updates should be made to the model
- * card, but it can still be exported.
The Amazon Resource Name (ARN) of the lineage group resource.
* @public */ - ModelCardStatus?: ModelCardStatus | undefined; -} + LineageGroupArn?: string | undefined; -/** - * @public - */ -export interface UpdateModelCardResponse { /** - *The Amazon Resource Name (ARN) of the updated model card.
+ *The list of tags that are associated with the component. You can use Search API to search on the tags.
* @public */ - ModelCardArn: string | undefined; -} + Tags?: Tag[] | undefined; -/** - * @public - */ -export interface UpdateModelPackageInput { /** - *The Amazon Resource Name (ARN) of the model package.
+ *An array of the parents of the component. A parent is a trial the component is associated + * with and the experiment the trial is part of. A component might not have any parents.
* @public */ - ModelPackageArn: string | undefined; + Parents?: Parent[] | undefined; /** - *The approval status of the model.
+ *The name of the experiment run.
* @public */ - ModelApprovalStatus?: ModelApprovalStatus | undefined; + RunName?: string | undefined; +} +/** + *A single resource returned as part of the Search API response.
+ * @public + */ +export interface SearchRecord { /** - *A description for the approval status of the model.
+ *The properties of a training job.
* @public */ - ApprovalDescription?: string | undefined; + TrainingJob?: TrainingJob | undefined; /** - *The metadata properties associated with the model package versions.
+ *The properties of an experiment.
* @public */ - CustomerMetadataProperties?: RecordThe metadata properties associated with the model package versions to remove.
+ *The properties of a trial.
* @public */ - CustomerMetadataPropertiesToRemove?: string[] | undefined; + Trial?: Trial | undefined; /** - *An array of additional Inference Specification objects to be added to the - * existing array additional Inference Specification. Total number of additional - * Inference Specifications can not exceed 15. 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.
+ *The properties of a trial component.
* @public */ - AdditionalInferenceSpecificationsToAdd?: AdditionalInferenceSpecificationDefinition[] | undefined; + TrialComponent?: TrialComponent | undefined; /** - *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 - * artifacts.
- *The instance types that the model package supports for transform jobs and - * real-time endpoints used for inference.
- *The input and output content formats that the model package supports for - * inference.
- *A hosted endpoint for real-time inference.
* @public */ - InferenceSpecification?: InferenceSpecification | undefined; + Endpoint?: Endpoint | undefined; /** - *The URI of the source for the model package.
+ *A versioned model that can be deployed for SageMaker inference.
* @public */ - SourceUri?: string | undefined; + ModelPackage?: ModelPackage | 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.
A group of versioned models in the model registry.
* @public */ - ModelCard?: ModelPackageModelCard | undefined; + ModelPackageGroup?: ModelPackageGroup | undefined; /** - *- * A structure describing the current state of the model in its life cycle. - *
+ *A SageMaker Model Building Pipeline instance.
* @public */ - ModelLifeCycle?: ModelLifeCycle | undefined; + Pipeline?: Pipeline | undefined; /** - *- * A unique token that guarantees that the call to this API is idempotent. - *
+ *An execution of a pipeline.
* @public */ - ClientToken?: string | undefined; -} + PipelineExecution?: PipelineExecution | undefined; -/** - * @public - */ -export interface UpdateModelPackageOutput { /** - *The Amazon Resource Name (ARN) of the model.
+ *Amazon SageMaker Feature Store stores features in a collection called Feature Group. A + * Feature Group can be visualized as a table which has rows, with a unique identifier for + * each row where each column in the table is a feature. In principle, a Feature Group is + * composed of features and values per features.
* @public */ - ModelPackageArn: string | undefined; -} + FeatureGroup?: FeatureGroup | undefined; -/** - * @public - */ -export interface UpdateMonitoringAlertRequest { /** - *The name of a monitoring schedule.
+ *The feature metadata used to search through the features.
* @public */ - MonitoringScheduleName: string | undefined; + FeatureMetadata?: FeatureMetadata | undefined; /** - *The name of a monitoring alert.
+ *The properties of a project.
* @public */ - MonitoringAlertName: string | undefined; + Project?: Project | undefined; /** - *Within EvaluationPeriod, how many execution failures will raise an
- * alert.
The properties of a hyperparameter tuning job.
* @public */ - DatapointsToAlert: number | undefined; + HyperParameterTuningJob?: HyperParameterTuningJobSearchEntity | undefined; /** - *The number of most recent monitoring executions to consider when evaluating alert - * status.
+ *An Amazon SageMaker Model Card that documents details about a machine learning model.
* @public */ - EvaluationPeriod: number | undefined; + ModelCard?: ModelCard | undefined; + + /** + *A model displayed in the Amazon SageMaker Model Dashboard.
+ * @public + */ + Model?: ModelDashboardModel | undefined; } /** * @public */ -export interface UpdateMonitoringAlertResponse { +export interface SearchResponse { /** - *The Amazon Resource Name (ARN) of the monitoring schedule.
+ *A list of SearchRecord objects.
The name of a monitoring alert.
+ *If the result of the previous Search request was truncated, the response
+ * includes a NextToken. To retrieve the next set of results, use the token in the next
+ * request.
The name of the monitoring schedule. The name must be unique within an Amazon Web Services - * Region within an Amazon Web Services account.
+ *The type of instance you want to search for in the available training plan offerings. + * This field allows you to filter the search results based on the specific compute resources + * you require for your SageMaker training jobs or SageMaker HyperPod clusters. When searching for training + * plan offerings, specifying the instance type helps you find Reserved Instances that match + * your computational needs.
* @public */ - MonitoringScheduleName: string | undefined; + InstanceType: ReservedCapacityInstanceType | undefined; /** - *The configuration object that specifies the monitoring schedule and defines the monitoring - * job.
+ *The number of instances you want to reserve in the training plan offerings. This allows + * you to specify the quantity of compute resources needed for your SageMaker training jobs or + * SageMaker HyperPod clusters, helping you find reserved capacity offerings that match your + * requirements.
* @public */ - MonitoringScheduleConfig: MonitoringScheduleConfig | undefined; -} + InstanceCount: number | undefined; -/** - * @public - */ -export interface UpdateMonitoringScheduleResponse { /** - *The Amazon Resource Name (ARN) of the monitoring schedule.
+ *A filter to search for training plan offerings with a start time after a specified + * date.
* @public */ - MonitoringScheduleArn: string | undefined; -} + StartTimeAfter?: Date | undefined; -/** - * @public - */ -export interface UpdateNotebookInstanceInput { /** - *The name of the notebook instance to update.
+ *A filter to search for reserved capacity offerings with an end time before a specified + * date.
* @public */ - NotebookInstanceName: string | undefined; + EndTimeBefore?: Date | undefined; /** - *The Amazon ML compute instance type.
+ *The desired duration in hours for the training plan offerings.
* @public */ - InstanceType?: _InstanceType | undefined; + DurationHours?: number | undefined; /** - *The Amazon Resource Name (ARN) of the IAM role that SageMaker can assume to - * access the notebook instance. For more information, see SageMaker Roles.
- *To be able to pass this role to SageMaker, the caller of this API must
- * have the iam:PassRole permission.
The target resources (e.g., SageMaker Training Jobs, SageMaker HyperPod) to search for in the + * offerings.
+ *Training plans are specific to their target resource.
+ *A training plan designed for SageMaker training jobs can only be used to schedule and + * run training jobs.
+ *A training plan for HyperPod clusters can be used exclusively to provide + * compute resources to a cluster's instance group.
+ *Details about a training plan offering.
+ *For more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using
+ * Amazon SageMaker Training Plan, see
+ * CreateTrainingPlan
+ * .
The name of a lifecycle configuration to associate with the notebook instance. For - * information about lifestyle configurations, see Step 2.1: (Optional) - * Customize a Notebook Instance.
+ *The unique identifier for this training plan offering.
* @public */ - LifecycleConfigName?: string | undefined; + TrainingPlanOfferingId: string | undefined; /** - *Set to true to remove the notebook instance lifecycle configuration
- * currently associated with the notebook instance. This operation is idempotent. If you
- * specify a lifecycle configuration that is not associated with the notebook instance when
- * you call this method, it does not throw an error.
The target resources (e.g., SageMaker Training Jobs, SageMaker HyperPod) for this training plan + * offering.
+ *Training plans are specific to their target resource.
+ *A training plan designed for SageMaker training jobs can only be used to schedule and + * run training jobs.
+ *A training plan for HyperPod clusters can be used exclusively to provide + * compute resources to a cluster's instance group.
+ *The size, in GB, of the ML storage volume to attach to the notebook instance. The - * default value is 5 GB. ML storage volumes are encrypted, so SageMaker can't - * determine the amount of available free space on the volume. Because of this, you can - * increase the volume size when you update a notebook instance, but you can't decrease the - * volume size. If you want to decrease the size of the ML storage volume in use, create a - * new notebook instance with the desired size.
+ *The requested start time that the user specified when searching for the training plan + * offering.
* @public */ - VolumeSizeInGB?: number | undefined; + RequestedStartTimeAfter?: Date | undefined; /** - *The Git repository to associate with the notebook instance as its default code - * repository. This can be either the name of a Git repository stored as a resource in your - * account, or the URL of a Git repository in Amazon Web Services CodeCommit - * or in any other Git repository. When you open a notebook instance, it opens in the - * directory that contains this repository. For more information, see Associating Git - * Repositories with SageMaker Notebook Instances.
+ *The requested end time that the user specified when searching for the training plan + * offering.
* @public */ - DefaultCodeRepository?: string | undefined; + RequestedEndTimeBefore?: Date | undefined; /** - *An array of up to three Git repositories to associate with the notebook instance. - * These can be either the names of Git repositories stored as resources in your account, - * or the URL of Git repositories in Amazon Web Services CodeCommit - * or in any other Git repository. These repositories are cloned at the same level as the - * default repository of your notebook instance. For more information, see Associating Git - * Repositories with SageMaker Notebook Instances.
+ *The number of whole hours in the total duration for this training plan offering.
* @public */ - AdditionalCodeRepositories?: string[] | undefined; + DurationHours?: number | undefined; /** - *This parameter is no longer supported. Elastic Inference (EI) is no longer - * available.
- *This parameter was used to specify a list of the EI instance types to associate with - * this notebook instance.
+ *The additional minutes beyond whole hours in the total duration for this training plan + * offering.
* @public */ - AcceleratorTypes?: NotebookInstanceAcceleratorType[] | undefined; + DurationMinutes?: number | undefined; /** - *This parameter is no longer supported. Elastic Inference (EI) is no longer - * available.
- *This parameter was used to specify a list of the EI instance types to remove from this notebook - * instance.
+ *The upfront fee for this training plan offering.
* @public */ - DisassociateAcceleratorTypes?: boolean | undefined; + UpfrontFee?: string | undefined; /** - *The name or URL of the default Git repository to remove from this notebook instance. - * This operation is idempotent. If you specify a Git repository that is not associated - * with the notebook instance when you call this method, it does not throw an error.
+ *The currency code for the upfront fee (e.g., USD).
* @public */ - DisassociateDefaultCodeRepository?: boolean | undefined; + CurrencyCode?: string | undefined; /** - *A list of names or URLs of the default Git repositories to remove from this notebook - * instance. This operation is idempotent. If you specify a Git repository that is not - * associated with the notebook instance when you call this method, it does not throw an - * error.
+ *A list of reserved capacity offerings associated with this training plan + * offering.
* @public */ - DisassociateAdditionalCodeRepositories?: boolean | undefined; + ReservedCapacityOfferings?: ReservedCapacityOffering[] | undefined; +} +/** + * @public + */ +export interface SearchTrainingPlanOfferingsResponse { /** - *Whether root access is enabled or disabled for users of the notebook instance. The
- * default value is Enabled.
If you set this to Disabled, users don't have root access on the
- * notebook instance, but lifecycle configuration scripts still run with root
- * permissions.
A list of training plan offerings that match the search criteria.
+ * @public + */ + TrainingPlanOfferings: TrainingPlanOffering[] | undefined; +} + +/** + * @public + */ +export interface SendPipelineExecutionStepFailureRequest { + /** + *The pipeline generated token from the Amazon SQS queue.
+ * @public + */ + CallbackToken: string | undefined; + + /** + *A message describing why the step failed.
* @public */ - RootAccess?: RootAccess | undefined; + FailureReason?: string | undefined; /** - *Information on the IMDS configuration of the notebook instance
+ *A unique, case-sensitive identifier that you provide to ensure the idempotency of the + * operation. An idempotent operation completes no more than one time.
* @public */ - InstanceMetadataServiceConfiguration?: InstanceMetadataServiceConfiguration | undefined; + ClientRequestToken?: string | undefined; } /** * @public */ -export interface UpdateNotebookInstanceOutput {} +export interface SendPipelineExecutionStepFailureResponse { + /** + *The Amazon Resource Name (ARN) of the pipeline execution.
+ * @public + */ + PipelineExecutionArn?: string | undefined; +} /** * @public */ -export interface UpdateNotebookInstanceLifecycleConfigInput { +export interface SendPipelineExecutionStepSuccessRequest { /** - *The name of the lifecycle configuration.
+ *The pipeline generated token from the Amazon SQS queue.
* @public */ - NotebookInstanceLifecycleConfigName: string | undefined; + CallbackToken: string | undefined; /** - *The shell script that runs only once, when you create a notebook instance. The shell - * script must be a base64-encoded string.
+ *A list of the output parameters of the callback step.
* @public */ - OnCreate?: NotebookInstanceLifecycleHook[] | undefined; + OutputParameters?: OutputParameter[] | undefined; /** - *The shell script that runs every time you start a notebook instance, including when - * you create the notebook instance. The shell script must be a base64-encoded - * string.
+ *A unique, case-sensitive identifier that you provide to ensure the idempotency of the + * operation. An idempotent operation completes no more than one time.
* @public */ - OnStart?: NotebookInstanceLifecycleHook[] | undefined; + ClientRequestToken?: string | undefined; } /** * @public */ -export interface UpdateNotebookInstanceLifecycleConfigOutput {} +export interface SendPipelineExecutionStepSuccessResponse { + /** + *The Amazon Resource Name (ARN) of the pipeline execution.
+ * @public + */ + PipelineExecutionArn?: string | undefined; +} /** * @public */ -export interface UpdatePipelineRequest { +export interface StartEdgeDeploymentStageRequest { /** - *The name of the pipeline to update.
+ *The name of the edge deployment plan to start.
* @public */ - PipelineName: string | undefined; + EdgeDeploymentPlanName: string | undefined; /** - *The display name of the pipeline.
+ *The name of the stage to start.
* @public */ - PipelineDisplayName?: string | undefined; + StageName: string | undefined; +} +/** + * @public + */ +export interface StartInferenceExperimentRequest { /** - *The JSON pipeline definition.
+ *The name of the inference experiment to start.
* @public */ - PipelineDefinition?: string | undefined; + Name: string | undefined; +} +/** + * @public + */ +export interface StartInferenceExperimentResponse { /** - *The location of the pipeline definition stored in Amazon S3. If specified, - * SageMaker will retrieve the pipeline definition from this location.
+ *The ARN of the started inference experiment to start.
* @public */ - PipelineDefinitionS3Location?: PipelineDefinitionS3Location | undefined; + InferenceExperimentArn: string | undefined; +} +/** + * @public + */ +export interface StartMlflowTrackingServerRequest { /** - *The description of the pipeline.
+ *The name of the tracking server to start.
* @public */ - PipelineDescription?: string | undefined; + TrackingServerName: string | undefined; +} +/** + * @public + */ +export interface StartMlflowTrackingServerResponse { /** - *The Amazon Resource Name (ARN) that the pipeline uses to execute.
+ *The ARN of the started tracking server.
* @public */ - RoleArn?: string | undefined; + TrackingServerArn?: string | undefined; +} +/** + * @public + */ +export interface StartMonitoringScheduleRequest { /** - *If specified, it applies to all executions of this pipeline by default.
+ *The name of the schedule to start.
* @public */ - ParallelismConfiguration?: ParallelismConfiguration | undefined; + MonitoringScheduleName: string | undefined; } /** * @public */ -export interface UpdatePipelineResponse { +export interface StartNotebookInstanceInput { /** - *The Amazon Resource Name (ARN) of the updated pipeline.
+ *The name of the notebook instance to start.
* @public */ - PipelineArn?: string | undefined; + NotebookInstanceName: string | undefined; } /** * @public */ -export interface UpdatePipelineExecutionRequest { +export interface StartPipelineExecutionRequest { /** - *The Amazon Resource Name (ARN) of the pipeline execution.
+ *The name or Amazon Resource Name (ARN) of the pipeline.
* @public */ - PipelineExecutionArn: string | undefined; + PipelineName: string | undefined; + + /** + *The display name of the pipeline execution.
+ * @public + */ + PipelineExecutionDisplayName?: string | undefined; + + /** + *Contains a list of pipeline parameters. This list can be empty.
+ * @public + */ + PipelineParameters?: Parameter[] | undefined; /** *The description of the pipeline execution.
@@ -10143,10 +10706,11 @@ export interface UpdatePipelineExecutionRequest { PipelineExecutionDescription?: string | undefined; /** - *The display name of the pipeline execution.
+ *A unique, case-sensitive identifier that you provide to ensure the idempotency of the + * operation. An idempotent operation completes no more than once.
* @public */ - PipelineExecutionDisplayName?: string | undefined; + ClientRequestToken?: string | undefined; /** *This configuration, if specified, overrides the parallelism configuration @@ -10154,282 +10718,336 @@ export interface UpdatePipelineExecutionRequest { * @public */ ParallelismConfiguration?: ParallelismConfiguration | undefined; + + /** + *
The selective execution configuration applied to the pipeline run.
+ * @public + */ + SelectiveExecutionConfig?: SelectiveExecutionConfig | undefined; } /** * @public */ -export interface UpdatePipelineExecutionResponse { +export interface StartPipelineExecutionResponse { /** - *The Amazon Resource Name (ARN) of the updated pipeline execution.
+ *The Amazon Resource Name (ARN) of the pipeline execution.
* @public */ PipelineExecutionArn?: string | undefined; } /** - *Details that you specify to provision a service catalog product. - * For information about service catalog, see What is Amazon Web Services Service Catalog. - *
* @public */ -export interface ServiceCatalogProvisioningUpdateDetails { - /** - *The ID of the provisioning artifact.
- * @public - */ - ProvisioningArtifactId?: string | undefined; - +export interface StopAutoMLJobRequest { /** - *A list of key value pairs that you specify when you provision a product.
+ *The name of the object you are requesting.
* @public */ - ProvisioningParameters?: ProvisioningParameter[] | undefined; + AutoMLJobName: string | undefined; } /** * @public */ -export interface UpdateProjectInput { +export interface StopCompilationJobRequest { /** - *The name of the project.
+ *The name of the model compilation job to stop.
* @public */ - ProjectName: string | undefined; + CompilationJobName: string | undefined; +} +/** + * @public + */ +export interface StopEdgeDeploymentStageRequest { /** - *The description for the project.
+ *The name of the edge deployment plan to stop.
* @public */ - ProjectDescription?: string | undefined; + EdgeDeploymentPlanName: string | undefined; /** - *The product ID and provisioning artifact ID to provision a service catalog. - * The provisioning artifact ID will default to the latest provisioning artifact - * ID of the product, if you don't provide the provisioning artifact ID. For more - * information, see What is Amazon Web Services Service Catalog. - *
+ *The name of the stage to stop.
* @public */ - ServiceCatalogProvisioningUpdateDetails?: ServiceCatalogProvisioningUpdateDetails | undefined; + StageName: string | undefined; +} +/** + * @public + */ +export interface StopEdgePackagingJobRequest { /** - *An array of key-value pairs. You can use tags to categorize your - * Amazon Web Services resources in different ways, for example, by purpose, owner, or - * environment. For more information, see Tagging Amazon Web Services Resources. - * In addition, the project must have tag update constraints set in order to include this - * parameter in the request. For more information, see Amazon Web Services Service - * Catalog Tag Update Constraints.
+ *The name of the edge packaging job.
* @public */ - Tags?: Tag[] | undefined; + EdgePackagingJobName: string | undefined; } /** * @public */ -export interface UpdateProjectOutput { +export interface StopHyperParameterTuningJobRequest { /** - *The Amazon Resource Name (ARN) of the project.
+ *The name of the tuning job to stop.
* @public */ - ProjectArn: string | undefined; + HyperParameterTuningJobName: string | undefined; } /** * @public */ -export interface UpdateSpaceRequest { +export interface StopInferenceExperimentRequest { /** - *The ID of the associated domain.
+ *The name of the inference experiment to stop.
* @public */ - DomainId: string | undefined; + Name: string | undefined; /** - *The name of the space.
+ *+ * Array of key-value pairs, with names of variants mapped to actions. The possible actions are the following: + *
+ *
+ * Promote - Promote the shadow variant to a production variant
+ * Remove - Delete the variant
+ * Retain - Keep the variant as it is
A collection of space settings.
+ *
+ * An array of ModelVariantConfig objects. There is one for each variant that you want to deploy
+ * after the inference experiment stops. Each ModelVariantConfig describes the infrastructure
+ * configuration for deploying the corresponding variant.
+ *
The name of the space that appears in the Amazon SageMaker Studio UI.
+ *+ * The desired state of the experiment after stopping. The possible states are the following: + *
+ *
+ * Completed: The experiment completed successfully
+ * Cancelled: The experiment was canceled
The space's Amazon Resource Name (ARN).
+ *The reason for stopping the experiment.
* @public */ - SpaceArn?: string | undefined; + Reason?: string | undefined; } /** * @public */ -export interface UpdateTrainingJobRequest { - /** - *The name of a training job to update the Debugger profiling configuration.
- * @public - */ - TrainingJobName: string | undefined; - +export interface StopInferenceExperimentResponse { /** - *Configuration information for Amazon SageMaker Debugger system monitoring, framework profiling, and - * storage paths.
+ *The ARN of the stopped inference experiment.
* @public */ - ProfilerConfig?: ProfilerConfigForUpdate | undefined; + InferenceExperimentArn: string | undefined; +} +/** + * @public + */ +export interface StopInferenceRecommendationsJobRequest { /** - *Configuration information for Amazon SageMaker Debugger rules for profiling system and framework - * metrics.
+ *The name of the job you want to stop.
* @public */ - ProfilerRuleConfigurations?: ProfilerRuleConfiguration[] | undefined; + JobName: string | undefined; +} +/** + * @public + */ +export interface StopLabelingJobRequest { /** - *The training job ResourceConfig to update warm pool retention
- * length.
The name of the labeling job to stop.
* @public */ - ResourceConfig?: ResourceConfigForUpdate | undefined; + LabelingJobName: string | undefined; +} +/** + * @public + */ +export interface StopMlflowTrackingServerRequest { /** - *Configuration for remote debugging while the training job is running. You can update
- * the remote debugging configuration when the SecondaryStatus of the job is
- * Downloading or Training.To learn more about the remote
- * debugging functionality of SageMaker, see Access a training container
- * through Amazon Web Services Systems Manager (SSM) for remote
- * debugging.
The name of the tracking server to stop.
* @public */ - RemoteDebugConfig?: RemoteDebugConfigForUpdate | undefined; + TrackingServerName: string | undefined; } /** * @public */ -export interface UpdateTrainingJobResponse { +export interface StopMlflowTrackingServerResponse { /** - *The Amazon Resource Name (ARN) of the training job.
+ *The ARN of the stopped tracking server.
* @public */ - TrainingJobArn: string | undefined; + TrackingServerArn?: string | undefined; } /** * @public */ -export interface UpdateTrialRequest { +export interface StopMonitoringScheduleRequest { /** - *The name of the trial to update.
+ *The name of the schedule to stop.
* @public */ - TrialName: string | undefined; + MonitoringScheduleName: string | undefined; +} +/** + * @public + */ +export interface StopNotebookInstanceInput { /** - *The name of the trial as displayed. The name doesn't need to be unique. If
- * DisplayName isn't specified, TrialName is displayed.
The name of the notebook instance to terminate.
* @public */ - DisplayName?: string | undefined; + NotebookInstanceName: string | undefined; } /** * @public */ -export interface UpdateTrialResponse { +export interface StopOptimizationJobRequest { /** - *The Amazon Resource Name (ARN) of the trial.
+ *The name that you assigned to the optimization job.
* @public */ - TrialArn?: string | undefined; + OptimizationJobName: string | undefined; } /** * @public */ -export interface UpdateTrialComponentRequest { +export interface StopPipelineExecutionRequest { /** - *The name of the component to update.
+ *The Amazon Resource Name (ARN) of the pipeline execution.
* @public */ - TrialComponentName: string | undefined; + PipelineExecutionArn: string | undefined; /** - *The name of the component as displayed. The name doesn't need to be unique. If
- * DisplayName isn't specified, TrialComponentName is
- * displayed.
A unique, case-sensitive identifier that you provide to ensure the idempotency of the + * operation. An idempotent operation completes no more than once.
* @public */ - DisplayName?: string | undefined; + ClientRequestToken?: string | undefined; +} +/** + * @public + */ +export interface StopPipelineExecutionResponse { /** - *The new status of the component.
+ *The Amazon Resource Name (ARN) of the pipeline execution.
* @public */ - Status?: TrialComponentStatus | undefined; + PipelineExecutionArn?: string | undefined; +} +/** + * @public + */ +export interface StopProcessingJobRequest { /** - *When the component started.
+ *The name of the processing job to stop.
* @public */ - StartTime?: Date | undefined; + ProcessingJobName: string | undefined; +} +/** + * @public + */ +export interface StopTrainingJobRequest { /** - *When the component ended.
+ *The name of the training job to stop.
* @public */ - EndTime?: Date | undefined; + TrainingJobName: string | undefined; +} +/** + * @public + */ +export interface StopTransformJobRequest { /** - *Replaces all of the component's hyperparameters with the specified hyperparameters or add new hyperparameters. Existing hyperparameters are replaced if the trial component is updated with an identical hyperparameter key.
+ *The name of the batch transform job to stop.
* @public */ - Parameters?: RecordThe hyperparameters to remove from the component.
+ *The name of the action to update.
* @public */ - ParametersToRemove?: string[] | undefined; + ActionName: string | undefined; /** - *Replaces all of the component's input artifacts with the specified artifacts or adds new input artifacts. Existing input artifacts are replaced if the trial component is updated with an identical input artifact key.
+ *The new description for the action.
* @public */ - InputArtifacts?: RecordThe input artifacts to remove from the component.
+ *The new status for the action.
* @public */ - InputArtifactsToRemove?: string[] | undefined; + Status?: ActionStatus | undefined; /** - *Replaces all of the component's output artifacts with the specified artifacts or adds new output artifacts. Existing output artifacts are replaced if the trial component is updated with an identical output artifact key.
+ *The new list of properties. Overwrites the current property list.
* @public */ - OutputArtifacts?: RecordThe output artifacts to remove from the component.
+ *A list of properties to remove.
* @public */ - OutputArtifactsToRemove?: string[] | undefined; + PropertiesToRemove?: string[] | undefined; } /** @@ -10466,19 +11084,3 @@ export const SearchResponseFilterSensitiveLog = (obj: SearchResponse): any => ({ ...obj, ...(obj.Results && { Results: obj.Results.map((item) => SearchRecordFilterSensitiveLog(item)) }), }); - -/** - * @internal - */ -export const UpdateModelCardRequestFilterSensitiveLog = (obj: UpdateModelCardRequest): any => ({ - ...obj, - ...(obj.Content && { Content: SENSITIVE_STRING }), -}); - -/** - * @internal - */ -export const UpdateModelPackageInputFilterSensitiveLog = (obj: UpdateModelPackageInput): any => ({ - ...obj, - ...(obj.ModelCard && { ModelCard: ModelPackageModelCardFilterSensitiveLog(obj.ModelCard) }), -}); diff --git a/clients/client-sagemaker/src/models/models_5.ts b/clients/client-sagemaker/src/models/models_5.ts index c52371366872..3b268d11d99a 100644 --- a/clients/client-sagemaker/src/models/models_5.ts +++ b/clients/client-sagemaker/src/models/models_5.ts @@ -1,22 +1,2094 @@ // smithy-typescript generated code -import { BooleanOperator } from "./models_0"; +import { SENSITIVE_STRING } from "@smithy/smithy-client"; -import { UserSettings } from "./models_1"; +import { + ActivationState, + AdditionalInferenceSpecificationDefinition, + AppNetworkAccessType, + AppSecurityGroupManagement, + BooleanOperator, + ClusterInstanceGroupSpecification, + ClusterNodeRecovery, + CodeEditorAppImageConfig, + ComputeQuotaConfig, + ComputeQuotaTarget, + InferenceSpecification, + JupyterLabAppImageConfig, + KernelGatewayImageConfig, + ModelApprovalStatus, + Tag, +} from "./models_0"; + +import { + _InstanceType, + DefaultSpaceSettings, + DeploymentConfig, + EdgeOutputConfig, + FeatureDefinition, + InferenceComponentRuntimeConfig, + InferenceComponentSpecification, + InferenceExperimentDataStorageConfig, + InferenceExperimentSchedule, + JobType, + ModelCardStatus, + ModelLifeCycle, + ModelPackageModelCard, + ModelPackageModelCardFilterSensitiveLog, + ModelVariantConfig, + MonitoringScheduleConfig, + Processor, + SchedulerConfig, + ShadowModeConfig, + TagPropagation, + ThroughputMode, + TrackingServerSize, + UserSettings, + VendorGuidance, +} from "./models_1"; + +import { + CrossAccountFilterOption, + FeatureParameter, + InstanceMetadataServiceConfiguration, + MemberDefinition, + NotebookInstanceAcceleratorType, + NotebookInstanceLifecycleHook, + NotificationConfiguration, + OidcConfig, + OidcConfigFilterSensitiveLog, + ParallelismConfiguration, + PartnerAppConfig, + PartnerAppMaintenanceConfig, + PipelineDefinitionS3Location, + ProfilerRuleConfiguration, + ProvisioningParameter, + RootAccess, + SourceIpConfig, + SpaceSettings, + TrialComponentArtifact, + TrialComponentParameterValue, + TrialComponentStatus, + WorkerAccessConfiguration, + WorkforceVpcConfigRequest, +} from "./models_2"; + +import { + DesiredWeightAndCapacity, + Device, + DomainSettingsForUpdate, + Filter, + GitConfigForUpdate, + ResourceType, + Workforce, + Workteam, +} from "./models_3"; + +import { + NestedFilters, + OnlineStoreConfigUpdate, + ProfilerConfigForUpdate, + RemoteDebugConfigForUpdate, + ResourceConfigForUpdate, + SearchSortOrder, + VisibilityConditions, +} from "./models_4"; + +/** + * @public + */ +export interface UpdateActionResponse { + /** + *The Amazon Resource Name (ARN) of the action.
+ * @public + */ + ActionArn?: string | undefined; +} + +/** + * @public + */ +export interface UpdateAppImageConfigRequest { + /** + *The name of the AppImageConfig to update.
+ * @public + */ + AppImageConfigName: string | undefined; + + /** + *The new KernelGateway app to run on the image.
+ * @public + */ + KernelGatewayImageConfig?: KernelGatewayImageConfig | undefined; + + /** + *The JupyterLab app running on the image.
+ * @public + */ + JupyterLabAppImageConfig?: JupyterLabAppImageConfig | undefined; + + /** + *The Code Editor app running on the image.
+ * @public + */ + CodeEditorAppImageConfig?: CodeEditorAppImageConfig | undefined; +} + +/** + * @public + */ +export interface UpdateAppImageConfigResponse { + /** + *The ARN for the AppImageConfig.
+ * @public + */ + AppImageConfigArn?: string | undefined; +} + +/** + * @public + */ +export interface UpdateArtifactRequest { + /** + *The Amazon Resource Name (ARN) of the artifact to update.
+ * @public + */ + ArtifactArn: string | undefined; + + /** + *The new name for the artifact.
+ * @public + */ + ArtifactName?: string | undefined; + + /** + *The new list of properties. Overwrites the current property list.
+ * @public + */ + Properties?: RecordA list of properties to remove.
+ * @public + */ + PropertiesToRemove?: string[] | undefined; +} + +/** + * @public + */ +export interface UpdateArtifactResponse { + /** + *The Amazon Resource Name (ARN) of the artifact.
+ * @public + */ + ArtifactArn?: string | undefined; +} + +/** + * @public + */ +export interface UpdateClusterRequest { + /** + *Specify the name of the SageMaker HyperPod cluster you want to update.
+ * @public + */ + ClusterName: string | undefined; + + /** + *Specify the instance groups to update.
+ * @public + */ + InstanceGroups: ClusterInstanceGroupSpecification[] | undefined; + + /** + *The node recovery mode to be applied to the SageMaker HyperPod cluster.
+ * @public + */ + NodeRecovery?: ClusterNodeRecovery | undefined; +} + +/** + * @public + */ +export interface UpdateClusterResponse { + /** + *The Amazon Resource Name (ARN) of the updated SageMaker HyperPod cluster.
+ * @public + */ + ClusterArn: string | undefined; +} + +/** + * @public + */ +export interface UpdateClusterSchedulerConfigRequest { + /** + *ID of the cluster policy.
+ * @public + */ + ClusterSchedulerConfigId: string | undefined; + + /** + *Target version.
+ * @public + */ + TargetVersion: number | undefined; + + /** + *Cluster policy configuration.
+ * @public + */ + SchedulerConfig?: SchedulerConfig | undefined; + + /** + *Description of the cluster policy.
+ * @public + */ + Description?: string | undefined; +} + +/** + * @public + */ +export interface UpdateClusterSchedulerConfigResponse { + /** + *ARN of the cluster policy.
+ * @public + */ + ClusterSchedulerConfigArn: string | undefined; + + /** + *Version of the cluster policy.
+ * @public + */ + ClusterSchedulerConfigVersion: number | undefined; +} + +/** + * @public + */ +export interface UpdateClusterSoftwareRequest { + /** + *Specify the name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster you want to update for security + * patching.
+ * @public + */ + ClusterName: string | undefined; +} + +/** + * @public + */ +export interface UpdateClusterSoftwareResponse { + /** + *The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster being updated for security patching.
+ * @public + */ + ClusterArn: string | undefined; +} + +/** + * @public + */ +export interface UpdateCodeRepositoryInput { + /** + *The name of the Git repository to update.
+ * @public + */ + CodeRepositoryName: string | undefined; + + /** + *The configuration of the git repository, including the URL and the Amazon Resource
+ * Name (ARN) of the Amazon Web Services Secrets Manager secret that contains the
+ * credentials used to access the repository. The secret must have a staging label of
+ * AWSCURRENT and must be in the following format:
+ * \{"username": UserName, "password":
+ * Password\}
+ *
The ARN of the Git repository.
+ * @public + */ + CodeRepositoryArn: string | undefined; +} + +/** + * @public + */ +export interface UpdateComputeQuotaRequest { + /** + *ID of the compute allocation definition.
+ * @public + */ + ComputeQuotaId: string | undefined; + + /** + *Target version.
+ * @public + */ + TargetVersion: number | undefined; + + /** + *Configuration of the compute allocation definition. This includes the resource sharing + * option, and the setting to preempt low priority tasks.
+ * @public + */ + ComputeQuotaConfig?: ComputeQuotaConfig | undefined; + + /** + *The target entity to allocate compute resources to.
+ * @public + */ + ComputeQuotaTarget?: ComputeQuotaTarget | undefined; + + /** + *The state of the compute allocation being described. Use to enable or disable compute + * allocation.
+ *Default is Enabled.
Description of the compute allocation definition.
+ * @public + */ + Description?: string | undefined; +} + +/** + * @public + */ +export interface UpdateComputeQuotaResponse { + /** + *ARN of the compute allocation definition.
+ * @public + */ + ComputeQuotaArn: string | undefined; + + /** + *Version of the compute allocation definition.
+ * @public + */ + ComputeQuotaVersion: number | undefined; +} + +/** + * @public + */ +export interface UpdateContextRequest { + /** + *The name of the context to update.
+ * @public + */ + ContextName: string | undefined; + + /** + *The new description for the context.
+ * @public + */ + Description?: string | undefined; + + /** + *The new list of properties. Overwrites the current property list.
+ * @public + */ + Properties?: RecordA list of properties to remove.
+ * @public + */ + PropertiesToRemove?: string[] | undefined; +} + +/** + * @public + */ +export interface UpdateContextResponse { + /** + *The Amazon Resource Name (ARN) of the context.
+ * @public + */ + ContextArn?: string | undefined; +} + +/** + * @public + */ +export interface UpdateDeviceFleetRequest { + /** + *The name of the fleet.
+ * @public + */ + DeviceFleetName: string | undefined; + + /** + *The Amazon Resource Name (ARN) of the device.
+ * @public + */ + RoleArn?: string | undefined; + + /** + *Description of the fleet.
+ * @public + */ + Description?: string | undefined; + + /** + *Output configuration for storing sample data collected by the fleet.
+ * @public + */ + OutputConfig: EdgeOutputConfig | undefined; + + /** + *Whether to create an Amazon Web Services IoT Role Alias during device fleet creation. + * The name of the role alias generated will match this pattern: + * "SageMakerEdge-\{DeviceFleetName\}".
+ *For example, if your device fleet is called "demo-fleet", the name of + * the role alias will be "SageMakerEdge-demo-fleet".
+ * @public + */ + EnableIotRoleAlias?: boolean | undefined; +} + +/** + * @public + */ +export interface UpdateDevicesRequest { + /** + *The name of the fleet the devices belong to.
+ * @public + */ + DeviceFleetName: string | undefined; + + /** + *List of devices to register with Edge Manager agent.
+ * @public + */ + Devices: Device[] | undefined; +} + +/** + * @public + */ +export interface UpdateDomainRequest { + /** + *The ID of the domain to be updated.
+ * @public + */ + DomainId: string | undefined; + + /** + *A collection of settings.
+ * @public + */ + DefaultUserSettings?: UserSettings | undefined; + + /** + *A collection of DomainSettings configuration values to update.
The entity that creates and manages the required security groups for inter-app
+ * communication in VPCOnly mode. Required when
+ * CreateDomain.AppNetworkAccessType is VPCOnly and
+ * DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is
+ * provided. If setting up the domain for use with RStudio, this value must be set to
+ * Service.
The default settings for shared spaces that users create in the domain.
+ * @public + */ + DefaultSpaceSettings?: DefaultSpaceSettings | undefined; + + /** + *The VPC subnets that Studio uses for communication.
+ *If removing subnets, ensure there are no apps in the InService,
+ * Pending, or Deleting state.
Specifies the VPC used for non-EFS traffic.
+ *
+ * PublicInternetOnly - Non-EFS traffic is through a VPC managed by Amazon SageMaker, which allows direct internet access.
+ * VpcOnly - All Studio traffic is through the specified VPC and
+ * subnets.
This configuration can only be modified if there are no apps in the
+ * InService, Pending, or Deleting state. The
+ * configuration cannot be updated if
+ * DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is already
+ * set or DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is
+ * provided as part of the same request.
Indicates whether custom tag propagation is supported for the domain. Defaults to
+ * DISABLED.
The Amazon Resource Name (ARN) of the domain.
+ * @public + */ + DomainArn?: string | undefined; +} + +/** + * @public + * @enum + */ +export const VariantPropertyType = { + DataCaptureConfig: "DataCaptureConfig", + DesiredInstanceCount: "DesiredInstanceCount", + DesiredWeight: "DesiredWeight", +} as const; + +/** + * @public + */ +export type VariantPropertyType = (typeof VariantPropertyType)[keyof typeof VariantPropertyType]; + +/** + *Specifies a production variant property type for an Endpoint.
+ *If you are updating an endpoint with the RetainAllVariantProperties
+ * option of UpdateEndpointInput set to true, the
+ * VariantProperty objects listed in the
+ * ExcludeRetainedVariantProperties parameter of UpdateEndpointInput override the existing variant properties of the
+ * endpoint.
The type of variant property. The supported values are:
+ *
+ * DesiredInstanceCount: Overrides the existing variant instance
+ * counts using the InitialInstanceCount values in the
+ * ProductionVariants of CreateEndpointConfig.
+ * DesiredWeight: Overrides the existing variant weights using the
+ * InitialVariantWeight values in the
+ * ProductionVariants of CreateEndpointConfig.
+ * DataCaptureConfig: (Not currently supported.)
The name of the endpoint whose configuration you want to update.
+ * @public + */ + EndpointName: string | undefined; + + /** + *The name of the new endpoint configuration.
+ * @public + */ + EndpointConfigName: string | undefined; + + /** + *When updating endpoint resources, enables or disables the retention of variant properties, such as the instance count or the variant weight. To
+ * retain the variant properties of an endpoint when updating it, set
+ * RetainAllVariantProperties to true. To use the variant
+ * properties specified in a new EndpointConfig call when updating an
+ * endpoint, set RetainAllVariantProperties to false. The default
+ * is false.
When you are updating endpoint resources with RetainAllVariantProperties,
+ * whose value is set to true, ExcludeRetainedVariantProperties
+ * specifies the list of type VariantProperty
+ * to override with the values provided by EndpointConfig. If you don't
+ * specify a value for ExcludeRetainedVariantProperties, no variant properties
+ * are overridden.
The deployment configuration for an endpoint, which contains the desired deployment + * strategy and rollback configurations.
+ * @public + */ + DeploymentConfig?: DeploymentConfig | undefined; + + /** + *Specifies whether to reuse the last deployment configuration. The default value is + * false (the configuration is not reused).
+ * @public + */ + RetainDeploymentConfig?: boolean | undefined; +} + +/** + * @public + */ +export interface UpdateEndpointOutput { + /** + *The Amazon Resource Name (ARN) of the endpoint.
+ * @public + */ + EndpointArn: string | undefined; +} + +/** + * @public + */ +export interface UpdateEndpointWeightsAndCapacitiesInput { + /** + *The name of an existing SageMaker endpoint.
+ * @public + */ + EndpointName: string | undefined; + + /** + *An object that provides new capacity and weight values for a variant.
+ * @public + */ + DesiredWeightsAndCapacities: DesiredWeightAndCapacity[] | undefined; +} + +/** + * @public + */ +export interface UpdateEndpointWeightsAndCapacitiesOutput { + /** + *The Amazon Resource Name (ARN) of the updated endpoint.
+ * @public + */ + EndpointArn: string | undefined; +} + +/** + * @public + */ +export interface UpdateExperimentRequest { + /** + *The name of the experiment to update.
+ * @public + */ + ExperimentName: string | undefined; + + /** + *The name of the experiment as displayed. The name doesn't need to be unique. If
+ * DisplayName isn't specified, ExperimentName is displayed.
The description of the experiment.
+ * @public + */ + Description?: string | undefined; +} + +/** + * @public + */ +export interface UpdateExperimentResponse { + /** + *The Amazon Resource Name (ARN) of the experiment.
+ * @public + */ + ExperimentArn?: string | undefined; +} + +/** + *The new throughput configuration for the feature group. You can switch between on-demand + * and provisioned modes or update the read / write capacity of provisioned feature groups. + * You can switch a feature group to on-demand only once in a 24 hour period.
+ * @public + */ +export interface ThroughputConfigUpdate { + /** + *Target throughput mode of the feature group. Throughput update is an asynchronous
+ * operation, and the outcome should be monitored by polling LastUpdateStatus
+ * field in DescribeFeatureGroup response. You cannot update a feature group's
+ * throughput while another update is in progress.
For provisioned feature groups with online store enabled, this indicates the read + * throughput you are billed for and can consume without throttling.
+ * @public + */ + ProvisionedReadCapacityUnits?: number | undefined; + + /** + *For provisioned feature groups, this indicates the write throughput you are billed for + * and can consume without throttling.
+ * @public + */ + ProvisionedWriteCapacityUnits?: number | undefined; +} + +/** + * @public + */ +export interface UpdateFeatureGroupRequest { + /** + *The name or Amazon Resource Name (ARN) of the feature group that you're updating.
+ * @public + */ + FeatureGroupName: string | undefined; + + /** + *Updates the feature group. Updating a feature group is an asynchronous operation. When + * you get an HTTP 200 response, you've made a valid request. It takes some time after you've + * made a valid request for Feature Store to update the feature group.
+ * @public + */ + FeatureAdditions?: FeatureDefinition[] | undefined; + + /** + *Updates the feature group online store configuration.
+ * @public + */ + OnlineStoreConfig?: OnlineStoreConfigUpdate | undefined; + + /** + *The new throughput configuration for the feature group. You can switch between on-demand + * and provisioned modes or update the read / write capacity of provisioned feature groups. + * You can switch a feature group to on-demand only once in a 24 hour period.
+ * @public + */ + ThroughputConfig?: ThroughputConfigUpdate | undefined; +} + +/** + * @public + */ +export interface UpdateFeatureGroupResponse { + /** + *The Amazon Resource Number (ARN) of the feature group that you're updating.
+ * @public + */ + FeatureGroupArn: string | undefined; +} + +/** + * @public + */ +export interface UpdateFeatureMetadataRequest { + /** + *The name or Amazon Resource Name (ARN) of the feature group containing the feature that + * you're updating.
+ * @public + */ + FeatureGroupName: string | undefined; + + /** + *The name of the feature that you're updating.
+ * @public + */ + FeatureName: string | undefined; + + /** + *A description that you can write to better describe the feature.
+ * @public + */ + Description?: string | undefined; + + /** + *A list of key-value pairs that you can add to better describe the feature.
+ * @public + */ + ParameterAdditions?: FeatureParameter[] | undefined; + + /** + *A list of parameter keys that you can specify to remove parameters that describe your + * feature.
+ * @public + */ + ParameterRemovals?: string[] | undefined; +} + +/** + * @public + */ +export interface UpdateHubRequest { + /** + *The name of the hub to update.
+ * @public + */ + HubName: string | undefined; + + /** + *A description of the updated hub.
+ * @public + */ + HubDescription?: string | undefined; + + /** + *The display name of the hub.
+ * @public + */ + HubDisplayName?: string | undefined; + + /** + *The searchable keywords for the hub.
+ * @public + */ + HubSearchKeywords?: string[] | undefined; +} + +/** + * @public + */ +export interface UpdateHubResponse { + /** + *The Amazon Resource Name (ARN) of the updated hub.
+ * @public + */ + HubArn: string | undefined; +} + +/** + * @public + */ +export interface UpdateImageRequest { + /** + *A list of properties to delete. Only the Description and
+ * DisplayName properties can be deleted.
The new description for the image.
+ * @public + */ + Description?: string | undefined; + + /** + *The new display name for the image.
+ * @public + */ + DisplayName?: string | undefined; + + /** + *The name of the image to update.
+ * @public + */ + ImageName: string | undefined; + + /** + *The new ARN for the IAM role that enables Amazon SageMaker to perform tasks on your behalf.
+ * @public + */ + RoleArn?: string | undefined; +} + +/** + * @public + */ +export interface UpdateImageResponse { + /** + *The ARN of the image.
+ * @public + */ + ImageArn?: string | undefined; +} + +/** + * @public + */ +export interface UpdateImageVersionRequest { + /** + *The name of the image.
+ * @public + */ + ImageName: string | undefined; + + /** + *The alias of the image version.
+ * @public + */ + Alias?: string | undefined; + + /** + *The version of the image.
+ * @public + */ + Version?: number | undefined; + + /** + *A list of aliases to add.
+ * @public + */ + AliasesToAdd?: string[] | undefined; + + /** + *A list of aliases to delete.
+ * @public + */ + AliasesToDelete?: string[] | undefined; + + /** + *The availability of the image version specified by the maintainer.
+ *
+ * NOT_PROVIDED: The maintainers did not provide a status for image version stability.
+ * STABLE: The image version is stable.
+ * TO_BE_ARCHIVED: The image version is set to be archived. Custom image versions that are set to be archived are automatically archived after three months.
+ * ARCHIVED: The image version is archived. Archived image versions are not searchable and are no longer actively supported.
Indicates SageMaker job type compatibility.
+ *
+ * TRAINING: The image version is compatible with SageMaker training jobs.
+ * INFERENCE: The image version is compatible with SageMaker inference jobs.
+ * NOTEBOOK_KERNEL: The image version is compatible with SageMaker notebook kernels.
The machine learning framework vended in the image version.
+ * @public + */ + MLFramework?: string | undefined; + + /** + *The supported programming language and its version.
+ * @public + */ + ProgrammingLang?: string | undefined; + + /** + *Indicates CPU or GPU compatibility.
+ *
+ * CPU: The image version is compatible with CPU.
+ * GPU: The image version is compatible with GPU.
Indicates Horovod compatibility.
+ * @public + */ + Horovod?: boolean | undefined; + + /** + *The maintainer description of the image version.
+ * @public + */ + ReleaseNotes?: string | undefined; +} + +/** + * @public + */ +export interface UpdateImageVersionResponse { + /** + *The ARN of the image version.
+ * @public + */ + ImageVersionArn?: string | undefined; +} + +/** + * @public + */ +export interface UpdateInferenceComponentInput { + /** + *The name of the inference component.
+ * @public + */ + InferenceComponentName: string | undefined; + + /** + *Details about the resources to deploy with this inference component, including the + * model, container, and compute resources.
+ * @public + */ + Specification?: InferenceComponentSpecification | undefined; + + /** + *Runtime settings for a model that is deployed with an inference component.
+ * @public + */ + RuntimeConfig?: InferenceComponentRuntimeConfig | undefined; +} + +/** + * @public + */ +export interface UpdateInferenceComponentOutput { + /** + *The Amazon Resource Name (ARN) of the inference component.
+ * @public + */ + InferenceComponentArn: string | undefined; +} + +/** + * @public + */ +export interface UpdateInferenceComponentRuntimeConfigInput { + /** + *The name of the inference component to update.
+ * @public + */ + InferenceComponentName: string | undefined; + + /** + *Runtime settings for a model that is deployed with an inference component.
+ * @public + */ + DesiredRuntimeConfig: InferenceComponentRuntimeConfig | undefined; +} + +/** + * @public + */ +export interface UpdateInferenceComponentRuntimeConfigOutput { + /** + *The Amazon Resource Name (ARN) of the inference component.
+ * @public + */ + InferenceComponentArn: string | undefined; +} + +/** + * @public + */ +export interface UpdateInferenceExperimentRequest { + /** + *The name of the inference experiment to be updated.
+ * @public + */ + Name: string | undefined; + + /** + *
+ * The duration for which the inference experiment will run. If the status of the inference experiment is
+ * Created, then you can update both the start and end dates. If the status of the inference
+ * experiment is Running, then you can update only the end date.
+ *
The description of the inference experiment.
+ * @public + */ + Description?: string | undefined; + + /** + *
+ * An array of ModelVariantConfig objects. There is one for each variant, whose infrastructure
+ * configuration you want to update.
+ *
The Amazon S3 location and configuration for storing inference request and response data.
+ * @public + */ + DataStorageConfig?: InferenceExperimentDataStorageConfig | undefined; + + /** + *
+ * The configuration of ShadowMode inference experiment type. Use this field to specify a
+ * production variant which takes all the inference requests, and a shadow variant to which Amazon SageMaker replicates a
+ * percentage of the inference requests. For the shadow variant also specify the percentage of requests that
+ * Amazon SageMaker replicates.
+ *
The ARN of the updated inference experiment.
+ * @public + */ + InferenceExperimentArn: string | undefined; +} + +/** + * @public + */ +export interface UpdateMlflowTrackingServerRequest { + /** + *The name of the MLflow Tracking Server to update.
+ * @public + */ + TrackingServerName: string | undefined; + + /** + *The new S3 URI for the general purpose bucket to use as the artifact store for the MLflow + * Tracking Server.
+ * @public + */ + ArtifactStoreUri?: string | undefined; + + /** + *The new size for the MLflow Tracking Server.
+ * @public + */ + TrackingServerSize?: TrackingServerSize | undefined; + + /** + *Whether to enable or disable automatic registration of new MLflow models to the SageMaker Model Registry.
+ * To enable automatic model registration, set this value to True.
+ * To disable automatic model registration, set this value to False.
+ * If not specified, AutomaticModelRegistration defaults to False
+ *
The new weekly maintenance window start day and time to update. The maintenance window day and time should be + * in Coordinated Universal Time (UTC) 24-hour standard time. For example: TUE:03:30.
+ * @public + */ + WeeklyMaintenanceWindowStart?: string | undefined; +} + +/** + * @public + */ +export interface UpdateMlflowTrackingServerResponse { + /** + *The ARN of the updated MLflow Tracking Server.
+ * @public + */ + TrackingServerArn?: string | undefined; +} + +/** + * @public + */ +export interface UpdateModelCardRequest { + /** + *The name or Amazon Resource Name (ARN) of the model card to update.
+ * @public + */ + ModelCardName: string | undefined; + + /** + *The updated model card content. Content must be in model card JSON schema and provided as a string.
+ *When updating model card content, be sure to include the full content and not just updated content.
+ * @public + */ + Content?: string | undefined; + + /** + *The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.
+ *
+ * Draft: The model card is a work in progress.
+ * PendingReview: The model card is pending review.
+ * Approved: The model card is approved.
+ * Archived: The model card is archived. No more updates should be made to the model
+ * card, but it can still be exported.
The Amazon Resource Name (ARN) of the updated model card.
+ * @public + */ + ModelCardArn: string | undefined; +} + +/** + * @public + */ +export interface UpdateModelPackageInput { + /** + *The Amazon Resource Name (ARN) of the model package.
+ * @public + */ + ModelPackageArn: string | undefined; + + /** + *The approval status of the model.
+ * @public + */ + ModelApprovalStatus?: ModelApprovalStatus | undefined; + + /** + *A description for the approval status of the model.
+ * @public + */ + ApprovalDescription?: string | undefined; + + /** + *The metadata properties associated with the model package versions.
+ * @public + */ + CustomerMetadataProperties?: RecordThe metadata properties associated with the model package versions to remove.
+ * @public + */ + CustomerMetadataPropertiesToRemove?: string[] | undefined; + + /** + *An array of additional Inference Specification objects to be added to the + * existing array additional Inference Specification. Total number of additional + * Inference Specifications can not exceed 15. 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 + */ + AdditionalInferenceSpecificationsToAdd?: AdditionalInferenceSpecificationDefinition[] | undefined; + + /** + *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 + * artifacts.
+ *The instance types that the model package supports for transform jobs and + * real-time endpoints used for inference.
+ *The input and output content formats that the model package supports for + * inference.
+ *The URI of the source for the model package.
+ * @public + */ + 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.
+ * 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. + *
+ * @public + */ + ClientToken?: string | undefined; +} + +/** + * @public + */ +export interface UpdateModelPackageOutput { + /** + *The Amazon Resource Name (ARN) of the model.
+ * @public + */ + ModelPackageArn: string | undefined; +} + +/** + * @public + */ +export interface UpdateMonitoringAlertRequest { + /** + *The name of a monitoring schedule.
+ * @public + */ + MonitoringScheduleName: string | undefined; + + /** + *The name of a monitoring alert.
+ * @public + */ + MonitoringAlertName: string | undefined; + + /** + *Within EvaluationPeriod, how many execution failures will raise an
+ * alert.
The number of most recent monitoring executions to consider when evaluating alert + * status.
+ * @public + */ + EvaluationPeriod: number | undefined; +} + +/** + * @public + */ +export interface UpdateMonitoringAlertResponse { + /** + *The Amazon Resource Name (ARN) of the monitoring schedule.
+ * @public + */ + MonitoringScheduleArn: string | undefined; + + /** + *The name of a monitoring alert.
+ * @public + */ + MonitoringAlertName?: string | undefined; +} + +/** + * @public + */ +export interface UpdateMonitoringScheduleRequest { + /** + *The name of the monitoring schedule. The name must be unique within an Amazon Web Services + * Region within an Amazon Web Services account.
+ * @public + */ + MonitoringScheduleName: string | undefined; + + /** + *The configuration object that specifies the monitoring schedule and defines the monitoring + * job.
+ * @public + */ + MonitoringScheduleConfig: MonitoringScheduleConfig | undefined; +} + +/** + * @public + */ +export interface UpdateMonitoringScheduleResponse { + /** + *The Amazon Resource Name (ARN) of the monitoring schedule.
+ * @public + */ + MonitoringScheduleArn: string | undefined; +} + +/** + * @public + */ +export interface UpdateNotebookInstanceInput { + /** + *The name of the notebook instance to update.
+ * @public + */ + NotebookInstanceName: string | undefined; + + /** + *The Amazon ML compute instance type.
+ * @public + */ + InstanceType?: _InstanceType | undefined; + + /** + *The Amazon Resource Name (ARN) of the IAM role that SageMaker can assume to + * access the notebook instance. For more information, see SageMaker Roles.
+ *To be able to pass this role to SageMaker, the caller of this API must
+ * have the iam:PassRole permission.
The name of a lifecycle configuration to associate with the notebook instance. For + * information about lifestyle configurations, see Step 2.1: (Optional) + * Customize a Notebook Instance.
+ * @public + */ + LifecycleConfigName?: string | undefined; + + /** + *Set to true to remove the notebook instance lifecycle configuration
+ * currently associated with the notebook instance. This operation is idempotent. If you
+ * specify a lifecycle configuration that is not associated with the notebook instance when
+ * you call this method, it does not throw an error.
The size, in GB, of the ML storage volume to attach to the notebook instance. The + * default value is 5 GB. ML storage volumes are encrypted, so SageMaker can't + * determine the amount of available free space on the volume. Because of this, you can + * increase the volume size when you update a notebook instance, but you can't decrease the + * volume size. If you want to decrease the size of the ML storage volume in use, create a + * new notebook instance with the desired size.
+ * @public + */ + VolumeSizeInGB?: number | undefined; + + /** + *The Git repository to associate with the notebook instance as its default code + * repository. This can be either the name of a Git repository stored as a resource in your + * account, or the URL of a Git repository in Amazon Web Services CodeCommit + * or in any other Git repository. When you open a notebook instance, it opens in the + * directory that contains this repository. For more information, see Associating Git + * Repositories with SageMaker Notebook Instances.
+ * @public + */ + DefaultCodeRepository?: string | undefined; + + /** + *An array of up to three Git repositories to associate with the notebook instance. + * These can be either the names of Git repositories stored as resources in your account, + * or the URL of Git repositories in Amazon Web Services CodeCommit + * or in any other Git repository. These repositories are cloned at the same level as the + * default repository of your notebook instance. For more information, see Associating Git + * Repositories with SageMaker Notebook Instances.
+ * @public + */ + AdditionalCodeRepositories?: string[] | undefined; + + /** + *This parameter is no longer supported. Elastic Inference (EI) is no longer + * available.
+ *This parameter was used to specify a list of the EI instance types to associate with + * this notebook instance.
+ * @public + */ + AcceleratorTypes?: NotebookInstanceAcceleratorType[] | undefined; + + /** + *This parameter is no longer supported. Elastic Inference (EI) is no longer + * available.
+ *This parameter was used to specify a list of the EI instance types to remove from this notebook + * instance.
+ * @public + */ + DisassociateAcceleratorTypes?: boolean | undefined; + + /** + *The name or URL of the default Git repository to remove from this notebook instance. + * This operation is idempotent. If you specify a Git repository that is not associated + * with the notebook instance when you call this method, it does not throw an error.
+ * @public + */ + DisassociateDefaultCodeRepository?: boolean | undefined; + + /** + *A list of names or URLs of the default Git repositories to remove from this notebook + * instance. This operation is idempotent. If you specify a Git repository that is not + * associated with the notebook instance when you call this method, it does not throw an + * error.
+ * @public + */ + DisassociateAdditionalCodeRepositories?: boolean | undefined; + + /** + *Whether root access is enabled or disabled for users of the notebook instance. The
+ * default value is Enabled.
If you set this to Disabled, users don't have root access on the
+ * notebook instance, but lifecycle configuration scripts still run with root
+ * permissions.
Information on the IMDS configuration of the notebook instance
+ * @public + */ + InstanceMetadataServiceConfiguration?: InstanceMetadataServiceConfiguration | undefined; +} + +/** + * @public + */ +export interface UpdateNotebookInstanceOutput {} + +/** + * @public + */ +export interface UpdateNotebookInstanceLifecycleConfigInput { + /** + *The name of the lifecycle configuration.
+ * @public + */ + NotebookInstanceLifecycleConfigName: string | undefined; + + /** + *The shell script that runs only once, when you create a notebook instance. The shell + * script must be a base64-encoded string.
+ * @public + */ + OnCreate?: NotebookInstanceLifecycleHook[] | undefined; + + /** + *The shell script that runs every time you start a notebook instance, including when + * you create the notebook instance. The shell script must be a base64-encoded + * string.
+ * @public + */ + OnStart?: NotebookInstanceLifecycleHook[] | undefined; +} + +/** + * @public + */ +export interface UpdateNotebookInstanceLifecycleConfigOutput {} + +/** + * @public + */ +export interface UpdatePartnerAppRequest { + /** + *The ARN of the SageMaker Partner AI App to update.
+ * @public + */ + Arn: string | undefined; + + /** + *Maintenance configuration settings for the SageMaker Partner AI App.
+ * @public + */ + MaintenanceConfig?: PartnerAppMaintenanceConfig | undefined; + + /** + *Indicates the instance type and size of the cluster attached to the SageMaker Partner AI App.
+ * @public + */ + Tier?: string | undefined; + + /** + *Configuration settings for the SageMaker Partner AI App.
+ * @public + */ + ApplicationConfig?: PartnerAppConfig | undefined; + + /** + *When set to TRUE, the SageMaker Partner AI App sets the Amazon Web Services IAM session name or the authenticated IAM user as the identity of the SageMaker Partner AI App user.
A unique token that guarantees that the call to this API is idempotent.
+ * @public + */ + ClientToken?: string | undefined; + + /** + *Each tag consists of a key and an optional value. Tag keys must be unique per + * resource.
+ * @public + */ + Tags?: Tag[] | undefined; +} + +/** + * @public + */ +export interface UpdatePartnerAppResponse { + /** + *The ARN of the SageMaker Partner AI App that was updated.
+ * @public + */ + Arn?: string | undefined; +} -import { - CrossAccountFilterOption, - MemberDefinition, - NotificationConfiguration, - OidcConfig, - OidcConfigFilterSensitiveLog, - SourceIpConfig, - WorkerAccessConfiguration, - WorkforceVpcConfigRequest, -} from "./models_2"; +/** + * @public + */ +export interface UpdatePipelineRequest { + /** + *The name of the pipeline to update.
+ * @public + */ + PipelineName: string | undefined; + + /** + *The display name of the pipeline.
+ * @public + */ + PipelineDisplayName?: string | undefined; + + /** + *The JSON pipeline definition.
+ * @public + */ + PipelineDefinition?: string | undefined; + + /** + *The location of the pipeline definition stored in Amazon S3. If specified, + * SageMaker will retrieve the pipeline definition from this location.
+ * @public + */ + PipelineDefinitionS3Location?: PipelineDefinitionS3Location | undefined; + + /** + *The description of the pipeline.
+ * @public + */ + PipelineDescription?: string | undefined; + + /** + *The Amazon Resource Name (ARN) that the pipeline uses to execute.
+ * @public + */ + RoleArn?: string | undefined; + + /** + *If specified, it applies to all executions of this pipeline by default.
+ * @public + */ + ParallelismConfiguration?: ParallelismConfiguration | undefined; +} + +/** + * @public + */ +export interface UpdatePipelineResponse { + /** + *The Amazon Resource Name (ARN) of the updated pipeline.
+ * @public + */ + PipelineArn?: string | undefined; +} + +/** + * @public + */ +export interface UpdatePipelineExecutionRequest { + /** + *The Amazon Resource Name (ARN) of the pipeline execution.
+ * @public + */ + PipelineExecutionArn: string | undefined; + + /** + *The description of the pipeline execution.
+ * @public + */ + PipelineExecutionDescription?: string | undefined; + + /** + *The display name of the pipeline execution.
+ * @public + */ + PipelineExecutionDisplayName?: string | undefined; + + /** + *This configuration, if specified, overrides the parallelism configuration + * of the parent pipeline for this specific run.
+ * @public + */ + ParallelismConfiguration?: ParallelismConfiguration | undefined; +} + +/** + * @public + */ +export interface UpdatePipelineExecutionResponse { + /** + *The Amazon Resource Name (ARN) of the updated pipeline execution.
+ * @public + */ + PipelineExecutionArn?: string | undefined; +} + +/** + *Details that you specify to provision a service catalog product. + * For information about service catalog, see What is Amazon Web Services Service Catalog. + *
+ * @public + */ +export interface ServiceCatalogProvisioningUpdateDetails { + /** + *The ID of the provisioning artifact.
+ * @public + */ + ProvisioningArtifactId?: string | undefined; + + /** + *A list of key value pairs that you specify when you provision a product.
+ * @public + */ + ProvisioningParameters?: ProvisioningParameter[] | undefined; +} + +/** + * @public + */ +export interface UpdateProjectInput { + /** + *The name of the project.
+ * @public + */ + ProjectName: string | undefined; + + /** + *The description for the project.
+ * @public + */ + ProjectDescription?: string | undefined; + + /** + *The product ID and provisioning artifact ID to provision a service catalog. + * The provisioning artifact ID will default to the latest provisioning artifact + * ID of the product, if you don't provide the provisioning artifact ID. For more + * information, see What is Amazon Web Services Service Catalog. + *
+ * @public + */ + ServiceCatalogProvisioningUpdateDetails?: ServiceCatalogProvisioningUpdateDetails | undefined; + + /** + *An array of key-value pairs. You can use tags to categorize your + * Amazon Web Services resources in different ways, for example, by purpose, owner, or + * environment. For more information, see Tagging Amazon Web Services Resources. + * In addition, the project must have tag update constraints set in order to include this + * parameter in the request. For more information, see Amazon Web Services Service + * Catalog Tag Update Constraints.
+ * @public + */ + Tags?: Tag[] | undefined; +} + +/** + * @public + */ +export interface UpdateProjectOutput { + /** + *The Amazon Resource Name (ARN) of the project.
+ * @public + */ + ProjectArn: string | undefined; +} + +/** + * @public + */ +export interface UpdateSpaceRequest { + /** + *The ID of the associated domain.
+ * @public + */ + DomainId: string | undefined; + + /** + *The name of the space.
+ * @public + */ + SpaceName: string | undefined; + + /** + *A collection of space settings.
+ * @public + */ + SpaceSettings?: SpaceSettings | undefined; + + /** + *The name of the space that appears in the Amazon SageMaker Studio UI.
+ * @public + */ + SpaceDisplayName?: string | undefined; +} + +/** + * @public + */ +export interface UpdateSpaceResponse { + /** + *The space's Amazon Resource Name (ARN).
+ * @public + */ + SpaceArn?: string | undefined; +} + +/** + * @public + */ +export interface UpdateTrainingJobRequest { + /** + *The name of a training job to update the Debugger profiling configuration.
+ * @public + */ + TrainingJobName: string | undefined; + + /** + *Configuration information for Amazon SageMaker Debugger system monitoring, framework profiling, and + * storage paths.
+ * @public + */ + ProfilerConfig?: ProfilerConfigForUpdate | undefined; + + /** + *Configuration information for Amazon SageMaker Debugger rules for profiling system and framework + * metrics.
+ * @public + */ + ProfilerRuleConfigurations?: ProfilerRuleConfiguration[] | undefined; + + /** + *The training job ResourceConfig to update warm pool retention
+ * length.
Configuration for remote debugging while the training job is running. You can update
+ * the remote debugging configuration when the SecondaryStatus of the job is
+ * Downloading or Training.To learn more about the remote
+ * debugging functionality of SageMaker, see Access a training container
+ * through Amazon Web Services Systems Manager (SSM) for remote
+ * debugging.
The Amazon Resource Name (ARN) of the training job.
+ * @public + */ + TrainingJobArn: string | undefined; +} + +/** + * @public + */ +export interface UpdateTrialRequest { + /** + *The name of the trial to update.
+ * @public + */ + TrialName: string | undefined; + + /** + *The name of the trial as displayed. The name doesn't need to be unique. If
+ * DisplayName isn't specified, TrialName is displayed.
The Amazon Resource Name (ARN) of the trial.
+ * @public + */ + TrialArn?: string | undefined; +} + +/** + * @public + */ +export interface UpdateTrialComponentRequest { + /** + *The name of the component to update.
+ * @public + */ + TrialComponentName: string | undefined; + + /** + *The name of the component as displayed. The name doesn't need to be unique. If
+ * DisplayName isn't specified, TrialComponentName is
+ * displayed.
The new status of the component.
+ * @public + */ + Status?: TrialComponentStatus | undefined; + + /** + *When the component started.
+ * @public + */ + StartTime?: Date | undefined; + + /** + *When the component ended.
+ * @public + */ + EndTime?: Date | undefined; + + /** + *Replaces all of the component's hyperparameters with the specified hyperparameters or add new hyperparameters. Existing hyperparameters are replaced if the trial component is updated with an identical hyperparameter key.
+ * @public + */ + Parameters?: RecordThe hyperparameters to remove from the component.
+ * @public + */ + ParametersToRemove?: string[] | undefined; + + /** + *Replaces all of the component's input artifacts with the specified artifacts or adds new input artifacts. Existing input artifacts are replaced if the trial component is updated with an identical input artifact key.
+ * @public + */ + InputArtifacts?: RecordThe input artifacts to remove from the component.
+ * @public + */ + InputArtifactsToRemove?: string[] | undefined; -import { Filter, ResourceType, Workforce, Workteam } from "./models_3"; + /** + *Replaces all of the component's output artifacts with the specified artifacts or adds new output artifacts. Existing output artifacts are replaced if the trial component is updated with an identical output artifact key.
+ * @public + */ + OutputArtifacts?: RecordThe output artifacts to remove from the component.
+ * @public + */ + OutputArtifactsToRemove?: string[] | undefined; +} /** * @public @@ -305,6 +2377,22 @@ export interface SearchRequest { VisibilityConditions?: VisibilityConditions[] | undefined; } +/** + * @internal + */ +export const UpdateModelCardRequestFilterSensitiveLog = (obj: UpdateModelCardRequest): any => ({ + ...obj, + ...(obj.Content && { Content: SENSITIVE_STRING }), +}); + +/** + * @internal + */ +export const UpdateModelPackageInputFilterSensitiveLog = (obj: UpdateModelPackageInput): any => ({ + ...obj, + ...(obj.ModelCard && { ModelCard: ModelPackageModelCardFilterSensitiveLog(obj.ModelCard) }), +}); + /** * @internal */ diff --git a/clients/client-sagemaker/src/pagination/ListClusterSchedulerConfigsPaginator.ts b/clients/client-sagemaker/src/pagination/ListClusterSchedulerConfigsPaginator.ts new file mode 100644 index 000000000000..8e2572d6609c --- /dev/null +++ b/clients/client-sagemaker/src/pagination/ListClusterSchedulerConfigsPaginator.ts @@ -0,0 +1,24 @@ +// smithy-typescript generated code +import { createPaginator } from "@smithy/core"; +import { Paginator } from "@smithy/types"; + +import { + ListClusterSchedulerConfigsCommand, + ListClusterSchedulerConfigsCommandInput, + ListClusterSchedulerConfigsCommandOutput, +} from "../commands/ListClusterSchedulerConfigsCommand"; +import { SageMakerClient } from "../SageMakerClient"; +import { SageMakerPaginationConfiguration } from "./Interfaces"; + +/** + * @public + */ +export const paginateListClusterSchedulerConfigs: ( + config: SageMakerPaginationConfiguration, + input: ListClusterSchedulerConfigsCommandInput, + ...rest: any[] +) => PaginatorLists the properties of an action. An action represents an action\n or activity. Some examples are a workflow step and a model deployment. Generally, an\n action involves at least one input artifact or output artifact.
" } }, + "com.amazonaws.sagemaker#ActivationState": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Enabled" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Disabled" + } + } + } + }, "com.amazonaws.sagemaker#AddAssociation": { "type": "operation", "input": { @@ -4637,6 +4654,24 @@ } } }, + "com.amazonaws.sagemaker#AvailabilityZone": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 32 + }, + "smithy.api#pattern": "^[a-z]+\\-[0-9a-z\\-]+$" + } + }, + "com.amazonaws.sagemaker#AvailableInstanceCount": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, "com.amazonaws.sagemaker#AwsManagedHumanLoopRequestSource": { "type": "enum", "members": { @@ -5182,6 +5217,15 @@ } } }, + "com.amazonaws.sagemaker#BorrowLimit": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 500 + } + } + }, "com.amazonaws.sagemaker#Branch": { "type": "string", "traits": { @@ -6890,6 +6934,24 @@ "smithy.api#documentation": "A flag indicating whether deep health checks should be performed when the cluster\n instance group is created or updated.
" } }, + "Status": { + "target": "com.amazonaws.sagemaker#InstanceGroupStatus", + "traits": { + "smithy.api#documentation": "The current status of the cluster instance group.
\n\n InService: The instance group is active and healthy.
\n Creating: The instance group is being provisioned.
\n Updating: The instance group is being updated.
\n Failed: The instance group has failed to provision or is no longer\n healthy.
\n Degraded: The instance group is degraded, meaning that some instances\n have failed to provision or are no longer healthy.
\n Deleting: The instance group is being deleted.
The Amazon Resource Name (ARN); of the training plan associated with this cluster instance group.
\nFor more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using\n Amazon SageMaker Training Plan, see \n CreateTrainingPlan\n .
The current status of the training plan associated with this cluster instance\n group.
" + } + }, "OverrideVpcConfig": { "target": "com.amazonaws.sagemaker#VpcConfig" } @@ -6975,6 +7037,12 @@ "smithy.api#documentation": "A flag indicating whether deep health checks should be performed when the cluster\n instance group is created or updated.
" } }, + "TrainingPlanArn": { + "target": "com.amazonaws.sagemaker#TrainingPlanArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN); of the training plan to use for this cluster instance group.
\nFor more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using\n Amazon SageMaker Training Plan, see \n CreateTrainingPlan\n .
ARN of the cluster policy.
", + "smithy.api#required": {} + } + }, + "ClusterSchedulerConfigId": { + "target": "com.amazonaws.sagemaker#ClusterSchedulerConfigId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "ID of the cluster policy.
", + "smithy.api#required": {} + } + }, + "ClusterSchedulerConfigVersion": { + "target": "com.amazonaws.sagemaker#Integer", + "traits": { + "smithy.api#documentation": "Version of the cluster policy.
" + } + }, + "Name": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Name of the cluster policy.
", + "smithy.api#required": {} + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Creation time of the cluster policy.
", + "smithy.api#required": {} + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "Last modified time of the cluster policy.
" + } + }, + "Status": { + "target": "com.amazonaws.sagemaker#SchedulerResourceStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Status of the cluster policy.
", + "smithy.api#required": {} + } + }, + "ClusterArn": { + "target": "com.amazonaws.sagemaker#ClusterArn", + "traits": { + "smithy.api#documentation": "ARN of the cluster.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Summary of the cluster policy.
" + } + }, + "com.amazonaws.sagemaker#ClusterSchedulerConfigSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ClusterSchedulerConfigSummary" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.sagemaker#ClusterSchedulerPriorityClassName": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9]){0,39}?$" + } + }, "com.amazonaws.sagemaker#ClusterSortBy": { "type": "enum", "members": { @@ -7831,6 +8015,12 @@ "smithy.api#documentation": "The status of the SageMaker HyperPod cluster.
", "smithy.api#required": {} } + }, + "TrainingPlanArns": { + "target": "com.amazonaws.sagemaker#TrainingPlanArns", + "traits": { + "smithy.api#documentation": "A list of Amazon Resource Names (ARNs) of the training plans associated with this\n cluster.
\nFor more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using\n Amazon SageMaker Training Plan, see \n CreateTrainingPlan\n .
Allocate compute resources by instance types.
" + } + }, + "ResourceSharingConfig": { + "target": "com.amazonaws.sagemaker#ResourceSharingConfig", + "traits": { + "smithy.api#documentation": "Resource sharing configuration. This defines how an entity can lend and borrow idle\n compute with other entities within the cluster.
" + } + }, + "PreemptTeamTasks": { + "target": "com.amazonaws.sagemaker#PreemptTeamTasks", + "traits": { + "smithy.api#documentation": "Allows workloads from within an entity to preempt same-team workloads. When set to\n LowerPriority, the entity's lower priority tasks are preempted by their own\n higher priority tasks.
Default is LowerPriority.
Configuration of the compute allocation definition for an entity. This includes the\n resource sharing option and the setting to preempt low priority tasks.
" + } + }, + "com.amazonaws.sagemaker#ComputeQuotaId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-z0-9]{12}$" + } + }, + "com.amazonaws.sagemaker#ComputeQuotaResourceConfig": { + "type": "structure", + "members": { + "InstanceType": { + "target": "com.amazonaws.sagemaker#ClusterInstanceType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The instance type of the instance group for the cluster.
", + "smithy.api#required": {} + } + }, + "Count": { + "target": "com.amazonaws.sagemaker#InstanceCount", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The number of instances to add to the instance group of a SageMaker HyperPod\n cluster.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration of the resources used for the compute allocation definition.
" + } + }, + "com.amazonaws.sagemaker#ComputeQuotaResourceConfigList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ComputeQuotaResourceConfig" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 15 + } + } + }, + "com.amazonaws.sagemaker#ComputeQuotaSummary": { + "type": "structure", + "members": { + "ComputeQuotaArn": { + "target": "com.amazonaws.sagemaker#ComputeQuotaArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "ARN of the compute allocation definition.
", + "smithy.api#required": {} + } + }, + "ComputeQuotaId": { + "target": "com.amazonaws.sagemaker#ComputeQuotaId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "ID of the compute allocation definition.
", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Name of the compute allocation definition.
", + "smithy.api#required": {} + } + }, + "ComputeQuotaVersion": { + "target": "com.amazonaws.sagemaker#Integer", + "traits": { + "smithy.api#documentation": "Version of the compute allocation definition.
" + } + }, + "Status": { + "target": "com.amazonaws.sagemaker#SchedulerResourceStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Status of the compute allocation definition.
", + "smithy.api#required": {} + } + }, + "ClusterArn": { + "target": "com.amazonaws.sagemaker#ClusterArn", + "traits": { + "smithy.api#documentation": "ARN of the cluster.
" + } + }, + "ComputeQuotaConfig": { + "target": "com.amazonaws.sagemaker#ComputeQuotaConfig", + "traits": { + "smithy.api#documentation": "Configuration of the compute allocation definition. This includes the resource sharing\n option, and the setting to preempt low priority tasks.
" + } + }, + "ComputeQuotaTarget": { + "target": "com.amazonaws.sagemaker#ComputeQuotaTarget", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The target entity to allocate compute resources to.
", + "smithy.api#required": {} + } + }, + "ActivationState": { + "target": "com.amazonaws.sagemaker#ActivationState", + "traits": { + "smithy.api#documentation": "The state of the compute allocation being described. Use to enable or disable compute\n allocation.
\nDefault is Enabled.
Creation time of the compute allocation definition.
", + "smithy.api#required": {} + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "Last modified time of the compute allocation definition.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Summary of the compute allocation definition.
" + } + }, + "com.amazonaws.sagemaker#ComputeQuotaSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ComputeQuotaSummary" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.sagemaker#ComputeQuotaTarget": { + "type": "structure", + "members": { + "TeamName": { + "target": "com.amazonaws.sagemaker#ComputeQuotaTargetTeamName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Name of the team to allocate compute resources to.
", + "smithy.api#required": {} + } + }, + "FairShareWeight": { + "target": "com.amazonaws.sagemaker#FairShareWeight", + "traits": { + "smithy.api#documentation": "Assigned entity fair-share weight. Idle compute will be shared across entities based on\n these assigned weights. This weight is only used when FairShare is\n enabled.
A weight of 0 is the lowest priority and 100 is the highest. Weight 0 is the\n default.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The target entity to allocate compute resources to.
" + } + }, + "com.amazonaws.sagemaker#ComputeQuotaTargetTeamName": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9]){0,39}?$" + } + }, "com.amazonaws.sagemaker#ConditionOutcome": { "type": "enum", "members": { @@ -9662,6 +10056,94 @@ "smithy.api#output": {} } }, + "com.amazonaws.sagemaker#CreateClusterSchedulerConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateClusterSchedulerConfigRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateClusterSchedulerConfigResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ConflictException" + }, + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "Create cluster policy configuration. This policy is used for task prioritization and\n fair-share allocation of idle compute. This helps prioritize critical workloads and distributes\n idle compute across entities.
" + } + }, + "com.amazonaws.sagemaker#CreateClusterSchedulerConfigRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Name for the cluster policy.
", + "smithy.api#required": {} + } + }, + "ClusterArn": { + "target": "com.amazonaws.sagemaker#ClusterArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "ARN of the cluster.
", + "smithy.api#required": {} + } + }, + "SchedulerConfig": { + "target": "com.amazonaws.sagemaker#SchedulerConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Configuration about the monitoring schedule.
", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.sagemaker#EntityDescription", + "traits": { + "smithy.api#documentation": "Description of the cluster policy.
" + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "Tags of the cluster policy.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateClusterSchedulerConfigResponse": { + "type": "structure", + "members": { + "ClusterSchedulerConfigArn": { + "target": "com.amazonaws.sagemaker#ClusterSchedulerConfigArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "ARN of the cluster policy.
", + "smithy.api#required": {} + } + }, + "ClusterSchedulerConfigId": { + "target": "com.amazonaws.sagemaker#ClusterSchedulerConfigId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "ID of the cluster policy.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.sagemaker#CreateCodeRepository": { "type": "operation", "input": { @@ -9820,6 +10302,108 @@ "smithy.api#output": {} } }, + "com.amazonaws.sagemaker#CreateComputeQuota": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateComputeQuotaRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateComputeQuotaResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ConflictException" + }, + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "Create compute allocation definition. This defines how compute is allocated, shared, and\n borrowed for specified entities. Specifically, how to lend and borrow idle compute and\n assign a fair-share weight to the specified entities.
" + } + }, + "com.amazonaws.sagemaker#CreateComputeQuotaRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Name to the compute allocation definition.
", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.sagemaker#EntityDescription", + "traits": { + "smithy.api#documentation": "Description of the compute allocation definition.
" + } + }, + "ClusterArn": { + "target": "com.amazonaws.sagemaker#ClusterArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "ARN of the cluster.
", + "smithy.api#required": {} + } + }, + "ComputeQuotaConfig": { + "target": "com.amazonaws.sagemaker#ComputeQuotaConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Configuration of the compute allocation definition. This includes the resource sharing\n option, and the setting to preempt low priority tasks.
", + "smithy.api#required": {} + } + }, + "ComputeQuotaTarget": { + "target": "com.amazonaws.sagemaker#ComputeQuotaTarget", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The target entity to allocate compute resources to.
", + "smithy.api#required": {} + } + }, + "ActivationState": { + "target": "com.amazonaws.sagemaker#ActivationState", + "traits": { + "smithy.api#documentation": "The state of the compute allocation being described. Use to enable or disable compute\n allocation.
\nDefault is Enabled.
Tags of the compute allocation definition.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateComputeQuotaResponse": { + "type": "structure", + "members": { + "ComputeQuotaArn": { + "target": "com.amazonaws.sagemaker#ComputeQuotaArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "ARN of the compute allocation definition.
", + "smithy.api#required": {} + } + }, + "ComputeQuotaId": { + "target": "com.amazonaws.sagemaker#ComputeQuotaId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "ID of the compute allocation definition.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.sagemaker#CreateContext": { "type": "operation", "input": { @@ -13100,6 +13684,178 @@ "smithy.api#output": {} } }, + "com.amazonaws.sagemaker#CreatePartnerApp": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreatePartnerAppRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreatePartnerAppResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ConflictException" + }, + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "Creates an Amazon SageMaker Partner AI App.
" + } + }, + "com.amazonaws.sagemaker#CreatePartnerAppPresignedUrl": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreatePartnerAppPresignedUrlRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreatePartnerAppPresignedUrlResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Creates a presigned URL to access an Amazon SageMaker Partner AI App.
" + } + }, + "com.amazonaws.sagemaker#CreatePartnerAppPresignedUrlRequest": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.sagemaker#PartnerAppArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The ARN of the SageMaker Partner AI App to create the presigned URL for.
", + "smithy.api#required": {} + } + }, + "ExpiresInSeconds": { + "target": "com.amazonaws.sagemaker#ExpiresInSeconds", + "traits": { + "smithy.api#documentation": "The time that will pass before the presigned URL expires.
" + } + }, + "SessionExpirationDurationInSeconds": { + "target": "com.amazonaws.sagemaker#SessionExpirationDurationInSeconds", + "traits": { + "smithy.api#documentation": "Indicates how long the Amazon SageMaker Partner AI App session can be accessed for after logging in.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreatePartnerAppPresignedUrlResponse": { + "type": "structure", + "members": { + "Url": { + "target": "com.amazonaws.sagemaker#String2048", + "traits": { + "smithy.api#documentation": "The presigned URL that you can use to access the SageMaker Partner AI App.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreatePartnerAppRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.sagemaker#PartnerAppName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name to give the SageMaker Partner AI App.
", + "smithy.api#required": {} + } + }, + "Type": { + "target": "com.amazonaws.sagemaker#PartnerAppType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The type of SageMaker Partner AI App to create. Must be one of the following: lakera-guard, comet, deepchecks-llm-evaluation, or fiddler.
The ARN of the IAM role that the partner application uses.
", + "smithy.api#required": {} + } + }, + "MaintenanceConfig": { + "target": "com.amazonaws.sagemaker#PartnerAppMaintenanceConfig", + "traits": { + "smithy.api#documentation": "Maintenance configuration settings for the SageMaker Partner AI App.
" + } + }, + "Tier": { + "target": "com.amazonaws.sagemaker#NonEmptyString64", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Indicates the instance type and size of the cluster attached to the SageMaker Partner AI App.
", + "smithy.api#required": {} + } + }, + "ApplicationConfig": { + "target": "com.amazonaws.sagemaker#PartnerAppConfig", + "traits": { + "smithy.api#documentation": "Configuration settings for the SageMaker Partner AI App.
" + } + }, + "AuthType": { + "target": "com.amazonaws.sagemaker#PartnerAppAuthType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The authorization type that users use to access the SageMaker Partner AI App.
", + "smithy.api#required": {} + } + }, + "EnableIamSessionBasedIdentity": { + "target": "com.amazonaws.sagemaker#Boolean", + "traits": { + "smithy.api#documentation": "When set to TRUE, the SageMaker Partner AI App sets the Amazon Web Services IAM session name or the authenticated IAM user as the identity of the SageMaker Partner AI App user.
A unique token that guarantees that the call to this API is idempotent.
", + "smithy.api#idempotencyToken": {} + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "Each tag consists of a key and an optional value. Tag keys must be unique per\n resource.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreatePartnerAppResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.sagemaker#PartnerAppArn", + "traits": { + "smithy.api#documentation": "The ARN of the SageMaker Partner AI App.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.sagemaker#CreatePipeline": { "type": "operation", "input": { @@ -13941,6 +14697,75 @@ "smithy.api#output": {} } }, + "com.amazonaws.sagemaker#CreateTrainingPlan": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateTrainingPlanRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateTrainingPlanResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceInUse" + }, + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Creates a new training plan in SageMaker to reserve compute capacity.
\nAmazon SageMaker Training Plan is a capability within SageMaker that allows customers to reserve and manage GPU\n capacity for large-scale AI model training. It provides a way to secure predictable access\n to computational resources within specific timelines and budgets, without the need to\n manage underlying infrastructure.
\n\n How it works\n
\nPlans can be created for specific resources such as SageMaker Training Jobs or SageMaker HyperPod\n clusters, automatically provisioning resources, setting up infrastructure, executing\n workloads, and handling infrastructure failures.
\n\n Plan creation workflow\n
\nUsers search for available plan offerings based on their requirements (e.g.,\n instance type, count, start time, duration) using the \n SearchTrainingPlanOfferings\n API operation.
They create a plan that best matches their needs using the ID of the plan offering\n they want to use.
\nAfter successful upfront payment, the plan's status becomes\n Scheduled.
The plan can be used to:
\nQueue training jobs.
\nAllocate to an instance group of a SageMaker HyperPod cluster.
\nWhen the plan start date arrives, it becomes Active. Based on\n available reserved capacity:
Training jobs are launched.
\nInstance groups are provisioned.
\n\n Plan composition\n
\nA plan can consist of one or more Reserved Capacities, each defined by a specific\n instance type, quantity, Availability Zone, duration, and start and end times. For more\n information about Reserved Capacity, see \n ReservedCapacitySummary\n .
The name of the training plan to create.
", + "smithy.api#required": {} + } + }, + "TrainingPlanOfferingId": { + "target": "com.amazonaws.sagemaker#TrainingPlanOfferingId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The unique identifier of the training plan offering to use for creating this\n plan.
", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "An array of key-value pairs to apply to this training plan.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateTrainingPlanResponse": { + "type": "structure", + "members": { + "TrainingPlanArn": { + "target": "com.amazonaws.sagemaker#TrainingPlanArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN); of the created training plan.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.sagemaker#CreateTransformJob": { "type": "operation", "input": { @@ -14535,6 +15360,9 @@ } } }, + "com.amazonaws.sagemaker#CurrencyCode": { + "type": "string" + }, "com.amazonaws.sagemaker#CustomFileSystem": { "type": "union", "members": { @@ -14543,6 +15371,12 @@ "traits": { "smithy.api#documentation": "A custom file system in Amazon EFS.
" } + }, + "FSxLustreFileSystem": { + "target": "com.amazonaws.sagemaker#FSxLustreFileSystem", + "traits": { + "smithy.api#documentation": "A custom file system in Amazon FSx for Lustre.
" + } } }, "traits": { @@ -14557,6 +15391,12 @@ "traits": { "smithy.api#documentation": "The settings for a custom Amazon EFS file system.
" } + }, + "FSxLustreFileSystemConfig": { + "target": "com.amazonaws.sagemaker#FSxLustreFileSystemConfig", + "traits": { + "smithy.api#documentation": "The settings for a custom Amazon FSx for Lustre file system.
" + } } }, "traits": { @@ -15717,6 +16557,39 @@ "smithy.api#output": {} } }, + "com.amazonaws.sagemaker#DeleteClusterSchedulerConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeleteClusterSchedulerConfigRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Deletes the cluster policy of the cluster.
" + } + }, + "com.amazonaws.sagemaker#DeleteClusterSchedulerConfigRequest": { + "type": "structure", + "members": { + "ClusterSchedulerConfigId": { + "target": "com.amazonaws.sagemaker#ClusterSchedulerConfigId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "ID of the cluster policy.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, "com.amazonaws.sagemaker#DeleteCodeRepository": { "type": "operation", "input": { @@ -15778,6 +16651,39 @@ "smithy.api#input": {} } }, + "com.amazonaws.sagemaker#DeleteComputeQuota": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeleteComputeQuotaRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Deletes the compute allocation from the cluster.
" + } + }, + "com.amazonaws.sagemaker#DeleteComputeQuotaRequest": { + "type": "structure", + "members": { + "ComputeQuotaId": { + "target": "com.amazonaws.sagemaker#ComputeQuotaId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "ID of the compute allocation definition.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, "com.amazonaws.sagemaker#DeleteContext": { "type": "operation", "input": { @@ -17003,6 +17909,63 @@ "smithy.api#input": {} } }, + "com.amazonaws.sagemaker#DeletePartnerApp": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeletePartnerAppRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DeletePartnerAppResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ConflictException" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a SageMaker Partner AI App.
" + } + }, + "com.amazonaws.sagemaker#DeletePartnerAppRequest": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.sagemaker#PartnerAppArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The ARN of the SageMaker Partner AI App to delete.
", + "smithy.api#required": {} + } + }, + "ClientToken": { + "target": "com.amazonaws.sagemaker#ClientToken", + "traits": { + "smithy.api#documentation": "A unique token that guarantees that the call to this API is idempotent.
", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeletePartnerAppResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.sagemaker#PartnerAppArn", + "traits": { + "smithy.api#documentation": "The ARN of the SageMaker Partner AI App that was deleted.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.sagemaker#DeletePipeline": { "type": "operation", "input": { @@ -18766,6 +19729,137 @@ "smithy.api#output": {} } }, + "com.amazonaws.sagemaker#DescribeClusterSchedulerConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeClusterSchedulerConfigRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeClusterSchedulerConfigResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Description of the cluster policy. This policy is used for task prioritization and\n fair-share allocation. This helps prioritize critical workloads and distributes\n idle compute across entities.
" + } + }, + "com.amazonaws.sagemaker#DescribeClusterSchedulerConfigRequest": { + "type": "structure", + "members": { + "ClusterSchedulerConfigId": { + "target": "com.amazonaws.sagemaker#ClusterSchedulerConfigId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "ID of the cluster policy.
", + "smithy.api#required": {} + } + }, + "ClusterSchedulerConfigVersion": { + "target": "com.amazonaws.sagemaker#Integer", + "traits": { + "smithy.api#documentation": "Version of the cluster policy.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeClusterSchedulerConfigResponse": { + "type": "structure", + "members": { + "ClusterSchedulerConfigArn": { + "target": "com.amazonaws.sagemaker#ClusterSchedulerConfigArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "ARN of the cluster policy.
", + "smithy.api#required": {} + } + }, + "ClusterSchedulerConfigId": { + "target": "com.amazonaws.sagemaker#ClusterSchedulerConfigId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "ID of the cluster policy.
", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Name of the cluster policy.
", + "smithy.api#required": {} + } + }, + "ClusterSchedulerConfigVersion": { + "target": "com.amazonaws.sagemaker#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Version of the cluster policy.
", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.sagemaker#SchedulerResourceStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Status of the cluster policy.
", + "smithy.api#required": {} + } + }, + "FailureReason": { + "target": "com.amazonaws.sagemaker#FailureReason", + "traits": { + "smithy.api#documentation": "Failure reason of the cluster policy.
" + } + }, + "ClusterArn": { + "target": "com.amazonaws.sagemaker#ClusterArn", + "traits": { + "smithy.api#documentation": "ARN of the cluster where the cluster policy is applied.
" + } + }, + "SchedulerConfig": { + "target": "com.amazonaws.sagemaker#SchedulerConfig", + "traits": { + "smithy.api#documentation": "Cluster policy configuration. This policy is used for task prioritization and fair-share\n allocation. This helps prioritize critical workloads and distributes idle compute\n across entities.
" + } + }, + "Description": { + "target": "com.amazonaws.sagemaker#EntityDescription", + "traits": { + "smithy.api#documentation": "Description of the cluster policy.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Creation time of the cluster policy.
", + "smithy.api#required": {} + } + }, + "CreatedBy": { + "target": "com.amazonaws.sagemaker#UserContext" + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "Last modified time of the cluster policy.
" + } + }, + "LastModifiedBy": { + "target": "com.amazonaws.sagemaker#UserContext" + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.sagemaker#DescribeCodeRepository": { "type": "operation", "input": { @@ -19011,6 +20105,151 @@ "smithy.api#output": {} } }, + "com.amazonaws.sagemaker#DescribeComputeQuota": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeComputeQuotaRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeComputeQuotaResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Description of the compute allocation definition.
" + } + }, + "com.amazonaws.sagemaker#DescribeComputeQuotaRequest": { + "type": "structure", + "members": { + "ComputeQuotaId": { + "target": "com.amazonaws.sagemaker#ComputeQuotaId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "ID of the compute allocation definition.
", + "smithy.api#required": {} + } + }, + "ComputeQuotaVersion": { + "target": "com.amazonaws.sagemaker#Integer", + "traits": { + "smithy.api#documentation": "Version of the compute allocation definition.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeComputeQuotaResponse": { + "type": "structure", + "members": { + "ComputeQuotaArn": { + "target": "com.amazonaws.sagemaker#ComputeQuotaArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "ARN of the compute allocation definition.
", + "smithy.api#required": {} + } + }, + "ComputeQuotaId": { + "target": "com.amazonaws.sagemaker#ComputeQuotaId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "ID of the compute allocation definition.
", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Name of the compute allocation definition.
", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.sagemaker#EntityDescription", + "traits": { + "smithy.api#documentation": "Description of the compute allocation definition.
" + } + }, + "ComputeQuotaVersion": { + "target": "com.amazonaws.sagemaker#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Version of the compute allocation definition.
", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.sagemaker#SchedulerResourceStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Status of the compute allocation definition.
", + "smithy.api#required": {} + } + }, + "FailureReason": { + "target": "com.amazonaws.sagemaker#FailureReason", + "traits": { + "smithy.api#documentation": "Failure reason of the compute allocation definition.
" + } + }, + "ClusterArn": { + "target": "com.amazonaws.sagemaker#ClusterArn", + "traits": { + "smithy.api#documentation": "ARN of the cluster.
" + } + }, + "ComputeQuotaConfig": { + "target": "com.amazonaws.sagemaker#ComputeQuotaConfig", + "traits": { + "smithy.api#documentation": "Configuration of the compute allocation definition. This includes the resource sharing\n option, and the setting to preempt low priority tasks.
" + } + }, + "ComputeQuotaTarget": { + "target": "com.amazonaws.sagemaker#ComputeQuotaTarget", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The target entity to allocate compute resources to.
", + "smithy.api#required": {} + } + }, + "ActivationState": { + "target": "com.amazonaws.sagemaker#ActivationState", + "traits": { + "smithy.api#documentation": "The state of the compute allocation being described. Use to enable or disable compute\n allocation.
\nDefault is Enabled.
Creation time of the compute allocation configuration.
", + "smithy.api#required": {} + } + }, + "CreatedBy": { + "target": "com.amazonaws.sagemaker#UserContext" + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "Last modified time of the compute allocation configuration.
" + } + }, + "LastModifiedBy": { + "target": "com.amazonaws.sagemaker#UserContext" + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.sagemaker#DescribeContext": { "type": "operation", "input": { @@ -23990,6 +25229,131 @@ "smithy.api#output": {} } }, + "com.amazonaws.sagemaker#DescribePartnerApp": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribePartnerAppRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribePartnerAppResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Gets information about a SageMaker Partner AI App.
" + } + }, + "com.amazonaws.sagemaker#DescribePartnerAppRequest": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.sagemaker#PartnerAppArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The ARN of the SageMaker Partner AI App to describe.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribePartnerAppResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.sagemaker#PartnerAppArn", + "traits": { + "smithy.api#documentation": "The ARN of the SageMaker Partner AI App that was described.
" + } + }, + "Name": { + "target": "com.amazonaws.sagemaker#PartnerAppName", + "traits": { + "smithy.api#documentation": "The name of the SageMaker Partner AI App.
" + } + }, + "Type": { + "target": "com.amazonaws.sagemaker#PartnerAppType", + "traits": { + "smithy.api#documentation": "The type of SageMaker Partner AI App. Must be one of the following: lakera-guard, comet, deepchecks-llm-evaluation, or fiddler.
The status of the SageMaker Partner AI App.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The time that the SageMaker Partner AI App was created.
" + } + }, + "ExecutionRoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#documentation": "The ARN of the IAM role associated with the SageMaker Partner AI App.
" + } + }, + "BaseUrl": { + "target": "com.amazonaws.sagemaker#String2048", + "traits": { + "smithy.api#documentation": "The URL of the SageMaker Partner AI App that the Application SDK uses to support in-app calls for the user.
" + } + }, + "MaintenanceConfig": { + "target": "com.amazonaws.sagemaker#PartnerAppMaintenanceConfig", + "traits": { + "smithy.api#documentation": "Maintenance configuration settings for the SageMaker Partner AI App.
" + } + }, + "Tier": { + "target": "com.amazonaws.sagemaker#NonEmptyString64", + "traits": { + "smithy.api#documentation": "The instance type and size of the cluster attached to the SageMaker Partner AI App.
" + } + }, + "Version": { + "target": "com.amazonaws.sagemaker#NonEmptyString64", + "traits": { + "smithy.api#documentation": "The version of the SageMaker Partner AI App.
" + } + }, + "ApplicationConfig": { + "target": "com.amazonaws.sagemaker#PartnerAppConfig", + "traits": { + "smithy.api#documentation": "Configuration settings for the SageMaker Partner AI App.
" + } + }, + "AuthType": { + "target": "com.amazonaws.sagemaker#PartnerAppAuthType", + "traits": { + "smithy.api#documentation": "The authorization type that users use to access the SageMaker Partner AI App.
" + } + }, + "EnableIamSessionBasedIdentity": { + "target": "com.amazonaws.sagemaker#Boolean", + "traits": { + "smithy.api#documentation": "When set to TRUE, the SageMaker Partner AI App sets the Amazon Web Services IAM session name or the authenticated IAM user as the identity of the SageMaker Partner AI App user.
This is an error field object that contains the error code and the reason for an operation failure.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.sagemaker#DescribePipeline": { "type": "operation", "input": { @@ -25191,6 +26555,143 @@ "smithy.api#output": {} } }, + "com.amazonaws.sagemaker#DescribeTrainingPlan": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeTrainingPlanRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeTrainingPlanResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves detailed information about a specific training plan.
" + } + }, + "com.amazonaws.sagemaker#DescribeTrainingPlanRequest": { + "type": "structure", + "members": { + "TrainingPlanName": { + "target": "com.amazonaws.sagemaker#TrainingPlanName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the training plan to describe.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeTrainingPlanResponse": { + "type": "structure", + "members": { + "TrainingPlanArn": { + "target": "com.amazonaws.sagemaker#TrainingPlanArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN); of the training plan.
", + "smithy.api#required": {} + } + }, + "TrainingPlanName": { + "target": "com.amazonaws.sagemaker#TrainingPlanName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the training plan.
", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.sagemaker#TrainingPlanStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The current status of the training plan (e.g., Pending, Active, Expired). To see the\n complete list of status values available for a training plan, refer to the\n Status attribute within the \n TrainingPlanSummary\n object.
A message providing additional information about the current status of the training\n plan.
" + } + }, + "DurationHours": { + "target": "com.amazonaws.sagemaker#TrainingPlanDurationHours", + "traits": { + "smithy.api#documentation": "The number of whole hours in the total duration for this training plan.
" + } + }, + "DurationMinutes": { + "target": "com.amazonaws.sagemaker#TrainingPlanDurationMinutes", + "traits": { + "smithy.api#documentation": "The additional minutes beyond whole hours in the total duration for this training\n plan.
" + } + }, + "StartTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The start time of the training plan.
" + } + }, + "EndTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The end time of the training plan.
" + } + }, + "UpfrontFee": { + "target": "com.amazonaws.sagemaker#String256", + "traits": { + "smithy.api#documentation": "The upfront fee for the training plan.
" + } + }, + "CurrencyCode": { + "target": "com.amazonaws.sagemaker#CurrencyCode", + "traits": { + "smithy.api#documentation": "The currency code for the upfront fee (e.g., USD).
" + } + }, + "TotalInstanceCount": { + "target": "com.amazonaws.sagemaker#TotalInstanceCount", + "traits": { + "smithy.api#documentation": "The total number of instances reserved in this training plan.
" + } + }, + "AvailableInstanceCount": { + "target": "com.amazonaws.sagemaker#AvailableInstanceCount", + "traits": { + "smithy.api#documentation": "The number of instances currently available for use in this training plan.
" + } + }, + "InUseInstanceCount": { + "target": "com.amazonaws.sagemaker#InUseInstanceCount", + "traits": { + "smithy.api#documentation": "The number of instances currently in use from this training plan.
" + } + }, + "TargetResources": { + "target": "com.amazonaws.sagemaker#SageMakerResourceNames", + "traits": { + "smithy.api#documentation": "The target resources (e.g., SageMaker Training Jobs, SageMaker HyperPod) that can use this training\n plan.
\nTraining plans are specific to their target resource.
\nA training plan designed for SageMaker training jobs can only be used to schedule and\n run training jobs.
\nA training plan for HyperPod clusters can be used exclusively to provide\n compute resources to a cluster's instance group.
\nThe list of Reserved Capacity providing the underlying compute resources of the plan.\n
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.sagemaker#DescribeTransformJob": { "type": "operation", "input": { @@ -28527,6 +30028,26 @@ "smithy.api#pattern": "^[\\S\\s]*$" } }, + "com.amazonaws.sagemaker#ErrorInfo": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.sagemaker#NonEmptyString64", + "traits": { + "smithy.api#documentation": "The error code for an invalid or failed operation.
" + } + }, + "Reason": { + "target": "com.amazonaws.sagemaker#NonEmptyString256", + "traits": { + "smithy.api#documentation": "The failure reason for the operation.
" + } + } + }, + "traits": { + "smithy.api#documentation": "This is an error field object that contains the error code and the reason for an operation failure.
" + } + }, "com.amazonaws.sagemaker#ExcludeFeaturesAttribute": { "type": "string", "traits": { @@ -28880,6 +30401,44 @@ "smithy.api#documentation": "A parameter to activate explainers.
" } }, + "com.amazonaws.sagemaker#FSxLustreFileSystem": { + "type": "structure", + "members": { + "FileSystemId": { + "target": "com.amazonaws.sagemaker#FileSystemId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Amazon FSx for Lustre file system ID.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A custom file system in Amazon FSx for Lustre.
" + } + }, + "com.amazonaws.sagemaker#FSxLustreFileSystemConfig": { + "type": "structure", + "members": { + "FileSystemId": { + "target": "com.amazonaws.sagemaker#FileSystemId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The globally unique, 17-digit, ID of the file system, assigned by Amazon FSx for Lustre.
", + "smithy.api#required": {} + } + }, + "FileSystemPath": { + "target": "com.amazonaws.sagemaker#FileSystemPath", + "traits": { + "smithy.api#documentation": "The path to the file system directory that is accessible in Amazon SageMaker Studio. Permitted\n users can access only this directory and below.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The settings for assigning a custom Amazon FSx for Lustre file system to a user profile or space for an\n Amazon SageMaker Domain.
" + } + }, "com.amazonaws.sagemaker#FailStepMetadata": { "type": "structure", "members": { @@ -28920,6 +30479,32 @@ } } }, + "com.amazonaws.sagemaker#FairShare": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Enabled" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Disabled" + } + } + } + }, + "com.amazonaws.sagemaker#FairShareWeight": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 100 + } + } + }, "com.amazonaws.sagemaker#FeatureAdditions": { "type": "list", "member": { @@ -33381,6 +34966,14 @@ "smithy.api#output": {} } }, + "com.amazonaws.sagemaker#InUseInstanceCount": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, "com.amazonaws.sagemaker#InferenceComponentArn": { "type": "string", "traits": { @@ -34475,6 +36068,14 @@ } } }, + "com.amazonaws.sagemaker#InstanceCount": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, "com.amazonaws.sagemaker#InstanceGroup": { "type": "structure", "members": { @@ -34529,6 +36130,62 @@ } } }, + "com.amazonaws.sagemaker#InstanceGroupStatus": { + "type": "enum", + "members": { + "INSERVICE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InService" + } + }, + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Creating" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Updating" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "DEGRADED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Degraded" + } + }, + "SYSTEMUPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SystemUpdating" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Deleting" + } + } + } + }, + "com.amazonaws.sagemaker#InstanceGroupTrainingPlanStatus": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + } + } + }, "com.amazonaws.sagemaker#InstanceGroups": { "type": "list", "member": { @@ -37766,6 +39423,106 @@ "smithy.api#output": {} } }, + "com.amazonaws.sagemaker#ListClusterSchedulerConfigs": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListClusterSchedulerConfigsRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListClusterSchedulerConfigsResponse" + }, + "traits": { + "smithy.api#documentation": "List the cluster policy configurations.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ClusterSchedulerConfigSummaries", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListClusterSchedulerConfigsRequest": { + "type": "structure", + "members": { + "CreatedAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "Filter for after this creation time. The input for this parameter is a Unix timestamp.\n To convert a date and time into a Unix timestamp, see EpochConverter.
" + } + }, + "CreatedBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "Filter for before this creation time. The input for this parameter is a Unix timestamp.\n To convert a date and time into a Unix timestamp, see EpochConverter.
" + } + }, + "NameContains": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#documentation": "Filter for name containing this string.
" + } + }, + "ClusterArn": { + "target": "com.amazonaws.sagemaker#ClusterArn", + "traits": { + "smithy.api#documentation": "Filter for ARN of the cluster.
" + } + }, + "Status": { + "target": "com.amazonaws.sagemaker#SchedulerResourceStatus", + "traits": { + "smithy.api#documentation": "Filter for status.
" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#SortClusterSchedulerConfigBy", + "traits": { + "smithy.api#documentation": "Filter for sorting the list by a given value. For example, sort by name, creation time,\n or status.
" + } + }, + "SortOrder": { + "target": "com.amazonaws.sagemaker#SortOrder", + "traits": { + "smithy.api#documentation": "The order of the list. By default, listed in Descending order according to\n by SortBy. To change the list order, you can specify SortOrder to\n be Ascending.
If the previous response was truncated, you will receive this token. Use it in your next\n request to receive the next set of results.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of cluster policies to list.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListClusterSchedulerConfigsResponse": { + "type": "structure", + "members": { + "ClusterSchedulerConfigSummaries": { + "target": "com.amazonaws.sagemaker#ClusterSchedulerConfigSummaryList", + "traits": { + "smithy.api#documentation": "Summaries of the cluster policies.
" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "If the previous response was truncated, you will receive this token. Use it in your next\n request to receive the next set of results.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.sagemaker#ListClusters": { "type": "operation", "input": { @@ -37822,6 +39579,12 @@ "traits": { "smithy.api#documentation": "The sort order for results. The default value is Ascending.
The Amazon Resource Name (ARN); of the training plan to filter clusters by. For more information about\n reserving GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see \n CreateTrainingPlan\n .
List the resource allocation definitions.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ComputeQuotaSummaries", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListComputeQuotasRequest": { + "type": "structure", + "members": { + "CreatedAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "Filter for after this creation time. The input for this parameter is a Unix timestamp.\n To convert a date and time into a Unix timestamp, see EpochConverter.
" + } + }, + "CreatedBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "Filter for before this creation time. The input for this parameter is a Unix timestamp.\n To convert a date and time into a Unix timestamp, see EpochConverter.
" + } + }, + "NameContains": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#documentation": "Filter for name containing this string.
" + } + }, + "Status": { + "target": "com.amazonaws.sagemaker#SchedulerResourceStatus", + "traits": { + "smithy.api#documentation": "Filter for status.
" + } + }, + "ClusterArn": { + "target": "com.amazonaws.sagemaker#ClusterArn", + "traits": { + "smithy.api#documentation": "Filter for ARN of the cluster.
" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#SortQuotaBy", + "traits": { + "smithy.api#documentation": "Filter for sorting the list by a given value. For example, sort by name, creation time,\n or status.
" + } + }, + "SortOrder": { + "target": "com.amazonaws.sagemaker#SortOrder", + "traits": { + "smithy.api#documentation": "The order of the list. By default, listed in Descending order according to\n by SortBy. To change the list order, you can specify SortOrder to\n be Ascending.
If the previous response was truncated, you will receive this token. Use it in your next\n request to receive the next set of results.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of compute allocation definitions to list.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListComputeQuotasResponse": { + "type": "structure", + "members": { + "ComputeQuotaSummaries": { + "target": "com.amazonaws.sagemaker#ComputeQuotaSummaryList", + "traits": { + "smithy.api#documentation": "Summaries of the compute allocation definitions.
" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "If the previous response was truncated, you will receive this token. Use it in your next\n request to receive the next set of results.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.sagemaker#ListContexts": { "type": "operation", "input": { @@ -42632,6 +44495,64 @@ } } }, + "com.amazonaws.sagemaker#ListPartnerApps": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListPartnerAppsRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListPartnerAppsResponse" + }, + "traits": { + "smithy.api#documentation": "Lists all of the SageMaker Partner AI Apps in an account.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Summaries", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListPartnerAppsRequest": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "This parameter defines the maximum number of results that can be returned in a single\n response. The MaxResults parameter is an upper bound, not a target. If there are\n more results available than the value specified, a NextToken is provided in the\n response. The NextToken indicates that the user should get the next set of\n results by providing this token as a part of a subsequent call. The default value for\n MaxResults is 10.
If the previous response was truncated, you will receive this token. Use it in your next\n request to receive the next set of results.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListPartnerAppsResponse": { + "type": "structure", + "members": { + "Summaries": { + "target": "com.amazonaws.sagemaker#PartnerAppSummaries", + "traits": { + "smithy.api#documentation": "The information related to each of the SageMaker Partner AI Apps in an account.
" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "If the previous response was truncated, you will receive this token. Use it in your next\n request to receive the next set of results.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.sagemaker#ListPipelineExecutionSteps": { "type": "operation", "input": { @@ -43838,6 +45759,12 @@ "traits": { "smithy.api#documentation": "A filter that retrieves only training jobs with a specific warm pool status.
" } + }, + "TrainingPlanArnEquals": { + "target": "com.amazonaws.sagemaker#TrainingPlanArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN); of the training plan to filter training jobs by. For more information\n about reserving GPU capacity for your SageMaker training jobs using Amazon SageMaker Training Plan, see \n CreateTrainingPlan\n .
Retrieves a list of training plans for the current account.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "TrainingPlanSummaries", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListTrainingPlansRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "A token to continue pagination if more results are available.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return in the response.
" + } + }, + "StartTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "Filter to list only training plans with an actual start time after this date.
" + } + }, + "StartTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "Filter to list only training plans with an actual start time before this date.
" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#TrainingPlanSortBy", + "traits": { + "smithy.api#documentation": "The training plan field to sort the results by (e.g., StartTime, Status).
" + } + }, + "SortOrder": { + "target": "com.amazonaws.sagemaker#TrainingPlanSortOrder", + "traits": { + "smithy.api#documentation": "The order to sort the results (Ascending or Descending).
" + } + }, + "Filters": { + "target": "com.amazonaws.sagemaker#TrainingPlanFilters", + "traits": { + "smithy.api#documentation": "Additional filters to apply to the list of training plans.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListTrainingPlansResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "A token to continue pagination if more results are available.
" + } + }, + "TrainingPlanSummaries": { + "target": "com.amazonaws.sagemaker#TrainingPlanSummaries", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A list of summary information for the training plans.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.sagemaker#ListTransformJobs": { "type": "operation", "input": { @@ -45075,6 +47092,36 @@ "traits": { "smithy.api#enumValue": "PerformanceEvaluation" } + }, + "HYPER_POD_CLUSTERS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HyperPodClusters" + } + }, + "LAKERA_GUARD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LakeraGuard" + } + }, + "COMET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Comet" + } + }, + "DEEPCHECKS_LLM_EVALUATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeepchecksLLMEvaluation" + } + }, + "FIDDLER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Fiddler" + } } } }, @@ -51080,6 +53127,218 @@ "target": "com.amazonaws.sagemaker#Parent" } }, + "com.amazonaws.sagemaker#PartnerAppAdminUserList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#NonEmptyString256" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 5 + } + } + }, + "com.amazonaws.sagemaker#PartnerAppArguments": { + "type": "map", + "key": { + "target": "com.amazonaws.sagemaker#NonEmptyString256" + }, + "value": { + "target": "com.amazonaws.sagemaker#String1024" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 5 + } + } + }, + "com.amazonaws.sagemaker#PartnerAppArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:partner-app\\/app-[A-Z0-9]{12}$" + } + }, + "com.amazonaws.sagemaker#PartnerAppAuthType": { + "type": "enum", + "members": { + "IAM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IAM" + } + } + } + }, + "com.amazonaws.sagemaker#PartnerAppConfig": { + "type": "structure", + "members": { + "AdminUsers": { + "target": "com.amazonaws.sagemaker#PartnerAppAdminUserList", + "traits": { + "smithy.api#documentation": "The list of users that are given admin access to the SageMaker Partner AI App.
" + } + }, + "Arguments": { + "target": "com.amazonaws.sagemaker#PartnerAppArguments", + "traits": { + "smithy.api#documentation": "This is a map of required inputs for a SageMaker Partner AI App. Based on the application type, the map is populated with a key and value pair that is specific to the user and application.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration settings for the SageMaker Partner AI App.
" + } + }, + "com.amazonaws.sagemaker#PartnerAppMaintenanceConfig": { + "type": "structure", + "members": { + "MaintenanceWindowStart": { + "target": "com.amazonaws.sagemaker#WeeklyScheduleTimeFormat", + "traits": { + "smithy.api#documentation": "The day and time of the week in Coordinated Universal Time (UTC) 24-hour standard time that weekly maintenance updates are scheduled. This value must take the following format: 3-letter-day:24-h-hour:minute. For example: TUE:03:30.
Maintenance configuration settings for the SageMaker Partner AI App.
" + } + }, + "com.amazonaws.sagemaker#PartnerAppName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z0-9]+$" + } + }, + "com.amazonaws.sagemaker#PartnerAppStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Creating" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Updating" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Deleting" + } + }, + "AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Available" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "UPDATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UpdateFailed" + } + }, + "DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Deleted" + } + } + } + }, + "com.amazonaws.sagemaker#PartnerAppSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#PartnerAppSummary" + } + }, + "com.amazonaws.sagemaker#PartnerAppSummary": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.sagemaker#PartnerAppArn", + "traits": { + "smithy.api#documentation": "The ARN of the SageMaker Partner AI App.
" + } + }, + "Name": { + "target": "com.amazonaws.sagemaker#PartnerAppName", + "traits": { + "smithy.api#documentation": "The name of the SageMaker Partner AI App.
" + } + }, + "Type": { + "target": "com.amazonaws.sagemaker#PartnerAppType", + "traits": { + "smithy.api#documentation": "The type of SageMaker Partner AI App to create. Must be one of the following: lakera-guard, comet, deepchecks-llm-evaluation, or fiddler.
The status of the SageMaker Partner AI App.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The creation time of the SageMaker Partner AI App.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A subset of information related to a SageMaker Partner AI App. This information is used as part of the ListPartnerApps API response.
A specification for a predefined metric.
" } }, + "com.amazonaws.sagemaker#PreemptTeamTasks": { + "type": "enum", + "members": { + "NEVER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Never" + } + }, + "LOWERPRIORITY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LowerPriority" + } + } + } + }, "com.amazonaws.sagemaker#PresignedDomainUrl": { "type": "string" }, + "com.amazonaws.sagemaker#PriorityClass": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.sagemaker#ClusterSchedulerPriorityClassName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Name of the priority class.
", + "smithy.api#required": {} + } + }, + "Weight": { + "target": "com.amazonaws.sagemaker#PriorityWeight", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Weight of the priority class. The value is within a range from 0 to 100, where 0 is the\n default.
\nA weight of 0 is the lowest priority and 100 is the highest. Weight 0 is the\n default.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Priority class configuration. When included in PriorityClasses, these class\n configurations define how tasks are queued.
The instance type for the reserved capacity offering.
", + "smithy.api#required": {} + } + }, + "InstanceCount": { + "target": "com.amazonaws.sagemaker#ReservedCapacityInstanceCount", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The number of instances in the reserved capacity offering.
", + "smithy.api#required": {} + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.sagemaker#AvailabilityZone", + "traits": { + "smithy.api#documentation": "The availability zone for the reserved capacity offering.
" + } + }, + "DurationHours": { + "target": "com.amazonaws.sagemaker#ReservedCapacityDurationHours", + "traits": { + "smithy.api#documentation": "The number of whole hours in the total duration for this reserved capacity\n offering.
" + } + }, + "DurationMinutes": { + "target": "com.amazonaws.sagemaker#ReservedCapacityDurationMinutes", + "traits": { + "smithy.api#documentation": "The additional minutes beyond whole hours in the total duration for this reserved\n capacity offering.
" + } + }, + "StartTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The start time of the reserved capacity offering.
" + } + }, + "EndTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The end time of the reserved capacity offering.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Details about a reserved capacity offering for a training plan offering.
\nFor more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using\n Amazon SageMaker Training Plan, see \n CreateTrainingPlan\n .
The Amazon Resource Name (ARN); of the reserved capacity.
", + "smithy.api#required": {} + } + }, + "InstanceType": { + "target": "com.amazonaws.sagemaker#ReservedCapacityInstanceType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The instance type for the reserved capacity.
", + "smithy.api#required": {} + } + }, + "TotalInstanceCount": { + "target": "com.amazonaws.sagemaker#TotalInstanceCount", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The total number of instances in the reserved capacity.
", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.sagemaker#ReservedCapacityStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The current status of the reserved capacity.
", + "smithy.api#required": {} + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.sagemaker#AvailabilityZone", + "traits": { + "smithy.api#documentation": "The availability zone for the reserved capacity.
" + } + }, + "DurationHours": { + "target": "com.amazonaws.sagemaker#ReservedCapacityDurationHours", + "traits": { + "smithy.api#documentation": "The number of whole hours in the total duration for this reserved capacity.
" + } + }, + "DurationMinutes": { + "target": "com.amazonaws.sagemaker#ReservedCapacityDurationMinutes", + "traits": { + "smithy.api#documentation": "The additional minutes beyond whole hours in the total duration for this reserved\n capacity.
" + } + }, + "StartTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The start time of the reserved capacity.
" + } + }, + "EndTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The end time of the reserved capacity.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Details of a reserved capacity for the training plan.
\nFor more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using\n Amazon SageMaker Training Plan, see \n CreateTrainingPlan\n .
The configuration of a heterogeneous cluster in JSON format.
" } + }, + "TrainingPlanArn": { + "target": "com.amazonaws.sagemaker#TrainingPlanArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN); of the training plan to use for this resource configuration.
" + } } }, "traits": { @@ -57359,6 +59941,51 @@ } } }, + "com.amazonaws.sagemaker#ResourceSharingConfig": { + "type": "structure", + "members": { + "Strategy": { + "target": "com.amazonaws.sagemaker#ResourceSharingStrategy", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The strategy of how idle compute is shared within the cluster. The following are the\n options of strategies.
\n\n DontLend: entities do not lend idle compute.
\n Lend: entities can lend idle compute to entities that can\n borrow.
\n LendandBorrow: entities can lend idle compute and borrow idle compute\n from other entities.
Default is LendandBorrow.
The limit on how much idle compute can be borrowed.The values can be 1 - 500 percent of\n idle compute that the team is allowed to borrow.
\nDefault is 50.
Resource sharing configuration.
" + } + }, + "com.amazonaws.sagemaker#ResourceSharingStrategy": { + "type": "enum", + "members": { + "LEND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Lend" + } + }, + "DONTLEND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DontLend" + } + }, + "LENDANDBORROW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LendAndBorrow" + } + } + } + }, "com.amazonaws.sagemaker#ResourceSpec": { "type": "structure", "members": { @@ -58045,12 +60672,18 @@ { "target": "com.amazonaws.sagemaker#CreateCluster" }, + { + "target": "com.amazonaws.sagemaker#CreateClusterSchedulerConfig" + }, { "target": "com.amazonaws.sagemaker#CreateCodeRepository" }, { "target": "com.amazonaws.sagemaker#CreateCompilationJob" }, + { + "target": "com.amazonaws.sagemaker#CreateComputeQuota" + }, { "target": "com.amazonaws.sagemaker#CreateContext" }, @@ -58156,6 +60789,12 @@ { "target": "com.amazonaws.sagemaker#CreateOptimizationJob" }, + { + "target": "com.amazonaws.sagemaker#CreatePartnerApp" + }, + { + "target": "com.amazonaws.sagemaker#CreatePartnerAppPresignedUrl" + }, { "target": "com.amazonaws.sagemaker#CreatePipeline" }, @@ -58183,6 +60822,9 @@ { "target": "com.amazonaws.sagemaker#CreateTrainingJob" }, + { + "target": "com.amazonaws.sagemaker#CreateTrainingPlan" + }, { "target": "com.amazonaws.sagemaker#CreateTransformJob" }, @@ -58222,12 +60864,18 @@ { "target": "com.amazonaws.sagemaker#DeleteCluster" }, + { + "target": "com.amazonaws.sagemaker#DeleteClusterSchedulerConfig" + }, { "target": "com.amazonaws.sagemaker#DeleteCodeRepository" }, { "target": "com.amazonaws.sagemaker#DeleteCompilationJob" }, + { + "target": "com.amazonaws.sagemaker#DeleteComputeQuota" + }, { "target": "com.amazonaws.sagemaker#DeleteContext" }, @@ -58327,6 +60975,9 @@ { "target": "com.amazonaws.sagemaker#DeleteOptimizationJob" }, + { + "target": "com.amazonaws.sagemaker#DeletePartnerApp" + }, { "target": "com.amazonaws.sagemaker#DeletePipeline" }, @@ -58387,12 +61038,18 @@ { "target": "com.amazonaws.sagemaker#DescribeClusterNode" }, + { + "target": "com.amazonaws.sagemaker#DescribeClusterSchedulerConfig" + }, { "target": "com.amazonaws.sagemaker#DescribeCodeRepository" }, { "target": "com.amazonaws.sagemaker#DescribeCompilationJob" }, + { + "target": "com.amazonaws.sagemaker#DescribeComputeQuota" + }, { "target": "com.amazonaws.sagemaker#DescribeContext" }, @@ -58504,6 +61161,9 @@ { "target": "com.amazonaws.sagemaker#DescribeOptimizationJob" }, + { + "target": "com.amazonaws.sagemaker#DescribePartnerApp" + }, { "target": "com.amazonaws.sagemaker#DescribePipeline" }, @@ -58531,6 +61191,9 @@ { "target": "com.amazonaws.sagemaker#DescribeTrainingJob" }, + { + "target": "com.amazonaws.sagemaker#DescribeTrainingPlan" + }, { "target": "com.amazonaws.sagemaker#DescribeTransformJob" }, @@ -58612,12 +61275,18 @@ { "target": "com.amazonaws.sagemaker#ListClusters" }, + { + "target": "com.amazonaws.sagemaker#ListClusterSchedulerConfigs" + }, { "target": "com.amazonaws.sagemaker#ListCodeRepositories" }, { "target": "com.amazonaws.sagemaker#ListCompilationJobs" }, + { + "target": "com.amazonaws.sagemaker#ListComputeQuotas" + }, { "target": "com.amazonaws.sagemaker#ListContexts" }, @@ -58750,6 +61419,9 @@ { "target": "com.amazonaws.sagemaker#ListOptimizationJobs" }, + { + "target": "com.amazonaws.sagemaker#ListPartnerApps" + }, { "target": "com.amazonaws.sagemaker#ListPipelineExecutions" }, @@ -58792,6 +61464,9 @@ { "target": "com.amazonaws.sagemaker#ListTrainingJobsForHyperParameterTuningJob" }, + { + "target": "com.amazonaws.sagemaker#ListTrainingPlans" + }, { "target": "com.amazonaws.sagemaker#ListTransformJobs" }, @@ -58828,6 +61503,9 @@ { "target": "com.amazonaws.sagemaker#Search" }, + { + "target": "com.amazonaws.sagemaker#SearchTrainingPlanOfferings" + }, { "target": "com.amazonaws.sagemaker#SendPipelineExecutionStepFailure" }, @@ -58912,12 +61590,18 @@ { "target": "com.amazonaws.sagemaker#UpdateCluster" }, + { + "target": "com.amazonaws.sagemaker#UpdateClusterSchedulerConfig" + }, { "target": "com.amazonaws.sagemaker#UpdateClusterSoftware" }, { "target": "com.amazonaws.sagemaker#UpdateCodeRepository" }, + { + "target": "com.amazonaws.sagemaker#UpdateComputeQuota" + }, { "target": "com.amazonaws.sagemaker#UpdateContext" }, @@ -58984,6 +61668,9 @@ { "target": "com.amazonaws.sagemaker#UpdateNotebookInstanceLifecycleConfig" }, + { + "target": "com.amazonaws.sagemaker#UpdatePartnerApp" + }, { "target": "com.amazonaws.sagemaker#UpdatePipeline" }, @@ -60087,6 +62774,34 @@ "smithy.api#pattern": "^arn:[a-z0-9-\\.]{1,63}:sagemaker:\\w+(?:-\\w+)+:aws:hub-content\\/[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}\\/Model\\/[a-zA-Z0-9](-*[a-zA-Z0-9]){0,63}$" } }, + "com.amazonaws.sagemaker#SageMakerResourceName": { + "type": "enum", + "members": { + "TRAINING_JOB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "training-job" + } + }, + "HYPERPOD_CLUSTER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "hyperpod-cluster" + } + } + } + }, + "com.amazonaws.sagemaker#SageMakerResourceNames": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#SageMakerResourceName" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, "com.amazonaws.sagemaker#SagemakerServicecatalogStatus": { "type": "enum", "members": { @@ -60249,6 +62964,103 @@ } } }, + "com.amazonaws.sagemaker#SchedulerConfig": { + "type": "structure", + "members": { + "PriorityClasses": { + "target": "com.amazonaws.sagemaker#PriorityClassList", + "traits": { + "smithy.api#documentation": "List of the priority classes, PriorityClass, of the cluster policy. When\n specified, these class configurations define how tasks are queued.
When enabled, entities borrow idle compute based on their assigned\n FairShareWeight.
When disabled, entities borrow idle compute based on a first-come first-serve\n basis.
\nDefault is Enabled.
Cluster policy configuration. This policy is used for task prioritization and fair-share\n allocation. This helps prioritize critical workloads and distributes idle compute\n across entities.
" + } + }, + "com.amazonaws.sagemaker#SchedulerResourceStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Creating" + } + }, + "CREATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreateFailed" + } + }, + "CREATE_ROLLBACK_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreateRollbackFailed" + } + }, + "CREATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Created" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Updating" + } + }, + "UPDATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UpdateFailed" + } + }, + "UPDATE_ROLLBACK_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UpdateRollbackFailed" + } + }, + "UPDATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Updated" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Deleting" + } + }, + "DELETE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeleteFailed" + } + }, + "DELETE_ROLLBACK_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeleteRollbackFailed" + } + }, + "DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Deleted" + } + } + } + }, "com.amazonaws.sagemaker#Scope": { "type": "string", "traits": { @@ -60499,6 +63311,89 @@ } } }, + "com.amazonaws.sagemaker#SearchTrainingPlanOfferings": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#SearchTrainingPlanOfferingsRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#SearchTrainingPlanOfferingsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "Searches for available training plan offerings based on specified criteria.
\nUsers search for available plan offerings based on their requirements (e.g.,\n instance type, count, start time, duration).
\nAnd then, they create a plan that best matches their needs using the ID of the\n plan offering they want to use.
\nFor more information about how to reserve GPU capacity for your SageMaker training jobs or\n SageMaker HyperPod clusters using Amazon SageMaker Training Plan , see \n CreateTrainingPlan\n .
The type of instance you want to search for in the available training plan offerings.\n This field allows you to filter the search results based on the specific compute resources\n you require for your SageMaker training jobs or SageMaker HyperPod clusters. When searching for training\n plan offerings, specifying the instance type helps you find Reserved Instances that match\n your computational needs.
", + "smithy.api#required": {} + } + }, + "InstanceCount": { + "target": "com.amazonaws.sagemaker#ReservedCapacityInstanceCount", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The number of instances you want to reserve in the training plan offerings. This allows\n you to specify the quantity of compute resources needed for your SageMaker training jobs or\n SageMaker HyperPod clusters, helping you find reserved capacity offerings that match your\n requirements.
", + "smithy.api#required": {} + } + }, + "StartTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "A filter to search for training plan offerings with a start time after a specified\n date.
" + } + }, + "EndTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "A filter to search for reserved capacity offerings with an end time before a specified\n date.
" + } + }, + "DurationHours": { + "target": "com.amazonaws.sagemaker#TrainingPlanDurationHoursInput", + "traits": { + "smithy.api#documentation": "The desired duration in hours for the training plan offerings.
" + } + }, + "TargetResources": { + "target": "com.amazonaws.sagemaker#SageMakerResourceNames", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The target resources (e.g., SageMaker Training Jobs, SageMaker HyperPod) to search for in the\n offerings.
\nTraining plans are specific to their target resource.
\nA training plan designed for SageMaker training jobs can only be used to schedule and\n run training jobs.
\nA training plan for HyperPod clusters can be used exclusively to provide\n compute resources to a cluster's instance group.
\nA list of training plan offerings that match the search criteria.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.sagemaker#SecondaryStatus": { "type": "enum", "members": { @@ -61257,6 +64152,29 @@ } } }, + "com.amazonaws.sagemaker#SortClusterSchedulerConfigBy": { + "type": "enum", + "members": { + "NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Name" + } + }, + "CREATION_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" + } + }, + "STATUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Status" + } + } + } + }, "com.amazonaws.sagemaker#SortContextsBy": { "type": "enum", "members": { @@ -61382,6 +64300,35 @@ } } }, + "com.amazonaws.sagemaker#SortQuotaBy": { + "type": "enum", + "members": { + "NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Name" + } + }, + "CREATION_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" + } + }, + "STATUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Status" + } + }, + "CLUSTER_ARN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ClusterArn" + } + } + } + }, "com.amazonaws.sagemaker#SortTrackingServerBy": { "type": "enum", "members": { @@ -63091,6 +66038,15 @@ "smithy.api#pattern": "^.+$" } }, + "com.amazonaws.sagemaker#String2048": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2048 + } + } + }, "com.amazonaws.sagemaker#String256": { "type": "string", "traits": { @@ -64508,6 +67464,14 @@ } } }, + "com.amazonaws.sagemaker#TotalInstanceCount": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, "com.amazonaws.sagemaker#TrackingServerArn": { "type": "string", "traits": { @@ -65169,6 +68133,12 @@ "smithy.api#enumValue": "ml.p5e.48xlarge" } }, + "ML_P5EN_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p5en.48xlarge" + } + }, "ML_C5_XLARGE": { "target": "smithy.api#Unit", "traits": { @@ -65391,6 +68361,12 @@ "smithy.api#enumValue": "ml.trn1n.32xlarge" } }, + "ML_TRN2_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.trn2.48xlarge" + } + }, "ML_M6I_LARGE": { "target": "smithy.api#Unit", "traits": { @@ -66120,12 +69096,399 @@ "traits": { "smithy.api#documentation": "The status of the warm pool associated with the training job.
" } + }, + "TrainingPlanArn": { + "target": "com.amazonaws.sagemaker#TrainingPlanArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN); of the training plan associated with this training job.
\nFor more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using\n Amazon SageMaker Training Plan, see \n CreateTrainingPlan\n .
Provides summary information about a training job.
" } }, + "com.amazonaws.sagemaker#TrainingPlanArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 50, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:training-plan/" + } + }, + "com.amazonaws.sagemaker#TrainingPlanArns": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#TrainingPlanArn" + } + }, + "com.amazonaws.sagemaker#TrainingPlanDurationHours": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 87600 + } + } + }, + "com.amazonaws.sagemaker#TrainingPlanDurationHoursInput": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 87600 + } + } + }, + "com.amazonaws.sagemaker#TrainingPlanDurationMinutes": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 59 + } + } + }, + "com.amazonaws.sagemaker#TrainingPlanFilter": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.sagemaker#TrainingPlanFilterName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the filter field (e.g., Status, InstanceType).
", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.sagemaker#String64", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The value to filter by for the specified field.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A filter to apply when listing or searching for training plans.
\nFor more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using\n Amazon SageMaker Training Plan, see \n CreateTrainingPlan\n .
The unique identifier for this training plan offering.
", + "smithy.api#required": {} + } + }, + "TargetResources": { + "target": "com.amazonaws.sagemaker#SageMakerResourceNames", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The target resources (e.g., SageMaker Training Jobs, SageMaker HyperPod) for this training plan\n offering.
\nTraining plans are specific to their target resource.
\nA training plan designed for SageMaker training jobs can only be used to schedule and\n run training jobs.
\nA training plan for HyperPod clusters can be used exclusively to provide\n compute resources to a cluster's instance group.
\nThe requested start time that the user specified when searching for the training plan\n offering.
" + } + }, + "RequestedEndTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The requested end time that the user specified when searching for the training plan\n offering.
" + } + }, + "DurationHours": { + "target": "com.amazonaws.sagemaker#TrainingPlanDurationHours", + "traits": { + "smithy.api#documentation": "The number of whole hours in the total duration for this training plan offering.
" + } + }, + "DurationMinutes": { + "target": "com.amazonaws.sagemaker#TrainingPlanDurationMinutes", + "traits": { + "smithy.api#documentation": "The additional minutes beyond whole hours in the total duration for this training plan\n offering.
" + } + }, + "UpfrontFee": { + "target": "com.amazonaws.sagemaker#String256", + "traits": { + "smithy.api#documentation": "The upfront fee for this training plan offering.
" + } + }, + "CurrencyCode": { + "target": "com.amazonaws.sagemaker#CurrencyCode", + "traits": { + "smithy.api#documentation": "The currency code for the upfront fee (e.g., USD).
" + } + }, + "ReservedCapacityOfferings": { + "target": "com.amazonaws.sagemaker#ReservedCapacityOfferings", + "traits": { + "smithy.api#documentation": "A list of reserved capacity offerings associated with this training plan\n offering.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Details about a training plan offering.
\nFor more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using\n Amazon SageMaker Training Plan, see \n CreateTrainingPlan\n .
The Amazon Resource Name (ARN); of the training plan.
", + "smithy.api#required": {} + } + }, + "TrainingPlanName": { + "target": "com.amazonaws.sagemaker#TrainingPlanName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the training plan.
", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.sagemaker#TrainingPlanStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The current status of the training plan (e.g., Pending, Active, Expired). To see the\n complete list of status values available for a training plan, refer to the\n Status attribute within the \n TrainingPlanSummary\n object.
A message providing additional information about the current status of the training\n plan.
" + } + }, + "DurationHours": { + "target": "com.amazonaws.sagemaker#TrainingPlanDurationHours", + "traits": { + "smithy.api#documentation": "The number of whole hours in the total duration for this training plan.
" + } + }, + "DurationMinutes": { + "target": "com.amazonaws.sagemaker#TrainingPlanDurationMinutes", + "traits": { + "smithy.api#documentation": "The additional minutes beyond whole hours in the total duration for this training\n plan.
" + } + }, + "StartTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The start time of the training plan.
" + } + }, + "EndTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The end time of the training plan.
" + } + }, + "UpfrontFee": { + "target": "com.amazonaws.sagemaker#String256", + "traits": { + "smithy.api#documentation": "The upfront fee for the training plan.
" + } + }, + "CurrencyCode": { + "target": "com.amazonaws.sagemaker#CurrencyCode", + "traits": { + "smithy.api#documentation": "The currency code for the upfront fee (e.g., USD).
" + } + }, + "TotalInstanceCount": { + "target": "com.amazonaws.sagemaker#TotalInstanceCount", + "traits": { + "smithy.api#documentation": "The total number of instances reserved in this training plan.
" + } + }, + "AvailableInstanceCount": { + "target": "com.amazonaws.sagemaker#AvailableInstanceCount", + "traits": { + "smithy.api#documentation": "The number of instances currently available for use in this training plan.
" + } + }, + "InUseInstanceCount": { + "target": "com.amazonaws.sagemaker#InUseInstanceCount", + "traits": { + "smithy.api#documentation": "The number of instances currently in use from this training plan.
" + } + }, + "TargetResources": { + "target": "com.amazonaws.sagemaker#SageMakerResourceNames", + "traits": { + "smithy.api#documentation": "The target resources (e.g., training jobs, HyperPod clusters) that can use this training\n plan.
\nTraining plans are specific to their target resource.
\nA training plan designed for SageMaker training jobs can only be used to schedule and\n run training jobs.
\nA training plan for HyperPod clusters can be used exclusively to provide\n compute resources to a cluster's instance group.
\nA list of reserved capacities associated with this training plan, including details such\n as instance types, counts, and availability zones.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Details of the training plan.
\nFor more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using\n Amazon SageMaker Training Plan, see \n CreateTrainingPlan\n .
Update the cluster policy configuration.
" + } + }, + "com.amazonaws.sagemaker#UpdateClusterSchedulerConfigRequest": { + "type": "structure", + "members": { + "ClusterSchedulerConfigId": { + "target": "com.amazonaws.sagemaker#ClusterSchedulerConfigId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "ID of the cluster policy.
", + "smithy.api#required": {} + } + }, + "TargetVersion": { + "target": "com.amazonaws.sagemaker#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Target version.
", + "smithy.api#required": {} + } + }, + "SchedulerConfig": { + "target": "com.amazonaws.sagemaker#SchedulerConfig", + "traits": { + "smithy.api#documentation": "Cluster policy configuration.
" + } + }, + "Description": { + "target": "com.amazonaws.sagemaker#EntityDescription", + "traits": { + "smithy.api#documentation": "Description of the cluster policy.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#UpdateClusterSchedulerConfigResponse": { + "type": "structure", + "members": { + "ClusterSchedulerConfigArn": { + "target": "com.amazonaws.sagemaker#ClusterSchedulerConfigArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "ARN of the cluster policy.
", + "smithy.api#required": {} + } + }, + "ClusterSchedulerConfigVersion": { + "target": "com.amazonaws.sagemaker#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Version of the cluster policy.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.sagemaker#UpdateClusterSoftware": { "type": "operation", "input": { @@ -68649,6 +72095,101 @@ "smithy.api#output": {} } }, + "com.amazonaws.sagemaker#UpdateComputeQuota": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#UpdateComputeQuotaRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#UpdateComputeQuotaResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ConflictException" + }, + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Update the compute allocation definition.
" + } + }, + "com.amazonaws.sagemaker#UpdateComputeQuotaRequest": { + "type": "structure", + "members": { + "ComputeQuotaId": { + "target": "com.amazonaws.sagemaker#ComputeQuotaId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "ID of the compute allocation definition.
", + "smithy.api#required": {} + } + }, + "TargetVersion": { + "target": "com.amazonaws.sagemaker#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Target version.
", + "smithy.api#required": {} + } + }, + "ComputeQuotaConfig": { + "target": "com.amazonaws.sagemaker#ComputeQuotaConfig", + "traits": { + "smithy.api#documentation": "Configuration of the compute allocation definition. This includes the resource sharing\n option, and the setting to preempt low priority tasks.
" + } + }, + "ComputeQuotaTarget": { + "target": "com.amazonaws.sagemaker#ComputeQuotaTarget", + "traits": { + "smithy.api#documentation": "The target entity to allocate compute resources to.
" + } + }, + "ActivationState": { + "target": "com.amazonaws.sagemaker#ActivationState", + "traits": { + "smithy.api#documentation": "The state of the compute allocation being described. Use to enable or disable compute\n allocation.
\nDefault is Enabled.
Description of the compute allocation definition.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#UpdateComputeQuotaResponse": { + "type": "structure", + "members": { + "ComputeQuotaArn": { + "target": "com.amazonaws.sagemaker#ComputeQuotaArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "ARN of the compute allocation definition.
", + "smithy.api#required": {} + } + }, + "ComputeQuotaVersion": { + "target": "com.amazonaws.sagemaker#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Version of the compute allocation definition.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.sagemaker#UpdateContext": { "type": "operation", "input": { @@ -70255,6 +73796,93 @@ "smithy.api#output": {} } }, + "com.amazonaws.sagemaker#UpdatePartnerApp": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#UpdatePartnerAppRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#UpdatePartnerAppResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ConflictException" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Updates all of the SageMaker Partner AI Apps in an account.
" + } + }, + "com.amazonaws.sagemaker#UpdatePartnerAppRequest": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.sagemaker#PartnerAppArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The ARN of the SageMaker Partner AI App to update.
", + "smithy.api#required": {} + } + }, + "MaintenanceConfig": { + "target": "com.amazonaws.sagemaker#PartnerAppMaintenanceConfig", + "traits": { + "smithy.api#documentation": "Maintenance configuration settings for the SageMaker Partner AI App.
" + } + }, + "Tier": { + "target": "com.amazonaws.sagemaker#NonEmptyString64", + "traits": { + "smithy.api#documentation": "Indicates the instance type and size of the cluster attached to the SageMaker Partner AI App.
" + } + }, + "ApplicationConfig": { + "target": "com.amazonaws.sagemaker#PartnerAppConfig", + "traits": { + "smithy.api#documentation": "Configuration settings for the SageMaker Partner AI App.
" + } + }, + "EnableIamSessionBasedIdentity": { + "target": "com.amazonaws.sagemaker#Boolean", + "traits": { + "smithy.api#documentation": "When set to TRUE, the SageMaker Partner AI App sets the Amazon Web Services IAM session name or the authenticated IAM user as the identity of the SageMaker Partner AI App user.
A unique token that guarantees that the call to this API is idempotent.
", + "smithy.api#idempotencyToken": {} + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "Each tag consists of a key and an optional value. Tag keys must be unique per\n resource.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#UpdatePartnerAppResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.sagemaker#PartnerAppArn", + "traits": { + "smithy.api#documentation": "The ARN of the SageMaker Partner AI App that was updated.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.sagemaker#UpdatePipeline": { "type": "operation", "input": { @@ -71735,6 +75363,16 @@ "smithy.api#pattern": "^(Mon|Tue|Wed|Thu|Fri|Sat|Sun):([01]\\d|2[0-3]):([0-5]\\d)$" } }, + "com.amazonaws.sagemaker#WeeklyScheduleTimeFormat": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 9 + }, + "smithy.api#pattern": "^(Mon|Tue|Wed|Thu|Fri|Sat|Sun):([01]\\d|2[0-3]):([0-5]\\d)$" + } + }, "com.amazonaws.sagemaker#WorkerAccessConfiguration": { "type": "structure", "members": {