Skip to content

Commit d7c4e6f

Browse files
author
awstools
committed
feat(client-sagemaker): Amazon SageMaker Training now provides model training container access for debugging purposes. Amazon SageMaker Search now provides the ability to use visibility conditions to limit resource access to a single domain or multiple domains.
1 parent 6325d6e commit d7c4e6f

File tree

9 files changed

+414
-184
lines changed

9 files changed

+414
-184
lines changed

clients/client-sagemaker/src/commands/CreateTrainingJobCommand.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -292,6 +292,9 @@ export interface CreateTrainingJobCommandOutput extends CreateTrainingJobRespons
292292
* RetryStrategy: { // RetryStrategy
293293
* MaximumRetryAttempts: Number("int"), // required
294294
* },
295+
* RemoteDebugConfig: { // RemoteDebugConfig
296+
* EnableRemoteDebug: true || false,
297+
* },
295298
* InfraCheckConfig: { // InfraCheckConfig
296299
* EnableInfraCheck: true || false,
297300
* },

clients/client-sagemaker/src/commands/DescribeTrainingJobCommand.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -276,6 +276,9 @@ export interface DescribeTrainingJobCommandOutput extends DescribeTrainingJobRes
276276
* // RetryStrategy: { // RetryStrategy
277277
* // MaximumRetryAttempts: Number("int"), // required
278278
* // },
279+
* // RemoteDebugConfig: { // RemoteDebugConfig
280+
* // EnableRemoteDebug: true || false,
281+
* // },
279282
* // InfraCheckConfig: { // InfraCheckConfig
280283
* // EnableInfraCheck: true || false,
281284
* // },

clients/client-sagemaker/src/commands/SearchCommand.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,12 @@ export interface SearchCommandOutput extends SearchResponse, __MetadataBearer {}
103103
* NextToken: "STRING_VALUE",
104104
* MaxResults: Number("int"),
105105
* CrossAccountFilterOption: "SameAccount" || "CrossAccount",
106+
* VisibilityConditions: [ // VisibilityConditionsList
107+
* { // VisibilityConditions
108+
* Key: "STRING_VALUE",
109+
* Value: "STRING_VALUE",
110+
* },
111+
* ],
106112
* };
107113
* const command = new SearchCommand(input);
108114
* const response = await client.send(command);

clients/client-sagemaker/src/commands/UpdateTrainingJobCommand.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,9 @@ export interface UpdateTrainingJobCommandOutput extends UpdateTrainingJobRespons
7171
* ResourceConfig: { // ResourceConfigForUpdate
7272
* KeepAlivePeriodInSeconds: Number("int"), // required
7373
* },
74+
* RemoteDebugConfig: { // RemoteDebugConfigForUpdate
75+
* EnableRemoteDebug: true || false,
76+
* },
7477
* };
7578
* const command = new UpdateTrainingJobCommand(input);
7679
* const response = await client.send(command);

clients/client-sagemaker/src/models/models_2.ts

Lines changed: 22 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -224,6 +224,20 @@ export interface ProfilerRuleConfiguration {
224224
RuleParameters?: Record<string, string>;
225225
}
226226

227+
/**
228+
* @public
229+
* <p>Configuration for remote debugging for the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingJob.html">CreateTrainingJob</a> API. To learn more about the remote
230+
* debugging functionality of SageMaker, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/train-remote-debugging.html">Access a training container through Amazon Web Services Systems Manager (SSM)
231+
* for remote debugging</a>.</p>
232+
*/
233+
export interface RemoteDebugConfig {
234+
/**
235+
* @public
236+
* <p>If set to True, enables remote debugging.</p>
237+
*/
238+
EnableRemoteDebug?: boolean;
239+
}
240+
227241
/**
228242
* @public
229243
* <p>Configuration of storage locations for the Amazon SageMaker Debugger TensorBoard output data.</p>
@@ -476,6 +490,14 @@ export interface CreateTrainingJobRequest {
476490
*/
477491
RetryStrategy?: RetryStrategy;
478492

493+
/**
494+
* @public
495+
* <p>Configuration for remote debugging. To learn more about the remote
496+
* debugging functionality of SageMaker, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/train-remote-debugging.html">Access a training container through Amazon Web Services Systems Manager (SSM)
497+
* for remote debugging</a>.</p>
498+
*/
499+
RemoteDebugConfig?: RemoteDebugConfig;
500+
479501
/**
480502
* @public
481503
* <p>Contains information about the infrastructure health check configuration for the training job.</p>
@@ -10002,30 +10024,6 @@ export interface DescribeTrainingJobRequest {
1000210024
TrainingJobName: string | undefined;
1000310025
}
1000410026

10005-
/**
10006-
* @public
10007-
* <p>The name, value, and date and time of a metric that was emitted to Amazon CloudWatch.</p>
10008-
*/
10009-
export interface MetricData {
10010-
/**
10011-
* @public
10012-
* <p>The name of the metric.</p>
10013-
*/
10014-
MetricName?: string;
10015-
10016-
/**
10017-
* @public
10018-
* <p>The value of the metric.</p>
10019-
*/
10020-
Value?: number;
10021-
10022-
/**
10023-
* @public
10024-
* <p>The date and time that the algorithm emitted the metric.</p>
10025-
*/
10026-
Timestamp?: Date;
10027-
}
10028-
1002910027
/**
1003010028
* @internal
1003110029
*/

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

