Skip to content

Commit cbc6a87

Browse files
author
awstools
committed
feat(client-sagemaker): Introduce Endpoint and EndpointConfig Arns in sagemaker:ListPipelineExecutionSteps API response
1 parent 5f85b5f commit cbc6a87

File tree

6 files changed

+189
-82
lines changed

6 files changed

+189
-82
lines changed

‎clients/client-sagemaker/src/commands/ListModelCardVersionsCommand.ts‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,8 @@ import { Command as $Command } from "@smithy/smithy-client";
55
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
66

77
import { commonParams } from "../endpoint/EndpointParameters";
8-
import { ListModelCardVersionsRequest, ListModelCardVersionsResponse } from "../models/models_3";
8+
import { ListModelCardVersionsRequest } from "../models/models_3";
9+
import { ListModelCardVersionsResponse } from "../models/models_4";
910
import { de_ListModelCardVersionsCommand, se_ListModelCardVersionsCommand } from "../protocols/Aws_json1_1";
1011
import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient";
1112

‎clients/client-sagemaker/src/commands/ListPipelineExecutionStepsCommand.ts‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -131,6 +131,12 @@ export interface ListPipelineExecutionStepsCommandOutput extends ListPipelineExe
131131
* // AutoMLJob: { // AutoMLJobStepMetadata
132132
* // Arn: "STRING_VALUE",
133133
* // },
134+
* // Endpoint: { // EndpointStepMetadata
135+
* // Arn: "STRING_VALUE",
136+
* // },
137+
* // EndpointConfig: { // EndpointConfigStepMetadata
138+
* // Arn: "STRING_VALUE",
139+
* // },
134140
* // },
135141
* // AttemptCount: Number("int"),
136142
* // SelectiveExecutionResult: { // SelectiveExecutionResult

‎clients/client-sagemaker/src/models/models_3.ts‎

