@aws-sdk/client-sagemaker 3.1006.0 → 3.1007.0

package/dist-types/commands/ExtendTrainingPlanCommand.d.ts

@@ -0,0 +1,91 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import type { ExtendTrainingPlanRequest, ExtendTrainingPlanResponse } from "../models/models_3";
+import type { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link ExtendTrainingPlanCommand}.
+ */
+export interface ExtendTrainingPlanCommandInput extends ExtendTrainingPlanRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link ExtendTrainingPlanCommand}.
+ */
+export interface ExtendTrainingPlanCommandOutput extends ExtendTrainingPlanResponse, __MetadataBearer {
+}
+declare const ExtendTrainingPlanCommand_base: {
+    new (input: ExtendTrainingPlanCommandInput): import("@smithy/smithy-client").CommandImpl<ExtendTrainingPlanCommandInput, ExtendTrainingPlanCommandOutput, SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (input: ExtendTrainingPlanCommandInput): import("@smithy/smithy-client").CommandImpl<ExtendTrainingPlanCommandInput, ExtendTrainingPlanCommandOutput, SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Extends an existing training plan by purchasing an extension offering. This allows you to add additional compute capacity time to your training plan without creating a new plan or reconfiguring your workloads.</p> <p>To find available extension offerings, use the <code> <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_SearchTrainingPlanOfferings.html">SearchTrainingPlanOfferings</a> </code> API with the <code>TrainingPlanArn</code> parameter.</p> <p>To view the history of extensions for a training plan, use the <code> <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeTrainingPlanExtensionHistory.html">DescribeTrainingPlanExtensionHistory</a> </code> API.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { SageMakerClient, ExtendTrainingPlanCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import
+ * // const { SageMakerClient, ExtendTrainingPlanCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import
+ * // import type { SageMakerClientConfig } from "@aws-sdk/client-sagemaker";
+ * const config = {}; // type is SageMakerClientConfig
+ * const client = new SageMakerClient(config);
+ * const input = { // ExtendTrainingPlanRequest
+ *   TrainingPlanExtensionOfferingId: "STRING_VALUE", // required
+ * };
+ * const command = new ExtendTrainingPlanCommand(input);
+ * const response = await client.send(command);
+ * // { // ExtendTrainingPlanResponse
+ * //   TrainingPlanExtensions: [ // TrainingPlanExtensions // required
+ * //     { // TrainingPlanExtension
+ * //       TrainingPlanExtensionOfferingId: "STRING_VALUE", // required
+ * //       ExtendedAt: new Date("TIMESTAMP"),
+ * //       StartDate: new Date("TIMESTAMP"),
+ * //       EndDate: new Date("TIMESTAMP"),
+ * //       Status: "STRING_VALUE",
+ * //       PaymentStatus: "STRING_VALUE",
+ * //       AvailabilityZone: "STRING_VALUE",
+ * //       AvailabilityZoneId: "STRING_VALUE",
+ * //       DurationHours: Number("int"),
+ * //       UpfrontFee: "STRING_VALUE",
+ * //       CurrencyCode: "STRING_VALUE",
+ * //     },
+ * //   ],
+ * // };
+ *
+ * ```
+ *
+ * @param ExtendTrainingPlanCommandInput - {@link ExtendTrainingPlanCommandInput}
+ * @returns {@link ExtendTrainingPlanCommandOutput}
+ * @see {@link ExtendTrainingPlanCommandInput} for command's `input` shape.
+ * @see {@link ExtendTrainingPlanCommandOutput} for command's `response` shape.
+ * @see {@link SageMakerClientResolvedConfig | config} for SageMakerClient's `config` shape.
+ *
+ * @throws {@link ResourceNotFound} (client fault)
+ *  <p>Resource being access is not found.</p>
+ *
+ * @throws {@link SageMakerServiceException}
+ * <p>Base exception class for all service exceptions from SageMaker service.</p>
+ *
+ *
+ * @public
+ */
+export declare class ExtendTrainingPlanCommand extends ExtendTrainingPlanCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: ExtendTrainingPlanRequest;
+            output: ExtendTrainingPlanResponse;
+        };
+        sdk: {
+            input: ExtendTrainingPlanCommandInput;
+            output: ExtendTrainingPlanCommandOutput;
+        };
+    };
+}

package/dist-types/commands/ListPipelineVersionsCommand.d.ts

@@ -1,6 +1,6 @@
 import { Command as $Command } from "@smithy/smithy-client";
 import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
-import type { ListPipelineVersionsRequest, ListPipelineVersionsResponse } from "../models/models_3";
+import type { ListPipelineVersionsRequest, ListPipelineVersionsResponse } from "../models/models_4";
 import type { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient";
 /**
  * @public

package/dist-types/commands/ListPipelinesCommand.d.ts

@@ -1,6 +1,7 @@
 import { Command as $Command } from "@smithy/smithy-client";
 import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
-import type { ListPipelinesRequest, ListPipelinesResponse } from "../models/models_3";
+import type { ListPipelinesRequest } from "../models/models_3";
+import type { ListPipelinesResponse } from "../models/models_4";
 import type { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient";
 /**
  * @public

package/dist-types/commands/ListProcessingJobsCommand.d.ts

@@ -1,7 +1,6 @@
 import { Command as $Command } from "@smithy/smithy-client";
 import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
-import type { ListProcessingJobsRequest } from "../models/models_3";
-import type { ListProcessingJobsResponse } from "../models/models_4";
+import type { ListProcessingJobsRequest, ListProcessingJobsResponse } from "../models/models_4";
 import type { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient";
 /**
  * @public

package/dist-types/commands/SearchTrainingPlanOfferingsCommand.d.ts

@@ -47,6 +47,7 @@ declare const SearchTrainingPlanOfferingsCommand_base: {
  *   TargetResources: [ // SageMakerResourceNames
  *     "training-job" || "hyperpod-cluster" || "endpoint",
  *   ],
+ *   TrainingPlanArn: "STRING_VALUE",
  * };
  * const command = new SearchTrainingPlanOfferingsCommand(input);
  * const response = await client.send(command);
@@ -75,10 +76,23 @@ declare const SearchTrainingPlanOfferingsCommand_base: {
  * //           DurationMinutes: Number("long"),
  * //           StartTime: new Date("TIMESTAMP"),
  * //           EndTime: new Date("TIMESTAMP"),
+ * //           ExtensionStartTime: new Date("TIMESTAMP"),
+ * //           ExtensionEndTime: new Date("TIMESTAMP"),
  * //         },
  * //       ],
  * //     },
  * //   ],
+ * //   TrainingPlanExtensionOfferings: [ // TrainingPlanExtensionOfferings
+ * //     { // TrainingPlanExtensionOffering
+ * //       TrainingPlanExtensionOfferingId: "STRING_VALUE", // required
+ * //       AvailabilityZone: "STRING_VALUE",
+ * //       StartDate: new Date("TIMESTAMP"),
+ * //       EndDate: new Date("TIMESTAMP"),
+ * //       DurationHours: Number("int"),
+ * //       UpfrontFee: "STRING_VALUE",
+ * //       CurrencyCode: "STRING_VALUE",
+ * //     },
+ * //   ],
  * // };
  *
  * ```

package/dist-types/commands/index.d.ts

@@ -198,6 +198,7 @@ export * from "./DescribeStudioLifecycleConfigCommand";
 export * from "./DescribeSubscribedWorkteamCommand";
 export * from "./DescribeTrainingJobCommand";
 export * from "./DescribeTrainingPlanCommand";
+export * from "./DescribeTrainingPlanExtensionHistoryCommand";
 export * from "./DescribeTransformJobCommand";
 export * from "./DescribeTrialCommand";
 export * from "./DescribeTrialComponentCommand";
@@ -208,6 +209,7 @@ export * from "./DetachClusterNodeVolumeCommand";
 export * from "./DisableSagemakerServicecatalogPortfolioCommand";
 export * from "./DisassociateTrialComponentCommand";
 export * from "./EnableSagemakerServicecatalogPortfolioCommand";
+export * from "./ExtendTrainingPlanCommand";
 export * from "./GetDeviceFleetReportCommand";
 export * from "./GetLineageGroupPolicyCommand";
 export * from "./GetModelPackageGroupPolicyCommand";

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

@@ -1189,6 +1189,102 @@ export interface DescribeTrainingPlanResponse {
      */
     ReservedCapacitySummaries?: ReservedCapacitySummary[] | undefined;
 }
+/**
+ * @public
+ */
+export interface DescribeTrainingPlanExtensionHistoryRequest {
+    /**
+     * <p>The Amazon Resource Name (ARN); of the training plan to retrieve extension history for.</p>
+     * @public
+     */
+    TrainingPlanArn: string | undefined;
+    /**
+     * <p>A token to continue pagination if more results are available.</p>
+     * @public
+     */
+    NextToken?: string | undefined;
+    /**
+     * <p>The maximum number of extensions to return in the response.</p>
+     * @public
+     */
+    MaxResults?: number | undefined;
+}
+/**
+ * <p>Details about an extension to a training plan, including the offering ID, dates, status, and cost information.</p>
+ * @public
+ */
+export interface TrainingPlanExtension {
+    /**
+     * <p>The unique identifier of the extension offering that was used to create this extension.</p>
+     * @public
+     */
+    TrainingPlanExtensionOfferingId: string | undefined;
+    /**
+     * <p>The timestamp when the extension was created.</p>
+     * @public
+     */
+    ExtendedAt?: Date | undefined;
+    /**
+     * <p>The start date of the extension period.</p>
+     * @public
+     */
+    StartDate?: Date | undefined;
+    /**
+     * <p>The end date of the extension period.</p>
+     * @public
+     */
+    EndDate?: Date | undefined;
+    /**
+     * <p>The current status of the extension (e.g., Pending, Active, Scheduled, Failed, Expired).</p>
+     * @public
+     */
+    Status?: string | undefined;
+    /**
+     * <p>The payment processing status of the extension.</p>
+     * @public
+     */
+    PaymentStatus?: string | undefined;
+    /**
+     * <p>The Availability Zone of the extension.</p>
+     * @public
+     */
+    AvailabilityZone?: string | undefined;
+    /**
+     * <p>The Availability Zone ID of the extension.</p>
+     * @public
+     */
+    AvailabilityZoneId?: string | undefined;
+    /**
+     * <p>The duration of the extension in hours.</p>
+     * @public
+     */
+    DurationHours?: number | undefined;
+    /**
+     * <p>The upfront fee for the extension.</p>
+     * @public
+     */
+    UpfrontFee?: string | undefined;
+    /**
+     * <p>The currency code for the upfront fee (e.g., USD).</p>
+     * @public
+     */
+    CurrencyCode?: string | undefined;
+}
+/**
+ * @public
+ */
+export interface DescribeTrainingPlanExtensionHistoryResponse {
+    /**
+     * <p>A list of extensions for the specified training plan.</p>
+     * @public
+     */
+    TrainingPlanExtensions: TrainingPlanExtension[] | undefined;
+    /**
+     * <p>A token to continue pagination if more results are available.</p>
+     * @public
+     */
+    NextToken?: string | undefined;
+}
 /**
  * @public
  */
@@ -2936,6 +3032,26 @@ export interface ExperimentSummary {
      */
     LastModifiedTime?: Date | undefined;
 }
+/**
+ * @public
+ */
+export interface ExtendTrainingPlanRequest {
+    /**
+     * <p>The unique identifier of the extension offering to purchase. You can retrieve this ID from the <code>TrainingPlanExtensionOfferings</code> in the response of the <code>SearchTrainingPlanOfferings</code> API.</p>
+     * @public
+     */
+    TrainingPlanExtensionOfferingId: string | undefined;
+}
+/**
+ * @public
+ */
+export interface ExtendTrainingPlanResponse {
+    /**
+     * <p>The list of extensions for the training plan, including the newly created extension.</p>
+     * @public
+     */
+    TrainingPlanExtensions: TrainingPlanExtension[] | undefined;
+}
 /**
  * <p>The container for the metadata for Fail step.</p>
  * @public
@@ -9471,159 +9587,3 @@ export interface PipelineSummary {
      */
     LastExecutionTime?: Date | undefined;
 }
-/**
- * @public
- */
-export interface ListPipelinesResponse {
-    /**
-     * <p>Contains a sorted list of <code>PipelineSummary</code> objects matching the specified filters. Each <code>PipelineSummary</code> consists of PipelineArn, PipelineName, ExperimentName, PipelineDescription, CreationTime, LastModifiedTime, LastRunTime, and RoleArn. This list can be empty. </p>
-     * @public
-     */
-    PipelineSummaries?: PipelineSummary[] | undefined;
-    /**
-     * <p>If the result of the previous <code>ListPipelines</code> request was truncated, the response includes a <code>NextToken</code>. To retrieve the next set of pipelines, use the token in the next request.</p>
-     * @public
-     */
-    NextToken?: string | undefined;
-}
-/**
- * @public
- */
-export interface ListPipelineVersionsRequest {
-    /**
-     * <p>The Amazon Resource Name (ARN) of the pipeline.</p>
-     * @public
-     */
-    PipelineName: string | undefined;
-    /**
-     * <p>A filter that returns the pipeline versions that were created after a specified time.</p>
-     * @public
-     */
-    CreatedAfter?: Date | undefined;
-    /**
-     * <p>A filter that returns the pipeline versions that were created before a specified time.</p>
-     * @public
-     */
-    CreatedBefore?: Date | undefined;
-    /**
-     * <p>The sort order for the results.</p>
-     * @public
-     */
-    SortOrder?: SortOrder | undefined;
-    /**
-     * <p>If the result of the previous <code>ListPipelineVersions</code> request was truncated, the response includes a <code>NextToken</code>. To retrieve the next set of pipeline versions, use this token in your next request.</p>
-     * @public
-     */
-    NextToken?: string | undefined;
-    /**
-     * <p>The maximum number of pipeline versions to return in the response.</p>
-     * @public
-     */
-    MaxResults?: number | undefined;
-}
-/**
- * <p>The summary of the pipeline version.</p>
- * @public
- */
-export interface PipelineVersionSummary {
-    /**
-     * <p>The Amazon Resource Name (ARN) of the pipeline.</p>
-     * @public
-     */
-    PipelineArn?: string | undefined;
-    /**
-     * <p>The ID of the pipeline version.</p>
-     * @public
-     */
-    PipelineVersionId?: number | undefined;
-    /**
-     * <p>The creation time of the pipeline version.</p>
-     * @public
-     */
-    CreationTime?: Date | undefined;
-    /**
-     * <p>The description of the pipeline version.</p>
-     * @public
-     */
-    PipelineVersionDescription?: string | undefined;
-    /**
-     * <p>The display name of the pipeline version.</p>
-     * @public
-     */
-    PipelineVersionDisplayName?: string | undefined;
-    /**
-     * <p>The Amazon Resource Name (ARN) of the most recent pipeline execution created from this pipeline version.</p>
-     * @public
-     */
-    LastExecutionPipelineExecutionArn?: string | undefined;
-}
-/**
- * @public
- */
-export interface ListPipelineVersionsResponse {
-    /**
-     * <p>Contains a sorted list of pipeline version summary objects matching the specified filters. Each version summary includes the pipeline version ID, the creation date, and the last pipeline execution created from that version. This list can be empty.</p>
-     * @public
-     */
-    PipelineVersionSummaries?: PipelineVersionSummary[] | undefined;
-    /**
-     * <p>If the result of the previous <code>ListPipelineVersions</code> request was truncated, the response includes a <code>NextToken</code>. To retrieve the next set of pipeline versions, use this token in your next request.</p>
-     * @public
-     */
-    NextToken?: string | undefined;
-}
-/**
- * @public
- */
-export interface ListProcessingJobsRequest {
-    /**
-     * <p>A filter that returns only processing jobs created after the specified time.</p>
-     * @public
-     */
-    CreationTimeAfter?: Date | undefined;
-    /**
-     * <p>A filter that returns only processing jobs created after the specified time.</p>
-     * @public
-     */
-    CreationTimeBefore?: Date | undefined;
-    /**
-     * <p>A filter that returns only processing jobs modified after the specified time.</p>
-     * @public
-     */
-    LastModifiedTimeAfter?: Date | undefined;
-    /**
-     * <p>A filter that returns only processing jobs modified before the specified time.</p>
-     * @public
-     */
-    LastModifiedTimeBefore?: Date | undefined;
-    /**
-     * <p>A string in the processing job name. This filter returns only processing jobs whose name contains the specified string.</p>
-     * @public
-     */
-    NameContains?: string | undefined;
-    /**
-     * <p>A filter that retrieves only processing jobs with a specific status.</p>
-     * @public
-     */
-    StatusEquals?: ProcessingJobStatus | undefined;
-    /**
-     * <p>The field to sort results by. The default is <code>CreationTime</code>.</p>
-     * @public
-     */
-    SortBy?: SortBy | undefined;
-    /**
-     * <p>The sort order for results. The default is <code>Ascending</code>.</p>
-     * @public
-     */
-    SortOrder?: SortOrder | undefined;
-    /**
-     * <p>If the result of the previous <code>ListProcessingJobs</code> request was truncated, the response includes a <code>NextToken</code>. To retrieve the next set of processing jobs, use the token in the next request.</p>
-     * @public
-     */
-    NextToken?: string | undefined;
-    /**
-     * <p>The maximum number of processing jobs to return in the response.</p>
-     * @public
-     */
-    MaxResults?: number | undefined;
-}