Skip to content

Commit 3ed9c12

Browse files
author
awstools
committed
feat(client-sagemaker): Add maintenance status field to DescribeMlflowTrackingServer API response
1 parent a08e51d commit 3ed9c12

File tree

8 files changed

+114
-61
lines changed

8 files changed

+114
-61
lines changed

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,7 @@ export interface DescribeMlflowTrackingServerCommandOutput
5353
* // MlflowVersion: "STRING_VALUE",
5454
* // RoleArn: "STRING_VALUE",
5555
* // TrackingServerStatus: "Creating" || "Created" || "CreateFailed" || "Updating" || "Updated" || "UpdateFailed" || "Deleting" || "DeleteFailed" || "Stopping" || "Stopped" || "StopFailed" || "Starting" || "Started" || "StartFailed" || "MaintenanceInProgress" || "MaintenanceComplete" || "MaintenanceFailed",
56+
* // TrackingServerMaintenanceStatus: "MaintenanceInProgress" || "MaintenanceComplete" || "MaintenanceFailed",
5657
* // IsActive: "Active" || "Inactive",
5758
* // TrackingServerUrl: "STRING_VALUE",
5859
* // WeeklyMaintenanceWindowStart: "STRING_VALUE",

‎clients/client-sagemaker/src/commands/ListCompilationJobsCommand.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 { ListCompilationJobsRequest, ListCompilationJobsResponse } from "../models/models_3";
8+
import { ListCompilationJobsRequest } from "../models/models_3";
9+
import { ListCompilationJobsResponse } from "../models/models_4";
910
import { de_ListCompilationJobsCommand, se_ListCompilationJobsCommand } from "../protocols/Aws_json1_1";
1011
import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient";
1112

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

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,7 @@ 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 { StopInferenceExperimentRequest } from "../models/models_4";
9-
import { StopInferenceExperimentResponse } from "../models/models_5";
8+
import { StopInferenceExperimentRequest, StopInferenceExperimentResponse } from "../models/models_5";
109
import { de_StopInferenceExperimentCommand, se_StopInferenceExperimentCommand } from "../protocols/Aws_json1_1";
1110
import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient";
1211

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

