feat(client-sagemaker): Introduce Endpoint and EndpointConfig Arns in…

… sagemaker:ListPipelineExecutionSteps API response
aws · Aug 16, 2024 · cbc6a87 · cbc6a87
1 parent 5f85b5f
commit cbc6a87
Show file tree

Hide file tree

Showing 6 changed files with 189 additions and 82 deletions.
diff --git a/clients/client-sagemaker/src/commands/ListModelCardVersionsCommand.ts b/clients/client-sagemaker/src/commands/ListModelCardVersionsCommand.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 { ListModelCardVersionsRequest, ListModelCardVersionsResponse } from "../models/models_3";
+import { ListModelCardVersionsRequest } from "../models/models_3";
+import { ListModelCardVersionsResponse } from "../models/models_4";
 import { de_ListModelCardVersionsCommand, se_ListModelCardVersionsCommand } from "../protocols/Aws_json1_1";
 import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient";
 

diff --git a/clients/client-sagemaker/src/commands/ListPipelineExecutionStepsCommand.ts b/clients/client-sagemaker/src/commands/ListPipelineExecutionStepsCommand.ts
@@ -131,6 +131,12 @@ export interface ListPipelineExecutionStepsCommandOutput extends ListPipelineExe
  * //         AutoMLJob: { // AutoMLJobStepMetadata
  * //           Arn: "STRING_VALUE",
  * //         },
+ * //         Endpoint: { // EndpointStepMetadata
+ * //           Arn: "STRING_VALUE",
+ * //         },
+ * //         EndpointConfig: { // EndpointConfigStepMetadata
+ * //           Arn: "STRING_VALUE",
+ * //         },
  * //       },
  * //       AttemptCount: Number("int"),
  * //       SelectiveExecutionResult: { // SelectiveExecutionResult

