Creates a SageMaker HyperPod cluster. SageMaker HyperPod is a capability of SageMaker for creating and managing * persistent clusters for developing large machine learning models, such as large language - * models (LLMs) and diffusion models. To learn more, see Amazon SageMaker HyperPod in the Amazon SageMaker Developer Guide.
+ * models (LLMs) and diffusion models. To learn more, see Amazon SageMaker HyperPod in the + * Amazon SageMaker Developer Guide. * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -50,6 +51,13 @@ export interface CreateClusterCommandOutput extends CreateClusterResponse, __Met * }, * ExecutionRole: "STRING_VALUE", // required * ThreadsPerCore: Number("int"), + * InstanceStorageConfigs: [ // ClusterInstanceStorageConfigs + * { // ClusterInstanceStorageConfig Union: only one key present + * EbsVolumeConfig: { // ClusterEbsVolumeConfig + * VolumeSizeInGB: Number("int"), // required + * }, + * }, + * ], * }, * ], * VpcConfig: { // VpcConfig diff --git a/clients/client-sagemaker/src/commands/CreateMlflowTrackingServerCommand.ts b/clients/client-sagemaker/src/commands/CreateMlflowTrackingServerCommand.ts new file mode 100644 index 0000000000000..569522da7ee1b --- /dev/null +++ b/clients/client-sagemaker/src/commands/CreateMlflowTrackingServerCommand.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 { CreateMlflowTrackingServerRequest, CreateMlflowTrackingServerResponse } from "../models/models_1"; +import { de_CreateMlflowTrackingServerCommand, se_CreateMlflowTrackingServerCommand } from "../protocols/Aws_json1_1"; +import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link CreateMlflowTrackingServerCommand}. + */ +export interface CreateMlflowTrackingServerCommandInput extends CreateMlflowTrackingServerRequest {} +/** + * @public + * + * The output of {@link CreateMlflowTrackingServerCommand}. + */ +export interface CreateMlflowTrackingServerCommandOutput extends CreateMlflowTrackingServerResponse, __MetadataBearer {} + +/** + *Creates an MLflow Tracking Server using a general purpose Amazon S3 bucket as the artifact + * store. For more information, see Create an MLflow Tracking + * Server.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, CreateMlflowTrackingServerCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, CreateMlflowTrackingServerCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const input = { // CreateMlflowTrackingServerRequest + * TrackingServerName: "STRING_VALUE", // required + * ArtifactStoreUri: "STRING_VALUE", // required + * TrackingServerSize: "Small" || "Medium" || "Large", + * MlflowVersion: "STRING_VALUE", + * RoleArn: "STRING_VALUE", // required + * AutomaticModelRegistration: true || false, + * WeeklyMaintenanceWindowStart: "STRING_VALUE", + * Tags: [ // TagList + * { // Tag + * Key: "STRING_VALUE", // required + * Value: "STRING_VALUE", // required + * }, + * ], + * }; + * const command = new CreateMlflowTrackingServerCommand(input); + * const response = await client.send(command); + * // { // CreateMlflowTrackingServerResponse + * // TrackingServerArn: "STRING_VALUE", + * // }; + * + * ``` + * + * @param CreateMlflowTrackingServerCommandInput - {@link CreateMlflowTrackingServerCommandInput} + * @returns {@link CreateMlflowTrackingServerCommandOutput} + * @see {@link CreateMlflowTrackingServerCommandInput} for command's `input` shape. + * @see {@link CreateMlflowTrackingServerCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for SageMakerClient's `config` shape. + * + * @throws {@link ResourceLimitExceeded} (client fault) + *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 CreateMlflowTrackingServerCommand extends $Command + .classBuilder< + CreateMlflowTrackingServerCommandInput, + CreateMlflowTrackingServerCommandOutput, + 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", "CreateMlflowTrackingServer", {}) + .n("SageMakerClient", "CreateMlflowTrackingServerCommand") + .f(void 0, void 0) + .ser(se_CreateMlflowTrackingServerCommand) + .de(de_CreateMlflowTrackingServerCommand) + .build() {} diff --git a/clients/client-sagemaker/src/commands/CreatePresignedMlflowTrackingServerUrlCommand.ts b/clients/client-sagemaker/src/commands/CreatePresignedMlflowTrackingServerUrlCommand.ts new file mode 100644 index 0000000000000..ed76c3d1f3eb3 --- /dev/null +++ b/clients/client-sagemaker/src/commands/CreatePresignedMlflowTrackingServerUrlCommand.ts @@ -0,0 +1,97 @@ +// 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 { + CreatePresignedMlflowTrackingServerUrlRequest, + CreatePresignedMlflowTrackingServerUrlResponse, +} from "../models/models_1"; +import { + de_CreatePresignedMlflowTrackingServerUrlCommand, + se_CreatePresignedMlflowTrackingServerUrlCommand, +} from "../protocols/Aws_json1_1"; +import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link CreatePresignedMlflowTrackingServerUrlCommand}. + */ +export interface CreatePresignedMlflowTrackingServerUrlCommandInput + extends CreatePresignedMlflowTrackingServerUrlRequest {} +/** + * @public + * + * The output of {@link CreatePresignedMlflowTrackingServerUrlCommand}. + */ +export interface CreatePresignedMlflowTrackingServerUrlCommandOutput + extends CreatePresignedMlflowTrackingServerUrlResponse, + __MetadataBearer {} + +/** + *Returns a presigned URL that you can use to connect to the MLflow UI attached to your + * tracking server. For more information, see Launch the MLflow UI using a presigned URL.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, CreatePresignedMlflowTrackingServerUrlCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, CreatePresignedMlflowTrackingServerUrlCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const input = { // CreatePresignedMlflowTrackingServerUrlRequest + * TrackingServerName: "STRING_VALUE", // required + * ExpiresInSeconds: Number("int"), + * SessionExpirationDurationInSeconds: Number("int"), + * }; + * const command = new CreatePresignedMlflowTrackingServerUrlCommand(input); + * const response = await client.send(command); + * // { // CreatePresignedMlflowTrackingServerUrlResponse + * // AuthorizedUrl: "STRING_VALUE", + * // }; + * + * ``` + * + * @param CreatePresignedMlflowTrackingServerUrlCommandInput - {@link CreatePresignedMlflowTrackingServerUrlCommandInput} + * @returns {@link CreatePresignedMlflowTrackingServerUrlCommandOutput} + * @see {@link CreatePresignedMlflowTrackingServerUrlCommandInput} for command's `input` shape. + * @see {@link CreatePresignedMlflowTrackingServerUrlCommandOutput} 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 CreatePresignedMlflowTrackingServerUrlCommand extends $Command + .classBuilder< + CreatePresignedMlflowTrackingServerUrlCommandInput, + CreatePresignedMlflowTrackingServerUrlCommandOutput, + 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", "CreatePresignedMlflowTrackingServerUrl", {}) + .n("SageMakerClient", "CreatePresignedMlflowTrackingServerUrlCommand") + .f(void 0, void 0) + .ser(se_CreatePresignedMlflowTrackingServerUrlCommand) + .de(de_CreatePresignedMlflowTrackingServerUrlCommand) + .build() {} diff --git a/clients/client-sagemaker/src/commands/DeleteMlflowTrackingServerCommand.ts b/clients/client-sagemaker/src/commands/DeleteMlflowTrackingServerCommand.ts new file mode 100644 index 0000000000000..c34eead03c267 --- /dev/null +++ b/clients/client-sagemaker/src/commands/DeleteMlflowTrackingServerCommand.ts @@ -0,0 +1,85 @@ +// 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 { DeleteMlflowTrackingServerRequest, DeleteMlflowTrackingServerResponse } from "../models/models_2"; +import { de_DeleteMlflowTrackingServerCommand, se_DeleteMlflowTrackingServerCommand } from "../protocols/Aws_json1_1"; +import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link DeleteMlflowTrackingServerCommand}. + */ +export interface DeleteMlflowTrackingServerCommandInput extends DeleteMlflowTrackingServerRequest {} +/** + * @public + * + * The output of {@link DeleteMlflowTrackingServerCommand}. + */ +export interface DeleteMlflowTrackingServerCommandOutput extends DeleteMlflowTrackingServerResponse, __MetadataBearer {} + +/** + *Deletes an MLflow Tracking Server. For more information, see Clean up MLflow resources.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, DeleteMlflowTrackingServerCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, DeleteMlflowTrackingServerCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const input = { // DeleteMlflowTrackingServerRequest + * TrackingServerName: "STRING_VALUE", // required + * }; + * const command = new DeleteMlflowTrackingServerCommand(input); + * const response = await client.send(command); + * // { // DeleteMlflowTrackingServerResponse + * // TrackingServerArn: "STRING_VALUE", + * // }; + * + * ``` + * + * @param DeleteMlflowTrackingServerCommandInput - {@link DeleteMlflowTrackingServerCommandInput} + * @returns {@link DeleteMlflowTrackingServerCommandOutput} + * @see {@link DeleteMlflowTrackingServerCommandInput} for command's `input` shape. + * @see {@link DeleteMlflowTrackingServerCommandOutput} 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 DeleteMlflowTrackingServerCommand extends $Command + .classBuilder< + DeleteMlflowTrackingServerCommandInput, + DeleteMlflowTrackingServerCommandOutput, + 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", "DeleteMlflowTrackingServer", {}) + .n("SageMakerClient", "DeleteMlflowTrackingServerCommand") + .f(void 0, void 0) + .ser(se_DeleteMlflowTrackingServerCommand) + .de(de_DeleteMlflowTrackingServerCommand) + .build() {} diff --git a/clients/client-sagemaker/src/commands/DeleteWorkforceCommand.ts b/clients/client-sagemaker/src/commands/DeleteWorkforceCommand.ts index 1c614b3bf5453..4f2ee34e3fd29 100644 --- a/clients/client-sagemaker/src/commands/DeleteWorkforceCommand.ts +++ b/clients/client-sagemaker/src/commands/DeleteWorkforceCommand.ts @@ -38,7 +38,7 @@ export interface DeleteWorkforceCommandOutput extends DeleteWorkforceResponse, _ * the DeleteWorkteam * operation to delete all work teams before you delete the workforce. * If you try to delete a workforce that contains one or more work teams, - * you will recieve aResourceInUse error.
+ * you will receive a ResourceInUse error.
*
* @example
* Use a bare-bones client and the command you need to make an API call.
diff --git a/clients/client-sagemaker/src/commands/DescribeClusterCommand.ts b/clients/client-sagemaker/src/commands/DescribeClusterCommand.ts
index 38fa44fbe8a27..921053c3aff25 100644
--- a/clients/client-sagemaker/src/commands/DescribeClusterCommand.ts
+++ b/clients/client-sagemaker/src/commands/DescribeClusterCommand.ts
@@ -58,6 +58,13 @@ export interface DescribeClusterCommandOutput extends DescribeClusterResponse, _
* // },
* // ExecutionRole: "STRING_VALUE",
* // ThreadsPerCore: Number("int"),
+ * // InstanceStorageConfigs: [ // ClusterInstanceStorageConfigs
+ * // { // ClusterInstanceStorageConfig Union: only one key present
+ * // EbsVolumeConfig: { // ClusterEbsVolumeConfig
+ * // VolumeSizeInGB: Number("int"), // required
+ * // },
+ * // },
+ * // ],
* // },
* // ],
* // VpcConfig: { // VpcConfig
diff --git a/clients/client-sagemaker/src/commands/DescribeClusterNodeCommand.ts b/clients/client-sagemaker/src/commands/DescribeClusterNodeCommand.ts
index 56cbc7ac337ca..482b7411d918f 100644
--- a/clients/client-sagemaker/src/commands/DescribeClusterNodeCommand.ts
+++ b/clients/client-sagemaker/src/commands/DescribeClusterNodeCommand.ts
@@ -57,6 +57,13 @@ export interface DescribeClusterNodeCommandOutput extends DescribeClusterNodeRes
* // OnCreate: "STRING_VALUE", // required
* // },
* // ThreadsPerCore: Number("int"),
+ * // InstanceStorageConfigs: [ // ClusterInstanceStorageConfigs
+ * // { // ClusterInstanceStorageConfig Union: only one key present
+ * // EbsVolumeConfig: { // ClusterEbsVolumeConfig
+ * // VolumeSizeInGB: Number("int"), // required
+ * // },
+ * // },
+ * // ],
* // PrivatePrimaryIp: "STRING_VALUE",
* // PrivateDnsHostname: "STRING_VALUE",
* // Placement: { // ClusterInstancePlacement
diff --git a/clients/client-sagemaker/src/commands/DescribeMlflowTrackingServerCommand.ts b/clients/client-sagemaker/src/commands/DescribeMlflowTrackingServerCommand.ts
new file mode 100644
index 0000000000000..264681fe6cb8c
--- /dev/null
+++ b/clients/client-sagemaker/src/commands/DescribeMlflowTrackingServerCommand.ts
@@ -0,0 +1,122 @@
+// 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 { DescribeMlflowTrackingServerRequest, DescribeMlflowTrackingServerResponse } from "../models/models_2";
+import {
+ de_DescribeMlflowTrackingServerCommand,
+ se_DescribeMlflowTrackingServerCommand,
+} from "../protocols/Aws_json1_1";
+import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient";
+
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link DescribeMlflowTrackingServerCommand}.
+ */
+export interface DescribeMlflowTrackingServerCommandInput extends DescribeMlflowTrackingServerRequest {}
+/**
+ * @public
+ *
+ * The output of {@link DescribeMlflowTrackingServerCommand}.
+ */
+export interface DescribeMlflowTrackingServerCommandOutput
+ extends DescribeMlflowTrackingServerResponse,
+ __MetadataBearer {}
+
+/**
+ * Returns information about an MLflow Tracking Server.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, DescribeMlflowTrackingServerCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, DescribeMlflowTrackingServerCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const input = { // DescribeMlflowTrackingServerRequest + * TrackingServerName: "STRING_VALUE", // required + * }; + * const command = new DescribeMlflowTrackingServerCommand(input); + * const response = await client.send(command); + * // { // DescribeMlflowTrackingServerResponse + * // TrackingServerArn: "STRING_VALUE", + * // TrackingServerName: "STRING_VALUE", + * // ArtifactStoreUri: "STRING_VALUE", + * // TrackingServerSize: "Small" || "Medium" || "Large", + * // MlflowVersion: "STRING_VALUE", + * // RoleArn: "STRING_VALUE", + * // TrackingServerStatus: "Creating" || "Created" || "CreateFailed" || "Updating" || "Updated" || "UpdateFailed" || "Deleting" || "DeleteFailed" || "Stopping" || "Stopped" || "StopFailed" || "Starting" || "Started" || "StartFailed" || "MaintenanceInProgress" || "MaintenanceComplete" || "MaintenanceFailed", + * // IsActive: "Active" || "Inactive", + * // TrackingServerUrl: "STRING_VALUE", + * // WeeklyMaintenanceWindowStart: "STRING_VALUE", + * // AutomaticModelRegistration: true || false, + * // CreationTime: new Date("TIMESTAMP"), + * // 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 DescribeMlflowTrackingServerCommandInput - {@link DescribeMlflowTrackingServerCommandInput} + * @returns {@link DescribeMlflowTrackingServerCommandOutput} + * @see {@link DescribeMlflowTrackingServerCommandInput} for command's `input` shape. + * @see {@link DescribeMlflowTrackingServerCommandOutput} 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 DescribeMlflowTrackingServerCommand extends $Command + .classBuilder< + DescribeMlflowTrackingServerCommandInput, + DescribeMlflowTrackingServerCommandOutput, + 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", "DescribeMlflowTrackingServer", {}) + .n("SageMakerClient", "DescribeMlflowTrackingServerCommand") + .f(void 0, void 0) + .ser(se_DescribeMlflowTrackingServerCommand) + .de(de_DescribeMlflowTrackingServerCommand) + .build() {} diff --git a/clients/client-sagemaker/src/commands/DescribeNotebookInstanceLifecycleConfigCommand.ts b/clients/client-sagemaker/src/commands/DescribeNotebookInstanceLifecycleConfigCommand.ts index aabead8fa419b..8ee6497a4b29d 100644 --- a/clients/client-sagemaker/src/commands/DescribeNotebookInstanceLifecycleConfigCommand.ts +++ b/clients/client-sagemaker/src/commands/DescribeNotebookInstanceLifecycleConfigCommand.ts @@ -8,7 +8,7 @@ import { commonParams } from "../endpoint/EndpointParameters"; import { DescribeNotebookInstanceLifecycleConfigInput, DescribeNotebookInstanceLifecycleConfigOutput, -} from "../models/models_2"; +} from "../models/models_3"; import { de_DescribeNotebookInstanceLifecycleConfigCommand, se_DescribeNotebookInstanceLifecycleConfigCommand, diff --git a/clients/client-sagemaker/src/commands/DescribePipelineCommand.ts b/clients/client-sagemaker/src/commands/DescribePipelineCommand.ts index e5e1b45cd5e1f..87816c2323b6f 100644 --- a/clients/client-sagemaker/src/commands/DescribePipelineCommand.ts +++ b/clients/client-sagemaker/src/commands/DescribePipelineCommand.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 { DescribePipelineRequest, DescribePipelineResponse } from "../models/models_2"; +import { DescribePipelineRequest, DescribePipelineResponse } from "../models/models_3"; import { de_DescribePipelineCommand, se_DescribePipelineCommand } from "../protocols/Aws_json1_1"; import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; diff --git a/clients/client-sagemaker/src/commands/DescribePipelineDefinitionForExecutionCommand.ts b/clients/client-sagemaker/src/commands/DescribePipelineDefinitionForExecutionCommand.ts index e77d2e54a8f70..b86957af39c0b 100644 --- a/clients/client-sagemaker/src/commands/DescribePipelineDefinitionForExecutionCommand.ts +++ b/clients/client-sagemaker/src/commands/DescribePipelineDefinitionForExecutionCommand.ts @@ -8,7 +8,7 @@ import { commonParams } from "../endpoint/EndpointParameters"; import { DescribePipelineDefinitionForExecutionRequest, DescribePipelineDefinitionForExecutionResponse, -} from "../models/models_2"; +} from "../models/models_3"; import { de_DescribePipelineDefinitionForExecutionCommand, se_DescribePipelineDefinitionForExecutionCommand, diff --git a/clients/client-sagemaker/src/commands/DescribePipelineExecutionCommand.ts b/clients/client-sagemaker/src/commands/DescribePipelineExecutionCommand.ts index 408973419a4ae..1ec1e353c12fa 100644 --- a/clients/client-sagemaker/src/commands/DescribePipelineExecutionCommand.ts +++ b/clients/client-sagemaker/src/commands/DescribePipelineExecutionCommand.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 { DescribePipelineExecutionRequest, DescribePipelineExecutionResponse } from "../models/models_2"; +import { DescribePipelineExecutionRequest, DescribePipelineExecutionResponse } from "../models/models_3"; import { de_DescribePipelineExecutionCommand, se_DescribePipelineExecutionCommand } from "../protocols/Aws_json1_1"; import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; diff --git a/clients/client-sagemaker/src/commands/DescribeWorkteamCommand.ts b/clients/client-sagemaker/src/commands/DescribeWorkteamCommand.ts index ece04176ca8e2..785169c8e72d9 100644 --- a/clients/client-sagemaker/src/commands/DescribeWorkteamCommand.ts +++ b/clients/client-sagemaker/src/commands/DescribeWorkteamCommand.ts @@ -29,7 +29,7 @@ export interface DescribeWorkteamCommandOutput extends DescribeWorkteamResponse, /** *Gets information about a specific work team. You can see information such as the - * create date, the last updated date, membership information, and the work team's Amazon + * creation date, the last updated date, membership information, and the work team's Amazon * Resource Name (ARN).
* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-sagemaker/src/commands/ListMlflowTrackingServersCommand.ts b/clients/client-sagemaker/src/commands/ListMlflowTrackingServersCommand.ts new file mode 100644 index 0000000000000..64bf9064f3111 --- /dev/null +++ b/clients/client-sagemaker/src/commands/ListMlflowTrackingServersCommand.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 { ListMlflowTrackingServersRequest, ListMlflowTrackingServersResponse } from "../models/models_3"; +import { de_ListMlflowTrackingServersCommand, se_ListMlflowTrackingServersCommand } from "../protocols/Aws_json1_1"; +import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link ListMlflowTrackingServersCommand}. + */ +export interface ListMlflowTrackingServersCommandInput extends ListMlflowTrackingServersRequest {} +/** + * @public + * + * The output of {@link ListMlflowTrackingServersCommand}. + */ +export interface ListMlflowTrackingServersCommandOutput extends ListMlflowTrackingServersResponse, __MetadataBearer {} + +/** + *Lists all MLflow Tracking Servers.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, ListMlflowTrackingServersCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, ListMlflowTrackingServersCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const input = { // ListMlflowTrackingServersRequest + * CreatedAfter: new Date("TIMESTAMP"), + * CreatedBefore: new Date("TIMESTAMP"), + * TrackingServerStatus: "Creating" || "Created" || "CreateFailed" || "Updating" || "Updated" || "UpdateFailed" || "Deleting" || "DeleteFailed" || "Stopping" || "Stopped" || "StopFailed" || "Starting" || "Started" || "StartFailed" || "MaintenanceInProgress" || "MaintenanceComplete" || "MaintenanceFailed", + * MlflowVersion: "STRING_VALUE", + * SortBy: "Name" || "CreationTime" || "Status", + * SortOrder: "Ascending" || "Descending", + * NextToken: "STRING_VALUE", + * MaxResults: Number("int"), + * }; + * const command = new ListMlflowTrackingServersCommand(input); + * const response = await client.send(command); + * // { // ListMlflowTrackingServersResponse + * // TrackingServerSummaries: [ // TrackingServerSummaryList + * // { // TrackingServerSummary + * // TrackingServerArn: "STRING_VALUE", + * // TrackingServerName: "STRING_VALUE", + * // CreationTime: new Date("TIMESTAMP"), + * // LastModifiedTime: new Date("TIMESTAMP"), + * // TrackingServerStatus: "Creating" || "Created" || "CreateFailed" || "Updating" || "Updated" || "UpdateFailed" || "Deleting" || "DeleteFailed" || "Stopping" || "Stopped" || "StopFailed" || "Starting" || "Started" || "StartFailed" || "MaintenanceInProgress" || "MaintenanceComplete" || "MaintenanceFailed", + * // IsActive: "Active" || "Inactive", + * // MlflowVersion: "STRING_VALUE", + * // }, + * // ], + * // NextToken: "STRING_VALUE", + * // }; + * + * ``` + * + * @param ListMlflowTrackingServersCommandInput - {@link ListMlflowTrackingServersCommandInput} + * @returns {@link ListMlflowTrackingServersCommandOutput} + * @see {@link ListMlflowTrackingServersCommandInput} for command's `input` shape. + * @see {@link ListMlflowTrackingServersCommandOutput} 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 ListMlflowTrackingServersCommand extends $Command + .classBuilder< + ListMlflowTrackingServersCommandInput, + ListMlflowTrackingServersCommandOutput, + 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", "ListMlflowTrackingServers", {}) + .n("SageMakerClient", "ListMlflowTrackingServersCommand") + .f(void 0, void 0) + .ser(se_ListMlflowTrackingServersCommand) + .de(de_ListMlflowTrackingServersCommand) + .build() {} diff --git a/clients/client-sagemaker/src/commands/ListMonitoringAlertsCommand.ts b/clients/client-sagemaker/src/commands/ListMonitoringAlertsCommand.ts index da1ba7c6a853b..36687d334ed78 100644 --- a/clients/client-sagemaker/src/commands/ListMonitoringAlertsCommand.ts +++ b/clients/client-sagemaker/src/commands/ListMonitoringAlertsCommand.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 { ListMonitoringAlertsRequest, ListMonitoringAlertsResponse } from "../models/models_3"; +import { ListMonitoringAlertsRequest } from "../models/models_3"; +import { ListMonitoringAlertsResponse } from "../models/models_4"; import { de_ListMonitoringAlertsCommand, se_ListMonitoringAlertsCommand } from "../protocols/Aws_json1_1"; import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; diff --git a/clients/client-sagemaker/src/commands/ListMonitoringExecutionsCommand.ts b/clients/client-sagemaker/src/commands/ListMonitoringExecutionsCommand.ts index 36e60b9f244eb..532f56cc04661 100644 --- a/clients/client-sagemaker/src/commands/ListMonitoringExecutionsCommand.ts +++ b/clients/client-sagemaker/src/commands/ListMonitoringExecutionsCommand.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 { ListMonitoringExecutionsRequest, ListMonitoringExecutionsResponse } from "../models/models_3"; +import { ListMonitoringExecutionsRequest, ListMonitoringExecutionsResponse } from "../models/models_4"; import { de_ListMonitoringExecutionsCommand, se_ListMonitoringExecutionsCommand } from "../protocols/Aws_json1_1"; import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; diff --git a/clients/client-sagemaker/src/commands/ListMonitoringSchedulesCommand.ts b/clients/client-sagemaker/src/commands/ListMonitoringSchedulesCommand.ts index a2f5a68011d24..4d5f1aa8acf63 100644 --- a/clients/client-sagemaker/src/commands/ListMonitoringSchedulesCommand.ts +++ b/clients/client-sagemaker/src/commands/ListMonitoringSchedulesCommand.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 { ListMonitoringSchedulesRequest, ListMonitoringSchedulesResponse } from "../models/models_3"; +import { ListMonitoringSchedulesRequest, ListMonitoringSchedulesResponse } from "../models/models_4"; import { de_ListMonitoringSchedulesCommand, se_ListMonitoringSchedulesCommand } from "../protocols/Aws_json1_1"; import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; diff --git a/clients/client-sagemaker/src/commands/ListNotebookInstanceLifecycleConfigsCommand.ts b/clients/client-sagemaker/src/commands/ListNotebookInstanceLifecycleConfigsCommand.ts index fec51ed0d71da..a22f8f6201a63 100644 --- a/clients/client-sagemaker/src/commands/ListNotebookInstanceLifecycleConfigsCommand.ts +++ b/clients/client-sagemaker/src/commands/ListNotebookInstanceLifecycleConfigsCommand.ts @@ -8,7 +8,7 @@ import { commonParams } from "../endpoint/EndpointParameters"; import { ListNotebookInstanceLifecycleConfigsInput, ListNotebookInstanceLifecycleConfigsOutput, -} from "../models/models_3"; +} from "../models/models_4"; import { de_ListNotebookInstanceLifecycleConfigsCommand, se_ListNotebookInstanceLifecycleConfigsCommand, diff --git a/clients/client-sagemaker/src/commands/StartMlflowTrackingServerCommand.ts b/clients/client-sagemaker/src/commands/StartMlflowTrackingServerCommand.ts new file mode 100644 index 0000000000000..795a4c189d9c0 --- /dev/null +++ b/clients/client-sagemaker/src/commands/StartMlflowTrackingServerCommand.ts @@ -0,0 +1,89 @@ +// 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 { StartMlflowTrackingServerRequest, StartMlflowTrackingServerResponse } from "../models/models_4"; +import { de_StartMlflowTrackingServerCommand, se_StartMlflowTrackingServerCommand } from "../protocols/Aws_json1_1"; +import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link StartMlflowTrackingServerCommand}. + */ +export interface StartMlflowTrackingServerCommandInput extends StartMlflowTrackingServerRequest {} +/** + * @public + * + * The output of {@link StartMlflowTrackingServerCommand}. + */ +export interface StartMlflowTrackingServerCommandOutput extends StartMlflowTrackingServerResponse, __MetadataBearer {} + +/** + *Programmatically start an MLflow Tracking Server.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, StartMlflowTrackingServerCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, StartMlflowTrackingServerCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const input = { // StartMlflowTrackingServerRequest + * TrackingServerName: "STRING_VALUE", // required + * }; + * const command = new StartMlflowTrackingServerCommand(input); + * const response = await client.send(command); + * // { // StartMlflowTrackingServerResponse + * // TrackingServerArn: "STRING_VALUE", + * // }; + * + * ``` + * + * @param StartMlflowTrackingServerCommandInput - {@link StartMlflowTrackingServerCommandInput} + * @returns {@link StartMlflowTrackingServerCommandOutput} + * @see {@link StartMlflowTrackingServerCommandInput} for command's `input` shape. + * @see {@link StartMlflowTrackingServerCommandOutput} 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 StartMlflowTrackingServerCommand extends $Command + .classBuilder< + StartMlflowTrackingServerCommandInput, + StartMlflowTrackingServerCommandOutput, + 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", "StartMlflowTrackingServer", {}) + .n("SageMakerClient", "StartMlflowTrackingServerCommand") + .f(void 0, void 0) + .ser(se_StartMlflowTrackingServerCommand) + .de(de_StartMlflowTrackingServerCommand) + .build() {} diff --git a/clients/client-sagemaker/src/commands/StopMlflowTrackingServerCommand.ts b/clients/client-sagemaker/src/commands/StopMlflowTrackingServerCommand.ts new file mode 100644 index 0000000000000..b01bee7811290 --- /dev/null +++ b/clients/client-sagemaker/src/commands/StopMlflowTrackingServerCommand.ts @@ -0,0 +1,89 @@ +// 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 { StopMlflowTrackingServerRequest, StopMlflowTrackingServerResponse } from "../models/models_4"; +import { de_StopMlflowTrackingServerCommand, se_StopMlflowTrackingServerCommand } from "../protocols/Aws_json1_1"; +import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link StopMlflowTrackingServerCommand}. + */ +export interface StopMlflowTrackingServerCommandInput extends StopMlflowTrackingServerRequest {} +/** + * @public + * + * The output of {@link StopMlflowTrackingServerCommand}. + */ +export interface StopMlflowTrackingServerCommandOutput extends StopMlflowTrackingServerResponse, __MetadataBearer {} + +/** + *Programmatically stop an MLflow Tracking Server.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, StopMlflowTrackingServerCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, StopMlflowTrackingServerCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const input = { // StopMlflowTrackingServerRequest + * TrackingServerName: "STRING_VALUE", // required + * }; + * const command = new StopMlflowTrackingServerCommand(input); + * const response = await client.send(command); + * // { // StopMlflowTrackingServerResponse + * // TrackingServerArn: "STRING_VALUE", + * // }; + * + * ``` + * + * @param StopMlflowTrackingServerCommandInput - {@link StopMlflowTrackingServerCommandInput} + * @returns {@link StopMlflowTrackingServerCommandOutput} + * @see {@link StopMlflowTrackingServerCommandInput} for command's `input` shape. + * @see {@link StopMlflowTrackingServerCommandOutput} 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 StopMlflowTrackingServerCommand extends $Command + .classBuilder< + StopMlflowTrackingServerCommandInput, + StopMlflowTrackingServerCommandOutput, + 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", "StopMlflowTrackingServer", {}) + .n("SageMakerClient", "StopMlflowTrackingServerCommand") + .f(void 0, void 0) + .ser(se_StopMlflowTrackingServerCommand) + .de(de_StopMlflowTrackingServerCommand) + .build() {} diff --git a/clients/client-sagemaker/src/commands/UpdateClusterCommand.ts b/clients/client-sagemaker/src/commands/UpdateClusterCommand.ts index 3a21741d5b42b..ef70a32989b96 100644 --- a/clients/client-sagemaker/src/commands/UpdateClusterCommand.ts +++ b/clients/client-sagemaker/src/commands/UpdateClusterCommand.ts @@ -48,6 +48,13 @@ export interface UpdateClusterCommandOutput extends UpdateClusterResponse, __Met * }, * ExecutionRole: "STRING_VALUE", // required * ThreadsPerCore: Number("int"), + * InstanceStorageConfigs: [ // ClusterInstanceStorageConfigs + * { // ClusterInstanceStorageConfig Union: only one key present + * EbsVolumeConfig: { // ClusterEbsVolumeConfig + * VolumeSizeInGB: Number("int"), // required + * }, + * }, + * ], * }, * ], * }; diff --git a/clients/client-sagemaker/src/commands/UpdateMlflowTrackingServerCommand.ts b/clients/client-sagemaker/src/commands/UpdateMlflowTrackingServerCommand.ts new file mode 100644 index 0000000000000..ad48ded701c7f --- /dev/null +++ b/clients/client-sagemaker/src/commands/UpdateMlflowTrackingServerCommand.ts @@ -0,0 +1,97 @@ +// 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 { UpdateMlflowTrackingServerRequest, UpdateMlflowTrackingServerResponse } from "../models/models_4"; +import { de_UpdateMlflowTrackingServerCommand, se_UpdateMlflowTrackingServerCommand } from "../protocols/Aws_json1_1"; +import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link UpdateMlflowTrackingServerCommand}. + */ +export interface UpdateMlflowTrackingServerCommandInput extends UpdateMlflowTrackingServerRequest {} +/** + * @public + * + * The output of {@link UpdateMlflowTrackingServerCommand}. + */ +export interface UpdateMlflowTrackingServerCommandOutput extends UpdateMlflowTrackingServerResponse, __MetadataBearer {} + +/** + *Updates properties of an existing MLflow Tracking Server.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, UpdateMlflowTrackingServerCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, UpdateMlflowTrackingServerCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const input = { // UpdateMlflowTrackingServerRequest + * TrackingServerName: "STRING_VALUE", // required + * ArtifactStoreUri: "STRING_VALUE", + * TrackingServerSize: "Small" || "Medium" || "Large", + * AutomaticModelRegistration: true || false, + * WeeklyMaintenanceWindowStart: "STRING_VALUE", + * }; + * const command = new UpdateMlflowTrackingServerCommand(input); + * const response = await client.send(command); + * // { // UpdateMlflowTrackingServerResponse + * // TrackingServerArn: "STRING_VALUE", + * // }; + * + * ``` + * + * @param UpdateMlflowTrackingServerCommandInput - {@link UpdateMlflowTrackingServerCommandInput} + * @returns {@link UpdateMlflowTrackingServerCommandOutput} + * @see {@link UpdateMlflowTrackingServerCommandInput} for command's `input` shape. + * @see {@link UpdateMlflowTrackingServerCommandOutput} 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 UpdateMlflowTrackingServerCommand extends $Command + .classBuilder< + UpdateMlflowTrackingServerCommandInput, + UpdateMlflowTrackingServerCommandOutput, + 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", "UpdateMlflowTrackingServer", {}) + .n("SageMakerClient", "UpdateMlflowTrackingServerCommand") + .f(void 0, void 0) + .ser(se_UpdateMlflowTrackingServerCommand) + .de(de_UpdateMlflowTrackingServerCommand) + .build() {} diff --git a/clients/client-sagemaker/src/commands/index.ts b/clients/client-sagemaker/src/commands/index.ts index 16e4a363e33cc..36b9e9534c86f 100644 --- a/clients/client-sagemaker/src/commands/index.ts +++ b/clients/client-sagemaker/src/commands/index.ts @@ -34,6 +34,7 @@ export * from "./CreateInferenceComponentCommand"; export * from "./CreateInferenceExperimentCommand"; export * from "./CreateInferenceRecommendationsJobCommand"; export * from "./CreateLabelingJobCommand"; +export * from "./CreateMlflowTrackingServerCommand"; export * from "./CreateModelBiasJobDefinitionCommand"; export * from "./CreateModelCardCommand"; export * from "./CreateModelCardExportJobCommand"; @@ -47,6 +48,7 @@ export * from "./CreateNotebookInstanceCommand"; export * from "./CreateNotebookInstanceLifecycleConfigCommand"; export * from "./CreatePipelineCommand"; export * from "./CreatePresignedDomainUrlCommand"; +export * from "./CreatePresignedMlflowTrackingServerUrlCommand"; export * from "./CreatePresignedNotebookInstanceUrlCommand"; export * from "./CreateProcessingJobCommand"; export * from "./CreateProjectCommand"; @@ -87,6 +89,7 @@ export * from "./DeleteImageCommand"; export * from "./DeleteImageVersionCommand"; export * from "./DeleteInferenceComponentCommand"; export * from "./DeleteInferenceExperimentCommand"; +export * from "./DeleteMlflowTrackingServerCommand"; export * from "./DeleteModelBiasJobDefinitionCommand"; export * from "./DeleteModelCardCommand"; export * from "./DeleteModelCommand"; @@ -144,6 +147,7 @@ export * from "./DescribeInferenceExperimentCommand"; export * from "./DescribeInferenceRecommendationsJobCommand"; export * from "./DescribeLabelingJobCommand"; export * from "./DescribeLineageGroupCommand"; +export * from "./DescribeMlflowTrackingServerCommand"; export * from "./DescribeModelBiasJobDefinitionCommand"; export * from "./DescribeModelCardCommand"; export * from "./DescribeModelCardExportJobCommand"; @@ -219,6 +223,7 @@ export * from "./ListInferenceRecommendationsJobsCommand"; export * from "./ListLabelingJobsCommand"; export * from "./ListLabelingJobsForWorkteamCommand"; export * from "./ListLineageGroupsCommand"; +export * from "./ListMlflowTrackingServersCommand"; export * from "./ListModelBiasJobDefinitionsCommand"; export * from "./ListModelCardExportJobsCommand"; export * from "./ListModelCardVersionsCommand"; @@ -265,6 +270,7 @@ export * from "./SendPipelineExecutionStepFailureCommand"; export * from "./SendPipelineExecutionStepSuccessCommand"; export * from "./StartEdgeDeploymentStageCommand"; export * from "./StartInferenceExperimentCommand"; +export * from "./StartMlflowTrackingServerCommand"; export * from "./StartMonitoringScheduleCommand"; export * from "./StartNotebookInstanceCommand"; export * from "./StartPipelineExecutionCommand"; @@ -276,6 +282,7 @@ export * from "./StopHyperParameterTuningJobCommand"; export * from "./StopInferenceExperimentCommand"; export * from "./StopInferenceRecommendationsJobCommand"; export * from "./StopLabelingJobCommand"; +export * from "./StopMlflowTrackingServerCommand"; export * from "./StopMonitoringScheduleCommand"; export * from "./StopNotebookInstanceCommand"; export * from "./StopPipelineExecutionCommand"; @@ -303,6 +310,7 @@ export * from "./UpdateImageVersionCommand"; export * from "./UpdateInferenceComponentCommand"; export * from "./UpdateInferenceComponentRuntimeConfigCommand"; export * from "./UpdateInferenceExperimentCommand"; +export * from "./UpdateMlflowTrackingServerCommand"; export * from "./UpdateModelCardCommand"; export * from "./UpdateModelPackageCommand"; export * from "./UpdateMonitoringAlertCommand"; diff --git a/clients/client-sagemaker/src/models/models_0.ts b/clients/client-sagemaker/src/models/models_0.ts index 3ed7f35837034..1b42e7937c554 100644 --- a/clients/client-sagemaker/src/models/models_0.ts +++ b/clients/client-sagemaker/src/models/models_0.ts @@ -8918,6 +8918,66 @@ export interface ClarifyExplainerConfig { ShapConfig: ClarifyShapConfig | undefined; } +/** + *Defines the configuration for attaching an additional Amazon Elastic Block Store (EBS) + * volume to each instance of the SageMaker HyperPod cluster instance group.
+ * @public + */ +export interface ClusterEbsVolumeConfig { + /** + *The size in gigabytes (GB) of the additional EBS volume to be attached to the instances
+ * in the SageMaker HyperPod cluster instance group. The additional EBS volume is attached to each
+ * instance within the SageMaker HyperPod cluster instance group and mounted to
+ * /opt/sagemaker.
Defines the configuration for attaching additional storage to the instances in the + * SageMaker HyperPod cluster instance group.
+ * @public + */ +export type ClusterInstanceStorageConfig = + | ClusterInstanceStorageConfig.EbsVolumeConfigMember + | ClusterInstanceStorageConfig.$UnknownMember; + +/** + * @public + */ +export namespace ClusterInstanceStorageConfig { + /** + *Defines the configuration for attaching additional Amazon Elastic Block Store (EBS)
+ * volumes to the instances in the SageMaker HyperPod cluster instance group. The additional EBS volume is
+ * attached to each instance within the SageMaker HyperPod cluster instance group and mounted to
+ * /opt/sagemaker.
The number of instances that are currently in the instance group of a - * SageMaker HyperPod cluster.
+ *The number of instances that are currently in the instance group of a SageMaker HyperPod + * cluster.
* @public */ CurrentCount?: number; /** - *The number of instances you specified to add to the instance group of a SageMaker HyperPod cluster.
+ *The number of instances you specified to add to the instance group of a SageMaker HyperPod + * cluster.
* @public */ TargetCount?: number; @@ -9040,11 +9101,19 @@ export interface ClusterInstanceGroupDetails { *The number you specified to TreadsPerCore in CreateCluster for
* enabling or disabling multithreading. For instance types that support multithreading, you
* can specify 1 for disabling multithreading and 2 for enabling multithreading. For more
- * information, see the reference table of CPU cores and threads per CPU core per instance type in the Amazon Elastic Compute Cloud
- * User Guide.
The additional storage configurations for the instances in the SageMaker HyperPod cluster instance + * group.
+ * @public + */ + InstanceStorageConfigs?: ClusterInstanceStorageConfig[]; } /** @@ -9053,7 +9122,8 @@ export interface ClusterInstanceGroupDetails { */ export interface ClusterInstanceGroupSpecification { /** - *Specifies the number of instances to add to the instance group of a SageMaker HyperPod cluster.
+ *Specifies the number of instances to add to the instance group of a SageMaker HyperPod + * cluster.
* @public */ InstanceCount: number | undefined; @@ -9083,15 +9153,23 @@ export interface ClusterInstanceGroupSpecification { ExecutionRole: string | undefined; /** - *Specifies the value for Threads per core. For instance types that
- * support multithreading, you can specify 1 for disabling multithreading and
- * 2 for enabling multithreading. For instance types that doesn't support
- * multithreading, specify 1. For more information, see the reference table of
- * CPU cores and threads per CPU core per instance type in the Amazon Elastic Compute Cloud
- * User Guide.
Specifies the value for Threads per core. For instance
+ * types that support multithreading, you can specify 1 for disabling
+ * multithreading and 2 for enabling multithreading. For instance types that
+ * doesn't support multithreading, specify 1. For more information, see the
+ * reference table of CPU cores and
+ * threads per CPU core per instance type in the Amazon Elastic Compute Cloud User
+ * Guide.
Specifies the additional storage configurations for the instances in the SageMaker HyperPod cluster + * instance group.
+ * @public + */ + InstanceStorageConfigs?: ClusterInstanceStorageConfig[]; } /** @@ -9198,6 +9276,13 @@ export interface ClusterNodeDetails { */ ThreadsPerCore?: number; + /** + *The configurations of additional storage specified to the instance group where the + * instance (node) is launched.
+ * @public + */ + InstanceStorageConfigs?: ClusterInstanceStorageConfig[]; + /** *The private primary IP address of the SageMaker HyperPod cluster node.
* @public @@ -11198,7 +11283,8 @@ export interface CreateClusterRequest { *Custom tags for managing the SageMaker HyperPod cluster as an Amazon Web Services resource. You can * add tags to your cluster in the same way you add them in other Amazon Web Services services * that support tagging. To learn more about tagging Amazon Web Services resources in general, - * see Tagging Amazon Web Services Resources User Guide.
+ * see Tagging + * Amazon Web Services Resources User Guide. * @public */ Tags?: Tag[]; @@ -11252,403 +11338,3 @@ export interface CreateCodeRepositoryOutput { */ CodeRepositoryArn: string | undefined; } - -/** - * @public - * @enum - */ -export const Framework = { - DARKNET: "DARKNET", - KERAS: "KERAS", - MXNET: "MXNET", - ONNX: "ONNX", - PYTORCH: "PYTORCH", - SKLEARN: "SKLEARN", - TENSORFLOW: "TENSORFLOW", - TFLITE: "TFLITE", - XGBOOST: "XGBOOST", -} as const; - -/** - * @public - */ -export type Framework = (typeof Framework)[keyof typeof Framework]; - -/** - *Contains information about the location of input model artifacts, the name and - * shape - * of the expected data inputs, and the framework in which the model was trained.
- * @public - */ -export interface InputConfig { - /** - *The S3 path where the model artifacts, which result from model training, are stored. - * This path must point to a single gzip compressed tar archive (.tar.gz suffix).
- * @public - */ - S3Uri: string | undefined; - - /** - *Specifies the name and shape of the expected data inputs for your trained model with a
- * JSON dictionary form. The data inputs are Framework specific.
- * TensorFlow: You must specify the name and shape (NHWC format) of
- * the expected data inputs using a dictionary format for your trained model. The
- * dictionary formats required for the console and CLI are different.
Examples for one input:
- *If using the console,
- * \{"input":[1,1024,1024,3]\}
- *
If using the CLI,
- * \{\"input\":[1,1024,1024,3]\}
- *
Examples for two inputs:
- *If using the console, \{"data1": [1,28,28,1],
- * "data2":[1,28,28,1]\}
- *
If using the CLI, \{\"data1\": [1,28,28,1],
- * \"data2\":[1,28,28,1]\}
- *
- * KERAS: You must specify the name and shape (NCHW format) of
- * expected data inputs using a dictionary format for your trained model. Note that
- * while Keras model artifacts should be uploaded in NHWC (channel-last) format,
- * DataInputConfig should be specified in NCHW (channel-first)
- * format. The dictionary formats required for the console and CLI are
- * different.
Examples for one input:
- *If using the console,
- * \{"input_1":[1,3,224,224]\}
- *
If using the CLI,
- * \{\"input_1\":[1,3,224,224]\}
- *
Examples for two inputs:
- *If using the console, \{"input_1": [1,3,224,224],
- * "input_2":[1,3,224,224]\}
- *
If using the CLI, \{\"input_1\": [1,3,224,224],
- * \"input_2\":[1,3,224,224]\}
- *
- * MXNET/ONNX/DARKNET: You must specify the name and shape (NCHW
- * format) of the expected data inputs in order using a dictionary format for your
- * trained model. The dictionary formats required for the console and CLI are
- * different.
Examples for one input:
- *If using the console,
- * \{"data":[1,3,1024,1024]\}
- *
If using the CLI,
- * \{\"data\":[1,3,1024,1024]\}
- *
Examples for two inputs:
- *If using the console, \{"var1": [1,1,28,28],
- * "var2":[1,1,28,28]\}
- *
If using the CLI, \{\"var1\": [1,1,28,28],
- * \"var2\":[1,1,28,28]\}
- *
- * PyTorch: You can either specify the name and shape (NCHW format)
- * of expected data inputs in order using a dictionary format for your trained
- * model or you can specify the shape only using a list format. The dictionary
- * formats required for the console and CLI are different. The list formats for the
- * console and CLI are the same.
Examples for one input in dictionary format:
- *If using the console,
- * \{"input0":[1,3,224,224]\}
- *
If using the CLI,
- * \{\"input0\":[1,3,224,224]\}
- *
Example for one input in list format:
- * [[1,3,224,224]]
- *
Examples for two inputs in dictionary format:
- *If using the console, \{"input0":[1,3,224,224],
- * "input1":[1,3,224,224]\}
- *
If using the CLI, \{\"input0\":[1,3,224,224],
- * \"input1\":[1,3,224,224]\}
- *
Example for two inputs in list format: [[1,3,224,224],
- * [1,3,224,224]]
- *
- * XGBOOST: input data name and shape are not needed.
- * DataInputConfig supports the following parameters for CoreML
- * TargetDevice (ML Model format):
- * shape: Input shape, for example \{"input_1": \{"shape":
- * [1,224,224,3]\}\}. In addition to static input shapes, CoreML converter
- * supports Flexible input shapes:
Range Dimension. You can use the Range Dimension feature if you know
- * the input shape will be within some specific interval in that dimension,
- * for example: \{"input_1": \{"shape": ["1..10", 224, 224,
- * 3]\}\}
- *
Enumerated shapes. Sometimes, the models are trained to work only on a
- * select set of inputs. You can enumerate all supported input shapes, for
- * example: \{"input_1": \{"shape": [[1, 224, 224, 3], [1, 160, 160,
- * 3]]\}\}
- *
- * default_shape: Default input shape. You can set a default shape
- * during conversion for both Range Dimension and Enumerated Shapes. For example
- * \{"input_1": \{"shape": ["1..10", 224, 224, 3], "default_shape": [1,
- * 224, 224, 3]\}\}
- *
- * type: Input type. Allowed values: Image and
- * Tensor. By default, the converter generates an ML Model with
- * inputs of type Tensor (MultiArray). User can set input type to be Image. Image
- * input type requires additional input parameters such as bias and
- * scale.
- * bias: If the input type is an Image, you need to provide the bias
- * vector.
- * scale: If the input type is an Image, you need to provide a scale
- * factor.
CoreML ClassifierConfig parameters can be specified using OutputConfig
- * CompilerOptions. CoreML converter supports Tensorflow and PyTorch models.
- * CoreML conversion examples:
Tensor type input:
- *
- * "DataInputConfig": \{"input_1": \{"shape": [[1,224,224,3],
- * [1,160,160,3]], "default_shape": [1,224,224,3]\}\}
- *
Tensor type input without input name (PyTorch):
- *
- * "DataInputConfig": [\{"shape": [[1,3,224,224], [1,3,160,160]],
- * "default_shape": [1,3,224,224]\}]
- *
Image type input:
- *
- * "DataInputConfig": \{"input_1": \{"shape": [[1,224,224,3],
- * [1,160,160,3]], "default_shape": [1,224,224,3], "type": "Image",
- * "bias": [-1,-1,-1], "scale": 0.007843137255\}\}
- *
- * "CompilerOptions": \{"class_labels":
- * "imagenet_labels_1000.txt"\}
- *
Image type input without input name (PyTorch):
- *
- * "DataInputConfig": [\{"shape": [[1,3,224,224], [1,3,160,160]],
- * "default_shape": [1,3,224,224], "type": "Image", "bias": [-1,-1,-1],
- * "scale": 0.007843137255\}]
- *
- * "CompilerOptions": \{"class_labels":
- * "imagenet_labels_1000.txt"\}
- *
Depending on the model format, DataInputConfig requires the following
- * parameters for ml_eia2
- * OutputConfig:TargetDevice.
For TensorFlow models saved in the SavedModel format, specify the input names
- * from signature_def_key and the input model shapes for
- * DataInputConfig. Specify the signature_def_key in
- *
- * OutputConfig:CompilerOptions
- * if the model does not
- * use TensorFlow's default signature def key. For example:
- * "DataInputConfig": \{"inputs": [1, 224, 224, 3]\}
- *
- * "CompilerOptions": \{"signature_def_key":
- * "serving_custom"\}
- *
For TensorFlow models saved as a frozen graph, specify the input tensor names
- * and shapes in DataInputConfig and the output tensor names for
- * output_names in
- * OutputConfig:CompilerOptions
- * . For
- * example:
- * "DataInputConfig": \{"input_tensor:0": [1, 224, 224,
- * 3]\}
- *
- * "CompilerOptions": \{"output_names":
- * ["output_tensor:0"]\}
- *
Identifies the framework in which the model was trained. For example: - * TENSORFLOW.
- * @public - */ - Framework: Framework | undefined; - - /** - *Specifies the framework version to use. This API field is only supported for the - * MXNet, PyTorch, TensorFlow and TensorFlow Lite frameworks.
- *For information about framework versions supported for cloud targets and edge devices, - * see Cloud - * Supported Instance Types and Frameworks and Edge Supported - * Frameworks.
- * @public - */ - FrameworkVersion?: string; -} diff --git a/clients/client-sagemaker/src/models/models_1.ts b/clients/client-sagemaker/src/models/models_1.ts index d886e37ad1a16..d5ba3d1bf35f0 100644 --- a/clients/client-sagemaker/src/models/models_1.ts +++ b/clients/client-sagemaker/src/models/models_1.ts @@ -7,7 +7,6 @@ import { AppNetworkAccessType, AppSecurityGroupManagement, AppSpecification, - AppType, AsyncInferenceConfig, AthenaDatasetDefinition, AuthMode, @@ -42,7 +41,6 @@ import { HyperParameterScalingType, HyperParameterTuningJobObjective, InferenceSpecification, - InputConfig, MetadataProperties, MetricDefinition, MetricsSource, @@ -66,6 +64,406 @@ import { VpcConfig, } from "./models_0"; +/** + * @public + * @enum + */ +export const Framework = { + DARKNET: "DARKNET", + KERAS: "KERAS", + MXNET: "MXNET", + ONNX: "ONNX", + PYTORCH: "PYTORCH", + SKLEARN: "SKLEARN", + TENSORFLOW: "TENSORFLOW", + TFLITE: "TFLITE", + XGBOOST: "XGBOOST", +} as const; + +/** + * @public + */ +export type Framework = (typeof Framework)[keyof typeof Framework]; + +/** + *Contains information about the location of input model artifacts, the name and + * shape + * of the expected data inputs, and the framework in which the model was trained.
+ * @public + */ +export interface InputConfig { + /** + *The S3 path where the model artifacts, which result from model training, are stored. + * This path must point to a single gzip compressed tar archive (.tar.gz suffix).
+ * @public + */ + S3Uri: string | undefined; + + /** + *Specifies the name and shape of the expected data inputs for your trained model with a
+ * JSON dictionary form. The data inputs are Framework specific.
+ * TensorFlow: You must specify the name and shape (NHWC format) of
+ * the expected data inputs using a dictionary format for your trained model. The
+ * dictionary formats required for the console and CLI are different.
Examples for one input:
+ *If using the console,
+ * \{"input":[1,1024,1024,3]\}
+ *
If using the CLI,
+ * \{\"input\":[1,1024,1024,3]\}
+ *
Examples for two inputs:
+ *If using the console, \{"data1": [1,28,28,1],
+ * "data2":[1,28,28,1]\}
+ *
If using the CLI, \{\"data1\": [1,28,28,1],
+ * \"data2\":[1,28,28,1]\}
+ *
+ * KERAS: You must specify the name and shape (NCHW format) of
+ * expected data inputs using a dictionary format for your trained model. Note that
+ * while Keras model artifacts should be uploaded in NHWC (channel-last) format,
+ * DataInputConfig should be specified in NCHW (channel-first)
+ * format. The dictionary formats required for the console and CLI are
+ * different.
Examples for one input:
+ *If using the console,
+ * \{"input_1":[1,3,224,224]\}
+ *
If using the CLI,
+ * \{\"input_1\":[1,3,224,224]\}
+ *
Examples for two inputs:
+ *If using the console, \{"input_1": [1,3,224,224],
+ * "input_2":[1,3,224,224]\}
+ *
If using the CLI, \{\"input_1\": [1,3,224,224],
+ * \"input_2\":[1,3,224,224]\}
+ *
+ * MXNET/ONNX/DARKNET: You must specify the name and shape (NCHW
+ * format) of the expected data inputs in order using a dictionary format for your
+ * trained model. The dictionary formats required for the console and CLI are
+ * different.
Examples for one input:
+ *If using the console,
+ * \{"data":[1,3,1024,1024]\}
+ *
If using the CLI,
+ * \{\"data\":[1,3,1024,1024]\}
+ *
Examples for two inputs:
+ *If using the console, \{"var1": [1,1,28,28],
+ * "var2":[1,1,28,28]\}
+ *
If using the CLI, \{\"var1\": [1,1,28,28],
+ * \"var2\":[1,1,28,28]\}
+ *
+ * PyTorch: You can either specify the name and shape (NCHW format)
+ * of expected data inputs in order using a dictionary format for your trained
+ * model or you can specify the shape only using a list format. The dictionary
+ * formats required for the console and CLI are different. The list formats for the
+ * console and CLI are the same.
Examples for one input in dictionary format:
+ *If using the console,
+ * \{"input0":[1,3,224,224]\}
+ *
If using the CLI,
+ * \{\"input0\":[1,3,224,224]\}
+ *
Example for one input in list format:
+ * [[1,3,224,224]]
+ *
Examples for two inputs in dictionary format:
+ *If using the console, \{"input0":[1,3,224,224],
+ * "input1":[1,3,224,224]\}
+ *
If using the CLI, \{\"input0\":[1,3,224,224],
+ * \"input1\":[1,3,224,224]\}
+ *
Example for two inputs in list format: [[1,3,224,224],
+ * [1,3,224,224]]
+ *
+ * XGBOOST: input data name and shape are not needed.
+ * DataInputConfig supports the following parameters for CoreML
+ * TargetDevice (ML Model format):
+ * shape: Input shape, for example \{"input_1": \{"shape":
+ * [1,224,224,3]\}\}. In addition to static input shapes, CoreML converter
+ * supports Flexible input shapes:
Range Dimension. You can use the Range Dimension feature if you know
+ * the input shape will be within some specific interval in that dimension,
+ * for example: \{"input_1": \{"shape": ["1..10", 224, 224,
+ * 3]\}\}
+ *
Enumerated shapes. Sometimes, the models are trained to work only on a
+ * select set of inputs. You can enumerate all supported input shapes, for
+ * example: \{"input_1": \{"shape": [[1, 224, 224, 3], [1, 160, 160,
+ * 3]]\}\}
+ *
+ * default_shape: Default input shape. You can set a default shape
+ * during conversion for both Range Dimension and Enumerated Shapes. For example
+ * \{"input_1": \{"shape": ["1..10", 224, 224, 3], "default_shape": [1,
+ * 224, 224, 3]\}\}
+ *
+ * type: Input type. Allowed values: Image and
+ * Tensor. By default, the converter generates an ML Model with
+ * inputs of type Tensor (MultiArray). User can set input type to be Image. Image
+ * input type requires additional input parameters such as bias and
+ * scale.
+ * bias: If the input type is an Image, you need to provide the bias
+ * vector.
+ * scale: If the input type is an Image, you need to provide a scale
+ * factor.
CoreML ClassifierConfig parameters can be specified using OutputConfig
+ * CompilerOptions. CoreML converter supports Tensorflow and PyTorch models.
+ * CoreML conversion examples:
Tensor type input:
+ *
+ * "DataInputConfig": \{"input_1": \{"shape": [[1,224,224,3],
+ * [1,160,160,3]], "default_shape": [1,224,224,3]\}\}
+ *
Tensor type input without input name (PyTorch):
+ *
+ * "DataInputConfig": [\{"shape": [[1,3,224,224], [1,3,160,160]],
+ * "default_shape": [1,3,224,224]\}]
+ *
Image type input:
+ *
+ * "DataInputConfig": \{"input_1": \{"shape": [[1,224,224,3],
+ * [1,160,160,3]], "default_shape": [1,224,224,3], "type": "Image",
+ * "bias": [-1,-1,-1], "scale": 0.007843137255\}\}
+ *
+ * "CompilerOptions": \{"class_labels":
+ * "imagenet_labels_1000.txt"\}
+ *
Image type input without input name (PyTorch):
+ *
+ * "DataInputConfig": [\{"shape": [[1,3,224,224], [1,3,160,160]],
+ * "default_shape": [1,3,224,224], "type": "Image", "bias": [-1,-1,-1],
+ * "scale": 0.007843137255\}]
+ *
+ * "CompilerOptions": \{"class_labels":
+ * "imagenet_labels_1000.txt"\}
+ *
Depending on the model format, DataInputConfig requires the following
+ * parameters for ml_eia2
+ * OutputConfig:TargetDevice.
For TensorFlow models saved in the SavedModel format, specify the input names
+ * from signature_def_key and the input model shapes for
+ * DataInputConfig. Specify the signature_def_key in
+ *
+ * OutputConfig:CompilerOptions
+ * if the model does not
+ * use TensorFlow's default signature def key. For example:
+ * "DataInputConfig": \{"inputs": [1, 224, 224, 3]\}
+ *
+ * "CompilerOptions": \{"signature_def_key":
+ * "serving_custom"\}
+ *
For TensorFlow models saved as a frozen graph, specify the input tensor names
+ * and shapes in DataInputConfig and the output tensor names for
+ * output_names in
+ * OutputConfig:CompilerOptions
+ * . For
+ * example:
+ * "DataInputConfig": \{"input_tensor:0": [1, 224, 224,
+ * 3]\}
+ *
+ * "CompilerOptions": \{"output_names":
+ * ["output_tensor:0"]\}
+ *
Identifies the framework in which the model was trained. For example: + * TENSORFLOW.
+ * @public + */ + Framework: Framework | undefined; + + /** + *Specifies the framework version to use. This API field is only supported for the + * MXNet, PyTorch, TensorFlow and TensorFlow Lite frameworks.
+ *For information about framework versions supported for cloud targets and edge devices, + * see Cloud + * Supported Instance Types and Frameworks and Edge Supported + * Frameworks.
+ * @public + */ + FrameworkVersion?: string; +} + /** *Contains information about a target platform that you want your model to run on, such * as OS, architecture, and accelerators. It is an alternative of @@ -9170,6 +9568,98 @@ export interface CreateLabelingJobResponse { LabelingJobArn: string | undefined; } +/** + * @public + * @enum + */ +export const TrackingServerSize = { + L: "Large", + M: "Medium", + S: "Small", +} as const; + +/** + * @public + */ +export type TrackingServerSize = (typeof TrackingServerSize)[keyof typeof TrackingServerSize]; + +/** + * @public + */ +export interface CreateMlflowTrackingServerRequest { + /** + *
A unique string identifying the tracking server name. This string is part of the tracking server + * ARN.
+ * @public + */ + TrackingServerName: string | undefined; + + /** + *The S3 URI for a general purpose bucket to use as the MLflow Tracking Server artifact + * store.
+ * @public + */ + ArtifactStoreUri: string | undefined; + + /** + *The size of the tracking server you want to create. You can choose between
+ * "Small", "Medium", and "Large". The default MLflow
+ * Tracking Server configuration size is "Small". You can choose a size depending on
+ * the projected use of the tracking server such as the volume of data logged, number of users,
+ * and frequency of use.
We recommend using a small tracking server for teams of up to 25 users, a medium tracking + * server for teams of up to 50 users, and a large tracking server for teams of up to 100 users.
+ * @public + */ + TrackingServerSize?: TrackingServerSize; + + /** + *The version of MLflow that the tracking server uses. To see which MLflow versions are + * available to use, see How it works.
+ * @public + */ + MlflowVersion?: string; + + /** + *The Amazon Resource Name (ARN) for an IAM role in your account that the MLflow Tracking Server uses to
+ * access the artifact store in Amazon S3. The role should have AmazonS3FullAccess
+ * permissions. For more information on IAM permissions for tracking server creation, see
+ * Set up IAM permissions for MLflow.
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 day and time of the week in Coordinated Universal Time (UTC) 24-hour standard time that weekly maintenance updates are scheduled. For example: TUE:03:30.
+ * @public + */ + WeeklyMaintenanceWindowStart?: string; + + /** + *Tags consisting of key-value pairs used to manage metadata for the tracking server.
+ * @public + */ + Tags?: Tag[]; +} + +/** + * @public + */ +export interface CreateMlflowTrackingServerResponse { + /** + *The ARN of the tracking server.
+ * @public + */ + TrackingServerArn?: string; +} + /** * @public * @enum @@ -11385,6 +11875,41 @@ export interface CreatePresignedDomainUrlResponse { AuthorizedUrl?: string; } +/** + * @public + */ +export interface CreatePresignedMlflowTrackingServerUrlRequest { + /** + *The name of the tracking server to connect to your MLflow UI.
+ * @public + */ + TrackingServerName: string | undefined; + + /** + *The duration in seconds that your presigned URL is valid. The presigned URL can be used + * only once.
+ * @public + */ + ExpiresInSeconds?: number; + + /** + *The duration in seconds that your MLflow UI session is valid.
+ * @public + */ + SessionExpirationDurationInSeconds?: number; +} + +/** + * @public + */ +export interface CreatePresignedMlflowTrackingServerUrlResponse { + /** + *A presigned URL with an authorization token.
+ * @public + */ + AuthorizedUrl?: string; +} + /** * @public */ @@ -12174,164 +12699,6 @@ export interface EFSFileSystem { 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.$UnknownMember; - -/** - * @public - */ -export namespace CustomFileSystem { - /** - *A custom file system in Amazon EFS.
- * @public - */ - export interface EFSFileSystemMember { - EFSFileSystem: EFSFileSystem; - $unknown?: never; - } - - /** - * @public - */ - export interface $UnknownMember { - EFSFileSystem?: never; - $unknown: [string, any]; - } - - export interface VisitorThe settings for the JupyterLab application within a space.
- * @public - */ -export interface SpaceJupyterLabAppSettings { - /** - *Specifies the ARN's of a SageMaker image and SageMaker image version, and the instance type that - * the version runs on.
- * @public - */ - DefaultResourceSpec?: ResourceSpec; - - /** - *A list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterLab application.
- * @public - */ - CodeRepositories?: CodeRepository[]; -} - -/** - *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.
- * @public - */ - EbsVolumeSizeInGb: number | undefined; -} - -/** - *The storage settings for a space.
- * @public - */ -export interface SpaceStorageSettings { - /** - *A collection of EBS storage settings for a space.
- * @public - */ - EbsStorageSettings?: EbsStorageSettings; -} - -/** - *A collection of space settings.
- * @public - */ -export interface SpaceSettings { - /** - *The JupyterServer app settings.
- * @public - */ - JupyterServerAppSettings?: JupyterServerAppSettings; - - /** - *The KernelGateway app settings.
- * @public - */ - KernelGatewayAppSettings?: KernelGatewayAppSettings; - - /** - *The Code Editor application settings.
- * @public - */ - CodeEditorAppSettings?: SpaceCodeEditorAppSettings; - - /** - *The settings for the JupyterLab application.
- * @public - */ - JupyterLabAppSettings?: SpaceJupyterLabAppSettings; - - /** - *The type of app created within the space.
- * @public - */ - AppType?: AppType; - - /** - *The storage settings for a space.
- * @public - */ - SpaceStorageSettings?: SpaceStorageSettings; - - /** - *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 - */ - CustomFileSystems?: CustomFileSystem[]; -} - -/** - * @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 { - /** - *Specifies the sharing type of the space.
- * @public - */ - SharingType: SharingType | undefined; -} - /** * @internal */ diff --git a/clients/client-sagemaker/src/models/models_2.ts b/clients/client-sagemaker/src/models/models_2.ts index 1e437ef6f3c9a..c1a1c6887f52c 100644 --- a/clients/client-sagemaker/src/models/models_2.ts +++ b/clients/client-sagemaker/src/models/models_2.ts @@ -42,6 +42,7 @@ import { ClusterNodeDetails, ClusterStatus, CodeEditorAppImageConfig, + CodeRepository, CognitoConfig, CognitoMemberDefinition, CollectionConfiguration, @@ -51,7 +52,6 @@ import { GitConfig, HyperParameterTuningJobObjectiveType, InferenceSpecification, - InputConfig, JupyterLabAppImageConfig, KernelGatewayImageConfig, MetadataProperties, @@ -90,6 +90,7 @@ import { EdgeDeploymentModelConfig, EdgeOutputConfig, EdgePresetDeploymentType, + EFSFileSystem, EndpointInfo, ExperimentConfig, ExplainerConfig, @@ -110,8 +111,11 @@ import { InferenceExperimentDataStorageConfig, InferenceExperimentSchedule, InferenceExperimentType, + InputConfig, InstanceMetadataServiceConfiguration, JobType, + JupyterServerAppSettings, + KernelGatewayAppSettings, LabelingJobAlgorithmsConfig, LabelingJobInputConfig, LabelingJobOutputConfig, @@ -142,12 +146,10 @@ import { MonitoringType, NeoVpcConfig, NotebookInstanceAcceleratorType, - NotebookInstanceLifecycleHook, OfflineStoreConfig, OnlineStoreConfig, OutputConfig, OwnershipSettings, - ParallelismConfiguration, ProcessingInstanceType, Processor, ProductionVariant, @@ -163,13 +165,171 @@ import { ShadowModeConfig, SkipModelValidation, SourceAlgorithmSpecification, - SpaceSettings, - SpaceSharingSettings, + SpaceCodeEditorAppSettings, ThroughputMode, + TrackingServerSize, UserSettings, VendorGuidance, } from "./models_1"; +/** + *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; + +/** + * @public + */ +export namespace CustomFileSystem { + /** + *A custom file system in Amazon EFS.
+ * @public + */ + export interface EFSFileSystemMember { + EFSFileSystem: EFSFileSystem; + $unknown?: never; + } + + /** + * @public + */ + export interface $UnknownMember { + EFSFileSystem?: never; + $unknown: [string, any]; + } + + export interface VisitorThe settings for the JupyterLab application within a space.
+ * @public + */ +export interface SpaceJupyterLabAppSettings { + /** + *Specifies the ARN's of a SageMaker image and SageMaker image version, and the instance type that + * the version runs on.
+ * @public + */ + DefaultResourceSpec?: ResourceSpec; + + /** + *A list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterLab application.
+ * @public + */ + CodeRepositories?: CodeRepository[]; +} + +/** + *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.
+ * @public + */ + EbsVolumeSizeInGb: number | undefined; +} + +/** + *The storage settings for a space.
+ * @public + */ +export interface SpaceStorageSettings { + /** + *A collection of EBS storage settings for a space.
+ * @public + */ + EbsStorageSettings?: EbsStorageSettings; +} + +/** + *A collection of space settings.
+ * @public + */ +export interface SpaceSettings { + /** + *The JupyterServer app settings.
+ * @public + */ + JupyterServerAppSettings?: JupyterServerAppSettings; + + /** + *The KernelGateway app settings.
+ * @public + */ + KernelGatewayAppSettings?: KernelGatewayAppSettings; + + /** + *The Code Editor application settings.
+ * @public + */ + CodeEditorAppSettings?: SpaceCodeEditorAppSettings; + + /** + *The settings for the JupyterLab application.
+ * @public + */ + JupyterLabAppSettings?: SpaceJupyterLabAppSettings; + + /** + *The type of app created within the space.
+ * @public + */ + AppType?: AppType; + + /** + *The storage settings for a space.
+ * @public + */ + SpaceStorageSettings?: SpaceStorageSettings; + + /** + *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 + */ + CustomFileSystems?: CustomFileSystem[]; +} + +/** + * @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 { + /** + *Specifies the sharing type of the space.
+ * @public + */ + SharingType: SharingType | undefined; +} + /** * @public */ @@ -1444,7 +1604,7 @@ export interface OidcConfig { /** *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 login to their worker portal from an + * 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 */ @@ -1473,7 +1633,7 @@ export interface WorkforceVpcConfigRequest { VpcId?: string; /** - *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 VPC security group IDs, in the form sg-xxxxxxxx. The security groups must be for the same VPC as specified in the subnet.
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 login to their worker portal from an + * 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 */ @@ -2416,6 +2576,29 @@ export interface DeleteInferenceExperimentResponse { InferenceExperimentArn: string | undefined; } +/** + * @public + */ +export interface DeleteMlflowTrackingServerRequest { + /** + *The name of the the tracking server to delete.
+ * @public + */ + TrackingServerName: string | undefined; +} + +/** + * @public + */ +export interface DeleteMlflowTrackingServerResponse { + /** + *A TrackingServerArn object, the ARN of the tracking server that is deleted if
+ * successfully found.
The name of the MLflow Tracking Server to describe.
+ * @public + */ + 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 ARN of the described tracking server.
+ * @public + */ + TrackingServerArn?: string; + + /** + *The name of the described tracking server.
+ * @public + */ + TrackingServerName?: string; + + /** + *The S3 URI of the general purpose bucket used as the MLflow Tracking Server + * artifact store.
+ * @public + */ + ArtifactStoreUri?: string; + + /** + *The size of the described tracking server.
+ * @public + */ + TrackingServerSize?: TrackingServerSize; + + /** + *The MLflow version used for the described tracking server.
+ * @public + */ + MlflowVersion?: string; + + /** + *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 + */ + RoleArn?: string; + + /** + *The current creation status of the described MLflow Tracking Server.
+ * @public + */ + TrackingServerStatus?: TrackingServerStatus; + + /** + *Whether the described MLflow Tracking Server is currently active.
+ * @public + */ + IsActive?: IsTrackingServerActive; + + /** + *The URL to connect to the MLflow user interface for the described tracking server.
+ * @public + */ + TrackingServerUrl?: string; + + /** + *The day and time of the week when weekly maintenance occurs on the described tracking server.
+ * @public + */ + WeeklyMaintenanceWindowStart?: string; + + /** + *Whether automatic registration of new MLflow models to the SageMaker Model Registry is enabled.
+ * @public + */ + AutomaticModelRegistration?: boolean; + + /** + *The timestamp of when the described MLflow Tracking Server was created.
+ * @public + */ + CreationTime?: Date; + + /** + *Information about the user who created or modified an experiment, trial, trial + * component, lineage group, project, or model card.
+ * @public + */ + CreatedBy?: UserContext; + + /** + *The timestamp of when the described MLflow Tracking Server was last modified.
+ * @public + */ + LastModifiedTime?: Date; + + /** + *Information about the user who created or modified an experiment, trial, trial + * component, lineage group, project, or model card.
+ * @public + */ + LastModifiedBy?: UserContext; +} + /** * @public */ @@ -9552,366 +9888,6 @@ export interface DescribeNotebookInstanceOutput { InstanceMetadataServiceConfiguration?: InstanceMetadataServiceConfiguration; } -/** - * @public - */ -export interface DescribeNotebookInstanceLifecycleConfigInput { - /** - *The name of the lifecycle configuration to describe.
- * @public - */ - NotebookInstanceLifecycleConfigName: string | undefined; -} - -/** - * @public - */ -export interface DescribeNotebookInstanceLifecycleConfigOutput { - /** - *The Amazon Resource Name (ARN) of the lifecycle configuration.
- * @public - */ - NotebookInstanceLifecycleConfigArn?: string; - - /** - *The name of the lifecycle configuration.
- * @public - */ - NotebookInstanceLifecycleConfigName?: string; - - /** - *The shell script that runs only once, when you create a notebook instance.
- * @public - */ - OnCreate?: NotebookInstanceLifecycleHook[]; - - /** - *The shell script that runs every time you start a notebook instance, including when - * you create the notebook instance.
- * @public - */ - OnStart?: NotebookInstanceLifecycleHook[]; - - /** - *A timestamp that tells when the lifecycle configuration was last modified.
- * @public - */ - LastModifiedTime?: Date; - - /** - *A timestamp that tells when the lifecycle configuration was created.
- * @public - */ - CreationTime?: Date; -} - -/** - * @public - */ -export interface DescribePipelineRequest { - /** - *The name or Amazon Resource Name (ARN) of the pipeline to describe.
- * @public - */ - PipelineName: string | undefined; -} - -/** - * @public - * @enum - */ -export const PipelineStatus = { - ACTIVE: "Active", - DELETING: "Deleting", -} as const; - -/** - * @public - */ -export type PipelineStatus = (typeof PipelineStatus)[keyof typeof PipelineStatus]; - -/** - * @public - */ -export interface DescribePipelineResponse { - /** - *The Amazon Resource Name (ARN) of the pipeline.
- * @public - */ - PipelineArn?: string; - - /** - *The name of the pipeline.
- * @public - */ - PipelineName?: string; - - /** - *The display name of the pipeline.
- * @public - */ - PipelineDisplayName?: string; - - /** - *The JSON pipeline definition.
- * @public - */ - PipelineDefinition?: string; - - /** - *The description of the pipeline.
- * @public - */ - PipelineDescription?: string; - - /** - *The Amazon Resource Name (ARN) that the pipeline uses to execute.
- * @public - */ - RoleArn?: string; - - /** - *The status of the pipeline execution.
- * @public - */ - PipelineStatus?: PipelineStatus; - - /** - *The time when the pipeline was created.
- * @public - */ - CreationTime?: Date; - - /** - *The time when the pipeline was last modified.
- * @public - */ - LastModifiedTime?: Date; - - /** - *The time when the pipeline was last run.
- * @public - */ - LastRunTime?: Date; - - /** - *Information about the user who created or modified an experiment, trial, trial - * component, lineage group, project, or model card.
- * @public - */ - CreatedBy?: UserContext; - - /** - *Information about the user who created or modified an experiment, trial, trial - * component, lineage group, project, or model card.
- * @public - */ - LastModifiedBy?: UserContext; - - /** - *Lists the parallelism configuration applied to the pipeline.
- * @public - */ - ParallelismConfiguration?: ParallelismConfiguration; -} - -/** - * @public - */ -export interface DescribePipelineDefinitionForExecutionRequest { - /** - *The Amazon Resource Name (ARN) of the pipeline execution.
- * @public - */ - PipelineExecutionArn: string | undefined; -} - -/** - * @public - */ -export interface DescribePipelineDefinitionForExecutionResponse { - /** - *The JSON pipeline definition.
- * @public - */ - PipelineDefinition?: string; - - /** - *The time when the pipeline was created.
- * @public - */ - CreationTime?: Date; -} - -/** - * @public - */ -export interface DescribePipelineExecutionRequest { - /** - *The Amazon Resource Name (ARN) of the pipeline execution.
- * @public - */ - 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 name of the experiment.
- * @public - */ - ExperimentName?: string; - - /** - *The name of the trial.
- * @public - */ - TrialName?: string; -} - -/** - *A step selected to run in selective execution mode.
- * @public - */ -export interface SelectedStep { - /** - *The name of the pipeline step.
- * @public - */ - StepName: string | undefined; -} - -/** - *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.
A list of pipeline steps to run. All step(s) in all path(s) between - * two selected steps should be included.
- * @public - */ - SelectedSteps: SelectedStep[] | undefined; -} - -/** - * @public - */ -export interface DescribePipelineExecutionResponse { - /** - *The Amazon Resource Name (ARN) of the pipeline.
- * @public - */ - PipelineArn?: string; - - /** - *The Amazon Resource Name (ARN) of the pipeline execution.
- * @public - */ - PipelineExecutionArn?: string; - - /** - *The display name of the pipeline execution.
- * @public - */ - PipelineExecutionDisplayName?: string; - - /** - *The status of the pipeline execution.
- * @public - */ - PipelineExecutionStatus?: PipelineExecutionStatus; - - /** - *The description of the pipeline execution.
- * @public - */ - PipelineExecutionDescription?: string; - - /** - *Specifies the names of the experiment and trial created by a pipeline.
- * @public - */ - PipelineExperimentConfig?: PipelineExperimentConfig; - - /** - *If the execution failed, a message describing why.
- * @public - */ - FailureReason?: string; - - /** - *The time when the pipeline execution was created.
- * @public - */ - CreationTime?: Date; - - /** - *The time when the pipeline execution was modified last.
- * @public - */ - LastModifiedTime?: Date; - - /** - *Information about the user who created or modified an experiment, trial, trial - * component, lineage group, project, or model card.
- * @public - */ - CreatedBy?: UserContext; - - /** - *Information about the user who created or modified an experiment, trial, trial - * component, lineage group, project, or model card.
- * @public - */ - LastModifiedBy?: UserContext; - - /** - *The parallelism configuration applied to the pipeline.
- * @public - */ - ParallelismConfiguration?: ParallelismConfiguration; - - /** - *The selective execution configuration applied to the pipeline run.
- * @public - */ - SelectiveExecutionConfig?: SelectiveExecutionConfig; -} - /** * @internal */ diff --git a/clients/client-sagemaker/src/models/models_3.ts b/clients/client-sagemaker/src/models/models_3.ts index db6241e03b309..60bac735669e7 100644 --- a/clients/client-sagemaker/src/models/models_3.ts +++ b/clients/client-sagemaker/src/models/models_3.ts @@ -68,9 +68,11 @@ import { MonitoringScheduleConfig, MonitoringType, NetworkConfig, + NotebookInstanceLifecycleHook, OfflineStoreConfig, OnlineStoreConfig, OwnershipSettings, + ParallelismConfiguration, ProcessingInput, ProcessingOutputConfig, ProcessingResources, @@ -79,8 +81,6 @@ import { ResourceLimits, RetryStrategy, ServiceCatalogProvisioningDetails, - SpaceSettings, - SpaceSharingSettings, UserSettings, } from "./models_1"; @@ -96,7 +96,6 @@ import { EdgePackagingJobStatus, EndpointOutputConfiguration, EndpointStatus, - ExecutionStatus, ExperimentSource, FeatureGroupStatus, FeatureParameter, @@ -114,6 +113,7 @@ import { InferenceExperimentStatus, InferenceMetrics, InfraCheckConfig, + IsTrackingServerActive, LabelCounters, LabelingJobOutput, LabelingJobStatus, @@ -138,8 +138,11 @@ import { RuleEvaluationStatus, ScheduleStatus, SourceIpConfig, + SpaceSettings, + SpaceSharingSettings, StudioLifecycleConfigAppType, TensorBoardOutputConfig, + TrackingServerStatus, TrainingJobStatus, TrainingJobStatusCounters, TrialComponentArtifact, @@ -151,1044 +154,1076 @@ import { /** * @public */ -export interface DescribeProcessingJobRequest { +export interface DescribeNotebookInstanceLifecycleConfigInput { /** - *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 lifecycle configuration to describe.
* @public */ - ProcessingJobName: string | undefined; + NotebookInstanceLifecycleConfigName: string | undefined; } /** * @public - * @enum */ -export const ProcessingJobStatus = { - COMPLETED: "Completed", - FAILED: "Failed", - IN_PROGRESS: "InProgress", - STOPPED: "Stopped", - STOPPING: "Stopping", -} as const; +export interface DescribeNotebookInstanceLifecycleConfigOutput { + /** + *The Amazon Resource Name (ARN) of the lifecycle configuration.
+ * @public + */ + NotebookInstanceLifecycleConfigArn?: string; -/** - * @public - */ -export type ProcessingJobStatus = (typeof ProcessingJobStatus)[keyof typeof ProcessingJobStatus]; + /** + *The name of the lifecycle configuration.
+ * @public + */ + NotebookInstanceLifecycleConfigName?: string; -/** - * @public - */ -export interface DescribeProcessingJobResponse { /** - *The inputs for a processing job.
+ *The shell script that runs only once, when you create a notebook instance.
* @public */ - ProcessingInputs?: ProcessingInput[]; + OnCreate?: NotebookInstanceLifecycleHook[]; /** - *Output configuration for the processing job.
+ *The shell script that runs every time you start a notebook instance, including when + * you create the notebook instance.
* @public */ - ProcessingOutputConfig?: ProcessingOutputConfig; + OnStart?: NotebookInstanceLifecycleHook[]; /** - *The name of the processing job. The name must be unique within an Amazon Web Services Region in the - * Amazon Web Services account.
+ *A timestamp that tells when the lifecycle configuration was last modified.
* @public */ - ProcessingJobName: string | undefined; + LastModifiedTime?: Date; /** - *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.
+ *A timestamp that tells when the lifecycle configuration was created.
* @public */ - ProcessingResources: ProcessingResources | undefined; + CreationTime?: Date; +} +/** + * @public + */ +export interface DescribePipelineRequest { /** - *The time limit for how long the processing job is allowed to run.
+ *The name or Amazon Resource Name (ARN) of the pipeline to describe.
* @public */ - StoppingCondition?: ProcessingStoppingCondition; + PipelineName: string | undefined; +} + +/** + * @public + * @enum + */ +export const PipelineStatus = { + ACTIVE: "Active", + DELETING: "Deleting", +} as const; + +/** + * @public + */ +export type PipelineStatus = (typeof PipelineStatus)[keyof typeof PipelineStatus]; +/** + * @public + */ +export interface DescribePipelineResponse { /** - *Configures the processing job to run a specified container image.
+ *The Amazon Resource Name (ARN) of the pipeline.
* @public */ - AppSpecification: AppSpecification | undefined; + PipelineArn?: string; /** - *The environment variables set in the Docker container.
+ *The name of the pipeline.
* @public */ - Environment?: RecordNetworking options for a processing job.
+ *The display name of the pipeline.
* @public */ - NetworkConfig?: NetworkConfig; + PipelineDisplayName?: string; /** - *The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on - * your behalf.
+ *The JSON pipeline definition.
* @public */ - RoleArn?: string; + PipelineDefinition?: string; /** - *The configuration information used to create an experiment.
+ *The description of the pipeline.
* @public */ - ExperimentConfig?: ExperimentConfig; + PipelineDescription?: string; /** - *The Amazon Resource Name (ARN) of the processing job.
+ *The Amazon Resource Name (ARN) that the pipeline uses to execute.
* @public */ - ProcessingJobArn: string | undefined; + RoleArn?: string; /** - *Provides the status of a processing job.
+ *The status of the pipeline execution.
* @public */ - ProcessingJobStatus: ProcessingJobStatus | undefined; + PipelineStatus?: PipelineStatus; /** - *An optional string, up to one KB in size, that contains metadata from the processing - * container when the processing job exits.
+ *The time when the pipeline was created.
* @public */ - ExitMessage?: string; + CreationTime?: Date; /** - *A string, up to one KB in size, that contains the reason a processing job failed, if - * it failed.
+ *The time when the pipeline was last modified.
* @public */ - FailureReason?: string; + LastModifiedTime?: Date; /** - *The time at which the processing job completed.
+ *The time when the pipeline was last run.
* @public */ - ProcessingEndTime?: Date; + LastRunTime?: Date; /** - *The time at which the processing job started.
+ *Information about the user who created or modified an experiment, trial, trial + * component, lineage group, project, or model card.
* @public */ - ProcessingStartTime?: Date; + CreatedBy?: UserContext; /** - *The time at which the processing job 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; + LastModifiedBy?: UserContext; /** - *The time at which the processing job was created.
+ *Lists the parallelism configuration applied to the pipeline.
* @public */ - CreationTime: Date | undefined; + ParallelismConfiguration?: ParallelismConfiguration; +} +/** + * @public + */ +export interface DescribePipelineDefinitionForExecutionRequest { /** - *The ARN of a monitoring schedule for an endpoint associated with this processing - * job.
+ *The Amazon Resource Name (ARN) of the pipeline execution.
* @public */ - MonitoringScheduleArn?: string; + PipelineExecutionArn: string | undefined; +} +/** + * @public + */ +export interface DescribePipelineDefinitionForExecutionResponse { /** - *The ARN of an AutoML job associated with this processing job.
+ *The JSON pipeline definition.
* @public */ - AutoMLJobArn?: string; + PipelineDefinition?: string; /** - *The ARN of a training job associated with this processing job.
+ *The time when the pipeline was created.
* @public */ - TrainingJobArn?: string; + CreationTime?: Date; } /** * @public */ -export interface DescribeProjectInput { +export interface DescribePipelineExecutionRequest { /** - *The name of the project to describe.
+ *The Amazon Resource Name (ARN) of the pipeline execution.
* @public */ - ProjectName: string | undefined; + PipelineExecutionArn: 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", +export const PipelineExecutionStatus = { + EXECUTING: "Executing", + FAILED: "Failed", + STOPPED: "Stopped", + STOPPING: "Stopping", + SUCCEEDED: "Succeeded", } as const; /** * @public */ -export type ProjectStatus = (typeof ProjectStatus)[keyof typeof ProjectStatus]; +export type PipelineExecutionStatus = (typeof PipelineExecutionStatus)[keyof typeof PipelineExecutionStatus]; /** - *Details of a provisioned service catalog product. For information about service catalog, - * see What is Amazon Web Services Service - * Catalog.
+ *Specifies the names of the experiment and trial created by a pipeline.
* @public */ -export interface ServiceCatalogProvisionedProductDetails { +export interface PipelineExperimentConfig { /** - *The ID of the provisioned product.
+ *The name of the experiment.
* @public */ - ProvisionedProductId?: string; + ExperimentName?: string; /** - *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.
The name of the trial.
* @public */ - ProvisionedProductStatusMessage?: string; + TrialName?: string; } /** + *A step selected to run in selective execution mode.
* @public */ -export interface DescribeProjectOutput { +export interface SelectedStep { /** - *The Amazon Resource Name (ARN) of the project.
+ *The name of the pipeline step.
* @public */ - ProjectArn: string | undefined; + StepName: string | undefined; +} +/** + *The selective execution configuration applied to the pipeline run.
+ * @public + */ +export interface SelectiveExecutionConfig { /** - *The name of the project.
+ *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 ID of the project.
+ *A list of pipeline steps to run. All step(s) in all path(s) between + * two selected steps should be included.
* @public */ - ProjectId: string | undefined; + SelectedSteps: SelectedStep[] | undefined; +} +/** + * @public + */ +export interface DescribePipelineExecutionResponse { /** - *The description of the project.
+ *The Amazon Resource Name (ARN) of the pipeline.
* @public */ - ProjectDescription?: string; + PipelineArn?: string; /** - *Information used to provision a service catalog product. For information, see What is Amazon Web Services Service - * Catalog.
+ *The Amazon Resource Name (ARN) of the pipeline execution.
* @public */ - ServiceCatalogProvisioningDetails: ServiceCatalogProvisioningDetails | undefined; + PipelineExecutionArn?: string; /** - *Information about a provisioned service catalog product.
+ *The display name of the pipeline execution.
* @public */ - ServiceCatalogProvisionedProductDetails?: ServiceCatalogProvisionedProductDetails; + PipelineExecutionDisplayName?: string; /** - *The status of the project.
+ *The status of the pipeline execution.
* @public */ - ProjectStatus: ProjectStatus | undefined; + PipelineExecutionStatus?: PipelineExecutionStatus; /** - *Information about the user who created or modified an experiment, trial, trial - * component, lineage group, project, or model card.
+ *The description of the pipeline execution.
* @public */ - CreatedBy?: UserContext; + PipelineExecutionDescription?: string; /** - *The time when the project was created.
+ *Specifies the names of the experiment and trial created by a pipeline.
* @public */ - CreationTime: Date | undefined; + PipelineExperimentConfig?: PipelineExperimentConfig; /** - *The timestamp when project was last modified.
+ *If the execution failed, a message describing why.
+ * @public + */ + FailureReason?: string; + + /** + *The time when the pipeline execution was created.
+ * @public + */ + CreationTime?: Date; + + /** + *The time when the pipeline execution was modified last.
* @public */ LastModifiedTime?: Date; + /** + *Information about the user who created or modified an experiment, trial, trial + * component, lineage group, project, or model card.
+ * @public + */ + CreatedBy?: UserContext; + /** *Information about the user who created or modified an experiment, trial, trial * component, lineage group, project, or model card.
* @public */ LastModifiedBy?: UserContext; -} -/** - * @public - */ -export interface DescribeSpaceRequest { /** - *The ID of the associated domain.
+ *The parallelism configuration applied to the pipeline.
* @public */ - DomainId: string | undefined; + ParallelismConfiguration?: ParallelismConfiguration; /** - *The name of the space.
+ *The selective execution configuration applied to the pipeline run.
* @public */ - SpaceName: string | undefined; + SelectiveExecutionConfig?: SelectiveExecutionConfig; } -/** - * @public - * @enum - */ -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]; +export interface DescribeProcessingJobRequest { + /** + *The name of the processing job. The name must be unique within an Amazon Web Services Region in the + * Amazon Web Services account.
+ * @public + */ + ProcessingJobName: string | undefined; +} /** * @public + * @enum */ -export interface DescribeSpaceResponse { +export const ProcessingJobStatus = { + COMPLETED: "Completed", + FAILED: "Failed", + IN_PROGRESS: "InProgress", + STOPPED: "Stopped", + STOPPING: "Stopping", +} as const; + +/** + * @public + */ +export type ProcessingJobStatus = (typeof ProcessingJobStatus)[keyof typeof ProcessingJobStatus]; + +/** + * @public + */ +export interface DescribeProcessingJobResponse { /** - *The ID of the associated domain.
+ *The inputs for a processing job.
* @public */ - DomainId?: string; + ProcessingInputs?: ProcessingInput[]; /** - *The space's Amazon Resource Name (ARN).
+ *Output configuration for the processing job.
* @public */ - SpaceArn?: string; + ProcessingOutputConfig?: ProcessingOutputConfig; /** - *The name of the space.
+ *The name of the processing job. The name must be unique within an Amazon Web Services Region in the + * Amazon Web Services account.
* @public */ - SpaceName?: string; + ProcessingJobName: string | undefined; /** - *The ID of the space's profile in the Amazon EFS volume.
+ *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 */ - HomeEfsFileSystemUid?: string; + ProcessingResources: ProcessingResources | undefined; /** - *The status.
+ *The time limit for how long the processing job is allowed to run.
* @public */ - Status?: SpaceStatus; + StoppingCondition?: ProcessingStoppingCondition; /** - *The last modified time.
+ *Configures the processing job to run a specified container image.
* @public */ - LastModifiedTime?: Date; + AppSpecification: AppSpecification | undefined; /** - *The creation time.
+ *The environment variables set in the Docker container.
* @public */ - CreationTime?: Date; + Environment?: RecordThe failure reason.
+ *Networking options for a processing job.
* @public */ - FailureReason?: string; + NetworkConfig?: NetworkConfig; /** - *A collection of space settings.
+ *The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on + * your behalf.
* @public */ - SpaceSettings?: SpaceSettings; + RoleArn?: string; /** - *The collection of ownership settings for a space.
+ *The configuration information used to create an experiment.
* @public */ - OwnershipSettings?: OwnershipSettings; + ExperimentConfig?: ExperimentConfig; /** - *The collection of space sharing settings for a space.
+ *The Amazon Resource Name (ARN) of the processing job.
* @public */ - SpaceSharingSettings?: SpaceSharingSettings; + ProcessingJobArn: string | undefined; /** - *The name of the space that appears in the Amazon SageMaker Studio UI.
+ *Provides the status of a processing job.
* @public */ - SpaceDisplayName?: string; + ProcessingJobStatus: ProcessingJobStatus | 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
- *
An optional string, up to one KB in size, that contains metadata from the processing + * container when the processing job exits.
* @public */ - Url?: string; -} + ExitMessage?: string; -/** - * @public - */ -export interface DescribeStudioLifecycleConfigRequest { /** - *The name of the Amazon SageMaker Studio Lifecycle Configuration to describe.
+ *A string, up to one KB in size, that contains the reason a processing job failed, if + * it failed.
* @public */ - StudioLifecycleConfigName: string | undefined; -} + FailureReason?: string; -/** - * @public - */ -export interface DescribeStudioLifecycleConfigResponse { /** - *The ARN of the Lifecycle Configuration to describe.
+ *The time at which the processing job completed.
* @public */ - StudioLifecycleConfigArn?: string; + ProcessingEndTime?: Date; /** - *The name of the Amazon SageMaker Studio Lifecycle Configuration that is described.
+ *The time at which the processing job started.
* @public */ - StudioLifecycleConfigName?: string; + ProcessingStartTime?: Date; /** - *The creation time of the Amazon SageMaker Studio Lifecycle Configuration.
+ *The time at which the processing job was last modified.
* @public */ - CreationTime?: Date; + LastModifiedTime?: Date; /** - *This value is equivalent to CreationTime because Amazon SageMaker Studio Lifecycle Configurations are immutable.
+ *The time at which the processing job was created.
* @public */ - LastModifiedTime?: Date; + CreationTime: Date | undefined; /** - *The content of your Amazon SageMaker Studio Lifecycle Configuration script.
+ *The ARN of a monitoring schedule for an endpoint associated with this processing + * job.
* @public */ - StudioLifecycleConfigContent?: string; + MonitoringScheduleArn?: string; /** - *The App type that the Lifecycle Configuration is attached to.
+ *The ARN of an AutoML job associated with this processing job.
* @public */ - StudioLifecycleConfigAppType?: StudioLifecycleConfigAppType; -} + AutoMLJobArn?: string; -/** - * @public - */ -export interface DescribeSubscribedWorkteamRequest { /** - *The Amazon Resource Name (ARN) of the subscribed work team to describe.
+ *The ARN of a training job associated with this processing job.
* @public */ - WorkteamArn: string | undefined; + TrainingJobArn?: string; } /** - *Describes a work team of a vendor that does the a labelling job.
* @public */ -export interface SubscribedWorkteam { - /** - *The Amazon Resource Name (ARN) of the vendor that you have subscribed.
- * @public - */ - WorkteamArn: string | undefined; - - /** - *The title of the service provided by the vendor in the Amazon Marketplace.
- * @public - */ - MarketplaceTitle?: string; - - /** - *The name of the vendor in the Amazon Marketplace.
- * @public - */ - SellerName?: string; - - /** - *The description of the vendor from the Amazon Marketplace.
- * @public - */ - MarketplaceDescription?: string; - +export interface DescribeProjectInput { /** - *Marketplace product listing ID.
+ *The name of the project to describe.
* @public */ - ListingId?: string; + ProjectName: string | undefined; } /** * @public + * @enum */ -export interface DescribeSubscribedWorkteamResponse { - /** - *A Workteam instance that contains information about the work team.
The name of the training job.
- * @public - */ - TrainingJobName: string | undefined; -} +export type ProjectStatus = (typeof ProjectStatus)[keyof typeof ProjectStatus]; /** - *The name, value, and date and time of a metric that was emitted to Amazon CloudWatch.
+ *Details of a provisioned service catalog product. For information about service catalog, + * see What is Amazon Web Services Service + * Catalog.
* @public */ -export interface MetricData { - /** - *The name of the metric.
- * @public - */ - MetricName?: string; - +export interface ServiceCatalogProvisionedProductDetails { /** - *The value of the metric.
+ *The ID of the provisioned product.
* @public */ - Value?: number; + ProvisionedProductId?: string; /** - *The date and time that the algorithm emitted the metric.
+ *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.
Information about the status of the rule evaluation.
* @public */ -export interface ProfilerRuleEvaluationStatus { +export interface DescribeProjectOutput { /** - *The name of the rule configuration.
+ *The Amazon Resource Name (ARN) of the project.
* @public */ - RuleConfigurationName?: string; + ProjectArn: string | undefined; /** - *The Amazon Resource Name (ARN) of the rule evaluation job.
+ *The name of the project.
* @public */ - RuleEvaluationJobArn?: string; + ProjectName: string | undefined; /** - *Status of the rule evaluation.
+ *The ID of the project.
* @public */ - RuleEvaluationStatus?: RuleEvaluationStatus; + ProjectId: string | undefined; /** - *Details from the rule evaluation.
+ *The description of the project.
* @public */ - StatusDetails?: string; + ProjectDescription?: string; /** - *Timestamp when the rule evaluation status was last modified.
+ *Information used to provision a service catalog product. For information, see What is Amazon Web Services Service + * Catalog.
+ * @public + */ + ServiceCatalogProvisioningDetails: ServiceCatalogProvisioningDetails | undefined; + + /** + *Information about a provisioned service catalog product.
+ * @public + */ + ServiceCatalogProvisionedProductDetails?: ServiceCatalogProvisionedProductDetails; + + /** + *The status of the project.
+ * @public + */ + ProjectStatus: ProjectStatus | undefined; + + /** + *Information about the user who created or modified an experiment, trial, trial + * component, lineage group, project, or model card.
+ * @public + */ + CreatedBy?: UserContext; + + /** + *The time when the project was created.
+ * @public + */ + CreationTime: Date | undefined; + + /** + *The timestamp when project was last modified.
* @public */ LastModifiedTime?: Date; + + /** + *Information about the user who created or modified an experiment, trial, trial + * component, lineage group, project, or model card.
+ * @public + */ + LastModifiedBy?: UserContext; } /** * @public - * @enum */ -export const ProfilingStatus = { - DISABLED: "Disabled", - ENABLED: "Enabled", -} as const; +export interface DescribeSpaceRequest { + /** + *The ID of the associated domain.
+ * @public + */ + DomainId: string | undefined; -/** - * @public - */ -export type ProfilingStatus = (typeof ProfilingStatus)[keyof typeof ProfilingStatus]; + /** + *The name of the space.
+ * @public + */ + SpaceName: string | undefined; +} /** * @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", +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 SecondaryStatus = (typeof SecondaryStatus)[keyof typeof SecondaryStatus]; +export type SpaceStatus = (typeof SpaceStatus)[keyof typeof SpaceStatus]; /** - *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
- *
The ID of the associated domain.
* @public */ - Status: SecondaryStatus | undefined; + DomainId?: string; /** - *A timestamp that shows when the training job transitioned to the current secondary - * status state.
+ *The space's Amazon Resource Name (ARN).
* @public */ - StartTime: Date | undefined; + SpaceArn?: string; /** - *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.
+ *The name of the space.
* @public */ - EndTime?: Date; + SpaceName?: string; /** - *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
The ID of the space's profile in the Amazon EFS volume.
+ * @public + */ + HomeEfsFileSystemUid?: string; + + /** + *The status.
+ * @public + */ + Status?: SpaceStatus; + + /** + *The last modified time.
+ * @public + */ + LastModifiedTime?: Date; + + /** + *The creation time.
+ * @public + */ + CreationTime?: Date; + + /** + *The failure reason.
+ * @public + */ + FailureReason?: string; + + /** + *A collection of space settings.
+ * @public + */ + SpaceSettings?: SpaceSettings; + + /** + *The collection of ownership settings for a space.
+ * @public + */ + OwnershipSettings?: OwnershipSettings; + + /** + *The collection of space sharing settings for a space.
+ * @public + */ + SpaceSharingSettings?: SpaceSharingSettings; + + /** + *The name of the space that appears in the Amazon SageMaker Studio UI.
+ * @public + */ + SpaceDisplayName?: string; + + /** + *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
+ *
- * SecondaryStatus - Training
JupyterLab: &redirect=JupyterLab
+ *
- * StatusMessage - Downloading the training image
Code Editor, based on Code-OSS, Visual Studio Code - Open Source: &redirect=CodeEditor
+ *
The name of the Amazon SageMaker Studio Lifecycle Configuration to describe.
+ * @public + */ + StudioLifecycleConfigName: string | undefined; +} /** * @public */ -export type WarmPoolResourceStatus = (typeof WarmPoolResourceStatus)[keyof typeof WarmPoolResourceStatus]; +export interface DescribeStudioLifecycleConfigResponse { + /** + *The ARN of the Lifecycle Configuration to describe.
+ * @public + */ + StudioLifecycleConfigArn?: string; -/** - *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 name of the Amazon SageMaker Studio Lifecycle Configuration that is described.
* @public */ - Status: WarmPoolResourceStatus | undefined; + StudioLifecycleConfigName?: string; /** - *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 creation time of the Amazon SageMaker Studio Lifecycle Configuration.
* @public */ - ResourceRetainedBillableTimeInSeconds?: number; + CreationTime?: Date; /** - *The name of the matching training job that reused the warm pool.
+ *This value is equivalent to CreationTime because Amazon SageMaker Studio Lifecycle Configurations are immutable.
* @public */ - ReusedByJob?: string; + LastModifiedTime?: Date; + + /** + *The content of your Amazon SageMaker Studio Lifecycle Configuration script.
+ * @public + */ + StudioLifecycleConfigContent?: string; + + /** + *The App type that the Lifecycle Configuration is attached to.
+ * @public + */ + StudioLifecycleConfigAppType?: StudioLifecycleConfigAppType; } /** * @public */ -export interface DescribeTrainingJobResponse { +export interface DescribeSubscribedWorkteamRequest { /** - *Name of the model training job.
+ *The Amazon Resource Name (ARN) of the subscribed work team to describe.
* @public */ - TrainingJobName: string | undefined; + WorkteamArn: string | undefined; +} +/** + *Describes a work team of a vendor that does the labelling job.
+ * @public + */ +export interface SubscribedWorkteam { /** - *The Amazon Resource Name (ARN) of the training job.
+ *The Amazon Resource Name (ARN) of the vendor that you have subscribed.
* @public */ - TrainingJobArn: string | undefined; + WorkteamArn: string | undefined; /** - *The Amazon Resource Name (ARN) of the associated hyperparameter tuning job if the - * training job was launched by a hyperparameter tuning job.
+ *The title of the service provided by the vendor in the Amazon Marketplace.
* @public */ - TuningJobArn?: string; + MarketplaceTitle?: string; /** - *The Amazon Resource Name (ARN) of the SageMaker Ground Truth labeling job that created the - * transform or training job.
+ *The name of the vendor in the Amazon Marketplace.
* @public */ - LabelingJobArn?: string; + SellerName?: string; /** - *The Amazon Resource Name (ARN) of an AutoML job.
+ *The description of the vendor from the Amazon Marketplace.
* @public */ - AutoMLJobArn?: string; + MarketplaceDescription?: string; /** - *Information about the Amazon S3 location that is configured for storing model artifacts. - *
+ *Marketplace product listing ID.
* @public */ - ModelArtifacts: ModelArtifacts | undefined; + ListingId?: string; +} +/** + * @public + */ +export interface DescribeSubscribedWorkteamResponse { /** - *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.
A Workteam instance that contains information about the work team.
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.
The name of the training job.
+ * @public + */ + TrainingJobName: 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.
+ * @public + */ + MetricName?: string; + + /** + *The value of the metric.
+ * @public + */ + Value?: number; + + /** + *The date and time that the algorithm emitted the metric.
+ * @public + */ + Timestamp?: Date; +} + +/** + *Information about the status of the rule evaluation.
+ * @public + */ +export interface ProfilerRuleEvaluationStatus { + /** + *The name of the rule configuration.
+ * @public + */ + RuleConfigurationName?: string; + + /** + *The Amazon Resource Name (ARN) of the rule evaluation job.
+ * @public + */ + RuleEvaluationJobArn?: string; + + /** + *Status of the rule evaluation.
+ * @public + */ + RuleEvaluationStatus?: RuleEvaluationStatus; + + /** + *Details from the rule evaluation.
+ * @public + */ + StatusDetails?: string; + + /** + *Timestamp when the rule evaluation status was last modified.
+ * @public + */ + LastModifiedTime?: Date; +} + +/** + * @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.
- * MaxWaitTimeExceeded - The job stopped because it
- * exceeded the maximum allowed wait time.
* Stopped - The training job has stopped.
Valid values for SecondaryStatus are subject to change.
We no longer support the following secondary statuses:
*
- * PreparingTraining
+ * PreparingTrainingStack
*
If the training job failed, the reason it failed.
+ *A timestamp that shows when the training job transitioned to the current secondary + * status state.
* @public */ - FailureReason?: string; + StartTime: Date | undefined; /** - *Algorithm-specific parameters.
+ *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 */ - HyperParameters?: RecordInformation about the algorithm used for training, and algorithm metadata. - *
+ *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
The Amazon Web Services Identity and Access Management (IAM) role configured for - * the training job.
- * @public - */ - RoleArn?: string; +/** + * @public + * @enum + */ +export const WarmPoolResourceStatus = { + AVAILABLE: "Available", + INUSE: "InUse", + REUSED: "Reused", + TERMINATED: "Terminated", +} as const; - /** - *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 - */ - OutputDataConfig?: OutputDataConfig; - - /** - *Resources, including ML compute instances and ML storage volumes, that are - * configured for model training.
- * @public - */ - ResourceConfig: ResourceConfig | undefined; - - /** - *The status of the warm pool associated with the training job.
- * @public - */ - WarmPoolStatus?: WarmPoolStatus; - - /** - *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 - */ - VpcConfig?: VpcConfig; - - /** - *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 timestamp that indicates when the training job was created.
- * @public - */ - 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; +/** + * @public + */ +export type WarmPoolResourceStatus = (typeof WarmPoolResourceStatus)[keyof typeof WarmPoolResourceStatus]; +/** + *Status and billing information about the warm pool.
+ * @public + */ +export interface WarmPoolStatus { /** - *A history of all of the secondary statuses that the training job has transitioned - * through.
+ *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.
A collection of MetricData objects that specify the names, values, and
- * dates and times that the training algorithm emitted to Amazon CloudWatch.
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.
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 name of the matching training job that reused the warm pool.
* @public */ - EnableNetworkIsolation?: boolean; + ReusedByJob?: string; +} +/** + * @public + */ +export interface DescribeTrainingJobResponse { /** - *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.
Name of the model training job.
* @public */ - EnableInterContainerTrafficEncryption?: boolean; + TrainingJobName: string | undefined; /** - *A Boolean indicating whether managed spot training is enabled (True) or
- * not (False).
The Amazon Resource Name (ARN) of the training job.
* @public */ - EnableManagedSpotTraining?: boolean; + TrainingJobArn: string | undefined; /** - *Contains information about the output location for managed spot training checkpoint - * data.
+ *The Amazon Resource Name (ARN) of the associated hyperparameter tuning job if the + * training job was launched by a hyperparameter tuning job.
* @public */ - CheckpointConfig?: CheckpointConfig; + TuningJobArn?: string; /** - *The training time in seconds.
+ *The Amazon Resource Name (ARN) of the SageMaker Ground Truth labeling job that created the + * transform or training job.
* @public */ - TrainingTimeInSeconds?: number; + LabelingJobArn?: string; /** - *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 Amazon Resource Name (ARN) of an AutoML job.
* @public */ - BillableTimeInSeconds?: number; + AutoMLJobArn?: string; /** - *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.
Information about the Amazon S3 location that is configured for storing model artifacts. + *
* @public */ - DebugHookConfig?: DebugHookConfig; + ModelArtifacts: ModelArtifacts | 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 training job.
+ *SageMaker provides the following training job statuses:
*- * CreateProcessingJob - *
+ *InProgress - The training is in progress.
* - * CreateTrainingJob - *
+ *Completed - The training job has completed.
* - * CreateTransformJob - *
+ *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.
Configuration information for Amazon SageMaker Debugger rules for debugging output tensors.
- * @public - */ - DebugRuleConfigurations?: DebugRuleConfiguration[]; - - /** - *Configuration of storage locations for the Amazon SageMaker Debugger TensorBoard output data.
- * @public - */ - TensorBoardOutputConfig?: TensorBoardOutputConfig; - - /** - *Evaluation status of Amazon SageMaker Debugger rules for debugging on a training job.
- * @public - */ - DebugRuleEvaluationStatuses?: DebugRuleEvaluationStatus[]; - - /** - *Configuration information for Amazon SageMaker Debugger system monitoring, framework profiling, and - * storage paths.
- * @public - */ - ProfilerConfig?: ProfilerConfig; - - /** - *Configuration information for Amazon SageMaker Debugger rules for profiling system and framework - * metrics.
- * @public - */ - ProfilerRuleConfigurations?: ProfilerRuleConfiguration[]; - - /** - *Evaluation status of Amazon SageMaker Debugger rules for profiling on a training job.
- * @public - */ - ProfilerRuleEvaluationStatuses?: ProfilerRuleEvaluationStatus[]; - - /** - *Profiling status of a training job.
- * @public - */ - ProfilingStatus?: ProfilingStatus; - - /** - *The environment variables to set in the Docker container.
- * @public - */ - Environment?: RecordThe number of times to retry the job when the job fails due to an
- * InternalServerError.
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
+ *
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.
+ *If the training job failed, the reason it failed.
* @public */ - RemoteDebugConfig?: RemoteDebugConfig; + FailureReason?: string; /** - *Contains information about the infrastructure health check configuration for the training job.
+ *Algorithm-specific parameters.
* @public */ - InfraCheckConfig?: InfraCheckConfig; -} + HyperParameters?: RecordThe name of the transform job that you want to view details of.
+ *Information about the algorithm used for training, and algorithm metadata. + *
* @public */ - 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]; + AlgorithmSpecification: AlgorithmSpecification | undefined; -/** - * @public - */ -export interface DescribeTransformJobResponse { /** - *The name of the transform job.
+ *The Amazon Web Services Identity and Access Management (IAM) role configured for + * the training job.
* @public */ - TransformJobName: string | undefined; + RoleArn?: string; /** - *The Amazon Resource Name (ARN) of the transform job.
+ *An array of Channel objects that describes each data input channel.
+ *
The
- * status of the transform job. If the transform job failed, the reason
- * is returned in the FailureReason field.
The S3 path where model artifacts that you configured when creating the job are + * stored. SageMaker creates subfolders for model artifacts.
* @public */ - TransformJobStatus: TransformJobStatus | undefined; + OutputDataConfig?: OutputDataConfig; /** - *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.
Resources, including ML compute instances and ML storage volumes, that are + * configured for model training.
* @public */ - FailureReason?: string; + ResourceConfig: ResourceConfig | undefined; /** - *The name of the model used in the transform job.
+ *The status of the warm pool associated with the training job.
* @public */ - ModelName: string | undefined; + WarmPoolStatus?: WarmPoolStatus; /** - *The - * maximum number - * of - * parallel requests on each instance node - * that can be launched in a transform job. The default value is 1.
+ *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 */ - MaxConcurrentTransforms?: number; + VpcConfig?: VpcConfig; /** - *The timeout and maximum number of retries for processing a transform job - * invocation.
+ *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 - * maximum - * payload size, in MB, used in the - * transform job.
+ *A timestamp that indicates when the training job was created.
* @public */ - MaxPayloadInMB?: number; + CreationTime: 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.
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 - * environment variables to set in the Docker container. We support up to 16 key and values - * entries in the map.
+ *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.
Describes the dataset to be transformed and the Amazon S3 location where it is - * stored.
+ *A timestamp that indicates when the status of the training job was last + * modified.
* @public */ - TransformInput: TransformInput | undefined; + LastModifiedTime?: Date; /** - *Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the - * transform job.
+ *A history of all of the secondary statuses that the training job has transitioned + * through.
* @public */ - TransformOutput?: TransformOutput; + SecondaryStatusTransitions?: SecondaryStatusTransition[]; /** - *Configuration to control how SageMaker captures inference data.
+ *A collection of MetricData objects that specify the names, values, and
+ * dates and times that the training algorithm emitted to Amazon CloudWatch.
Describes - * the resources, including ML instance types and ML instance count, to - * use for the transform job.
+ *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.
A timestamp that shows when the transform Job was created.
+ *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.
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 Boolean indicating whether managed spot training is enabled (True) or
+ * not (False).
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.
Contains information about the output location for managed spot training checkpoint + * data.
* @public */ - TransformEndTime?: Date; + CheckpointConfig?: CheckpointConfig; /** - *The Amazon Resource Name (ARN) of the Amazon SageMaker Ground Truth labeling job that created the - * transform or training job.
+ *The training time in seconds.
* @public */ - LabelingJobArn?: string; + TrainingTimeInSeconds?: number; /** - *The Amazon Resource Name (ARN) of the AutoML transform job.
+ *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 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.
+ *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.
Associates a SageMaker job as a trial component with an experiment and trial. Specified when @@ -1763,463 +1834,755 @@ export interface DescribeTransformJobResponse { * @public */ ExperimentConfig?: ExperimentConfig; -} -/** - * @public - */ -export interface DescribeTrialRequest { - /** - *
The name of the trial to describe.
- * @public - */ - TrialName: string | undefined; -} - -/** - *The source of the trial.
- * @public - */ -export interface TrialSource { /** - *The Amazon Resource Name (ARN) of the source.
- * @public - */ - SourceArn: string | undefined; - - /** - *The source job type.
+ *Configuration information for Amazon SageMaker Debugger rules for debugging output tensors.
* @public */ - SourceType?: string; -} + DebugRuleConfigurations?: DebugRuleConfiguration[]; -/** - * @public - */ -export interface DescribeTrialResponse { /** - *The name of the trial.
+ *Configuration of storage locations for the Amazon SageMaker Debugger TensorBoard output data.
* @public */ - TrialName?: string; + TensorBoardOutputConfig?: TensorBoardOutputConfig; /** - *The Amazon Resource Name (ARN) of the trial.
+ *Evaluation status of Amazon SageMaker Debugger rules for debugging on a training job.
* @public */ - TrialArn?: string; + DebugRuleEvaluationStatuses?: DebugRuleEvaluationStatus[]; /** - *The name of the trial as displayed. If DisplayName isn't specified,
- * TrialName is displayed.
Configuration information for Amazon SageMaker Debugger system monitoring, framework profiling, and + * storage paths.
* @public */ - DisplayName?: string; + ProfilerConfig?: ProfilerConfig; /** - *The name of the experiment the trial is part of.
+ *Configuration information for Amazon SageMaker Debugger rules for profiling system and framework + * metrics.
* @public */ - ExperimentName?: string; + ProfilerRuleConfigurations?: ProfilerRuleConfiguration[]; /** - *The Amazon Resource Name (ARN) of the source and, optionally, the job type.
+ *Evaluation status of Amazon SageMaker Debugger rules for profiling on a training job.
* @public */ - Source?: TrialSource; + ProfilerRuleEvaluationStatuses?: ProfilerRuleEvaluationStatus[]; /** - *When the trial was created.
+ *Profiling status of a training job.
* @public */ - CreationTime?: Date; + ProfilingStatus?: ProfilingStatus; /** - *Who created the trial.
+ *The environment variables to set in the Docker container.
* @public */ - CreatedBy?: UserContext; + Environment?: RecordWhen the trial was last modified.
+ *The number of times to retry the job when the job fails due to an
+ * InternalServerError.
Who last modified the trial.
+ *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 */ - LastModifiedBy?: UserContext; + RemoteDebugConfig?: RemoteDebugConfig; /** - *Metadata properties of the tracking entity, trial, or trial component.
+ *Contains information about the infrastructure health check configuration for the training job.
* @public */ - MetadataProperties?: MetadataProperties; + InfraCheckConfig?: InfraCheckConfig; } /** * @public */ -export interface DescribeTrialComponentRequest { +export interface DescribeTransformJobRequest { /** - *The name of the trial component to describe.
+ *The name of the transform job that you want to view details of.
* @public */ - TrialComponentName: string | undefined; + TransformJobName: string | undefined; } /** - *A summary of the metrics of a trial component.
* @public + * @enum */ -export interface TrialComponentMetricSummary { +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 name of the metric.
+ *The name of the transform job.
* @public */ - MetricName?: string; + TransformJobName: string | undefined; /** - *The Amazon Resource Name (ARN) of the source.
+ *The Amazon Resource Name (ARN) of the transform job.
* @public */ - SourceArn?: string; + TransformJobArn: string | undefined; /** - *When the metric was last updated.
+ *The
+ * status of the transform job. If the transform job failed, the reason
+ * is returned in the FailureReason field.
The maximum value of the metric.
+ *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 minimum value of the metric.
+ *The name of the model used in the transform job.
* @public */ - Min?: number; + ModelName: string | undefined; /** - *The most recent value of the metric.
+ *The + * maximum number + * of + * parallel requests on each instance node + * that can be launched in a transform job. The default value is 1.
* @public */ - Last?: number; + MaxConcurrentTransforms?: number; /** - *The number of samples used to generate the metric.
+ *The timeout and maximum number of retries for processing a transform job + * invocation.
* @public */ - Count?: number; + ModelClientConfig?: ModelClientConfig; /** - *The average value of the metric.
+ *The + * maximum + * payload size, in MB, used in the + * transform job.
* @public */ - Avg?: number; + MaxPayloadInMB?: number; /** - *The standard deviation of the metric.
+ *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 Amazon Resource Name (ARN) and job type of the source of a trial component.
- * @public - */ -export interface TrialComponentSource { /** - *The source Amazon Resource Name (ARN).
+ *The + * environment variables to set in the Docker container. We support up to 16 key and values + * entries in the map.
* @public */ - SourceArn: string | undefined; + Environment?: RecordThe source job type.
+ *Describes the dataset to be transformed and the Amazon S3 location where it is + * stored.
* @public */ - SourceType?: string; -} + TransformInput: TransformInput | undefined; -/** - * @public - */ -export interface DescribeTrialComponentResponse { /** - *The name of the trial component.
+ *Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the + * transform job.
* @public */ - TrialComponentName?: string; + TransformOutput?: TransformOutput; /** - *The Amazon Resource Name (ARN) of the trial component.
+ *Configuration to control how SageMaker captures inference data.
* @public */ - TrialComponentArn?: string; + DataCaptureConfig?: BatchDataCaptureConfig; /** - *The name of the component as displayed. If DisplayName isn't specified,
- * TrialComponentName is displayed.
Describes + * the resources, including ML instance types and ML instance count, to + * use for the transform job.
* @public */ - DisplayName?: string; + TransformResources: TransformResources | undefined; /** - *The Amazon Resource Name (ARN) of the source and, optionally, the job type.
+ *A timestamp that shows when the transform Job was created.
* @public */ - Source?: TrialComponentSource; + CreationTime: Date | undefined; /** - *The status of the component. States include:
+ *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.
The Amazon Resource Name (ARN) of the Amazon SageMaker Ground Truth labeling job that created the + * transform or training job.
+ * @public + */ + LabelingJobArn?: string; + + /** + *The Amazon Resource Name (ARN) of the AutoML transform job.
+ * @public + */ + AutoMLJobArn?: string; + + /** + *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; + + /** + *Associates a SageMaker job as a trial component with an experiment and trial. Specified when + * you call the following APIs:
*InProgress
+ *+ * CreateProcessingJob + *
*Completed
+ *+ * CreateTrainingJob + *
*Failed
+ *+ * CreateTransformJob + *
*When the component started.
+ *The name of the trial to describe.
* @public */ - StartTime?: Date; + TrialName: string | undefined; +} +/** + *The source of the trial.
+ * @public + */ +export interface TrialSource { /** - *When the component ended.
+ *The Amazon Resource Name (ARN) of the source.
* @public */ - EndTime?: Date; + SourceArn: string | undefined; /** - *When the component was created.
+ *The source job type.
* @public */ - CreationTime?: Date; + SourceType?: string; +} +/** + * @public + */ +export interface DescribeTrialResponse { /** - *Who created the trial component.
+ *The name of the trial.
* @public */ - CreatedBy?: UserContext; + TrialName?: string; /** - *When the component was last modified.
+ *The Amazon Resource Name (ARN) of the trial.
* @public */ - LastModifiedTime?: Date; + TrialArn?: string; /** - *Who last modified the component.
+ *The name of the trial as displayed. If DisplayName isn't specified,
+ * TrialName is displayed.
The hyperparameters of the component.
+ *The name of the experiment the trial is part of.
* @public */ - Parameters?: RecordThe input artifacts of the component.
+ *The Amazon Resource Name (ARN) of the source and, optionally, the job type.
* @public */ - InputArtifacts?: RecordThe output artifacts of the component.
+ *When the trial was created.
* @public */ - OutputArtifacts?: RecordMetadata properties of the tracking entity, trial, or trial component.
+ *Who created the trial.
* @public */ - MetadataProperties?: MetadataProperties; + CreatedBy?: UserContext; /** - *The metrics for the component.
+ *When the trial was last modified.
* @public */ - Metrics?: TrialComponentMetricSummary[]; + LastModifiedTime?: Date; /** - *The Amazon Resource Name (ARN) of the lineage group.
+ *Who last modified the trial.
* @public */ - LineageGroupArn?: string; + LastModifiedBy?: UserContext; /** - *A list of ARNs and, if applicable, job types for multiple sources of an experiment - * run.
+ *Metadata properties of the tracking entity, trial, or trial component.
* @public */ - Sources?: TrialComponentSource[]; + MetadataProperties?: MetadataProperties; } /** * @public */ -export interface DescribeUserProfileRequest { - /** - *The domain ID.
- * @public - */ - DomainId: string | undefined; - +export interface DescribeTrialComponentRequest { /** - *The user profile name. This value is not case sensitive.
+ *The name of the trial component to describe.
* @public */ - UserProfileName: string | undefined; + TrialComponentName: string | 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]; - -/** + *A summary of the metrics of a trial component.
* @public */ -export interface DescribeUserProfileResponse { +export interface TrialComponentMetricSummary { /** - *The ID of the domain that contains the profile.
+ *The name of the metric.
* @public */ - DomainId?: string; + MetricName?: string; /** - *The user profile Amazon Resource Name (ARN).
+ *The Amazon Resource Name (ARN) of the source.
* @public */ - UserProfileArn?: string; + SourceArn?: string; /** - *The user profile name.
+ *When the metric was last updated.
* @public */ - UserProfileName?: string; + TimeStamp?: Date; /** - *The ID of the user's profile in the Amazon Elastic File System volume.
+ *The maximum value of the metric.
* @public */ - HomeEfsFileSystemUid?: string; + Max?: number; /** - *The status.
+ *The minimum value of the metric.
* @public */ - Status?: UserProfileStatus; + Min?: number; /** - *The last modified time.
+ *The most recent value of the metric.
* @public */ - LastModifiedTime?: Date; + Last?: number; /** - *The creation time.
+ *The number of samples used to generate the metric.
* @public */ - CreationTime?: Date; + Count?: number; /** - *The failure reason.
+ *The average value of the metric.
* @public */ - FailureReason?: string; + Avg?: number; /** - *The IAM Identity Center user identifier.
+ *The standard deviation of the metric.
* @public */ - SingleSignOnUserIdentifier?: string; + StdDev?: number; +} +/** + *The Amazon Resource Name (ARN) and job type of the source of a trial component.
+ * @public + */ +export interface TrialComponentSource { /** - *The IAM Identity Center user value.
+ *The source Amazon Resource Name (ARN).
* @public */ - SingleSignOnUserValue?: string; + SourceArn: string | undefined; /** - *A collection of settings.
+ *The source job type.
* @public */ - UserSettings?: UserSettings; + SourceType?: string; } /** * @public */ -export interface DescribeWorkforceRequest { +export interface DescribeTrialComponentResponse { /** - *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 name of the trial component.
* @public */ - WorkforceName: string | undefined; -} + TrialComponentName?: string; -/** - *Your OIDC IdP workforce configuration.
- * @public - */ -export interface OidcConfigForResponse { /** - *The OIDC IdP client ID used to configure your private workforce.
+ *The Amazon Resource Name (ARN) of the trial component.
* @public */ - ClientId?: string; + TrialComponentArn?: string; /** - *The OIDC IdP issuer used to configure your private workforce.
+ *The name of the component as displayed. If DisplayName isn't specified,
+ * TrialComponentName is displayed.
The OIDC IdP authorization endpoint used to configure your private workforce.
+ *The Amazon Resource Name (ARN) of the source and, optionally, the job type.
* @public */ - AuthorizationEndpoint?: string; + Source?: TrialComponentSource; /** - *The OIDC IdP token endpoint used to configure your private workforce.
+ *The status of the component. States include:
+ *InProgress
+ *Completed
+ *Failed
+ *When the component started.
+ * @public + */ + StartTime?: Date; + + /** + *When the component ended.
+ * @public + */ + EndTime?: Date; + + /** + *When the component was created.
+ * @public + */ + CreationTime?: Date; + + /** + *Who created the trial component.
+ * @public + */ + CreatedBy?: UserContext; + + /** + *When the component was last modified.
+ * @public + */ + LastModifiedTime?: Date; + + /** + *Who last modified the component.
+ * @public + */ + LastModifiedBy?: UserContext; + + /** + *The hyperparameters of the component.
+ * @public + */ + Parameters?: RecordThe input artifacts of the component.
+ * @public + */ + InputArtifacts?: RecordThe output artifacts of the component.
+ * @public + */ + OutputArtifacts?: RecordMetadata properties of the tracking entity, trial, or trial component.
+ * @public + */ + MetadataProperties?: MetadataProperties; + + /** + *The metrics for the component.
+ * @public + */ + Metrics?: TrialComponentMetricSummary[]; + + /** + *The Amazon Resource Name (ARN) of the lineage group.
+ * @public + */ + LineageGroupArn?: string; + + /** + *A list of ARNs and, if applicable, job types for multiple sources of an experiment + * run.
+ * @public + */ + Sources?: TrialComponentSource[]; +} + +/** + * @public + */ +export interface DescribeUserProfileRequest { + /** + *The domain ID.
+ * @public + */ + DomainId: string | undefined; + + /** + *The user profile name. This value is not case sensitive.
+ * @public + */ + UserProfileName: string | 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]; + +/** + * @public + */ +export interface DescribeUserProfileResponse { + /** + *The ID of the domain that contains the profile.
+ * @public + */ + DomainId?: string; + + /** + *The user profile Amazon Resource Name (ARN).
+ * @public + */ + UserProfileArn?: string; + + /** + *The user profile name.
+ * @public + */ + UserProfileName?: string; + + /** + *The ID of the user's profile in the Amazon Elastic File System volume.
+ * @public + */ + HomeEfsFileSystemUid?: string; + + /** + *The status.
+ * @public + */ + Status?: UserProfileStatus; + + /** + *The last modified time.
+ * @public + */ + LastModifiedTime?: Date; + + /** + *The creation time.
+ * @public + */ + CreationTime?: Date; + + /** + *The failure reason.
+ * @public + */ + FailureReason?: string; + + /** + *The IAM Identity Center user identifier.
+ * @public + */ + SingleSignOnUserIdentifier?: string; + + /** + *The IAM Identity Center user value.
+ * @public + */ + SingleSignOnUserValue?: string; + + /** + *A collection of settings.
+ * @public + */ + UserSettings?: UserSettings; +} + +/** + * @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 OIDC IdP client ID used to configure your private workforce.
+ * @public + */ + ClientId?: string; + + /** + *The OIDC IdP issuer used to configure your private workforce.
+ * @public + */ + Issuer?: string; + + /** + *The OIDC IdP authorization endpoint used to configure your private workforce.
+ * @public + */ + AuthorizationEndpoint?: string; + + /** + *The OIDC IdP token endpoint used to configure your private workforce.
* @public */ TokenEndpoint?: string; @@ -3681,1469 +4044,1144 @@ export interface Experiment { */ Source?: ExperimentSource; - /** - *The description of the experiment.
- * @public - */ - Description?: string; - - /** - *When the experiment was created.
- * @public - */ - CreationTime?: Date; - - /** - *Who created the experiment.
- * @public - */ - CreatedBy?: UserContext; - - /** - *When the experiment was last modified.
- * @public - */ - LastModifiedTime?: Date; - - /** - *Information about the user who created or modified an experiment, trial, trial - * component, lineage group, project, or model card.
- * @public - */ - LastModifiedBy?: UserContext; - - /** - *The list of tags that are associated with the experiment. You can use Search API to search on the tags.
- * @public - */ - Tags?: Tag[]; -} - -/** - *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.
- * @public - */ - ExperimentArn?: string; - - /** - *The name of the experiment.
- * @public - */ - ExperimentName?: string; - - /** - *The name of the experiment as displayed. If DisplayName isn't specified,
- * ExperimentName is displayed.
The source of the experiment.
- * @public - */ - ExperimentSource?: ExperimentSource; - - /** - *When the experiment was created.
- * @public - */ - CreationTime?: Date; - - /** - *When the experiment was last modified.
- * @public - */ - LastModifiedTime?: Date; -} - -/** - *The container for the metadata for Fail step.
- * @public - */ -export interface FailStepMetadata { - /** - *A message that you define and then is processed and rendered by - * the Fail step when the error occurs.
- * @public - */ - ErrorMessage?: string; -} - -/** - *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 Amazon Resource Name (ARN) of a FeatureGroup.
The name of the FeatureGroup.
The name of the Feature whose value uniquely identifies a
- * Record defined in the FeatureGroup
- * FeatureDefinitions.
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.
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 time a FeatureGroup was created.
A timestamp indicating the last time you updated the feature group.
- * @public - */ - LastModifiedTime?: Date; - - /** - *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.
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.
The Amazon Resource Name (ARN) of the IAM execution role used to create the feature - * group.
- * @public - */ - RoleArn?: string; - - /** - *A FeatureGroup status.
The status of OfflineStore.
A value that indicates whether the feature group was updated successfully.
- * @public - */ - LastUpdateStatus?: LastUpdateStatus; - - /** - *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.
A free form description of a FeatureGroup.
Tags used to define a FeatureGroup.
The name, ARN, CreationTime, FeatureGroup values,
- * LastUpdatedTime and EnableOnlineStorage status of a
- * FeatureGroup.
The name of FeatureGroup.
Unique identifier for the FeatureGroup.
A timestamp indicating the time of creation time of the
- * FeatureGroup.
The status of a FeatureGroup. The status can be any of the following:
- * Creating, Created, CreateFail,
- * Deleting or DetailFail.
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 FeatureMetadata { - /** - *The Amazon Resource Number (ARN) of the feature group.
- * @public - */ - FeatureGroupArn?: string; - - /** - *The name of the feature group containing the feature.
- * @public - */ - FeatureGroupName?: string; - - /** - *The name of feature.
- * @public - */ - FeatureName?: string; - - /** - *The data type of the feature.
- * @public - */ - FeatureType?: FeatureType; - - /** - *A timestamp indicating when the feature was created.
- * @public - */ - CreationTime?: Date; - - /** - *A timestamp indicating when the feature was last modified.
- * @public - */ - LastModifiedTime?: Date; - - /** - *An optional description that you specify to better describe the feature.
- * @public - */ - Description?: string; - - /** - *Optional key-value pairs that you specify to better describe the feature.
- * @public - */ - Parameters?: FeatureParameter[]; -} - -/** - * @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..
A resource property name. For example, TrainingJobName. For
- * valid property names, see SearchRecord.
- * You must specify a valid property for the resource.
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."
The description of the experiment.
* @public */ - Operator?: Operator; + Description?: string; /** - *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.
When the experiment was created.
* @public */ - Value?: string; + CreationTime?: Date; + + /** + *Who created the experiment.
+ * @public + */ + CreatedBy?: UserContext; + + /** + *When the experiment was last modified.
+ * @public + */ + LastModifiedTime?: Date; + + /** + *Information about the user who created or modified an experiment, trial, trial + * component, lineage group, project, or model card.
+ * @public + */ + LastModifiedBy?: UserContext; + + /** + *The list of tags that are associated with the experiment. You can use Search API to search on the tags.
+ * @public + */ + Tags?: Tag[]; } /** - *Contains summary information about the flow definition.
+ *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 flow definition.
+ *The Amazon Resource Name (ARN) of the experiment.
* @public */ - FlowDefinitionName: string | undefined; + ExperimentArn?: string; /** - *The Amazon Resource Name (ARN) of the flow definition.
+ *The name of the experiment.
* @public */ - FlowDefinitionArn: string | undefined; + ExperimentName?: string; /** - *The status of the flow definition. Valid values:
+ *The name of the experiment as displayed. If DisplayName isn't specified,
+ * ExperimentName is displayed.
The timestamp when SageMaker created the flow definition.
+ *The source of the experiment.
* @public */ - CreationTime: Date | undefined; + ExperimentSource?: ExperimentSource; /** - *The reason why the flow definition creation failed. A failure reason is returned only when the flow definition status is Failed.
When the experiment was created.
* @public */ - FailureReason?: string; + CreationTime?: Date; + + /** + *When the experiment was last modified.
+ * @public + */ + LastModifiedTime?: Date; } /** + *The container for the metadata for Fail step.
* @public */ -export interface GetDeviceFleetReportRequest { +export interface FailStepMetadata { /** - *The name of the fleet.
+ *A message that you define and then is processed and rendered by + * the Fail step when the error occurs.
* @public */ - DeviceFleetName: string | undefined; + ErrorMessage?: string; } /** + *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 GetDeviceFleetReportResponse { +export interface FeatureGroup { /** - *The Amazon Resource Name (ARN) of the device.
+ *The Amazon Resource Name (ARN) of a FeatureGroup.
The name of the fleet.
+ *The name of the FeatureGroup.
The output configuration for storing sample data collected by the fleet.
+ *The name of the Feature whose value uniquely identifies a
+ * Record defined in the FeatureGroup
+ * FeatureDefinitions.
Description of the fleet.
+ *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.
Timestamp of when the report was generated.
+ *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.
Status of devices.
+ *The time a FeatureGroup was created.
The versions of Edge Manager agent deployed on the fleet.
+ *A timestamp indicating the last time you updated the feature group.
* @public */ - AgentVersions?: AgentVersion[]; + LastModifiedTime?: Date; /** - *Status of model on device.
+ *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.
The name or Amazon Resource Name (ARN) of the lineage group.
+ *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.
The Amazon Resource Name (ARN) of the lineage group.
+ *The Amazon Resource Name (ARN) of the IAM execution role used to create the feature + * group.
* @public */ - LineageGroupArn?: string; + RoleArn?: string; /** - *The resource policy that gives access to the lineage group in another account.
+ *A FeatureGroup status.
The name of the model group for which to get the resource policy.
+ *The status of OfflineStore.
The resource policy for the model group.
+ *A value that indicates whether the feature group was updated successfully.
* @public */ - ResourcePolicy: string | undefined; -} + LastUpdateStatus?: LastUpdateStatus; -/** - * @public - */ -export interface GetSagemakerServicecatalogPortfolioStatusInput {} + /** + *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.
A free form description of a FeatureGroup.
Tags used to define a FeatureGroup.
Whether Service Catalog is enabled or disabled in SageMaker.
- * @public - */ - Status?: SagemakerServicecatalogStatus; -} +export const FeatureGroupSortOrder = { + ASCENDING: "Ascending", + DESCENDING: "Descending", +} as const; /** - *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.
- * @public - */ - MinInvocationsPerMinute?: number; - - /** - *The maximum number of expected requests to your endpoint per minute.
- * @public - */ - MaxInvocationsPerMinute?: number; -} +export type FeatureGroupSortOrder = (typeof FeatureGroupSortOrder)[keyof typeof FeatureGroupSortOrder]; /** + *The name, ARN, CreationTime, FeatureGroup values,
+ * LastUpdatedTime and EnableOnlineStorage status of a
+ * FeatureGroup.
The name of a previously completed Inference Recommender job.
+ *The name of FeatureGroup.
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.
Unique identifier for the FeatureGroup.
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.
A timestamp indicating the time of creation time of the
+ * FeatureGroup.
The percentage of how much utilization you want an instance to use before autoscaling. The default value is 50%.
+ *The status of a FeatureGroup. The status can be any of the following:
+ * Creating, Created, CreateFail,
+ * Deleting or DetailFail.
An object where you specify the anticipated traffic pattern for an endpoint.
+ *Notifies you if replicating data into the OfflineStore has failed. Returns
+ * either: Active or Blocked.
The metric for a scaling policy.
+ *The metadata for a feature. It can either be metadata that you specify, or metadata that + * is updated automatically.
* @public */ -export interface ScalingPolicyMetric { +export interface FeatureMetadata { /** - *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.
The Amazon Resource Number (ARN) of the feature group.
* @public */ - InvocationsPerInstance?: number; + FeatureGroupArn?: string; /** - *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 name of the feature group containing the feature.
* @public */ - ModelLatency?: number; -} + FeatureGroupName?: string; -/** - * @public - */ -export interface GetScalingConfigurationRecommendationResponse { /** - *The name of a previously completed Inference Recommender job.
+ *The name of feature.
* @public */ - InferenceRecommendationsJobName?: string; + FeatureName?: string; /** - *The recommendation ID of a previously completed inference recommendation.
+ *The data type of the feature.
* @public */ - RecommendationId?: string; + FeatureType?: FeatureType; /** - *The name of an endpoint benchmarked during a previously completed Inference Recommender job.
+ *A timestamp indicating when the feature was created.
* @public */ - EndpointName?: string; + CreationTime?: Date; /** - *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%.
+ *A timestamp indicating when the feature was last modified.
* @public */ - TargetCpuUtilizationPerCore?: number; + LastModifiedTime?: Date; /** - *An object representing the anticipated traffic pattern for an endpoint that you specified in the request.
+ *An optional description that you specify to better describe the feature.
* @public */ - ScalingPolicyObjective?: ScalingPolicyObjective; + Description?: string; /** - *An object with a list of metrics that were benchmarked during the previously completed Inference Recommender job.
+ *Optional key-value pairs that you specify to better describe the feature.
* @public */ - Metric?: ScalingPolicyMetric; + Parameters?: FeatureParameter[]; +} + +/** + * @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..
A resource property name. For example, TrainingJobName. For
+ * valid property names, see SearchRecord.
+ * You must specify a valid property for the resource.
An object with the recommended values for you to specify when creating an autoscaling policy.
+ *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."
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.
+ *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.
Specified in the GetSearchSuggestions request. - * Limits the property names that are included in the response.
+ *Contains summary information about the flow definition.
* @public */ -export interface SuggestionQuery { +export interface FlowDefinitionSummary { /** - *Defines a property name hint. Only property - * names that begin with the specified hint are included in the response.
+ *The name of the flow definition.
* @public */ - PropertyNameQuery?: PropertyNameQuery; -} + FlowDefinitionName: string | undefined; -/** - * @public - */ -export interface GetSearchSuggestionsRequest { /** - *The name of the SageMaker resource to search for.
+ *The Amazon Resource Name (ARN) of the flow definition.
* @public */ - Resource: ResourceType | undefined; + FlowDefinitionArn: string | undefined; /** - *Limits the property names that are included in the response.
+ *The status of the flow definition. Valid values:
* @public */ - SuggestionQuery?: SuggestionQuery; -} + FlowDefinitionStatus: FlowDefinitionStatus | 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 timestamp when SageMaker created the flow definition.
* @public */ - PropertyName?: string; -} + CreationTime: Date | undefined; -/** - * @public - */ -export interface GetSearchSuggestionsResponse { /** - *A list of property names for a Resource that match a
- * SuggestionQuery.
The reason why the flow definition creation failed. A failure reason is returned only when the flow definition status is Failed.
Specifies configuration details for a Git repository when the repository is - * updated.
* @public */ -export interface GitConfigForUpdate { +export interface GetDeviceFleetReportRequest { /** - *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 fleet.
* @public */ - SecretArn?: string; + DeviceFleetName: string | undefined; } /** - *Information about hub content.
* @public */ -export interface HubContentInfo { - /** - *The name of the hub content.
- * @public - */ - HubContentName: string | undefined; - - /** - *The Amazon Resource Name (ARN) of the hub content.
- * @public - */ - HubContentArn: string | undefined; - +export interface GetDeviceFleetReportResponse { /** - *The version of the hub content.
+ *The Amazon Resource Name (ARN) of the device.
* @public */ - HubContentVersion: string | undefined; + DeviceFleetArn: string | undefined; /** - *The type of hub content.
+ *The name of the fleet.
* @public */ - HubContentType: HubContentType | undefined; + DeviceFleetName: string | undefined; /** - *The version of the hub content document schema.
+ *The output configuration for storing sample data collected by the fleet.
* @public */ - DocumentSchemaVersion: string | undefined; + OutputConfig?: EdgeOutputConfig; /** - *The display name of the hub content.
+ *Description of the fleet.
* @public */ - HubContentDisplayName?: string; + Description?: string; /** - *A description of the hub content.
+ *Timestamp of when the report was generated.
* @public */ - HubContentDescription?: string; + ReportGenerated?: Date; /** - *The searchable keywords for the hub content.
+ *Status of devices.
* @public */ - HubContentSearchKeywords?: string[]; + DeviceStats?: DeviceStats; /** - *The status of the hub content.
+ *The versions of Edge Manager agent deployed on the fleet.
* @public */ - HubContentStatus: HubContentStatus | undefined; + AgentVersions?: AgentVersion[]; /** - *The date and time that the hub content was created.
+ *Status of model on device.
* @public */ - CreationTime: Date | undefined; + ModelStats?: EdgeModelStat[]; } /** - * @public - * @enum - */ -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 { - /** - *The name of the hub.
- * @public - */ - HubName: string | undefined; - - /** - *The Amazon Resource Name (ARN) of the hub.
- * @public - */ - HubArn: string | undefined; - - /** - *The display name of the hub.
- * @public - */ - HubDisplayName?: string; - +export interface GetLineageGroupPolicyRequest { /** - *A description of the hub.
+ *The name or Amazon Resource Name (ARN) of the lineage group.
* @public */ - HubDescription?: string; + LineageGroupName: string | undefined; +} +/** + * @public + */ +export interface GetLineageGroupPolicyResponse { /** - *The searchable keywords for the hub.
+ *The Amazon Resource Name (ARN) of the lineage group.
* @public */ - HubSearchKeywords?: string[]; + LineageGroupArn?: string; /** - *The status of the hub.
+ *The resource policy that gives access to the lineage group in another account.
* @public */ - HubStatus: HubStatus | undefined; + ResourcePolicy?: string; +} +/** + * @public + */ +export interface GetModelPackageGroupPolicyInput { /** - *The date and time that the hub was created.
+ *The name of the model group for which to get the resource policy.
* @public */ - CreationTime: Date | undefined; + ModelPackageGroupName: string | undefined; +} +/** + * @public + */ +export interface GetModelPackageGroupPolicyOutput { /** - *The date and time that the hub was last modified.
+ *The resource policy for the model group.
* @public */ - LastModifiedTime: Date | undefined; + ResourcePolicy: string | undefined; } /** * @public - * @enum */ -export const HubSortBy = { - ACCOUNT_ID_OWNER: "AccountIdOwner", - CREATION_TIME: "CreationTime", - HUB_NAME: "HubName", - HUB_STATUS: "HubStatus", +export interface GetSagemakerServicecatalogPortfolioStatusInput {} + +/** + * @public + * @enum + */ +export const SagemakerServicecatalogStatus = { + DISABLED: "Disabled", + ENABLED: "Enabled", } as const; /** * @public */ -export type HubSortBy = (typeof HubSortBy)[keyof typeof HubSortBy]; +export type SagemakerServicecatalogStatus = + (typeof SagemakerServicecatalogStatus)[keyof typeof SagemakerServicecatalogStatus]; /** - *Container for human task user interface information.
* @public */ -export interface HumanTaskUiSummary { +export interface GetSagemakerServicecatalogPortfolioStatusOutput { /** - *The name of the human task user interface.
+ *Whether Service Catalog is enabled or disabled in SageMaker.
* @public */ - HumanTaskUiName: string | undefined; + Status?: SagemakerServicecatalogStatus; +} +/** + *An object where you specify the anticipated traffic pattern for an endpoint.
+ * @public + */ +export interface ScalingPolicyObjective { /** - *The Amazon Resource Name (ARN) of the human task user interface.
+ *The minimum number of expected requests to your endpoint per minute.
* @public */ - HumanTaskUiArn: string | undefined; + MinInvocationsPerMinute?: number; /** - *A timestamp when SageMaker created the human task user interface.
+ *The maximum number of expected requests to your endpoint per minute.
* @public */ - CreationTime: Date | undefined; + MaxInvocationsPerMinute?: number; } /** - *An entity returned by the SearchRecord API - * containing the properties of a hyperparameter tuning job.
* @public */ -export interface HyperParameterTuningJobSearchEntity { +export interface GetScalingConfigurationRecommendationRequest { /** - *The name of a hyperparameter tuning job.
+ *The name of a previously completed Inference Recommender job.
* @public */ - HyperParameterTuningJobName?: string; + InferenceRecommendationsJobName: string | undefined; /** - *The Amazon Resource Name (ARN) of a hyperparameter tuning job.
+ *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.
Configures a hyperparameter tuning job.
+ *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.
Defines - * the training jobs launched by a hyperparameter tuning job.
+ *The percentage of how much utilization you want an instance to use before autoscaling. The default value is 50%.
* @public */ - TrainingJobDefinition?: HyperParameterTrainingJobDefinition; + TargetCpuUtilizationPerCore?: number; /** - *The job definitions included in a hyperparameter tuning job.
+ *An object where you specify the anticipated traffic pattern for an endpoint.
* @public */ - TrainingJobDefinitions?: HyperParameterTrainingJobDefinition[]; + ScalingPolicyObjective?: ScalingPolicyObjective; +} +/** + *The metric for a scaling policy.
+ * @public + */ +export interface ScalingPolicyMetric { /** - *The status of a hyperparameter tuning job.
+ *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.
The time that a hyperparameter tuning job was created.
+ *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 */ - CreationTime?: Date; + ModelLatency?: number; +} +/** + * @public + */ +export interface GetScalingConfigurationRecommendationResponse { /** - *The time that a hyperparameter tuning job ended.
+ *The name of a previously completed Inference Recommender job.
* @public */ - HyperParameterTuningEndTime?: Date; + InferenceRecommendationsJobName?: string; /** - *The time that a hyperparameter tuning job was last modified.
+ *The recommendation ID of a previously completed inference recommendation.
* @public */ - LastModifiedTime?: Date; + RecommendationId?: string; /** - *The numbers of training jobs launched by a hyperparameter tuning job, categorized by - * status.
+ *The name of an endpoint benchmarked during a previously completed Inference Recommender job.
* @public */ - TrainingJobStatusCounters?: TrainingJobStatusCounters; + EndpointName?: string; /** - *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.
+ *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 */ - ObjectiveStatusCounters?: ObjectiveStatusCounters; + TargetCpuUtilizationPerCore?: number; /** - *The container for the summary information about a training job.
+ *An object representing the anticipated traffic pattern for an endpoint that you specified in the request.
* @public */ - BestTrainingJob?: HyperParameterTrainingJobSummary; + ScalingPolicyObjective?: ScalingPolicyObjective; /** - *The container for the summary information about a training job.
+ *An object with a list of metrics that were benchmarked during the previously completed Inference Recommender job.
* @public */ - OverallBestTrainingJob?: HyperParameterTrainingJobSummary; + Metric?: ScalingPolicyMetric; /** - *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.
- *An object with the recommended values for you to specify when creating an autoscaling policy.
* @public */ - WarmStartConfig?: HyperParameterTuningJobWarmStartConfig; + DynamicScalingConfiguration?: DynamicScalingConfiguration; +} + +/** + * @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.
The error that was created when a hyperparameter tuning job failed.
+ *Text that begins a property's name.
* @public */ - FailureReason?: string; + PropertyNameHint: string | undefined; +} +/** + *Specified in the GetSearchSuggestions request. + * Limits the property names that are included in the response.
+ * @public + */ +export interface SuggestionQuery { /** - *Information about either a current or completed hyperparameter tuning job.
+ *Defines a property name hint. Only property + * names that begin with the specified hint are included in the response.
* @public */ - TuningJobCompletionDetails?: HyperParameterTuningJobCompletionDetails; + PropertyNameQuery?: PropertyNameQuery; +} +/** + * @public + */ +export interface GetSearchSuggestionsRequest { /** - *The total amount of resources consumed by a hyperparameter tuning job.
+ *The name of the SageMaker resource to search for.
* @public */ - ConsumedResources?: HyperParameterTuningJobConsumedResources; + Resource: ResourceType | undefined; /** - *The tags associated with a hyperparameter tuning job. For more information see Tagging Amazon Web Services resources.
+ *Limits the property names that are included in the response.
* @public */ - Tags?: Tag[]; + SuggestionQuery?: SuggestionQuery; } /** + *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.
+ * @public + */ + PropertyName?: string; +} /** * @public */ -export type HyperParameterTuningJobSortByOptions = - (typeof HyperParameterTuningJobSortByOptions)[keyof typeof HyperParameterTuningJobSortByOptions]; +export interface GetSearchSuggestionsResponse { + /** + *A list of property names for a Resource that match a
+ * SuggestionQuery.
Provides summary information about a hyperparameter tuning job.
+ *Specifies configuration details for a Git repository when the repository is + * updated.
* @public */ -export interface HyperParameterTuningJobSummary { +export interface GitConfigForUpdate { /** - *The name of the tuning job.
+ *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 HubContentInfo { + /** + *The name of the hub content.
+ * @public + */ + HubContentName: string | undefined; /** - *The - * Amazon - * Resource Name (ARN) of the tuning job.
+ *The Amazon Resource Name (ARN) of the hub content.
* @public */ - HyperParameterTuningJobArn: string | undefined; + HubContentArn: string | undefined; /** - *The status of the - * tuning - * job.
+ *The version of the hub content.
* @public */ - HyperParameterTuningJobStatus: HyperParameterTuningJobStatus | undefined; + HubContentVersion: string | undefined; /** - *Specifies the search strategy hyperparameter tuning uses to choose which - * hyperparameters to - * evaluate - * at each iteration.
+ *The type of hub content.
* @public */ - Strategy: HyperParameterTuningJobStrategyType | undefined; + HubContentType: HubContentType | undefined; /** - *The date and time that the tuning job was created.
+ *The version of the hub content document schema.
* @public */ - CreationTime: Date | undefined; + DocumentSchemaVersion: string | undefined; /** - *The date and time that the tuning job ended.
+ *The display name of the hub content.
* @public */ - HyperParameterTuningEndTime?: Date; + HubContentDisplayName?: string; /** - *The date and time that the tuning job was - * modified.
+ *A description of the hub content.
* @public */ - LastModifiedTime?: Date; + HubContentDescription?: string; /** - *The TrainingJobStatusCounters object that specifies the numbers of training - * jobs, categorized by status, that this tuning job launched.
+ *The searchable keywords for the hub content.
* @public */ - TrainingJobStatusCounters: TrainingJobStatusCounters | undefined; + HubContentSearchKeywords?: string[]; /** - *The ObjectiveStatusCounters object that specifies the numbers of training jobs, - * categorized by objective metric status, that this tuning job launched.
+ *The status of the hub content.
* @public */ - ObjectiveStatusCounters: ObjectiveStatusCounters | undefined; + HubContentStatus: HubContentStatus | undefined; /** - *The ResourceLimits - * object that specifies the maximum number of training jobs and parallel training jobs - * allowed for this tuning job.
+ *The date and time that the hub content was created.
* @public */ - ResourceLimits?: ResourceLimits; + CreationTime: Date | 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.
Information about a hub.
+ * @public + */ +export interface HubInfo { /** - *When the image was created.
+ *The name of the hub.
* @public */ - CreationTime: Date | undefined; + HubName: string | undefined; /** - *The description of the image.
+ *The Amazon Resource Name (ARN) of the hub.
* @public */ - Description?: string; + HubArn: string | undefined; /** - *The name of the image as displayed.
+ *The display name of the hub.
* @public */ - DisplayName?: string; + HubDisplayName?: string; /** - *When a create, update, or delete operation fails, the reason for the failure.
+ *A description of the hub.
* @public */ - FailureReason?: string; + HubDescription?: string; /** - *The ARN of the image.
+ *The searchable keywords for the hub.
* @public */ - ImageArn: string | undefined; + HubSearchKeywords?: string[]; /** - *The name of the image.
+ *The status of the hub.
* @public */ - ImageName: string | undefined; + HubStatus: HubStatus | undefined; /** - *The status of the image.
+ *The date and time that the hub was created.
* @public */ - ImageStatus: ImageStatus | undefined; + CreationTime: Date | undefined; /** - *When the image was last modified.
+ *The date and time that the hub was last modified.
* @public */ LastModifiedTime: Date | undefined; @@ -5153,202 +5191,182 @@ export interface Image { * @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", +export const HubSortBy = { + ACCOUNT_ID_OWNER: "AccountIdOwner", + CREATION_TIME: "CreationTime", + HUB_NAME: "HubName", + HUB_STATUS: "HubStatus", } as const; /** * @public */ -export type ImageSortOrder = (typeof ImageSortOrder)[keyof typeof ImageSortOrder]; +export type HubSortBy = (typeof HubSortBy)[keyof typeof HubSortBy]; /** - *A version of a SageMaker Image. A version represents an existing container
- * image.
Container for human task user interface information.
* @public */ -export interface ImageVersion { +export interface HumanTaskUiSummary { /** - *When the version was created.
+ *The name of the human task user interface.
* @public */ - CreationTime: Date | undefined; + HumanTaskUiName: string | undefined; /** - *When a create or delete operation fails, the reason for the failure.
+ *The Amazon Resource Name (ARN) of the human task user interface.
* @public */ - FailureReason?: string; + HumanTaskUiArn: string | undefined; /** - *The ARN of the image the version is based on.
+ *A timestamp when SageMaker created the human task user interface.
* @public */ - ImageArn: string | undefined; + CreationTime: Date | undefined; +} +/** + *An entity returned by the SearchRecord API + * containing the properties of a hyperparameter tuning job.
+ * @public + */ +export interface HyperParameterTuningJobSearchEntity { /** - *The ARN of the version.
+ *The name of a hyperparameter tuning job.
* @public */ - ImageVersionArn: string | undefined; + HyperParameterTuningJobName?: string; /** - *The status of the version.
+ *The Amazon Resource Name (ARN) of a hyperparameter tuning job.
* @public */ - ImageVersionStatus: ImageVersionStatus | undefined; + HyperParameterTuningJobArn?: string; /** - *When the version was last modified.
+ *Configures a hyperparameter tuning job.
* @public */ - LastModifiedTime: Date | undefined; + HyperParameterTuningJobConfig?: HyperParameterTuningJobConfig; /** - *The version number.
+ *Defines + * the training jobs launched by a hyperparameter tuning job.
* @public */ - Version: 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; + TrainingJobDefinition?: HyperParameterTrainingJobDefinition; -/** - * @public - */ -export type ImageVersionSortOrder = (typeof ImageVersionSortOrder)[keyof typeof ImageVersionSortOrder]; + /** + *The job definitions included in a hyperparameter tuning job.
+ * @public + */ + TrainingJobDefinitions?: HyperParameterTrainingJobDefinition[]; -/** - * @public - */ -export interface ImportHubContentRequest { /** - *The name of the hub content to import.
+ *The status of a hyperparameter tuning job.
* @public */ - HubContentName: string | undefined; + HyperParameterTuningJobStatus?: HyperParameterTuningJobStatus; /** - *The version of the hub content to import.
+ *The time that a hyperparameter tuning job was created.
* @public */ - HubContentVersion?: string; + CreationTime?: Date; /** - *The type of hub content to import.
+ *The time that a hyperparameter tuning job ended.
* @public */ - HubContentType: HubContentType | undefined; + HyperParameterTuningEndTime?: Date; /** - *The version of the hub content schema to import.
+ *The time that a hyperparameter tuning job was last modified.
* @public */ - DocumentSchemaVersion: string | undefined; + LastModifiedTime?: Date; /** - *The name of the hub to import content into.
+ *The numbers of training jobs launched by a hyperparameter tuning job, categorized by + * status.
* @public */ - HubName: string | undefined; + TrainingJobStatusCounters?: TrainingJobStatusCounters; /** - *The display name of the hub content to import.
+ *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 */ - HubContentDisplayName?: string; + ObjectiveStatusCounters?: ObjectiveStatusCounters; /** - *A description of the hub content to import.
+ *The container for the summary information about a training job.
* @public */ - HubContentDescription?: string; + BestTrainingJob?: HyperParameterTrainingJobSummary; /** - *A string that provides a description of the hub content. This string can include links, tables, and standard markdown formating.
+ *The container for the summary information about a training job.
* @public */ - HubContentMarkdown?: string; + OverallBestTrainingJob?: HyperParameterTrainingJobSummary; /** - *The hub content document that describes information about the hub content such as type, associated containers, scripts, and more.
+ *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 searchable keywords of the hub content.
+ *The error that was created when a hyperparameter tuning job failed.
* @public */ - HubContentSearchKeywords?: string[]; + FailureReason?: string; /** - *Any tags associated with the hub content.
+ *Information about either a current or completed hyperparameter tuning job.
* @public */ - Tags?: Tag[]; -} + TuningJobCompletionDetails?: HyperParameterTuningJobCompletionDetails; -/** - * @public - */ -export interface ImportHubContentResponse { /** - *The ARN of the hub that the content was imported into.
+ *The total amount of resources consumed by a hyperparameter tuning job.
* @public */ - HubArn: string | undefined; + ConsumedResources?: HyperParameterTuningJobConsumedResources; /** - *The ARN of the hub content that was imported.
+ *The tags associated with a hyperparameter tuning job. For more information see Tagging Amazon Web Services resources.
* @public */ - HubContentArn: string | undefined; + Tags?: Tag[]; } /** * @public * @enum */ -export const InferenceComponentSortKey = { +export const HyperParameterTuningJobSortByOptions = { CreationTime: "CreationTime", Name: "Name", Status: "Status", @@ -5357,960 +5375,947 @@ export const InferenceComponentSortKey = { /** * @public */ -export type InferenceComponentSortKey = (typeof InferenceComponentSortKey)[keyof typeof InferenceComponentSortKey]; +export type HyperParameterTuningJobSortByOptions = + (typeof HyperParameterTuningJobSortByOptions)[keyof typeof HyperParameterTuningJobSortByOptions]; /** - *A summary of the properties of an inference component.
+ *Provides summary information about a hyperparameter tuning job.
* @public */ -export interface InferenceComponentSummary { +export interface HyperParameterTuningJobSummary { /** - *The time when the inference component was created.
+ *The name of the tuning job.
* @public */ - CreationTime: Date | undefined; + HyperParameterTuningJobName: string | undefined; /** - *The Amazon Resource Name (ARN) of the inference component.
+ *The + * Amazon + * Resource Name (ARN) of the tuning job.
* @public */ - InferenceComponentArn: string | undefined; + HyperParameterTuningJobArn: string | undefined; /** - *The name of the inference component.
+ *The status of the + * tuning + * job.
* @public */ - InferenceComponentName: string | undefined; + HyperParameterTuningJobStatus: HyperParameterTuningJobStatus | undefined; /** - *The Amazon Resource Name (ARN) of the endpoint that hosts the inference component.
+ *Specifies the search strategy hyperparameter tuning uses to choose which + * hyperparameters to + * evaluate + * at each iteration.
* @public */ - EndpointArn: string | undefined; + Strategy: HyperParameterTuningJobStrategyType | undefined; /** - *The name of the endpoint that hosts the inference component.
+ *The date and time that the tuning job was created.
* @public */ - EndpointName: string | undefined; + CreationTime: Date | undefined; /** - *The name of the production variant that hosts the inference component.
+ *The date and time that the tuning job ended.
* @public */ - VariantName: string | undefined; + HyperParameterTuningEndTime?: Date; /** - *The status of the inference component.
+ *The date and time that the tuning job was + * modified.
* @public */ - InferenceComponentStatus?: InferenceComponentStatus; + LastModifiedTime?: Date; /** - *The time when the inference component was last updated.
+ *The TrainingJobStatusCounters object that specifies the numbers of training + * jobs, categorized by status, that this tuning job launched.
* @public */ - LastModifiedTime: Date | undefined; -} + TrainingJobStatusCounters: TrainingJobStatusCounters | undefined; -/** - *Lists a summary of properties of an inference experiment.
- * @public - */ -export interface InferenceExperimentSummary { /** - *The name of the inference experiment.
+ *The ObjectiveStatusCounters object that specifies the numbers of training jobs, + * categorized by objective metric status, that this tuning job launched.
* @public */ - Name: string | undefined; + ObjectiveStatusCounters: ObjectiveStatusCounters | undefined; /** - *The type of the inference experiment.
+ *The ResourceLimits + * object that specifies the maximum number of training jobs and parallel training jobs + * allowed for this tuning job.
* @public */ - Type: InferenceExperimentType | undefined; + ResourceLimits?: ResourceLimits; +} +/** + *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.
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.
+ *When the image was created.
* @public */ - Schedule?: InferenceExperimentSchedule; + CreationTime: Date | undefined; /** - *The status of the inference experiment.
+ *The description of the image.
* @public */ - Status: InferenceExperimentStatus | undefined; + Description?: string; /** - *The error message for the inference experiment status result.
+ *The name of the image as displayed.
* @public */ - StatusReason?: string; + DisplayName?: string; /** - *The description of the inference experiment.
+ *When a create, update, or delete operation fails, the reason for the failure.
* @public */ - Description?: string; + FailureReason?: string; /** - *The timestamp at which the inference experiment was created.
+ *The ARN of the image.
* @public */ - CreationTime: Date | undefined; + ImageArn: string | undefined; /** - *The timestamp at which the inference experiment was completed.
+ *The name of the image.
* @public */ - CompletionTime?: Date; + ImageName: string | undefined; /** - *The timestamp when you last modified the inference experiment.
+ *The status of the image.
* @public */ - LastModifiedTime: Date | undefined; + ImageStatus: ImageStatus | 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. - *
+ *When the image was last modified.
* @public */ - RoleArn?: string; + LastModifiedTime: Date | undefined; } /** * @public * @enum */ -export const InferenceExperimentStopDesiredState = { - CANCELLED: "Cancelled", - COMPLETED: "Completed", +export const ImageSortBy = { + CREATION_TIME: "CREATION_TIME", + IMAGE_NAME: "IMAGE_NAME", + LAST_MODIFIED_TIME: "LAST_MODIFIED_TIME", } as const; /** * @public */ -export type InferenceExperimentStopDesiredState = - (typeof InferenceExperimentStopDesiredState)[keyof typeof InferenceExperimentStopDesiredState]; +export type ImageSortBy = (typeof ImageSortBy)[keyof typeof ImageSortBy]; /** - *A structure that contains a list of recommendation jobs.
* @public + * @enum */ -export interface InferenceRecommendationsJob { - /** - *The name of the job.
- * @public - */ - JobName: string | undefined; - - /** - *The job description.
- * @public - */ - JobDescription: string | undefined; - - /** - *The recommendation job type.
- * @public - */ - JobType: RecommendationJobType | undefined; - - /** - *The Amazon Resource Name (ARN) of the recommendation job.
- * @public - */ - JobArn: string | undefined; +export const ImageSortOrder = { + ASCENDING: "ASCENDING", + DESCENDING: "DESCENDING", +} as const; - /** - *The status of the job.
- * @public - */ - Status: RecommendationJobStatus | undefined; +/** + * @public + */ +export type ImageSortOrder = (typeof ImageSortOrder)[keyof typeof ImageSortOrder]; +/** + *A version of a SageMaker Image. A version represents an existing container
+ * image.
A timestamp that shows when the job was created.
+ *When the version was created.
* @public */ CreationTime: Date | undefined; /** - *A timestamp that shows when the job completed.
- * @public - */ - CompletionTime?: Date; - - /** - *The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker - * to perform tasks on your behalf.
+ *When a create or delete operation fails, the reason for the failure.
* @public */ - RoleArn: string | undefined; + FailureReason?: string; /** - *A timestamp that shows when the job was last modified.
+ *The ARN of the image the version is based on.
* @public */ - LastModifiedTime: Date | undefined; + ImageArn: string | undefined; /** - *If the job fails, provides information why the job failed.
+ *The ARN of the version.
* @public */ - FailureReason?: string; + ImageVersionArn: string | undefined; /** - *The name of the created model.
+ *The status of the version.
* @public */ - ModelName?: string; + ImageVersionStatus: ImageVersionStatus | 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).
+ *When the version was last modified.
* @public */ - SamplePayloadUrl?: string; + LastModifiedTime: Date | undefined; /** - *The Amazon Resource Name (ARN) of a versioned model package.
+ *The version number.
* @public */ - ModelPackageVersionArn?: string; + Version: number | undefined; } /** - *The details for a specific benchmark from an Inference Recommender job.
* @public + * @enum */ -export interface RecommendationJobInferenceBenchmark { - /** - *The metrics of recommendations.
- * @public - */ - Metrics?: RecommendationMetrics; - - /** - *The metrics for an existing endpoint compared in an Inference Recommender job.
- * @public - */ - EndpointMetrics?: InferenceMetrics; - - /** - *The endpoint configuration made by Inference Recommender during a recommendation job.
- * @public - */ - EndpointConfiguration?: EndpointOutputConfiguration; - - /** - *Defines the model configuration. Includes the specification name and environment parameters.
- * @public - */ - ModelConfiguration: ModelConfiguration | undefined; - - /** - *The reason why a benchmark failed.
- * @public - */ - FailureReason?: string; - - /** - *A timestamp that shows when the benchmark completed.
- * @public - */ - InvocationEndTime?: Date; +export const ImageVersionSortBy = { + CREATION_TIME: "CREATION_TIME", + LAST_MODIFIED_TIME: "LAST_MODIFIED_TIME", + VERSION: "VERSION", +} as const; - /** - *A timestamp that shows when the benchmark started.
- * @public - */ - InvocationStartTime?: Date; -} +/** + * @public + */ +export type ImageVersionSortBy = (typeof ImageVersionSortBy)[keyof typeof ImageVersionSortBy]; /** * @public * @enum */ -export const RecommendationStepType = { - BENCHMARK: "BENCHMARK", +export const ImageVersionSortOrder = { + ASCENDING: "ASCENDING", + DESCENDING: "DESCENDING", } as const; /** * @public */ -export type RecommendationStepType = (typeof RecommendationStepType)[keyof typeof RecommendationStepType]; +export type ImageVersionSortOrder = (typeof ImageVersionSortOrder)[keyof typeof ImageVersionSortOrder]; /** - *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 name of the hub content to import.
* @public */ - StepType: RecommendationStepType | undefined; + HubContentName: string | undefined; /** - *The name of the Inference Recommender job.
+ *The version of the hub content to import.
* @public */ - JobName: string | undefined; + HubContentVersion?: string; /** - *The current status of the benchmark.
+ *The type of hub content to import.
* @public */ - Status: RecommendationJobStatus | undefined; + HubContentType: HubContentType | undefined; /** - *The details for a specific benchmark.
+ *The version of the hub content schema to import.
* @public */ - InferenceBenchmark?: RecommendationJobInferenceBenchmark; -} + DocumentSchemaVersion: string | 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.
+ *The name of the hub to import content into.
* @public */ - HumanLabeled?: number; + HubName: string | undefined; /** - *The total number of data objects that need to be labeled by a human worker.
+ *The display name of the hub content to import.
* @public */ - PendingHuman?: number; + HubContentDisplayName?: string; /** - *The total number of tasks in the labeling job.
+ *A description of the hub content to import.
* @public */ - Total?: number; -} + HubContentDescription?: string; -/** - *Provides summary information for a work team.
- * @public - */ -export interface LabelingJobForWorkteamSummary { /** - *The name of the labeling job that the work team is assigned to.
+ *A string that provides a description of the hub content. This string can include links, tables, and standard markdown formating.
* @public */ - LabelingJobName?: string; + HubContentMarkdown?: string; /** - *A unique identifier for a labeling job. You can use this to refer to a specific - * labeling job.
+ *The hub content document that describes information about the hub content such as type, associated containers, scripts, and more.
* @public */ - JobReferenceCode: string | undefined; + HubContentDocument: string | undefined; /** - *The Amazon Web Services account ID of the account used to start the labeling - * job.
+ *The searchable keywords of the hub content.
* @public */ - WorkRequesterAccountId: string | undefined; + HubContentSearchKeywords?: string[]; /** - *The date and time that the labeling job was created.
+ *Any tags associated with the hub content.
* @public */ - CreationTime: Date | undefined; + Tags?: Tag[]; +} +/** + * @public + */ +export interface ImportHubContentResponse { /** - *Provides information about the progress of a labeling job.
+ *The ARN of the hub that the content was imported into.
* @public */ - LabelCounters?: LabelCountersForWorkteam; + HubArn: string | undefined; /** - *The configured number of workers per data object.
+ *The ARN of the hub content that was imported.
* @public */ - NumberOfHumanWorkersPerDataObject?: number; + HubContentArn: string | undefined; } /** - *Provides summary information about a labeling job.
* @public + * @enum */ -export interface LabelingJobSummary { - /** - *The name of the labeling job.
- * @public - */ - LabelingJobName: string | undefined; +export const InferenceComponentSortKey = { + CreationTime: "CreationTime", + Name: "Name", + Status: "Status", +} as const; + +/** + * @public + */ +export type InferenceComponentSortKey = (typeof InferenceComponentSortKey)[keyof typeof InferenceComponentSortKey]; +/** + *A summary of the properties of an inference component.
+ * @public + */ +export interface InferenceComponentSummary { /** - *The Amazon Resource Name (ARN) assigned to the labeling job when it was - * created.
+ *The time when the inference component was created.
* @public */ - LabelingJobArn: string | undefined; + CreationTime: Date | undefined; /** - *The date and time that the job was created (timestamp).
+ *The Amazon Resource Name (ARN) of the inference component.
* @public */ - CreationTime: Date | undefined; + InferenceComponentArn: string | undefined; /** - *The date and time that the job was last modified (timestamp).
+ *The name of the inference component.
* @public */ - LastModifiedTime: Date | undefined; + InferenceComponentName: string | undefined; /** - *The current status of the labeling job.
+ *The Amazon Resource Name (ARN) of the endpoint that hosts the inference component.
* @public */ - LabelingJobStatus: LabelingJobStatus | undefined; + EndpointArn: string | undefined; /** - *Counts showing the progress of the labeling job.
+ *The name of the endpoint that hosts the inference component.
* @public */ - LabelCounters: LabelCounters | undefined; + EndpointName: string | undefined; /** - *The Amazon Resource Name (ARN) of the work team assigned to the job.
+ *The name of the production variant that hosts the inference component.
* @public */ - WorkteamArn: string | undefined; + VariantName: string | undefined; /** - *The Amazon Resource Name (ARN) of a Lambda function. The function is run before each - * data object is sent to a worker.
+ *The status of the inference component.
* @public */ - PreHumanTaskLambdaArn: string | undefined; + InferenceComponentStatus?: InferenceComponentStatus; /** - *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 when the inference component was last updated.
* @public */ - AnnotationConsolidationLambdaArn?: string; + LastModifiedTime: Date | undefined; +} +/** + *Lists a summary of properties of an inference experiment.
+ * @public + */ +export interface InferenceExperimentSummary { /** - *If the LabelingJobStatus field is Failed, this field
- * contains a description of the error.
The name of the inference experiment.
* @public */ - FailureReason?: string; + Name: string | undefined; /** - *The location of the output produced by the labeling job.
+ *The type of the inference experiment.
* @public */ - LabelingJobOutput?: LabelingJobOutput; + Type: InferenceExperimentType | undefined; /** - *Input configuration for the labeling job.
+ *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 */ - InputConfig?: LabelingJobInputConfig; -} + Schedule?: InferenceExperimentSchedule; -/** - *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 status of the inference experiment.
* @public */ - Arn?: string; + Status: InferenceExperimentStatus | undefined; /** - *A list of the output parameters of the Lambda step.
+ *The error message for the inference experiment status result.
* @public */ - OutputParameters?: OutputParameter[]; -} + StatusReason?: string; -/** - *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 description of the inference experiment.
* @public */ - LineageGroupArn?: string; + Description?: string; /** - *The name or Amazon Resource Name (ARN) of the lineage group.
+ *The timestamp at which the inference experiment was created.
* @public */ - LineageGroupName?: string; + CreationTime: Date | undefined; /** - *The display name of the lineage group summary.
+ *The timestamp at which the inference experiment was completed.
* @public */ - DisplayName?: string; + CompletionTime?: Date; /** - *The creation time of the lineage group summary.
+ *The timestamp when you last modified the inference experiment.
* @public */ - CreationTime?: Date; + LastModifiedTime: Date | undefined; /** - *The last modified time of the lineage group summary.
+ *+ * 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 */ - LastModifiedTime?: Date; + RoleArn?: string; } /** * @public * @enum */ -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", +export const InferenceExperimentStopDesiredState = { + CANCELLED: "Cancelled", + COMPLETED: "Completed", } as const; /** * @public */ -export type SortOrder = (typeof SortOrder)[keyof typeof SortOrder]; +export type InferenceExperimentStopDesiredState = + (typeof InferenceExperimentStopDesiredState)[keyof typeof InferenceExperimentStopDesiredState]; /** + *A structure that contains a list of recommendation jobs.
* @public */ -export interface ListActionsRequest { +export interface InferenceRecommendationsJob { /** - *A filter that returns only actions with the specified source URI.
+ *The name of the job.
* @public */ - SourceUri?: string; + JobName: string | undefined; /** - *A filter that returns only actions of the specified type.
+ *The job description.
* @public */ - ActionType?: string; + JobDescription: string | undefined; /** - *A filter that returns only actions created on or after the specified time.
+ *The recommendation job type.
* @public */ - CreatedAfter?: Date; + JobType: RecommendationJobType | undefined; /** - *A filter that returns only actions created on or before the specified time.
+ *The Amazon Resource Name (ARN) of the recommendation job.
* @public */ - CreatedBefore?: Date; + JobArn: string | undefined; /** - *The property used to sort results. The default value is CreationTime.
The status of the job.
* @public */ - SortBy?: SortActionsBy; + Status: RecommendationJobStatus | undefined; /** - *The sort order. The default value is Descending.
A timestamp that shows when the job was created.
* @public */ - SortOrder?: SortOrder; + CreationTime: Date | undefined; /** - *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 timestamp that shows when the job completed.
* @public */ - NextToken?: string; + CompletionTime?: Date; /** - *The maximum number of actions to return in the response. The default value is 10.
+ *The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker + * to perform tasks on your behalf.
* @public */ - MaxResults?: number; -} + RoleArn: string | undefined; -/** - * @public - */ -export interface ListActionsResponse { /** - *A list of actions and their properties.
+ *A timestamp that shows when the job was last modified.
* @public */ - ActionSummaries?: ActionSummary[]; + LastModifiedTime: Date | undefined; /** - *A token for getting the next set of actions, if there are any.
+ *If the job fails, provides information why the job failed.
* @public */ - NextToken?: string; + FailureReason?: string; + + /** + *The name of the created model.
+ * @public + */ + ModelName?: string; + + /** + *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; + + /** + *The Amazon Resource Name (ARN) of a versioned model package.
+ * @public + */ + ModelPackageVersionArn?: string; } /** + *The details for a specific benchmark from an Inference Recommender job.
* @public */ -export interface ListAlgorithmsInput { +export interface RecommendationJobInferenceBenchmark { /** - *A filter that returns only algorithms created after the specified time - * (timestamp).
+ *The metrics of recommendations.
* @public */ - CreationTimeAfter?: Date; + Metrics?: RecommendationMetrics; /** - *A filter that returns only algorithms created before the specified time - * (timestamp).
+ *The metrics for an existing endpoint compared in an Inference Recommender job.
* @public */ - CreationTimeBefore?: Date; + EndpointMetrics?: InferenceMetrics; /** - *The maximum number of algorithms to return in the response.
+ *The endpoint configuration made by Inference Recommender during a recommendation job.
* @public */ - MaxResults?: number; + EndpointConfiguration?: EndpointOutputConfiguration; /** - *A string in the algorithm name. This filter returns only algorithms whose name - * contains the specified string.
+ *Defines the model configuration. Includes the specification name and environment parameters.
* @public */ - NameContains?: string; + ModelConfiguration: ModelConfiguration | 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.
The reason why a benchmark failed.
* @public */ - NextToken?: string; + FailureReason?: string; /** - *The parameter by which to sort the results. The default is
- * CreationTime.
A timestamp that shows when the benchmark completed.
* @public */ - SortBy?: AlgorithmSortBy; + InvocationEndTime?: Date; /** - *The sort order for the results. The default is Ascending.
A timestamp that shows when the benchmark started.
* @public */ - SortOrder?: SortOrder; + InvocationStartTime?: Date; } +/** + * @public + * @enum + */ +export const RecommendationStepType = { + BENCHMARK: "BENCHMARK", +} as const; + /** * @public */ -export interface ListAlgorithmsOutput { +export type RecommendationStepType = (typeof RecommendationStepType)[keyof typeof RecommendationStepType]; + +/** + *A returned array object for the Steps response field in the
+ * ListInferenceRecommendationsJobSteps API command.
>An array of AlgorithmSummary objects, each of which lists an
- * algorithm.
The type of the subtask.
+ *
+ * BENCHMARK: Evaluate the performance of your model on different instance types.
If the response is truncated, SageMaker returns this token. To retrieve the next set of - * algorithms, use it in the subsequent request.
+ *The name of the Inference Recommender job.
* @public */ - NextToken?: string; -} + JobName: string | undefined; -/** - * @public - */ -export interface ListAliasesRequest { /** - *The name of the image.
+ *The current status of the benchmark.
* @public */ - ImageName: string | undefined; + Status: RecommendationJobStatus | undefined; /** - *The alias of the image version.
+ *The details for a specific benchmark.
* @public */ - Alias?: string; + InferenceBenchmark?: RecommendationJobInferenceBenchmark; +} +/** + *Provides counts for human-labeled tasks in the labeling job.
+ * @public + */ +export interface LabelCountersForWorkteam { /** - *The version of the image. If image version is not specified, the aliases of all versions of the image are listed.
+ *The total number of data objects labeled by a human worker.
* @public */ - Version?: number; + HumanLabeled?: number; /** - *The maximum number of aliases to return.
+ *The total number of data objects that need to be labeled by a human worker.
* @public */ - MaxResults?: number; + PendingHuman?: number; /** - *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 total number of tasks in the labeling job.
* @public */ - NextToken?: string; + Total?: number; } /** + *Provides summary information for a work team.
* @public */ -export interface ListAliasesResponse { +export interface LabelingJobForWorkteamSummary { /** - *A list of SageMaker image version aliases.
+ *The name of the labeling job that the work team is assigned to.
* @public */ - SageMakerImageVersionAliases?: string[]; + LabelingJobName?: string; /** - *A token for getting the next set of aliases, if more aliases exist.
+ *A unique identifier for a labeling job. You can use this to refer to a specific + * labeling job.
* @public */ - NextToken?: string; + JobReferenceCode: string | undefined; + + /** + *The Amazon Web Services account ID of the account used to start the labeling + * job.
+ * @public + */ + WorkRequesterAccountId: string | undefined; + + /** + *The date and time that the labeling job was created.
+ * @public + */ + CreationTime: Date | undefined; + + /** + *Provides information about the progress of a labeling job.
+ * @public + */ + LabelCounters?: LabelCountersForWorkteam; + + /** + *The configured number of workers per data object.
+ * @public + */ + NumberOfHumanWorkersPerDataObject?: number; } /** + *Provides summary information about a labeling job.
* @public */ -export interface ListAppImageConfigsRequest { +export interface LabelingJobSummary { /** - *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 name of the labeling job.
* @public */ - MaxResults?: number; + LabelingJobName: string | undefined; /** - *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.
The Amazon Resource Name (ARN) assigned to the labeling job when it was + * created.
* @public */ - NextToken?: string; + LabelingJobArn: string | undefined; /** - *A filter that returns only AppImageConfigs whose name contains the specified string.
+ *The date and time that the job was created (timestamp).
* @public */ - NameContains?: string; + CreationTime: Date | undefined; /** - *A filter that returns only AppImageConfigs created on or before the specified time.
+ *The date and time that the job was last modified (timestamp).
* @public */ - CreationTimeBefore?: Date; + LastModifiedTime: Date | undefined; /** - *A filter that returns only AppImageConfigs created on or after the specified time.
+ *The current status of the labeling job.
* @public */ - CreationTimeAfter?: Date; + LabelingJobStatus: LabelingJobStatus | undefined; + + /** + *Counts showing the progress of the labeling job.
+ * @public + */ + LabelCounters: LabelCounters | undefined; + + /** + *The Amazon Resource Name (ARN) of the work team assigned to the job.
+ * @public + */ + WorkteamArn: string | undefined; + + /** + *The Amazon Resource Name (ARN) of a Lambda function. The function is run before each + * data object is sent to a worker.
+ * @public + */ + PreHumanTaskLambdaArn: string | undefined; /** - *A filter that returns only AppImageConfigs modified on or before the 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 */ - ModifiedTimeBefore?: Date; + AnnotationConsolidationLambdaArn?: string; /** - *A filter that returns only AppImageConfigs modified on or after the specified time.
+ *If the LabelingJobStatus field is Failed, this field
+ * contains a description of the error.
The property used to sort results. The default value is CreationTime.
The location of the output produced by the labeling job.
* @public */ - SortBy?: AppImageConfigSortKey; + LabelingJobOutput?: LabelingJobOutput; /** - *The sort order. The default value is Descending.
Input configuration for the labeling job.
* @public */ - SortOrder?: SortOrder; + InputConfig?: LabelingJobInputConfig; } /** + *Metadata for a Lambda step.
* @public */ -export interface ListAppImageConfigsResponse { +export interface LambdaStepMetadata { /** - *A token for getting the next set of AppImageConfigs, if there are any.
+ *The Amazon Resource Name (ARN) of the Lambda function that was run by this step execution.
* @public */ - NextToken?: string; + Arn?: string; /** - *A list of AppImageConfigs and their properties.
+ *A list of the output parameters of the Lambda step.
* @public */ - AppImageConfigs?: AppImageConfigDetails[]; + OutputParameters?: OutputParameter[]; } /** + *Lists a summary of the properties of a lineage group. A lineage group provides a group of shareable lineage entity + * resources.
* @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.
- * @public - */ - NextToken?: string; - - /** - *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.
+ *The Amazon Resource Name (ARN) of the lineage group resource.
* @public */ - SortOrder?: SortOrder; + LineageGroupArn?: string; /** - *The parameter by which to sort the results. The default is CreationTime.
+ *The name or Amazon Resource Name (ARN) of the lineage group.
* @public */ - SortBy?: AppSortKey; + LineageGroupName?: string; /** - *A parameter to search for the domain ID.
+ *The display name of the lineage group summary.
* @public */ - DomainIdEquals?: string; + DisplayName?: string; /** - *A parameter to search by user profile name. If SpaceNameEquals is set, then this value cannot be set.
The creation time of the lineage group summary.
* @public */ - UserProfileNameEquals?: string; + CreationTime?: Date; /** - *A parameter to search by space name. If UserProfileNameEquals is set,
- * then this value cannot be set.
The last modified time of the lineage group summary.
* @public */ - SpaceNameEquals?: string; + LastModifiedTime?: Date; } /** * @public + * @enum */ -export interface ListAppsResponse { - /** - *The list of apps.
- * @public - */ - Apps?: AppDetails[]; +export const LineageType = { + ACTION: "Action", + ARTIFACT: "Artifact", + CONTEXT: "Context", + TRIAL_COMPONENT: "TrialComponent", +} 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; -} +/** + * @public + */ +export type LineageType = (typeof LineageType)[keyof typeof LineageType]; /** * @public * @enum */ -export const SortArtifactsBy = { +export const SortActionsBy = { CREATION_TIME: "CreationTime", + NAME: "Name", } as const; /** * @public */ -export type SortArtifactsBy = (typeof SortArtifactsBy)[keyof typeof SortArtifactsBy]; +export type SortActionsBy = (typeof SortActionsBy)[keyof typeof SortActionsBy]; /** * @public + * @enum */ -export interface ListArtifactsRequest { +export const SortOrder = { + ASCENDING: "Ascending", + DESCENDING: "Descending", +} as const; + +/** + * @public + */ +export type SortOrder = (typeof SortOrder)[keyof typeof SortOrder]; + +/** + * @public + */ +export interface ListActionsRequest { /** - *A filter that returns only artifacts with the specified source URI.
+ *A filter that returns only actions with the specified source URI.
* @public */ SourceUri?: string; /** - *A filter that returns only artifacts of the specified type.
+ *A filter that returns only actions of the specified type.
* @public */ - ArtifactType?: string; + ActionType?: string; /** - *A filter that returns only artifacts created on or after the specified time.
+ *A filter that returns only actions created on or after the specified time.
* @public */ CreatedAfter?: Date; /** - *A filter that returns only artifacts created on or before the specified time.
+ *A filter that returns only actions created on or before the specified time.
* @public */ CreatedBefore?: Date; @@ -6319,7 +6324,7 @@ export interface ListArtifactsRequest { *The property used to sort results. The default value is CreationTime.
The sort order. The default value is Descending.
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 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 maximum number of artifacts to return in the response. The default value is 10.
+ *The maximum number of actions to return in the response. The default value is 10.
* @public */ MaxResults?: number; @@ -6344,15 +6349,15 @@ export interface ListArtifactsRequest { /** * @public */ -export interface ListArtifactsResponse { +export interface ListActionsResponse { /** - *A list of artifacts and their properties.
+ *A list of actions and their properties.
* @public */ - ArtifactSummaries?: ArtifactSummary[]; + ActionSummaries?: ActionSummary[]; /** - *A token for getting the next set of artifacts, if there are any.
+ *A token for getting the next set of actions, if there are any.
* @public */ NextToken?: string; @@ -6360,105 +6365,124 @@ export interface ListArtifactsResponse { /** * @public - * @enum */ -export const SortAssociationsBy = { - CREATION_TIME: "CreationTime", - DESTINATION_ARN: "DestinationArn", - DESTINATION_TYPE: "DestinationType", - SOURCE_ARN: "SourceArn", - SOURCE_TYPE: "SourceType", -} as const; +export interface ListAlgorithmsInput { + /** + *A filter that returns only algorithms created after the specified time + * (timestamp).
+ * @public + */ + CreationTimeAfter?: Date; -/** - * @public - */ -export type SortAssociationsBy = (typeof SortAssociationsBy)[keyof typeof SortAssociationsBy]; + /** + *A filter that returns only algorithms created before the specified time + * (timestamp).
+ * @public + */ + CreationTimeBefore?: Date; -/** - * @public - */ -export interface ListAssociationsRequest { /** - *A filter that returns only associations with the specified source ARN.
+ *The maximum number of algorithms to return in the response.
* @public */ - SourceArn?: string; + MaxResults?: number; /** - *A filter that returns only associations with the specified destination Amazon Resource Name (ARN).
+ *A string in the algorithm name. This filter returns only algorithms whose name + * contains the specified string.
* @public */ - DestinationArn?: string; + NameContains?: string; /** - *A filter that returns only associations with the specified source type.
+ *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 associations with the specified destination type.
+ *The parameter by which to sort the results. The default is
+ * CreationTime.
A filter that returns only associations of the specified type.
+ *The sort order for the results. The default is Ascending.
A filter that returns only associations created on or after the specified time.
+ *>An array of AlgorithmSummary objects, each of which lists an
+ * algorithm.
A filter that returns only associations created on or before the specified time.
+ *If the response is truncated, SageMaker returns this token. To retrieve the next set of + * algorithms, use it in the subsequent request.
* @public */ - CreatedBefore?: Date; + NextToken?: string; +} +/** + * @public + */ +export interface ListAliasesRequest { /** - *The property used to sort results. The default value is CreationTime.
The name of the image.
* @public */ - SortBy?: SortAssociationsBy; + ImageName: string | undefined; /** - *The sort order. The default value is Descending.
The alias of the image version.
* @public */ - SortOrder?: SortOrder; + Alias?: string; /** - *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.
The version of the image. If image version is not specified, the aliases of all versions of the image are listed.
* @public */ - NextToken?: string; + Version?: number; /** - *The maximum number of associations to return in the response. The default value is 10.
+ *The maximum number of aliases to return.
* @public */ MaxResults?: number; + + /** + *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 associations and their properties.
+ *A list of SageMaker image version aliases.
* @public */ - AssociationSummaries?: AssociationSummary[]; + SageMakerImageVersionAliases?: string[]; /** - *A token for getting the next set of associations, if there are any.
+ *A token for getting the next set of aliases, if more aliases exist.
* @public */ NextToken?: string; @@ -6467,865 +6491,797 @@ export interface ListAssociationsResponse { /** * @public */ -export interface ListAutoMLJobsRequest { - /** - *Request a list of jobs, using a filter for time.
- * @public - */ - CreationTimeAfter?: Date; - +export interface ListAppImageConfigsRequest { /** - *Request a list of jobs, using a filter for time.
+ *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.
Request a list of jobs, using a filter for time.
+ *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.
Request a list of jobs, using a filter for time.
+ *A filter that returns only AppImageConfigs whose name contains the specified string.
* @public */ - LastModifiedTimeBefore?: Date; + NameContains?: string; /** - *Request a list of jobs, using a search filter for name.
+ *A filter that returns only AppImageConfigs created on or before the specified time.
* @public */ - NameContains?: string; + CreationTimeBefore?: Date; /** - *Request a list of jobs, using a filter for status.
+ *A filter that returns only AppImageConfigs created on or after the specified time.
* @public */ - StatusEquals?: AutoMLJobStatus; + CreationTimeAfter?: Date; /** - *The sort order for the results. The default is Descending.
A filter that returns only AppImageConfigs modified on or before the specified time.
* @public */ - SortOrder?: AutoMLSortOrder; + ModifiedTimeBefore?: Date; /** - *The parameter by which to sort the results. The default is Name.
A filter that returns only AppImageConfigs modified on or after the specified time.
* @public */ - SortBy?: AutoMLSortBy; + ModifiedTimeAfter?: Date; /** - *Request a list of jobs up to a specified limit.
+ *The property used to sort results. The default value is CreationTime.
If the previous response was truncated, you receive this token. Use it in your next - * request to receive the next set of results.
+ *The sort order. The default value is Descending.
Returns a summary list of jobs.
+ *A token for getting the next set of AppImageConfigs, if there are any.
* @public */ - AutoMLJobSummaries: AutoMLJobSummary[] | undefined; + NextToken?: string; /** - *If the previous response was truncated, you receive this token. Use it in your next - * request to receive the next set of results.
+ *A list of AppImageConfigs and their properties.
* @public */ - NextToken?: string; + AppImageConfigs?: AppImageConfigDetails[]; } /** * @public */ -export interface ListCandidatesForAutoMLJobRequest { +export interface ListAppsRequest { /** - *List the candidates created for the job by providing the job's name.
+ *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 */ - AutoMLJobName: string | undefined; + NextToken?: string; /** - *List the candidates for the job and filter by status.
+ *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.
List the candidates for the job and filter by candidate name.
+ *The sort order for the results. The default is Ascending.
* @public */ - CandidateNameEquals?: string; + SortOrder?: SortOrder; /** - *The sort order for the results. The default is Ascending.
The parameter by which to sort the results. The default is CreationTime.
* @public */ - SortOrder?: AutoMLSortOrder; + SortBy?: AppSortKey; /** - *The parameter by which to sort the results. The default is
- * Descending.
A parameter to search for the domain ID.
* @public */ - SortBy?: CandidateSortBy; + DomainIdEquals?: string; /** - *List the job's candidates up to a specified limit.
+ *A parameter to search by user profile name. If SpaceNameEquals is set, then this value cannot be set.
If the previous response was truncated, you receive this token. Use it in your next - * request to receive the next set of results.
+ *A parameter to search by space name. If UserProfileNameEquals is set,
+ * then this value cannot be set.
Summaries about the AutoMLCandidates.
The list of apps.
* @public */ - Candidates: AutoMLCandidate[] | undefined; + Apps?: AppDetails[]; /** - *If the previous response was truncated, you receive this token. Use it in your next - * request to receive the next set of results.
+ *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; } +/** + * @public + * @enum + */ +export const SortArtifactsBy = { + CREATION_TIME: "CreationTime", +} as const; + /** * @public */ -export interface ListClusterNodesRequest { +export type SortArtifactsBy = (typeof SortArtifactsBy)[keyof typeof SortArtifactsBy]; + +/** + * @public + */ +export interface ListArtifactsRequest { /** - *The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster in which you want to retrieve the list of nodes.
+ *A filter that returns only artifacts with the specified source URI.
* @public */ - ClusterName: string | undefined; + SourceUri?: string; /** - *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.
+ *A filter that returns only artifacts of the specified type.
* @public */ - CreationTimeAfter?: Date; + ArtifactType?: 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 artifacts created on or after the specified time.
* @public */ - CreationTimeBefore?: Date; + CreatedAfter?: Date; /** - *A filter that returns the instance groups whose name contain a specified string.
+ *A filter that returns only artifacts created on or before the specified time.
* @public */ - InstanceGroupNameContains?: string; + CreatedBefore?: Date; /** - *The maximum number of nodes to return in the response.
+ *The property used to sort results. The default value is CreationTime.
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 sort order. The default value is Descending.
The field by which to sort results. The default value is
- * CREATION_TIME.
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 sort order for results. The default value is Ascending.
The maximum number of artifacts to return in the response. The default value is 10.
* @public */ - SortOrder?: SortOrder; + MaxResults?: number; } /** * @public */ -export interface ListClusterNodesResponse { +export interface ListArtifactsResponse { /** - *The next token specified for listing instances in a SageMaker HyperPod cluster.
+ *A list of artifacts and their properties.
* @public */ - NextToken: string | undefined; + ArtifactSummaries?: ArtifactSummary[]; /** - *The summaries of listed instances in a SageMaker HyperPod cluster
+ *A token for getting the next set of artifacts, if there are any.
* @public */ - ClusterNodeSummaries: ClusterNodeSummary[] | undefined; + NextToken?: string; } /** * @public + * @enum */ -export interface ListClustersRequest { +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]; + +/** + * @public + */ +export interface ListAssociationsRequest { /** - *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.
+ *A filter that returns only associations with the specified source ARN.
* @public */ - CreationTimeAfter?: Date; + SourceArn?: string; + + /** + *A filter that returns only associations with the specified destination Amazon Resource Name (ARN).
+ * @public + */ + DestinationArn?: string; + + /** + *A filter that returns only associations with the specified source type.
+ * @public + */ + SourceType?: string; + + /** + *A filter that returns only associations with the specified destination type.
+ * @public + */ + DestinationType?: string; + + /** + *A filter that returns only associations of the specified type.
+ * @public + */ + AssociationType?: AssociationEdgeType; /** - *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 associations created on or after the specified time.
* @public */ - CreationTimeBefore?: Date; + CreatedAfter?: Date; /** - *Set the maximum number of SageMaker HyperPod clusters to list.
+ *A filter that returns only associations created on or before the specified time.
* @public */ - MaxResults?: number; + CreatedBefore?: Date; /** - *Set the maximum number of instances to print in the list.
+ *The property used to sort results. The default value is CreationTime.
Set the next token to retrieve the list of SageMaker HyperPod clusters.
+ *The sort order. The default value is Descending.
The field by which to sort results. The default value is
- * CREATION_TIME.
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.
The sort order for results. The default value is Ascending.
The maximum number of associations to return in the response. The default value is 10.
* @public */ - SortOrder?: SortOrder; + MaxResults?: number; } /** * @public */ -export interface ListClustersResponse { +export interface ListAssociationsResponse { /** - *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 list of associations and their properties.
* @public */ - NextToken: string | undefined; + AssociationSummaries?: AssociationSummary[]; /** - *The summaries of listed SageMaker HyperPod clusters.
+ *A token for getting the next set of associations, if there are any.
* @public */ - ClusterSummaries: ClusterSummary[] | undefined; + NextToken?: string; } /** * @public */ -export interface ListCodeRepositoriesInput { +export interface ListAutoMLJobsRequest { /** - *A filter that returns only Git repositories that were created after the specified - * time.
+ *Request a list of jobs, using a filter for time.
* @public */ CreationTimeAfter?: Date; /** - *A filter that returns only Git repositories that were created before the specified - * time.
+ *Request a list of jobs, using a filter for time.
* @public */ CreationTimeBefore?: Date; /** - *A filter that returns only Git repositories that were last modified after the - * specified time.
+ *Request a list of jobs, using a filter for time.
* @public */ LastModifiedTimeAfter?: Date; /** - *A filter that returns only Git repositories that were last modified before the - * specified time.
+ *Request a list of jobs, using a filter for time.
* @public */ LastModifiedTimeBefore?: Date; /** - *The maximum number of Git repositories to return in the response.
- * @public - */ - MaxResults?: number; - - /** - *A string in the Git repositories name. This filter returns only repositories whose - * name contains the specified string.
+ *Request a list of jobs, using a search filter for name.
* @public */ NameContains?: string; /** - *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.
Request a list of jobs, using a filter for status.
* @public */ - NextToken?: string; + StatusEquals?: AutoMLJobStatus; /** - *The field to sort results by. The default is Name.
The sort order for the results. The default is Descending.
The sort order for results. The default is Ascending.
The parameter by which to sort the results. The default is Name.
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.
- *Request a list of jobs up to a specified limit.
* @public */ - CodeRepositorySummaryList: CodeRepositorySummary[] | undefined; + MaxResults?: number; /** - *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.
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; } -/** - * @public - * @enum - */ -export const ListCompilationJobsSortBy = { - CREATION_TIME: "CreationTime", - NAME: "Name", - STATUS: "Status", -} as const; - /** * @public */ -export type ListCompilationJobsSortBy = (typeof ListCompilationJobsSortBy)[keyof typeof ListCompilationJobsSortBy]; - -/** - * @public - */ -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.
+ *Returns a summary list of jobs.
* @public */ - MaxResults?: number; + AutoMLJobSummaries: AutoMLJobSummary[] | undefined; /** - *A filter that returns the model compilation jobs that were created after a specified - * time.
+ *If the previous response was truncated, you receive this token. Use it in your next + * request to receive the next set of results.
* @public */ - CreationTimeAfter?: Date; + NextToken?: string; +} +/** + * @public + */ +export interface ListCandidatesForAutoMLJobRequest { /** - *A filter that returns the model compilation jobs that were created before a specified - * time.
+ *List the candidates created for the job by providing the job's name.
* @public */ - CreationTimeBefore?: Date; + AutoMLJobName: string | undefined; /** - *A filter that returns the model compilation jobs that were modified after a specified - * time.
+ *List the candidates for the job and filter by status.
* @public */ - LastModifiedTimeAfter?: Date; + StatusEquals?: CandidateStatus; /** - *A filter that returns the model compilation jobs that were modified before a specified - * time.
+ *List the candidates for the job and filter by candidate name.
* @public */ - LastModifiedTimeBefore?: Date; + CandidateNameEquals?: string; /** - *A filter that returns the model compilation jobs whose name contains a specified - * string.
+ *The sort order for the results. The default is Ascending.
A filter that retrieves model compilation jobs with a specific
- * CompilationJobStatus status.
The parameter by which to sort the results. The default is
+ * Descending.
The field by which to sort results. The default is CreationTime.
List the job's candidates up to a specified limit.
* @public */ - SortBy?: ListCompilationJobsSortBy; + MaxResults?: number; /** - *The sort order for results. The default is Ascending.
If the previous response was truncated, you receive this token. Use it in your next + * request to receive the next set of results.
* @public */ - SortOrder?: SortOrder; + NextToken?: string; } /** * @public */ -export interface ListCompilationJobsResponse { +export interface ListCandidatesForAutoMLJobResponse { /** - *An array of CompilationJobSummary objects, each describing a model compilation job. - *
+ *Summaries about the AutoMLCandidates.
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.
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; } -/** - * @public - * @enum - */ -export const SortContextsBy = { - CREATION_TIME: "CreationTime", - NAME: "Name", -} as const; - -/** - * @public - */ -export type SortContextsBy = (typeof SortContextsBy)[keyof typeof SortContextsBy]; - /** * @public */ -export interface ListContextsRequest { - /** - *A filter that returns only contexts with the specified source URI.
- * @public - */ - SourceUri?: string; - - /** - *A filter that returns only contexts of the specified type.
- * @public - */ - ContextType?: string; - +export interface ListClusterNodesRequest { /** - *A filter that returns only contexts created on or after the specified time.
+ *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 */ - CreatedAfter?: Date; + ClusterName: string | undefined; /** - *A filter that returns only contexts created on or before the specified time.
+ *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 */ - CreatedBefore?: Date; + CreationTimeAfter?: Date; /** - *The property used to sort results. The default value is CreationTime.
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 sort order. The default value is Descending.
A filter that returns the instance groups whose name contain a specified string.
* @public */ - SortOrder?: SortOrder; + InstanceGroupNameContains?: string; /** - *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 nodes to return in the response.
* @public */ - NextToken?: string; + MaxResults?: number; /** - *The maximum number of contexts to return in the response. The default value is 10.
+ *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 list of contexts and their properties.
+ *The field by which to sort results. The default value is
+ * CREATION_TIME.
A token for getting the next set of contexts, if there are any.
+ *The sort order for results. The default value is Ascending.
A filter that lists the data quality job definitions associated with the specified - * endpoint.
+ *The next token specified for listing instances in a SageMaker HyperPod cluster.
* @public */ - EndpointName?: string; + NextToken: string | undefined; /** - *The field to sort results by. The default is CreationTime.
The summaries of listed instances in a SageMaker HyperPod cluster
* @public */ - SortBy?: MonitoringJobDefinitionSortKey; + ClusterNodeSummaries: ClusterNodeSummary[] | undefined; +} +/** + * @public + */ +export interface ListClustersRequest { /** - *Whether to sort the results in Ascending or Descending order.
- * The default is Descending.
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 */ - SortOrder?: SortOrder; + CreationTimeAfter?: Date; /** - *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.>
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 maximum number of data quality monitoring job definitions to return in the - * response.
+ *Set the maximum number of SageMaker HyperPod clusters to list.
* @public */ MaxResults?: number; /** - *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.
+ *Set the maximum number of instances to print in the list.
* @public */ NameContains?: string; /** - *A filter that returns only data quality monitoring job definitions created before the - * specified time.
- * @public - */ - CreationTimeBefore?: Date; - - /** - *A filter that returns only data quality monitoring job definitions created after the - * specified time.
- * @public - */ - CreationTimeAfter?: Date; -} - -/** - *Summary information about a monitoring job.
- * @public - */ -export interface MonitoringJobDefinitionSummary { - /** - *The name of the monitoring job.
- * @public - */ - MonitoringJobDefinitionName: string | undefined; - - /** - *The Amazon Resource Name (ARN) of the monitoring job.
+ *Set the next token to retrieve the list of SageMaker HyperPod clusters.
* @public */ - MonitoringJobDefinitionArn: string | undefined; + NextToken?: string; /** - *The time that the monitoring job was created.
+ *The field by which to sort results. The default value is
+ * CREATION_TIME.
The name of the endpoint that the job monitors.
+ *The sort order for results. The default value is Ascending.
A list of data quality monitoring job definitions.
+ *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.
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 summaries of listed SageMaker HyperPod clusters.
* @public */ - NextToken?: string; + ClusterSummaries: ClusterSummary[] | undefined; } -/** - * @public - * @enum - */ -export const ListDeviceFleetsSortBy = { - CreationTime: "CREATION_TIME", - LastModifiedTime: "LAST_MODIFIED_TIME", - Name: "NAME", -} as const; - -/** - * @public - */ -export type ListDeviceFleetsSortBy = (typeof ListDeviceFleetsSortBy)[keyof typeof ListDeviceFleetsSortBy]; - /** * @public */ -export interface ListDeviceFleetsRequest { +export interface ListCodeRepositoriesInput { /** - *The response from the last list when returning a list large enough to need tokening.
+ *A filter that returns only Git repositories that were created after the specified + * time.
* @public */ - NextToken?: string; + CreationTimeAfter?: Date; /** - *The maximum number of results to select.
+ *A filter that returns only Git repositories that were created before the specified + * time.
* @public */ - MaxResults?: number; + CreationTimeBefore?: Date; /** - *Filter fleets where packaging job was created after specified time.
+ *A filter that returns only Git repositories that were last modified after the + * specified time.
* @public */ - CreationTimeAfter?: Date; + LastModifiedTimeAfter?: Date; /** - *Filter fleets where the edge packaging job was created before specified time.
+ *A filter that returns only Git repositories that were last modified before the + * specified time.
* @public */ - CreationTimeBefore?: Date; + LastModifiedTimeBefore?: Date; /** - *Select fleets where the job was updated after X
+ *The maximum number of Git repositories to return in the response.
* @public */ - LastModifiedTimeAfter?: Date; + MaxResults?: number; /** - *Select fleets where the job was updated before X
+ *A string in the Git repositories name. This filter returns only repositories whose + * name contains the specified string.
* @public */ - LastModifiedTimeBefore?: Date; + NameContains?: string; /** - *Filter for fleets containing this name in their fleet device name.
+ *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 column to sort by.
+ *The field to sort results by. The default is Name.
What direction to sort in.
+ *The sort order for results. The default is Ascending.
Summary of the device fleet.
+ *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 response from the last list when returning a list large enough to need tokening.
+ *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 response from the last list when returning a list large enough to need tokening.
+ *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.
Maximum number of results to select.
+ *The maximum number of model compilation jobs to return in the response.
* @public */ MaxResults?: number; /** - *Select fleets where the job was updated after X
+ *A filter that returns the model compilation jobs that were created after a specified + * time.
* @public */ - LatestHeartbeatAfter?: Date; + CreationTimeAfter?: Date; /** - *A filter that searches devices that contains this name in any of their models.
+ *A filter that returns the model compilation jobs that were created before a specified + * time.
* @public */ - ModelName?: string; + CreationTimeBefore?: Date; /** - *Filter for fleets containing this name in their device fleet name.
+ *A filter that returns the model compilation jobs that were modified after a specified + * time.
* @public */ - DeviceFleetName?: string; -} + LastModifiedTimeAfter?: Date; -/** - * @public - */ -export interface ListDevicesResponse { /** - *Summary of devices.
+ *A filter that returns the model compilation jobs that were modified before a specified + * time.
* @public */ - DeviceSummaries: DeviceSummary[] | undefined; + LastModifiedTimeBefore?: Date; /** - *The response from the last list when returning a list large enough to need tokening.
+ *A filter that returns the model compilation jobs whose name contains a specified + * string.
* @public */ - NextToken?: string; -} + NameContains?: string; -/** - * @public - */ -export interface ListDomainsRequest { /** - *If the previous response was truncated, you will receive this token. Use it in your next - * request to receive the next set of results.
+ *A filter that retrieves model compilation jobs with a specific
+ * CompilationJobStatus status.
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 field by which to sort results. The default is CreationTime.
The sort order for results. The default is Ascending.
The list of domains.
+ *An array of CompilationJobSummary objects, each describing a model compilation job. + *
* @public */ - Domains?: DomainDetails[]; + CompilationJobSummaries: CompilationJobSummary[] | 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 response is truncated, Amazon SageMaker returns this NextToken. To retrieve
+ * the next set of model compilation jobs, use this token in the next request.
The response from the last list when returning a list large enough to need - * tokening.
- * @public - */ - NextToken?: string; - - /** - *The maximum number of results to select (50 by default).
- * @public - */ - MaxResults?: number; - +export interface ListContextsRequest { /** - *Selects edge deployment plans created after this time.
+ *A filter that returns only contexts with the specified source URI.
* @public */ - CreationTimeAfter?: Date; + SourceUri?: string; /** - *Selects edge deployment plans created before this time.
+ *A filter that returns only contexts of the specified type.
* @public */ - CreationTimeBefore?: Date; + ContextType?: string; /** - *Selects edge deployment plans that were last updated after this time.
+ *A filter that returns only contexts created on or after the specified time.
* @public */ - LastModifiedTimeAfter?: Date; + CreatedAfter?: Date; /** - *Selects edge deployment plans that were last updated before this time.
+ *A filter that returns only contexts created on or before the specified time.
* @public */ - LastModifiedTimeBefore?: Date; + CreatedBefore?: Date; /** - *Selects edge deployment plans with names containing this name.
+ *The property used to sort results. The default value is CreationTime.
Selects edge deployment plans with a device fleet name containing this name.
+ *The sort order. The default value is Descending.
The column by which to sort the edge deployment plans. Can be one of
- * NAME, DEVICEFLEETNAME, CREATIONTIME,
- * LASTMODIFIEDTIME.
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 direction of the sorting (ascending or descending).
+ *The maximum number of contexts to return in the response. The default value is 10.
* @public */ - SortOrder?: SortOrder; + MaxResults?: number; } /** * @public */ -export interface ListEdgeDeploymentPlansResponse { +export interface ListContextsResponse { /** - *List of summaries of edge deployment plans.
+ *A list of contexts and their properties.
* @public */ - EdgeDeploymentPlanSummaries: EdgeDeploymentPlanSummary[] | undefined; + ContextSummaries?: ContextSummary[]; /** - *The token to use when calling the next page of results.
+ *A token for getting the next set of contexts, if there are any.
* @public */ NextToken?: string; @@ -7527,103 +7483,122 @@ export interface ListEdgeDeploymentPlansResponse { * @public * @enum */ -export const ListEdgePackagingJobsSortBy = { - CreationTime: "CREATION_TIME", - EdgePackagingJobStatus: "STATUS", - LastModifiedTime: "LAST_MODIFIED_TIME", - ModelName: "MODEL_NAME", - Name: "NAME", +export const MonitoringJobDefinitionSortKey = { + CREATION_TIME: "CreationTime", + NAME: "Name", } as const; /** * @public */ -export type ListEdgePackagingJobsSortBy = - (typeof ListEdgePackagingJobsSortBy)[keyof typeof ListEdgePackagingJobsSortBy]; +export type MonitoringJobDefinitionSortKey = + (typeof MonitoringJobDefinitionSortKey)[keyof typeof MonitoringJobDefinitionSortKey]; /** * @public */ -export interface ListEdgePackagingJobsRequest { +export interface ListDataQualityJobDefinitionsRequest { /** - *The response from the last list when returning a list large enough to need tokening.
+ *A filter that lists the data quality job definitions associated with the specified + * endpoint.
* @public */ - NextToken?: string; + EndpointName?: string; /** - *Maximum number of results to select.
+ *The field to sort results by. The default is CreationTime.
Select jobs where the job was created after specified time.
+ *Whether to sort the results in Ascending or Descending order.
+ * The default is Descending.
Select jobs where the job was created before specified time.
+ *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.>
Select jobs where the job was updated after specified time.
+ *The maximum number of data quality monitoring job definitions to return in the + * response.
* @public */ - LastModifiedTimeAfter?: Date; + MaxResults?: number; /** - *Select jobs where the job was updated before specified time.
+ *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 */ - LastModifiedTimeBefore?: Date; + NameContains?: string; /** - *Filter for jobs containing this name in their packaging job name.
+ *A filter that returns only data quality monitoring job definitions created before the + * specified time.
* @public */ - NameContains?: string; + CreationTimeBefore?: Date; /** - *Filter for jobs where the model name contains this string.
+ *A filter that returns only data quality monitoring job definitions created after the + * specified time.
* @public */ - ModelNameContains?: string; + CreationTimeAfter?: Date; +} +/** + *Summary information about a monitoring job.
+ * @public + */ +export interface MonitoringJobDefinitionSummary { /** - *The job status to filter for.
+ *The name of the monitoring job.
* @public */ - StatusEquals?: EdgePackagingJobStatus; + MonitoringJobDefinitionName: string | undefined; /** - *Use to specify what column to sort by.
+ *The Amazon Resource Name (ARN) of the monitoring job.
* @public */ - SortBy?: ListEdgePackagingJobsSortBy; + MonitoringJobDefinitionArn: string | undefined; /** - *What direction to sort by.
+ *The time that the monitoring job was created.
* @public */ - SortOrder?: SortOrder; + CreationTime: Date | undefined; + + /** + *The name of the endpoint that the job monitors.
+ * @public + */ + EndpointName: string | undefined; } /** * @public */ -export interface ListEdgePackagingJobsResponse { +export interface ListDataQualityJobDefinitionsResponse { /** - *Summaries of edge packaging jobs.
+ *A list of data quality monitoring job definitions.
* @public */ - EdgePackagingJobSummaries: EdgePackagingJobSummary[] | undefined; + JobDefinitionSummaries: MonitoringJobDefinitionSummary[] | undefined; /** - *Token to use when calling the next page of results.
+ *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 field to sort results by. The default is CreationTime.
The response from the last list when returning a list large enough to need tokening.
* @public */ - SortBy?: EndpointConfigSortKey; + NextToken?: string; /** - *The sort order for results. The default is Descending.
The maximum number of results to select.
* @public */ - SortOrder?: OrderKey; + MaxResults?: number; /** - *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.
Filter fleets where packaging job was created after specified time.
* @public */ - NextToken?: string; + CreationTimeAfter?: Date; /** - *The maximum number of training jobs to return in the response.
+ *Filter fleets where the edge packaging job was created before specified time.
* @public */ - MaxResults?: number; + CreationTimeBefore?: Date; /** - *A string in the endpoint configuration name. This filter returns only endpoint - * configurations whose name contains the specified string.
+ *Select fleets where the job was updated after X
* @public */ - NameContains?: string; + LastModifiedTimeAfter?: Date; /** - *A filter that returns only endpoint configurations created before the specified - * time (timestamp).
+ *Select fleets where the job was updated before X
* @public */ - CreationTimeBefore?: Date; + LastModifiedTimeBefore?: Date; /** - *A filter that returns only endpoint configurations with a creation time greater - * than or equal to the specified time (timestamp).
+ *Filter for fleets containing this name in their fleet device name.
* @public */ - CreationTimeAfter?: Date; -} + NameContains?: string; -/** - * @public - */ -export interface ListEndpointConfigsOutput { /** - *An array of endpoint configurations.
+ *The column to sort by.
* @public */ - EndpointConfigs: EndpointConfigSummary[] | undefined; + SortBy?: ListDeviceFleetsSortBy; /** - *If the response is truncated, SageMaker returns this token. To retrieve the next set of - * endpoint configurations, use it in the subsequent request
+ *What direction to sort in.
* @public */ - NextToken?: string; + SortOrder?: SortOrder; } /** * @public */ -export interface ListEndpointsInput { +export interface ListDeviceFleetsResponse { /** - *Sorts the list of results. The default is CreationTime.
Summary of the device fleet.
* @public */ - SortBy?: EndpointSortKey; + DeviceFleetSummaries: DeviceFleetSummary[] | undefined; /** - *The sort order for results. The default is Descending.
The response from the last list when returning a list large enough to need tokening.
* @public */ - SortOrder?: OrderKey; + NextToken?: string; +} +/** + * @public + */ +export interface ListDevicesRequest { /** - *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.
The response from the last list when returning a list large enough to need tokening.
* @public */ NextToken?: string; /** - *The maximum number of endpoints to return in the response. This value defaults to - * 10.
+ *Maximum number of results to select.
* @public */ MaxResults?: number; /** - *A string in endpoint names. This filter returns only endpoints whose name contains - * the specified string.
+ *Select fleets where the job was updated after X
* @public */ - NameContains?: string; + LatestHeartbeatAfter?: Date; /** - *A filter that returns only endpoints that were created before the specified time - * (timestamp).
+ *A filter that searches devices that contains this name in any of their models.
* @public */ - CreationTimeBefore?: Date; + ModelName?: string; /** - *A filter that returns only endpoints with a creation time greater than or equal to - * the specified time (timestamp).
+ *Filter for fleets containing this name in their device fleet name.
* @public */ - CreationTimeAfter?: Date; + DeviceFleetName?: string; +} +/** + * @public + */ +export interface ListDevicesResponse { /** - *A filter that returns only endpoints that were modified before the specified - * timestamp.
+ *Summary of devices.
* @public */ - LastModifiedTimeBefore?: Date; + DeviceSummaries: DeviceSummary[] | undefined; /** - *A filter that returns only endpoints that were modified after the specified - * timestamp.
+ *The response from the last list when returning a list large enough to need tokening.
* @public */ - LastModifiedTimeAfter?: Date; + NextToken?: string; +} +/** + * @public + */ +export interface ListDomainsRequest { /** - *A filter that returns only endpoints with the specified status.
+ *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 */ - StatusEquals?: EndpointStatus; + NextToken?: string; + + /** + *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 array or endpoint objects.
+ *The list of domains.
* @public */ - Endpoints: EndpointSummary[] | undefined; + Domains?: DomainDetails[]; /** - *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 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; @@ -7808,71 +7789,99 @@ export interface ListEndpointsOutput { * @public * @enum */ -export const SortExperimentsBy = { - CREATION_TIME: "CreationTime", - NAME: "Name", +export const ListEdgeDeploymentPlansSortBy = { + CreationTime: "CREATION_TIME", + DeviceFleetName: "DEVICE_FLEET_NAME", + LastModifiedTime: "LAST_MODIFIED_TIME", + Name: "NAME", } as const; /** * @public */ -export type SortExperimentsBy = (typeof SortExperimentsBy)[keyof typeof SortExperimentsBy]; +export type ListEdgeDeploymentPlansSortBy = + (typeof ListEdgeDeploymentPlansSortBy)[keyof typeof ListEdgeDeploymentPlansSortBy]; /** * @public */ -export interface ListExperimentsRequest { +export interface ListEdgeDeploymentPlansRequest { /** - *A filter that returns only experiments created after the specified time.
+ *The response from the last list when returning a list large enough to need + * tokening.
* @public */ - CreatedAfter?: Date; + NextToken?: string; /** - *A filter that returns only experiments created before the specified time.
+ *The maximum number of results to select (50 by default).
* @public */ - CreatedBefore?: Date; + MaxResults?: number; /** - *The property used to sort results. The default value is CreationTime.
Selects edge deployment plans created after this time.
* @public */ - SortBy?: SortExperimentsBy; + CreationTimeAfter?: Date; /** - *The sort order. The default value is Descending.
Selects edge deployment plans created before this time.
* @public */ - SortOrder?: SortOrder; + CreationTimeBefore?: Date; /** - *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.
Selects edge deployment plans that were last updated after this time.
* @public */ - NextToken?: string; + LastModifiedTimeAfter?: Date; /** - *The maximum number of experiments to return in the response. The default value is - * 10.
+ *Selects edge deployment plans that were last updated before this time.
* @public */ - MaxResults?: number; + LastModifiedTimeBefore?: Date; + + /** + *Selects edge deployment plans with names containing this name.
+ * @public + */ + NameContains?: string; + + /** + *Selects edge deployment plans with a device fleet name containing this name.
+ * @public + */ + DeviceFleetNameContains?: string; + + /** + *The column by which to sort the edge deployment plans. Can be one of
+ * NAME, DEVICEFLEETNAME, CREATIONTIME,
+ * LASTMODIFIEDTIME.
The direction of the sorting (ascending or descending).
+ * @public + */ + SortOrder?: SortOrder; } /** * @public */ -export interface ListExperimentsResponse { +export interface ListEdgeDeploymentPlansResponse { /** - *A list of the summaries of your experiments.
+ *List of summaries of edge deployment plans.
* @public */ - ExperimentSummaries?: ExperimentSummary[]; + EdgeDeploymentPlanSummaries: EdgeDeploymentPlanSummary[] | undefined; /** - *A token for getting the next set of experiments, if there are any.
+ *The token to use when calling the next page of results.
* @public */ NextToken?: string; @@ -7880,79 +7889,105 @@ export interface ListExperimentsResponse { /** * @public + * @enum */ -export interface ListFeatureGroupsRequest { +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]; + +/** + * @public + */ +export interface ListEdgePackagingJobsRequest { /** - *A string that partially matches one or more FeatureGroups names. Filters
- * FeatureGroups by name.
The response from the last list when returning a list large enough to need tokening.
* @public */ - NameContains?: string; + NextToken?: string; /** - *A FeatureGroup status. Filters by FeatureGroup status.
Maximum number of results to select.
* @public */ - FeatureGroupStatusEquals?: FeatureGroupStatus; + MaxResults?: number; /** - *An OfflineStore status. Filters by OfflineStore status.
- *
Select jobs where the job was created after specified time.
* @public */ - OfflineStoreStatusEquals?: OfflineStoreStatusValue; + CreationTimeAfter?: Date; /** - *Use this parameter to search for FeatureGroupss created after a specific
- * date and time.
Select jobs where the job was created before specified time.
* @public */ - CreationTimeAfter?: Date; + CreationTimeBefore?: Date; + + /** + *Select jobs where the job was updated after specified time.
+ * @public + */ + LastModifiedTimeAfter?: Date; + + /** + *Select jobs where the job was updated before specified time.
+ * @public + */ + LastModifiedTimeBefore?: Date; /** - *Use this parameter to search for FeatureGroupss created before a specific
- * date and time.
Filter for jobs containing this name in their packaging job name.
* @public */ - CreationTimeBefore?: Date; + NameContains?: string; /** - *The order in which feature groups are listed.
+ *Filter for jobs where the model name contains this string.
* @public */ - SortOrder?: FeatureGroupSortOrder; + ModelNameContains?: string; /** - *The value on which the feature group list is sorted.
+ *The job status to filter for.
* @public */ - SortBy?: FeatureGroupSortBy; + StatusEquals?: EdgePackagingJobStatus; /** - *The maximum number of results returned by ListFeatureGroups.
Use to specify what column to sort by.
* @public */ - MaxResults?: number; + SortBy?: ListEdgePackagingJobsSortBy; /** - *A token to resume pagination of ListFeatureGroups results.
What direction to sort by.
* @public */ - NextToken?: string; + SortOrder?: SortOrder; } /** * @public */ -export interface ListFeatureGroupsResponse { +export interface ListEdgePackagingJobsResponse { /** - *A summary of feature groups.
+ *Summaries of edge packaging jobs.
* @public */ - FeatureGroupSummaries: FeatureGroupSummary[] | undefined; + EdgePackagingJobSummaries: EdgePackagingJobSummary[] | undefined; /** - *A token to resume pagination of ListFeatureGroups results.
Token to use when calling the next page of results.
* @public */ NextToken?: string; @@ -7960,51 +7995,83 @@ export interface ListFeatureGroupsResponse { /** * @public + * @enum */ -export interface ListFlowDefinitionsRequest { +export const OrderKey = { + Ascending: "Ascending", + Descending: "Descending", +} as const; + +/** + * @public + */ +export type OrderKey = (typeof OrderKey)[keyof typeof OrderKey]; + +/** + * @public + */ +export interface ListEndpointConfigsInput { /** - *A filter that returns only flow definitions with a creation time greater than or equal to the specified timestamp.
+ *The field to sort results by. The default is CreationTime.
A filter that returns only flow definitions that were created before the specified timestamp.
+ *The sort order for results. The default is Descending.
An optional value that specifies whether you want the results sorted in Ascending or Descending order.
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 token to resume pagination.
+ *The maximum number of training jobs to return in the response.
* @public */ - NextToken?: string; + MaxResults?: number; /** - *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 string in the endpoint configuration name. This filter returns only endpoint + * configurations whose name contains the specified string.
* @public */ - MaxResults?: number; + NameContains?: string; + + /** + *A filter that returns only endpoint configurations created before the specified + * time (timestamp).
+ * @public + */ + CreationTimeBefore?: Date; + + /** + *A filter that returns only endpoint configurations with a creation time greater + * than or equal to the specified time (timestamp).
+ * @public + */ + CreationTimeAfter?: Date; } /** * @public */ -export interface ListFlowDefinitionsResponse { +export interface ListEndpointConfigsOutput { /** - *An array of objects describing the flow definitions.
+ *An array of endpoint configurations.
* @public */ - FlowDefinitionSummaries: FlowDefinitionSummary[] | undefined; + EndpointConfigs: EndpointConfigSummary[] | undefined; /** - *A token to resume pagination.
+ *If the response is truncated, SageMaker returns this token. To retrieve the next set of + * endpoint configurations, use it in the subsequent request
* @public */ NextToken?: string; @@ -8013,80 +8080,89 @@ export interface ListFlowDefinitionsResponse { /** * @public */ -export interface ListHubContentsRequest { +export interface ListEndpointsInput { /** - *The name of the hub to list the contents of.
+ *Sorts the list of results. The default is CreationTime.
The type of hub content to list.
+ *The sort order for results. The default is Descending.
Only list hub content if the name contains the specified string.
+ *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.
The upper bound of the hub content schema verion.
+ *The maximum number of endpoints to return in the response. This value defaults to + * 10.
* @public */ - MaxSchemaVersion?: string; + MaxResults?: number; /** - *Only list hub content that was created before the time specified.
+ *A string in endpoint names. This filter returns only endpoints whose name contains + * the specified string.
* @public */ - CreationTimeBefore?: Date; + NameContains?: string; /** - *Only list hub content that was created after the time specified.
+ *A filter that returns only endpoints that were created before the specified time + * (timestamp).
* @public */ - CreationTimeAfter?: Date; + CreationTimeBefore?: Date; /** - *Sort hub content versions by either name or creation time.
+ *A filter that returns only endpoints with a creation time greater than or equal to + * the specified time (timestamp).
* @public */ - SortBy?: HubContentSortBy; + CreationTimeAfter?: Date; /** - *Sort hubs by ascending or descending order.
+ *A filter that returns only endpoints that were modified before the specified + * timestamp.
* @public */ - SortOrder?: SortOrder; + LastModifiedTimeBefore?: Date; /** - *The maximum amount of hub content to list.
+ *A filter that returns only endpoints that were modified after the specified + * timestamp.
* @public */ - MaxResults?: number; + LastModifiedTimeAfter?: Date; /** - *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.
A filter that returns only endpoints with the specified status.
* @public */ - NextToken?: string; + StatusEquals?: EndpointStatus; } /** * @public */ -export interface ListHubContentsResponse { +export interface ListEndpointsOutput { /** - *The summaries of the listed hub content.
+ *An array or endpoint objects.
* @public */ - HubContentSummaries: HubContentInfo[] | undefined; + Endpoints: EndpointSummary[] | undefined; /** - *If the response is truncated, SageMaker returns this token. To retrieve the next set of hub content, 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; @@ -8094,87 +8170,73 @@ export interface ListHubContentsResponse { /** * @public + * @enum */ -export interface ListHubContentVersionsRequest { - /** - *The name of the hub to list the content versions of.
- * @public - */ - HubName: string | undefined; - - /** - *The type of hub content to list versions of.
- * @public - */ - HubContentType: HubContentType | undefined; - - /** - *The name of the hub content.
- * @public - */ - HubContentName: string | undefined; - - /** - *The lower bound of the hub content versions to list.
- * @public - */ - MinVersion?: string; +export const SortExperimentsBy = { + CREATION_TIME: "CreationTime", + NAME: "Name", +} as const; - /** - *The upper bound of the hub content schema version.
- * @public - */ - MaxSchemaVersion?: string; +/** + * @public + */ +export type SortExperimentsBy = (typeof SortExperimentsBy)[keyof typeof SortExperimentsBy]; +/** + * @public + */ +export interface ListExperimentsRequest { /** - *Only list hub content versions that were created before the time specified.
+ *A filter that returns only experiments created after the specified time.
* @public */ - CreationTimeBefore?: Date; + CreatedAfter?: Date; /** - *Only list hub content versions that were created after the time specified.
+ *A filter that returns only experiments created before the specified time.
* @public */ - CreationTimeAfter?: Date; + CreatedBefore?: Date; /** - *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 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 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 experiments to return in the response. The default value is + * 10.
* @public */ - NextToken?: string; + MaxResults?: number; } /** * @public */ -export interface ListHubContentVersionsResponse { +export interface ListExperimentsResponse { /** - *The summaries of the listed hub content versions.
+ *A list of the summaries of your experiments.
* @public */ - HubContentSummaries: HubContentInfo[] | undefined; + ExperimentSummaries?: ExperimentSummary[]; /** - *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 experiments, if there are any.
* @public */ NextToken?: string; @@ -8183,57 +8245,61 @@ export interface ListHubContentVersionsResponse { /** * @public */ -export interface ListHubsRequest { +export interface ListFeatureGroupsRequest { /** - *Only list hubs with names that contain the specified string.
+ *A string that partially matches one or more FeatureGroups names. Filters
+ * FeatureGroups by name.
Only list hubs that were created before the time specified.
+ *A FeatureGroup status. Filters by FeatureGroup status.
Only list hubs that were created after the time specified.
+ *An OfflineStore status. Filters by OfflineStore status.
+ *
Only list hubs that were last modified before the time specified.
+ *Use this parameter to search for FeatureGroupss created after a specific
+ * date and time.
Only list hubs that were last modified after the time specified.
+ *Use this parameter to search for FeatureGroupss created before a specific
+ * date and time.
Sort hubs by either name or creation time.
+ *The order in which feature groups are listed.
* @public */ - SortBy?: HubSortBy; + SortOrder?: FeatureGroupSortOrder; /** - *Sort hubs by ascending or descending order.
+ *The value on which the feature group list is sorted.
* @public */ - SortOrder?: SortOrder; + SortBy?: FeatureGroupSortBy; /** - *The maximum number of hubs to list.
+ *The maximum number of results returned by ListFeatureGroups.
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.
A token to resume pagination of ListFeatureGroups results.
The summaries of the listed hubs.
+ *A summary of feature groups.
* @public */ - HubSummaries: HubInfo[] | undefined; + FeatureGroupSummaries: FeatureGroupSummary[] | undefined; /** - *If the response is truncated, SageMaker returns this token. To retrieve the next set of hubs, use it in the subsequent request.
+ *A token to resume pagination of ListFeatureGroups results.
A filter that returns only human task user interfaces with a creation time greater than or equal to the specified timestamp.
+ *A filter that returns only flow definitions with a creation time greater than or equal to the specified timestamp.
* @public */ CreationTimeAfter?: Date; /** - *A filter that returns only human task user interfaces that were created before the specified timestamp.
+ *A filter that returns only flow definitions that were created before the specified timestamp.
* @public */ CreationTimeBefore?: Date; @@ -8294,12 +8360,12 @@ export interface ListHumanTaskUisRequest { /** * @public */ -export interface ListHumanTaskUisResponse { +export interface ListFlowDefinitionsResponse { /** - *An array of objects describing the human task user interfaces.
+ *An array of objects describing the flow definitions.
* @public */ - HumanTaskUiSummaries: HumanTaskUiSummary[] | undefined; + FlowDefinitionSummaries: FlowDefinitionSummary[] | undefined; /** *A token to resume pagination.
@@ -8311,94 +8377,80 @@ export interface ListHumanTaskUisResponse { /** * @public */ -export interface ListHyperParameterTuningJobsRequest { +export interface ListHubContentsRequest { /** - *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.
The name of the hub to list the contents of.
* @public */ - NextToken?: string; + HubName: string | undefined; /** - *The - * maximum number of tuning jobs to return. The default value is - * 10.
+ *The type of hub content to list.
* @public */ - MaxResults?: number; + HubContentType: HubContentType | undefined; /** - *The field to sort results by. The default is Name.
Only list hub content if the name contains the specified string.
* @public */ - SortBy?: HyperParameterTuningJobSortByOptions; + NameContains?: string; /** - *The sort order for results. The default is Ascending.
The upper bound of the hub content schema verion.
* @public */ - SortOrder?: SortOrder; + MaxSchemaVersion?: string; /** - *A string in the tuning job name. This filter returns only tuning jobs whose name - * contains the specified string.
+ *Only list hub content that was created before the time specified.
* @public */ - NameContains?: string; + CreationTimeBefore?: Date; /** - *A filter that returns only tuning jobs that were created after the specified - * time.
+ *Only list hub content that was created after the time specified.
* @public */ CreationTimeAfter?: Date; /** - *A filter that returns only tuning jobs that were created before the specified - * time.
+ *Sort hub content versions by either name or creation time.
* @public */ - CreationTimeBefore?: Date; + SortBy?: HubContentSortBy; /** - *A filter that returns only tuning jobs that were modified after the specified - * time.
+ *Sort hubs by ascending or descending order.
* @public */ - LastModifiedTimeAfter?: Date; + SortOrder?: SortOrder; /** - *A filter that returns only tuning jobs that were modified before the specified - * time.
+ *The maximum amount of hub content to list.
* @public */ - LastModifiedTimeBefore?: Date; + MaxResults?: number; /** - *A filter that returns only tuning jobs with the specified status.
+ *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.
A list of HyperParameterTuningJobSummary objects that
- * describe
- * the tuning jobs that the ListHyperParameterTuningJobs
- * request returned.
The summaries of the listed hub content.
* @public */ - HyperParameterTuningJobSummaries: HyperParameterTuningJobSummary[] | undefined; + HubContentSummaries: HubContentInfo[] | 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.
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; @@ -8407,75 +8459,69 @@ export interface ListHyperParameterTuningJobsResponse { /** * @public */ -export interface ListImagesRequest { +export interface ListHubContentVersionsRequest { /** - *A filter that returns only images created on or after the specified time.
+ *The name of the hub to list the content versions of.
* @public */ - CreationTimeAfter?: Date; + HubName: string | undefined; /** - *A filter that returns only images created on or before the specified time.
+ *The type of hub content to list versions of.
* @public */ - CreationTimeBefore?: Date; + HubContentType: HubContentType | undefined; /** - *A filter that returns only images modified on or after the specified time.
+ *The name of the hub content.
* @public */ - LastModifiedTimeAfter?: Date; + HubContentName: string | undefined; /** - *A filter that returns only images modified on or before the specified time.
+ *The lower bound of the hub content versions to list.
* @public */ - LastModifiedTimeBefore?: Date; + MinVersion?: string; /** - *The maximum number of images to return in the response. The default value is 10.
+ *The upper bound of the hub content schema version.
* @public */ - MaxResults?: number; + MaxSchemaVersion?: string; /** - *A filter that returns only images whose name contains the specified string.
+ *Only list hub content versions that were created before the time specified.
* @public */ - NameContains?: string; + CreationTimeBefore?: Date; /** - *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.
Only list hub content versions that were created after the time specified.
* @public */ - NextToken?: string; + CreationTimeAfter?: Date; /** - *The property used to sort results. The default value is CREATION_TIME.
Sort hub content versions by either name or creation time.
* @public */ - SortBy?: ImageSortBy; + SortBy?: HubContentSortBy; /** - *The sort order. The default value is DESCENDING.
Sort hub content versions by ascending or descending order.
* @public */ - SortOrder?: ImageSortOrder; -} + SortOrder?: SortOrder; -/** - * @public - */ -export interface ListImagesResponse { /** - *A list of images and their properties.
+ *The maximum number of hub content versions to list.
* @public */ - Images?: Image[]; + MaxResults?: number; /** - *A token for getting the next set of images, if there are any.
+ *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.
A filter that returns only versions created on or after the specified time.
+ *The summaries of the listed hub content versions.
* @public */ - CreationTimeAfter?: Date; + HubContentSummaries: HubContentInfo[] | undefined; /** - *A filter that returns only versions created on or before the specified time.
+ *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 */ - CreationTimeBefore?: Date; + NextToken?: string; +} +/** + * @public + */ +export interface ListHubsRequest { /** - *The name of the image to list the versions of.
+ *Only list hubs with names that contain the specified string.
* @public */ - ImageName: string | undefined; + NameContains?: string; /** - *A filter that returns only versions modified on or after the specified time.
+ *Only list hubs that were created before the time specified.
* @public */ - LastModifiedTimeAfter?: Date; + CreationTimeBefore?: Date; /** - *A filter that returns only versions modified on or before the specified time.
+ *Only list hubs that were created after the time specified.
* @public */ - LastModifiedTimeBefore?: Date; + CreationTimeAfter?: Date; /** - *The maximum number of versions to return in the response. The default value is 10.
+ *Only list hubs that were last modified before the time specified.
* @public */ - MaxResults?: number; + LastModifiedTimeBefore?: Date; /** - *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.
Only list hubs that were last modified after the time specified.
* @public */ - NextToken?: string; + LastModifiedTimeAfter?: Date; /** - *The property used to sort results. The default value is CREATION_TIME.
Sort hubs by either name or creation time.
* @public */ - SortBy?: ImageVersionSortBy; + SortBy?: HubSortBy; /** - *The sort order. The default value is DESCENDING.
Sort hubs by ascending or descending order.
* @public */ - SortOrder?: ImageVersionSortOrder; -} + SortOrder?: SortOrder; -/** - * @public - */ -export interface ListImageVersionsResponse { /** - *A list of versions and their properties.
+ *The maximum number of hubs to list.
* @public */ - ImageVersions?: ImageVersion[]; + MaxResults?: number; /** - *A token for getting the next set of versions, if there are any.
+ *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.
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.
The summaries of the listed hubs.
* @public */ - SortOrder?: OrderKey; + HubSummaries: HubInfo[] | undefined; /** - *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.
+ *If the response is truncated, SageMaker returns this token. To retrieve the next set of hubs, use it in the subsequent request.
* @public */ NextToken?: string; +} +/** + * @public + */ +export interface ListHumanTaskUisRequest { /** - *The maximum number of inference components to return in the response. This value - * defaults to 10.
- * @public - */ - MaxResults?: number; - - /** - *Filters the results to only those inference components with a name that contains the - * specified string.
- * @public - */ - NameContains?: string; - - /** - *Filters the results to only those inference components that were created before the - * specified time.
- * @public - */ - CreationTimeBefore?: Date; - - /** - *Filters the results to only those inference components that were created after the - * specified time.
+ *A filter that returns only human task user interfaces with a creation time greater than or equal to the specified timestamp.
* @public */ CreationTimeAfter?: Date; /** - *Filters the results to only those inference components that were updated before the - * specified time.
- * @public - */ - LastModifiedTimeBefore?: Date; - - /** - *Filters the results to only those inference components that were updated after the - * specified time.
+ *A filter that returns only human task user interfaces that were created before the specified timestamp.
* @public */ - LastModifiedTimeAfter?: Date; + CreationTimeBefore?: Date; /** - *Filters the results to only those inference components with the specified status.
+ *An optional value that specifies whether you want the results sorted in Ascending or Descending order.
An endpoint name to filter the listed inference components. The response includes only - * those inference components that are hosted at the specified endpoint.
+ *A token to resume pagination.
* @public */ - EndpointNameEquals?: string; + NextToken?: string; /** - *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 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 list of inference components and their properties that matches any of the filters you - * specified in the request.
+ *An array of objects describing the human task user interfaces.
* @public */ - InferenceComponents: InferenceComponentSummary[] | undefined; + HumanTaskUiSummaries: HumanTaskUiSummary[] | undefined; /** - *The token to use in a subsequent request to get the next set of results following a - * truncated response.
+ *A token to resume pagination.
* @public */ NextToken?: string; } -/** - * @public - * @enum - */ -export const SortInferenceExperimentsBy = { - CREATION_TIME: "CreationTime", - NAME: "Name", - STATUS: "Status", -} as const; - -/** - * @public - */ -export type SortInferenceExperimentsBy = (typeof SortInferenceExperimentsBy)[keyof typeof SortInferenceExperimentsBy]; - /** * @public */ -export interface ListInferenceExperimentsRequest { - /** - *Selects inference experiments whose names contain this name.
- * @public - */ - NameContains?: string; - +export interface ListHyperParameterTuningJobsRequest { /** - *- * Selects inference experiments of this type. For the possible types of inference experiments, see CreateInferenceExperiment. - *
+ *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.
- * Selects inference experiments which are in this status. For the possible statuses, see DescribeInferenceExperiment. - *
+ *The + * maximum number of tuning jobs to return. The default value is + * 10.
* @public */ - StatusEquals?: InferenceExperimentStatus; + MaxResults?: number; /** - *Selects inference experiments which were created after this timestamp.
+ *The field to sort results by. The default is Name.
Selects inference experiments which were created before this timestamp.
+ *The sort order for results. The default is Ascending.
Selects inference experiments which were last modified after this timestamp.
+ *A string in the tuning job name. This filter returns only tuning jobs whose name + * contains the specified string.
* @public */ - LastModifiedTimeAfter?: Date; + NameContains?: string; /** - *Selects inference experiments which were last modified before this timestamp.
+ *A filter that returns only tuning jobs that were created after the specified + * time.
* @public */ - LastModifiedTimeBefore?: Date; + CreationTimeAfter?: Date; /** - *The column by which to sort the listed inference experiments.
+ *A filter that returns only tuning jobs that were created before the specified + * time.
* @public */ - SortBy?: SortInferenceExperimentsBy; + CreationTimeBefore?: Date; /** - *The direction of sorting (ascending or descending).
+ *A filter that returns only tuning jobs that were modified after the specified + * time.
* @public */ - SortOrder?: SortOrder; + LastModifiedTimeAfter?: Date; /** - *- * The response from the last list when returning a list large enough to need tokening. - *
+ *A filter that returns only tuning jobs that were modified before the specified + * time.
* @public */ - NextToken?: string; + LastModifiedTimeBefore?: Date; /** - *The maximum number of results to select.
+ *A filter that returns only tuning jobs with the specified status.
* @public */ - MaxResults?: number; + StatusEquals?: HyperParameterTuningJobStatus; } /** * @public */ -export interface ListInferenceExperimentsResponse { +export interface ListHyperParameterTuningJobsResponse { /** - *List of inference experiments.
+ *A list of HyperParameterTuningJobSummary objects that
+ * describe
+ * the tuning jobs that the ListHyperParameterTuningJobs
+ * request returned.
The token to use when calling the next page of results.
+ *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.
A filter that returns only jobs created after the specified time (timestamp).
+ *A filter that returns only images created on or after the specified time.
* @public */ CreationTimeAfter?: Date; /** - *A filter that returns only jobs created before the specified time (timestamp).
+ *A filter that returns only images created on or before the specified time.
* @public */ CreationTimeBefore?: Date; /** - *A filter that returns only jobs that were last modified after the specified time (timestamp).
+ *A filter that returns only images modified on or after the specified time.
* @public */ LastModifiedTimeAfter?: Date; /** - *A filter that returns only jobs that were last modified before the specified time (timestamp).
+ *A filter that returns only images modified on or before the specified time.
* @public */ LastModifiedTimeBefore?: Date; /** - *A string in the job name. This filter returns only recommendations whose name contains the specified string.
- * @public - */ - NameContains?: string; - - /** - *A filter that retrieves only inference recommendations jobs with a specific status.
+ *The maximum number of images to return in the response. The default value is 10.
* @public */ - StatusEquals?: RecommendationJobStatus; + MaxResults?: number; /** - *The parameter by which to sort the results.
+ *A filter that returns only images whose name contains the specified string.
* @public */ - SortBy?: ListInferenceRecommendationsJobsSortBy; + NameContains?: string; /** - *The sort order for the results.
+ *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.
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 property used to sort results. The default value is CREATION_TIME.
The maximum number of recommendations to return in the response.
+ *The sort order. The default value is DESCENDING.
A filter that returns only jobs that were created for this model.
+ *A list of images and their properties.
* @public */ - ModelNameEquals?: string; + Images?: Image[]; /** - *A filter that returns only jobs that were created for this versioned model package.
+ *A token for getting the next set of images, if there are any.
* @public */ - ModelPackageVersionArnEquals?: string; + NextToken?: string; } /** * @public */ -export interface ListInferenceRecommendationsJobsResponse { +export interface ListImageVersionsRequest { /** - *The recommendations created from the Amazon SageMaker Inference Recommender job.
+ *A filter that returns only versions created on or after the specified time.
* @public */ - InferenceRecommendationsJobs: InferenceRecommendationsJob[] | undefined; + CreationTimeAfter?: Date; /** - *A token for getting the next set of recommendations, if there are any.
+ *A filter that returns only versions created on or before the specified time.
* @public */ - NextToken?: string; -} + CreationTimeBefore?: Date; -/** - * @public - */ -export interface ListInferenceRecommendationsJobStepsRequest { /** - *The name for the Inference Recommender job.
+ *The name of the image to list the versions of.
* @public */ - JobName: string | undefined; + ImageName: string | 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 versions modified on or after the specified time.
* @public */ - Status?: RecommendationJobStatus; + LastModifiedTimeAfter?: Date; /** - *A filter to return details about the specified type of subtask.
- *
- * BENCHMARK: Evaluate the performance of your model on different instance types.
A filter that returns only versions modified on or before the specified time.
* @public */ - StepType?: RecommendationStepType; + LastModifiedTimeBefore?: Date; /** - *The maximum number of results to return.
+ *The maximum number of versions to return in the response. The default value is 10.
* @public */ MaxResults?: number; /** - *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 ListImageVersions didn't return the full set of
+ * versions, the call returns a token for getting the next set of versions.
The property used to sort results. The default value is CREATION_TIME.
The sort order. The default value is DESCENDING.
A list of all subtask details in Inference Recommender.
+ *A list of versions and their properties.
* @public */ - Steps?: InferenceRecommendationsJobStep[]; + ImageVersions?: ImageVersion[]; /** - *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 versions, if there are any.
* @public */ NextToken?: string; } -/** - * @public - * @enum - */ -export const SortBy = { - CREATION_TIME: "CreationTime", - NAME: "Name", - STATUS: "Status", -} as const; - /** * @public */ -export type SortBy = (typeof SortBy)[keyof typeof SortBy]; +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 filter that returns only labeling jobs created after the specified time - * (timestamp).
+ *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 */ - CreationTimeAfter?: Date; + NextToken?: string; /** - *A filter that returns only labeling jobs created before the specified time - * (timestamp).
+ *The maximum number of inference components to return in the response. This value + * defaults to 10.
* @public */ - CreationTimeBefore?: Date; + MaxResults?: number; /** - *A filter that returns only labeling jobs modified after the specified time - * (timestamp).
+ *Filters the results to only those inference components with a name that contains the + * specified string.
* @public */ - LastModifiedTimeAfter?: Date; + NameContains?: string; /** - *A filter that returns only labeling jobs modified before the specified time - * (timestamp).
+ *Filters the results to only those inference components that were created before the + * specified time.
* @public */ - LastModifiedTimeBefore?: Date; + CreationTimeBefore?: Date; /** - *The maximum number of labeling jobs to return in each page of the response.
+ *Filters the results to only those inference components that were created after the + * specified time.
* @public */ - MaxResults?: number; + CreationTimeAfter?: Date; /** - *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.
Filters the results to only those inference components that were updated before the + * specified time.
* @public */ - NextToken?: string; + LastModifiedTimeBefore?: Date; /** - *A string in the labeling job name. This filter returns only labeling jobs whose name - * contains the specified string.
+ *Filters the results to only those inference components that were updated after the + * specified time.
* @public */ - NameContains?: string; + LastModifiedTimeAfter?: Date; /** - *The field to sort results by. The default is CreationTime.
Filters the results to only those inference components with the specified status.
* @public */ - SortBy?: SortBy; + StatusEquals?: InferenceComponentStatus; /** - *The sort order for results. The default is Ascending.
An endpoint name to filter the listed inference components. The response includes only + * those inference components that are hosted at the specified endpoint.
* @public */ - SortOrder?: SortOrder; + EndpointNameEquals?: string; /** - *A filter that retrieves only labeling jobs with a specific status.
+ *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 */ - StatusEquals?: LabelingJobStatus; + VariantNameEquals?: string; } /** * @public */ -export interface ListLabelingJobsResponse { +export interface ListInferenceComponentsOutput { /** - *An array of LabelingJobSummary objects, each describing a labeling
- * job.
A list of inference components and their properties that matches any of the filters you + * specified in the request.
* @public */ - LabelingJobSummaryList?: LabelingJobSummary[]; + InferenceComponents: InferenceComponentSummary[] | undefined; /** - *If the response is truncated, SageMaker returns this token. To retrieve the next set of - * labeling jobs, 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; @@ -9050,89 +9033,106 @@ export interface ListLabelingJobsResponse { * @public * @enum */ -export const ListLabelingJobsForWorkteamSortByOptions = { +export const SortInferenceExperimentsBy = { CREATION_TIME: "CreationTime", + NAME: "Name", + STATUS: "Status", } as const; /** * @public */ -export type ListLabelingJobsForWorkteamSortByOptions = - (typeof ListLabelingJobsForWorkteamSortByOptions)[keyof typeof ListLabelingJobsForWorkteamSortByOptions]; +export type SortInferenceExperimentsBy = (typeof SortInferenceExperimentsBy)[keyof typeof SortInferenceExperimentsBy]; /** * @public */ -export interface ListLabelingJobsForWorkteamRequest { +export interface ListInferenceExperimentsRequest { /** - *The Amazon Resource Name (ARN) of the work team for which you want to see labeling - * jobs for.
+ *Selects inference experiments whose names contain this name.
* @public */ - WorkteamArn: string | undefined; + NameContains?: string; /** - *The maximum number of labeling jobs to return in each page of the response.
+ *+ * Selects inference experiments of this type. For the possible types of inference experiments, see CreateInferenceExperiment. + *
* @public */ - MaxResults?: number; + Type?: InferenceExperimentType; /** - *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.
+ * Selects inference experiments which are in this status. For the possible statuses, see DescribeInferenceExperiment. + *
* @public */ - NextToken?: string; + StatusEquals?: InferenceExperimentStatus; /** - *A filter that returns only labeling jobs created after the specified time - * (timestamp).
+ *Selects inference experiments which were created after this timestamp.
* @public */ CreationTimeAfter?: Date; /** - *A filter that returns only labeling jobs created before the specified time - * (timestamp).
+ *Selects inference experiments which were created before this timestamp.
* @public */ CreationTimeBefore?: Date; /** - *A filter the limits jobs to only the ones whose job reference code contains the - * specified string.
+ *Selects inference experiments which were last modified after this timestamp.
* @public */ - JobReferenceCodeContains?: string; + LastModifiedTimeAfter?: Date; /** - *The field to sort results by. The default is CreationTime.
Selects inference experiments which were last modified before this timestamp.
* @public */ - SortBy?: ListLabelingJobsForWorkteamSortByOptions; + LastModifiedTimeBefore?: Date; /** - *The sort order for results. The default is Ascending.
The column by which to sort the listed inference experiments.
+ * @public + */ + SortBy?: SortInferenceExperimentsBy; + + /** + *The direction of sorting (ascending or descending).
* @public */ SortOrder?: SortOrder; + + /** + *+ * The response from the last list when returning a list large enough to need tokening. + *
+ * @public + */ + NextToken?: string; + + /** + *The maximum number of results to select.
+ * @public + */ + MaxResults?: number; } /** * @public */ -export interface ListLabelingJobsForWorkteamResponse { +export interface ListInferenceExperimentsResponse { /** - *An array of LabelingJobSummary objects, each describing a labeling
- * job.
List of inference experiments.
* @public */ - LabelingJobSummaryList: LabelingJobForWorkteamSummary[] | undefined; + InferenceExperiments?: InferenceExperimentSummary[]; /** - *If the response is truncated, SageMaker returns this token. To retrieve the next set of - * labeling jobs, use it in the subsequent request.
+ *The token to use when calling the next page of results.
* @public */ NextToken?: string; @@ -9142,148 +9142,163 @@ export interface ListLabelingJobsForWorkteamResponse { * @public * @enum */ -export const SortLineageGroupsBy = { +export const ListInferenceRecommendationsJobsSortBy = { CREATION_TIME: "CreationTime", NAME: "Name", + STATUS: "Status", } as const; /** * @public */ -export type SortLineageGroupsBy = (typeof SortLineageGroupsBy)[keyof typeof SortLineageGroupsBy]; +export type ListInferenceRecommendationsJobsSortBy = + (typeof ListInferenceRecommendationsJobsSortBy)[keyof typeof ListInferenceRecommendationsJobsSortBy]; /** * @public */ -export interface ListLineageGroupsRequest { +export interface ListInferenceRecommendationsJobsRequest { /** - *A timestamp to filter against lineage groups created after a certain point in time.
+ *A filter that returns only jobs created after the specified time (timestamp).
* @public */ - CreatedAfter?: Date; + CreationTimeAfter?: Date; /** - *A timestamp to filter against lineage groups created before a certain point in time.
+ *A filter that returns only jobs created before the specified time (timestamp).
* @public */ - CreatedBefore?: Date; + CreationTimeBefore?: Date; /** - *The parameter by which to sort the results. The default is
- * CreationTime.
A filter that returns only jobs that were last modified after the specified time (timestamp).
* @public */ - SortBy?: SortLineageGroupsBy; + LastModifiedTimeAfter?: Date; /** - *The sort order for the results. The default is Ascending.
A filter that returns only jobs that were last modified before the specified time (timestamp).
+ * @public + */ + LastModifiedTimeBefore?: Date; + + /** + *A string in the job name. This filter returns only recommendations whose name contains the specified string.
+ * @public + */ + NameContains?: string; + + /** + *A filter that retrieves only inference recommendations jobs with a specific status.
+ * @public + */ + StatusEquals?: RecommendationJobStatus; + + /** + *The parameter by which to sort the results.
+ * @public + */ + SortBy?: ListInferenceRecommendationsJobsSortBy; + + /** + *The sort order for the results.
* @public */ SortOrder?: SortOrder; /** - *If the response is truncated, SageMaker returns this token. To retrieve the next set of - * algorithms, use it in the subsequent request.
+ *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 endpoints to return in the response. This value defaults to - * 10.
+ *The maximum number of recommendations to return in the response.
* @public */ MaxResults?: number; -} -/** - * @public - */ -export interface ListLineageGroupsResponse { /** - *A list of lineage groups and their properties.
+ *A filter that returns only jobs that were created for this model.
* @public */ - LineageGroupSummaries?: LineageGroupSummary[]; + ModelNameEquals?: string; /** - *If the response is truncated, SageMaker returns this token. To retrieve the next set of - * algorithms, use it in the subsequent request.
+ *A filter that returns only jobs that were created for this versioned model package.
* @public */ - NextToken?: string; + ModelPackageVersionArnEquals?: string; } /** * @public */ -export interface ListModelBiasJobDefinitionsRequest { - /** - *Name of the endpoint to monitor for model bias.
- * @public - */ - EndpointName?: string; - +export interface ListInferenceRecommendationsJobsResponse { /** - *Whether to sort results by the Name or CreationTime field.
- * The default is CreationTime.
The recommendations created from the Amazon SageMaker Inference Recommender job.
* @public */ - SortBy?: MonitoringJobDefinitionSortKey; + InferenceRecommendationsJobs: InferenceRecommendationsJob[] | undefined; /** - *Whether to sort the results in Ascending or Descending order.
- * The default is Descending.
A token for getting the next set of recommendations, if there are any.
* @public */ - SortOrder?: SortOrder; + NextToken?: string; +} +/** + * @public + */ +export interface ListInferenceRecommendationsJobStepsRequest { /** - *The token returned if the response is truncated. To retrieve the next set of job executions, use - * it in the next request.
+ *The name for the Inference Recommender job.
* @public */ - NextToken?: string; + JobName: string | undefined; /** - *The maximum number of model bias jobs to return in the response. The default value is - * 10.
+ *A filter to return benchmarks of a specified status. If this field is left empty, then all benchmarks are returned.
* @public */ - MaxResults?: number; + Status?: RecommendationJobStatus; /** - *Filter for model bias jobs whose name contains a specified string.
+ *A filter to return details about the specified type of subtask.
+ *
+ * BENCHMARK: Evaluate the performance of your model on different instance types.
A filter that returns only model bias jobs created before a specified time.
+ *The maximum number of results to return.
* @public */ - CreationTimeBefore?: Date; + MaxResults?: number; /** - *A filter that returns only model bias jobs created after a specified time.
+ *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 */ - CreationTimeAfter?: Date; + NextToken?: string; } /** * @public */ -export interface ListModelBiasJobDefinitionsResponse { +export interface ListInferenceRecommendationsJobStepsResponse { /** - *A JSON array in which each element is a summary for a model bias jobs.
+ *A list of all subtask details in Inference Recommender.
* @public */ - JobDefinitionSummaries: MonitoringJobDefinitionSummary[] | undefined; + Steps?: InferenceRecommendationsJobStep[]; /** - *The token returned if the response is truncated. To retrieve the next set of job executions, use - * it in the next request.
+ *A token that you can specify in your next request to return more results from the list.
* @public */ NextToken?: string; @@ -9293,7 +9308,7 @@ export interface ListModelBiasJobDefinitionsResponse { * @public * @enum */ -export const ModelCardExportJobSortBy = { +export const SortBy = { CREATION_TIME: "CreationTime", NAME: "Name", STATUS: "Status", @@ -9302,151 +9317,94 @@ export const ModelCardExportJobSortBy = { /** * @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]; +export type SortBy = (typeof SortBy)[keyof typeof SortBy]; /** * @public */ -export interface ListModelCardExportJobsRequest { - /** - *List export jobs for the model card with the specified name.
- * @public - */ - ModelCardName: string | undefined; - - /** - *List export jobs for the model card with the specified version.
- * @public - */ - ModelCardVersion?: number; - +export interface ListLabelingJobsRequest { /** - *Only list model card export jobs that were created after the time specified.
+ *A filter that returns only labeling jobs created after the specified time + * (timestamp).
* @public */ CreationTimeAfter?: Date; /** - *Only list model card export jobs that were created before the time specified.
+ *A filter that returns only labeling jobs created before the specified time + * (timestamp).
* @public */ CreationTimeBefore?: Date; /** - *Only list model card export jobs with names that contain the specified string.
- * @public - */ - ModelCardExportJobNameContains?: string; - - /** - *Only list model card export jobs with the specified status.
- * @public - */ - StatusEquals?: ModelCardExportJobStatus; - - /** - *Sort model card export jobs by either name or creation time. Sorts by creation time by default.
- * @public - */ - SortBy?: ModelCardExportJobSortBy; - - /** - *Sort model card export jobs by ascending or descending order.
+ *A filter that returns only labeling jobs modified after the specified time + * (timestamp).
* @public */ - SortOrder?: ModelCardExportJobSortOrder; + LastModifiedTimeAfter?: Date; /** - *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 filter that returns only labeling jobs modified before the specified time + * (timestamp).
* @public */ - NextToken?: string; + LastModifiedTimeBefore?: Date; /** - *The maximum number of model card export jobs to list.
+ *The maximum number of labeling jobs to return in each page of the response.
* @public */ MaxResults?: number; -} - -/** - *The summary of the Amazon SageMaker Model Card export job.
- * @public - */ -export interface ModelCardExportJobSummary { - /** - *The name of the model card export job.
- * @public - */ - ModelCardExportJobName: string | undefined; - - /** - *The Amazon Resource Name (ARN) of the model card export job.
- * @public - */ - ModelCardExportJobArn: string | undefined; /** - *The completion status of the model card export job.
+ *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.
The name of the model card that the export job exports.
+ *A string in the labeling job name. This filter returns only labeling jobs whose name + * contains the specified string.
* @public */ - ModelCardName: string | undefined; + NameContains?: string; /** - *The version of the model card that the export job exports.
+ *The field to sort results by. The default is CreationTime.
The date and time that the model card export job was created.
+ *The sort order for results. The default is Ascending.
The date and time that the model card export job was last modified..
+ *A filter that retrieves only labeling jobs with a specific status.
* @public */ - LastModifiedAt: Date | undefined; + StatusEquals?: LabelingJobStatus; } /** * @public */ -export interface ListModelCardExportJobsResponse { +export interface ListLabelingJobsResponse { /** - *The summaries of the listed model card export jobs.
+ *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 model - * card export jobs, use it in the subsequent 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; @@ -9456,153 +9414,165 @@ export interface ListModelCardExportJobsResponse { * @public * @enum */ -export const ModelCardSortBy = { +export const ListLabelingJobsForWorkteamSortByOptions = { 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]; +export type ListLabelingJobsForWorkteamSortByOptions = + (typeof ListLabelingJobsForWorkteamSortByOptions)[keyof typeof ListLabelingJobsForWorkteamSortByOptions]; /** * @public */ -export interface ListModelCardsRequest { +export interface ListLabelingJobsForWorkteamRequest { /** - *Only list model cards that were created after the time specified.
+ *The Amazon Resource Name (ARN) of the work team for which you want to see labeling + * jobs for.
* @public */ - CreationTimeAfter?: Date; + WorkteamArn: string | undefined; /** - *Only list model cards that were created before the time specified.
+ *The maximum number of labeling jobs to return in each page of the response.
* @public */ - CreationTimeBefore?: Date; + MaxResults?: number; /** - *The maximum number of model cards to list.
+ *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.
Only list model cards with names that contain the specified string.
+ *A filter that returns only labeling jobs created after the specified time + * (timestamp).
* @public */ - NameContains?: string; + CreationTimeAfter?: Date; /** - *Only list model cards with the specified approval status.
+ *A filter that returns only labeling jobs created before the specified time + * (timestamp).
* @public */ - ModelCardStatus?: ModelCardStatus; + CreationTimeBefore?: Date; /** - *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.
A filter the limits jobs to only the ones whose job reference code contains the + * specified string.
* @public */ - NextToken?: string; + JobReferenceCodeContains?: string; /** - *Sort model cards by either name or creation time. Sorts by creation time by default.
+ *The field to sort results by. The default is CreationTime.
Sort model cards by ascending or descending order.
+ *The sort order for results. The default is Ascending.
A summary of the model card.
* @public */ -export interface ModelCardSummary { +export interface ListLabelingJobsForWorkteamResponse { /** - *The name of the model card.
+ *An array of LabelingJobSummary objects, each describing a labeling
+ * job.
The Amazon Resource Name (ARN) of the model card.
+ *If the response is truncated, SageMaker returns this token. To retrieve the next set of + * labeling jobs, use it in the subsequent request.
* @public */ - ModelCardArn: string | undefined; + NextToken?: string; +} + +/** + * @public + * @enum + */ +export const SortLineageGroupsBy = { + CREATION_TIME: "CreationTime", + NAME: "Name", +} as const; + +/** + * @public + */ +export type SortLineageGroupsBy = (typeof SortLineageGroupsBy)[keyof typeof SortLineageGroupsBy]; +/** + * @public + */ +export interface ListLineageGroupsRequest { /** - *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 timestamp to filter against lineage groups created after a certain point in time.
+ * @public + */ + CreatedAfter?: Date; + + /** + *A timestamp to filter against lineage groups created before a certain point in time.
* @public */ - ModelCardStatus: ModelCardStatus | undefined; + CreatedBefore?: Date; /** - *The date and time that the model card was created.
+ *The parameter by which to sort the results. The default is
+ * CreationTime.
The date and time that the model card was last modified.
+ *The sort order for the results. The default is Ascending.
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; + + /** + *The maximum number of endpoints to return in the response. This value defaults to + * 10.
+ * @public + */ + MaxResults?: number; } /** * @public */ -export interface ListModelCardsResponse { +export interface ListLineageGroupsResponse { /** - *The summaries of the listed model cards.
+ *A list of lineage groups and their properties.
* @public */ - ModelCardSummaries: ModelCardSummary[] | undefined; + LineageGroupSummaries?: LineageGroupSummary[]; /** - *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 + * algorithms, use it in the subsequent request.
* @public */ NextToken?: string; @@ -9612,144 +9582,137 @@ export interface ListModelCardsResponse { * @public * @enum */ -export const ModelCardVersionSortBy = { - VERSION: "Version", +export const SortTrackingServerBy = { + CREATION_TIME: "CreationTime", + NAME: "Name", + STATUS: "Status", } as const; /** * @public */ -export type ModelCardVersionSortBy = (typeof ModelCardVersionSortBy)[keyof typeof ModelCardVersionSortBy]; +export type SortTrackingServerBy = (typeof SortTrackingServerBy)[keyof typeof SortTrackingServerBy]; /** * @public */ -export interface ListModelCardVersionsRequest { +export interface ListMlflowTrackingServersRequest { /** - *Only list model card versions that were created after the time specified.
+ *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.
Only list model card versions that were created before the time specified.
+ *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 maximum number of model card versions to list.
+ *Filter for tracking servers with a specified creation status.
* @public */ - MaxResults?: number; + TrackingServerStatus?: TrackingServerStatus; /** - *List model card versions for the model card with the specified name or Amazon Resource Name (ARN).
+ *Filter for tracking servers using the specified MLflow version.
* @public */ - ModelCardName: string | undefined; + MlflowVersion?: string; /** - *Only list model card versions with the specified approval status.
+ *Filter for trackings servers sorting by name, creation time, or creation status.
* @public */ - ModelCardStatus?: ModelCardStatus; + SortBy?: SortTrackingServerBy; /** - *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.
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.
Sort listed model card versions by version. Sorts by version by default.
+ *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?: ModelCardVersionSortBy; + NextToken?: string; /** - *Sort model card versions by ascending or descending order.
+ *The maximum number of tracking servers to list.
* @public */ - SortOrder?: ModelCardSortOrder; + MaxResults?: number; } /** - *A summary of a specific version of the model card.
+ *The summary of the tracking server to list.
* @public */ -export interface ModelCardVersionSummary { +export interface TrackingServerSummary { /** - *The name of the model card.
+ *The ARN of a listed tracking server.
* @public */ - ModelCardName: string | undefined; + TrackingServerArn?: string; /** - *The Amazon Resource Name (ARN) of the model card.
+ *The name of a listed tracking server.
* @public */ - ModelCardArn: string | undefined; + TrackingServerName?: string; /** - *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 creation time of a listed tracking server.
* @public */ - ModelCardStatus: ModelCardStatus | undefined; + CreationTime?: Date; /** - *A version of the model card.
+ *The last modified time of a listed tracking server.
* @public */ - ModelCardVersion: number | undefined; + LastModifiedTime?: Date; /** - *The date and time that the model card version was created.
+ *The creation status of a listed tracking server.
* @public */ - CreationTime: Date | undefined; + TrackingServerStatus?: TrackingServerStatus; /** - *The time date and time that the model card version was last modified.
+ *The activity status of a listed tracking server.
* @public */ - LastModifiedTime?: Date; + IsActive?: IsTrackingServerActive; + + /** + *The MLflow version used for a listed tracking server.
+ * @public + */ + MlflowVersion?: string; } /** * @public */ -export interface ListModelCardVersionsResponse { +export interface ListMlflowTrackingServersResponse { /** - *The summaries of the listed versions of the model card.
+ *A list of tracking servers according to chosen filters.
* @public */ - ModelCardVersionSummaryList: ModelCardVersionSummary[] | undefined; + TrackingServerSummaries?: TrackingServerSummary[]; /** - *If the response is truncated, SageMaker returns this token. To retrieve the next set of model - * card versions, use it in the subsequent 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; @@ -9758,9 +9721,9 @@ export interface ListModelCardVersionsResponse { /** * @public */ -export interface ListModelExplainabilityJobDefinitionsRequest { +export interface ListModelBiasJobDefinitionsRequest { /** - *Name of the endpoint to monitor for model explainability.
+ *Name of the endpoint to monitor for model bias.
* @public */ EndpointName?: string; @@ -9787,27 +9750,26 @@ export interface ListModelExplainabilityJobDefinitionsRequest { NextToken?: string; /** - *The maximum number of jobs to return in the response. The default value is 10.
+ *The maximum number of model bias jobs to return in the response. The default value is + * 10.
* @public */ MaxResults?: number; /** - *Filter for model explainability jobs whose name contains a specified string.
+ *Filter for model bias jobs whose name contains a specified string.
* @public */ NameContains?: string; /** - *A filter that returns only model explainability jobs created before a specified - * time.
+ *A filter that returns only model bias jobs created before a specified time.
* @public */ CreationTimeBefore?: Date; /** - *A filter that returns only model explainability jobs created after a specified - * time.
+ *A filter that returns only model bias jobs created after a specified time.
* @public */ CreationTimeAfter?: Date; @@ -9816,9 +9778,9 @@ export interface ListModelExplainabilityJobDefinitionsRequest { /** * @public */ -export interface ListModelExplainabilityJobDefinitionsResponse { +export interface ListModelBiasJobDefinitionsResponse { /** - *A JSON array in which each element is a summary for a explainability bias jobs.
+ *A JSON array in which each element is a summary for a model bias jobs.
* @public */ JobDefinitionSummaries: MonitoringJobDefinitionSummary[] | undefined; @@ -9835,255 +9797,160 @@ export interface ListModelExplainabilityJobDefinitionsResponse { * @public * @enum */ -export const ModelMetadataFilterType = { - DOMAIN: "Domain", - FRAMEWORK: "Framework", - FRAMEWORKVERSION: "FrameworkVersion", - TASK: "Task", +export const ModelCardExportJobSortBy = { + CREATION_TIME: "CreationTime", + NAME: "Name", + STATUS: "Status", } as const; /** * @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 { - /** - *The name of the of the model to filter by.
- * @public - */ - Name: ModelMetadataFilterType | undefined; - - /** - *The value to filter the model metadata.
- * @public - */ - Value: string | undefined; -} - -/** - *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 { - /** - *A list of filter objects.
- * @public - */ - Filters?: ModelMetadataFilter[]; -} - -/** - * @public - */ -export interface ListModelMetadataRequest { - /** - *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 - */ - SearchExpression?: ModelMetadataSearchExpression; - - /** - *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 maximum number of models to return in the response.
- * @public - */ - MaxResults?: number; -} - -/** - *A summary of the model metadata.
- * @public - */ -export interface ModelMetadataSummary { - /** - *The machine learning domain of the model.
- * @public - */ - Domain: string | undefined; - - /** - *The machine learning framework of the model.
- * @public - */ - Framework: string | undefined; - - /** - *The machine learning task of the model.
- * @public - */ - Task: string | undefined; - - /** - *The name of the model.
- * @public - */ - Model: string | undefined; - - /** - *The framework version of the model.
- * @public - */ - FrameworkVersion: string | undefined; -} - -/** - * @public - */ -export interface ListModelMetadataResponse { - /** - *A structure that holds model metadata.
- * @public - */ - ModelMetadataSummaries: ModelMetadataSummary[] | undefined; - - /** - *A token for getting the next set of recommendations, if there are any.
- * @public - */ - NextToken?: string; -} + */ +export type ModelCardExportJobSortBy = (typeof ModelCardExportJobSortBy)[keyof typeof ModelCardExportJobSortBy]; /** * @public * @enum */ -export const ModelPackageGroupSortBy = { - CREATION_TIME: "CreationTime", - NAME: "Name", +export const ModelCardExportJobSortOrder = { + ASCENDING: "Ascending", + DESCENDING: "Descending", } as const; /** * @public */ -export type ModelPackageGroupSortBy = (typeof ModelPackageGroupSortBy)[keyof typeof ModelPackageGroupSortBy]; +export type ModelCardExportJobSortOrder = + (typeof ModelCardExportJobSortOrder)[keyof typeof ModelCardExportJobSortOrder]; /** * @public */ -export interface ListModelPackageGroupsInput { +export interface ListModelCardExportJobsRequest { /** - *A filter that returns only model groups created after the specified time.
+ *List export jobs for the model card with the specified name.
+ * @public + */ + ModelCardName: string | undefined; + + /** + *List export jobs for the model card with the specified version.
+ * @public + */ + ModelCardVersion?: number; + + /** + *Only list model card export jobs that were created after the time specified.
* @public */ CreationTimeAfter?: Date; /** - *A filter that returns only model groups created before the specified time.
+ *Only list model card export jobs that were created before the time specified.
* @public */ CreationTimeBefore?: Date; /** - *The maximum number of results to return in the response.
+ *Only list model card export jobs with names that contain the specified string.
* @public */ - MaxResults?: number; + ModelCardExportJobNameContains?: string; /** - *A string in the model group name. This filter returns only model groups whose name - * contains the specified string.
+ *Only list model card export jobs with the specified status.
* @public */ - NameContains?: string; + StatusEquals?: ModelCardExportJobStatus; /** - *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.
Sort model card export jobs by either name or creation time. Sorts by creation time by default.
* @public */ - NextToken?: string; + SortBy?: ModelCardExportJobSortBy; /** - *The field to sort results by. The default is CreationTime.
Sort model card export jobs by ascending or descending order.
* @public */ - SortBy?: ModelPackageGroupSortBy; + SortOrder?: ModelCardExportJobSortOrder; /** - *The sort order for results. The default is Ascending.
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 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 model card export jobs to list.
* @public */ - CrossAccountFilterOption?: CrossAccountFilterOption; + MaxResults?: number; } /** - *Summary information about a model group.
+ *The summary of the Amazon SageMaker Model Card export job.
* @public */ -export interface ModelPackageGroupSummary { +export interface ModelCardExportJobSummary { /** - *The name of the model group.
+ *The name of the model card export job.
* @public */ - ModelPackageGroupName: string | undefined; + ModelCardExportJobName: string | undefined; /** - *The Amazon Resource Name (ARN) of the model group.
+ *The Amazon Resource Name (ARN) of the model card export job.
* @public */ - ModelPackageGroupArn: string | undefined; + ModelCardExportJobArn: string | undefined; /** - *A description of the model group.
+ *The completion status of the model card export job.
* @public */ - ModelPackageGroupDescription?: string; + Status: ModelCardExportJobStatus | undefined; /** - *The time that the model group was created.
+ *The name of the model card that the export job exports.
* @public */ - CreationTime: Date | undefined; + ModelCardName: string | undefined; /** - *The status of the model group.
+ *The version of the model card that the export job exports.
* @public */ - ModelPackageGroupStatus: ModelPackageGroupStatus | undefined; + 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 ListModelPackageGroupsOutput { +export interface ListModelCardExportJobsResponse { /** - *A list of summaries of the model groups in your Amazon Web Services account.
+ *The summaries of the listed model card export jobs.
* @public */ - ModelPackageGroupSummaryList: ModelPackageGroupSummary[] | undefined; + ModelCardExportJobSummaries: ModelCardExportJobSummary[] | undefined; /** - *If the response is truncated, SageMaker returns this token. To retrieve the next set - * of model groups, use it in the subsequent request.
+ *If the response is truncated, SageMaker returns this token. To retrieve the next set of model + * card export jobs, use it in the subsequent request.
* @public */ NextToken?: string; @@ -10093,391 +9960,376 @@ export interface ListModelPackageGroupsOutput { * @public * @enum */ -export const ModelPackageType = { - BOTH: "Both", - UNVERSIONED: "Unversioned", - VERSIONED: "Versioned", +export const ModelCardSortBy = { + CREATION_TIME: "CreationTime", + NAME: "Name", } as const; /** * @public */ -export type ModelPackageType = (typeof ModelPackageType)[keyof typeof ModelPackageType]; +export type ModelCardSortBy = (typeof ModelCardSortBy)[keyof typeof ModelCardSortBy]; /** * @public * @enum */ -export const ModelPackageSortBy = { - CREATION_TIME: "CreationTime", - NAME: "Name", +export const ModelCardSortOrder = { + ASCENDING: "Ascending", + DESCENDING: "Descending", } as const; /** * @public */ -export type ModelPackageSortBy = (typeof ModelPackageSortBy)[keyof typeof ModelPackageSortBy]; +export type ModelCardSortOrder = (typeof ModelCardSortOrder)[keyof typeof ModelCardSortOrder]; /** * @public */ -export interface ListModelPackagesInput { +export interface ListModelCardsRequest { /** - *A filter that returns only model packages created after the specified time - * (timestamp).
+ *Only list model cards that were created after the time specified.
* @public */ CreationTimeAfter?: Date; /** - *A filter that returns only model packages created before the specified time - * (timestamp).
+ *Only list model cards that were created before the time specified.
* @public */ CreationTimeBefore?: Date; /** - *The maximum number of model packages to return in the response.
+ *The maximum number of model cards to list.
* @public */ MaxResults?: number; /** - *A string in the model package name. This filter returns only model packages whose name - * contains the specified string.
+ *Only list model cards with names that contain the specified string.
* @public */ NameContains?: string; /** - *A filter that returns only the model packages with the specified approval - * status.
+ *Only list model cards with the specified approval status.
* @public */ - ModelApprovalStatus?: ModelApprovalStatus; + ModelCardStatus?: ModelCardStatus; /** - *A filter that returns only model versions that belong to the specified model group.
+ *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.
A filter that returns only the model packages of the specified type. This can be one - * of the following values.
+ *Sort model cards by either name or creation time. Sorts by creation time by default.
+ * @public + */ + SortBy?: ModelCardSortBy; + + /** + *Sort model cards by ascending or descending order.
+ * @public + */ + SortOrder?: ModelCardSortOrder; +} + +/** + *A summary of the model card.
+ * @public + */ +export interface ModelCardSummary { + /** + *The name of the model card.
+ * @public + */ + ModelCardName: string | undefined; + + /** + *The Amazon Resource Name (ARN) of the model card.
+ * @public + */ + ModelCardArn: string | undefined; + + /** + *The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.
*
- * UNVERSIONED - List only unversioined models.
- * This is the default value if no ModelPackageType is specified.
Draft: The model card is a work in progress.
*
- * VERSIONED - List only versioned models.
PendingReview: The model card is pending review.
*
- * BOTH - List both versioned and unversioned models.
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.
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 parameter by which to sort the results. The default is
- * CreationTime.
The date and time that the model card was created.
* @public */ - SortBy?: ModelPackageSortBy; + CreationTime: Date | undefined; /** - *The sort order for the results. The default is Ascending.
The date and time that the model card was last modified.
* @public */ - SortOrder?: SortOrder; + LastModifiedTime?: Date; } /** - *Provides summary information about a model package.
* @public */ -export interface ModelPackageSummary { +export interface ListModelCardsResponse { /** - *The name of the model package.
+ *The summaries of the listed model cards.
* @public */ - ModelPackageName?: string; + ModelCardSummaries: ModelCardSummary[] | undefined; /** - *If the model package is a versioned model, the model group that the versioned model - * belongs to.
+ *If the response is truncated, SageMaker returns this token. To retrieve the next set of model + * cards, use it in the subsequent request.
* @public */ - ModelPackageGroupName?: string; + NextToken?: string; +} - /** - *If the model package is a versioned model, the version of the model.
- * @public - */ - ModelPackageVersion?: number; +/** + * @public + * @enum + */ +export const ModelCardVersionSortBy = { + VERSION: "Version", +} as const; - /** - *The Amazon Resource Name (ARN) of the model package.
- * @public - */ - ModelPackageArn: string | undefined; +/** + * @public + */ +export type ModelCardVersionSortBy = (typeof ModelCardVersionSortBy)[keyof typeof ModelCardVersionSortBy]; +/** + * @public + */ +export interface ListModelCardVersionsRequest { /** - *A brief description of the model package.
+ *Only list model card versions that were created after the time specified.
* @public */ - ModelPackageDescription?: string; + CreationTimeAfter?: Date; /** - *A timestamp that shows when the model package was created.
+ *Only list model card versions that were created before the time specified.
* @public */ - CreationTime: Date | undefined; + CreationTimeBefore?: Date; /** - *The overall status of the model package.
+ *The maximum number of model card versions to list.
* @public */ - ModelPackageStatus: ModelPackageStatus | undefined; + MaxResults?: number; /** - *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.
List model card versions for the model card with the specified name or Amazon Resource Name (ARN).
* @public */ - ModelApprovalStatus?: ModelApprovalStatus; -} + ModelCardName: string | undefined; -/** - * @public - */ -export interface ListModelPackagesOutput { /** - *An array of ModelPackageSummary objects, each of which lists a model
- * package.
Only list model card versions with the specified approval status.
* @public */ - ModelPackageSummaryList: ModelPackageSummary[] | undefined; + ModelCardStatus?: ModelCardStatus; /** - *If the response is truncated, SageMaker returns this token. To retrieve the next set of - * model packages, use it in the subsequent 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.
A filter that returns only model quality monitoring job definitions that are associated - * with the specified endpoint.
+ *Sort listed model card versions by version. Sorts by version by default.
* @public */ - EndpointName?: string; + SortBy?: ModelCardVersionSortBy; /** - *The field to sort results by. The default is CreationTime.
Sort model card versions by ascending or descending order.
* @public */ - SortBy?: MonitoringJobDefinitionSortKey; + SortOrder?: ModelCardSortOrder; +} +/** + *A summary of a specific version of the model card.
+ * @public + */ +export interface ModelCardVersionSummary { /** - *Whether to sort the results in Ascending or Descending order.
- * The default is Descending.
The name of the model card.
* @public */ - SortOrder?: SortOrder; + ModelCardName: 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.
The Amazon Resource Name (ARN) of the model card.
* @public */ - NextToken?: string; + ModelCardArn: string | undefined; /** - *The maximum number of results to return in a call to
- * ListModelQualityJobDefinitions.
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.
A string in the transform job name. This filter returns only model quality monitoring - * job definitions whose name contains the specified string.
+ *A version of the model card.
* @public */ - NameContains?: string; + ModelCardVersion: number | undefined; /** - *A filter that returns only model quality monitoring job definitions created before the - * specified time.
+ *The date and time that the model card version was created.
* @public */ - CreationTimeBefore?: Date; + CreationTime: Date | undefined; /** - *A filter that returns only model quality monitoring job definitions created after the - * specified time.
+ *The time date and time that the model card version was last modified.
* @public */ - CreationTimeAfter?: Date; + LastModifiedTime?: Date; } /** * @public */ -export interface ListModelQualityJobDefinitionsResponse { +export interface ListModelCardVersionsResponse { /** - *A list of summaries of model quality monitoring job definitions.
+ *The summaries of the listed versions of the model card.
* @public */ - JobDefinitionSummaries: MonitoringJobDefinitionSummary[] | undefined; + ModelCardVersionSummaryList: ModelCardVersionSummary[] | 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.
+ *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; } -/** - * @public - * @enum - */ -export const ModelSortKey = { - CreationTime: "CreationTime", - Name: "Name", -} as const; - /** * @public */ -export type ModelSortKey = (typeof ModelSortKey)[keyof typeof ModelSortKey]; +export interface ListModelExplainabilityJobDefinitionsRequest { + /** + *Name of the endpoint to monitor for model explainability.
+ * @public + */ + EndpointName?: string; -/** - * @public - */ -export interface ListModelsInput { /** - *Sorts the list of results. The default is CreationTime.
Whether to sort results by the Name or CreationTime field.
+ * The default is CreationTime.
The sort order for results. The default is Descending.
Whether to sort the results in Ascending or Descending order.
+ * 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.
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; /** - *The maximum number of models to return in the response.
+ *The maximum number of jobs to return in the response. The default value is 10.
* @public */ MaxResults?: number; /** - *A string in the model name. This filter returns only models whose name contains the - * specified string.
+ *Filter for model explainability jobs whose name contains a specified string.
* @public */ NameContains?: string; /** - *A filter that returns only models created before the specified time - * (timestamp).
+ *A filter that returns only model explainability jobs created before a specified + * time.
* @public */ CreationTimeBefore?: Date; /** - *A filter that returns only models with a creation time greater than or equal to the - * specified time (timestamp).
+ *A filter that returns only model explainability jobs created after a specified + * time.
* @public */ CreationTimeAfter?: Date; } -/** - *Provides summary information about a model.
- * @public - */ -export interface ModelSummary { - /** - *The name of the model that you want a summary for.
- * @public - */ - 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 ListModelsOutput { +export interface ListModelExplainabilityJobDefinitionsResponse { /** - *An array of ModelSummary objects, each of which lists a
- * model.
A JSON array in which each element is a summary for a explainability bias jobs.
* @public */ - Models: ModelSummary[] | undefined; + JobDefinitionSummaries: MonitoringJobDefinitionSummary[] | 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 returned if the response is truncated. To retrieve the next set of job executions, use + * it in the next request.
* @public */ NextToken?: string; @@ -10487,138 +10339,127 @@ export interface ListModelsOutput { * @public * @enum */ -export const MonitoringAlertHistorySortKey = { - CreationTime: "CreationTime", - Status: "Status", -} as const; - -/** - * @public - */ -export type MonitoringAlertHistorySortKey = - (typeof MonitoringAlertHistorySortKey)[keyof typeof MonitoringAlertHistorySortKey]; - -/** - * @public - * @enum - */ -export const MonitoringAlertStatus = { - IN_ALERT: "InAlert", - OK: "OK", +export const ModelMetadataFilterType = { + DOMAIN: "Domain", + FRAMEWORK: "Framework", + FRAMEWORKVERSION: "FrameworkVersion", + TASK: "Task", } as const; /** * @public */ -export type MonitoringAlertStatus = (typeof MonitoringAlertStatus)[keyof typeof MonitoringAlertStatus]; +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 ListMonitoringAlertHistoryRequest { - /** - *The name of a monitoring schedule.
- * @public - */ - MonitoringScheduleName?: string; - - /** - *The name of a monitoring alert.
- * @public - */ - MonitoringAlertName?: string; - - /** - *The field used to sort results. The default is CreationTime.
The sort order, whether Ascending or Descending, of the alert
- * history. The default is Descending.
The name of the of the model to filter by.
* @public */ - SortOrder?: SortOrder; + Name: ModelMetadataFilterType | 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.
The value to filter the model metadata.
* @public */ - NextToken?: string; + Value: string | undefined; +} +/** + *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 { /** - *The maximum number of results to display. The default is 100.
+ *A list of filter objects.
* @public */ - MaxResults?: number; + Filters?: ModelMetadataFilter[]; +} +/** + * @public + */ +export interface ListModelMetadataRequest { /** - *A filter that returns only alerts created on or before the specified time.
+ *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 */ - CreationTimeBefore?: Date; + SearchExpression?: ModelMetadataSearchExpression; /** - *A filter that returns only alerts created on or after the specified time.
+ *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.
A filter that retrieves only alerts with a specific status.
+ *The maximum number of models to return in the response.
* @public */ - StatusEquals?: MonitoringAlertStatus; + MaxResults?: number; } /** - *Provides summary information of an alert's history.
+ *A summary of the model metadata.
* @public */ -export interface MonitoringAlertHistorySummary { +export interface ModelMetadataSummary { /** - *The name of a monitoring schedule.
+ *The machine learning domain of the model.
* @public */ - MonitoringScheduleName: string | undefined; + Domain: string | undefined; /** - *The name of a monitoring alert.
+ *The machine learning framework of the model.
* @public */ - MonitoringAlertName: string | undefined; + Framework: 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.
The machine learning task of the model.
* @public */ - CreationTime: Date | undefined; + Task: string | undefined; /** - *The current alert status of an alert.
+ *The name of the model.
* @public */ - AlertStatus: MonitoringAlertStatus | undefined; + Model: string | undefined; + + /** + *The framework version of the model.
+ * @public + */ + FrameworkVersion: string | undefined; } /** * @public */ -export interface ListMonitoringAlertHistoryResponse { +export interface ListModelMetadataResponse { /** - *An alert history for a model monitoring schedule.
+ *A structure that holds model metadata.
* @public */ - MonitoringAlertHistory?: MonitoringAlertHistorySummary[]; + ModelMetadataSummaries: ModelMetadataSummary[] | 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 for getting the next set of recommendations, if there are any.
* @public */ NextToken?: string; @@ -10626,120 +10467,127 @@ export interface ListMonitoringAlertHistoryResponse { /** * @public + * @enum */ -export interface ListMonitoringAlertsRequest { +export const ModelPackageGroupSortBy = { + CREATION_TIME: "CreationTime", + NAME: "Name", +} as const; + +/** + * @public + */ +export type ModelPackageGroupSortBy = (typeof ModelPackageGroupSortBy)[keyof typeof ModelPackageGroupSortBy]; + +/** + * @public + */ +export interface ListModelPackageGroupsInput { /** - *The name of a monitoring schedule.
+ *A filter that returns only model groups created after the specified time.
* @public */ - MonitoringScheduleName: string | undefined; + CreationTimeAfter?: Date; /** - *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 returns only model groups created before the specified time.
* @public */ - NextToken?: string; + CreationTimeBefore?: Date; /** - *The maximum number of results to display. The default is 100.
+ *The maximum number of results to return in the response.
* @public */ MaxResults?: number; -} -/** - *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 string in the model group name. This filter returns only model groups whose name + * contains the specified string.
* @public */ - Enabled?: boolean; -} + NameContains?: string; -/** - *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.
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.
Provides summary information about a monitor alert.
- * @public - */ -export interface MonitoringAlertSummary { /** - *The name of a monitoring alert.
+ *The field to sort results by. The default is CreationTime.
A timestamp that indicates when a monitor alert was created.
+ *The sort order for results. The default is Ascending.
A timestamp that indicates when a monitor alert was last updated.
+ *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.
Summary information about a model group.
+ * @public + */ +export interface ModelPackageGroupSummary { + /** + *The name of the model group.
+ * @public + */ + ModelPackageGroupName: string | undefined; /** - *The current status of an alert.
+ *The Amazon Resource Name (ARN) of the model group.
* @public */ - AlertStatus: MonitoringAlertStatus | undefined; + ModelPackageGroupArn: string | undefined; /** - *Within EvaluationPeriod, how many execution failures will raise an
- * alert.
A description of the model group.
* @public */ - DatapointsToAlert: number | undefined; + ModelPackageGroupDescription?: string; /** - *The number of most recent monitoring executions to consider when evaluating alert - * status.
+ *The time that the model group was created.
* @public */ - EvaluationPeriod: number | undefined; + CreationTime: Date | undefined; /** - *A list of alert actions taken in response to an alert going into
- * InAlert status.
The status of the model group.
* @public */ - Actions: MonitoringAlertActions | undefined; + ModelPackageGroupStatus: ModelPackageGroupStatus | undefined; } /** * @public */ -export interface ListMonitoringAlertsResponse { +export interface ListModelPackageGroupsOutput { /** - *A JSON array where each element is a summary for a monitoring alert.
+ *A list of summaries of the model groups in your Amazon Web Services account.
* @public */ - MonitoringAlertSummaries?: MonitoringAlertSummary[]; + ModelPackageGroupSummaryList: ModelPackageGroupSummary[] | undefined; /** - *If the response is truncated, SageMaker returns this token. To retrieve the next set of - * alerts, use it in the subsequent request.
+ *If the response is truncated, SageMaker returns this token. To retrieve the next set + * of model groups, use it in the subsequent request.
* @public */ NextToken?: string; @@ -10749,166 +10597,224 @@ export interface ListMonitoringAlertsResponse { * @public * @enum */ -export const MonitoringExecutionSortKey = { +export const ModelPackageType = { + BOTH: "Both", + UNVERSIONED: "Unversioned", + VERSIONED: "Versioned", +} as const; + +/** + * @public + */ +export type ModelPackageType = (typeof ModelPackageType)[keyof typeof ModelPackageType]; + +/** + * @public + * @enum + */ +export const ModelPackageSortBy = { CREATION_TIME: "CreationTime", - SCHEDULED_TIME: "ScheduledTime", - STATUS: "Status", + NAME: "Name", } as const; /** * @public */ -export type MonitoringExecutionSortKey = (typeof MonitoringExecutionSortKey)[keyof typeof MonitoringExecutionSortKey]; +export type ModelPackageSortBy = (typeof ModelPackageSortBy)[keyof typeof ModelPackageSortBy]; /** * @public */ -export interface ListMonitoringExecutionsRequest { +export interface ListModelPackagesInput { /** - *Name of a specific schedule to fetch jobs for.
+ *A filter that returns only model packages created after the specified time + * (timestamp).
* @public */ - MonitoringScheduleName?: string; + CreationTimeAfter?: Date; + + /** + *A filter that returns only model packages created before the specified time + * (timestamp).
+ * @public + */ + CreationTimeBefore?: Date; /** - *Name of a specific endpoint to fetch jobs for.
+ *The maximum number of model packages to return in the response.
* @public */ - EndpointName?: string; + MaxResults?: number; /** - *Whether to sort the results by the Status, CreationTime, or
- * ScheduledTime field. The default is CreationTime.
A string in the model package name. This filter returns only model packages whose name + * contains the specified string.
* @public */ - SortBy?: MonitoringExecutionSortKey; + NameContains?: string; /** - *Whether to sort the results in Ascending or Descending order.
- * The default is Descending.
A filter that returns only the model packages with the specified approval + * status.
* @public */ - SortOrder?: SortOrder; + ModelApprovalStatus?: ModelApprovalStatus; /** - *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 model versions that belong to the specified model group.
+ * @public + */ + ModelPackageGroupName?: string; + + /** + *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.
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 maximum number of jobs to return in the response. The default value is 10.
+ *The parameter by which to sort the results. The default is
+ * CreationTime.
Filter for jobs scheduled before a specified time.
+ *The sort order for the results. The default is Ascending.
Provides summary information about a model package.
+ * @public + */ +export interface ModelPackageSummary { /** - *Filter for jobs scheduled after a specified time.
+ *The name of the model package.
* @public */ - ScheduledTimeAfter?: Date; + ModelPackageName?: string; /** - *A filter that returns only jobs created before a specified time.
+ *If the model package is a versioned model, the model group that the versioned model + * belongs to.
* @public */ - CreationTimeBefore?: Date; + ModelPackageGroupName?: string; /** - *A filter that returns only jobs created after a specified time.
+ *If the model package is a versioned model, the version of the model.
* @public */ - CreationTimeAfter?: Date; + ModelPackageVersion?: number; /** - *A filter that returns only jobs modified after a specified time.
+ *The Amazon Resource Name (ARN) of the model package.
* @public */ - LastModifiedTimeBefore?: Date; + ModelPackageArn: string | undefined; /** - *A filter that returns only jobs modified before a specified time.
+ *A brief description of the model package.
* @public */ - LastModifiedTimeAfter?: Date; + ModelPackageDescription?: string; /** - *A filter that retrieves only jobs with a specific status.
+ *A timestamp that shows when the model package was created.
* @public */ - StatusEquals?: ExecutionStatus; + CreationTime: Date | undefined; /** - *Gets a list of the monitoring job runs of the specified monitoring job - * definitions.
+ *The overall status of the model package.
* @public */ - MonitoringJobDefinitionName?: string; + ModelPackageStatus: ModelPackageStatus | undefined; /** - *A filter that returns only the monitoring job runs of the specified monitoring - * type.
+ *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.
A JSON array in which each element is a summary for a monitoring execution.
+ *An array of ModelPackageSummary objects, each of which lists a model
+ * package.
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 + * model packages, use it in the subsequent request.
* @public */ NextToken?: string; } -/** - * @public - * @enum - */ -export const MonitoringScheduleSortKey = { - CREATION_TIME: "CreationTime", - NAME: "Name", - STATUS: "Status", -} as const; - -/** - * @public - */ -export type MonitoringScheduleSortKey = (typeof MonitoringScheduleSortKey)[keyof typeof MonitoringScheduleSortKey]; - /** * @public */ -export interface ListMonitoringSchedulesRequest { +export interface ListModelQualityJobDefinitionsRequest { /** - *Name of a specific endpoint to fetch schedules for.
+ *A filter that returns only model quality monitoring job definitions that are associated + * with the specified endpoint.
* @public */ EndpointName?: string; /** - *Whether to sort the results by the Status, CreationTime, or
- * ScheduledTime field. The default is CreationTime.
The field to sort results by. The default is CreationTime.
Whether to sort the results in Ascending or Descending order.
@@ -10918,136 +10824,164 @@ export interface ListMonitoringSchedulesRequest {
SortOrder?: SortOrder;
/**
- *
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 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.
The maximum number of jobs to return in the response. The default value is 10.
+ *The maximum number of results to return in a call to
+ * ListModelQualityJobDefinitions.
Filter for monitoring schedules whose name contains a specified string.
+ *A string in the transform job name. This filter returns only model quality monitoring + * job definitions whose name contains the specified string.
* @public */ NameContains?: string; /** - *A filter that returns only monitoring schedules created before a specified time.
+ *A filter that returns only model quality monitoring job definitions created before the + * specified time.
* @public */ CreationTimeBefore?: Date; /** - *A filter that returns only monitoring schedules created after a specified time.
+ *A filter that returns only model quality monitoring job definitions created after the + * specified time.
* @public */ CreationTimeAfter?: Date; +} +/** + * @public + */ +export interface ListModelQualityJobDefinitionsResponse { /** - *A filter that returns only monitoring schedules modified before a specified time.
+ *A list of summaries of model quality monitoring job definitions.
* @public */ - LastModifiedTimeBefore?: Date; + JobDefinitionSummaries: MonitoringJobDefinitionSummary[] | undefined; /** - *A filter that returns only monitoring schedules modified after a specified time.
+ *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 */ - LastModifiedTimeAfter?: Date; + NextToken?: string; +} - /** - *A filter that returns only monitoring schedules modified before a specified time.
- * @public - */ - StatusEquals?: ScheduleStatus; +/** + * @public + * @enum + */ +export const ModelSortKey = { + CreationTime: "CreationTime", + Name: "Name", +} as const; + +/** + * @public + */ +export type ModelSortKey = (typeof ModelSortKey)[keyof typeof ModelSortKey]; +/** + * @public + */ +export interface ListModelsInput { /** - *Gets a list of the monitoring schedules for the specified monitoring job - * definition.
+ *Sorts the list of results. The default is CreationTime.
A filter that returns only the monitoring schedules for the specified monitoring - * type.
+ *The sort order for results. The default is Descending.
Summarizes the monitoring schedule.
- * @public - */ -export interface MonitoringScheduleSummary { /** - *The name of the monitoring schedule.
+ *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 Amazon Resource Name (ARN) of the monitoring schedule.
+ *The maximum number of models to return in the response.
* @public */ - MonitoringScheduleArn: string | undefined; + MaxResults?: number; /** - *The creation time of the monitoring schedule.
+ *A string in the model name. This filter returns only models whose name contains the + * specified string.
* @public */ - CreationTime: Date | undefined; + NameContains?: string; /** - *The last time the monitoring schedule was modified.
+ *A filter that returns only models created before the specified time + * (timestamp).
* @public */ - LastModifiedTime: Date | undefined; + CreationTimeBefore?: Date; /** - *The status of the monitoring schedule.
+ *A filter that returns only models with a creation time greater than or equal to the + * specified time (timestamp).
* @public */ - MonitoringScheduleStatus: ScheduleStatus | undefined; + CreationTimeAfter?: Date; +} +/** + *Provides summary information about a model.
+ * @public + */ +export interface ModelSummary { /** - *The name of the endpoint using the monitoring schedule.
+ *The name of the model that you want a summary for.
* @public */ - EndpointName?: string; + ModelName: string | undefined; /** - *The name of the monitoring job definition that the schedule is for.
+ *The Amazon Resource Name (ARN) of the model.
* @public */ - MonitoringJobDefinitionName?: string; + ModelArn: string | undefined; /** - *The type of the monitoring job definition that the schedule is for.
+ *A timestamp that indicates when the model was created.
* @public */ - MonitoringType?: MonitoringType; + CreationTime: Date | undefined; } /** * @public */ -export interface ListMonitoringSchedulesResponse { +export interface ListModelsOutput { /** - *A JSON array in which each element is a summary for a monitoring schedule.
+ *An array of ModelSummary objects, each of which lists a
+ * model.
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 + * models, use it in the subsequent request.
* @public */ NextToken?: string; @@ -11057,159 +10991,164 @@ export interface ListMonitoringSchedulesResponse { * @public * @enum */ -export const NotebookInstanceLifecycleConfigSortKey = { - CREATION_TIME: "CreationTime", - LAST_MODIFIED_TIME: "LastModifiedTime", - NAME: "Name", +export const MonitoringAlertHistorySortKey = { + CreationTime: "CreationTime", + Status: "Status", } as const; /** * @public */ -export type NotebookInstanceLifecycleConfigSortKey = - (typeof NotebookInstanceLifecycleConfigSortKey)[keyof typeof NotebookInstanceLifecycleConfigSortKey]; +export type MonitoringAlertHistorySortKey = + (typeof MonitoringAlertHistorySortKey)[keyof typeof MonitoringAlertHistorySortKey]; /** * @public * @enum */ -export const NotebookInstanceLifecycleConfigSortOrder = { - ASCENDING: "Ascending", - DESCENDING: "Descending", +export const MonitoringAlertStatus = { + IN_ALERT: "InAlert", + OK: "OK", } as const; /** * @public */ -export type NotebookInstanceLifecycleConfigSortOrder = - (typeof NotebookInstanceLifecycleConfigSortOrder)[keyof typeof NotebookInstanceLifecycleConfigSortOrder]; +export type MonitoringAlertStatus = (typeof MonitoringAlertStatus)[keyof typeof MonitoringAlertStatus]; /** * @public */ -export interface ListNotebookInstanceLifecycleConfigsInput { +export interface ListMonitoringAlertHistoryRequest { /** - *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 name of a monitoring schedule.
* @public */ - NextToken?: string; + MonitoringScheduleName?: string; /** - *The maximum number of lifecycle configurations to return in the response.
+ *The name of a monitoring alert.
* @public */ - MaxResults?: number; + MonitoringAlertName?: string; /** - *Sorts the list of results. The default is CreationTime.
The field used to sort results. The default is CreationTime.
The sort order for results.
+ *The sort order, whether Ascending or Descending, of the alert
+ * history. The default is Descending.
A string in the lifecycle configuration name. This filter returns only lifecycle - * configurations whose name contains the specified string.
+ *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.
A filter that returns only lifecycle configurations that were created before the - * specified time (timestamp).
+ *The maximum number of results to display. The default is 100.
* @public */ - CreationTimeBefore?: Date; + MaxResults?: number; /** - *A filter that returns only lifecycle configurations that were created after the - * specified time (timestamp).
+ *A filter that returns only alerts created on or before the specified time.
* @public */ - CreationTimeAfter?: Date; + CreationTimeBefore?: Date; /** - *A filter that returns only lifecycle configurations that were modified before the - * specified time (timestamp).
+ *A filter that returns only alerts created on or after the specified time.
* @public */ - LastModifiedTimeBefore?: Date; + CreationTimeAfter?: Date; /** - *A filter that returns only lifecycle configurations that were modified after the - * specified time (timestamp).
+ *A filter that retrieves only alerts with a specific status.
* @public */ - LastModifiedTimeAfter?: Date; + StatusEquals?: MonitoringAlertStatus; } /** - *Provides a summary of a notebook instance lifecycle configuration.
+ *Provides summary information of an alert's history.
* @public */ -export interface NotebookInstanceLifecycleConfigSummary { +export interface MonitoringAlertHistorySummary { /** - *The name of the lifecycle configuration.
+ *The name of a monitoring schedule.
* @public */ - NotebookInstanceLifecycleConfigName: string | undefined; + MonitoringScheduleName: string | undefined; /** - *The Amazon Resource Name (ARN) of the lifecycle configuration.
+ *The name of a monitoring alert.
* @public */ - NotebookInstanceLifecycleConfigArn: string | undefined; + MonitoringAlertName: string | undefined; /** - *A timestamp that tells when the lifecycle configuration 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.
A timestamp that tells when the lifecycle configuration was last modified.
+ *The current alert status of an alert.
* @public */ - LastModifiedTime?: Date; + AlertStatus: MonitoringAlertStatus | undefined; } /** * @public */ -export interface ListNotebookInstanceLifecycleConfigsOutput { +export interface ListMonitoringAlertHistoryResponse { /** - *If the response is truncated, SageMaker returns this token. To get the next set of - * lifecycle configurations, use it in the next request.
+ *An alert history for a model monitoring schedule.
* @public */ - NextToken?: string; + MonitoringAlertHistory?: MonitoringAlertHistorySummary[]; /** - *An array of NotebookInstanceLifecycleConfiguration objects, each listing
- * a lifecycle configuration.
If the response is truncated, SageMaker returns this token. To retrieve the next set of + * alerts, use it in the subsequent request.
* @public */ - NotebookInstanceLifecycleConfigs?: NotebookInstanceLifecycleConfigSummary[]; + NextToken?: string; } /** * @public - * @enum */ -export const NotebookInstanceSortKey = { - CREATION_TIME: "CreationTime", - NAME: "Name", - STATUS: "Status", -} as const; +export interface ListMonitoringAlertsRequest { + /** + *The name of a monitoring schedule.
+ * @public + */ + MonitoringScheduleName: string | undefined; -/** - * @public - */ -export type NotebookInstanceSortKey = (typeof NotebookInstanceSortKey)[keyof typeof NotebookInstanceSortKey]; + /** + *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.
The maximum number of results to display. The default is 100.
+ * @public + */ + MaxResults?: number; +} diff --git a/clients/client-sagemaker/src/models/models_4.ts b/clients/client-sagemaker/src/models/models_4.ts index fd95318adc2a4..e5f33271e1be6 100644 --- a/clients/client-sagemaker/src/models/models_4.ts +++ b/clients/client-sagemaker/src/models/models_4.ts @@ -81,12 +81,10 @@ import { RootAccess, ServiceCatalogProvisioningDetails, ShadowModeConfig, - SharingType, SkipModelValidation, SourceAlgorithmSpecification, - SpaceSettings, - SpaceStorageSettings, ThroughputMode, + TrackingServerSize, TtlDuration, UiTemplate, UserSettings, @@ -101,6 +99,7 @@ import { DebugRuleEvaluationStatus, DeploymentRecommendation, EndpointStatus, + ExecutionStatus, FeatureParameter, HyperParameterTrainingJobSummary, MemberDefinition, @@ -113,14 +112,13 @@ import { NotificationConfiguration, OidcConfig, OidcConfigFilterSensitiveLog, - PipelineExecutionStatus, - PipelineExperimentConfig, - PipelineStatus, ProfilerConfig, ProfilerRuleConfiguration, ScheduleStatus, - SelectiveExecutionConfig, + SharingType, SourceIpConfig, + SpaceSettings, + SpaceStorageSettings, StudioLifecycleConfigAppType, TensorBoardOutputConfig, TrainingJobStatus, @@ -151,13 +149,16 @@ import { LambdaStepMetadata, LineageType, MetricData, - MonitoringAlertSummary, - NotebookInstanceSortKey, + MonitoringAlertStatus, + PipelineExecutionStatus, + PipelineExperimentConfig, + PipelineStatus, ProcessingJobStatus, ProjectStatus, ResourceType, SecondaryStatus, SecondaryStatusTransition, + SelectiveExecutionConfig, ServiceCatalogProvisionedProductDetails, SortBy, SortOrder, @@ -174,6 +175,571 @@ import { Workteam, } from "./models_3"; +/** + *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.
+ * @public + */ + Enabled?: boolean; +} + +/** + *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.
Provides summary information about a monitor alert.
+ * @public + */ +export interface MonitoringAlertSummary { + /** + *The name of a monitoring alert.
+ * @public + */ + MonitoringAlertName: string | undefined; + + /** + *A timestamp that indicates when a monitor alert was created.
+ * @public + */ + CreationTime: Date | undefined; + + /** + *A timestamp that indicates when a monitor alert was last updated.
+ * @public + */ + LastModifiedTime: Date | undefined; + + /** + *The current status of an alert.
+ * @public + */ + AlertStatus: MonitoringAlertStatus | 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; + + /** + *A list of alert actions taken in response to an alert going into
+ * InAlert status.
A JSON array where each element is a summary for a monitoring alert.
+ * @public + */ + MonitoringAlertSummaries?: MonitoringAlertSummary[]; + + /** + *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; +} + +/** + * @public + * @enum + */ +export const MonitoringExecutionSortKey = { + CREATION_TIME: "CreationTime", + SCHEDULED_TIME: "ScheduledTime", + STATUS: "Status", +} as const; + +/** + * @public + */ +export type MonitoringExecutionSortKey = (typeof MonitoringExecutionSortKey)[keyof typeof MonitoringExecutionSortKey]; + +/** + * @public + */ +export interface ListMonitoringExecutionsRequest { + /** + *Name of a specific schedule to fetch jobs for.
+ * @public + */ + MonitoringScheduleName?: string; + + /** + *Name of a specific endpoint to fetch jobs for.
+ * @public + */ + EndpointName?: string; + + /** + *Whether to sort the results by the Status, CreationTime, or
+ * ScheduledTime field. The default is CreationTime.
Whether to sort the results in Ascending or Descending order.
+ * The default is Descending.
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; + + /** + *The maximum number of jobs to return in the response. The default value is 10.
+ * @public + */ + MaxResults?: number; + + /** + *Filter for jobs scheduled before a specified time.
+ * @public + */ + ScheduledTimeBefore?: Date; + + /** + *Filter for jobs scheduled after a specified time.
+ * @public + */ + ScheduledTimeAfter?: Date; + + /** + *A filter that returns only jobs created before a specified time.
+ * @public + */ + CreationTimeBefore?: Date; + + /** + *A filter that returns only jobs created after a specified time.
+ * @public + */ + CreationTimeAfter?: Date; + + /** + *A filter that returns only jobs modified after a specified time.
+ * @public + */ + LastModifiedTimeBefore?: Date; + + /** + *A filter that returns only jobs modified before a specified time.
+ * @public + */ + LastModifiedTimeAfter?: Date; + + /** + *A filter that retrieves only jobs with a specific status.
+ * @public + */ + StatusEquals?: ExecutionStatus; + + /** + *Gets a list of the monitoring job runs of the specified monitoring job + * definitions.
+ * @public + */ + MonitoringJobDefinitionName?: string; + + /** + *A filter that returns only the monitoring job runs of the specified monitoring + * type.
+ * @public + */ + MonitoringTypeEquals?: MonitoringType; +} + +/** + * @public + */ +export interface ListMonitoringExecutionsResponse { + /** + *A JSON array in which each element is a summary for a monitoring execution.
+ * @public + */ + MonitoringExecutionSummaries: MonitoringExecutionSummary[] | undefined; + + /** + *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; +} + +/** + * @public + * @enum + */ +export const MonitoringScheduleSortKey = { + CREATION_TIME: "CreationTime", + NAME: "Name", + STATUS: "Status", +} as const; + +/** + * @public + */ +export type MonitoringScheduleSortKey = (typeof MonitoringScheduleSortKey)[keyof typeof MonitoringScheduleSortKey]; + +/** + * @public + */ +export interface ListMonitoringSchedulesRequest { + /** + *Name of a specific endpoint to fetch schedules for.
+ * @public + */ + EndpointName?: string; + + /** + *Whether to sort the results by the Status, CreationTime, or
+ * ScheduledTime field. The default is CreationTime.
Whether to sort the results in Ascending or Descending order.
+ * The default is Descending.
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; + + /** + *The maximum number of jobs to return in the response. The default value is 10.
+ * @public + */ + MaxResults?: number; + + /** + *Filter for monitoring schedules whose name contains a specified string.
+ * @public + */ + NameContains?: string; + + /** + *A filter that returns only monitoring schedules created before a specified time.
+ * @public + */ + CreationTimeBefore?: Date; + + /** + *A filter that returns only monitoring schedules created after a specified time.
+ * @public + */ + CreationTimeAfter?: Date; + + /** + *A filter that returns only monitoring schedules modified before a specified time.
+ * @public + */ + LastModifiedTimeBefore?: Date; + + /** + *A filter that returns only monitoring schedules modified after a specified time.
+ * @public + */ + LastModifiedTimeAfter?: Date; + + /** + *A filter that returns only monitoring schedules modified before a specified time.
+ * @public + */ + StatusEquals?: ScheduleStatus; + + /** + *Gets a list of the monitoring schedules for the specified monitoring job + * definition.
+ * @public + */ + MonitoringJobDefinitionName?: string; + + /** + *A filter that returns only the monitoring schedules for the specified monitoring + * type.
+ * @public + */ + MonitoringTypeEquals?: MonitoringType; +} + +/** + *Summarizes the monitoring schedule.
+ * @public + */ +export interface MonitoringScheduleSummary { + /** + *The name of the monitoring schedule.
+ * @public + */ + MonitoringScheduleName: string | undefined; + + /** + *The Amazon Resource Name (ARN) of the monitoring schedule.
+ * @public + */ + MonitoringScheduleArn: string | undefined; + + /** + *The creation time of the monitoring schedule.
+ * @public + */ + CreationTime: Date | undefined; + + /** + *The last time the monitoring schedule was modified.
+ * @public + */ + LastModifiedTime: Date | undefined; + + /** + *The status of the monitoring schedule.
+ * @public + */ + MonitoringScheduleStatus: ScheduleStatus | undefined; + + /** + *The name of the endpoint using the monitoring schedule.
+ * @public + */ + EndpointName?: string; + + /** + *The name of the monitoring job definition that the schedule is for.
+ * @public + */ + MonitoringJobDefinitionName?: string; + + /** + *The type of the monitoring job definition that the schedule is for.
+ * @public + */ + MonitoringType?: MonitoringType; +} + +/** + * @public + */ +export interface ListMonitoringSchedulesResponse { + /** + *A JSON array in which each element is a summary for a monitoring schedule.
+ * @public + */ + MonitoringScheduleSummaries: MonitoringScheduleSummary[] | undefined; + + /** + *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; +} + +/** + * @public + * @enum + */ +export const NotebookInstanceLifecycleConfigSortKey = { + CREATION_TIME: "CreationTime", + LAST_MODIFIED_TIME: "LastModifiedTime", + NAME: "Name", +} 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]; + +/** + * @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.
+ * @public + */ + MaxResults?: number; + + /** + *Sorts the list of results. The default is CreationTime.
The sort order for results.
+ * @public + */ + SortOrder?: NotebookInstanceLifecycleConfigSortOrder; + + /** + *A string in the lifecycle configuration name. This filter returns only lifecycle + * configurations whose name contains the specified string.
+ * @public + */ + NameContains?: string; + + /** + *A filter that returns only lifecycle configurations that were created before the + * specified time (timestamp).
+ * @public + */ + CreationTimeBefore?: Date; + + /** + *A filter that returns only lifecycle configurations that were created after the + * specified time (timestamp).
+ * @public + */ + CreationTimeAfter?: Date; + + /** + *A filter that returns only lifecycle configurations that were modified before the + * specified time (timestamp).
+ * @public + */ + LastModifiedTimeBefore?: Date; + + /** + *A filter that returns only lifecycle configurations that were modified after the + * specified time (timestamp).
+ * @public + */ + LastModifiedTimeAfter?: Date; +} + +/** + *Provides a summary of a notebook instance lifecycle configuration.
+ * @public + */ +export interface NotebookInstanceLifecycleConfigSummary { + /** + *The name of the lifecycle configuration.
+ * @public + */ + NotebookInstanceLifecycleConfigName: string | undefined; + + /** + *The Amazon Resource Name (ARN) of the lifecycle configuration.
+ * @public + */ + NotebookInstanceLifecycleConfigArn: string | undefined; + + /** + *A timestamp that tells when the lifecycle configuration was created.
+ * @public + */ + CreationTime?: Date; + + /** + *A timestamp that tells when the lifecycle configuration was last modified.
+ * @public + */ + LastModifiedTime?: Date; +} + +/** + * @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.
+ * @public + */ + NextToken?: string; + + /** + *An array of NotebookInstanceLifecycleConfiguration objects, each listing
+ * a lifecycle configuration.
The name of the tracking server to start.
+ * @public + */ + TrackingServerName: string | undefined; +} + +/** + * @public + */ +export interface StartMlflowTrackingServerResponse { + /** + *The ARN of the started tracking server.
+ * @public + */ + TrackingServerArn?: string; +} + /** * @public */ @@ -6044,6 +6632,28 @@ export interface StopLabelingJobRequest { LabelingJobName: string | undefined; } +/** + * @public + */ +export interface StopMlflowTrackingServerRequest { + /** + *The name of the tracking server to stop.
+ * @public + */ + TrackingServerName: string | undefined; +} + +/** + * @public + */ +export interface StopMlflowTrackingServerResponse { + /** + *The ARN of the stopped tracking server.
+ * @public + */ + TrackingServerArn?: string; +} + /** * @public */ @@ -7152,6 +7762,58 @@ export interface UpdateInferenceExperimentResponse { 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; + + /** + *The new size for the MLflow Tracking Server.
+ * @public + */ + TrackingServerSize?: TrackingServerSize; + + /** + *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; +} + +/** + * @public + */ +export interface UpdateMlflowTrackingServerResponse { + /** + *The ARN of the updated MLflow Tracking Server.
+ * @public + */ + TrackingServerArn?: string; +} + /** * @public */ diff --git a/clients/client-sagemaker/src/pagination/ListMlflowTrackingServersPaginator.ts b/clients/client-sagemaker/src/pagination/ListMlflowTrackingServersPaginator.ts new file mode 100644 index 0000000000000..a5835e8001dcc --- /dev/null +++ b/clients/client-sagemaker/src/pagination/ListMlflowTrackingServersPaginator.ts @@ -0,0 +1,24 @@ +// smithy-typescript generated code +import { createPaginator } from "@smithy/core"; +import { Paginator } from "@smithy/types"; + +import { + ListMlflowTrackingServersCommand, + ListMlflowTrackingServersCommandInput, + ListMlflowTrackingServersCommandOutput, +} from "../commands/ListMlflowTrackingServersCommand"; +import { SageMakerClient } from "../SageMakerClient"; +import { SageMakerPaginationConfiguration } from "./Interfaces"; + +/** + * @public + */ +export const paginateListMlflowTrackingServers: ( + config: SageMakerPaginationConfiguration, + input: ListMlflowTrackingServersCommandInput, + ...rest: any[] +) => PaginatorThe size in gigabytes (GB) of the additional EBS volume to be attached to the instances\n in the SageMaker HyperPod cluster instance group. The additional EBS volume is attached to each\n instance within the SageMaker HyperPod cluster instance group and mounted to\n /opt/sagemaker.
Defines the configuration for attaching an additional Amazon Elastic Block Store (EBS)\n volume to each instance of the SageMaker HyperPod cluster instance group.
" + } + }, + "com.amazonaws.sagemaker#ClusterEbsVolumeSizeInGB": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 16384 + } + } + }, "com.amazonaws.sagemaker#ClusterInstanceCount": { "type": "integer", "traits": { @@ -6504,13 +6529,13 @@ "CurrentCount": { "target": "com.amazonaws.sagemaker#ClusterNonNegativeInstanceCount", "traits": { - "smithy.api#documentation": "The number of instances that are currently in the instance group of a\n SageMaker HyperPod cluster.
" + "smithy.api#documentation": "The number of instances that are currently in the instance group of a SageMaker HyperPod\n cluster.
" } }, "TargetCount": { "target": "com.amazonaws.sagemaker#ClusterInstanceCount", "traits": { - "smithy.api#documentation": "The number of instances you specified to add to the instance group of a SageMaker HyperPod cluster.
" + "smithy.api#documentation": "The number of instances you specified to add to the instance group of a SageMaker HyperPod\n cluster.
" } }, "InstanceGroupName": { @@ -6540,7 +6565,13 @@ "ThreadsPerCore": { "target": "com.amazonaws.sagemaker#ClusterThreadsPerCore", "traits": { - "smithy.api#documentation": "The number you specified to TreadsPerCore in CreateCluster for\n enabling or disabling multithreading. For instance types that support multithreading, you\n can specify 1 for disabling multithreading and 2 for enabling multithreading. For more\n information, see the reference table of CPU cores and threads per CPU core per instance type in the Amazon Elastic Compute Cloud\n User Guide.
The number you specified to TreadsPerCore in CreateCluster for\n enabling or disabling multithreading. For instance types that support multithreading, you\n can specify 1 for disabling multithreading and 2 for enabling multithreading. For more\n information, see the reference table of CPU cores and\n threads per CPU core per instance type in the Amazon Elastic Compute Cloud User\n Guide.
The additional storage configurations for the instances in the SageMaker HyperPod cluster instance\n group.
" } } }, @@ -6571,7 +6602,7 @@ "target": "com.amazonaws.sagemaker#ClusterInstanceCount", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Specifies the number of instances to add to the instance group of a SageMaker HyperPod cluster.
", + "smithy.api#documentation": "Specifies the number of instances to add to the instance group of a SageMaker HyperPod\n cluster.
", "smithy.api#required": {} } }, @@ -6610,7 +6641,13 @@ "ThreadsPerCore": { "target": "com.amazonaws.sagemaker#ClusterThreadsPerCore", "traits": { - "smithy.api#documentation": "Specifies the value for Threads per core. For instance types that\n support multithreading, you can specify 1 for disabling multithreading and\n 2 for enabling multithreading. For instance types that doesn't support\n multithreading, specify 1. For more information, see the reference table of\n CPU cores and threads per CPU core per instance type in the Amazon Elastic Compute Cloud\n User Guide.
Specifies the value for Threads per core. For instance\n types that support multithreading, you can specify 1 for disabling\n multithreading and 2 for enabling multithreading. For instance types that\n doesn't support multithreading, specify 1. For more information, see the\n reference table of CPU cores and\n threads per CPU core per instance type in the Amazon Elastic Compute Cloud User\n Guide.
Specifies the additional storage configurations for the instances in the SageMaker HyperPod cluster\n instance group.
" } } }, @@ -6707,6 +6744,32 @@ "smithy.api#documentation": "Details of an instance in a SageMaker HyperPod cluster.
" } }, + "com.amazonaws.sagemaker#ClusterInstanceStorageConfig": { + "type": "union", + "members": { + "EbsVolumeConfig": { + "target": "com.amazonaws.sagemaker#ClusterEbsVolumeConfig", + "traits": { + "smithy.api#documentation": "Defines the configuration for attaching additional Amazon Elastic Block Store (EBS)\n volumes to the instances in the SageMaker HyperPod cluster instance group. The additional EBS volume is\n attached to each instance within the SageMaker HyperPod cluster instance group and mounted to\n /opt/sagemaker.
Defines the configuration for attaching additional storage to the instances in the\n SageMaker HyperPod cluster instance group.
" + } + }, + "com.amazonaws.sagemaker#ClusterInstanceStorageConfigs": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ClusterInstanceStorageConfig" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 + } + } + }, "com.amazonaws.sagemaker#ClusterInstanceType": { "type": "enum", "members": { @@ -7039,6 +7102,12 @@ "smithy.api#documentation": "The number of threads per CPU core you specified under\n CreateCluster.
The configurations of additional storage specified to the instance group where the\n instance (node) is launched.
" + } + }, "PrivatePrimaryIp": { "target": "com.amazonaws.sagemaker#ClusterPrivatePrimaryIp", "traits": { @@ -7069,7 +7138,7 @@ "min": 1, "max": 256 }, - "smithy.api#pattern": "^[a-zA-Z][-a-zA-Z0-9]*$" + "smithy.api#pattern": "^i-[a-f0-9]{8}(?:[a-f0-9]{9})?$" } }, "com.amazonaws.sagemaker#ClusterNodeSummaries": { @@ -8993,7 +9062,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a SageMaker HyperPod cluster. SageMaker HyperPod is a capability of SageMaker for creating and managing\n persistent clusters for developing large machine learning models, such as large language\n models (LLMs) and diffusion models. To learn more, see Amazon SageMaker HyperPod in the Amazon SageMaker Developer Guide.
" + "smithy.api#documentation": "Creates a SageMaker HyperPod cluster. SageMaker HyperPod is a capability of SageMaker for creating and managing\n persistent clusters for developing large machine learning models, such as large language\n models (LLMs) and diffusion models. To learn more, see Amazon SageMaker HyperPod in the\n Amazon SageMaker Developer Guide.
" } }, "com.amazonaws.sagemaker#CreateClusterRequest": { @@ -9021,7 +9090,7 @@ "Tags": { "target": "com.amazonaws.sagemaker#TagList", "traits": { - "smithy.api#documentation": "Custom tags for managing the SageMaker HyperPod cluster as an Amazon Web Services resource. You can\n add tags to your cluster in the same way you add them in other Amazon Web Services services\n that support tagging. To learn more about tagging Amazon Web Services resources in general,\n see Tagging Amazon Web Services Resources User Guide.
" + "smithy.api#documentation": "Custom tags for managing the SageMaker HyperPod cluster as an Amazon Web Services resource. You can\n add tags to your cluster in the same way you add them in other Amazon Web Services services\n that support tagging. To learn more about tagging Amazon Web Services resources in general,\n see Tagging\n Amazon Web Services Resources User Guide.
" } } }, @@ -11094,6 +11163,99 @@ "smithy.api#output": {} } }, + "com.amazonaws.sagemaker#CreateMlflowTrackingServer": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateMlflowTrackingServerRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateMlflowTrackingServerResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "Creates an MLflow Tracking Server using a general purpose Amazon S3 bucket as the artifact\n store. For more information, see Create an MLflow Tracking\n Server.
" + } + }, + "com.amazonaws.sagemaker#CreateMlflowTrackingServerRequest": { + "type": "structure", + "members": { + "TrackingServerName": { + "target": "com.amazonaws.sagemaker#TrackingServerName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A unique string identifying the tracking server name. This string is part of the tracking server\n ARN.
", + "smithy.api#required": {} + } + }, + "ArtifactStoreUri": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The S3 URI for a general purpose bucket to use as the MLflow Tracking Server artifact\n store.
", + "smithy.api#required": {} + } + }, + "TrackingServerSize": { + "target": "com.amazonaws.sagemaker#TrackingServerSize", + "traits": { + "smithy.api#documentation": "The size of the tracking server you want to create. You can choose between\n \"Small\", \"Medium\", and \"Large\". The default MLflow\n Tracking Server configuration size is \"Small\". You can choose a size depending on\n the projected use of the tracking server such as the volume of data logged, number of users,\n and frequency of use.
We recommend using a small tracking server for teams of up to 25 users, a medium tracking\n server for teams of up to 50 users, and a large tracking server for teams of up to 100 users.
" + } + }, + "MlflowVersion": { + "target": "com.amazonaws.sagemaker#MlflowVersion", + "traits": { + "smithy.api#documentation": "The version of MLflow that the tracking server uses. To see which MLflow versions are\n available to use, see How it works.
" + } + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) for an IAM role in your account that the MLflow Tracking Server uses to\n access the artifact store in Amazon S3. The role should have AmazonS3FullAccess\n permissions. For more information on IAM permissions for tracking server creation, see\n Set up IAM permissions for MLflow.
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. \n To disable automatic model registration, set this value to False. If not specified, AutomaticModelRegistration defaults to False.
The day and time of the week in Coordinated Universal Time (UTC) 24-hour standard time that weekly maintenance updates are scheduled. For example: TUE:03:30.
" + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "Tags consisting of key-value pairs used to manage metadata for the tracking server.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateMlflowTrackingServerResponse": { + "type": "structure", + "members": { + "TrackingServerArn": { + "target": "com.amazonaws.sagemaker#TrackingServerArn", + "traits": { + "smithy.api#documentation": "The ARN of the tracking server.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.sagemaker#CreateModel": { "type": "operation", "input": { @@ -12361,6 +12523,65 @@ "smithy.api#output": {} } }, + "com.amazonaws.sagemaker#CreatePresignedMlflowTrackingServerUrl": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreatePresignedMlflowTrackingServerUrlRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreatePresignedMlflowTrackingServerUrlResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Returns a presigned URL that you can use to connect to the MLflow UI attached to your\n tracking server. For more information, see Launch the MLflow UI using a presigned URL.
" + } + }, + "com.amazonaws.sagemaker#CreatePresignedMlflowTrackingServerUrlRequest": { + "type": "structure", + "members": { + "TrackingServerName": { + "target": "com.amazonaws.sagemaker#TrackingServerName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the tracking server to connect to your MLflow UI.
", + "smithy.api#required": {} + } + }, + "ExpiresInSeconds": { + "target": "com.amazonaws.sagemaker#ExpiresInSeconds", + "traits": { + "smithy.api#documentation": "The duration in seconds that your presigned URL is valid. The presigned URL can be used\n only once.
" + } + }, + "SessionExpirationDurationInSeconds": { + "target": "com.amazonaws.sagemaker#SessionExpirationDurationInSeconds", + "traits": { + "smithy.api#documentation": "The duration in seconds that your MLflow UI session is valid.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreatePresignedMlflowTrackingServerUrlResponse": { + "type": "structure", + "members": { + "AuthorizedUrl": { + "target": "com.amazonaws.sagemaker#TrackingServerUrl", + "traits": { + "smithy.api#documentation": "A presigned URL with an authorization token.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.sagemaker#CreatePresignedNotebookInstanceUrl": { "type": "operation", "input": { @@ -15528,6 +15749,53 @@ "smithy.api#output": {} } }, + "com.amazonaws.sagemaker#DeleteMlflowTrackingServer": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeleteMlflowTrackingServerRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DeleteMlflowTrackingServerResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Deletes an MLflow Tracking Server. For more information, see Clean up MLflow resources.
" + } + }, + "com.amazonaws.sagemaker#DeleteMlflowTrackingServerRequest": { + "type": "structure", + "members": { + "TrackingServerName": { + "target": "com.amazonaws.sagemaker#TrackingServerName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the the tracking server to delete.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeleteMlflowTrackingServerResponse": { + "type": "structure", + "members": { + "TrackingServerArn": { + "target": "com.amazonaws.sagemaker#TrackingServerArn", + "traits": { + "smithy.api#documentation": "A TrackingServerArn object, the ARN of the tracking server that is deleted if\n successfully found.
Use this operation to delete a workforce.
\nIf you want to create a new workforce in an Amazon Web Services Region where\n a workforce already exists, use this operation to delete the \n existing workforce and then use CreateWorkforce\n to create a new workforce.
\nIf a private workforce contains one or more work teams, you must use \n the DeleteWorkteam\n operation to delete all work teams before you delete the workforce.\n If you try to delete a workforce that contains one or more work teams,\n you will recieve a ResourceInUse error.
Use this operation to delete a workforce.
\nIf you want to create a new workforce in an Amazon Web Services Region where\n a workforce already exists, use this operation to delete the \n existing workforce and then use CreateWorkforce\n to create a new workforce.
\nIf a private workforce contains one or more work teams, you must use \n the DeleteWorkteam\n operation to delete all work teams before you delete the workforce.\n If you try to delete a workforce that contains one or more work teams,\n you will receive a ResourceInUse error.
Returns information about an MLflow Tracking Server.
" + } + }, + "com.amazonaws.sagemaker#DescribeMlflowTrackingServerRequest": { + "type": "structure", + "members": { + "TrackingServerName": { + "target": "com.amazonaws.sagemaker#TrackingServerName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the MLflow Tracking Server to describe.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeMlflowTrackingServerResponse": { + "type": "structure", + "members": { + "TrackingServerArn": { + "target": "com.amazonaws.sagemaker#TrackingServerArn", + "traits": { + "smithy.api#documentation": "The ARN of the described tracking server.
" + } + }, + "TrackingServerName": { + "target": "com.amazonaws.sagemaker#TrackingServerName", + "traits": { + "smithy.api#documentation": "The name of the described tracking server.
" + } + }, + "ArtifactStoreUri": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#documentation": "The S3 URI of the general purpose bucket used as the MLflow Tracking Server\n artifact store.
" + } + }, + "TrackingServerSize": { + "target": "com.amazonaws.sagemaker#TrackingServerSize", + "traits": { + "smithy.api#documentation": "The size of the described tracking server.
" + } + }, + "MlflowVersion": { + "target": "com.amazonaws.sagemaker#MlflowVersion", + "traits": { + "smithy.api#documentation": "The MLflow version used for the described tracking server.
" + } + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) for an IAM role in your account that the described MLflow Tracking Server\n uses to access the artifact store in Amazon S3.
" + } + }, + "TrackingServerStatus": { + "target": "com.amazonaws.sagemaker#TrackingServerStatus", + "traits": { + "smithy.api#documentation": "The current creation status of the described MLflow Tracking Server.
" + } + }, + "IsActive": { + "target": "com.amazonaws.sagemaker#IsTrackingServerActive", + "traits": { + "smithy.api#documentation": "Whether the described MLflow Tracking Server is currently active.
" + } + }, + "TrackingServerUrl": { + "target": "com.amazonaws.sagemaker#TrackingServerUrl", + "traits": { + "smithy.api#documentation": "The URL to connect to the MLflow user interface for the described tracking server.
" + } + }, + "WeeklyMaintenanceWindowStart": { + "target": "com.amazonaws.sagemaker#WeeklyMaintenanceWindowStart", + "traits": { + "smithy.api#documentation": "The day and time of the week when weekly maintenance occurs on the described tracking server.
" + } + }, + "AutomaticModelRegistration": { + "target": "com.amazonaws.sagemaker#Boolean", + "traits": { + "smithy.api#documentation": "Whether automatic registration of new MLflow models to the SageMaker Model Registry is enabled.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp of when the described MLflow Tracking Server was created.
" + } + }, + "CreatedBy": { + "target": "com.amazonaws.sagemaker#UserContext" + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp of when the described MLflow Tracking Server was last modified.
" + } + }, + "LastModifiedBy": { + "target": "com.amazonaws.sagemaker#UserContext" + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.sagemaker#DescribeModel": { "type": "operation", "input": { @@ -24353,7 +24746,7 @@ "target": "com.amazonaws.sagemaker#DescribeWorkteamResponse" }, "traits": { - "smithy.api#documentation": "Gets information about a specific work team. You can see information such as the\n create date, the last updated date, membership information, and the work team's Amazon\n Resource Name (ARN).
" + "smithy.api#documentation": "Gets information about a specific work team. You can see information such as the\n creation date, the last updated date, membership information, and the work team's Amazon\n Resource Name (ARN).
" } }, "com.amazonaws.sagemaker#DescribeWorkteamRequest": { @@ -33902,6 +34295,23 @@ "smithy.api#pattern": "^arn:aws[a-z\\-]*:iam::\\d{12}:rolealias/?[a-zA-Z_0-9+=,.@\\-_/]+$" } }, + "com.amazonaws.sagemaker#IsTrackingServerActive": { + "type": "enum", + "members": { + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Active" + } + }, + "INACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Inactive" + } + } + } + }, "com.amazonaws.sagemaker#ItemIdentifierAttributeName": { "type": "string", "traits": { @@ -35842,14 +36252,14 @@ "target": "com.amazonaws.sagemaker#ClusterNameOrArn", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster in which you want to retrieve the list of nodes.
", + "smithy.api#documentation": "The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster in which you want to retrieve the\n list of nodes.
", "smithy.api#required": {} } }, "CreationTimeAfter": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "A filter that returns nodes in a SageMaker HyperPod cluster created after the specified time. Timestamps are\n formatted according to the ISO 8601 standard.
\nAcceptable formats include:
\n\n YYYY-MM-DDThh:mm:ss.sssTZD (UTC), for example,\n 2014-10-01T20:30:00.000Z\n
\n YYYY-MM-DDThh:mm:ss.sssTZD (with offset), for example,\n 2014-10-01T12:30:00.000-08:00\n
\n YYYY-MM-DD, for example, 2014-10-01\n
Unix time in seconds, for example, 1412195400. This is also referred to as Unix\n Epoch time and represents the number of seconds since midnight, January 1, 1970\n UTC.
For more information about the timestamp format, see Timestamp in the Amazon Web Services Command Line Interface User\n Guide.
" + "smithy.api#documentation": "A filter that returns nodes in a SageMaker HyperPod cluster created after the specified time.\n Timestamps are formatted according to the ISO 8601 standard.
\nAcceptable formats include:
\n\n YYYY-MM-DDThh:mm:ss.sssTZD (UTC), for example,\n 2014-10-01T20:30:00.000Z\n
\n YYYY-MM-DDThh:mm:ss.sssTZD (with offset), for example,\n 2014-10-01T12:30:00.000-08:00\n
\n YYYY-MM-DD, for example, 2014-10-01\n
Unix time in seconds, for example, 1412195400. This is also referred\n to as Unix Epoch time and represents the number of seconds since midnight, January 1,\n 1970 UTC.
For more information about the timestamp format, see Timestamp in the Amazon Web Services Command Line Interface User\n Guide.
" } }, "CreationTimeBefore": { @@ -35941,7 +36351,7 @@ "CreationTimeBefore": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "Set an end time for the time range during which you want to list SageMaker HyperPod clusters. A\n filter that returns nodes in a SageMaker HyperPod cluster created before the specified time. The acceptable\n formats are the same as the timestamp formats for CreationTimeAfter. For more\n information about the timestamp format, see Timestamp in the Amazon Web Services Command Line Interface User\n Guide.
Set an end time for the time range during which you want to list SageMaker HyperPod clusters. A\n filter that returns nodes in a SageMaker HyperPod cluster created before the specified time. The\n acceptable formats are the same as the timestamp formats for\n CreationTimeAfter. For more information about the timestamp format, see Timestamp in the Amazon Web Services Command Line Interface User\n Guide.
Lists all MLflow Tracking Servers.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "TrackingServerSummaries", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListMlflowTrackingServersRequest": { + "type": "structure", + "members": { + "CreatedAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "Use the CreatedAfter filter to only list tracking servers created after a\n specific date and time. Listed tracking servers are shown with a date and time such as\n \"2024-03-16T01:46:56+00:00\". The CreatedAfter parameter takes in a\n Unix timestamp. To convert a date and time into a Unix timestamp, see EpochConverter.
Use the CreatedBefore filter to only list tracking servers created before a\n specific date and time. Listed tracking servers are shown with a date and time such as\n \"2024-03-16T01:46:56+00:00\". The CreatedBefore parameter takes in\n a Unix timestamp. To convert a date and time into a Unix timestamp, see EpochConverter.
Filter for tracking servers with a specified creation status.
" + } + }, + "MlflowVersion": { + "target": "com.amazonaws.sagemaker#MlflowVersion", + "traits": { + "smithy.api#documentation": "Filter for tracking servers using the specified MLflow version.
" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#SortTrackingServerBy", + "traits": { + "smithy.api#documentation": "Filter for trackings servers sorting by name, creation time, or creation status.
" + } + }, + "SortOrder": { + "target": "com.amazonaws.sagemaker#SortOrder", + "traits": { + "smithy.api#documentation": "Change the order of the listed tracking servers. By default, tracking servers are listed in Descending order by creation time. \n To change the list order, you can specify SortOrder to be Ascending.
If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of tracking servers to list.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListMlflowTrackingServersResponse": { + "type": "structure", + "members": { + "TrackingServerSummaries": { + "target": "com.amazonaws.sagemaker#TrackingServerSummaryList", + "traits": { + "smithy.api#documentation": "A list of tracking servers according to chosen filters.
" + } + }, + "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 request to receive the next set of results.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.sagemaker#ListModelBiasJobDefinitions": { "type": "operation", "input": { @@ -42903,6 +43407,16 @@ "smithy.api#pattern": "^1|2$" } }, + "com.amazonaws.sagemaker#MlflowVersion": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 16 + }, + "smithy.api#pattern": "^[0-9]*.[0-9]*.[0-9]*$" + } + }, "com.amazonaws.sagemaker#Model": { "type": "structure", "members": { @@ -55003,6 +55517,9 @@ { "target": "com.amazonaws.sagemaker#CreateLabelingJob" }, + { + "target": "com.amazonaws.sagemaker#CreateMlflowTrackingServer" + }, { "target": "com.amazonaws.sagemaker#CreateModel" }, @@ -55042,6 +55559,9 @@ { "target": "com.amazonaws.sagemaker#CreatePresignedDomainUrl" }, + { + "target": "com.amazonaws.sagemaker#CreatePresignedMlflowTrackingServerUrl" + }, { "target": "com.amazonaws.sagemaker#CreatePresignedNotebookInstanceUrl" }, @@ -55162,6 +55682,9 @@ { "target": "com.amazonaws.sagemaker#DeleteInferenceExperiment" }, + { + "target": "com.amazonaws.sagemaker#DeleteMlflowTrackingServer" + }, { "target": "com.amazonaws.sagemaker#DeleteModel" }, @@ -55333,6 +55856,9 @@ { "target": "com.amazonaws.sagemaker#DescribeLineageGroup" }, + { + "target": "com.amazonaws.sagemaker#DescribeMlflowTrackingServer" + }, { "target": "com.amazonaws.sagemaker#DescribeModel" }, @@ -55558,6 +56084,9 @@ { "target": "com.amazonaws.sagemaker#ListLineageGroups" }, + { + "target": "com.amazonaws.sagemaker#ListMlflowTrackingServers" + }, { "target": "com.amazonaws.sagemaker#ListModelBiasJobDefinitions" }, @@ -55696,6 +56225,9 @@ { "target": "com.amazonaws.sagemaker#StartInferenceExperiment" }, + { + "target": "com.amazonaws.sagemaker#StartMlflowTrackingServer" + }, { "target": "com.amazonaws.sagemaker#StartMonitoringSchedule" }, @@ -55729,6 +56261,9 @@ { "target": "com.amazonaws.sagemaker#StopLabelingJob" }, + { + "target": "com.amazonaws.sagemaker#StopMlflowTrackingServer" + }, { "target": "com.amazonaws.sagemaker#StopMonitoringSchedule" }, @@ -55810,6 +56345,9 @@ { "target": "com.amazonaws.sagemaker#UpdateInferenceExperiment" }, + { + "target": "com.amazonaws.sagemaker#UpdateMlflowTrackingServer" + }, { "target": "com.amazonaws.sagemaker#UpdateModelCard" }, @@ -58205,6 +58743,29 @@ } } }, + "com.amazonaws.sagemaker#SortTrackingServerBy": { + "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#SortTrialComponentsBy": { "type": "enum", "members": { @@ -58308,7 +58869,7 @@ } }, "traits": { - "smithy.api#documentation": "A list of IP address ranges (CIDRs). Used to create an allow\n list of IP addresses for a private workforce. Workers will only be able to login to their worker portal from an \n IP address within this range. By default, a workforce isn't restricted to specific IP addresses.
" + "smithy.api#documentation": "A list of IP address ranges (CIDRs). Used to create an allow\n list of IP addresses for a private workforce. Workers will only be able to log in to their worker portal from an\n IP address within this range. By default, a workforce isn't restricted to specific IP addresses.
" } }, "com.amazonaws.sagemaker#SourceType": { @@ -58831,6 +59392,56 @@ "smithy.api#output": {} } }, + "com.amazonaws.sagemaker#StartMlflowTrackingServer": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#StartMlflowTrackingServerRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#StartMlflowTrackingServerResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ConflictException" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Programmatically start an MLflow Tracking Server.
" + } + }, + "com.amazonaws.sagemaker#StartMlflowTrackingServerRequest": { + "type": "structure", + "members": { + "TrackingServerName": { + "target": "com.amazonaws.sagemaker#TrackingServerName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the tracking server to start.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#StartMlflowTrackingServerResponse": { + "type": "structure", + "members": { + "TrackingServerArn": { + "target": "com.amazonaws.sagemaker#TrackingServerArn", + "traits": { + "smithy.api#documentation": "The ARN of the started tracking server.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.sagemaker#StartMonitoringSchedule": { "type": "operation", "input": { @@ -59415,6 +60026,56 @@ "smithy.api#input": {} } }, + "com.amazonaws.sagemaker#StopMlflowTrackingServer": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#StopMlflowTrackingServerRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#StopMlflowTrackingServerResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ConflictException" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Programmatically stop an MLflow Tracking Server.
" + } + }, + "com.amazonaws.sagemaker#StopMlflowTrackingServerRequest": { + "type": "structure", + "members": { + "TrackingServerName": { + "target": "com.amazonaws.sagemaker#TrackingServerName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the tracking server to stop.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#StopMlflowTrackingServerResponse": { + "type": "structure", + "members": { + "TrackingServerArn": { + "target": "com.amazonaws.sagemaker#TrackingServerArn", + "traits": { + "smithy.api#documentation": "The ARN of the stopped tracking server.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.sagemaker#StopMonitoringSchedule": { "type": "operation", "input": { @@ -59965,7 +60626,7 @@ } }, "traits": { - "smithy.api#documentation": "Describes a work team of a vendor that does the a labelling job.
" + "smithy.api#documentation": "Describes a work team of a vendor that does the labelling job.
" } }, "com.amazonaws.sagemaker#SubscribedWorkteams": { @@ -61076,6 +61737,227 @@ } } }, + "com.amazonaws.sagemaker#TrackingServerArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:mlflow-tracking-server/" + } + }, + "com.amazonaws.sagemaker#TrackingServerName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,255}$" + } + }, + "com.amazonaws.sagemaker#TrackingServerSize": { + "type": "enum", + "members": { + "S": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Small" + } + }, + "M": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Medium" + } + }, + "L": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Large" + } + } + } + }, + "com.amazonaws.sagemaker#TrackingServerStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Creating" + } + }, + "CREATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Created" + } + }, + "CREATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreateFailed" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Updating" + } + }, + "UPDATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Updated" + } + }, + "UPDATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UpdateFailed" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Deleting" + } + }, + "DELETE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeleteFailed" + } + }, + "STOPPING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopping" + } + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopped" + } + }, + "STOP_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "StopFailed" + } + }, + "STARTING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Starting" + } + }, + "STARTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Started" + } + }, + "START_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "StartFailed" + } + }, + "MAINTENANCE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MaintenanceInProgress" + } + }, + "MAINTENANCE_COMPLETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MaintenanceComplete" + } + }, + "MAINTENANCE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MaintenanceFailed" + } + } + } + }, + "com.amazonaws.sagemaker#TrackingServerSummary": { + "type": "structure", + "members": { + "TrackingServerArn": { + "target": "com.amazonaws.sagemaker#TrackingServerArn", + "traits": { + "smithy.api#documentation": "The ARN of a listed tracking server.
" + } + }, + "TrackingServerName": { + "target": "com.amazonaws.sagemaker#TrackingServerName", + "traits": { + "smithy.api#documentation": "The name of a listed tracking server.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The creation time of a listed tracking server.
" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The last modified time of a listed tracking server.
" + } + }, + "TrackingServerStatus": { + "target": "com.amazonaws.sagemaker#TrackingServerStatus", + "traits": { + "smithy.api#documentation": "The creation status of a listed tracking server.
" + } + }, + "IsActive": { + "target": "com.amazonaws.sagemaker#IsTrackingServerActive", + "traits": { + "smithy.api#documentation": "The activity status of a listed tracking server.
" + } + }, + "MlflowVersion": { + "target": "com.amazonaws.sagemaker#MlflowVersion", + "traits": { + "smithy.api#documentation": "The MLflow version used for a listed tracking server.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The summary of the tracking server to list.
" + } + }, + "com.amazonaws.sagemaker#TrackingServerSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#TrackingServerSummary" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.sagemaker#TrackingServerUrl": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2048 + } + } + }, "com.amazonaws.sagemaker#TrafficDurationInSeconds": { "type": "integer", "traits": { @@ -65773,6 +66655,83 @@ "smithy.api#output": {} } }, + "com.amazonaws.sagemaker#UpdateMlflowTrackingServer": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#UpdateMlflowTrackingServerRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#UpdateMlflowTrackingServerResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ConflictException" + }, + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Updates properties of an existing MLflow Tracking Server.
" + } + }, + "com.amazonaws.sagemaker#UpdateMlflowTrackingServerRequest": { + "type": "structure", + "members": { + "TrackingServerName": { + "target": "com.amazonaws.sagemaker#TrackingServerName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the MLflow Tracking Server to update.
", + "smithy.api#required": {} + } + }, + "ArtifactStoreUri": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#documentation": "The new S3 URI for the general purpose bucket to use as the artifact store for the MLflow\n Tracking Server.
" + } + }, + "TrackingServerSize": { + "target": "com.amazonaws.sagemaker#TrackingServerSize", + "traits": { + "smithy.api#documentation": "The new size for the MLflow Tracking Server.
" + } + }, + "AutomaticModelRegistration": { + "target": "com.amazonaws.sagemaker#Boolean", + "traits": { + "smithy.api#documentation": "Whether to enable or disable automatic registration of new MLflow models to the SageMaker Model Registry. \n To enable automatic model registration, set this value to True. \n To disable automatic model registration, set this value to False. \n If not specified, AutomaticModelRegistration defaults to False\n
The new weekly maintenance window start day and time to update. The maintenance window day and time should be \n in Coordinated Universal Time (UTC) 24-hour standard time. For example: TUE:03:30.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#UpdateMlflowTrackingServerResponse": { + "type": "structure", + "members": { + "TrackingServerArn": { + "target": "com.amazonaws.sagemaker#TrackingServerArn", + "traits": { + "smithy.api#documentation": "The ARN of the updated MLflow Tracking Server.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.sagemaker#UpdateModelCard": { "type": "operation", "input": { @@ -67695,6 +68654,16 @@ "smithy.api#documentation": "Status and billing information about the warm pool.
" } }, + "com.amazonaws.sagemaker#WeeklyMaintenanceWindowStart": { + "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": { @@ -67908,7 +68877,7 @@ "SecurityGroupIds": { "target": "com.amazonaws.sagemaker#WorkforceSecurityGroupIds", "traits": { - "smithy.api#documentation": "The VPC security group IDs, in the form sg-xxxxxxxx. The security groups must be for the same VPC as specified in the subnet.
" + "smithy.api#documentation": "The VPC security group IDs, in the form sg-xxxxxxxx. The security groups must be for the same VPC as specified in the subnet.