Lines changed: 24 additions & 79 deletions
Original file line numberDiff line numberDiff line change
@@ -5245,6 +5245,18 @@ export const EndpointConfigSortKey = {
52455245
*/
52465246
export type EndpointConfigSortKey = (typeof EndpointConfigSortKey)[keyof typeof EndpointConfigSortKey];
52475247

5248+
/**
5249+
* <p>Metadata for an endpoint configuration step.</p>
5250+
* @public
5251+
*/
5252+
export interface EndpointConfigStepMetadata {
5253+
/**
5254+
* <p>The Amazon Resource Name (ARN) of the endpoint configuration used in the step.</p>
5255+
* @public
5256+
*/
5257+
Arn?: string;
5258+
}
5259+
52485260
/**
52495261
* <p>Provides summary information for an endpoint configuration.</p>
52505262
* @public
@@ -5284,6 +5296,18 @@ export const EndpointSortKey = {
52845296
*/
52855297
export type EndpointSortKey = (typeof EndpointSortKey)[keyof typeof EndpointSortKey];
52865298

5299+
/**
5300+
* <p>Metadata for an endpoint step.</p>
5301+
* @public
5302+
*/
5303+
export interface EndpointStepMetadata {
5304+
/**
5305+
* <p>The Amazon Resource Name (ARN) of the endpoint in the step.</p>
5306+
* @public
5307+
*/
5308+
Arn?: string;
5309+
}
5310+
52875311
/**
52885312
* <p>Provides summary information for an endpoint.</p>
52895313
* @public
@@ -11561,85 +11585,6 @@ export interface ListModelCardVersionsRequest {
1156111585
SortOrder?: ModelCardSortOrder;
1156211586
}
1156311587

11564-
/**
11565-
* <p>A summary of a specific version of the model card.</p>
11566-
* @public
11567-
*/
11568-
export interface ModelCardVersionSummary {
11569-
/**
11570-
* <p>The name of the model card.</p>
11571-
* @public
11572-
*/
11573-
ModelCardName: string | undefined;
11574-
11575-
/**
11576-
* <p>The Amazon Resource Name (ARN) of the model card.</p>
11577-
* @public
11578-
*/
11579-
ModelCardArn: string | undefined;
11580-
11581-
/**
11582-
* <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>
11583-
* <ul>
11584-
* <li>
11585-
* <p>
11586-
* <code>Draft</code>: The model card is a work in progress.</p>
11587-
* </li>
11588-
* <li>
11589-
* <p>
11590-
* <code>PendingReview</code>: The model card is pending review.</p>
11591-
* </li>
11592-
* <li>
11593-
* <p>
11594-
* <code>Approved</code>: The model card is approved.</p>
11595-
* </li>
11596-
* <li>
11597-
* <p>
11598-
* <code>Archived</code>: The model card is archived. No more updates should be made to the model
11599-
* card, but it can still be exported.</p>
11600-
* </li>
11601-
* </ul>
11602-
* @public
11603-
*/
11604-
ModelCardStatus: ModelCardStatus | undefined;
11605-
11606-
/**
11607-
* <p>A version of the model card.</p>
11608-
* @public
11609-
*/
11610-
ModelCardVersion: number | undefined;
11611-
11612-
/**
11613-
* <p>The date and time that the model card version was created.</p>
11614-
* @public
11615-
*/
11616-
CreationTime: Date | undefined;
11617-
11618-
/**
11619-
* <p>The time date and time that the model card version was last modified.</p>
11620-
* @public
11621-
*/
11622-
LastModifiedTime?: Date;
11623-
}
11624-
11625-
/**
11626-
* @public
11627-
*/
11628-
export interface ListModelCardVersionsResponse {
11629-
/**
11630-
* <p>The summaries of the listed versions of the model card.</p>
11631-
* @public
11632-
*/
11633-
ModelCardVersionSummaryList: ModelCardVersionSummary[] | undefined;
11634-
11635-
/**
11636-
* <p>If the response is truncated, SageMaker returns this token. To retrieve the next set of model
11637-
* card versions, use it in the subsequent request.</p>
11638-
* @public
11639-
*/
11640-
NextToken?: string;
11641-
}
11642-
1164311588
/**
1164411589
* @internal
1164511590
*/

‎clients/client-sagemaker/src/models/models_4.ts‎

Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -133,6 +133,8 @@ import {
133133
Edge,
134134
EMRStepMetadata,
135135
Endpoint,
136+
EndpointConfigStepMetadata,
137+
EndpointStepMetadata,
136138
ExecutionStatus,
137139
Experiment,
138140
FailStepMetadata,
@@ -179,6 +181,85 @@ import {
179181
Workteam,
180182
} from "./models_3";
181183

184+
/**
185+
* <p>A summary of a specific version of the model card.</p>
186+
* @public
187+
*/
188+
export interface ModelCardVersionSummary {
189+
/**
190+
* <p>The name of the model card.</p>
191+
* @public
192+
*/
193+
ModelCardName: string | undefined;
194+
195+
/**
196+
* <p>The Amazon Resource Name (ARN) of the model card.</p>
197+
* @public
198+
*/
199+
ModelCardArn: string | undefined;
200+
201+
/**
202+
* <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>
203+
* <ul>
204+
* <li>
205+
* <p>
206+
* <code>Draft</code>: The model card is a work in progress.</p>
207+
* </li>
208+
* <li>
209+
* <p>
210+
* <code>PendingReview</code>: The model card is pending review.</p>
211+
* </li>
212+
* <li>
213+
* <p>
214+
* <code>Approved</code>: The model card is approved.</p>
215+
* </li>
216+
* <li>
217+
* <p>
218+
* <code>Archived</code>: The model card is archived. No more updates should be made to the model
219+
* card, but it can still be exported.</p>
220+
* </li>
221+
* </ul>
222+
* @public
223+
*/
224+
ModelCardStatus: ModelCardStatus | undefined;
225+
226+
/**
227+
* <p>A version of the model card.</p>
228+
* @public
229+
*/
230+
ModelCardVersion: number | undefined;
231+
232+
/**
233+
* <p>The date and time that the model card version was created.</p>
234+
* @public
235+
*/
236+
CreationTime: Date | undefined;
237+
238+
/**
239+
* <p>The time date and time that the model card version was last modified.</p>
240+
* @public
241+
*/
242+
LastModifiedTime?: Date;
243+
}
244+
245+
/**
246+
* @public
247+
*/
248+
export interface ListModelCardVersionsResponse {
249+
/**
250+
* <p>The summaries of the listed versions of the model card.</p>
251+
* @public
252+
*/
253+
ModelCardVersionSummaryList: ModelCardVersionSummary[] | undefined;
254+
255+
/**
256+
* <p>If the response is truncated, SageMaker returns this token. To retrieve the next set of model
257+
* card versions, use it in the subsequent request.</p>
258+
* @public
259+
*/
260+
NextToken?: string;
261+
}
262+
182263
/**
183264
* @public
184265
*/
@@ -2477,6 +2558,18 @@ export interface PipelineExecutionStepMetadata {
24772558
* @public
24782559
*/
24792560
AutoMLJob?: AutoMLJobStepMetadata;
2561+
2562+
/**
2563+
* <p>The endpoint that was invoked during this step execution.</p>
2564+
* @public
2565+
*/
2566+
Endpoint?: EndpointStepMetadata;
2567+
2568+
/**
2569+
* <p>The endpoint configuration used to create an endpoint during this step execution.</p>
2570+
* @public
2571+
*/
2572+
EndpointConfig?: EndpointConfigStepMetadata;
24802573
}
24812574

24822575
/**

‎clients/client-sagemaker/src/protocols/Aws_json1_1.ts‎

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1716,7 +1716,9 @@ import {
17161716
EnableSagemakerServicecatalogPortfolioInput,
17171717
EnableSagemakerServicecatalogPortfolioOutput,
17181718
Endpoint,
1719+
EndpointConfigStepMetadata,
17191720
EndpointConfigSummary,
1721+
EndpointStepMetadata,
17201722
EndpointSummary,
17211723
Experiment,
17221724
ExperimentSummary,
@@ -1845,13 +1847,11 @@ import {
18451847
ListModelCardsRequest,
18461848
ListModelCardsResponse,
18471849
ListModelCardVersionsRequest,
1848-
ListModelCardVersionsResponse,
18491850
MetricData,
18501851
MetricSpecification,
18511852
ModelCardExportArtifacts,
18521853
ModelCardExportJobSummary,
18531854
ModelCardSummary,
1854-
ModelCardVersionSummary,
18551855
ModelPackageStatusDetails,
18561856
ModelPackageStatusItem,
18571857
MonitoringExecutionSummary,
@@ -1887,6 +1887,7 @@ import {
18871887
Workteam,
18881888
} from "../models/models_3";
18891889
import {
1890+
ListModelCardVersionsResponse,
18901891
ListModelExplainabilityJobDefinitionsRequest,
18911892
ListModelExplainabilityJobDefinitionsResponse,
18921893
ListModelMetadataRequest,
@@ -1955,6 +1956,7 @@ import {
19551956
ListWorkteamsResponse,
19561957
Model,
19571958
ModelCard,
1959+
ModelCardVersionSummary,
19581960
ModelDashboardEndpoint,
19591961
ModelDashboardIndicatorAction,
19601962
ModelDashboardModel,
@@ -21683,6 +21685,15 @@ const de_Endpoint = (output: any, context: __SerdeContext): Endpoint => {
2168321685
}) as any;
2168421686
};
2168521687

21688+
/**
21689+
* deserializeAws_json1_1EndpointConfigStepMetadata
21690+
*/
21691+
const de_EndpointConfigStepMetadata = (output: any, context: __SerdeContext): EndpointConfigStepMetadata => {
21692+
return take(output, {
21693+
Arn: __expectString,
21694+
}) as any;
21695+
};
21696+
2168621697
/**
2168721698
* deserializeAws_json1_1EndpointConfigSummary
2168821699
*/
@@ -21817,6 +21828,15 @@ const de_Endpoints = (output: any, context: __SerdeContext): EndpointInfo[] => {
2181721828
return retVal;
2181821829
};
2181921830

21831+
/**
21832+
* deserializeAws_json1_1EndpointStepMetadata
21833+
*/
21834+
const de_EndpointStepMetadata = (output: any, context: __SerdeContext): EndpointStepMetadata => {
21835+
return take(output, {
21836+
Arn: __expectString,
21837+
}) as any;
21838+
};
21839+
2182021840
/**
2182121841
* deserializeAws_json1_1EndpointSummary
2182221842
*/
@@ -26863,6 +26883,8 @@ const de_PipelineExecutionStepMetadata = (output: any, context: __SerdeContext):
2686326883
ClarifyCheck: (_: any) => de_ClarifyCheckStepMetadata(_, context),
2686426884
Condition: (_: any) => de_ConditionStepMetadata(_, context),
2686526885
EMR: (_: any) => de_EMRStepMetadata(_, context),
26886+
Endpoint: (_: any) => de_EndpointStepMetadata(_, context),
26887+
EndpointConfig: (_: any) => de_EndpointConfigStepMetadata(_, context),
2686626888
Fail: (_: any) => de_FailStepMetadata(_, context),
2686726889
Lambda: (_: any) => de_LambdaStepMetadata(_, context),
2686826890
Model: (_: any) => de_ModelStepMetadata(_, context),

0 commit comments

Comments
 (0)