Lines changed: 22 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,6 @@ import {
3939
CodeRepositorySummary,
4040
CognitoConfig,
4141
CompilationJobStatus,
42-
CompilationJobSummary,
4342
InferenceSpecification,
4443
ModelApprovalStatus,
4544
ModelPackageStatus,
@@ -2213,6 +2212,22 @@ export const IsTrackingServerActive = {
22132212
*/
22142213
export type IsTrackingServerActive = (typeof IsTrackingServerActive)[keyof typeof IsTrackingServerActive];
22152214

2215+
/**
2216+
* @public
2217+
* @enum
2218+
*/
2219+
export const TrackingServerMaintenanceStatus = {
2220+
MAINTENANCE_COMPLETE: "MaintenanceComplete",
2221+
MAINTENANCE_FAILED: "MaintenanceFailed",
2222+
MAINTENANCE_IN_PROGRESS: "MaintenanceInProgress",
2223+
} as const;
2224+
2225+
/**
2226+
* @public
2227+
*/
2228+
export type TrackingServerMaintenanceStatus =
2229+
(typeof TrackingServerMaintenanceStatus)[keyof typeof TrackingServerMaintenanceStatus];
2230+
22162231
/**
22172232
* @public
22182233
* @enum
@@ -2288,6 +2303,12 @@ export interface DescribeMlflowTrackingServerResponse {
22882303
*/
22892304
TrackingServerStatus?: TrackingServerStatus | undefined;
22902305

2306+
/**
2307+
* <p> The current maintenance status of the described MLflow Tracking Server. </p>
2308+
* @public
2309+
*/
2310+
TrackingServerMaintenanceStatus?: TrackingServerMaintenanceStatus | undefined;
2311+
22912312
/**
22922313
* <p>Whether the described MLflow Tracking Server is currently active.</p>
22932314
* @public
@@ -10380,23 +10401,6 @@ export interface ListCompilationJobsRequest {
1038010401
SortOrder?: SortOrder | undefined;
1038110402
}
1038210403

10383-
/**
10384-
* @public
10385-
*/
10386-
export interface ListCompilationJobsResponse {
10387-
/**
10388-
* <p>An array of <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CompilationJobSummary.html">CompilationJobSummary</a> objects, each describing a model compilation job. </p>
10389-
* @public
10390-
*/
10391-
CompilationJobSummaries: CompilationJobSummary[] | undefined;
10392-
10393-
/**
10394-
* <p>If the response is truncated, Amazon SageMaker AI returns this <code>NextToken</code>. To retrieve the next set of model compilation jobs, use this token in the next request.</p>
10395-
* @public
10396-
*/
10397-
NextToken?: string | undefined;
10398-
}
10399-
1040010404
/**
1040110405
* @internal
1040210406
*/

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

Lines changed: 18 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ import {
1515
Channel,
1616
CheckpointConfig,
1717
ClarifyCheckStepMetadata,
18+
CompilationJobSummary,
1819
ComputeQuotaSummary,
1920
ConditionStepMetadata,
2021
InferenceSpecification,
@@ -49,7 +50,6 @@ import {
4950
ModelPackageModelCardFilterSensitiveLog,
5051
ModelPackageSecurityConfig,
5152
ModelPackageValidationSpecification,
52-
ModelVariantConfig,
5353
RetryStrategy,
5454
SkipModelValidation,
5555
SourceAlgorithmSpecification,
@@ -142,7 +142,6 @@ import {
142142
InferenceComponentStatus,
143143
InferenceComponentSummary,
144144
InferenceExperimentStatus,
145-
InferenceExperimentStopDesiredState,
146145
InferenceExperimentSummary,
147146
InferenceRecommendationsJob,
148147
InferenceRecommendationsJobStep,
@@ -193,6 +192,23 @@ import {
193192
Workteam,
194193
} from "./models_3";
195194

195+
/**
196+
* @public
197+
*/
198+
export interface ListCompilationJobsResponse {
199+
/**
200+
* <p>An array of <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CompilationJobSummary.html">CompilationJobSummary</a> objects, each describing a model compilation job. </p>
201+
* @public
202+
*/
203+
CompilationJobSummaries: CompilationJobSummary[] | undefined;
204+
205+
/**
206+
* <p>If the response is truncated, Amazon SageMaker AI returns this <code>NextToken</code>. To retrieve the next set of model compilation jobs, use this token in the next request.</p>
207+
* @public
208+
*/
209+
NextToken?: string | undefined;
210+
}
211+
196212
/**
197213
* @public
198214
* @enum
@@ -10092,41 +10108,6 @@ export interface StopHyperParameterTuningJobRequest {
1009210108
HyperParameterTuningJobName: string | undefined;
1009310109
}
1009410110

10095-
/**
10096-
* @public
10097-
*/
10098-
export interface StopInferenceExperimentRequest {
10099-
/**
10100-
* <p>The name of the inference experiment to stop.</p>
10101-
* @public
10102-
*/
10103-
Name: string | undefined;
10104-
10105-
/**
10106-
* <p> Array of key-value pairs, with names of variants mapped to actions. The possible actions are the following: </p> <ul> <li> <p> <code>Promote</code> - Promote the shadow variant to a production variant</p> </li> <li> <p> <code>Remove</code> - Delete the variant</p> </li> <li> <p> <code>Retain</code> - Keep the variant as it is</p> </li> </ul>
10107-
* @public
10108-
*/
10109-
ModelVariantActions: Record<string, ModelVariantAction> | undefined;
10110-
10111-
/**
10112-
* <p> An array of <code>ModelVariantConfig</code> objects. There is one for each variant that you want to deploy after the inference experiment stops. Each <code>ModelVariantConfig</code> describes the infrastructure configuration for deploying the corresponding variant. </p>
10113-
* @public
10114-
*/
10115-
DesiredModelVariants?: ModelVariantConfig[] | undefined;
10116-
10117-
/**
10118-
* <p> The desired state of the experiment after stopping. The possible states are the following: </p> <ul> <li> <p> <code>Completed</code>: The experiment completed successfully</p> </li> <li> <p> <code>Cancelled</code>: The experiment was canceled</p> </li> </ul>
10119-
* @public
10120-
*/
10121-
DesiredState?: InferenceExperimentStopDesiredState | undefined;
10122-
10123-
/**
10124-
* <p>The reason for stopping the experiment.</p>
10125-
* @public
10126-
*/
10127-
Reason?: string | undefined;
10128-
}
10129-
1013010111
/**
1013110112
* @internal
1013210113
*/

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

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,12 +83,14 @@ import {
8383
GitConfigForUpdate,
8484
HubContentSupportStatus,
8585
InferenceComponentDeploymentConfig,
86+
InferenceExperimentStopDesiredState,
8687
ResourceType,
8788
Workforce,
8889
Workteam,
8990
} from "./models_3";
9091

9192
import {
93+
ModelVariantAction,
9294
NestedFilters,
9395
OnlineStoreConfigUpdate,
9496
ProfilerConfigForUpdate,
@@ -98,6 +100,41 @@ import {
98100
VisibilityConditions,
99101
} from "./models_4";
100102

103+
/**
104+
* @public
105+
*/
106+
export interface StopInferenceExperimentRequest {
107+
/**
108+
* <p>The name of the inference experiment to stop.</p>
109+
* @public
110+
*/
111+
Name: string | undefined;
112+
113+
/**
114+
* <p> Array of key-value pairs, with names of variants mapped to actions. The possible actions are the following: </p> <ul> <li> <p> <code>Promote</code> - Promote the shadow variant to a production variant</p> </li> <li> <p> <code>Remove</code> - Delete the variant</p> </li> <li> <p> <code>Retain</code> - Keep the variant as it is</p> </li> </ul>
115+
* @public
116+
*/
117+
ModelVariantActions: Record<string, ModelVariantAction> | undefined;
118+
119+
/**
120+
* <p> An array of <code>ModelVariantConfig</code> objects. There is one for each variant that you want to deploy after the inference experiment stops. Each <code>ModelVariantConfig</code> describes the infrastructure configuration for deploying the corresponding variant. </p>
121+
* @public
122+
*/
123+
DesiredModelVariants?: ModelVariantConfig[] | undefined;
124+
125+
/**
126+
* <p> The desired state of the experiment after stopping. The possible states are the following: </p> <ul> <li> <p> <code>Completed</code>: The experiment completed successfully</p> </li> <li> <p> <code>Cancelled</code>: The experiment was canceled</p> </li> </ul>
127+
* @public
128+
*/
129+
DesiredState?: InferenceExperimentStopDesiredState | undefined;
130+
131+
/**
132+
* <p>The reason for stopping the experiment.</p>
133+
* @public
134+
*/
135+
Reason?: string | undefined;
136+
}
137+
101138
/**
102139
* @public
103140
*/

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

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1896,7 +1896,6 @@ import {
18961896
ListCodeRepositoriesInput,
18971897
ListCodeRepositoriesOutput,
18981898
ListCompilationJobsRequest,
1899-
ListCompilationJobsResponse,
19001899
MetricData,
19011900
MetricSpecification,
19021901
ModelCardExportArtifacts,
@@ -1941,6 +1940,7 @@ import {
19411940
Workteam,
19421941
} from "../models/models_3";
19431942
import {
1943+
ListCompilationJobsResponse,
19441944
ListComputeQuotasRequest,
19451945
ListComputeQuotasResponse,
19461946
ListContextsRequest,
@@ -2165,7 +2165,6 @@ import {
21652165
StopEdgeDeploymentStageRequest,
21662166
StopEdgePackagingJobRequest,
21672167
StopHyperParameterTuningJobRequest,
2168-
StopInferenceExperimentRequest,
21692168
StudioLifecycleConfigDetails,
21702169
TotalHits,
21712170
TrackingServerSummary,
@@ -2193,6 +2192,7 @@ import {
21932192
SearchExpression,
21942193
SearchRequest,
21952194
ServiceCatalogProvisioningUpdateDetails,
2195+
StopInferenceExperimentRequest,
21962196
StopInferenceExperimentResponse,
21972197
StopInferenceRecommendationsJobRequest,
21982198
StopLabelingJobRequest,
@@ -21994,6 +21994,7 @@ const de_DescribeMlflowTrackingServerResponse = (
2199421994
MlflowVersion: __expectString,
2199521995
RoleArn: __expectString,
2199621996
TrackingServerArn: __expectString,
21997+
TrackingServerMaintenanceStatus: __expectString,
2199721998
TrackingServerName: __expectString,
2199821999
TrackingServerSize: __expectString,
2199922000
TrackingServerStatus: __expectString,

‎codegen/sdk-codegen/aws-models/sagemaker.json

Lines changed: 30 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24085,6 +24085,12 @@
2408524085
"smithy.api#documentation": "<p>The current creation status of the described MLflow Tracking Server.</p>"
2408624086
}
2408724087
},
24088+
"TrackingServerMaintenanceStatus": {
24089+
"target": "com.amazonaws.sagemaker#TrackingServerMaintenanceStatus",
24090+
"traits": {
24091+
"smithy.api#documentation": "<p> The current maintenance status of the described MLflow Tracking Server. </p>"
24092+
}
24093+
},
2408824094
"IsActive": {
2408924095
"target": "com.amazonaws.sagemaker#IsTrackingServerActive",
2409024096
"traits": {
@@ -60464,7 +60470,7 @@
6046460470
"type": "integer",
6046560471
"traits": {
6046660472
"smithy.api#range": {
60467-
"min": 1,
60473+
"min": 0,
6046860474
"max": 256
6046960475
}
6047060476
}
@@ -68633,6 +68639,29 @@
6863368639
"smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:mlflow-tracking-server/"
6863468640
}
6863568641
},
68642+
"com.amazonaws.sagemaker#TrackingServerMaintenanceStatus": {
68643+
"type": "enum",
68644+
"members": {
68645+
"MAINTENANCE_IN_PROGRESS": {
68646+
"target": "smithy.api#Unit",
68647+
"traits": {
68648+
"smithy.api#enumValue": "MaintenanceInProgress"
68649+
}
68650+
},
68651+
"MAINTENANCE_COMPLETE": {
68652+
"target": "smithy.api#Unit",
68653+
"traits": {
68654+
"smithy.api#enumValue": "MaintenanceComplete"
68655+
}
68656+
},
68657+
"MAINTENANCE_FAILED": {
68658+
"target": "smithy.api#Unit",
68659+
"traits": {
68660+
"smithy.api#enumValue": "MaintenanceFailed"
68661+
}
68662+
}
68663+
}
68664+
},
6863668665
"com.amazonaws.sagemaker#TrackingServerName": {
6863768666
"type": "string",
6863868667
"traits": {

0 commit comments

Comments
 (0)