diff --git a/clients/client-sagemaker/src/models/models_3.ts b/clients/client-sagemaker/src/models/models_3.ts
@@ -5245,6 +5245,18 @@ export const EndpointConfigSortKey = {
  */
 export type EndpointConfigSortKey = (typeof EndpointConfigSortKey)[keyof typeof EndpointConfigSortKey];
 
+/**
+ * <p>Metadata for an endpoint configuration step.</p>
+ * @public
+ */
+export interface EndpointConfigStepMetadata {
+  /**
+   * <p>The Amazon Resource Name (ARN) of the endpoint configuration used in the step.</p>
+   * @public
+   */
+  Arn?: string;
+}
+
 /**
  * <p>Provides summary information for an endpoint configuration.</p>
  * @public
@@ -5284,6 +5296,18 @@ export const EndpointSortKey = {
  */
 export type EndpointSortKey = (typeof EndpointSortKey)[keyof typeof EndpointSortKey];
 
+/**
+ * <p>Metadata for an endpoint step.</p>
+ * @public
+ */
+export interface EndpointStepMetadata {
+  /**
+   * <p>The Amazon Resource Name (ARN) of the endpoint in the step.</p>
+   * @public
+   */
+  Arn?: string;
+}
+
 /**
  * <p>Provides summary information for an endpoint.</p>
  * @public
@@ -11561,85 +11585,6 @@ export interface ListModelCardVersionsRequest {
   SortOrder?: ModelCardSortOrder;
 }
 
-/**
- * <p>A summary of a specific version of the model card.</p>
- * @public
- */
-export interface ModelCardVersionSummary {
-  /**
-   * <p>The name of the model card.</p>
-   * @public
-   */
-  ModelCardName: string | undefined;
-
-  /**
-   * <p>The Amazon Resource Name (ARN) of the model card.</p>
-   * @public
-   */
-  ModelCardArn: string | undefined;
-
-  /**
-   * <p>The approval status of the model card version within your organization. Different organizations might have different criteria for model card review and approval.</p>
-   *          <ul>
-   *             <li>
-   *                <p>
-   *                   <code>Draft</code>: The model card is a work in progress.</p>
-   *             </li>
-   *             <li>
-   *                <p>
-   *                   <code>PendingReview</code>: The model card is pending review.</p>
-   *             </li>
-   *             <li>
-   *                <p>
-   *                   <code>Approved</code>: The model card is approved.</p>
-   *             </li>
-   *             <li>
-   *                <p>
-   *                   <code>Archived</code>: The model card is archived. No more updates should be made to the model
-   *                card, but it can still be exported.</p>
-   *             </li>
-   *          </ul>
-   * @public
-   */
-  ModelCardStatus: ModelCardStatus | undefined;
-
-  /**
-   * <p>A version of the model card.</p>
-   * @public
-   */
-  ModelCardVersion: number | undefined;
-
-  /**
-   * <p>The date and time that the model card version was created.</p>
-   * @public
-   */
-  CreationTime: Date | undefined;
-
-  /**
-   * <p>The time date and time that the model card version was last modified.</p>
-   * @public
-   */
-  LastModifiedTime?: Date;
-}
-
-/**
- * @public
- */
-export interface ListModelCardVersionsResponse {
-  /**
-   * <p>The summaries of the listed versions of the model card.</p>
-   * @public
-   */
-  ModelCardVersionSummaryList: ModelCardVersionSummary[] | undefined;
-
-  /**
-   * <p>If the response is truncated, SageMaker returns this token. To retrieve the next set of model
-   *          card versions, use it in the subsequent request.</p>
-   * @public
-   */
-  NextToken?: string;
-}
-
 /**
  * @internal
  */

diff --git a/clients/client-sagemaker/src/models/models_4.ts b/clients/client-sagemaker/src/models/models_4.ts
@@ -133,6 +133,8 @@ import {
   Edge,
   EMRStepMetadata,
   Endpoint,
+  EndpointConfigStepMetadata,
+  EndpointStepMetadata,
   ExecutionStatus,
   Experiment,
   FailStepMetadata,
@@ -179,6 +181,85 @@ import {
   Workteam,
 } from "./models_3";
 
+/**
+ * <p>A summary of a specific version of the model card.</p>
+ * @public
+ */
+export interface ModelCardVersionSummary {
+  /**
+   * <p>The name of the model card.</p>
+   * @public
+   */
+  ModelCardName: string | undefined;
+
+  /**
+   * <p>The Amazon Resource Name (ARN) of the model card.</p>
+   * @public
+   */
+  ModelCardArn: string | undefined;
+
+  /**
+   * <p>The approval status of the model card version within your organization. Different organizations might have different criteria for model card review and approval.</p>
+   *          <ul>
+   *             <li>
+   *                <p>
+   *                   <code>Draft</code>: The model card is a work in progress.</p>
+   *             </li>
+   *             <li>
+   *                <p>
+   *                   <code>PendingReview</code>: The model card is pending review.</p>
+   *             </li>
+   *             <li>
+   *                <p>
+   *                   <code>Approved</code>: The model card is approved.</p>
+   *             </li>
+   *             <li>
+   *                <p>
+   *                   <code>Archived</code>: The model card is archived. No more updates should be made to the model
+   *                card, but it can still be exported.</p>
+   *             </li>
+   *          </ul>
+   * @public
+   */
+  ModelCardStatus: ModelCardStatus | undefined;
+
+  /**
+   * <p>A version of the model card.</p>
+   * @public
+   */
+  ModelCardVersion: number | undefined;
+
+  /**
+   * <p>The date and time that the model card version was created.</p>
+   * @public
+   */
+  CreationTime: Date | undefined;
+
+  /**
+   * <p>The time date and time that the model card version was last modified.</p>
+   * @public
+   */
+  LastModifiedTime?: Date;
+}
+
+/**
+ * @public
+ */
+export interface ListModelCardVersionsResponse {
+  /**
+   * <p>The summaries of the listed versions of the model card.</p>
+   * @public
+   */
+  ModelCardVersionSummaryList: ModelCardVersionSummary[] | undefined;
+
+  /**
+   * <p>If the response is truncated, SageMaker returns this token. To retrieve the next set of model
+   *          card versions, use it in the subsequent request.</p>
+   * @public
+   */
+  NextToken?: string;
+}
+
 /**
  * @public
  */
@@ -2477,6 +2558,18 @@ export interface PipelineExecutionStepMetadata {
    * @public
    */
   AutoMLJob?: AutoMLJobStepMetadata;
+
+  /**
+   * <p>The endpoint that was invoked during this step execution.</p>
+   * @public
+   */
+  Endpoint?: EndpointStepMetadata;
+
+  /**
+   * <p>The endpoint configuration used to create an endpoint during this step execution.</p>
+   * @public
+   */
+  EndpointConfig?: EndpointConfigStepMetadata;
 }
 
 /**

diff --git a/clients/client-sagemaker/src/protocols/Aws_json1_1.ts b/clients/client-sagemaker/src/protocols/Aws_json1_1.ts
@@ -1716,7 +1716,9 @@ import {
   EnableSagemakerServicecatalogPortfolioInput,
   EnableSagemakerServicecatalogPortfolioOutput,
   Endpoint,
+  EndpointConfigStepMetadata,
   EndpointConfigSummary,
+  EndpointStepMetadata,
   EndpointSummary,
   Experiment,
   ExperimentSummary,
@@ -1845,13 +1847,11 @@ import {
   ListModelCardsRequest,
   ListModelCardsResponse,
   ListModelCardVersionsRequest,
-  ListModelCardVersionsResponse,
   MetricData,
   MetricSpecification,
   ModelCardExportArtifacts,
   ModelCardExportJobSummary,
   ModelCardSummary,
-  ModelCardVersionSummary,
   ModelPackageStatusDetails,
   ModelPackageStatusItem,
   MonitoringExecutionSummary,
@@ -1887,6 +1887,7 @@ import {
   Workteam,
 } from "../models/models_3";
 import {
+  ListModelCardVersionsResponse,
   ListModelExplainabilityJobDefinitionsRequest,
   ListModelExplainabilityJobDefinitionsResponse,
   ListModelMetadataRequest,
@@ -1955,6 +1956,7 @@ import {
   ListWorkteamsResponse,
   Model,
   ModelCard,
+  ModelCardVersionSummary,
   ModelDashboardEndpoint,
   ModelDashboardIndicatorAction,
   ModelDashboardModel,
@@ -21683,6 +21685,15 @@ const de_Endpoint = (output: any, context: __SerdeContext): Endpoint => {
   }) as any;
 };
 
+/**
+ * deserializeAws_json1_1EndpointConfigStepMetadata
+ */
+const de_EndpointConfigStepMetadata = (output: any, context: __SerdeContext): EndpointConfigStepMetadata => {
+  return take(output, {
+    Arn: __expectString,
+  }) as any;
+};
+
 /**
  * deserializeAws_json1_1EndpointConfigSummary
  */
@@ -21817,6 +21828,15 @@ const de_Endpoints = (output: any, context: __SerdeContext): EndpointInfo[] => {
   return retVal;
 };
 
+/**
+ * deserializeAws_json1_1EndpointStepMetadata
+ */
+const de_EndpointStepMetadata = (output: any, context: __SerdeContext): EndpointStepMetadata => {
+  return take(output, {
+    Arn: __expectString,
+  }) as any;
+};
+
 /**
  * deserializeAws_json1_1EndpointSummary
  */
@@ -26863,6 +26883,8 @@ const de_PipelineExecutionStepMetadata = (output: any, context: __SerdeContext):
     ClarifyCheck: (_: any) => de_ClarifyCheckStepMetadata(_, context),
     Condition: (_: any) => de_ConditionStepMetadata(_, context),
     EMR: (_: any) => de_EMRStepMetadata(_, context),
+    Endpoint: (_: any) => de_EndpointStepMetadata(_, context),
+    EndpointConfig: (_: any) => de_EndpointConfigStepMetadata(_, context),
     Fail: (_: any) => de_FailStepMetadata(_, context),
     Lambda: (_: any) => de_LambdaStepMetadata(_, context),
     Model: (_: any) => de_ModelStepMetadata(_, context),