Lines changed: 33 additions & 155 deletions
Original file line numberDiff line numberDiff line change
@@ -14,18 +14,15 @@ import {
1414
AssociationSummary,
1515
AutoMLCandidate,
1616
AutoMLJobStatus,
17-
AutoMLJobStepMetadata,
1817
AutoMLJobSummary,
1918
AutoMLSortBy,
2019
AutoMLSortOrder,
2120
BatchDataCaptureConfig,
2221
BatchStrategy,
23-
CallbackStepMetadata,
2422
CandidateSortBy,
2523
CandidateStatus,
2624
Channel,
2725
CheckpointConfig,
28-
ClarifyCheckStepMetadata,
2926
ClusterNodeSummary,
3027
ClusterSortBy,
3128
ClusterSummary,
@@ -35,7 +32,6 @@ import {
3532
CognitoConfig,
3633
CompilationJobStatus,
3734
CompilationJobSummary,
38-
ConditionStepMetadata,
3935
ContextSummary,
4036
MetadataProperties,
4137
ModelApprovalStatus,
@@ -113,7 +109,6 @@ import {
113109
LabelingJobStatus,
114110
LastUpdateStatus,
115111
MemberDefinition,
116-
MetricData,
117112
ModelArtifacts,
118113
ModelCardExportJobStatus,
119114
ModelClientConfig,
@@ -130,6 +125,7 @@ import {
130125
ProfilerRuleConfiguration,
131126
RecommendationJobStatus,
132127
RecommendationMetrics,
128+
RemoteDebugConfig,
133129
RuleEvaluationStatus,
134130
ScheduleStatus,
135131
SourceIpConfig,
@@ -141,6 +137,30 @@ import {
141137
TrialComponentStatus,
142138
} from "./models_2";
143139

140+
/**
141+
* @public
142+
* <p>The name, value, and date and time of a metric that was emitted to Amazon CloudWatch.</p>
143+
*/
144+
export interface MetricData {
145+
/**
146+
* @public
147+
* <p>The name of the metric.</p>
148+
*/
149+
MetricName?: string;
150+
151+
/**
152+
* @public
153+
* <p>The value of the metric.</p>
154+
*/
155+
Value?: number;
156+
157+
/**
158+
* @public
159+
* <p>The date and time that the algorithm emitted the metric.</p>
160+
*/
161+
Timestamp?: Date;
162+
}
163+
144164
/**
145165
* @public
146166
* <p>Information about the status of the rule evaluation.</p>
@@ -378,9 +398,6 @@ export interface SecondaryStatusTransition {
378398
* <dd>
379399
* <ul>
380400
* <li>
381-
* <p>Downloading the training image.</p>
382-
* </li>
383-
* <li>
384401
* <p>Training
385402
* image download completed. Training in
386403
* progress.</p>
@@ -931,6 +948,14 @@ export interface DescribeTrainingJobResponse {
931948
*/
932949
RetryStrategy?: RetryStrategy;
933950

951+
/**
952+
* @public
953+
* <p>Configuration for remote debugging. To learn more about the remote
954+
* debugging functionality of SageMaker, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/train-remote-debugging.html">Access a training container through Amazon Web Services Systems Manager (SSM)
955+
* for remote debugging</a>.</p>
956+
*/
957+
RemoteDebugConfig?: RemoteDebugConfig;
958+
934959
/**
935960
* @public
936961
* <p>Contains information about the infrastructure health check configuration for the training job.</p>
@@ -11091,150 +11116,3 @@ export interface TuningJobStepMetaData {
1109111116
*/
1109211117
Arn?: string;
1109311118
}
11094-
11095-
/**
11096-
* @public
11097-
* <p>Metadata for a step execution.</p>
11098-
*/
11099-
export interface PipelineExecutionStepMetadata {
11100-
/**
11101-
* @public
11102-
* <p>The Amazon Resource Name (ARN) of the training job that was run by this step execution.</p>
11103-
*/
11104-
TrainingJob?: TrainingJobStepMetadata;
11105-
11106-
/**
11107-
* @public
11108-
* <p>The Amazon Resource Name (ARN) of the processing job that was run by this step execution.</p>
11109-
*/
11110-
ProcessingJob?: ProcessingJobStepMetadata;
11111-
11112-
/**
11113-
* @public
11114-
* <p>The Amazon Resource Name (ARN) of the transform job that was run by this step execution.</p>
11115-
*/
11116-
TransformJob?: TransformJobStepMetadata;
11117-
11118-
/**
11119-
* @public
11120-
* <p>The Amazon Resource Name (ARN) of the tuning job that was run by this step execution.</p>
11121-
*/
11122-
TuningJob?: TuningJobStepMetaData;
11123-
11124-
/**
11125-
* @public
11126-
* <p>The Amazon Resource Name (ARN) of the model that was created by this step execution.</p>
11127-
*/
11128-
Model?: ModelStepMetadata;
11129-
11130-
/**
11131-
* @public
11132-
* <p>The Amazon Resource Name (ARN) of the model package that the model was registered to by this step execution.</p>
11133-
*/
11134-
RegisterModel?: RegisterModelStepMetadata;
11135-
11136-
/**
11137-
* @public
11138-
* <p>The outcome of the condition evaluation that was run by this step execution.</p>
11139-
*/
11140-
Condition?: ConditionStepMetadata;
11141-
11142-
/**
11143-
* @public
11144-
* <p>The URL of the Amazon SQS queue used by this step execution, the pipeline generated token,
11145-
* and a list of output parameters.</p>
11146-
*/
11147-
Callback?: CallbackStepMetadata;
11148-
11149-
/**
11150-
* @public
11151-
* <p>The Amazon Resource Name (ARN) of the Lambda function that was run by this step execution and a list of
11152-
* output parameters.</p>
11153-
*/
11154-
Lambda?: LambdaStepMetadata;
11155-
11156-
/**
11157-
* @public
11158-
* <p>The configurations and outcomes of an Amazon EMR step execution.</p>
11159-
*/
11160-
EMR?: EMRStepMetadata;
11161-
11162-
/**
11163-
* @public
11164-
* <p>The configurations and outcomes of the check step execution. This includes: </p>
11165-
* <ul>
11166-
* <li>
11167-
* <p>The type of the check conducted.</p>
11168-
* </li>
11169-
* <li>
11170-
* <p>The Amazon S3 URIs of baseline constraints and statistics files to be used for the drift check.</p>
11171-
* </li>
11172-
* <li>
11173-
* <p>The Amazon S3 URIs of newly calculated baseline constraints and statistics.</p>
11174-
* </li>
11175-
* <li>
11176-
* <p>The model package group name provided.</p>
11177-
* </li>
11178-
* <li>
11179-
* <p>The Amazon S3 URI of the violation report if violations detected.</p>
11180-
* </li>
11181-
* <li>
11182-
* <p>The Amazon Resource Name (ARN) of check processing job initiated by the step execution.</p>
11183-
* </li>
11184-
* <li>
11185-
* <p>The Boolean flags indicating if the drift check is skipped.</p>
11186-
* </li>
11187-
* <li>
11188-
* <p>If step property <code>BaselineUsedForDriftCheck</code> is set the same as
11189-
* <code>CalculatedBaseline</code>.</p>
11190-
* </li>
11191-
* </ul>
11192-
*/
11193-
QualityCheck?: QualityCheckStepMetadata;
11194-
11195-
/**
11196-
* @public
11197-
* <p>Container for the metadata for a Clarify check step. The configurations
11198-
* and outcomes of the check step execution. This includes: </p>
11199-
* <ul>
11200-
* <li>
11201-
* <p>The type of the check conducted,</p>
11202-
* </li>
11203-
* <li>
11204-
* <p>The Amazon S3 URIs of baseline constraints and statistics files to be used for the drift check.</p>
11205-
* </li>
11206-
* <li>
11207-
* <p>The Amazon S3 URIs of newly calculated baseline constraints and statistics.</p>
11208-
* </li>
11209-
* <li>
11210-
* <p>The model package group name provided.</p>
11211-
* </li>
11212-
* <li>
11213-
* <p>The Amazon S3 URI of the violation report if violations detected.</p>
11214-
* </li>
11215-
* <li>
11216-
* <p>The Amazon Resource Name (ARN) of check processing job initiated by the step execution.</p>
11217-
* </li>
11218-
* <li>
11219-
* <p>The boolean flags indicating if the drift check is skipped.</p>
11220-
* </li>
11221-
* <li>
11222-
* <p>If step property <code>BaselineUsedForDriftCheck</code> is set the same as
11223-
* <code>CalculatedBaseline</code>.</p>
11224-
* </li>
11225-
* </ul>
11226-
*/
11227-
ClarifyCheck?: ClarifyCheckStepMetadata;
11228-
11229-
/**
11230-
* @public
11231-
* <p>The configurations and outcomes of a Fail step execution.</p>
11232-
*/
11233-
Fail?: FailStepMetadata;
11234-
11235-
/**
11236-
* @public
11237-
* <p>The Amazon Resource Name (ARN) of the AutoML job that was run by this step.</p>
11238-
*/
11239-
AutoMLJob?: AutoMLJobStepMetadata;
11240-
}

0 commit comments

Comments
 (0)