@aws-sdk/client-sagemaker 3.806.0 → 3.810.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -16
- package/dist-cjs/index.js +26 -26
- package/dist-es/waiters/waitForEndpointDeleted.js +2 -2
- package/dist-es/waiters/waitForEndpointInService.js +2 -2
- package/dist-es/waiters/waitForImageCreated.js +2 -2
- package/dist-es/waiters/waitForImageDeleted.js +2 -2
- package/dist-es/waiters/waitForImageUpdated.js +2 -2
- package/dist-es/waiters/waitForImageVersionCreated.js +2 -2
- package/dist-es/waiters/waitForImageVersionDeleted.js +2 -2
- package/dist-es/waiters/waitForNotebookInstanceDeleted.js +2 -2
- package/dist-es/waiters/waitForNotebookInstanceInService.js +2 -2
- package/dist-es/waiters/waitForNotebookInstanceStopped.js +2 -2
- package/dist-es/waiters/waitForProcessingJobCompletedOrStopped.js +2 -2
- package/dist-es/waiters/waitForTrainingJobCompletedOrStopped.js +2 -2
- package/dist-es/waiters/waitForTransformJobCompletedOrStopped.js +2 -2
- package/dist-types/SageMaker.d.ts +1 -16
- package/dist-types/SageMakerClient.d.ts +1 -16
- package/dist-types/commands/AddAssociationCommand.d.ts +2 -7
- package/dist-types/commands/AddTagsCommand.d.ts +1 -26
- package/dist-types/commands/AssociateTrialComponentCommand.d.ts +2 -4
- package/dist-types/commands/BatchDeleteClusterNodesCommand.d.ts +1 -17
- package/dist-types/commands/CreateActionCommand.d.ts +2 -7
- package/dist-types/commands/CreateAppCommand.d.ts +2 -6
- package/dist-types/commands/CreateAppImageConfigCommand.d.ts +1 -3
- package/dist-types/commands/CreateArtifactCommand.d.ts +2 -7
- package/dist-types/commands/CreateAutoMLJobCommand.d.ts +2 -26
- package/dist-types/commands/CreateAutoMLJobV2Command.d.ts +2 -33
- package/dist-types/commands/CreateClusterCommand.d.ts +2 -6
- package/dist-types/commands/CreateClusterSchedulerConfigCommand.d.ts +3 -7
- package/dist-types/commands/CreateCodeRepositoryCommand.d.ts +1 -7
- package/dist-types/commands/CreateCompilationJobCommand.d.ts +2 -33
- package/dist-types/commands/CreateComputeQuotaCommand.d.ts +3 -7
- package/dist-types/commands/CreateContextCommand.d.ts +2 -7
- package/dist-types/commands/CreateDataQualityJobDefinitionCommand.d.ts +2 -5
- package/dist-types/commands/CreateDeviceFleetCommand.d.ts +1 -2
- package/dist-types/commands/CreateDomainCommand.d.ts +2 -46
- package/dist-types/commands/CreateEdgeDeploymentPlanCommand.d.ts +2 -4
- package/dist-types/commands/CreateEdgeDeploymentStageCommand.d.ts +1 -2
- package/dist-types/commands/CreateEdgePackagingJobCommand.d.ts +1 -2
- package/dist-types/commands/CreateEndpointCommand.d.ts +2 -77
- package/dist-types/commands/CreateEndpointConfigCommand.d.ts +2 -33
- package/dist-types/commands/CreateExperimentCommand.d.ts +2 -22
- package/dist-types/commands/CreateFeatureGroupCommand.d.ts +2 -20
- package/dist-types/commands/CreateFlowDefinitionCommand.d.ts +1 -2
- package/dist-types/commands/CreateHubCommand.d.ts +1 -2
- package/dist-types/commands/CreateHubContentReferenceCommand.d.ts +1 -2
- package/dist-types/commands/CreateHumanTaskUiCommand.d.ts +1 -2
- package/dist-types/commands/CreateHyperParameterTuningJobCommand.d.ts +2 -18
- package/dist-types/commands/CreateImageCommand.d.ts +2 -5
- package/dist-types/commands/CreateImageVersionCommand.d.ts +2 -4
- package/dist-types/commands/CreateInferenceComponentCommand.d.ts +2 -10
- package/dist-types/commands/CreateInferenceExperimentCommand.d.ts +2 -17
- package/dist-types/commands/CreateInferenceRecommendationsJobCommand.d.ts +2 -4
- package/dist-types/commands/CreateLabelingJobCommand.d.ts +2 -40
- package/dist-types/commands/CreateMlflowTrackingServerCommand.d.ts +2 -5
- package/dist-types/commands/CreateModelBiasJobDefinitionCommand.d.ts +1 -2
- package/dist-types/commands/CreateModelCardCommand.d.ts +3 -6
- package/dist-types/commands/CreateModelCardExportJobCommand.d.ts +2 -4
- package/dist-types/commands/CreateModelCommand.d.ts +2 -19
- package/dist-types/commands/CreateModelExplainabilityJobDefinitionCommand.d.ts +1 -2
- package/dist-types/commands/CreateModelPackageCommand.d.ts +3 -24
- package/dist-types/commands/CreateModelPackageGroupCommand.d.ts +1 -2
- package/dist-types/commands/CreateModelQualityJobDefinitionCommand.d.ts +2 -5
- package/dist-types/commands/CreateMonitoringScheduleCommand.d.ts +2 -4
- package/dist-types/commands/CreateNotebookInstanceCommand.d.ts +2 -38
- package/dist-types/commands/CreateNotebookInstanceLifecycleConfigCommand.d.ts +2 -16
- package/dist-types/commands/CreateOptimizationJobCommand.d.ts +2 -8
- package/dist-types/commands/CreatePartnerAppCommand.d.ts +2 -4
- package/dist-types/commands/CreatePipelineCommand.d.ts +2 -4
- package/dist-types/commands/CreatePresignedDomainUrlCommand.d.ts +1 -26
- package/dist-types/commands/CreatePresignedMlflowTrackingServerUrlCommand.d.ts +1 -2
- package/dist-types/commands/CreatePresignedNotebookInstanceUrlCommand.d.ts +1 -18
- package/dist-types/commands/CreateProcessingJobCommand.d.ts +1 -2
- package/dist-types/commands/CreateProjectCommand.d.ts +2 -4
- package/dist-types/commands/CreateSpaceCommand.d.ts +1 -2
- package/dist-types/commands/CreateTrainingJobCommand.d.ts +2 -88
- package/dist-types/commands/CreateTrainingPlanCommand.d.ts +2 -63
- package/dist-types/commands/CreateTransformJobCommand.d.ts +2 -37
- package/dist-types/commands/CreateTrialCommand.d.ts +2 -13
- package/dist-types/commands/CreateTrialComponentCommand.d.ts +2 -12
- package/dist-types/commands/CreateUserProfileCommand.d.ts +2 -9
- package/dist-types/commands/CreateWorkforceCommand.d.ts +1 -18
- package/dist-types/commands/CreateWorkteamCommand.d.ts +2 -6
- package/dist-types/commands/DeleteAlgorithmCommand.d.ts +1 -2
- package/dist-types/commands/DeleteArtifactCommand.d.ts +1 -2
- package/dist-types/commands/DeleteClusterCommand.d.ts +1 -2
- package/dist-types/commands/DeleteCompilationJobCommand.d.ts +1 -8
- package/dist-types/commands/DeleteDomainCommand.d.ts +1 -4
- package/dist-types/commands/DeleteEdgeDeploymentPlanCommand.d.ts +1 -2
- package/dist-types/commands/DeleteEdgeDeploymentStageCommand.d.ts +1 -2
- package/dist-types/commands/DeleteEndpointCommand.d.ts +1 -11
- package/dist-types/commands/DeleteEndpointConfigCommand.d.ts +1 -9
- package/dist-types/commands/DeleteExperimentCommand.d.ts +1 -3
- package/dist-types/commands/DeleteFeatureGroupCommand.d.ts +1 -8
- package/dist-types/commands/DeleteHumanTaskUiCommand.d.ts +1 -5
- package/dist-types/commands/DeleteHyperParameterTuningJobCommand.d.ts +1 -4
- package/dist-types/commands/DeleteImageCommand.d.ts +1 -2
- package/dist-types/commands/DeleteImageVersionCommand.d.ts +1 -2
- package/dist-types/commands/DeleteInferenceExperimentCommand.d.ts +2 -9
- package/dist-types/commands/DeleteModelCardCommand.d.ts +1 -2
- package/dist-types/commands/DeleteModelCommand.d.ts +1 -4
- package/dist-types/commands/DeleteModelPackageCommand.d.ts +2 -6
- package/dist-types/commands/DeleteModelPackageGroupCommand.d.ts +1 -2
- package/dist-types/commands/DeleteMonitoringScheduleCommand.d.ts +1 -2
- package/dist-types/commands/DeleteNotebookInstanceCommand.d.ts +1 -6
- package/dist-types/commands/DeletePartnerAppCommand.d.ts +1 -2
- package/dist-types/commands/DeletePipelineCommand.d.ts +2 -6
- package/dist-types/commands/DeleteProjectCommand.d.ts +1 -2
- package/dist-types/commands/DeleteStudioLifecycleConfigCommand.d.ts +1 -4
- package/dist-types/commands/DeleteTagsCommand.d.ts +1 -12
- package/dist-types/commands/DeleteTrialCommand.d.ts +1 -3
- package/dist-types/commands/DeleteTrialComponentCommand.d.ts +1 -3
- package/dist-types/commands/DeleteUserProfileCommand.d.ts +1 -2
- package/dist-types/commands/DeleteWorkforceCommand.d.ts +1 -12
- package/dist-types/commands/DeleteWorkteamCommand.d.ts +1 -2
- package/dist-types/commands/DescribeAutoMLJobCommand.d.ts +1 -5
- package/dist-types/commands/DescribeAutoMLJobV2Command.d.ts +1 -2
- package/dist-types/commands/DescribeClusterNodeCommand.d.ts +1 -2
- package/dist-types/commands/DescribeClusterSchedulerConfigCommand.d.ts +1 -3
- package/dist-types/commands/DescribeCompilationJobCommand.d.ts +1 -3
- package/dist-types/commands/DescribeEndpointConfigCommand.d.ts +1 -2
- package/dist-types/commands/DescribeFeatureGroupCommand.d.ts +1 -3
- package/dist-types/commands/DescribeHyperParameterTuningJobCommand.d.ts +1 -3
- package/dist-types/commands/DescribeInferenceRecommendationsJobCommand.d.ts +1 -2
- package/dist-types/commands/DescribeLineageGroupCommand.d.ts +1 -3
- package/dist-types/commands/DescribeModelCommand.d.ts +1 -2
- package/dist-types/commands/DescribeModelPackageCommand.d.ts +1 -8
- package/dist-types/commands/DescribeNotebookInstanceLifecycleConfigCommand.d.ts +1 -3
- package/dist-types/commands/DescribeSubscribedWorkteamCommand.d.ts +1 -2
- package/dist-types/commands/DescribeTrainingJobCommand.d.ts +1 -7
- package/dist-types/commands/DescribeUserProfileCommand.d.ts +1 -2
- package/dist-types/commands/DescribeWorkforceCommand.d.ts +1 -6
- package/dist-types/commands/DescribeWorkteamCommand.d.ts +1 -3
- package/dist-types/commands/DisableSagemakerServicecatalogPortfolioCommand.d.ts +1 -2
- package/dist-types/commands/DisassociateTrialComponentCommand.d.ts +1 -6
- package/dist-types/commands/EnableSagemakerServicecatalogPortfolioCommand.d.ts +1 -2
- package/dist-types/commands/GetModelPackageGroupPolicyCommand.d.ts +1 -4
- package/dist-types/commands/GetSagemakerServicecatalogPortfolioStatusCommand.d.ts +1 -2
- package/dist-types/commands/GetScalingConfigurationRecommendationCommand.d.ts +1 -2
- package/dist-types/commands/GetSearchSuggestionsCommand.d.ts +1 -4
- package/dist-types/commands/ImportHubContentCommand.d.ts +1 -2
- package/dist-types/commands/ListAppImageConfigsCommand.d.ts +1 -3
- package/dist-types/commands/ListClusterNodesCommand.d.ts +1 -2
- package/dist-types/commands/ListCompilationJobsCommand.d.ts +1 -3
- package/dist-types/commands/ListExperimentsCommand.d.ts +1 -3
- package/dist-types/commands/ListHyperParameterTuningJobsCommand.d.ts +1 -3
- package/dist-types/commands/ListImageVersionsCommand.d.ts +1 -2
- package/dist-types/commands/ListImagesCommand.d.ts +1 -2
- package/dist-types/commands/ListInferenceRecommendationsJobStepsCommand.d.ts +1 -2
- package/dist-types/commands/ListLineageGroupsCommand.d.ts +1 -3
- package/dist-types/commands/ListModelMetadataCommand.d.ts +1 -2
- package/dist-types/commands/ListNotebookInstancesCommand.d.ts +1 -2
- package/dist-types/commands/ListResourceCatalogsCommand.d.ts +1 -2
- package/dist-types/commands/ListStageDevicesCommand.d.ts +1 -2
- package/dist-types/commands/ListStudioLifecycleConfigsCommand.d.ts +1 -2
- package/dist-types/commands/ListSubscribedWorkteamsCommand.d.ts +1 -3
- package/dist-types/commands/ListTrainingJobsCommand.d.ts +1 -22
- package/dist-types/commands/ListTrainingJobsForHyperParameterTuningJobCommand.d.ts +1 -2
- package/dist-types/commands/ListTrialComponentsCommand.d.ts +1 -20
- package/dist-types/commands/ListTrialsCommand.d.ts +1 -5
- package/dist-types/commands/ListWorkforcesCommand.d.ts +1 -2
- package/dist-types/commands/ListWorkteamsCommand.d.ts +1 -3
- package/dist-types/commands/PutModelPackageGroupPolicyCommand.d.ts +2 -6
- package/dist-types/commands/QueryLineageCommand.d.ts +1 -3
- package/dist-types/commands/RegisterDevicesCommand.d.ts +1 -2
- package/dist-types/commands/RetryPipelineExecutionCommand.d.ts +2 -4
- package/dist-types/commands/SearchCommand.d.ts +1 -10
- package/dist-types/commands/SearchTrainingPlanOfferingsCommand.d.ts +2 -17
- package/dist-types/commands/SendPipelineExecutionStepFailureCommand.d.ts +3 -7
- package/dist-types/commands/SendPipelineExecutionStepSuccessCommand.d.ts +3 -7
- package/dist-types/commands/StartInferenceExperimentCommand.d.ts +1 -2
- package/dist-types/commands/StartMlflowTrackingServerCommand.d.ts +1 -2
- package/dist-types/commands/StartMonitoringScheduleCommand.d.ts +1 -5
- package/dist-types/commands/StartNotebookInstanceCommand.d.ts +2 -6
- package/dist-types/commands/StartPipelineExecutionCommand.d.ts +2 -4
- package/dist-types/commands/StopCompilationJobCommand.d.ts +1 -7
- package/dist-types/commands/StopHyperParameterTuningJobCommand.d.ts +1 -7
- package/dist-types/commands/StopInferenceExperimentCommand.d.ts +1 -2
- package/dist-types/commands/StopLabelingJobCommand.d.ts +1 -2
- package/dist-types/commands/StopMlflowTrackingServerCommand.d.ts +1 -2
- package/dist-types/commands/StopNotebookInstanceCommand.d.ts +1 -8
- package/dist-types/commands/StopPipelineExecutionCommand.d.ts +2 -25
- package/dist-types/commands/StopTrainingJobCommand.d.ts +1 -7
- package/dist-types/commands/StopTransformJobCommand.d.ts +1 -6
- package/dist-types/commands/UpdateActionCommand.d.ts +1 -2
- package/dist-types/commands/UpdateArtifactCommand.d.ts +1 -2
- package/dist-types/commands/UpdateClusterCommand.d.ts +2 -4
- package/dist-types/commands/UpdateClusterSchedulerConfigCommand.d.ts +2 -4
- package/dist-types/commands/UpdateClusterSoftwareCommand.d.ts +2 -9
- package/dist-types/commands/UpdateCodeRepositoryCommand.d.ts +1 -2
- package/dist-types/commands/UpdateComputeQuotaCommand.d.ts +2 -4
- package/dist-types/commands/UpdateContextCommand.d.ts +1 -2
- package/dist-types/commands/UpdateDomainCommand.d.ts +1 -2
- package/dist-types/commands/UpdateEndpointCommand.d.ts +2 -22
- package/dist-types/commands/UpdateEndpointWeightsAndCapacitiesCommand.d.ts +2 -7
- package/dist-types/commands/UpdateExperimentCommand.d.ts +2 -4
- package/dist-types/commands/UpdateFeatureGroupCommand.d.ts +2 -17
- package/dist-types/commands/UpdateHubContentCommand.d.ts +1 -36
- package/dist-types/commands/UpdateHubContentReferenceCommand.d.ts +1 -14
- package/dist-types/commands/UpdateImageCommand.d.ts +1 -2
- package/dist-types/commands/UpdateInferenceComponentCommand.d.ts +1 -2
- package/dist-types/commands/UpdateInferenceComponentRuntimeConfigCommand.d.ts +1 -2
- package/dist-types/commands/UpdateInferenceExperimentCommand.d.ts +2 -7
- package/dist-types/commands/UpdateMlflowTrackingServerCommand.d.ts +2 -4
- package/dist-types/commands/UpdateModelCardCommand.d.ts +3 -8
- package/dist-types/commands/UpdateModelPackageCommand.d.ts +1 -2
- package/dist-types/commands/UpdateMonitoringAlertCommand.d.ts +1 -2
- package/dist-types/commands/UpdateMonitoringScheduleCommand.d.ts +1 -2
- package/dist-types/commands/UpdateNotebookInstanceCommand.d.ts +2 -5
- package/dist-types/commands/UpdateNotebookInstanceLifecycleConfigCommand.d.ts +1 -2
- package/dist-types/commands/UpdatePartnerAppCommand.d.ts +2 -3
- package/dist-types/commands/UpdatePipelineCommand.d.ts +1 -2
- package/dist-types/commands/UpdatePipelineExecutionCommand.d.ts +1 -2
- package/dist-types/commands/UpdateProjectCommand.d.ts +2 -10
- package/dist-types/commands/UpdateSpaceCommand.d.ts +2 -6
- package/dist-types/commands/UpdateTrainingJobCommand.d.ts +2 -4
- package/dist-types/commands/UpdateTrialCommand.d.ts +1 -2
- package/dist-types/commands/UpdateTrialComponentCommand.d.ts +1 -2
- package/dist-types/commands/UpdateUserProfileCommand.d.ts +1 -2
- package/dist-types/commands/UpdateWorkforceCommand.d.ts +2 -28
- package/dist-types/commands/UpdateWorkteamCommand.d.ts +1 -2
- package/dist-types/index.d.ts +1 -16
- package/dist-types/models/models_0.d.ts +370 -4018
- package/dist-types/models/models_1.d.ts +532 -5722
- package/dist-types/models/models_2.d.ts +328 -1436
- package/dist-types/models/models_3.d.ts +364 -2021
- package/dist-types/models/models_4.d.ts +462 -1693
- package/dist-types/models/models_5.d.ts +90 -441
- package/package.json +17 -17
|
@@ -235,8 +235,7 @@ export interface DescribeHubContentResponse {
|
|
|
235
235
|
*/
|
|
236
236
|
export interface DescribeHumanTaskUiRequest {
|
|
237
237
|
/**
|
|
238
|
-
* <p>The name of the human task user interface
|
|
239
|
-
* (worker task template) you want information about.</p>
|
|
238
|
+
* <p>The name of the human task user interface (worker task template) you want information about.</p>
|
|
240
239
|
* @public
|
|
241
240
|
*/
|
|
242
241
|
HumanTaskUiName: string | undefined;
|
|
@@ -310,23 +309,17 @@ export interface DescribeHyperParameterTuningJobRequest {
|
|
|
310
309
|
HyperParameterTuningJobName: string | undefined;
|
|
311
310
|
}
|
|
312
311
|
/**
|
|
313
|
-
* <p>Shows the latest objective metric emitted by a training job that was launched by a
|
|
314
|
-
* hyperparameter tuning job. You define the objective metric in the
|
|
315
|
-
* <code>HyperParameterTuningJobObjective</code> parameter of <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTuningJobConfig.html">HyperParameterTuningJobConfig</a>.</p>
|
|
312
|
+
* <p>Shows the latest objective metric emitted by a training job that was launched by a hyperparameter tuning job. You define the objective metric in the <code>HyperParameterTuningJobObjective</code> parameter of <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTuningJobConfig.html">HyperParameterTuningJobConfig</a>.</p>
|
|
316
313
|
* @public
|
|
317
314
|
*/
|
|
318
315
|
export interface FinalHyperParameterTuningJobObjectiveMetric {
|
|
319
316
|
/**
|
|
320
|
-
* <p>Select if you want to minimize or maximize the objective metric during hyperparameter
|
|
321
|
-
* tuning. </p>
|
|
317
|
+
* <p>Select if you want to minimize or maximize the objective metric during hyperparameter tuning. </p>
|
|
322
318
|
* @public
|
|
323
319
|
*/
|
|
324
320
|
Type?: HyperParameterTuningJobObjectiveType | undefined;
|
|
325
321
|
/**
|
|
326
|
-
* <p>The name of the objective metric. For SageMaker built-in algorithms, metrics are defined
|
|
327
|
-
* per algorithm. See the <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/xgboost-tuning.html">metrics for XGBoost</a> as an
|
|
328
|
-
* example. You can also use a custom algorithm for training and define your own metrics.
|
|
329
|
-
* For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-define-metrics-variables.html">Define metrics and environment variables</a>.</p>
|
|
322
|
+
* <p>The name of the objective metric. For SageMaker built-in algorithms, metrics are defined per algorithm. See the <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/xgboost-tuning.html">metrics for XGBoost</a> as an example. You can also use a custom algorithm for training and define your own metrics. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-define-metrics-variables.html">Define metrics and environment variables</a>.</p>
|
|
330
323
|
* @public
|
|
331
324
|
*/
|
|
332
325
|
MetricName: string | undefined;
|
|
@@ -387,70 +380,32 @@ export interface HyperParameterTrainingJobSummary {
|
|
|
387
380
|
*/
|
|
388
381
|
TrainingStartTime?: Date | undefined;
|
|
389
382
|
/**
|
|
390
|
-
* <p>Specifies the time when the training job ends on training instances. You are billed
|
|
391
|
-
* for the time interval between the value of <code>TrainingStartTime</code> and this time.
|
|
392
|
-
* For successful jobs and stopped jobs, this is the time after model artifacts are
|
|
393
|
-
* uploaded. For failed jobs, this is the time when SageMaker detects a job failure.</p>
|
|
383
|
+
* <p>Specifies the time when the training job ends on training instances. You are billed for the time interval between the value of <code>TrainingStartTime</code> and this time. For successful jobs and stopped jobs, this is the time after model artifacts are uploaded. For failed jobs, this is the time when SageMaker detects a job failure.</p>
|
|
394
384
|
* @public
|
|
395
385
|
*/
|
|
396
386
|
TrainingEndTime?: Date | undefined;
|
|
397
387
|
/**
|
|
398
|
-
* <p>The
|
|
399
|
-
* status
|
|
400
|
-
* of the training job.</p>
|
|
388
|
+
* <p>The status of the training job.</p>
|
|
401
389
|
* @public
|
|
402
390
|
*/
|
|
403
391
|
TrainingJobStatus: TrainingJobStatus | undefined;
|
|
404
392
|
/**
|
|
405
|
-
* <p>A
|
|
406
|
-
* list of the hyperparameters for which you specified ranges to
|
|
407
|
-
* search.</p>
|
|
393
|
+
* <p>A list of the hyperparameters for which you specified ranges to search.</p>
|
|
408
394
|
* @public
|
|
409
395
|
*/
|
|
410
396
|
TunedHyperParameters: Record<string, string> | undefined;
|
|
411
397
|
/**
|
|
412
|
-
* <p>The
|
|
413
|
-
* reason that the training job failed.
|
|
414
|
-
* </p>
|
|
398
|
+
* <p>The reason that the training job failed. </p>
|
|
415
399
|
* @public
|
|
416
400
|
*/
|
|
417
401
|
FailureReason?: string | undefined;
|
|
418
402
|
/**
|
|
419
|
-
* <p>The <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_FinalHyperParameterTuningJobObjectiveMetric.html">FinalHyperParameterTuningJobObjectiveMetric</a> object that specifies the
|
|
420
|
-
* value
|
|
421
|
-
* of the
|
|
422
|
-
* objective
|
|
423
|
-
* metric of the tuning job that launched this training job.</p>
|
|
403
|
+
* <p>The <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_FinalHyperParameterTuningJobObjectiveMetric.html">FinalHyperParameterTuningJobObjectiveMetric</a> object that specifies the value of the objective metric of the tuning job that launched this training job.</p>
|
|
424
404
|
* @public
|
|
425
405
|
*/
|
|
426
406
|
FinalHyperParameterTuningJobObjectiveMetric?: FinalHyperParameterTuningJobObjectiveMetric | undefined;
|
|
427
407
|
/**
|
|
428
|
-
* <p>The status of the objective metric for the training job:</p>
|
|
429
|
-
* <ul>
|
|
430
|
-
* <li>
|
|
431
|
-
* <p>Succeeded: The
|
|
432
|
-
* final
|
|
433
|
-
* objective metric for the training job was evaluated by the
|
|
434
|
-
* hyperparameter tuning job and
|
|
435
|
-
* used
|
|
436
|
-
* in the hyperparameter tuning process.</p>
|
|
437
|
-
* </li>
|
|
438
|
-
* </ul>
|
|
439
|
-
* <ul>
|
|
440
|
-
* <li>
|
|
441
|
-
* <p>Pending: The training job is in progress and evaluation of its final objective
|
|
442
|
-
* metric is pending.</p>
|
|
443
|
-
* </li>
|
|
444
|
-
* </ul>
|
|
445
|
-
* <ul>
|
|
446
|
-
* <li>
|
|
447
|
-
* <p>Failed:
|
|
448
|
-
* The final objective metric for the training job was not evaluated, and was not
|
|
449
|
-
* used in the hyperparameter tuning process. This typically occurs when the
|
|
450
|
-
* training job failed or did not emit an objective
|
|
451
|
-
* metric.</p>
|
|
452
|
-
* </li>
|
|
453
|
-
* </ul>
|
|
408
|
+
* <p>The status of the objective metric for the training job:</p> <ul> <li> <p>Succeeded: The final objective metric for the training job was evaluated by the hyperparameter tuning job and used in the hyperparameter tuning process.</p> </li> </ul> <ul> <li> <p>Pending: The training job is in progress and evaluation of its final objective metric is pending.</p> </li> </ul> <ul> <li> <p>Failed: The final objective metric for the training job was not evaluated, and was not used in the hyperparameter tuning process. This typically occurs when the training job failed or did not emit an objective metric.</p> </li> </ul>
|
|
454
409
|
* @public
|
|
455
410
|
*/
|
|
456
411
|
ObjectiveStatus?: ObjectiveStatus | undefined;
|
|
@@ -484,89 +439,69 @@ export declare const HyperParameterTuningJobStatus: {
|
|
|
484
439
|
*/
|
|
485
440
|
export type HyperParameterTuningJobStatus = (typeof HyperParameterTuningJobStatus)[keyof typeof HyperParameterTuningJobStatus];
|
|
486
441
|
/**
|
|
487
|
-
* <p>Specifies the number of training jobs that this hyperparameter tuning job launched,
|
|
488
|
-
* categorized by the status of their objective metric. The objective metric status shows
|
|
489
|
-
* whether the
|
|
490
|
-
* final
|
|
491
|
-
* objective metric for the training job has been evaluated by the
|
|
492
|
-
* tuning job and used in the hyperparameter tuning process.</p>
|
|
442
|
+
* <p>Specifies the number of training jobs that this hyperparameter tuning job launched, categorized by the status of their objective metric. The objective metric status shows whether the final objective metric for the training job has been evaluated by the tuning job and used in the hyperparameter tuning process.</p>
|
|
493
443
|
* @public
|
|
494
444
|
*/
|
|
495
445
|
export interface ObjectiveStatusCounters {
|
|
496
446
|
/**
|
|
497
|
-
* <p>The number of training jobs whose final objective metric was evaluated by the
|
|
498
|
-
* hyperparameter tuning job and used in the hyperparameter tuning process.</p>
|
|
447
|
+
* <p>The number of training jobs whose final objective metric was evaluated by the hyperparameter tuning job and used in the hyperparameter tuning process.</p>
|
|
499
448
|
* @public
|
|
500
449
|
*/
|
|
501
450
|
Succeeded?: number | undefined;
|
|
502
451
|
/**
|
|
503
|
-
* <p>The number of training jobs that are in progress and pending evaluation of their final
|
|
504
|
-
* objective metric.</p>
|
|
452
|
+
* <p>The number of training jobs that are in progress and pending evaluation of their final objective metric.</p>
|
|
505
453
|
* @public
|
|
506
454
|
*/
|
|
507
455
|
Pending?: number | undefined;
|
|
508
456
|
/**
|
|
509
|
-
* <p>The number of training jobs whose final objective metric was not evaluated and used in
|
|
510
|
-
* the hyperparameter tuning process. This typically occurs when the training job failed or
|
|
511
|
-
* did not emit an objective metric.</p>
|
|
457
|
+
* <p>The number of training jobs whose final objective metric was not evaluated and used in the hyperparameter tuning process. This typically occurs when the training job failed or did not emit an objective metric.</p>
|
|
512
458
|
* @public
|
|
513
459
|
*/
|
|
514
460
|
Failed?: number | undefined;
|
|
515
461
|
}
|
|
516
462
|
/**
|
|
517
|
-
* <p>The numbers of training jobs launched by a hyperparameter tuning job, categorized by
|
|
518
|
-
* status.</p>
|
|
463
|
+
* <p>The numbers of training jobs launched by a hyperparameter tuning job, categorized by status.</p>
|
|
519
464
|
* @public
|
|
520
465
|
*/
|
|
521
466
|
export interface TrainingJobStatusCounters {
|
|
522
467
|
/**
|
|
523
|
-
* <p>The number of completed training jobs launched by the hyperparameter tuning
|
|
524
|
-
* job.</p>
|
|
468
|
+
* <p>The number of completed training jobs launched by the hyperparameter tuning job.</p>
|
|
525
469
|
* @public
|
|
526
470
|
*/
|
|
527
471
|
Completed?: number | undefined;
|
|
528
472
|
/**
|
|
529
|
-
* <p>The number of in-progress training jobs launched by a hyperparameter tuning
|
|
530
|
-
* job.</p>
|
|
473
|
+
* <p>The number of in-progress training jobs launched by a hyperparameter tuning job.</p>
|
|
531
474
|
* @public
|
|
532
475
|
*/
|
|
533
476
|
InProgress?: number | undefined;
|
|
534
477
|
/**
|
|
535
|
-
* <p>The number of training jobs that failed, but can be retried. A failed training job can
|
|
536
|
-
* be retried only if it failed because an internal service error occurred.</p>
|
|
478
|
+
* <p>The number of training jobs that failed, but can be retried. A failed training job can be retried only if it failed because an internal service error occurred.</p>
|
|
537
479
|
* @public
|
|
538
480
|
*/
|
|
539
481
|
RetryableError?: number | undefined;
|
|
540
482
|
/**
|
|
541
|
-
* <p>The number of training jobs that failed and can't be retried. A failed training job
|
|
542
|
-
* can't be retried if it failed because a client error occurred.</p>
|
|
483
|
+
* <p>The number of training jobs that failed and can't be retried. A failed training job can't be retried if it failed because a client error occurred.</p>
|
|
543
484
|
* @public
|
|
544
485
|
*/
|
|
545
486
|
NonRetryableError?: number | undefined;
|
|
546
487
|
/**
|
|
547
|
-
* <p>The number of training jobs launched by a hyperparameter tuning job that were
|
|
548
|
-
* manually
|
|
549
|
-
* stopped.</p>
|
|
488
|
+
* <p>The number of training jobs launched by a hyperparameter tuning job that were manually stopped.</p>
|
|
550
489
|
* @public
|
|
551
490
|
*/
|
|
552
491
|
Stopped?: number | undefined;
|
|
553
492
|
}
|
|
554
493
|
/**
|
|
555
|
-
* <p>A structure that contains runtime information about both current and completed
|
|
556
|
-
* hyperparameter tuning jobs.</p>
|
|
494
|
+
* <p>A structure that contains runtime information about both current and completed hyperparameter tuning jobs.</p>
|
|
557
495
|
* @public
|
|
558
496
|
*/
|
|
559
497
|
export interface HyperParameterTuningJobCompletionDetails {
|
|
560
498
|
/**
|
|
561
|
-
* <p>The number of training jobs launched by a tuning job that are not improving (1% or
|
|
562
|
-
* less) as measured by model performance evaluated against an objective function.</p>
|
|
499
|
+
* <p>The number of training jobs launched by a tuning job that are not improving (1% or less) as measured by model performance evaluated against an objective function.</p>
|
|
563
500
|
* @public
|
|
564
501
|
*/
|
|
565
502
|
NumberOfTrainingJobsObjectiveNotImproving?: number | undefined;
|
|
566
503
|
/**
|
|
567
|
-
* <p>The time in timestamp format that AMT detected model convergence, as defined by a lack
|
|
568
|
-
* of significant improvement over time based on criteria developed over a wide range of
|
|
569
|
-
* diverse benchmarking tests.</p>
|
|
504
|
+
* <p>The time in timestamp format that AMT detected model convergence, as defined by a lack of significant improvement over time based on criteria developed over a wide range of diverse benchmarking tests.</p>
|
|
570
505
|
* @public
|
|
571
506
|
*/
|
|
572
507
|
ConvergenceDetectedTime?: Date | undefined;
|
|
@@ -586,20 +521,17 @@ export interface DescribeHyperParameterTuningJobResponse {
|
|
|
586
521
|
*/
|
|
587
522
|
HyperParameterTuningJobArn: string | undefined;
|
|
588
523
|
/**
|
|
589
|
-
* <p>The <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTuningJobConfig.html">HyperParameterTuningJobConfig</a> object that specifies the configuration of
|
|
590
|
-
* the tuning job.</p>
|
|
524
|
+
* <p>The <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTuningJobConfig.html">HyperParameterTuningJobConfig</a> object that specifies the configuration of the tuning job.</p>
|
|
591
525
|
* @public
|
|
592
526
|
*/
|
|
593
527
|
HyperParameterTuningJobConfig: HyperParameterTuningJobConfig | undefined;
|
|
594
528
|
/**
|
|
595
|
-
* <p>The <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTrainingJobDefinition.html">HyperParameterTrainingJobDefinition</a> object that specifies the definition of
|
|
596
|
-
* the training jobs that this tuning job launches.</p>
|
|
529
|
+
* <p>The <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTrainingJobDefinition.html">HyperParameterTrainingJobDefinition</a> object that specifies the definition of the training jobs that this tuning job launches.</p>
|
|
597
530
|
* @public
|
|
598
531
|
*/
|
|
599
532
|
TrainingJobDefinition?: HyperParameterTrainingJobDefinition | undefined;
|
|
600
533
|
/**
|
|
601
|
-
* <p>A list of the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTrainingJobDefinition.html">HyperParameterTrainingJobDefinition</a> objects launched for this tuning
|
|
602
|
-
* job.</p>
|
|
534
|
+
* <p>A list of the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTrainingJobDefinition.html">HyperParameterTrainingJobDefinition</a> objects launched for this tuning job.</p>
|
|
603
535
|
* @public
|
|
604
536
|
*/
|
|
605
537
|
TrainingJobDefinitions?: HyperParameterTrainingJobDefinition[] | undefined;
|
|
@@ -624,38 +556,27 @@ export interface DescribeHyperParameterTuningJobResponse {
|
|
|
624
556
|
*/
|
|
625
557
|
LastModifiedTime?: Date | undefined;
|
|
626
558
|
/**
|
|
627
|
-
* <p>The <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_TrainingJobStatusCounters.html">TrainingJobStatusCounters</a> object that specifies the number of training
|
|
628
|
-
* jobs, categorized by status, that this tuning job launched.</p>
|
|
559
|
+
* <p>The <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_TrainingJobStatusCounters.html">TrainingJobStatusCounters</a> object that specifies the number of training jobs, categorized by status, that this tuning job launched.</p>
|
|
629
560
|
* @public
|
|
630
561
|
*/
|
|
631
562
|
TrainingJobStatusCounters: TrainingJobStatusCounters | undefined;
|
|
632
563
|
/**
|
|
633
|
-
* <p>The <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ObjectiveStatusCounters.html">ObjectiveStatusCounters</a> object that specifies the number of training jobs,
|
|
634
|
-
* categorized by the status of their final objective metric, that this tuning job
|
|
635
|
-
* launched.</p>
|
|
564
|
+
* <p>The <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ObjectiveStatusCounters.html">ObjectiveStatusCounters</a> object that specifies the number of training jobs, categorized by the status of their final objective metric, that this tuning job launched.</p>
|
|
636
565
|
* @public
|
|
637
566
|
*/
|
|
638
567
|
ObjectiveStatusCounters: ObjectiveStatusCounters | undefined;
|
|
639
568
|
/**
|
|
640
|
-
* <p>A <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_TrainingJobSummary.html">TrainingJobSummary</a> object that describes the training job that completed
|
|
641
|
-
* with the best current <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTuningJobObjective.html">HyperParameterTuningJobObjective</a>.</p>
|
|
569
|
+
* <p>A <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_TrainingJobSummary.html">TrainingJobSummary</a> object that describes the training job that completed with the best current <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTuningJobObjective.html">HyperParameterTuningJobObjective</a>.</p>
|
|
642
570
|
* @public
|
|
643
571
|
*/
|
|
644
572
|
BestTrainingJob?: HyperParameterTrainingJobSummary | undefined;
|
|
645
573
|
/**
|
|
646
|
-
* <p>If the hyperparameter tuning job is an warm start tuning job with a
|
|
647
|
-
* <code>WarmStartType</code> of <code>IDENTICAL_DATA_AND_ALGORITHM</code>, this is the
|
|
648
|
-
* <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_TrainingJobSummary.html">TrainingJobSummary</a> for the training job with the best objective metric
|
|
649
|
-
* value of all training jobs launched by this tuning job and all parent jobs specified for
|
|
650
|
-
* the warm start tuning job.</p>
|
|
574
|
+
* <p>If the hyperparameter tuning job is an warm start tuning job with a <code>WarmStartType</code> of <code>IDENTICAL_DATA_AND_ALGORITHM</code>, this is the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_TrainingJobSummary.html">TrainingJobSummary</a> for the training job with the best objective metric value of all training jobs launched by this tuning job and all parent jobs specified for the warm start tuning job.</p>
|
|
651
575
|
* @public
|
|
652
576
|
*/
|
|
653
577
|
OverallBestTrainingJob?: HyperParameterTrainingJobSummary | undefined;
|
|
654
578
|
/**
|
|
655
|
-
* <p>The configuration for starting the hyperparameter parameter tuning job using one or
|
|
656
|
-
* more previous tuning jobs as a starting point. The results of previous tuning jobs are
|
|
657
|
-
* used to inform which combinations of hyperparameters to search over in the new tuning
|
|
658
|
-
* job.</p>
|
|
579
|
+
* <p>The configuration for starting the hyperparameter parameter tuning job using one or more previous tuning jobs as a starting point. The results of previous tuning jobs are used to inform which combinations of hyperparameters to search over in the new tuning job.</p>
|
|
659
580
|
* @public
|
|
660
581
|
*/
|
|
661
582
|
WarmStartConfig?: HyperParameterTuningJobWarmStartConfig | undefined;
|
|
@@ -670,10 +591,7 @@ export interface DescribeHyperParameterTuningJobResponse {
|
|
|
670
591
|
*/
|
|
671
592
|
FailureReason?: string | undefined;
|
|
672
593
|
/**
|
|
673
|
-
* <p>Tuning job completion information returned as the response from a hyperparameter
|
|
674
|
-
* tuning job. This information tells if your tuning job has or has not converged. It also
|
|
675
|
-
* includes the number of training jobs that have not improved model performance as
|
|
676
|
-
* evaluated against the objective function.</p>
|
|
594
|
+
* <p>Tuning job completion information returned as the response from a hyperparameter tuning job. This information tells if your tuning job has or has not converged. It also includes the number of training jobs that have not improved model performance as evaluated against the objective function.</p>
|
|
677
595
|
* @public
|
|
678
596
|
*/
|
|
679
597
|
TuningJobCompletionDetails?: HyperParameterTuningJobCompletionDetails | undefined;
|
|
@@ -845,44 +763,12 @@ export interface DescribeImageVersionResponse {
|
|
|
845
763
|
*/
|
|
846
764
|
Version?: number | undefined;
|
|
847
765
|
/**
|
|
848
|
-
* <p>The stability of the image version specified by the maintainer.</p>
|
|
849
|
-
* <ul>
|
|
850
|
-
* <li>
|
|
851
|
-
* <p>
|
|
852
|
-
* <code>NOT_PROVIDED</code>: The maintainers did not provide a status for image version stability.</p>
|
|
853
|
-
* </li>
|
|
854
|
-
* <li>
|
|
855
|
-
* <p>
|
|
856
|
-
* <code>STABLE</code>: The image version is stable.</p>
|
|
857
|
-
* </li>
|
|
858
|
-
* <li>
|
|
859
|
-
* <p>
|
|
860
|
-
* <code>TO_BE_ARCHIVED</code>: The image version is set to be archived. Custom image versions that are set to be archived are automatically archived after three months.</p>
|
|
861
|
-
* </li>
|
|
862
|
-
* <li>
|
|
863
|
-
* <p>
|
|
864
|
-
* <code>ARCHIVED</code>: The image version is archived. Archived image versions are not searchable and are no longer actively supported. </p>
|
|
865
|
-
* </li>
|
|
866
|
-
* </ul>
|
|
766
|
+
* <p>The stability of the image version specified by the maintainer.</p> <ul> <li> <p> <code>NOT_PROVIDED</code>: The maintainers did not provide a status for image version stability.</p> </li> <li> <p> <code>STABLE</code>: The image version is stable.</p> </li> <li> <p> <code>TO_BE_ARCHIVED</code>: The image version is set to be archived. Custom image versions that are set to be archived are automatically archived after three months.</p> </li> <li> <p> <code>ARCHIVED</code>: The image version is archived. Archived image versions are not searchable and are no longer actively supported. </p> </li> </ul>
|
|
867
767
|
* @public
|
|
868
768
|
*/
|
|
869
769
|
VendorGuidance?: VendorGuidance | undefined;
|
|
870
770
|
/**
|
|
871
|
-
* <p>Indicates SageMaker AI job type compatibility.</p>
|
|
872
|
-
* <ul>
|
|
873
|
-
* <li>
|
|
874
|
-
* <p>
|
|
875
|
-
* <code>TRAINING</code>: The image version is compatible with SageMaker AI training jobs.</p>
|
|
876
|
-
* </li>
|
|
877
|
-
* <li>
|
|
878
|
-
* <p>
|
|
879
|
-
* <code>INFERENCE</code>: The image version is compatible with SageMaker AI inference jobs.</p>
|
|
880
|
-
* </li>
|
|
881
|
-
* <li>
|
|
882
|
-
* <p>
|
|
883
|
-
* <code>NOTEBOOK_KERNEL</code>: The image version is compatible with SageMaker AI notebook kernels.</p>
|
|
884
|
-
* </li>
|
|
885
|
-
* </ul>
|
|
771
|
+
* <p>Indicates SageMaker AI job type compatibility.</p> <ul> <li> <p> <code>TRAINING</code>: The image version is compatible with SageMaker AI training jobs.</p> </li> <li> <p> <code>INFERENCE</code>: The image version is compatible with SageMaker AI inference jobs.</p> </li> <li> <p> <code>NOTEBOOK_KERNEL</code>: The image version is compatible with SageMaker AI notebook kernels.</p> </li> </ul>
|
|
886
772
|
* @public
|
|
887
773
|
*/
|
|
888
774
|
JobType?: JobType | undefined;
|
|
@@ -897,17 +783,7 @@ export interface DescribeImageVersionResponse {
|
|
|
897
783
|
*/
|
|
898
784
|
ProgrammingLang?: string | undefined;
|
|
899
785
|
/**
|
|
900
|
-
* <p>Indicates CPU or GPU compatibility.</p>
|
|
901
|
-
* <ul>
|
|
902
|
-
* <li>
|
|
903
|
-
* <p>
|
|
904
|
-
* <code>CPU</code>: The image version is compatible with CPU.</p>
|
|
905
|
-
* </li>
|
|
906
|
-
* <li>
|
|
907
|
-
* <p>
|
|
908
|
-
* <code>GPU</code>: The image version is compatible with GPU.</p>
|
|
909
|
-
* </li>
|
|
910
|
-
* </ul>
|
|
786
|
+
* <p>Indicates CPU or GPU compatibility.</p> <ul> <li> <p> <code>CPU</code>: The image version is compatible with CPU.</p> </li> <li> <p> <code>GPU</code>: The image version is compatible with GPU.</p> </li> </ul>
|
|
911
787
|
* @public
|
|
912
788
|
*/
|
|
913
789
|
Processor?: Processor | undefined;
|
|
@@ -960,62 +836,33 @@ export declare const InferenceComponentCapacitySizeType: {
|
|
|
960
836
|
*/
|
|
961
837
|
export type InferenceComponentCapacitySizeType = (typeof InferenceComponentCapacitySizeType)[keyof typeof InferenceComponentCapacitySizeType];
|
|
962
838
|
/**
|
|
963
|
-
* <p>Specifies the type and size of the endpoint capacity to activate for a rolling
|
|
964
|
-
* deployment or a rollback strategy. You can specify your batches as either of the
|
|
965
|
-
* following:</p>
|
|
966
|
-
* <ul>
|
|
967
|
-
* <li>
|
|
968
|
-
* <p>A count of inference component copies </p>
|
|
969
|
-
* </li>
|
|
970
|
-
* <li>
|
|
971
|
-
* <p>The overall percentage or your fleet </p>
|
|
972
|
-
* </li>
|
|
973
|
-
* </ul>
|
|
974
|
-
* <p>For a rollback strategy, if you don't specify the fields in this object, or if you set
|
|
975
|
-
* the <code>Value</code> parameter to 100%, then SageMaker AI uses a blue/green rollback
|
|
976
|
-
* strategy and rolls all traffic back to the blue fleet.</p>
|
|
839
|
+
* <p>Specifies the type and size of the endpoint capacity to activate for a rolling deployment or a rollback strategy. You can specify your batches as either of the following:</p> <ul> <li> <p>A count of inference component copies </p> </li> <li> <p>The overall percentage or your fleet </p> </li> </ul> <p>For a rollback strategy, if you don't specify the fields in this object, or if you set the <code>Value</code> parameter to 100%, then SageMaker AI uses a blue/green rollback strategy and rolls all traffic back to the blue fleet.</p>
|
|
977
840
|
* @public
|
|
978
841
|
*/
|
|
979
842
|
export interface InferenceComponentCapacitySize {
|
|
980
843
|
/**
|
|
981
|
-
* <p>Specifies the endpoint capacity type.</p>
|
|
982
|
-
* <dl>
|
|
983
|
-
* <dt>COPY_COUNT</dt>
|
|
984
|
-
* <dd>
|
|
985
|
-
* <p>The endpoint activates based on the number of inference component
|
|
986
|
-
* copies.</p>
|
|
987
|
-
* </dd>
|
|
988
|
-
* <dt>CAPACITY_PERCENT</dt>
|
|
989
|
-
* <dd>
|
|
990
|
-
* <p>The endpoint activates based on the specified percentage of capacity.</p>
|
|
991
|
-
* </dd>
|
|
992
|
-
* </dl>
|
|
844
|
+
* <p>Specifies the endpoint capacity type.</p> <dl> <dt>COPY_COUNT</dt> <dd> <p>The endpoint activates based on the number of inference component copies.</p> </dd> <dt>CAPACITY_PERCENT</dt> <dd> <p>The endpoint activates based on the specified percentage of capacity.</p> </dd> </dl>
|
|
993
845
|
* @public
|
|
994
846
|
*/
|
|
995
847
|
Type: InferenceComponentCapacitySizeType | undefined;
|
|
996
848
|
/**
|
|
997
|
-
* <p>Defines the capacity size, either as a number of inference component copies or a
|
|
998
|
-
* capacity percentage.</p>
|
|
849
|
+
* <p>Defines the capacity size, either as a number of inference component copies or a capacity percentage.</p>
|
|
999
850
|
* @public
|
|
1000
851
|
*/
|
|
1001
852
|
Value: number | undefined;
|
|
1002
853
|
}
|
|
1003
854
|
/**
|
|
1004
|
-
* <p>Specifies a rolling deployment strategy for updating a SageMaker AI inference
|
|
1005
|
-
* component.</p>
|
|
855
|
+
* <p>Specifies a rolling deployment strategy for updating a SageMaker AI inference component.</p>
|
|
1006
856
|
* @public
|
|
1007
857
|
*/
|
|
1008
858
|
export interface InferenceComponentRollingUpdatePolicy {
|
|
1009
859
|
/**
|
|
1010
|
-
* <p>The batch size for each rolling step in the deployment process. For each step, SageMaker AI provisions capacity on the new endpoint fleet, routes traffic to that fleet,
|
|
1011
|
-
* and terminates capacity on the old endpoint fleet. The value must be between 5% to 50% of
|
|
1012
|
-
* the copy count of the inference component.</p>
|
|
860
|
+
* <p>The batch size for each rolling step in the deployment process. For each step, SageMaker AI provisions capacity on the new endpoint fleet, routes traffic to that fleet, and terminates capacity on the old endpoint fleet. The value must be between 5% to 50% of the copy count of the inference component.</p>
|
|
1013
861
|
* @public
|
|
1014
862
|
*/
|
|
1015
863
|
MaximumBatchSize: InferenceComponentCapacitySize | undefined;
|
|
1016
864
|
/**
|
|
1017
|
-
* <p>The length of the baking period, during which SageMaker AI monitors alarms for each
|
|
1018
|
-
* batch on the new fleet.</p>
|
|
865
|
+
* <p>The length of the baking period, during which SageMaker AI monitors alarms for each batch on the new fleet.</p>
|
|
1019
866
|
* @public
|
|
1020
867
|
*/
|
|
1021
868
|
WaitIntervalInSeconds: number | undefined;
|
|
@@ -1025,42 +872,34 @@ export interface InferenceComponentRollingUpdatePolicy {
|
|
|
1025
872
|
*/
|
|
1026
873
|
MaximumExecutionTimeoutInSeconds?: number | undefined;
|
|
1027
874
|
/**
|
|
1028
|
-
* <p>The batch size for a rollback to the old endpoint fleet. If this field is absent, the
|
|
1029
|
-
* value is set to the default, which is 100% of the total capacity. When the default is used,
|
|
1030
|
-
* SageMaker AI provisions the entire capacity of the old fleet at once during
|
|
1031
|
-
* rollback.</p>
|
|
875
|
+
* <p>The batch size for a rollback to the old endpoint fleet. If this field is absent, the value is set to the default, which is 100% of the total capacity. When the default is used, SageMaker AI provisions the entire capacity of the old fleet at once during rollback.</p>
|
|
1032
876
|
* @public
|
|
1033
877
|
*/
|
|
1034
878
|
RollbackMaximumBatchSize?: InferenceComponentCapacitySize | undefined;
|
|
1035
879
|
}
|
|
1036
880
|
/**
|
|
1037
|
-
* <p>The deployment configuration for an endpoint that hosts inference components. The
|
|
1038
|
-
* configuration includes the desired deployment strategy and rollback settings.</p>
|
|
881
|
+
* <p>The deployment configuration for an endpoint that hosts inference components. The configuration includes the desired deployment strategy and rollback settings.</p>
|
|
1039
882
|
* @public
|
|
1040
883
|
*/
|
|
1041
884
|
export interface InferenceComponentDeploymentConfig {
|
|
1042
885
|
/**
|
|
1043
|
-
* <p>Specifies a rolling deployment strategy for updating a SageMaker AI
|
|
1044
|
-
* endpoint.</p>
|
|
886
|
+
* <p>Specifies a rolling deployment strategy for updating a SageMaker AI endpoint.</p>
|
|
1045
887
|
* @public
|
|
1046
888
|
*/
|
|
1047
889
|
RollingUpdatePolicy: InferenceComponentRollingUpdatePolicy | undefined;
|
|
1048
890
|
/**
|
|
1049
|
-
* <p>Automatic rollback configuration for handling endpoint deployment failures and
|
|
1050
|
-
* recovery.</p>
|
|
891
|
+
* <p>Automatic rollback configuration for handling endpoint deployment failures and recovery.</p>
|
|
1051
892
|
* @public
|
|
1052
893
|
*/
|
|
1053
894
|
AutoRollbackConfiguration?: AutoRollbackConfig | undefined;
|
|
1054
895
|
}
|
|
1055
896
|
/**
|
|
1056
|
-
* <p>Details about the runtime settings for the model that is deployed with the inference
|
|
1057
|
-
* component.</p>
|
|
897
|
+
* <p>Details about the runtime settings for the model that is deployed with the inference component.</p>
|
|
1058
898
|
* @public
|
|
1059
899
|
*/
|
|
1060
900
|
export interface InferenceComponentRuntimeConfigSummary {
|
|
1061
901
|
/**
|
|
1062
|
-
* <p>The number of runtime copies of the model container that you requested to deploy with
|
|
1063
|
-
* the inference component.</p>
|
|
902
|
+
* <p>The number of runtime copies of the model container that you requested to deploy with the inference component.</p>
|
|
1064
903
|
* @public
|
|
1065
904
|
*/
|
|
1066
905
|
DesiredCopyCount?: number | undefined;
|
|
@@ -1076,12 +915,7 @@ export interface InferenceComponentRuntimeConfigSummary {
|
|
|
1076
915
|
*/
|
|
1077
916
|
export interface InferenceComponentContainerSpecificationSummary {
|
|
1078
917
|
/**
|
|
1079
|
-
* <p>Gets the Amazon EC2 Container Registry path of the docker image of the model that is hosted in this <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ProductionVariant.html">ProductionVariant</a>.</p>
|
|
1080
|
-
* <p>If you used the <code>registry/repository[:tag]</code> form to specify the image path
|
|
1081
|
-
* of the primary container when you created the model hosted in this
|
|
1082
|
-
* <code>ProductionVariant</code>, the path resolves to a path of the form
|
|
1083
|
-
* <code>registry/repository[@digest]</code>. A digest is a hash value that identifies
|
|
1084
|
-
* a specific version of an image. For information about Amazon ECR paths, see <a href="https://docs.aws.amazon.com/AmazonECR/latest/userguide/docker-pull-ecr-image.html">Pulling an Image</a> in the <i>Amazon ECR User Guide</i>.</p>
|
|
918
|
+
* <p>Gets the Amazon EC2 Container Registry path of the docker image of the model that is hosted in this <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ProductionVariant.html">ProductionVariant</a>.</p> <p>If you used the <code>registry/repository[:tag]</code> form to specify the image path of the primary container when you created the model hosted in this <code>ProductionVariant</code>, the path resolves to a path of the form <code>registry/repository[@digest]</code>. A digest is a hash value that identifies a specific version of an image. For information about Amazon ECR paths, see <a href="https://docs.aws.amazon.com/AmazonECR/latest/userguide/docker-pull-ecr-image.html">Pulling an Image</a> in the <i>Amazon ECR User Guide</i>.</p>
|
|
1085
919
|
* @public
|
|
1086
920
|
*/
|
|
1087
921
|
DeployedImage?: DeployedImage | undefined;
|
|
@@ -1102,14 +936,12 @@ export interface InferenceComponentContainerSpecificationSummary {
|
|
|
1102
936
|
*/
|
|
1103
937
|
export interface InferenceComponentSpecificationSummary {
|
|
1104
938
|
/**
|
|
1105
|
-
* <p>The name of the SageMaker AI model object that is deployed with the inference
|
|
1106
|
-
* component.</p>
|
|
939
|
+
* <p>The name of the SageMaker AI model object that is deployed with the inference component.</p>
|
|
1107
940
|
* @public
|
|
1108
941
|
*/
|
|
1109
942
|
ModelName?: string | undefined;
|
|
1110
943
|
/**
|
|
1111
|
-
* <p>Details about the container that provides the runtime environment for the model that is
|
|
1112
|
-
* deployed with the inference component.</p>
|
|
944
|
+
* <p>Details about the container that provides the runtime environment for the model that is deployed with the inference component.</p>
|
|
1113
945
|
* @public
|
|
1114
946
|
*/
|
|
1115
947
|
Container?: InferenceComponentContainerSpecificationSummary | undefined;
|
|
@@ -1119,8 +951,7 @@ export interface InferenceComponentSpecificationSummary {
|
|
|
1119
951
|
*/
|
|
1120
952
|
StartupParameters?: InferenceComponentStartupParameters | undefined;
|
|
1121
953
|
/**
|
|
1122
|
-
* <p>The compute resources allocated to run the model, plus any
|
|
1123
|
-
* adapter models, that you assign to the inference component.</p>
|
|
954
|
+
* <p>The compute resources allocated to run the model, plus any adapter models, that you assign to the inference component.</p>
|
|
1124
955
|
* @public
|
|
1125
956
|
*/
|
|
1126
957
|
ComputeResourceRequirements?: InferenceComponentComputeResourceRequirements | undefined;
|
|
@@ -1160,8 +991,7 @@ export interface DescribeInferenceComponentOutput {
|
|
|
1160
991
|
*/
|
|
1161
992
|
VariantName?: string | undefined;
|
|
1162
993
|
/**
|
|
1163
|
-
* <p>If the inference component status is <code>Failed</code>, the reason for the
|
|
1164
|
-
* failure.</p>
|
|
994
|
+
* <p>If the inference component status is <code>Failed</code>, the reason for the failure.</p>
|
|
1165
995
|
* @public
|
|
1166
996
|
*/
|
|
1167
997
|
FailureReason?: string | undefined;
|
|
@@ -1171,8 +1001,7 @@ export interface DescribeInferenceComponentOutput {
|
|
|
1171
1001
|
*/
|
|
1172
1002
|
Specification?: InferenceComponentSpecificationSummary | undefined;
|
|
1173
1003
|
/**
|
|
1174
|
-
* <p>Details about the runtime settings for the model that is deployed with the inference
|
|
1175
|
-
* component.</p>
|
|
1004
|
+
* <p>Details about the runtime settings for the model that is deployed with the inference component.</p>
|
|
1176
1005
|
* @public
|
|
1177
1006
|
*/
|
|
1178
1007
|
RuntimeConfig?: InferenceComponentRuntimeConfigSummary | undefined;
|
|
@@ -1192,8 +1021,7 @@ export interface DescribeInferenceComponentOutput {
|
|
|
1192
1021
|
*/
|
|
1193
1022
|
InferenceComponentStatus?: InferenceComponentStatus | undefined;
|
|
1194
1023
|
/**
|
|
1195
|
-
* <p>The deployment and rollback settings that you assigned to the inference
|
|
1196
|
-
* component.</p>
|
|
1024
|
+
* <p>The deployment and rollback settings that you assigned to the inference component.</p>
|
|
1197
1025
|
* @public
|
|
1198
1026
|
*/
|
|
1199
1027
|
LastDeploymentConfig?: InferenceComponentDeploymentConfig | undefined;
|
|
@@ -1224,17 +1052,12 @@ export interface EndpointMetadata {
|
|
|
1224
1052
|
*/
|
|
1225
1053
|
EndpointConfigName?: string | undefined;
|
|
1226
1054
|
/**
|
|
1227
|
-
* <p>
|
|
1228
|
-
* The status of the endpoint. For possible values of the status of an endpoint, see <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_EndpointSummary.html">EndpointSummary</a>.
|
|
1229
|
-
* </p>
|
|
1055
|
+
* <p> The status of the endpoint. For possible values of the status of an endpoint, see <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_EndpointSummary.html">EndpointSummary</a>. </p>
|
|
1230
1056
|
* @public
|
|
1231
1057
|
*/
|
|
1232
1058
|
EndpointStatus?: EndpointStatus | undefined;
|
|
1233
1059
|
/**
|
|
1234
|
-
* <p>
|
|
1235
|
-
* If the status of the endpoint is <code>Failed</code>, or the status is <code>InService</code> but update
|
|
1236
|
-
* operation fails, this provides the reason why it failed.
|
|
1237
|
-
* </p>
|
|
1060
|
+
* <p> If the status of the endpoint is <code>Failed</code>, or the status is <code>InService</code> but update operation fails, this provides the reason why it failed. </p>
|
|
1238
1061
|
* @public
|
|
1239
1062
|
*/
|
|
1240
1063
|
FailureReason?: string | undefined;
|
|
@@ -1275,35 +1098,7 @@ export interface ModelVariantConfigSummary {
|
|
|
1275
1098
|
*/
|
|
1276
1099
|
InfrastructureConfig: ModelInfrastructureConfig | undefined;
|
|
1277
1100
|
/**
|
|
1278
|
-
* <p>The status of deployment for the model variant on the hosted inference endpoint.</p>
|
|
1279
|
-
* <ul>
|
|
1280
|
-
* <li>
|
|
1281
|
-
* <p>
|
|
1282
|
-
* <code>Creating</code> - Amazon SageMaker is preparing the model variant on the hosted inference endpoint.
|
|
1283
|
-
* </p>
|
|
1284
|
-
* </li>
|
|
1285
|
-
* <li>
|
|
1286
|
-
* <p>
|
|
1287
|
-
* <code>InService</code> - The model variant is running on the hosted inference endpoint.
|
|
1288
|
-
* </p>
|
|
1289
|
-
* </li>
|
|
1290
|
-
* <li>
|
|
1291
|
-
* <p>
|
|
1292
|
-
* <code>Updating</code> - Amazon SageMaker is updating the model variant on the hosted inference endpoint.
|
|
1293
|
-
* </p>
|
|
1294
|
-
* </li>
|
|
1295
|
-
* <li>
|
|
1296
|
-
* <p>
|
|
1297
|
-
* <code>Deleting</code> - Amazon SageMaker is deleting the model variant on the hosted inference endpoint.
|
|
1298
|
-
* </p>
|
|
1299
|
-
* </li>
|
|
1300
|
-
* <li>
|
|
1301
|
-
* <p>
|
|
1302
|
-
* <code>Deleted</code> - The model variant has been deleted on the hosted inference endpoint. This
|
|
1303
|
-
* can only happen after stopping the experiment.
|
|
1304
|
-
* </p>
|
|
1305
|
-
* </li>
|
|
1306
|
-
* </ul>
|
|
1101
|
+
* <p>The status of deployment for the model variant on the hosted inference endpoint.</p> <ul> <li> <p> <code>Creating</code> - Amazon SageMaker is preparing the model variant on the hosted inference endpoint. </p> </li> <li> <p> <code>InService</code> - The model variant is running on the hosted inference endpoint. </p> </li> <li> <p> <code>Updating</code> - Amazon SageMaker is updating the model variant on the hosted inference endpoint. </p> </li> <li> <p> <code>Deleting</code> - Amazon SageMaker is deleting the model variant on the hosted inference endpoint. </p> </li> <li> <p> <code>Deleted</code> - The model variant has been deleted on the hosted inference endpoint. This can only happen after stopping the experiment. </p> </li> </ul>
|
|
1307
1102
|
* @public
|
|
1308
1103
|
*/
|
|
1309
1104
|
Status: ModelVariantStatus | undefined;
|
|
@@ -1351,62 +1146,12 @@ export interface DescribeInferenceExperimentResponse {
|
|
|
1351
1146
|
*/
|
|
1352
1147
|
Schedule?: InferenceExperimentSchedule | undefined;
|
|
1353
1148
|
/**
|
|
1354
|
-
* <p>
|
|
1355
|
-
* The status of the inference experiment. The following are the possible statuses for an inference
|
|
1356
|
-
* experiment:
|
|
1357
|
-
* </p>
|
|
1358
|
-
* <ul>
|
|
1359
|
-
* <li>
|
|
1360
|
-
* <p>
|
|
1361
|
-
* <code>Creating</code> - Amazon SageMaker is creating your experiment.
|
|
1362
|
-
* </p>
|
|
1363
|
-
* </li>
|
|
1364
|
-
* <li>
|
|
1365
|
-
* <p>
|
|
1366
|
-
* <code>Created</code> - Amazon SageMaker has finished the creation of your experiment and will begin the
|
|
1367
|
-
* experiment at the scheduled time.
|
|
1368
|
-
* </p>
|
|
1369
|
-
* </li>
|
|
1370
|
-
* <li>
|
|
1371
|
-
* <p>
|
|
1372
|
-
* <code>Updating</code> - When you make changes to your experiment, your experiment shows as updating.
|
|
1373
|
-
* </p>
|
|
1374
|
-
* </li>
|
|
1375
|
-
* <li>
|
|
1376
|
-
* <p>
|
|
1377
|
-
* <code>Starting</code> - Amazon SageMaker is beginning your experiment.
|
|
1378
|
-
* </p>
|
|
1379
|
-
* </li>
|
|
1380
|
-
* <li>
|
|
1381
|
-
* <p>
|
|
1382
|
-
* <code>Running</code> - Your experiment is in progress.
|
|
1383
|
-
* </p>
|
|
1384
|
-
* </li>
|
|
1385
|
-
* <li>
|
|
1386
|
-
* <p>
|
|
1387
|
-
* <code>Stopping</code> - Amazon SageMaker is stopping your experiment.
|
|
1388
|
-
* </p>
|
|
1389
|
-
* </li>
|
|
1390
|
-
* <li>
|
|
1391
|
-
* <p>
|
|
1392
|
-
* <code>Completed</code> - Your experiment has completed.
|
|
1393
|
-
* </p>
|
|
1394
|
-
* </li>
|
|
1395
|
-
* <li>
|
|
1396
|
-
* <p>
|
|
1397
|
-
* <code>Cancelled</code> - When you conclude your experiment early using the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_StopInferenceExperiment.html">StopInferenceExperiment</a> API, or if any operation fails with an unexpected error, it shows
|
|
1398
|
-
* as cancelled.
|
|
1399
|
-
* </p>
|
|
1400
|
-
* </li>
|
|
1401
|
-
* </ul>
|
|
1149
|
+
* <p> The status of the inference experiment. The following are the possible statuses for an inference experiment: </p> <ul> <li> <p> <code>Creating</code> - Amazon SageMaker is creating your experiment. </p> </li> <li> <p> <code>Created</code> - Amazon SageMaker has finished the creation of your experiment and will begin the experiment at the scheduled time. </p> </li> <li> <p> <code>Updating</code> - When you make changes to your experiment, your experiment shows as updating. </p> </li> <li> <p> <code>Starting</code> - Amazon SageMaker is beginning your experiment. </p> </li> <li> <p> <code>Running</code> - Your experiment is in progress. </p> </li> <li> <p> <code>Stopping</code> - Amazon SageMaker is stopping your experiment. </p> </li> <li> <p> <code>Completed</code> - Your experiment has completed. </p> </li> <li> <p> <code>Cancelled</code> - When you conclude your experiment early using the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_StopInferenceExperiment.html">StopInferenceExperiment</a> API, or if any operation fails with an unexpected error, it shows as cancelled. </p> </li> </ul>
|
|
1402
1150
|
* @public
|
|
1403
1151
|
*/
|
|
1404
1152
|
Status: InferenceExperimentStatus | undefined;
|
|
1405
1153
|
/**
|
|
1406
|
-
* <p>
|
|
1407
|
-
* The error message or client-specified <code>Reason</code> from the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_StopInferenceExperiment.html">StopInferenceExperiment</a>
|
|
1408
|
-
* API, that explains the status of the inference experiment.
|
|
1409
|
-
* </p>
|
|
1154
|
+
* <p> The error message or client-specified <code>Reason</code> from the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_StopInferenceExperiment.html">StopInferenceExperiment</a> API, that explains the status of the inference experiment. </p>
|
|
1410
1155
|
* @public
|
|
1411
1156
|
*/
|
|
1412
1157
|
StatusReason?: string | undefined;
|
|
@@ -1421,9 +1166,7 @@ export interface DescribeInferenceExperimentResponse {
|
|
|
1421
1166
|
*/
|
|
1422
1167
|
CreationTime?: Date | undefined;
|
|
1423
1168
|
/**
|
|
1424
|
-
* <p>
|
|
1425
|
-
* The timestamp at which the inference experiment was completed.
|
|
1426
|
-
* </p>
|
|
1169
|
+
* <p> The timestamp at which the inference experiment was completed. </p>
|
|
1427
1170
|
* @public
|
|
1428
1171
|
*/
|
|
1429
1172
|
CompletionTime?: Date | undefined;
|
|
@@ -1433,10 +1176,7 @@ export interface DescribeInferenceExperimentResponse {
|
|
|
1433
1176
|
*/
|
|
1434
1177
|
LastModifiedTime?: Date | undefined;
|
|
1435
1178
|
/**
|
|
1436
|
-
* <p>
|
|
1437
|
-
* The ARN of the IAM role that Amazon SageMaker can assume to access model artifacts and container images, and manage
|
|
1438
|
-
* Amazon SageMaker Inference endpoints for model deployment.
|
|
1439
|
-
* </p>
|
|
1179
|
+
* <p> The ARN of the IAM role that Amazon SageMaker can assume to access model artifacts and container images, and manage Amazon SageMaker Inference endpoints for model deployment. </p>
|
|
1440
1180
|
* @public
|
|
1441
1181
|
*/
|
|
1442
1182
|
RoleArn?: string | undefined;
|
|
@@ -1446,11 +1186,7 @@ export interface DescribeInferenceExperimentResponse {
|
|
|
1446
1186
|
*/
|
|
1447
1187
|
EndpointMetadata: EndpointMetadata | undefined;
|
|
1448
1188
|
/**
|
|
1449
|
-
* <p>
|
|
1450
|
-
* An array of <code>ModelVariantConfigSummary</code> objects. There is one for each variant in the inference
|
|
1451
|
-
* experiment. Each <code>ModelVariantConfigSummary</code> object in the array describes the infrastructure
|
|
1452
|
-
* configuration for deploying the corresponding variant.
|
|
1453
|
-
* </p>
|
|
1189
|
+
* <p> An array of <code>ModelVariantConfigSummary</code> objects. There is one for each variant in the inference experiment. Each <code>ModelVariantConfigSummary</code> object in the array describes the infrastructure configuration for deploying the corresponding variant. </p>
|
|
1454
1190
|
* @public
|
|
1455
1191
|
*/
|
|
1456
1192
|
ModelVariants: ModelVariantConfigSummary[] | undefined;
|
|
@@ -1460,20 +1196,12 @@ export interface DescribeInferenceExperimentResponse {
|
|
|
1460
1196
|
*/
|
|
1461
1197
|
DataStorageConfig?: InferenceExperimentDataStorageConfig | undefined;
|
|
1462
1198
|
/**
|
|
1463
|
-
* <p>
|
|
1464
|
-
* The configuration of <code>ShadowMode</code> inference experiment type, which shows the production variant
|
|
1465
|
-
* that takes all the inference requests, and the shadow variant to which Amazon SageMaker replicates a percentage of the
|
|
1466
|
-
* inference requests. For the shadow variant it also shows the percentage of requests that Amazon SageMaker replicates.
|
|
1467
|
-
* </p>
|
|
1199
|
+
* <p> The configuration of <code>ShadowMode</code> inference experiment type, which shows the production variant that takes all the inference requests, and the shadow variant to which Amazon SageMaker replicates a percentage of the inference requests. For the shadow variant it also shows the percentage of requests that Amazon SageMaker replicates. </p>
|
|
1468
1200
|
* @public
|
|
1469
1201
|
*/
|
|
1470
1202
|
ShadowModeConfig?: ShadowModeConfig | undefined;
|
|
1471
1203
|
/**
|
|
1472
|
-
* <p>
|
|
1473
|
-
* The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on
|
|
1474
|
-
* the storage volume attached to the ML compute instance that hosts the endpoint. For more information, see
|
|
1475
|
-
* <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateInferenceExperiment.html">CreateInferenceExperiment</a>.
|
|
1476
|
-
* </p>
|
|
1204
|
+
* <p> The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateInferenceExperiment.html">CreateInferenceExperiment</a>. </p>
|
|
1477
1205
|
* @public
|
|
1478
1206
|
*/
|
|
1479
1207
|
KmsKey?: string | undefined;
|
|
@@ -1483,8 +1211,7 @@ export interface DescribeInferenceExperimentResponse {
|
|
|
1483
1211
|
*/
|
|
1484
1212
|
export interface DescribeInferenceRecommendationsJobRequest {
|
|
1485
1213
|
/**
|
|
1486
|
-
* <p>The name of the job. The name must be unique within an
|
|
1487
|
-
* Amazon Web Services Region in the Amazon Web Services account.</p>
|
|
1214
|
+
* <p>The name of the job. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.</p>
|
|
1488
1215
|
* @public
|
|
1489
1216
|
*/
|
|
1490
1217
|
JobName: string | undefined;
|
|
@@ -1578,25 +1305,17 @@ export interface RecommendationMetrics {
|
|
|
1578
1305
|
*/
|
|
1579
1306
|
ModelLatency?: number | undefined;
|
|
1580
1307
|
/**
|
|
1581
|
-
* <p>The expected CPU utilization at maximum invocations per minute for the instance.</p>
|
|
1582
|
-
* <p>
|
|
1583
|
-
* <code>NaN</code> indicates that the value is not available.</p>
|
|
1308
|
+
* <p>The expected CPU utilization at maximum invocations per minute for the instance.</p> <p> <code>NaN</code> indicates that the value is not available.</p>
|
|
1584
1309
|
* @public
|
|
1585
1310
|
*/
|
|
1586
1311
|
CpuUtilization?: number | undefined;
|
|
1587
1312
|
/**
|
|
1588
|
-
* <p>The expected memory utilization at maximum invocations per minute for the instance.</p>
|
|
1589
|
-
* <p>
|
|
1590
|
-
* <code>NaN</code> indicates that the value is not available.</p>
|
|
1313
|
+
* <p>The expected memory utilization at maximum invocations per minute for the instance.</p> <p> <code>NaN</code> indicates that the value is not available.</p>
|
|
1591
1314
|
* @public
|
|
1592
1315
|
*/
|
|
1593
1316
|
MemoryUtilization?: number | undefined;
|
|
1594
1317
|
/**
|
|
1595
|
-
* <p>The time it takes to launch new compute resources for a serverless endpoint.
|
|
1596
|
-
* The time can vary depending on the model size, how long it takes to download the
|
|
1597
|
-
* model, and the start-up time of the container.</p>
|
|
1598
|
-
* <p>
|
|
1599
|
-
* <code>NaN</code> indicates that the value is not available.</p>
|
|
1318
|
+
* <p>The time it takes to launch new compute resources for a serverless endpoint. The time can vary depending on the model size, how long it takes to download the model, and the start-up time of the container.</p> <p> <code>NaN</code> indicates that the value is not available.</p>
|
|
1600
1319
|
* @public
|
|
1601
1320
|
*/
|
|
1602
1321
|
ModelSetupTime?: number | undefined;
|
|
@@ -1702,8 +1421,7 @@ export type RecommendationJobStatus = (typeof RecommendationJobStatus)[keyof typ
|
|
|
1702
1421
|
*/
|
|
1703
1422
|
export interface DescribeInferenceRecommendationsJobResponse {
|
|
1704
1423
|
/**
|
|
1705
|
-
* <p>The name of the job. The name must be unique within an
|
|
1706
|
-
* Amazon Web Services Region in the Amazon Web Services account.</p>
|
|
1424
|
+
* <p>The name of the job. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.</p>
|
|
1707
1425
|
* @public
|
|
1708
1426
|
*/
|
|
1709
1427
|
JobName: string | undefined;
|
|
@@ -1723,8 +1441,7 @@ export interface DescribeInferenceRecommendationsJobResponse {
|
|
|
1723
1441
|
*/
|
|
1724
1442
|
JobArn: string | undefined;
|
|
1725
1443
|
/**
|
|
1726
|
-
* <p>The Amazon Resource Name (ARN) of the Amazon Web Services
|
|
1727
|
-
* Identity and Access Management (IAM) role you provided when you initiated the job.</p>
|
|
1444
|
+
* <p>The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role you provided when you initiated the job.</p>
|
|
1728
1445
|
* @public
|
|
1729
1446
|
*/
|
|
1730
1447
|
RoleArn: string | undefined;
|
|
@@ -1754,8 +1471,7 @@ export interface DescribeInferenceRecommendationsJobResponse {
|
|
|
1754
1471
|
*/
|
|
1755
1472
|
FailureReason?: string | undefined;
|
|
1756
1473
|
/**
|
|
1757
|
-
* <p>Returns information about the versioned model package Amazon Resource Name (ARN),
|
|
1758
|
-
* the traffic pattern, and endpoint configurations you provided when you initiated the job.</p>
|
|
1474
|
+
* <p>Returns information about the versioned model package Amazon Resource Name (ARN), the traffic pattern, and endpoint configurations you provided when you initiated the job.</p>
|
|
1759
1475
|
* @public
|
|
1760
1476
|
*/
|
|
1761
1477
|
InputConfig: RecommendationJobInputConfig | undefined;
|
|
@@ -1827,8 +1543,7 @@ export interface LabelingJobOutput {
|
|
|
1827
1543
|
*/
|
|
1828
1544
|
OutputDatasetS3Uri: string | undefined;
|
|
1829
1545
|
/**
|
|
1830
|
-
* <p>The Amazon Resource Name (ARN) for the most recent SageMaker model trained as part of
|
|
1831
|
-
* automated data labeling. </p>
|
|
1546
|
+
* <p>The Amazon Resource Name (ARN) for the most recent SageMaker model trained as part of automated data labeling. </p>
|
|
1832
1547
|
* @public
|
|
1833
1548
|
*/
|
|
1834
1549
|
FinalActiveLearningModelArn?: string | undefined;
|
|
@@ -1859,9 +1574,7 @@ export interface DescribeLabelingJobResponse {
|
|
|
1859
1574
|
*/
|
|
1860
1575
|
LabelingJobStatus: LabelingJobStatus | undefined;
|
|
1861
1576
|
/**
|
|
1862
|
-
* <p>Provides a breakdown of the number of data objects labeled by humans, the number of
|
|
1863
|
-
* objects labeled by machine, the number of objects than couldn't be labeled, and the
|
|
1864
|
-
* total number of objects labeled. </p>
|
|
1577
|
+
* <p>Provides a breakdown of the number of data objects labeled by humans, the number of objects labeled by machine, the number of objects than couldn't be labeled, and the total number of objects labeled. </p>
|
|
1865
1578
|
* @public
|
|
1866
1579
|
*/
|
|
1867
1580
|
LabelCounters: LabelCounters | undefined;
|
|
@@ -1901,87 +1614,27 @@ export interface DescribeLabelingJobResponse {
|
|
|
1901
1614
|
*/
|
|
1902
1615
|
LabelAttributeName?: string | undefined;
|
|
1903
1616
|
/**
|
|
1904
|
-
* <p>Input configuration information for the labeling job, such as the Amazon S3 location of the
|
|
1905
|
-
* data objects and the location of the manifest file that describes the data
|
|
1906
|
-
* objects.</p>
|
|
1617
|
+
* <p>Input configuration information for the labeling job, such as the Amazon S3 location of the data objects and the location of the manifest file that describes the data objects.</p>
|
|
1907
1618
|
* @public
|
|
1908
1619
|
*/
|
|
1909
1620
|
InputConfig: LabelingJobInputConfig | undefined;
|
|
1910
1621
|
/**
|
|
1911
|
-
* <p>The location of the job's output data and the Amazon Web Services Key Management
|
|
1912
|
-
* Service key ID for the key used to encrypt the output data, if any.</p>
|
|
1622
|
+
* <p>The location of the job's output data and the Amazon Web Services Key Management Service key ID for the key used to encrypt the output data, if any.</p>
|
|
1913
1623
|
* @public
|
|
1914
1624
|
*/
|
|
1915
1625
|
OutputConfig: LabelingJobOutputConfig | undefined;
|
|
1916
1626
|
/**
|
|
1917
|
-
* <p>The Amazon Resource Name (ARN) that SageMaker assumes to perform tasks on your behalf
|
|
1918
|
-
* during data labeling.</p>
|
|
1627
|
+
* <p>The Amazon Resource Name (ARN) that SageMaker assumes to perform tasks on your behalf during data labeling.</p>
|
|
1919
1628
|
* @public
|
|
1920
1629
|
*/
|
|
1921
1630
|
RoleArn: string | undefined;
|
|
1922
1631
|
/**
|
|
1923
|
-
* <p>The S3 location of the JSON file that defines the categories used to label data
|
|
1924
|
-
* objects. Please note the following label-category limits:</p>
|
|
1925
|
-
* <ul>
|
|
1926
|
-
* <li>
|
|
1927
|
-
* <p>Semantic segmentation labeling jobs using automated labeling: 20 labels</p>
|
|
1928
|
-
* </li>
|
|
1929
|
-
* <li>
|
|
1930
|
-
* <p>Box bounding labeling jobs (all): 10 labels</p>
|
|
1931
|
-
* </li>
|
|
1932
|
-
* </ul>
|
|
1933
|
-
* <p>The file is a JSON structure in the following format:</p>
|
|
1934
|
-
* <p>
|
|
1935
|
-
* <code>\{</code>
|
|
1936
|
-
* </p>
|
|
1937
|
-
* <p>
|
|
1938
|
-
* <code> "document-version": "2018-11-28"</code>
|
|
1939
|
-
* </p>
|
|
1940
|
-
* <p>
|
|
1941
|
-
* <code> "labels": [</code>
|
|
1942
|
-
* </p>
|
|
1943
|
-
* <p>
|
|
1944
|
-
* <code> \{</code>
|
|
1945
|
-
* </p>
|
|
1946
|
-
* <p>
|
|
1947
|
-
* <code> "label": "<i>label 1</i>"</code>
|
|
1948
|
-
* </p>
|
|
1949
|
-
* <p>
|
|
1950
|
-
* <code> \},</code>
|
|
1951
|
-
* </p>
|
|
1952
|
-
* <p>
|
|
1953
|
-
* <code> \{</code>
|
|
1954
|
-
* </p>
|
|
1955
|
-
* <p>
|
|
1956
|
-
* <code> "label": "<i>label 2</i>"</code>
|
|
1957
|
-
* </p>
|
|
1958
|
-
* <p>
|
|
1959
|
-
* <code> \},</code>
|
|
1960
|
-
* </p>
|
|
1961
|
-
* <p>
|
|
1962
|
-
* <code> ...</code>
|
|
1963
|
-
* </p>
|
|
1964
|
-
* <p>
|
|
1965
|
-
* <code> \{</code>
|
|
1966
|
-
* </p>
|
|
1967
|
-
* <p>
|
|
1968
|
-
* <code> "label": "<i>label n</i>"</code>
|
|
1969
|
-
* </p>
|
|
1970
|
-
* <p>
|
|
1971
|
-
* <code> \}</code>
|
|
1972
|
-
* </p>
|
|
1973
|
-
* <p>
|
|
1974
|
-
* <code> ]</code>
|
|
1975
|
-
* </p>
|
|
1976
|
-
* <p>
|
|
1977
|
-
* <code>\}</code>
|
|
1978
|
-
* </p>
|
|
1632
|
+
* <p>The S3 location of the JSON file that defines the categories used to label data objects. Please note the following label-category limits:</p> <ul> <li> <p>Semantic segmentation labeling jobs using automated labeling: 20 labels</p> </li> <li> <p>Box bounding labeling jobs (all): 10 labels</p> </li> </ul> <p>The file is a JSON structure in the following format:</p> <p> <code>\{</code> </p> <p> <code> "document-version": "2018-11-28"</code> </p> <p> <code> "labels": [</code> </p> <p> <code> \{</code> </p> <p> <code> "label": "<i>label 1</i>"</code> </p> <p> <code> \},</code> </p> <p> <code> \{</code> </p> <p> <code> "label": "<i>label 2</i>"</code> </p> <p> <code> \},</code> </p> <p> <code> ...</code> </p> <p> <code> \{</code> </p> <p> <code> "label": "<i>label n</i>"</code> </p> <p> <code> \}</code> </p> <p> <code> ]</code> </p> <p> <code>\}</code> </p>
|
|
1979
1633
|
* @public
|
|
1980
1634
|
*/
|
|
1981
1635
|
LabelCategoryConfigS3Uri?: string | undefined;
|
|
1982
1636
|
/**
|
|
1983
|
-
* <p>A set of conditions for stopping a labeling job. If any of the conditions are met, the
|
|
1984
|
-
* job is automatically stopped.</p>
|
|
1637
|
+
* <p>A set of conditions for stopping a labeling job. If any of the conditions are met, the job is automatically stopped.</p>
|
|
1985
1638
|
* @public
|
|
1986
1639
|
*/
|
|
1987
1640
|
StoppingConditions?: LabelingJobStoppingConditions | undefined;
|
|
@@ -1991,15 +1644,12 @@ export interface DescribeLabelingJobResponse {
|
|
|
1991
1644
|
*/
|
|
1992
1645
|
LabelingJobAlgorithmsConfig?: LabelingJobAlgorithmsConfig | undefined;
|
|
1993
1646
|
/**
|
|
1994
|
-
* <p>Configuration information required for human workers to complete a labeling
|
|
1995
|
-
* task.</p>
|
|
1647
|
+
* <p>Configuration information required for human workers to complete a labeling task.</p>
|
|
1996
1648
|
* @public
|
|
1997
1649
|
*/
|
|
1998
1650
|
HumanTaskConfig: HumanTaskConfig | undefined;
|
|
1999
1651
|
/**
|
|
2000
|
-
* <p>An array of key-value pairs. You can use tags to categorize your Amazon Web Services
|
|
2001
|
-
* resources in different ways, for example, by purpose, owner, or environment. For more
|
|
2002
|
-
* information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services Resources</a>.</p>
|
|
1652
|
+
* <p>An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services Resources</a>.</p>
|
|
2003
1653
|
* @public
|
|
2004
1654
|
*/
|
|
2005
1655
|
Tags?: Tag[] | undefined;
|
|
@@ -2049,8 +1699,7 @@ export interface DescribeLineageGroupResponse {
|
|
|
2049
1699
|
*/
|
|
2050
1700
|
CreationTime?: Date | undefined;
|
|
2051
1701
|
/**
|
|
2052
|
-
* <p>Information about the user who created or modified an experiment, trial, trial
|
|
2053
|
-
* component, lineage group, project, or model card.</p>
|
|
1702
|
+
* <p>Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.</p>
|
|
2054
1703
|
* @public
|
|
2055
1704
|
*/
|
|
2056
1705
|
CreatedBy?: UserContext | undefined;
|
|
@@ -2060,8 +1709,7 @@ export interface DescribeLineageGroupResponse {
|
|
|
2060
1709
|
*/
|
|
2061
1710
|
LastModifiedTime?: Date | undefined;
|
|
2062
1711
|
/**
|
|
2063
|
-
* <p>Information about the user who created or modified an experiment, trial, trial
|
|
2064
|
-
* component, lineage group, project, or model card.</p>
|
|
1712
|
+
* <p>Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.</p>
|
|
2065
1713
|
* @public
|
|
2066
1714
|
*/
|
|
2067
1715
|
LastModifiedBy?: UserContext | undefined;
|
|
@@ -2130,8 +1778,7 @@ export interface DescribeMlflowTrackingServerResponse {
|
|
|
2130
1778
|
*/
|
|
2131
1779
|
TrackingServerName?: string | undefined;
|
|
2132
1780
|
/**
|
|
2133
|
-
* <p>The S3 URI of the general purpose bucket used as the MLflow Tracking Server
|
|
2134
|
-
* artifact store.</p>
|
|
1781
|
+
* <p>The S3 URI of the general purpose bucket used as the MLflow Tracking Server artifact store.</p>
|
|
2135
1782
|
* @public
|
|
2136
1783
|
*/
|
|
2137
1784
|
ArtifactStoreUri?: string | undefined;
|
|
@@ -2146,8 +1793,7 @@ export interface DescribeMlflowTrackingServerResponse {
|
|
|
2146
1793
|
*/
|
|
2147
1794
|
MlflowVersion?: string | undefined;
|
|
2148
1795
|
/**
|
|
2149
|
-
* <p>The Amazon Resource Name (ARN) for an IAM role in your account that the described MLflow Tracking Server
|
|
2150
|
-
* uses to access the artifact store in Amazon S3.</p>
|
|
1796
|
+
* <p>The Amazon Resource Name (ARN) for an IAM role in your account that the described MLflow Tracking Server uses to access the artifact store in Amazon S3.</p>
|
|
2151
1797
|
* @public
|
|
2152
1798
|
*/
|
|
2153
1799
|
RoleArn?: string | undefined;
|
|
@@ -2182,8 +1828,7 @@ export interface DescribeMlflowTrackingServerResponse {
|
|
|
2182
1828
|
*/
|
|
2183
1829
|
CreationTime?: Date | undefined;
|
|
2184
1830
|
/**
|
|
2185
|
-
* <p>Information about the user who created or modified an experiment, trial, trial
|
|
2186
|
-
* component, lineage group, project, or model card.</p>
|
|
1831
|
+
* <p>Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.</p>
|
|
2187
1832
|
* @public
|
|
2188
1833
|
*/
|
|
2189
1834
|
CreatedBy?: UserContext | undefined;
|
|
@@ -2193,8 +1838,7 @@ export interface DescribeMlflowTrackingServerResponse {
|
|
|
2193
1838
|
*/
|
|
2194
1839
|
LastModifiedTime?: Date | undefined;
|
|
2195
1840
|
/**
|
|
2196
|
-
* <p>Information about the user who created or modified an experiment, trial, trial
|
|
2197
|
-
* component, lineage group, project, or model card.</p>
|
|
1841
|
+
* <p>Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.</p>
|
|
2198
1842
|
* @public
|
|
2199
1843
|
*/
|
|
2200
1844
|
LastModifiedBy?: UserContext | undefined;
|
|
@@ -2219,9 +1863,7 @@ export interface DescribeModelOutput {
|
|
|
2219
1863
|
*/
|
|
2220
1864
|
ModelName: string | undefined;
|
|
2221
1865
|
/**
|
|
2222
|
-
* <p>The location of the primary inference code, associated artifacts, and custom
|
|
2223
|
-
* environment map that the inference code uses when it is deployed in production.
|
|
2224
|
-
* </p>
|
|
1866
|
+
* <p>The location of the primary inference code, associated artifacts, and custom environment map that the inference code uses when it is deployed in production. </p>
|
|
2225
1867
|
* @public
|
|
2226
1868
|
*/
|
|
2227
1869
|
PrimaryContainer?: ContainerDefinition | undefined;
|
|
@@ -2236,16 +1878,12 @@ export interface DescribeModelOutput {
|
|
|
2236
1878
|
*/
|
|
2237
1879
|
InferenceExecutionConfig?: InferenceExecutionConfig | undefined;
|
|
2238
1880
|
/**
|
|
2239
|
-
* <p>The Amazon Resource Name (ARN) of the IAM role that you specified for the
|
|
2240
|
-
* model.</p>
|
|
1881
|
+
* <p>The Amazon Resource Name (ARN) of the IAM role that you specified for the model.</p>
|
|
2241
1882
|
* @public
|
|
2242
1883
|
*/
|
|
2243
1884
|
ExecutionRoleArn?: string | undefined;
|
|
2244
1885
|
/**
|
|
2245
|
-
* <p>A <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_VpcConfig.html">VpcConfig</a> object that specifies the VPC that this model has access to. For
|
|
2246
|
-
* more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/host-vpc.html">Protect Endpoints by Using an Amazon Virtual
|
|
2247
|
-
* Private Cloud</a>
|
|
2248
|
-
* </p>
|
|
1886
|
+
* <p>A <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_VpcConfig.html">VpcConfig</a> object that specifies the VPC that this model has access to. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/host-vpc.html">Protect Endpoints by Using an Amazon Virtual Private Cloud</a> </p>
|
|
2249
1887
|
* @public
|
|
2250
1888
|
*/
|
|
2251
1889
|
VpcConfig?: VpcConfig | undefined;
|
|
@@ -2260,8 +1898,7 @@ export interface DescribeModelOutput {
|
|
|
2260
1898
|
*/
|
|
2261
1899
|
ModelArn: string | undefined;
|
|
2262
1900
|
/**
|
|
2263
|
-
* <p>If <code>True</code>, no inbound or outbound network calls can be made to or from the
|
|
2264
|
-
* model container.</p>
|
|
1901
|
+
* <p>If <code>True</code>, no inbound or outbound network calls can be made to or from the model container.</p>
|
|
2265
1902
|
* @public
|
|
2266
1903
|
*/
|
|
2267
1904
|
EnableNetworkIsolation?: boolean | undefined;
|
|
@@ -2291,8 +1928,7 @@ export interface DescribeModelBiasJobDefinitionResponse {
|
|
|
2291
1928
|
*/
|
|
2292
1929
|
JobDefinitionArn: string | undefined;
|
|
2293
1930
|
/**
|
|
2294
|
-
* <p>The name of the bias job definition. The name must be unique within an Amazon Web Services
|
|
2295
|
-
* Region in the Amazon Web Services account.</p>
|
|
1931
|
+
* <p>The name of the bias job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.</p>
|
|
2296
1932
|
* @public
|
|
2297
1933
|
*/
|
|
2298
1934
|
JobDefinitionName: string | undefined;
|
|
@@ -2332,8 +1968,7 @@ export interface DescribeModelBiasJobDefinitionResponse {
|
|
|
2332
1968
|
*/
|
|
2333
1969
|
NetworkConfig?: MonitoringNetworkConfig | undefined;
|
|
2334
1970
|
/**
|
|
2335
|
-
* <p>The Amazon Resource Name (ARN) of the IAM role that has read permission to the
|
|
2336
|
-
* input data location and write permission to the output data location in Amazon S3.</p>
|
|
1971
|
+
* <p>The Amazon Resource Name (ARN) of the IAM role that has read permission to the input data location and write permission to the output data location in Amazon S3.</p>
|
|
2337
1972
|
* @public
|
|
2338
1973
|
*/
|
|
2339
1974
|
RoleArn: string | undefined;
|
|
@@ -2399,26 +2034,7 @@ export interface DescribeModelCardResponse {
|
|
|
2399
2034
|
*/
|
|
2400
2035
|
Content: string | undefined;
|
|
2401
2036
|
/**
|
|
2402
|
-
* <p>The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.</p>
|
|
2403
|
-
* <ul>
|
|
2404
|
-
* <li>
|
|
2405
|
-
* <p>
|
|
2406
|
-
* <code>Draft</code>: The model card is a work in progress.</p>
|
|
2407
|
-
* </li>
|
|
2408
|
-
* <li>
|
|
2409
|
-
* <p>
|
|
2410
|
-
* <code>PendingReview</code>: The model card is pending review.</p>
|
|
2411
|
-
* </li>
|
|
2412
|
-
* <li>
|
|
2413
|
-
* <p>
|
|
2414
|
-
* <code>Approved</code>: The model card is approved.</p>
|
|
2415
|
-
* </li>
|
|
2416
|
-
* <li>
|
|
2417
|
-
* <p>
|
|
2418
|
-
* <code>Archived</code>: The model card is archived. No more updates should be made to the model
|
|
2419
|
-
* card, but it can still be exported.</p>
|
|
2420
|
-
* </li>
|
|
2421
|
-
* </ul>
|
|
2037
|
+
* <p>The approval status of the model card 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>
|
|
2422
2038
|
* @public
|
|
2423
2039
|
*/
|
|
2424
2040
|
ModelCardStatus: ModelCardStatus | undefined;
|
|
@@ -2433,8 +2049,7 @@ export interface DescribeModelCardResponse {
|
|
|
2433
2049
|
*/
|
|
2434
2050
|
CreationTime: Date | undefined;
|
|
2435
2051
|
/**
|
|
2436
|
-
* <p>Information about the user who created or modified an experiment, trial, trial
|
|
2437
|
-
* component, lineage group, project, or model card.</p>
|
|
2052
|
+
* <p>Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.</p>
|
|
2438
2053
|
* @public
|
|
2439
2054
|
*/
|
|
2440
2055
|
CreatedBy: UserContext | undefined;
|
|
@@ -2444,39 +2059,12 @@ export interface DescribeModelCardResponse {
|
|
|
2444
2059
|
*/
|
|
2445
2060
|
LastModifiedTime?: Date | undefined;
|
|
2446
2061
|
/**
|
|
2447
|
-
* <p>Information about the user who created or modified an experiment, trial, trial
|
|
2448
|
-
* component, lineage group, project, or model card.</p>
|
|
2062
|
+
* <p>Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.</p>
|
|
2449
2063
|
* @public
|
|
2450
2064
|
*/
|
|
2451
2065
|
LastModifiedBy?: UserContext | undefined;
|
|
2452
2066
|
/**
|
|
2453
|
-
* <p>The processing status of model card deletion. The <code>ModelCardProcessingStatus</code> updates throughout the different deletion steps.</p>
|
|
2454
|
-
* <ul>
|
|
2455
|
-
* <li>
|
|
2456
|
-
* <p>
|
|
2457
|
-
* <code>DeletePending</code>: Model card deletion request received.</p>
|
|
2458
|
-
* </li>
|
|
2459
|
-
* <li>
|
|
2460
|
-
* <p>
|
|
2461
|
-
* <code>DeleteInProgress</code>: Model card deletion is in progress.</p>
|
|
2462
|
-
* </li>
|
|
2463
|
-
* <li>
|
|
2464
|
-
* <p>
|
|
2465
|
-
* <code>ContentDeleted</code>: Deleted model card content.</p>
|
|
2466
|
-
* </li>
|
|
2467
|
-
* <li>
|
|
2468
|
-
* <p>
|
|
2469
|
-
* <code>ExportJobsDeleted</code>: Deleted all export jobs associated with the model card.</p>
|
|
2470
|
-
* </li>
|
|
2471
|
-
* <li>
|
|
2472
|
-
* <p>
|
|
2473
|
-
* <code>DeleteCompleted</code>: Successfully deleted the model card.</p>
|
|
2474
|
-
* </li>
|
|
2475
|
-
* <li>
|
|
2476
|
-
* <p>
|
|
2477
|
-
* <code>DeleteFailed</code>: The model card failed to delete.</p>
|
|
2478
|
-
* </li>
|
|
2479
|
-
* </ul>
|
|
2067
|
+
* <p>The processing status of model card deletion. The <code>ModelCardProcessingStatus</code> updates throughout the different deletion steps.</p> <ul> <li> <p> <code>DeletePending</code>: Model card deletion request received.</p> </li> <li> <p> <code>DeleteInProgress</code>: Model card deletion is in progress.</p> </li> <li> <p> <code>ContentDeleted</code>: Deleted model card content.</p> </li> <li> <p> <code>ExportJobsDeleted</code>: Deleted all export jobs associated with the model card.</p> </li> <li> <p> <code>DeleteCompleted</code>: Successfully deleted the model card.</p> </li> <li> <p> <code>DeleteFailed</code>: The model card failed to delete.</p> </li> </ul>
|
|
2480
2068
|
* @public
|
|
2481
2069
|
*/
|
|
2482
2070
|
ModelCardProcessingStatus?: ModelCardProcessingStatus | undefined;
|
|
@@ -2530,23 +2118,7 @@ export interface DescribeModelCardExportJobResponse {
|
|
|
2530
2118
|
*/
|
|
2531
2119
|
ModelCardExportJobArn: string | undefined;
|
|
2532
2120
|
/**
|
|
2533
|
-
* <p>The completion status of the model card export job.</p>
|
|
2534
|
-
* <ul>
|
|
2535
|
-
* <li>
|
|
2536
|
-
* <p>
|
|
2537
|
-
* <code>InProgress</code>: The model card export job is in progress.</p>
|
|
2538
|
-
* </li>
|
|
2539
|
-
* <li>
|
|
2540
|
-
* <p>
|
|
2541
|
-
* <code>Completed</code>: The model card export job is complete.</p>
|
|
2542
|
-
* </li>
|
|
2543
|
-
* <li>
|
|
2544
|
-
* <p>
|
|
2545
|
-
* <code>Failed</code>: The model card export job failed. To see the reason for the failure, see
|
|
2546
|
-
* the <code>FailureReason</code> field in the response to a
|
|
2547
|
-
* <code>DescribeModelCardExportJob</code> call.</p>
|
|
2548
|
-
* </li>
|
|
2549
|
-
* </ul>
|
|
2121
|
+
* <p>The completion status of the model card export job.</p> <ul> <li> <p> <code>InProgress</code>: The model card export job is in progress.</p> </li> <li> <p> <code>Completed</code>: The model card export job is complete.</p> </li> <li> <p> <code>Failed</code>: The model card export job failed. To see the reason for the failure, see the <code>FailureReason</code> field in the response to a <code>DescribeModelCardExportJob</code> call.</p> </li> </ul>
|
|
2550
2122
|
* @public
|
|
2551
2123
|
*/
|
|
2552
2124
|
Status: ModelCardExportJobStatus | undefined;
|
|
@@ -2591,8 +2163,7 @@ export interface DescribeModelCardExportJobResponse {
|
|
|
2591
2163
|
*/
|
|
2592
2164
|
export interface DescribeModelExplainabilityJobDefinitionRequest {
|
|
2593
2165
|
/**
|
|
2594
|
-
* <p>The name of the model explainability job definition. The name must be unique within an
|
|
2595
|
-
* Amazon Web Services Region in the Amazon Web Services account.</p>
|
|
2166
|
+
* <p>The name of the model explainability job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.</p>
|
|
2596
2167
|
* @public
|
|
2597
2168
|
*/
|
|
2598
2169
|
JobDefinitionName: string | undefined;
|
|
@@ -2647,8 +2218,7 @@ export interface DescribeModelExplainabilityJobDefinitionResponse {
|
|
|
2647
2218
|
*/
|
|
2648
2219
|
NetworkConfig?: MonitoringNetworkConfig | undefined;
|
|
2649
2220
|
/**
|
|
2650
|
-
* <p>The Amazon Resource Name (ARN) of the IAM role that has read permission to the
|
|
2651
|
-
* input data location and write permission to the output data location in Amazon S3.</p>
|
|
2221
|
+
* <p>The Amazon Resource Name (ARN) of the IAM role that has read permission to the input data location and write permission to the output data location in Amazon S3.</p>
|
|
2652
2222
|
* @public
|
|
2653
2223
|
*/
|
|
2654
2224
|
RoleArn: string | undefined;
|
|
@@ -2663,9 +2233,7 @@ export interface DescribeModelExplainabilityJobDefinitionResponse {
|
|
|
2663
2233
|
*/
|
|
2664
2234
|
export interface DescribeModelPackageInput {
|
|
2665
2235
|
/**
|
|
2666
|
-
* <p>The name or Amazon Resource Name (ARN) of the model package to describe.</p>
|
|
2667
|
-
* <p>When you specify a name, the name must have 1 to 63 characters. Valid characters are
|
|
2668
|
-
* a-z, A-Z, 0-9, and - (hyphen).</p>
|
|
2236
|
+
* <p>The name or Amazon Resource Name (ARN) of the model package to describe.</p> <p>When you specify a name, the name must have 1 to 63 characters. Valid characters are a-z, A-Z, 0-9, and - (hyphen).</p>
|
|
2669
2237
|
* @public
|
|
2670
2238
|
*/
|
|
2671
2239
|
ModelPackageName: string | undefined;
|
|
@@ -2731,8 +2299,7 @@ export interface DescribeModelPackageOutput {
|
|
|
2731
2299
|
*/
|
|
2732
2300
|
ModelPackageName: string | undefined;
|
|
2733
2301
|
/**
|
|
2734
|
-
* <p>If the model is a versioned model, the name of the model group that the versioned
|
|
2735
|
-
* model belongs to.</p>
|
|
2302
|
+
* <p>If the model is a versioned model, the name of the model group that the versioned model belongs to.</p>
|
|
2736
2303
|
* @public
|
|
2737
2304
|
*/
|
|
2738
2305
|
ModelPackageGroupName?: string | undefined;
|
|
@@ -2757,8 +2324,7 @@ export interface DescribeModelPackageOutput {
|
|
|
2757
2324
|
*/
|
|
2758
2325
|
CreationTime: Date | undefined;
|
|
2759
2326
|
/**
|
|
2760
|
-
* <p>Details about inference jobs that you can run with models based on this model
|
|
2761
|
-
* package.</p>
|
|
2327
|
+
* <p>Details about inference jobs that you can run with models based on this model package.</p>
|
|
2762
2328
|
* @public
|
|
2763
2329
|
*/
|
|
2764
2330
|
InferenceSpecification?: InferenceSpecification | undefined;
|
|
@@ -2768,8 +2334,7 @@ export interface DescribeModelPackageOutput {
|
|
|
2768
2334
|
*/
|
|
2769
2335
|
SourceAlgorithmSpecification?: SourceAlgorithmSpecification | undefined;
|
|
2770
2336
|
/**
|
|
2771
|
-
* <p>Configurations for one or more transform jobs that SageMaker runs to test the model
|
|
2772
|
-
* package.</p>
|
|
2337
|
+
* <p>Configurations for one or more transform jobs that SageMaker runs to test the model package.</p>
|
|
2773
2338
|
* @public
|
|
2774
2339
|
*/
|
|
2775
2340
|
ValidationSpecification?: ModelPackageValidationSpecification | undefined;
|
|
@@ -2784,8 +2349,7 @@ export interface DescribeModelPackageOutput {
|
|
|
2784
2349
|
*/
|
|
2785
2350
|
ModelPackageStatusDetails: ModelPackageStatusDetails | undefined;
|
|
2786
2351
|
/**
|
|
2787
|
-
* <p>Whether the model package is certified for listing on Amazon Web Services
|
|
2788
|
-
* Marketplace.</p>
|
|
2352
|
+
* <p>Whether the model package is certified for listing on Amazon Web Services Marketplace.</p>
|
|
2789
2353
|
* @public
|
|
2790
2354
|
*/
|
|
2791
2355
|
CertifyForMarketplace?: boolean | undefined;
|
|
@@ -2795,8 +2359,7 @@ export interface DescribeModelPackageOutput {
|
|
|
2795
2359
|
*/
|
|
2796
2360
|
ModelApprovalStatus?: ModelApprovalStatus | undefined;
|
|
2797
2361
|
/**
|
|
2798
|
-
* <p>Information about the user who created or modified an experiment, trial, trial
|
|
2799
|
-
* component, lineage group, project, or model card.</p>
|
|
2362
|
+
* <p>Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.</p>
|
|
2800
2363
|
* @public
|
|
2801
2364
|
*/
|
|
2802
2365
|
CreatedBy?: UserContext | undefined;
|
|
@@ -2816,8 +2379,7 @@ export interface DescribeModelPackageOutput {
|
|
|
2816
2379
|
*/
|
|
2817
2380
|
LastModifiedTime?: Date | undefined;
|
|
2818
2381
|
/**
|
|
2819
|
-
* <p>Information about the user who created or modified an experiment, trial, trial
|
|
2820
|
-
* component, lineage group, project, or model card.</p>
|
|
2382
|
+
* <p>Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.</p>
|
|
2821
2383
|
* @public
|
|
2822
2384
|
*/
|
|
2823
2385
|
LastModifiedBy?: UserContext | undefined;
|
|
@@ -2827,20 +2389,17 @@ export interface DescribeModelPackageOutput {
|
|
|
2827
2389
|
*/
|
|
2828
2390
|
ApprovalDescription?: string | undefined;
|
|
2829
2391
|
/**
|
|
2830
|
-
* <p>The machine learning domain of the model package you specified. Common machine
|
|
2831
|
-
* learning domains include computer vision and natural language processing.</p>
|
|
2392
|
+
* <p>The machine learning domain of the model package you specified. Common machine learning domains include computer vision and natural language processing.</p>
|
|
2832
2393
|
* @public
|
|
2833
2394
|
*/
|
|
2834
2395
|
Domain?: string | undefined;
|
|
2835
2396
|
/**
|
|
2836
|
-
* <p>The machine learning task you specified that your model package accomplishes. Common
|
|
2837
|
-
* machine learning tasks include object detection and image classification.</p>
|
|
2397
|
+
* <p>The machine learning task you specified that your model package accomplishes. Common machine learning tasks include object detection and image classification.</p>
|
|
2838
2398
|
* @public
|
|
2839
2399
|
*/
|
|
2840
2400
|
Task?: string | undefined;
|
|
2841
2401
|
/**
|
|
2842
|
-
* <p>The Amazon Simple Storage Service (Amazon S3) path where the sample payload are stored. This path points to a
|
|
2843
|
-
* single gzip compressed tar archive (.tar.gz suffix).</p>
|
|
2402
|
+
* <p>The Amazon Simple Storage Service (Amazon S3) path where the sample payload are stored. This path points to a single gzip compressed tar archive (.tar.gz suffix).</p>
|
|
2844
2403
|
* @public
|
|
2845
2404
|
*/
|
|
2846
2405
|
SamplePayloadUrl?: string | undefined;
|
|
@@ -2850,17 +2409,12 @@ export interface DescribeModelPackageOutput {
|
|
|
2850
2409
|
*/
|
|
2851
2410
|
CustomerMetadataProperties?: Record<string, string> | undefined;
|
|
2852
2411
|
/**
|
|
2853
|
-
* <p>Represents the drift check baselines that can be used when the model monitor is set
|
|
2854
|
-
* using the model package. For more information, see the topic on <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/pipelines-quality-clarify-baseline-lifecycle.html#pipelines-quality-clarify-baseline-drift-detection">Drift Detection against Previous Baselines in SageMaker
|
|
2855
|
-
* Pipelines</a> in the <i>Amazon SageMaker Developer Guide</i>. </p>
|
|
2412
|
+
* <p>Represents the drift check baselines that can be used when the model monitor is set using the model package. For more information, see the topic on <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/pipelines-quality-clarify-baseline-lifecycle.html#pipelines-quality-clarify-baseline-drift-detection">Drift Detection against Previous Baselines in SageMaker Pipelines</a> in the <i>Amazon SageMaker Developer Guide</i>. </p>
|
|
2856
2413
|
* @public
|
|
2857
2414
|
*/
|
|
2858
2415
|
DriftCheckBaselines?: DriftCheckBaselines | undefined;
|
|
2859
2416
|
/**
|
|
2860
|
-
* <p>An array of additional Inference Specification objects. Each additional Inference
|
|
2861
|
-
* Specification specifies artifacts based on this model package that can be used on
|
|
2862
|
-
* inference endpoints. Generally used with SageMaker Neo to store the compiled
|
|
2863
|
-
* artifacts.</p>
|
|
2417
|
+
* <p>An array of additional Inference Specification objects. Each additional Inference Specification specifies artifacts based on this model package that can be used on inference endpoints. Generally used with SageMaker Neo to store the compiled artifacts.</p>
|
|
2864
2418
|
* @public
|
|
2865
2419
|
*/
|
|
2866
2420
|
AdditionalInferenceSpecifications?: AdditionalInferenceSpecificationDefinition[] | undefined;
|
|
@@ -2875,22 +2429,12 @@ export interface DescribeModelPackageOutput {
|
|
|
2875
2429
|
*/
|
|
2876
2430
|
SourceUri?: string | undefined;
|
|
2877
2431
|
/**
|
|
2878
|
-
* <p>The KMS Key ID (<code>KMSKeyId</code>) used for encryption of model
|
|
2879
|
-
* package information.</p>
|
|
2432
|
+
* <p>The KMS Key ID (<code>KMSKeyId</code>) used for encryption of model package information.</p>
|
|
2880
2433
|
* @public
|
|
2881
2434
|
*/
|
|
2882
2435
|
SecurityConfig?: ModelPackageSecurityConfig | undefined;
|
|
2883
2436
|
/**
|
|
2884
|
-
* <p>The model card associated with the model package. Since
|
|
2885
|
-
* <code>ModelPackageModelCard</code> is tied to a model package, it is a specific
|
|
2886
|
-
* usage of a model card and its schema is simplified compared to the schema of
|
|
2887
|
-
* <code>ModelCard</code>. The <code>ModelPackageModelCard</code> schema does not
|
|
2888
|
-
* include <code>model_package_details</code>, and <code>model_overview</code> is composed
|
|
2889
|
-
* of the <code>model_creator</code> and <code>model_artifact</code> properties. For more
|
|
2890
|
-
* information about the model package model card schema, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/model-registry-details.html#model-card-schema">Model
|
|
2891
|
-
* package model card schema</a>. For more information about the model card
|
|
2892
|
-
* associated with the model package, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/model-registry-details.html">View the Details of a Model
|
|
2893
|
-
* Version</a>.</p>
|
|
2437
|
+
* <p>The model card associated with the model package. Since <code>ModelPackageModelCard</code> is tied to a model package, it is a specific usage of a model card and its schema is simplified compared to the schema of <code>ModelCard</code>. The <code>ModelPackageModelCard</code> schema does not include <code>model_package_details</code>, and <code>model_overview</code> is composed of the <code>model_creator</code> and <code>model_artifact</code> properties. For more information about the model package model card schema, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/model-registry-details.html#model-card-schema">Model package model card schema</a>. For more information about the model card associated with the model package, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/model-registry-details.html">View the Details of a Model Version</a>.</p>
|
|
2894
2438
|
* @public
|
|
2895
2439
|
*/
|
|
2896
2440
|
ModelCard?: ModelPackageModelCard | undefined;
|
|
@@ -2951,8 +2495,7 @@ export interface DescribeModelPackageGroupOutput {
|
|
|
2951
2495
|
*/
|
|
2952
2496
|
CreationTime: Date | undefined;
|
|
2953
2497
|
/**
|
|
2954
|
-
* <p>Information about the user who created or modified an experiment, trial, trial
|
|
2955
|
-
* component, lineage group, project, or model card.</p>
|
|
2498
|
+
* <p>Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.</p>
|
|
2956
2499
|
* @public
|
|
2957
2500
|
*/
|
|
2958
2501
|
CreatedBy: UserContext | undefined;
|
|
@@ -2967,8 +2510,7 @@ export interface DescribeModelPackageGroupOutput {
|
|
|
2967
2510
|
*/
|
|
2968
2511
|
export interface DescribeModelQualityJobDefinitionRequest {
|
|
2969
2512
|
/**
|
|
2970
|
-
* <p>The name of the model quality job. The name must be unique within an Amazon Web Services
|
|
2971
|
-
* Region in the Amazon Web Services account.</p>
|
|
2513
|
+
* <p>The name of the model quality job. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.</p>
|
|
2972
2514
|
* @public
|
|
2973
2515
|
*/
|
|
2974
2516
|
JobDefinitionName: string | undefined;
|
|
@@ -3023,8 +2565,7 @@ export interface DescribeModelQualityJobDefinitionResponse {
|
|
|
3023
2565
|
*/
|
|
3024
2566
|
NetworkConfig?: MonitoringNetworkConfig | undefined;
|
|
3025
2567
|
/**
|
|
3026
|
-
* <p>The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker AI can
|
|
3027
|
-
* assume to perform tasks on your behalf.</p>
|
|
2568
|
+
* <p>The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker AI can assume to perform tasks on your behalf.</p>
|
|
3028
2569
|
* @public
|
|
3029
2570
|
*/
|
|
3030
2571
|
RoleArn: string | undefined;
|
|
@@ -3151,35 +2692,12 @@ export interface DescribeMonitoringScheduleResponse {
|
|
|
3151
2692
|
*/
|
|
3152
2693
|
MonitoringScheduleStatus: ScheduleStatus | undefined;
|
|
3153
2694
|
/**
|
|
3154
|
-
* <p>The type of the monitoring job that this schedule runs. This is one of the following
|
|
3155
|
-
* values.</p>
|
|
3156
|
-
* <ul>
|
|
3157
|
-
* <li>
|
|
3158
|
-
* <p>
|
|
3159
|
-
* <code>DATA_QUALITY</code> - The schedule is for a data quality monitoring
|
|
3160
|
-
* job.</p>
|
|
3161
|
-
* </li>
|
|
3162
|
-
* <li>
|
|
3163
|
-
* <p>
|
|
3164
|
-
* <code>MODEL_QUALITY</code> - The schedule is for a model quality monitoring
|
|
3165
|
-
* job.</p>
|
|
3166
|
-
* </li>
|
|
3167
|
-
* <li>
|
|
3168
|
-
* <p>
|
|
3169
|
-
* <code>MODEL_BIAS</code> - The schedule is for a bias monitoring job.</p>
|
|
3170
|
-
* </li>
|
|
3171
|
-
* <li>
|
|
3172
|
-
* <p>
|
|
3173
|
-
* <code>MODEL_EXPLAINABILITY</code> - The schedule is for an explainability
|
|
3174
|
-
* monitoring job.</p>
|
|
3175
|
-
* </li>
|
|
3176
|
-
* </ul>
|
|
2695
|
+
* <p>The type of the monitoring job that this schedule runs. This is one of the following values.</p> <ul> <li> <p> <code>DATA_QUALITY</code> - The schedule is for a data quality monitoring job.</p> </li> <li> <p> <code>MODEL_QUALITY</code> - The schedule is for a model quality monitoring job.</p> </li> <li> <p> <code>MODEL_BIAS</code> - The schedule is for a bias monitoring job.</p> </li> <li> <p> <code>MODEL_EXPLAINABILITY</code> - The schedule is for an explainability monitoring job.</p> </li> </ul>
|
|
3177
2696
|
* @public
|
|
3178
2697
|
*/
|
|
3179
2698
|
MonitoringType?: MonitoringType | undefined;
|
|
3180
2699
|
/**
|
|
3181
|
-
* <p>A string, up to one KB in size, that contains the reason a monitoring job failed, if it
|
|
3182
|
-
* failed.</p>
|
|
2700
|
+
* <p>A string, up to one KB in size, that contains the reason a monitoring job failed, if it failed.</p>
|
|
3183
2701
|
* @public
|
|
3184
2702
|
*/
|
|
3185
2703
|
FailureReason?: string | undefined;
|
|
@@ -3194,8 +2712,7 @@ export interface DescribeMonitoringScheduleResponse {
|
|
|
3194
2712
|
*/
|
|
3195
2713
|
LastModifiedTime: Date | undefined;
|
|
3196
2714
|
/**
|
|
3197
|
-
* <p>The configuration object that specifies the monitoring schedule and defines the monitoring
|
|
3198
|
-
* job.</p>
|
|
2715
|
+
* <p>The configuration object that specifies the monitoring schedule and defines the monitoring job.</p>
|
|
3199
2716
|
* @public
|
|
3200
2717
|
*/
|
|
3201
2718
|
MonitoringScheduleConfig: MonitoringScheduleConfig | undefined;
|
|
@@ -3262,8 +2779,7 @@ export interface DescribeNotebookInstanceOutput {
|
|
|
3262
2779
|
*/
|
|
3263
2780
|
FailureReason?: string | undefined;
|
|
3264
2781
|
/**
|
|
3265
|
-
* <p>The URL that you use to connect to the Jupyter notebook that is running in your
|
|
3266
|
-
* notebook instance. </p>
|
|
2782
|
+
* <p>The URL that you use to connect to the Jupyter notebook that is running in your notebook instance. </p>
|
|
3267
2783
|
* @public
|
|
3268
2784
|
*/
|
|
3269
2785
|
Url?: string | undefined;
|
|
@@ -3283,49 +2799,37 @@ export interface DescribeNotebookInstanceOutput {
|
|
|
3283
2799
|
*/
|
|
3284
2800
|
SecurityGroups?: string[] | undefined;
|
|
3285
2801
|
/**
|
|
3286
|
-
* <p>The Amazon Resource Name (ARN) of the IAM role associated with the instance.
|
|
3287
|
-
* </p>
|
|
2802
|
+
* <p>The Amazon Resource Name (ARN) of the IAM role associated with the instance. </p>
|
|
3288
2803
|
* @public
|
|
3289
2804
|
*/
|
|
3290
2805
|
RoleArn?: string | undefined;
|
|
3291
2806
|
/**
|
|
3292
|
-
* <p>The Amazon Web Services KMS key ID SageMaker AI uses to encrypt data when
|
|
3293
|
-
* storing it on the ML storage volume attached to the instance. </p>
|
|
2807
|
+
* <p>The Amazon Web Services KMS key ID SageMaker AI uses to encrypt data when storing it on the ML storage volume attached to the instance. </p>
|
|
3294
2808
|
* @public
|
|
3295
2809
|
*/
|
|
3296
2810
|
KmsKeyId?: string | undefined;
|
|
3297
2811
|
/**
|
|
3298
|
-
* <p>The network interface IDs that SageMaker AI created at the time of creating
|
|
3299
|
-
* the instance. </p>
|
|
2812
|
+
* <p>The network interface IDs that SageMaker AI created at the time of creating the instance. </p>
|
|
3300
2813
|
* @public
|
|
3301
2814
|
*/
|
|
3302
2815
|
NetworkInterfaceId?: string | undefined;
|
|
3303
2816
|
/**
|
|
3304
|
-
* <p>A timestamp. Use this parameter to retrieve the time when the notebook instance was
|
|
3305
|
-
* last modified. </p>
|
|
2817
|
+
* <p>A timestamp. Use this parameter to retrieve the time when the notebook instance was last modified. </p>
|
|
3306
2818
|
* @public
|
|
3307
2819
|
*/
|
|
3308
2820
|
LastModifiedTime?: Date | undefined;
|
|
3309
2821
|
/**
|
|
3310
|
-
* <p>A timestamp. Use this parameter to return the time when the notebook instance was
|
|
3311
|
-
* created</p>
|
|
2822
|
+
* <p>A timestamp. Use this parameter to return the time when the notebook instance was created</p>
|
|
3312
2823
|
* @public
|
|
3313
2824
|
*/
|
|
3314
2825
|
CreationTime?: Date | undefined;
|
|
3315
2826
|
/**
|
|
3316
|
-
* <p>Returns the name of a notebook instance lifecycle configuration.</p>
|
|
3317
|
-
* <p>For information about notebook instance lifestyle configurations, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/notebook-lifecycle-config.html">Step
|
|
3318
|
-
* 2.1: (Optional) Customize a Notebook Instance</a>
|
|
3319
|
-
* </p>
|
|
2827
|
+
* <p>Returns the name of a notebook instance lifecycle configuration.</p> <p>For information about notebook instance lifestyle configurations, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/notebook-lifecycle-config.html">Step 2.1: (Optional) Customize a Notebook Instance</a> </p>
|
|
3320
2828
|
* @public
|
|
3321
2829
|
*/
|
|
3322
2830
|
NotebookInstanceLifecycleConfigName?: string | undefined;
|
|
3323
2831
|
/**
|
|
3324
|
-
* <p>Describes whether SageMaker AI provides internet access to the notebook instance.
|
|
3325
|
-
* If this value is set to <i>Disabled</i>, the notebook instance does not
|
|
3326
|
-
* have internet access, and cannot connect to SageMaker AI training and endpoint
|
|
3327
|
-
* services.</p>
|
|
3328
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/appendix-additional-considerations.html#appendix-notebook-and-internet-access">Notebook Instances Are Internet-Enabled by Default</a>.</p>
|
|
2832
|
+
* <p>Describes whether SageMaker AI provides internet access to the notebook instance. If this value is set to <i>Disabled</i>, the notebook instance does not have internet access, and cannot connect to SageMaker AI training and endpoint services.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/appendix-additional-considerations.html#appendix-notebook-and-internet-access">Notebook Instances Are Internet-Enabled by Default</a>.</p>
|
|
3329
2833
|
* @public
|
|
3330
2834
|
*/
|
|
3331
2835
|
DirectInternetAccess?: DirectInternetAccess | undefined;
|
|
@@ -3335,41 +2839,22 @@ export interface DescribeNotebookInstanceOutput {
|
|
|
3335
2839
|
*/
|
|
3336
2840
|
VolumeSizeInGB?: number | undefined;
|
|
3337
2841
|
/**
|
|
3338
|
-
* <p>This parameter is no longer supported. Elastic Inference (EI) is no longer
|
|
3339
|
-
* available.</p>
|
|
3340
|
-
* <p>This parameter was used to specify a list of the EI instance types associated with
|
|
3341
|
-
* this notebook instance.</p>
|
|
2842
|
+
* <p>This parameter is no longer supported. Elastic Inference (EI) is no longer available.</p> <p>This parameter was used to specify a list of the EI instance types associated with this notebook instance.</p>
|
|
3342
2843
|
* @public
|
|
3343
2844
|
*/
|
|
3344
2845
|
AcceleratorTypes?: NotebookInstanceAcceleratorType[] | undefined;
|
|
3345
2846
|
/**
|
|
3346
|
-
* <p>The Git repository associated with the notebook instance as its default code
|
|
3347
|
-
* repository. This can be either the name of a Git repository stored as a resource in your
|
|
3348
|
-
* account, or the URL of a Git repository in <a href="https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html">Amazon Web Services CodeCommit</a>
|
|
3349
|
-
* or in any other Git repository. When you open a notebook instance, it opens in the
|
|
3350
|
-
* directory that contains this repository. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html">Associating Git
|
|
3351
|
-
* Repositories with SageMaker AI Notebook Instances</a>.</p>
|
|
2847
|
+
* <p>The Git repository associated with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in <a href="https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html">Amazon Web Services CodeCommit</a> or in any other Git repository. When you open a notebook instance, it opens in the directory that contains this repository. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html">Associating Git Repositories with SageMaker AI Notebook Instances</a>.</p>
|
|
3352
2848
|
* @public
|
|
3353
2849
|
*/
|
|
3354
2850
|
DefaultCodeRepository?: string | undefined;
|
|
3355
2851
|
/**
|
|
3356
|
-
* <p>An array of up to three Git repositories associated with the notebook instance. These
|
|
3357
|
-
* can be either the names of Git repositories stored as resources in your account, or the
|
|
3358
|
-
* URL of Git repositories in <a href="https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html">Amazon Web Services CodeCommit</a>
|
|
3359
|
-
* or in any other Git repository. These repositories are cloned at the same level as the
|
|
3360
|
-
* default repository of your notebook instance. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html">Associating Git
|
|
3361
|
-
* Repositories with SageMaker AI Notebook Instances</a>.</p>
|
|
2852
|
+
* <p>An array of up to three Git repositories associated with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in <a href="https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html">Amazon Web Services CodeCommit</a> or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html">Associating Git Repositories with SageMaker AI Notebook Instances</a>.</p>
|
|
3362
2853
|
* @public
|
|
3363
2854
|
*/
|
|
3364
2855
|
AdditionalCodeRepositories?: string[] | undefined;
|
|
3365
2856
|
/**
|
|
3366
|
-
* <p>Whether root access is enabled or disabled for users of the notebook instance.</p>
|
|
3367
|
-
* <note>
|
|
3368
|
-
* <p>Lifecycle configurations need root access to be able to set up a notebook
|
|
3369
|
-
* instance. Because of this, lifecycle configurations associated with a notebook
|
|
3370
|
-
* instance always run with root access even if you disable root access for
|
|
3371
|
-
* users.</p>
|
|
3372
|
-
* </note>
|
|
2857
|
+
* <p>Whether root access is enabled or disabled for users of the notebook instance.</p> <note> <p>Lifecycle configurations need root access to be able to set up a notebook instance. Because of this, lifecycle configurations associated with a notebook instance always run with root access even if you disable root access for users.</p> </note>
|
|
3373
2858
|
* @public
|
|
3374
2859
|
*/
|
|
3375
2860
|
RootAccess?: RootAccess | undefined;
|
|
@@ -3414,8 +2899,7 @@ export interface DescribeNotebookInstanceLifecycleConfigOutput {
|
|
|
3414
2899
|
*/
|
|
3415
2900
|
OnCreate?: NotebookInstanceLifecycleHook[] | undefined;
|
|
3416
2901
|
/**
|
|
3417
|
-
* <p>The shell script that runs every time you start a notebook instance, including when
|
|
3418
|
-
* you create the notebook instance.</p>
|
|
2902
|
+
* <p>The shell script that runs every time you start a notebook instance, including when you create the notebook instance.</p>
|
|
3419
2903
|
* @public
|
|
3420
2904
|
*/
|
|
3421
2905
|
OnStart?: NotebookInstanceLifecycleHook[] | undefined;
|
|
@@ -3462,8 +2946,7 @@ export type OptimizationJobStatus = (typeof OptimizationJobStatus)[keyof typeof
|
|
|
3462
2946
|
*/
|
|
3463
2947
|
export interface OptimizationOutput {
|
|
3464
2948
|
/**
|
|
3465
|
-
* <p>The image that SageMaker recommends that you use to host the optimized model that you created
|
|
3466
|
-
* with an optimization job.</p>
|
|
2949
|
+
* <p>The image that SageMaker recommends that you use to host the optimized model that you created with an optimization job.</p>
|
|
3467
2950
|
* @public
|
|
3468
2951
|
*/
|
|
3469
2952
|
RecommendedInferenceImage?: string | undefined;
|
|
@@ -3503,8 +2986,7 @@ export interface DescribeOptimizationJobResponse {
|
|
|
3503
2986
|
*/
|
|
3504
2987
|
LastModifiedTime: Date | undefined;
|
|
3505
2988
|
/**
|
|
3506
|
-
* <p>If the optimization job status is <code>FAILED</code>, the reason for the
|
|
3507
|
-
* failure.</p>
|
|
2989
|
+
* <p>If the optimization job status is <code>FAILED</code>, the reason for the failure.</p>
|
|
3508
2990
|
* @public
|
|
3509
2991
|
*/
|
|
3510
2992
|
FailureReason?: string | undefined;
|
|
@@ -3549,22 +3031,7 @@ export interface DescribeOptimizationJobResponse {
|
|
|
3549
3031
|
*/
|
|
3550
3032
|
RoleArn: string | undefined;
|
|
3551
3033
|
/**
|
|
3552
|
-
* <p>Specifies a limit to how long a job can run. When the job reaches the time limit, SageMaker
|
|
3553
|
-
* ends the job. Use this API to cap costs.</p>
|
|
3554
|
-
* <p>To stop a training job, SageMaker sends the algorithm the <code>SIGTERM</code> signal,
|
|
3555
|
-
* which delays job termination for 120 seconds. Algorithms can use this 120-second window
|
|
3556
|
-
* to save the model artifacts, so the results of training are not lost. </p>
|
|
3557
|
-
* <p>The training algorithms provided by SageMaker automatically save the intermediate results
|
|
3558
|
-
* of a model training job when possible. This attempt to save artifacts is only a best
|
|
3559
|
-
* effort case as model might not be in a state from which it can be saved. For example, if
|
|
3560
|
-
* training has just started, the model might not be ready to save. When saved, this
|
|
3561
|
-
* intermediate data is a valid model artifact. You can use it to create a model with
|
|
3562
|
-
* <code>CreateModel</code>.</p>
|
|
3563
|
-
* <note>
|
|
3564
|
-
* <p>The Neural Topic Model (NTM) currently does not support saving intermediate model
|
|
3565
|
-
* artifacts. When training NTMs, make sure that the maximum runtime is sufficient for
|
|
3566
|
-
* the training job to complete.</p>
|
|
3567
|
-
* </note>
|
|
3034
|
+
* <p>Specifies a limit to how long a job can run. When the job reaches the time limit, SageMaker ends the job. Use this API to cap costs.</p> <p>To stop a training job, SageMaker sends the algorithm the <code>SIGTERM</code> signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts, so the results of training are not lost. </p> <p>The training algorithms provided by SageMaker automatically save the intermediate results of a model training job when possible. This attempt to save artifacts is only a best effort case as model might not be in a state from which it can be saved. For example, if training has just started, the model might not be ready to save. When saved, this intermediate data is a valid model artifact. You can use it to create a model with <code>CreateModel</code>.</p> <note> <p>The Neural Topic Model (NTM) currently does not support saving intermediate model artifacts. When training NTMs, make sure that the maximum runtime is sufficient for the training job to complete.</p> </note>
|
|
3568
3035
|
* @public
|
|
3569
3036
|
*/
|
|
3570
3037
|
StoppingCondition: StoppingCondition | undefined;
|
|
@@ -3779,14 +3246,12 @@ export interface DescribePipelineResponse {
|
|
|
3779
3246
|
*/
|
|
3780
3247
|
LastRunTime?: Date | undefined;
|
|
3781
3248
|
/**
|
|
3782
|
-
* <p>Information about the user who created or modified an experiment, trial, trial
|
|
3783
|
-
* component, lineage group, project, or model card.</p>
|
|
3249
|
+
* <p>Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.</p>
|
|
3784
3250
|
* @public
|
|
3785
3251
|
*/
|
|
3786
3252
|
CreatedBy?: UserContext | undefined;
|
|
3787
3253
|
/**
|
|
3788
|
-
* <p>Information about the user who created or modified an experiment, trial, trial
|
|
3789
|
-
* component, lineage group, project, or model card.</p>
|
|
3254
|
+
* <p>Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.</p>
|
|
3790
3255
|
* @public
|
|
3791
3256
|
*/
|
|
3792
3257
|
LastModifiedBy?: UserContext | undefined;
|
|
@@ -3879,20 +3344,12 @@ export interface SelectedStep {
|
|
|
3879
3344
|
*/
|
|
3880
3345
|
export interface SelectiveExecutionConfig {
|
|
3881
3346
|
/**
|
|
3882
|
-
* <p>The ARN from a reference execution of the current pipeline.
|
|
3883
|
-
* Used to copy input collaterals needed for the selected steps to run.
|
|
3884
|
-
* The execution status of the pipeline can be either <code>Failed</code>
|
|
3885
|
-
* or <code>Success</code>.</p>
|
|
3886
|
-
* <p>This field is required if the steps you specify for
|
|
3887
|
-
* <code>SelectedSteps</code> depend on output collaterals from any non-specified pipeline
|
|
3888
|
-
* steps. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/pipelines-selective-ex.html">Selective
|
|
3889
|
-
* Execution for Pipeline Steps</a>.</p>
|
|
3347
|
+
* <p>The ARN from a reference execution of the current pipeline. Used to copy input collaterals needed for the selected steps to run. The execution status of the pipeline can be either <code>Failed</code> or <code>Success</code>.</p> <p>This field is required if the steps you specify for <code>SelectedSteps</code> depend on output collaterals from any non-specified pipeline steps. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/pipelines-selective-ex.html">Selective Execution for Pipeline Steps</a>.</p>
|
|
3890
3348
|
* @public
|
|
3891
3349
|
*/
|
|
3892
3350
|
SourcePipelineExecutionArn?: string | undefined;
|
|
3893
3351
|
/**
|
|
3894
|
-
* <p>A list of pipeline steps to run. All step(s) in all path(s) between
|
|
3895
|
-
* two selected steps should be included.</p>
|
|
3352
|
+
* <p>A list of pipeline steps to run. All step(s) in all path(s) between two selected steps should be included.</p>
|
|
3896
3353
|
* @public
|
|
3897
3354
|
*/
|
|
3898
3355
|
SelectedSteps: SelectedStep[] | undefined;
|
|
@@ -3947,14 +3404,12 @@ export interface DescribePipelineExecutionResponse {
|
|
|
3947
3404
|
*/
|
|
3948
3405
|
LastModifiedTime?: Date | undefined;
|
|
3949
3406
|
/**
|
|
3950
|
-
* <p>Information about the user who created or modified an experiment, trial, trial
|
|
3951
|
-
* component, lineage group, project, or model card.</p>
|
|
3407
|
+
* <p>Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.</p>
|
|
3952
3408
|
* @public
|
|
3953
3409
|
*/
|
|
3954
3410
|
CreatedBy?: UserContext | undefined;
|
|
3955
3411
|
/**
|
|
3956
|
-
* <p>Information about the user who created or modified an experiment, trial, trial
|
|
3957
|
-
* component, lineage group, project, or model card.</p>
|
|
3412
|
+
* <p>Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.</p>
|
|
3958
3413
|
* @public
|
|
3959
3414
|
*/
|
|
3960
3415
|
LastModifiedBy?: UserContext | undefined;
|
|
@@ -3974,8 +3429,7 @@ export interface DescribePipelineExecutionResponse {
|
|
|
3974
3429
|
*/
|
|
3975
3430
|
export interface DescribeProcessingJobRequest {
|
|
3976
3431
|
/**
|
|
3977
|
-
* <p>The name of the processing job. The name must be unique within an Amazon Web Services
|
|
3978
|
-
* Region in the Amazon Web Services account.</p>
|
|
3432
|
+
* <p>The name of the processing job. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.</p>
|
|
3979
3433
|
* @public
|
|
3980
3434
|
*/
|
|
3981
3435
|
ProcessingJobName: string | undefined;
|
|
@@ -4010,14 +3464,12 @@ export interface DescribeProcessingJobResponse {
|
|
|
4010
3464
|
*/
|
|
4011
3465
|
ProcessingOutputConfig?: ProcessingOutputConfig | undefined;
|
|
4012
3466
|
/**
|
|
4013
|
-
* <p>The name of the processing job. The name must be unique within an Amazon Web Services
|
|
4014
|
-
* Region in the Amazon Web Services account.</p>
|
|
3467
|
+
* <p>The name of the processing job. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.</p>
|
|
4015
3468
|
* @public
|
|
4016
3469
|
*/
|
|
4017
3470
|
ProcessingJobName: string | undefined;
|
|
4018
3471
|
/**
|
|
4019
|
-
* <p>Identifies the resources, ML compute instances, and ML storage volumes to deploy for a
|
|
4020
|
-
* processing job. In distributed training, you specify more than one instance.</p>
|
|
3472
|
+
* <p>Identifies the resources, ML compute instances, and ML storage volumes to deploy for a processing job. In distributed training, you specify more than one instance.</p>
|
|
4021
3473
|
* @public
|
|
4022
3474
|
*/
|
|
4023
3475
|
ProcessingResources: ProcessingResources | undefined;
|
|
@@ -4042,8 +3494,7 @@ export interface DescribeProcessingJobResponse {
|
|
|
4042
3494
|
*/
|
|
4043
3495
|
NetworkConfig?: NetworkConfig | undefined;
|
|
4044
3496
|
/**
|
|
4045
|
-
* <p>The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on
|
|
4046
|
-
* your behalf.</p>
|
|
3497
|
+
* <p>The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.</p>
|
|
4047
3498
|
* @public
|
|
4048
3499
|
*/
|
|
4049
3500
|
RoleArn?: string | undefined;
|
|
@@ -4063,14 +3514,12 @@ export interface DescribeProcessingJobResponse {
|
|
|
4063
3514
|
*/
|
|
4064
3515
|
ProcessingJobStatus: ProcessingJobStatus | undefined;
|
|
4065
3516
|
/**
|
|
4066
|
-
* <p>An optional string, up to one KB in size, that contains metadata from the processing
|
|
4067
|
-
* container when the processing job exits.</p>
|
|
3517
|
+
* <p>An optional string, up to one KB in size, that contains metadata from the processing container when the processing job exits.</p>
|
|
4068
3518
|
* @public
|
|
4069
3519
|
*/
|
|
4070
3520
|
ExitMessage?: string | undefined;
|
|
4071
3521
|
/**
|
|
4072
|
-
* <p>A string, up to one KB in size, that contains the reason a processing job failed, if
|
|
4073
|
-
* it failed.</p>
|
|
3522
|
+
* <p>A string, up to one KB in size, that contains the reason a processing job failed, if it failed.</p>
|
|
4074
3523
|
* @public
|
|
4075
3524
|
*/
|
|
4076
3525
|
FailureReason?: string | undefined;
|
|
@@ -4095,8 +3544,7 @@ export interface DescribeProcessingJobResponse {
|
|
|
4095
3544
|
*/
|
|
4096
3545
|
CreationTime: Date | undefined;
|
|
4097
3546
|
/**
|
|
4098
|
-
* <p>The ARN of a monitoring schedule for an endpoint associated with this processing
|
|
4099
|
-
* job.</p>
|
|
3547
|
+
* <p>The ARN of a monitoring schedule for an endpoint associated with this processing job.</p>
|
|
4100
3548
|
* @public
|
|
4101
3549
|
*/
|
|
4102
3550
|
MonitoringScheduleArn?: string | undefined;
|
|
@@ -4142,9 +3590,7 @@ export declare const ProjectStatus: {
|
|
|
4142
3590
|
*/
|
|
4143
3591
|
export type ProjectStatus = (typeof ProjectStatus)[keyof typeof ProjectStatus];
|
|
4144
3592
|
/**
|
|
4145
|
-
* <p>Details of a provisioned service catalog product. For information about service catalog,
|
|
4146
|
-
* see <a href="https://docs.aws.amazon.com/servicecatalog/latest/adminguide/introduction.html">What is Amazon Web Services Service
|
|
4147
|
-
* Catalog</a>.</p>
|
|
3593
|
+
* <p>Details of a provisioned service catalog product. For information about service catalog, see <a href="https://docs.aws.amazon.com/servicecatalog/latest/adminguide/introduction.html">What is Amazon Web Services Service Catalog</a>.</p>
|
|
4148
3594
|
* @public
|
|
4149
3595
|
*/
|
|
4150
3596
|
export interface ServiceCatalogProvisionedProductDetails {
|
|
@@ -4154,29 +3600,7 @@ export interface ServiceCatalogProvisionedProductDetails {
|
|
|
4154
3600
|
*/
|
|
4155
3601
|
ProvisionedProductId?: string | undefined;
|
|
4156
3602
|
/**
|
|
4157
|
-
* <p>The current status of the product.</p>
|
|
4158
|
-
* <ul>
|
|
4159
|
-
* <li>
|
|
4160
|
-
* <p>
|
|
4161
|
-
* <code>AVAILABLE</code> - Stable state, ready to perform any operation. The most recent operation succeeded and completed.</p>
|
|
4162
|
-
* </li>
|
|
4163
|
-
* <li>
|
|
4164
|
-
* <p>
|
|
4165
|
-
* <code>UNDER_CHANGE</code> - Transitive state. Operations performed might not have valid results. Wait for an AVAILABLE status before performing operations.</p>
|
|
4166
|
-
* </li>
|
|
4167
|
-
* <li>
|
|
4168
|
-
* <p>
|
|
4169
|
-
* <code>TAINTED</code> - Stable state, ready to perform any operation. The stack has completed the requested operation but is not exactly what was requested. For example, a request to update to a new version failed and the stack rolled back to the current version.</p>
|
|
4170
|
-
* </li>
|
|
4171
|
-
* <li>
|
|
4172
|
-
* <p>
|
|
4173
|
-
* <code>ERROR</code> - An unexpected error occurred. The provisioned product exists but the stack is not running. For example, CloudFormation received a parameter value that was not valid and could not launch the stack.</p>
|
|
4174
|
-
* </li>
|
|
4175
|
-
* <li>
|
|
4176
|
-
* <p>
|
|
4177
|
-
* <code>PLAN_IN_PROGRESS</code> - Transitive state. The plan operations were performed to provision a new product, but resources have not yet been created. After reviewing the list of resources to be created, execute the plan. Wait for an AVAILABLE status before performing operations.</p>
|
|
4178
|
-
* </li>
|
|
4179
|
-
* </ul>
|
|
3603
|
+
* <p>The current status of the product.</p> <ul> <li> <p> <code>AVAILABLE</code> - Stable state, ready to perform any operation. The most recent operation succeeded and completed.</p> </li> <li> <p> <code>UNDER_CHANGE</code> - Transitive state. Operations performed might not have valid results. Wait for an AVAILABLE status before performing operations.</p> </li> <li> <p> <code>TAINTED</code> - Stable state, ready to perform any operation. The stack has completed the requested operation but is not exactly what was requested. For example, a request to update to a new version failed and the stack rolled back to the current version.</p> </li> <li> <p> <code>ERROR</code> - An unexpected error occurred. The provisioned product exists but the stack is not running. For example, CloudFormation received a parameter value that was not valid and could not launch the stack.</p> </li> <li> <p> <code>PLAN_IN_PROGRESS</code> - Transitive state. The plan operations were performed to provision a new product, but resources have not yet been created. After reviewing the list of resources to be created, execute the plan. Wait for an AVAILABLE status before performing operations.</p> </li> </ul>
|
|
4180
3604
|
* @public
|
|
4181
3605
|
*/
|
|
4182
3606
|
ProvisionedProductStatusMessage?: string | undefined;
|
|
@@ -4206,8 +3630,7 @@ export interface DescribeProjectOutput {
|
|
|
4206
3630
|
*/
|
|
4207
3631
|
ProjectDescription?: string | undefined;
|
|
4208
3632
|
/**
|
|
4209
|
-
* <p>Information used to provision a service catalog product. For information, see <a href="https://docs.aws.amazon.com/servicecatalog/latest/adminguide/introduction.html">What is Amazon Web Services Service
|
|
4210
|
-
* Catalog</a>.</p>
|
|
3633
|
+
* <p>Information used to provision a service catalog product. For information, see <a href="https://docs.aws.amazon.com/servicecatalog/latest/adminguide/introduction.html">What is Amazon Web Services Service Catalog</a>.</p>
|
|
4211
3634
|
* @public
|
|
4212
3635
|
*/
|
|
4213
3636
|
ServiceCatalogProvisioningDetails?: ServiceCatalogProvisioningDetails | undefined;
|
|
@@ -4222,8 +3645,7 @@ export interface DescribeProjectOutput {
|
|
|
4222
3645
|
*/
|
|
4223
3646
|
ProjectStatus: ProjectStatus | undefined;
|
|
4224
3647
|
/**
|
|
4225
|
-
* <p>Information about the user who created or modified an experiment, trial, trial
|
|
4226
|
-
* component, lineage group, project, or model card.</p>
|
|
3648
|
+
* <p>Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.</p>
|
|
4227
3649
|
* @public
|
|
4228
3650
|
*/
|
|
4229
3651
|
CreatedBy?: UserContext | undefined;
|
|
@@ -4238,8 +3660,7 @@ export interface DescribeProjectOutput {
|
|
|
4238
3660
|
*/
|
|
4239
3661
|
LastModifiedTime?: Date | undefined;
|
|
4240
3662
|
/**
|
|
4241
|
-
* <p>Information about the user who created or modified an experiment, trial, trial
|
|
4242
|
-
* component, lineage group, project, or model card.</p>
|
|
3663
|
+
* <p>Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.</p>
|
|
4243
3664
|
* @public
|
|
4244
3665
|
*/
|
|
4245
3666
|
LastModifiedBy?: UserContext | undefined;
|
|
@@ -4341,26 +3762,7 @@ export interface DescribeSpaceResponse {
|
|
|
4341
3762
|
*/
|
|
4342
3763
|
SpaceDisplayName?: string | undefined;
|
|
4343
3764
|
/**
|
|
4344
|
-
* <p>Returns the URL of the space. If the space is created with Amazon Web Services IAM Identity
|
|
4345
|
-
* Center (Successor to Amazon Web Services Single Sign-On) authentication, users can navigate to
|
|
4346
|
-
* the URL after appending the respective redirect parameter for the application type to be
|
|
4347
|
-
* federated through Amazon Web Services IAM Identity Center.</p>
|
|
4348
|
-
* <p>The following application types are supported:</p>
|
|
4349
|
-
* <ul>
|
|
4350
|
-
* <li>
|
|
4351
|
-
* <p>Studio Classic: <code>&redirect=JupyterServer</code>
|
|
4352
|
-
* </p>
|
|
4353
|
-
* </li>
|
|
4354
|
-
* <li>
|
|
4355
|
-
* <p>JupyterLab: <code>&redirect=JupyterLab</code>
|
|
4356
|
-
* </p>
|
|
4357
|
-
* </li>
|
|
4358
|
-
* <li>
|
|
4359
|
-
* <p>Code Editor, based on Code-OSS, Visual Studio Code - Open Source:
|
|
4360
|
-
* <code>&redirect=CodeEditor</code>
|
|
4361
|
-
* </p>
|
|
4362
|
-
* </li>
|
|
4363
|
-
* </ul>
|
|
3765
|
+
* <p>Returns the URL of the space. If the space is created with Amazon Web Services IAM Identity Center (Successor to Amazon Web Services Single Sign-On) authentication, users can navigate to the URL after appending the respective redirect parameter for the application type to be federated through Amazon Web Services IAM Identity Center.</p> <p>The following application types are supported:</p> <ul> <li> <p>Studio Classic: <code>&redirect=JupyterServer</code> </p> </li> <li> <p>JupyterLab: <code>&redirect=JupyterLab</code> </p> </li> <li> <p>Code Editor, based on Code-OSS, Visual Studio Code - Open Source: <code>&redirect=CodeEditor</code> </p> </li> </ul>
|
|
4364
3766
|
* @public
|
|
4365
3767
|
*/
|
|
4366
3768
|
Url?: string | undefined;
|
|
@@ -4385,8 +3787,7 @@ export interface DescribeStudioLifecycleConfigResponse {
|
|
|
4385
3787
|
*/
|
|
4386
3788
|
StudioLifecycleConfigArn?: string | undefined;
|
|
4387
3789
|
/**
|
|
4388
|
-
* <p>The name of the Amazon SageMaker AI Studio Lifecycle Configuration that is
|
|
4389
|
-
* described.</p>
|
|
3790
|
+
* <p>The name of the Amazon SageMaker AI Studio Lifecycle Configuration that is described.</p>
|
|
4390
3791
|
* @public
|
|
4391
3792
|
*/
|
|
4392
3793
|
StudioLifecycleConfigName?: string | undefined;
|
|
@@ -4396,8 +3797,7 @@ export interface DescribeStudioLifecycleConfigResponse {
|
|
|
4396
3797
|
*/
|
|
4397
3798
|
CreationTime?: Date | undefined;
|
|
4398
3799
|
/**
|
|
4399
|
-
* <p>This value is equivalent to CreationTime because Amazon SageMaker AI Studio Lifecycle
|
|
4400
|
-
* Configurations are immutable.</p>
|
|
3800
|
+
* <p>This value is equivalent to CreationTime because Amazon SageMaker AI Studio Lifecycle Configurations are immutable.</p>
|
|
4401
3801
|
* @public
|
|
4402
3802
|
*/
|
|
4403
3803
|
LastModifiedTime?: Date | undefined;
|
|
@@ -4565,188 +3965,27 @@ export declare const SecondaryStatus: {
|
|
|
4565
3965
|
*/
|
|
4566
3966
|
export type SecondaryStatus = (typeof SecondaryStatus)[keyof typeof SecondaryStatus];
|
|
4567
3967
|
/**
|
|
4568
|
-
* <p>An array element of <code>SecondaryStatusTransitions</code> for <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeTrainingJob.html">DescribeTrainingJob</a>. It provides additional details about a status that the
|
|
4569
|
-
* training job has transitioned through. A training job can be in one of several states,
|
|
4570
|
-
* for example, starting, downloading, training, or uploading. Within each state, there are
|
|
4571
|
-
* a number of intermediate states. For example, within the starting state, SageMaker could be
|
|
4572
|
-
* starting the training job or launching the ML instances. These transitional states are
|
|
4573
|
-
* referred to as the job's secondary
|
|
4574
|
-
* status.
|
|
4575
|
-
* </p>
|
|
4576
|
-
* <p></p>
|
|
3968
|
+
* <p>An array element of <code>SecondaryStatusTransitions</code> for <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeTrainingJob.html">DescribeTrainingJob</a>. It provides additional details about a status that the training job has transitioned through. A training job can be in one of several states, for example, starting, downloading, training, or uploading. Within each state, there are a number of intermediate states. For example, within the starting state, SageMaker could be starting the training job or launching the ML instances. These transitional states are referred to as the job's secondary status. </p> <p/>
|
|
4577
3969
|
* @public
|
|
4578
3970
|
*/
|
|
4579
3971
|
export interface SecondaryStatusTransition {
|
|
4580
3972
|
/**
|
|
4581
|
-
* <p>Contains a secondary status information from a training
|
|
4582
|
-
* job.</p>
|
|
4583
|
-
* <p>Status might be one of the following secondary statuses:</p>
|
|
4584
|
-
* <dl>
|
|
4585
|
-
* <dt>InProgress</dt>
|
|
4586
|
-
* <dd>
|
|
4587
|
-
* <ul>
|
|
4588
|
-
* <li>
|
|
4589
|
-
* <p>
|
|
4590
|
-
* <code>Starting</code>
|
|
4591
|
-
* - Starting the training job.</p>
|
|
4592
|
-
* </li>
|
|
4593
|
-
* <li>
|
|
4594
|
-
* <p>
|
|
4595
|
-
* <code>Downloading</code> - An optional stage for algorithms that
|
|
4596
|
-
* support <code>File</code> training input mode. It indicates that
|
|
4597
|
-
* data is being downloaded to the ML storage volumes.</p>
|
|
4598
|
-
* </li>
|
|
4599
|
-
* <li>
|
|
4600
|
-
* <p>
|
|
4601
|
-
* <code>Training</code> - Training is in progress.</p>
|
|
4602
|
-
* </li>
|
|
4603
|
-
* <li>
|
|
4604
|
-
* <p>
|
|
4605
|
-
* <code>Uploading</code> - Training is complete and the model
|
|
4606
|
-
* artifacts are being uploaded to the S3 location.</p>
|
|
4607
|
-
* </li>
|
|
4608
|
-
* </ul>
|
|
4609
|
-
* </dd>
|
|
4610
|
-
* <dt>Completed</dt>
|
|
4611
|
-
* <dd>
|
|
4612
|
-
* <ul>
|
|
4613
|
-
* <li>
|
|
4614
|
-
* <p>
|
|
4615
|
-
* <code>Completed</code> - The training job has completed.</p>
|
|
4616
|
-
* </li>
|
|
4617
|
-
* </ul>
|
|
4618
|
-
* </dd>
|
|
4619
|
-
* <dt>Failed</dt>
|
|
4620
|
-
* <dd>
|
|
4621
|
-
* <ul>
|
|
4622
|
-
* <li>
|
|
4623
|
-
* <p>
|
|
4624
|
-
* <code>Failed</code> - The training job has failed. The reason for
|
|
4625
|
-
* the failure is returned in the <code>FailureReason</code> field of
|
|
4626
|
-
* <code>DescribeTrainingJobResponse</code>.</p>
|
|
4627
|
-
* </li>
|
|
4628
|
-
* </ul>
|
|
4629
|
-
* </dd>
|
|
4630
|
-
* <dt>Stopped</dt>
|
|
4631
|
-
* <dd>
|
|
4632
|
-
* <ul>
|
|
4633
|
-
* <li>
|
|
4634
|
-
* <p>
|
|
4635
|
-
* <code>MaxRuntimeExceeded</code> - The job stopped because it
|
|
4636
|
-
* exceeded the maximum allowed runtime.</p>
|
|
4637
|
-
* </li>
|
|
4638
|
-
* <li>
|
|
4639
|
-
* <p>
|
|
4640
|
-
* <code>Stopped</code> - The training job has stopped.</p>
|
|
4641
|
-
* </li>
|
|
4642
|
-
* </ul>
|
|
4643
|
-
* </dd>
|
|
4644
|
-
* <dt>Stopping</dt>
|
|
4645
|
-
* <dd>
|
|
4646
|
-
* <ul>
|
|
4647
|
-
* <li>
|
|
4648
|
-
* <p>
|
|
4649
|
-
* <code>Stopping</code> - Stopping the training job.</p>
|
|
4650
|
-
* </li>
|
|
4651
|
-
* </ul>
|
|
4652
|
-
* </dd>
|
|
4653
|
-
* </dl>
|
|
4654
|
-
* <p>We no longer support the following secondary statuses:</p>
|
|
4655
|
-
* <ul>
|
|
4656
|
-
* <li>
|
|
4657
|
-
* <p>
|
|
4658
|
-
* <code>LaunchingMLInstances</code>
|
|
4659
|
-
* </p>
|
|
4660
|
-
* </li>
|
|
4661
|
-
* <li>
|
|
4662
|
-
* <p>
|
|
4663
|
-
* <code>PreparingTrainingStack</code>
|
|
4664
|
-
* </p>
|
|
4665
|
-
* </li>
|
|
4666
|
-
* <li>
|
|
4667
|
-
* <p>
|
|
4668
|
-
* <code>DownloadingTrainingImage</code>
|
|
4669
|
-
* </p>
|
|
4670
|
-
* </li>
|
|
4671
|
-
* </ul>
|
|
3973
|
+
* <p>Contains a secondary status information from a training job.</p> <p>Status might be one of the following secondary statuses:</p> <dl> <dt>InProgress</dt> <dd> <ul> <li> <p> <code>Starting</code> - Starting the training job.</p> </li> <li> <p> <code>Downloading</code> - An optional stage for algorithms that support <code>File</code> training input mode. It indicates that data is being downloaded to the ML storage volumes.</p> </li> <li> <p> <code>Training</code> - Training is in progress.</p> </li> <li> <p> <code>Uploading</code> - Training is complete and the model artifacts are being uploaded to the S3 location.</p> </li> </ul> </dd> <dt>Completed</dt> <dd> <ul> <li> <p> <code>Completed</code> - The training job has completed.</p> </li> </ul> </dd> <dt>Failed</dt> <dd> <ul> <li> <p> <code>Failed</code> - The training job has failed. The reason for the failure is returned in the <code>FailureReason</code> field of <code>DescribeTrainingJobResponse</code>.</p> </li> </ul> </dd> <dt>Stopped</dt> <dd> <ul> <li> <p> <code>MaxRuntimeExceeded</code> - The job stopped because it exceeded the maximum allowed runtime.</p> </li> <li> <p> <code>Stopped</code> - The training job has stopped.</p> </li> </ul> </dd> <dt>Stopping</dt> <dd> <ul> <li> <p> <code>Stopping</code> - Stopping the training job.</p> </li> </ul> </dd> </dl> <p>We no longer support the following secondary statuses:</p> <ul> <li> <p> <code>LaunchingMLInstances</code> </p> </li> <li> <p> <code>PreparingTrainingStack</code> </p> </li> <li> <p> <code>DownloadingTrainingImage</code> </p> </li> </ul>
|
|
4672
3974
|
* @public
|
|
4673
3975
|
*/
|
|
4674
3976
|
Status: SecondaryStatus | undefined;
|
|
4675
3977
|
/**
|
|
4676
|
-
* <p>A timestamp that shows when the training job transitioned to the current secondary
|
|
4677
|
-
* status state.</p>
|
|
3978
|
+
* <p>A timestamp that shows when the training job transitioned to the current secondary status state.</p>
|
|
4678
3979
|
* @public
|
|
4679
3980
|
*/
|
|
4680
3981
|
StartTime: Date | undefined;
|
|
4681
3982
|
/**
|
|
4682
|
-
* <p>A timestamp that shows when the training job transitioned out of this secondary status
|
|
4683
|
-
* state into another secondary status state or when the training job has ended.</p>
|
|
3983
|
+
* <p>A timestamp that shows when the training job transitioned out of this secondary status state into another secondary status state or when the training job has ended.</p>
|
|
4684
3984
|
* @public
|
|
4685
3985
|
*/
|
|
4686
3986
|
EndTime?: Date | undefined;
|
|
4687
3987
|
/**
|
|
4688
|
-
* <p>A detailed description of the progress within a secondary status.
|
|
4689
|
-
* </p>
|
|
4690
|
-
* <p>SageMaker provides secondary statuses and status messages that apply to each of
|
|
4691
|
-
* them:</p>
|
|
4692
|
-
* <dl>
|
|
4693
|
-
* <dt>Starting</dt>
|
|
4694
|
-
* <dd>
|
|
4695
|
-
* <ul>
|
|
4696
|
-
* <li>
|
|
4697
|
-
* <p>Starting the training job.</p>
|
|
4698
|
-
* </li>
|
|
4699
|
-
* <li>
|
|
4700
|
-
* <p>Launching requested ML
|
|
4701
|
-
* instances.</p>
|
|
4702
|
-
* </li>
|
|
4703
|
-
* <li>
|
|
4704
|
-
* <p>Insufficient
|
|
4705
|
-
* capacity error from EC2 while launching instances,
|
|
4706
|
-
* retrying!</p>
|
|
4707
|
-
* </li>
|
|
4708
|
-
* <li>
|
|
4709
|
-
* <p>Launched
|
|
4710
|
-
* instance was unhealthy, replacing it!</p>
|
|
4711
|
-
* </li>
|
|
4712
|
-
* <li>
|
|
4713
|
-
* <p>Preparing the instances for training.</p>
|
|
4714
|
-
* </li>
|
|
4715
|
-
* </ul>
|
|
4716
|
-
* </dd>
|
|
4717
|
-
* <dt>Training</dt>
|
|
4718
|
-
* <dd>
|
|
4719
|
-
* <ul>
|
|
4720
|
-
* <li>
|
|
4721
|
-
* <p>Training
|
|
4722
|
-
* image download completed. Training in
|
|
4723
|
-
* progress.</p>
|
|
4724
|
-
* </li>
|
|
4725
|
-
* </ul>
|
|
4726
|
-
* </dd>
|
|
4727
|
-
* </dl>
|
|
4728
|
-
* <important>
|
|
4729
|
-
* <p>Status messages are subject to change. Therefore, we recommend not including them
|
|
4730
|
-
* in code that programmatically initiates actions. For examples, don't use status
|
|
4731
|
-
* messages in if statements.</p>
|
|
4732
|
-
* </important>
|
|
4733
|
-
* <p>To have an overview of your training job's progress, view
|
|
4734
|
-
* <code>TrainingJobStatus</code> and <code>SecondaryStatus</code> in <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeTrainingJob.html">DescribeTrainingJob</a>, and <code>StatusMessage</code> together. For example,
|
|
4735
|
-
* at the start of a training job, you might see the following:</p>
|
|
4736
|
-
* <ul>
|
|
4737
|
-
* <li>
|
|
4738
|
-
* <p>
|
|
4739
|
-
* <code>TrainingJobStatus</code> - InProgress</p>
|
|
4740
|
-
* </li>
|
|
4741
|
-
* <li>
|
|
4742
|
-
* <p>
|
|
4743
|
-
* <code>SecondaryStatus</code> - Training</p>
|
|
4744
|
-
* </li>
|
|
4745
|
-
* <li>
|
|
4746
|
-
* <p>
|
|
4747
|
-
* <code>StatusMessage</code> - Downloading the training image</p>
|
|
4748
|
-
* </li>
|
|
4749
|
-
* </ul>
|
|
3988
|
+
* <p>A detailed description of the progress within a secondary status. </p> <p>SageMaker provides secondary statuses and status messages that apply to each of them:</p> <dl> <dt>Starting</dt> <dd> <ul> <li> <p>Starting the training job.</p> </li> <li> <p>Launching requested ML instances.</p> </li> <li> <p>Insufficient capacity error from EC2 while launching instances, retrying!</p> </li> <li> <p>Launched instance was unhealthy, replacing it!</p> </li> <li> <p>Preparing the instances for training.</p> </li> </ul> </dd> <dt>Training</dt> <dd> <ul> <li> <p>Training image download completed. Training in progress.</p> </li> </ul> </dd> </dl> <important> <p>Status messages are subject to change. Therefore, we recommend not including them in code that programmatically initiates actions. For examples, don't use status messages in if statements.</p> </important> <p>To have an overview of your training job's progress, view <code>TrainingJobStatus</code> and <code>SecondaryStatus</code> in <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeTrainingJob.html">DescribeTrainingJob</a>, and <code>StatusMessage</code> together. For example, at the start of a training job, you might see the following:</p> <ul> <li> <p> <code>TrainingJobStatus</code> - InProgress</p> </li> <li> <p> <code>SecondaryStatus</code> - Training</p> </li> <li> <p> <code>StatusMessage</code> - Downloading the training image</p> </li> </ul>
|
|
4750
3989
|
* @public
|
|
4751
3990
|
*/
|
|
4752
3991
|
StatusMessage?: string | undefined;
|
|
@@ -4771,40 +4010,12 @@ export type WarmPoolResourceStatus = (typeof WarmPoolResourceStatus)[keyof typeo
|
|
|
4771
4010
|
*/
|
|
4772
4011
|
export interface WarmPoolStatus {
|
|
4773
4012
|
/**
|
|
4774
|
-
* <p>The status of the warm pool.</p>
|
|
4775
|
-
* <ul>
|
|
4776
|
-
* <li>
|
|
4777
|
-
* <p>
|
|
4778
|
-
* <code>InUse</code>: The warm pool is in use for the training job.</p>
|
|
4779
|
-
* </li>
|
|
4780
|
-
* <li>
|
|
4781
|
-
* <p>
|
|
4782
|
-
* <code>Available</code>: The warm pool is available to reuse for a matching
|
|
4783
|
-
* training job.</p>
|
|
4784
|
-
* </li>
|
|
4785
|
-
* <li>
|
|
4786
|
-
* <p>
|
|
4787
|
-
* <code>Reused</code>: The warm pool moved to a matching training job for
|
|
4788
|
-
* reuse.</p>
|
|
4789
|
-
* </li>
|
|
4790
|
-
* <li>
|
|
4791
|
-
* <p>
|
|
4792
|
-
* <code>Terminated</code>: The warm pool is no longer available. Warm pools are
|
|
4793
|
-
* unavailable if they are terminated by a user, terminated for a patch update, or
|
|
4794
|
-
* terminated for exceeding the specified
|
|
4795
|
-
* <code>KeepAlivePeriodInSeconds</code>.</p>
|
|
4796
|
-
* </li>
|
|
4797
|
-
* </ul>
|
|
4013
|
+
* <p>The status of the warm pool.</p> <ul> <li> <p> <code>InUse</code>: The warm pool is in use for the training job.</p> </li> <li> <p> <code>Available</code>: The warm pool is available to reuse for a matching training job.</p> </li> <li> <p> <code>Reused</code>: The warm pool moved to a matching training job for reuse.</p> </li> <li> <p> <code>Terminated</code>: The warm pool is no longer available. Warm pools are unavailable if they are terminated by a user, terminated for a patch update, or terminated for exceeding the specified <code>KeepAlivePeriodInSeconds</code>.</p> </li> </ul>
|
|
4798
4014
|
* @public
|
|
4799
4015
|
*/
|
|
4800
4016
|
Status: WarmPoolResourceStatus | undefined;
|
|
4801
4017
|
/**
|
|
4802
|
-
* <p>The billable time in seconds used by the warm pool. Billable time refers to the
|
|
4803
|
-
* absolute wall-clock time.</p>
|
|
4804
|
-
* <p>Multiply <code>ResourceRetainedBillableTimeInSeconds</code> by the number of instances
|
|
4805
|
-
* (<code>InstanceCount</code>) in your training cluster to get the total compute time
|
|
4806
|
-
* SageMaker bills you if you run warm pool training. The formula is as follows:
|
|
4807
|
-
* <code>ResourceRetainedBillableTimeInSeconds * InstanceCount</code>.</p>
|
|
4018
|
+
* <p>The billable time in seconds used by the warm pool. Billable time refers to the absolute wall-clock time.</p> <p>Multiply <code>ResourceRetainedBillableTimeInSeconds</code> by the number of instances (<code>InstanceCount</code>) in your training cluster to get the total compute time SageMaker bills you if you run warm pool training. The formula is as follows: <code>ResourceRetainedBillableTimeInSeconds * InstanceCount</code>.</p>
|
|
4808
4019
|
* @public
|
|
4809
4020
|
*/
|
|
4810
4021
|
ResourceRetainedBillableTimeInSeconds?: number | undefined;
|
|
@@ -4829,14 +4040,12 @@ export interface DescribeTrainingJobResponse {
|
|
|
4829
4040
|
*/
|
|
4830
4041
|
TrainingJobArn: string | undefined;
|
|
4831
4042
|
/**
|
|
4832
|
-
* <p>The Amazon Resource Name (ARN) of the associated hyperparameter tuning job if the
|
|
4833
|
-
* training job was launched by a hyperparameter tuning job.</p>
|
|
4043
|
+
* <p>The Amazon Resource Name (ARN) of the associated hyperparameter tuning job if the training job was launched by a hyperparameter tuning job.</p>
|
|
4834
4044
|
* @public
|
|
4835
4045
|
*/
|
|
4836
4046
|
TuningJobArn?: string | undefined;
|
|
4837
4047
|
/**
|
|
4838
|
-
* <p>The Amazon Resource Name (ARN) of the SageMaker Ground Truth labeling job that created the
|
|
4839
|
-
* transform or training job.</p>
|
|
4048
|
+
* <p>The Amazon Resource Name (ARN) of the SageMaker Ground Truth labeling job that created the transform or training job.</p>
|
|
4840
4049
|
* @public
|
|
4841
4050
|
*/
|
|
4842
4051
|
LabelingJobArn?: string | undefined;
|
|
@@ -4846,149 +4055,17 @@ export interface DescribeTrainingJobResponse {
|
|
|
4846
4055
|
*/
|
|
4847
4056
|
AutoMLJobArn?: string | undefined;
|
|
4848
4057
|
/**
|
|
4849
|
-
* <p>Information about the Amazon S3 location that is configured for storing model artifacts.
|
|
4850
|
-
* </p>
|
|
4058
|
+
* <p>Information about the Amazon S3 location that is configured for storing model artifacts. </p>
|
|
4851
4059
|
* @public
|
|
4852
4060
|
*/
|
|
4853
4061
|
ModelArtifacts: ModelArtifacts | undefined;
|
|
4854
4062
|
/**
|
|
4855
|
-
* <p>The status of the training job.</p>
|
|
4856
|
-
* <p>SageMaker provides the following training job statuses:</p>
|
|
4857
|
-
* <ul>
|
|
4858
|
-
* <li>
|
|
4859
|
-
* <p>
|
|
4860
|
-
* <code>InProgress</code> - The training is in progress.</p>
|
|
4861
|
-
* </li>
|
|
4862
|
-
* <li>
|
|
4863
|
-
* <p>
|
|
4864
|
-
* <code>Completed</code> - The training job has completed.</p>
|
|
4865
|
-
* </li>
|
|
4866
|
-
* <li>
|
|
4867
|
-
* <p>
|
|
4868
|
-
* <code>Failed</code> - The training job has failed. To see the reason for the
|
|
4869
|
-
* failure, see the <code>FailureReason</code> field in the response to a
|
|
4870
|
-
* <code>DescribeTrainingJobResponse</code> call.</p>
|
|
4871
|
-
* </li>
|
|
4872
|
-
* <li>
|
|
4873
|
-
* <p>
|
|
4874
|
-
* <code>Stopping</code> - The training job is stopping.</p>
|
|
4875
|
-
* </li>
|
|
4876
|
-
* <li>
|
|
4877
|
-
* <p>
|
|
4878
|
-
* <code>Stopped</code> - The training job has stopped.</p>
|
|
4879
|
-
* </li>
|
|
4880
|
-
* </ul>
|
|
4881
|
-
* <p>For more detailed information, see <code>SecondaryStatus</code>. </p>
|
|
4063
|
+
* <p>The status of the training job.</p> <p>SageMaker provides the following training job statuses:</p> <ul> <li> <p> <code>InProgress</code> - The training is in progress.</p> </li> <li> <p> <code>Completed</code> - The training job has completed.</p> </li> <li> <p> <code>Failed</code> - The training job has failed. To see the reason for the failure, see the <code>FailureReason</code> field in the response to a <code>DescribeTrainingJobResponse</code> call.</p> </li> <li> <p> <code>Stopping</code> - The training job is stopping.</p> </li> <li> <p> <code>Stopped</code> - The training job has stopped.</p> </li> </ul> <p>For more detailed information, see <code>SecondaryStatus</code>. </p>
|
|
4882
4064
|
* @public
|
|
4883
4065
|
*/
|
|
4884
4066
|
TrainingJobStatus: TrainingJobStatus | undefined;
|
|
4885
4067
|
/**
|
|
4886
|
-
* <p> Provides detailed information about the state of the training job. For detailed
|
|
4887
|
-
* information on the secondary status of the training job, see <code>StatusMessage</code>
|
|
4888
|
-
* under <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_SecondaryStatusTransition.html">SecondaryStatusTransition</a>.</p>
|
|
4889
|
-
* <p>SageMaker provides primary statuses and secondary statuses that apply to each of
|
|
4890
|
-
* them:</p>
|
|
4891
|
-
* <dl>
|
|
4892
|
-
* <dt>InProgress</dt>
|
|
4893
|
-
* <dd>
|
|
4894
|
-
* <ul>
|
|
4895
|
-
* <li>
|
|
4896
|
-
* <p>
|
|
4897
|
-
* <code>Starting</code>
|
|
4898
|
-
* - Starting the training job.</p>
|
|
4899
|
-
* </li>
|
|
4900
|
-
* <li>
|
|
4901
|
-
* <p>
|
|
4902
|
-
* <code>Downloading</code> - An optional stage for algorithms that
|
|
4903
|
-
* support <code>File</code> training input mode. It indicates that
|
|
4904
|
-
* data is being downloaded to the ML storage volumes.</p>
|
|
4905
|
-
* </li>
|
|
4906
|
-
* <li>
|
|
4907
|
-
* <p>
|
|
4908
|
-
* <code>Training</code> - Training is in progress.</p>
|
|
4909
|
-
* </li>
|
|
4910
|
-
* <li>
|
|
4911
|
-
* <p>
|
|
4912
|
-
* <code>Interrupted</code> - The job stopped because the managed
|
|
4913
|
-
* spot training instances were interrupted. </p>
|
|
4914
|
-
* </li>
|
|
4915
|
-
* <li>
|
|
4916
|
-
* <p>
|
|
4917
|
-
* <code>Uploading</code> - Training is complete and the model
|
|
4918
|
-
* artifacts are being uploaded to the S3 location.</p>
|
|
4919
|
-
* </li>
|
|
4920
|
-
* </ul>
|
|
4921
|
-
* </dd>
|
|
4922
|
-
* <dt>Completed</dt>
|
|
4923
|
-
* <dd>
|
|
4924
|
-
* <ul>
|
|
4925
|
-
* <li>
|
|
4926
|
-
* <p>
|
|
4927
|
-
* <code>Completed</code> - The training job has completed.</p>
|
|
4928
|
-
* </li>
|
|
4929
|
-
* </ul>
|
|
4930
|
-
* </dd>
|
|
4931
|
-
* <dt>Failed</dt>
|
|
4932
|
-
* <dd>
|
|
4933
|
-
* <ul>
|
|
4934
|
-
* <li>
|
|
4935
|
-
* <p>
|
|
4936
|
-
* <code>Failed</code> - The training job has failed. The reason for
|
|
4937
|
-
* the failure is returned in the <code>FailureReason</code> field of
|
|
4938
|
-
* <code>DescribeTrainingJobResponse</code>.</p>
|
|
4939
|
-
* </li>
|
|
4940
|
-
* </ul>
|
|
4941
|
-
* </dd>
|
|
4942
|
-
* <dt>Stopped</dt>
|
|
4943
|
-
* <dd>
|
|
4944
|
-
* <ul>
|
|
4945
|
-
* <li>
|
|
4946
|
-
* <p>
|
|
4947
|
-
* <code>MaxRuntimeExceeded</code> - The job stopped because it
|
|
4948
|
-
* exceeded the maximum allowed runtime.</p>
|
|
4949
|
-
* </li>
|
|
4950
|
-
* <li>
|
|
4951
|
-
* <p>
|
|
4952
|
-
* <code>MaxWaitTimeExceeded</code> - The job stopped because it
|
|
4953
|
-
* exceeded the maximum allowed wait time.</p>
|
|
4954
|
-
* </li>
|
|
4955
|
-
* <li>
|
|
4956
|
-
* <p>
|
|
4957
|
-
* <code>Stopped</code> - The training job has stopped.</p>
|
|
4958
|
-
* </li>
|
|
4959
|
-
* </ul>
|
|
4960
|
-
* </dd>
|
|
4961
|
-
* <dt>Stopping</dt>
|
|
4962
|
-
* <dd>
|
|
4963
|
-
* <ul>
|
|
4964
|
-
* <li>
|
|
4965
|
-
* <p>
|
|
4966
|
-
* <code>Stopping</code> - Stopping the training job.</p>
|
|
4967
|
-
* </li>
|
|
4968
|
-
* </ul>
|
|
4969
|
-
* </dd>
|
|
4970
|
-
* </dl>
|
|
4971
|
-
* <important>
|
|
4972
|
-
* <p>Valid values for <code>SecondaryStatus</code> are subject to change. </p>
|
|
4973
|
-
* </important>
|
|
4974
|
-
* <p>We no longer support the following secondary statuses:</p>
|
|
4975
|
-
* <ul>
|
|
4976
|
-
* <li>
|
|
4977
|
-
* <p>
|
|
4978
|
-
* <code>LaunchingMLInstances</code>
|
|
4979
|
-
* </p>
|
|
4980
|
-
* </li>
|
|
4981
|
-
* <li>
|
|
4982
|
-
* <p>
|
|
4983
|
-
* <code>PreparingTraining</code>
|
|
4984
|
-
* </p>
|
|
4985
|
-
* </li>
|
|
4986
|
-
* <li>
|
|
4987
|
-
* <p>
|
|
4988
|
-
* <code>DownloadingTrainingImage</code>
|
|
4989
|
-
* </p>
|
|
4990
|
-
* </li>
|
|
4991
|
-
* </ul>
|
|
4068
|
+
* <p> Provides detailed information about the state of the training job. For detailed information on the secondary status of the training job, see <code>StatusMessage</code> under <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_SecondaryStatusTransition.html">SecondaryStatusTransition</a>.</p> <p>SageMaker provides primary statuses and secondary statuses that apply to each of them:</p> <dl> <dt>InProgress</dt> <dd> <ul> <li> <p> <code>Starting</code> - Starting the training job.</p> </li> <li> <p> <code>Downloading</code> - An optional stage for algorithms that support <code>File</code> training input mode. It indicates that data is being downloaded to the ML storage volumes.</p> </li> <li> <p> <code>Training</code> - Training is in progress.</p> </li> <li> <p> <code>Interrupted</code> - The job stopped because the managed spot training instances were interrupted. </p> </li> <li> <p> <code>Uploading</code> - Training is complete and the model artifacts are being uploaded to the S3 location.</p> </li> </ul> </dd> <dt>Completed</dt> <dd> <ul> <li> <p> <code>Completed</code> - The training job has completed.</p> </li> </ul> </dd> <dt>Failed</dt> <dd> <ul> <li> <p> <code>Failed</code> - The training job has failed. The reason for the failure is returned in the <code>FailureReason</code> field of <code>DescribeTrainingJobResponse</code>.</p> </li> </ul> </dd> <dt>Stopped</dt> <dd> <ul> <li> <p> <code>MaxRuntimeExceeded</code> - The job stopped because it exceeded the maximum allowed runtime.</p> </li> <li> <p> <code>MaxWaitTimeExceeded</code> - The job stopped because it exceeded the maximum allowed wait time.</p> </li> <li> <p> <code>Stopped</code> - The training job has stopped.</p> </li> </ul> </dd> <dt>Stopping</dt> <dd> <ul> <li> <p> <code>Stopping</code> - Stopping the training job.</p> </li> </ul> </dd> </dl> <important> <p>Valid values for <code>SecondaryStatus</code> are subject to change. </p> </important> <p>We no longer support the following secondary statuses:</p> <ul> <li> <p> <code>LaunchingMLInstances</code> </p> </li> <li> <p> <code>PreparingTraining</code> </p> </li> <li> <p> <code>DownloadingTrainingImage</code> </p> </li> </ul>
|
|
4992
4069
|
* @public
|
|
4993
4070
|
*/
|
|
4994
4071
|
SecondaryStatus: SecondaryStatus | undefined;
|
|
@@ -5003,32 +4080,27 @@ export interface DescribeTrainingJobResponse {
|
|
|
5003
4080
|
*/
|
|
5004
4081
|
HyperParameters?: Record<string, string> | undefined;
|
|
5005
4082
|
/**
|
|
5006
|
-
* <p>Information about the algorithm used for training, and algorithm metadata.
|
|
5007
|
-
* </p>
|
|
4083
|
+
* <p>Information about the algorithm used for training, and algorithm metadata. </p>
|
|
5008
4084
|
* @public
|
|
5009
4085
|
*/
|
|
5010
4086
|
AlgorithmSpecification: AlgorithmSpecification | undefined;
|
|
5011
4087
|
/**
|
|
5012
|
-
* <p>The Amazon Web Services Identity and Access Management (IAM) role configured for
|
|
5013
|
-
* the training job. </p>
|
|
4088
|
+
* <p>The Amazon Web Services Identity and Access Management (IAM) role configured for the training job. </p>
|
|
5014
4089
|
* @public
|
|
5015
4090
|
*/
|
|
5016
4091
|
RoleArn?: string | undefined;
|
|
5017
4092
|
/**
|
|
5018
|
-
* <p>An array of <code>Channel</code> objects that describes each data input channel.
|
|
5019
|
-
* </p>
|
|
4093
|
+
* <p>An array of <code>Channel</code> objects that describes each data input channel. </p>
|
|
5020
4094
|
* @public
|
|
5021
4095
|
*/
|
|
5022
4096
|
InputDataConfig?: Channel[] | undefined;
|
|
5023
4097
|
/**
|
|
5024
|
-
* <p>The S3 path where model artifacts that you configured when creating the job are
|
|
5025
|
-
* stored. SageMaker creates subfolders for model artifacts. </p>
|
|
4098
|
+
* <p>The S3 path where model artifacts that you configured when creating the job are stored. SageMaker creates subfolders for model artifacts. </p>
|
|
5026
4099
|
* @public
|
|
5027
4100
|
*/
|
|
5028
4101
|
OutputDataConfig?: OutputDataConfig | undefined;
|
|
5029
4102
|
/**
|
|
5030
|
-
* <p>Resources, including ML compute instances and ML storage volumes, that are
|
|
5031
|
-
* configured for model training. </p>
|
|
4103
|
+
* <p>Resources, including ML compute instances and ML storage volumes, that are configured for model training. </p>
|
|
5032
4104
|
* @public
|
|
5033
4105
|
*/
|
|
5034
4106
|
ResourceConfig: ResourceConfig | undefined;
|
|
@@ -5038,19 +4110,12 @@ export interface DescribeTrainingJobResponse {
|
|
|
5038
4110
|
*/
|
|
5039
4111
|
WarmPoolStatus?: WarmPoolStatus | undefined;
|
|
5040
4112
|
/**
|
|
5041
|
-
* <p>A <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_VpcConfig.html">VpcConfig</a> object that specifies the VPC that this training job has access
|
|
5042
|
-
* to. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/train-vpc.html">Protect Training Jobs by Using an Amazon
|
|
5043
|
-
* Virtual Private Cloud</a>.</p>
|
|
4113
|
+
* <p>A <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_VpcConfig.html">VpcConfig</a> object that specifies the VPC that this training job has access to. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/train-vpc.html">Protect Training Jobs by Using an Amazon Virtual Private Cloud</a>.</p>
|
|
5044
4114
|
* @public
|
|
5045
4115
|
*/
|
|
5046
4116
|
VpcConfig?: VpcConfig | undefined;
|
|
5047
4117
|
/**
|
|
5048
|
-
* <p>Specifies a limit to how long a model training job can run. It also specifies how long
|
|
5049
|
-
* a managed Spot training job has to complete. When the job reaches the time limit, SageMaker
|
|
5050
|
-
* ends the training job. Use this API to cap model training costs.</p>
|
|
5051
|
-
* <p>To stop a job, SageMaker sends the algorithm the <code>SIGTERM</code> signal, which delays
|
|
5052
|
-
* job termination for 120 seconds. Algorithms can use this 120-second window to save the
|
|
5053
|
-
* model artifacts, so the results of training are not lost. </p>
|
|
4118
|
+
* <p>Specifies a limit to how long a model training job can run. It also specifies how long a managed Spot training job has to complete. When the job reaches the time limit, SageMaker ends the training job. Use this API to cap model training costs.</p> <p>To stop a job, SageMaker sends the algorithm the <code>SIGTERM</code> signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts, so the results of training are not lost. </p>
|
|
5054
4119
|
* @public
|
|
5055
4120
|
*/
|
|
5056
4121
|
StoppingCondition: StoppingCondition | undefined;
|
|
@@ -5060,67 +4125,47 @@ export interface DescribeTrainingJobResponse {
|
|
|
5060
4125
|
*/
|
|
5061
4126
|
CreationTime: Date | undefined;
|
|
5062
4127
|
/**
|
|
5063
|
-
* <p>Indicates the time when the training job starts on training instances. You are
|
|
5064
|
-
* billed for the time interval between this time and the value of
|
|
5065
|
-
* <code>TrainingEndTime</code>. The start time in CloudWatch Logs might be later than this time.
|
|
5066
|
-
* The difference is due to the time it takes to download the training data and to the size
|
|
5067
|
-
* of the training container.</p>
|
|
4128
|
+
* <p>Indicates the time when the training job starts on training instances. You are billed for the time interval between this time and the value of <code>TrainingEndTime</code>. The start time in CloudWatch Logs might be later than this time. The difference is due to the time it takes to download the training data and to the size of the training container.</p>
|
|
5068
4129
|
* @public
|
|
5069
4130
|
*/
|
|
5070
4131
|
TrainingStartTime?: Date | undefined;
|
|
5071
4132
|
/**
|
|
5072
|
-
* <p>Indicates the time when the training job ends on training instances. You are billed
|
|
5073
|
-
* for the time interval between the value of <code>TrainingStartTime</code> and this time.
|
|
5074
|
-
* For successful jobs and stopped jobs, this is the time after model artifacts are
|
|
5075
|
-
* uploaded. For failed jobs, this is the time when SageMaker detects a job failure.</p>
|
|
4133
|
+
* <p>Indicates the time when the training job ends on training instances. You are billed for the time interval between the value of <code>TrainingStartTime</code> and this time. For successful jobs and stopped jobs, this is the time after model artifacts are uploaded. For failed jobs, this is the time when SageMaker detects a job failure.</p>
|
|
5076
4134
|
* @public
|
|
5077
4135
|
*/
|
|
5078
4136
|
TrainingEndTime?: Date | undefined;
|
|
5079
4137
|
/**
|
|
5080
|
-
* <p>A timestamp that indicates when the status of the training job was last
|
|
5081
|
-
* modified.</p>
|
|
4138
|
+
* <p>A timestamp that indicates when the status of the training job was last modified.</p>
|
|
5082
4139
|
* @public
|
|
5083
4140
|
*/
|
|
5084
4141
|
LastModifiedTime?: Date | undefined;
|
|
5085
4142
|
/**
|
|
5086
|
-
* <p>A history of all of the secondary statuses that the training job has transitioned
|
|
5087
|
-
* through.</p>
|
|
4143
|
+
* <p>A history of all of the secondary statuses that the training job has transitioned through.</p>
|
|
5088
4144
|
* @public
|
|
5089
4145
|
*/
|
|
5090
4146
|
SecondaryStatusTransitions?: SecondaryStatusTransition[] | undefined;
|
|
5091
4147
|
/**
|
|
5092
|
-
* <p>A collection of <code>MetricData</code> objects that specify the names, values, and
|
|
5093
|
-
* dates and times that the training algorithm emitted to Amazon CloudWatch.</p>
|
|
4148
|
+
* <p>A collection of <code>MetricData</code> objects that specify the names, values, and dates and times that the training algorithm emitted to Amazon CloudWatch.</p>
|
|
5094
4149
|
* @public
|
|
5095
4150
|
*/
|
|
5096
4151
|
FinalMetricDataList?: MetricData[] | undefined;
|
|
5097
4152
|
/**
|
|
5098
|
-
* <p>If you want to allow inbound or outbound network calls, except for calls between peers
|
|
5099
|
-
* within a training cluster for distributed training, choose <code>True</code>. If you
|
|
5100
|
-
* enable network isolation for training jobs that are configured to use a VPC, SageMaker
|
|
5101
|
-
* downloads and uploads customer data and model artifacts through the specified VPC, but
|
|
5102
|
-
* the training container does not have network access.</p>
|
|
4153
|
+
* <p>If you want to allow inbound or outbound network calls, except for calls between peers within a training cluster for distributed training, choose <code>True</code>. If you enable network isolation for training jobs that are configured to use a VPC, SageMaker downloads and uploads customer data and model artifacts through the specified VPC, but the training container does not have network access.</p>
|
|
5103
4154
|
* @public
|
|
5104
4155
|
*/
|
|
5105
4156
|
EnableNetworkIsolation?: boolean | undefined;
|
|
5106
4157
|
/**
|
|
5107
|
-
* <p>To encrypt all communications between ML compute instances in distributed training,
|
|
5108
|
-
* choose <code>True</code>. Encryption provides greater security for distributed training,
|
|
5109
|
-
* but training might take longer. How long it takes depends on the amount of communication
|
|
5110
|
-
* between compute instances, especially if you use a deep learning algorithms in
|
|
5111
|
-
* distributed training.</p>
|
|
4158
|
+
* <p>To encrypt all communications between ML compute instances in distributed training, choose <code>True</code>. Encryption provides greater security for distributed training, but training might take longer. How long it takes depends on the amount of communication between compute instances, especially if you use a deep learning algorithms in distributed training.</p>
|
|
5112
4159
|
* @public
|
|
5113
4160
|
*/
|
|
5114
4161
|
EnableInterContainerTrafficEncryption?: boolean | undefined;
|
|
5115
4162
|
/**
|
|
5116
|
-
* <p>A Boolean indicating whether managed spot training is enabled (<code>True</code>) or
|
|
5117
|
-
* not (<code>False</code>).</p>
|
|
4163
|
+
* <p>A Boolean indicating whether managed spot training is enabled (<code>True</code>) or not (<code>False</code>).</p>
|
|
5118
4164
|
* @public
|
|
5119
4165
|
*/
|
|
5120
4166
|
EnableManagedSpotTraining?: boolean | undefined;
|
|
5121
4167
|
/**
|
|
5122
|
-
* <p>Contains information about the output location for managed spot training checkpoint
|
|
5123
|
-
* data. </p>
|
|
4168
|
+
* <p>Contains information about the output location for managed spot training checkpoint data. </p>
|
|
5124
4169
|
* @public
|
|
5125
4170
|
*/
|
|
5126
4171
|
CheckpointConfig?: CheckpointConfig | undefined;
|
|
@@ -5130,47 +4175,17 @@ export interface DescribeTrainingJobResponse {
|
|
|
5130
4175
|
*/
|
|
5131
4176
|
TrainingTimeInSeconds?: number | undefined;
|
|
5132
4177
|
/**
|
|
5133
|
-
* <p>The billable time in seconds. Billable time refers to the absolute wall-clock
|
|
5134
|
-
* time.</p>
|
|
5135
|
-
* <p>Multiply <code>BillableTimeInSeconds</code> by the number of instances
|
|
5136
|
-
* (<code>InstanceCount</code>) in your training cluster to get the total compute time
|
|
5137
|
-
* SageMaker bills you if you run distributed training. The formula is as follows:
|
|
5138
|
-
* <code>BillableTimeInSeconds * InstanceCount</code> .</p>
|
|
5139
|
-
* <p>You can calculate the savings from using managed spot training using the formula
|
|
5140
|
-
* <code>(1 - BillableTimeInSeconds / TrainingTimeInSeconds) * 100</code>. For example,
|
|
5141
|
-
* if <code>BillableTimeInSeconds</code> is 100 and <code>TrainingTimeInSeconds</code> is
|
|
5142
|
-
* 500, the savings is 80%.</p>
|
|
4178
|
+
* <p>The billable time in seconds. Billable time refers to the absolute wall-clock time.</p> <p>Multiply <code>BillableTimeInSeconds</code> by the number of instances (<code>InstanceCount</code>) in your training cluster to get the total compute time SageMaker bills you if you run distributed training. The formula is as follows: <code>BillableTimeInSeconds * InstanceCount</code> .</p> <p>You can calculate the savings from using managed spot training using the formula <code>(1 - BillableTimeInSeconds / TrainingTimeInSeconds) * 100</code>. For example, if <code>BillableTimeInSeconds</code> is 100 and <code>TrainingTimeInSeconds</code> is 500, the savings is 80%.</p>
|
|
5143
4179
|
* @public
|
|
5144
4180
|
*/
|
|
5145
4181
|
BillableTimeInSeconds?: number | undefined;
|
|
5146
4182
|
/**
|
|
5147
|
-
* <p>Configuration information for the Amazon SageMaker Debugger hook parameters, metric and tensor collections, and
|
|
5148
|
-
* storage paths. To learn more about
|
|
5149
|
-
* how to configure the <code>DebugHookConfig</code> parameter,
|
|
5150
|
-
* see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/debugger-createtrainingjob-api.html">Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job</a>.</p>
|
|
4183
|
+
* <p>Configuration information for the Amazon SageMaker Debugger hook parameters, metric and tensor collections, and storage paths. To learn more about how to configure the <code>DebugHookConfig</code> parameter, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/debugger-createtrainingjob-api.html">Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job</a>.</p>
|
|
5151
4184
|
* @public
|
|
5152
4185
|
*/
|
|
5153
4186
|
DebugHookConfig?: DebugHookConfig | undefined;
|
|
5154
4187
|
/**
|
|
5155
|
-
* <p>Associates a SageMaker job as a trial component with an experiment and trial. Specified when
|
|
5156
|
-
* you call the following APIs:</p>
|
|
5157
|
-
* <ul>
|
|
5158
|
-
* <li>
|
|
5159
|
-
* <p>
|
|
5160
|
-
* <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateProcessingJob.html">CreateProcessingJob</a>
|
|
5161
|
-
* </p>
|
|
5162
|
-
* </li>
|
|
5163
|
-
* <li>
|
|
5164
|
-
* <p>
|
|
5165
|
-
* <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingJob.html">CreateTrainingJob</a>
|
|
5166
|
-
* </p>
|
|
5167
|
-
* </li>
|
|
5168
|
-
* <li>
|
|
5169
|
-
* <p>
|
|
5170
|
-
* <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTransformJob.html">CreateTransformJob</a>
|
|
5171
|
-
* </p>
|
|
5172
|
-
* </li>
|
|
5173
|
-
* </ul>
|
|
4188
|
+
* <p>Associates a SageMaker job as a trial component with an experiment and trial. Specified when you call the following APIs:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateProcessingJob.html">CreateProcessingJob</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingJob.html">CreateTrainingJob</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTransformJob.html">CreateTransformJob</a> </p> </li> </ul>
|
|
5174
4189
|
* @public
|
|
5175
4190
|
*/
|
|
5176
4191
|
ExperimentConfig?: ExperimentConfig | undefined;
|
|
@@ -5190,14 +4205,12 @@ export interface DescribeTrainingJobResponse {
|
|
|
5190
4205
|
*/
|
|
5191
4206
|
DebugRuleEvaluationStatuses?: DebugRuleEvaluationStatus[] | undefined;
|
|
5192
4207
|
/**
|
|
5193
|
-
* <p>Configuration information for Amazon SageMaker Debugger system monitoring, framework profiling, and
|
|
5194
|
-
* storage paths.</p>
|
|
4208
|
+
* <p>Configuration information for Amazon SageMaker Debugger system monitoring, framework profiling, and storage paths.</p>
|
|
5195
4209
|
* @public
|
|
5196
4210
|
*/
|
|
5197
4211
|
ProfilerConfig?: ProfilerConfig | undefined;
|
|
5198
4212
|
/**
|
|
5199
|
-
* <p>Configuration information for Amazon SageMaker Debugger rules for profiling system and framework
|
|
5200
|
-
* metrics.</p>
|
|
4213
|
+
* <p>Configuration information for Amazon SageMaker Debugger rules for profiling system and framework metrics.</p>
|
|
5201
4214
|
* @public
|
|
5202
4215
|
*/
|
|
5203
4216
|
ProfilerRuleConfigurations?: ProfilerRuleConfiguration[] | undefined;
|
|
@@ -5212,28 +4225,17 @@ export interface DescribeTrainingJobResponse {
|
|
|
5212
4225
|
*/
|
|
5213
4226
|
ProfilingStatus?: ProfilingStatus | undefined;
|
|
5214
4227
|
/**
|
|
5215
|
-
* <p>The environment variables to set in the Docker container.</p>
|
|
5216
|
-
* <important>
|
|
5217
|
-
* <p>Do not include any security-sensitive information including account access IDs, secrets,
|
|
5218
|
-
* or tokens in any environment fields. As part of the shared responsibility
|
|
5219
|
-
* model, you are responsible for any potential exposure, unauthorized access, or compromise of
|
|
5220
|
-
* your sensitive data if caused by security-sensitive information included in the
|
|
5221
|
-
* request environment variable or plain text fields.</p>
|
|
5222
|
-
* </important>
|
|
4228
|
+
* <p>The environment variables to set in the Docker container.</p> <important> <p>Do not include any security-sensitive information including account access IDs, secrets, or tokens in any environment fields. As part of the shared responsibility model, you are responsible for any potential exposure, unauthorized access, or compromise of your sensitive data if caused by security-sensitive information included in the request environment variable or plain text fields.</p> </important>
|
|
5223
4229
|
* @public
|
|
5224
4230
|
*/
|
|
5225
4231
|
Environment?: Record<string, string> | undefined;
|
|
5226
4232
|
/**
|
|
5227
|
-
* <p>The number of times to retry the job when the job fails due to an
|
|
5228
|
-
* <code>InternalServerError</code>.</p>
|
|
4233
|
+
* <p>The number of times to retry the job when the job fails due to an <code>InternalServerError</code>.</p>
|
|
5229
4234
|
* @public
|
|
5230
4235
|
*/
|
|
5231
4236
|
RetryStrategy?: RetryStrategy | undefined;
|
|
5232
4237
|
/**
|
|
5233
|
-
* <p>Configuration for remote debugging. To learn more about the remote debugging
|
|
5234
|
-
* functionality of SageMaker, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/train-remote-debugging.html">Access a training container
|
|
5235
|
-
* through Amazon Web Services Systems Manager (SSM) for remote
|
|
5236
|
-
* debugging</a>.</p>
|
|
4238
|
+
* <p>Configuration for remote debugging. To learn more about the remote 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) for remote debugging</a>.</p>
|
|
5237
4239
|
* @public
|
|
5238
4240
|
*/
|
|
5239
4241
|
RemoteDebugConfig?: RemoteDebugConfig | undefined;
|
|
@@ -5285,11 +4287,7 @@ export declare const ReservedCapacityStatus: {
|
|
|
5285
4287
|
*/
|
|
5286
4288
|
export type ReservedCapacityStatus = (typeof ReservedCapacityStatus)[keyof typeof ReservedCapacityStatus];
|
|
5287
4289
|
/**
|
|
5288
|
-
* <p>Details of a reserved capacity for the training plan.</p>
|
|
5289
|
-
* <p>For more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using
|
|
5290
|
-
* Amazon SageMaker Training Plan, see <code>
|
|
5291
|
-
* <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingPlan.html">CreateTrainingPlan</a>
|
|
5292
|
-
* </code>.</p>
|
|
4290
|
+
* <p>Details of a reserved capacity for the training plan.</p> <p>For more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see <code> <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingPlan.html">CreateTrainingPlan</a> </code>.</p>
|
|
5293
4291
|
* @public
|
|
5294
4292
|
*/
|
|
5295
4293
|
export interface ReservedCapacitySummary {
|
|
@@ -5324,8 +4322,7 @@ export interface ReservedCapacitySummary {
|
|
|
5324
4322
|
*/
|
|
5325
4323
|
DurationHours?: number | undefined;
|
|
5326
4324
|
/**
|
|
5327
|
-
* <p>The additional minutes beyond whole hours in the total duration for this reserved
|
|
5328
|
-
* capacity.</p>
|
|
4325
|
+
* <p>The additional minutes beyond whole hours in the total duration for this reserved capacity.</p>
|
|
5329
4326
|
* @public
|
|
5330
4327
|
*/
|
|
5331
4328
|
DurationMinutes?: number | undefined;
|
|
@@ -5382,17 +4379,12 @@ export interface DescribeTrainingPlanResponse {
|
|
|
5382
4379
|
*/
|
|
5383
4380
|
TrainingPlanName: string | undefined;
|
|
5384
4381
|
/**
|
|
5385
|
-
* <p>The current status of the training plan (e.g., Pending, Active, Expired). To see the
|
|
5386
|
-
* complete list of status values available for a training plan, refer to the
|
|
5387
|
-
* <code>Status</code> attribute within the <code>
|
|
5388
|
-
* <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_TrainingPlanSummary.html">TrainingPlanSummary</a>
|
|
5389
|
-
* </code> object.</p>
|
|
4382
|
+
* <p>The current status of the training plan (e.g., Pending, Active, Expired). To see the complete list of status values available for a training plan, refer to the <code>Status</code> attribute within the <code> <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_TrainingPlanSummary.html">TrainingPlanSummary</a> </code> object.</p>
|
|
5390
4383
|
* @public
|
|
5391
4384
|
*/
|
|
5392
4385
|
Status: TrainingPlanStatus | undefined;
|
|
5393
4386
|
/**
|
|
5394
|
-
* <p>A message providing additional information about the current status of the training
|
|
5395
|
-
* plan.</p>
|
|
4387
|
+
* <p>A message providing additional information about the current status of the training plan.</p>
|
|
5396
4388
|
* @public
|
|
5397
4389
|
*/
|
|
5398
4390
|
StatusMessage?: string | undefined;
|
|
@@ -5402,8 +4394,7 @@ export interface DescribeTrainingPlanResponse {
|
|
|
5402
4394
|
*/
|
|
5403
4395
|
DurationHours?: number | undefined;
|
|
5404
4396
|
/**
|
|
5405
|
-
* <p>The additional minutes beyond whole hours in the total duration for this training
|
|
5406
|
-
* plan.</p>
|
|
4397
|
+
* <p>The additional minutes beyond whole hours in the total duration for this training plan.</p>
|
|
5407
4398
|
* @public
|
|
5408
4399
|
*/
|
|
5409
4400
|
DurationMinutes?: number | undefined;
|
|
@@ -5443,25 +4434,12 @@ export interface DescribeTrainingPlanResponse {
|
|
|
5443
4434
|
*/
|
|
5444
4435
|
InUseInstanceCount?: number | undefined;
|
|
5445
4436
|
/**
|
|
5446
|
-
* <p>The target resources (e.g., SageMaker Training Jobs, SageMaker HyperPod) that can use this training
|
|
5447
|
-
* plan.</p>
|
|
5448
|
-
* <p>Training plans are specific to their target resource.</p>
|
|
5449
|
-
* <ul>
|
|
5450
|
-
* <li>
|
|
5451
|
-
* <p>A training plan designed for SageMaker training jobs can only be used to schedule and
|
|
5452
|
-
* run training jobs.</p>
|
|
5453
|
-
* </li>
|
|
5454
|
-
* <li>
|
|
5455
|
-
* <p>A training plan for HyperPod clusters can be used exclusively to provide
|
|
5456
|
-
* compute resources to a cluster's instance group.</p>
|
|
5457
|
-
* </li>
|
|
5458
|
-
* </ul>
|
|
4437
|
+
* <p>The target resources (e.g., SageMaker Training Jobs, SageMaker HyperPod) that can use this training plan.</p> <p>Training plans are specific to their target resource.</p> <ul> <li> <p>A training plan designed for SageMaker training jobs can only be used to schedule and run training jobs.</p> </li> <li> <p>A training plan for HyperPod clusters can be used exclusively to provide compute resources to a cluster's instance group.</p> </li> </ul>
|
|
5459
4438
|
* @public
|
|
5460
4439
|
*/
|
|
5461
4440
|
TargetResources?: SageMakerResourceName[] | undefined;
|
|
5462
4441
|
/**
|
|
5463
|
-
* <p>The list of Reserved Capacity providing the underlying compute resources of the plan.
|
|
5464
|
-
* </p>
|
|
4442
|
+
* <p>The list of Reserved Capacity providing the underlying compute resources of the plan. </p>
|
|
5465
4443
|
* @public
|
|
5466
4444
|
*/
|
|
5467
4445
|
ReservedCapacitySummaries?: ReservedCapacitySummary[] | undefined;
|
|
@@ -5506,20 +4484,12 @@ export interface DescribeTransformJobResponse {
|
|
|
5506
4484
|
*/
|
|
5507
4485
|
TransformJobArn: string | undefined;
|
|
5508
4486
|
/**
|
|
5509
|
-
* <p>The
|
|
5510
|
-
* status of the transform job. If the transform job failed, the reason
|
|
5511
|
-
* is returned in the <code>FailureReason</code> field.</p>
|
|
4487
|
+
* <p>The status of the transform job. If the transform job failed, the reason is returned in the <code>FailureReason</code> field.</p>
|
|
5512
4488
|
* @public
|
|
5513
4489
|
*/
|
|
5514
4490
|
TransformJobStatus: TransformJobStatus | undefined;
|
|
5515
4491
|
/**
|
|
5516
|
-
* <p>If the transform job failed, <code>FailureReason</code> describes
|
|
5517
|
-
* why
|
|
5518
|
-
* it failed. A transform job creates a log file, which includes error
|
|
5519
|
-
* messages, and stores it
|
|
5520
|
-
* as
|
|
5521
|
-
* an Amazon S3 object. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/logging-cloudwatch.html">Log Amazon SageMaker Events with
|
|
5522
|
-
* Amazon CloudWatch</a>.</p>
|
|
4492
|
+
* <p>If the transform job failed, <code>FailureReason</code> describes why it failed. A transform job creates a log file, which includes error messages, and stores it as an Amazon S3 object. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/logging-cloudwatch.html">Log Amazon SageMaker Events with Amazon CloudWatch</a>.</p>
|
|
5523
4493
|
* @public
|
|
5524
4494
|
*/
|
|
5525
4495
|
FailureReason?: string | undefined;
|
|
@@ -5529,57 +4499,37 @@ export interface DescribeTransformJobResponse {
|
|
|
5529
4499
|
*/
|
|
5530
4500
|
ModelName: string | undefined;
|
|
5531
4501
|
/**
|
|
5532
|
-
* <p>The
|
|
5533
|
-
* maximum number
|
|
5534
|
-
* of
|
|
5535
|
-
* parallel requests on each instance node
|
|
5536
|
-
* that can be launched in a transform job. The default value is 1.</p>
|
|
4502
|
+
* <p>The maximum number of parallel requests on each instance node that can be launched in a transform job. The default value is 1.</p>
|
|
5537
4503
|
* @public
|
|
5538
4504
|
*/
|
|
5539
4505
|
MaxConcurrentTransforms?: number | undefined;
|
|
5540
4506
|
/**
|
|
5541
|
-
* <p>The timeout and maximum number of retries for processing a transform job
|
|
5542
|
-
* invocation.</p>
|
|
4507
|
+
* <p>The timeout and maximum number of retries for processing a transform job invocation.</p>
|
|
5543
4508
|
* @public
|
|
5544
4509
|
*/
|
|
5545
4510
|
ModelClientConfig?: ModelClientConfig | undefined;
|
|
5546
4511
|
/**
|
|
5547
|
-
* <p>The
|
|
5548
|
-
* maximum
|
|
5549
|
-
* payload size, in MB, used in the
|
|
5550
|
-
* transform job.</p>
|
|
4512
|
+
* <p>The maximum payload size, in MB, used in the transform job.</p>
|
|
5551
4513
|
* @public
|
|
5552
4514
|
*/
|
|
5553
4515
|
MaxPayloadInMB?: number | undefined;
|
|
5554
4516
|
/**
|
|
5555
|
-
* <p>Specifies the number of records to include in a mini-batch for an HTTP inference
|
|
5556
|
-
* request.
|
|
5557
|
-
* A <i>record</i>
|
|
5558
|
-
* <i></i> is a single unit of input data that inference
|
|
5559
|
-
* can be made on. For example, a single line in a CSV file is a record. </p>
|
|
5560
|
-
* <p>To enable the batch strategy, you must set <code>SplitType</code>
|
|
5561
|
-
* to
|
|
5562
|
-
* <code>Line</code>, <code>RecordIO</code>, or
|
|
5563
|
-
* <code>TFRecord</code>.</p>
|
|
4517
|
+
* <p>Specifies the number of records to include in a mini-batch for an HTTP inference request. A <i>record</i> <i/> is a single unit of input data that inference can be made on. For example, a single line in a CSV file is a record. </p> <p>To enable the batch strategy, you must set <code>SplitType</code> to <code>Line</code>, <code>RecordIO</code>, or <code>TFRecord</code>.</p>
|
|
5564
4518
|
* @public
|
|
5565
4519
|
*/
|
|
5566
4520
|
BatchStrategy?: BatchStrategy | undefined;
|
|
5567
4521
|
/**
|
|
5568
|
-
* <p>The
|
|
5569
|
-
* environment variables to set in the Docker container. We support up to 16 key and values
|
|
5570
|
-
* entries in the map.</p>
|
|
4522
|
+
* <p>The environment variables to set in the Docker container. We support up to 16 key and values entries in the map.</p>
|
|
5571
4523
|
* @public
|
|
5572
4524
|
*/
|
|
5573
4525
|
Environment?: Record<string, string> | undefined;
|
|
5574
4526
|
/**
|
|
5575
|
-
* <p>Describes the dataset to be transformed and the Amazon S3 location where it is
|
|
5576
|
-
* stored.</p>
|
|
4527
|
+
* <p>Describes the dataset to be transformed and the Amazon S3 location where it is stored.</p>
|
|
5577
4528
|
* @public
|
|
5578
4529
|
*/
|
|
5579
4530
|
TransformInput: TransformInput | undefined;
|
|
5580
4531
|
/**
|
|
5581
|
-
* <p>Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the
|
|
5582
|
-
* transform job.</p>
|
|
4532
|
+
* <p>Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the transform job.</p>
|
|
5583
4533
|
* @public
|
|
5584
4534
|
*/
|
|
5585
4535
|
TransformOutput?: TransformOutput | undefined;
|
|
@@ -5589,9 +4539,7 @@ export interface DescribeTransformJobResponse {
|
|
|
5589
4539
|
*/
|
|
5590
4540
|
DataCaptureConfig?: BatchDataCaptureConfig | undefined;
|
|
5591
4541
|
/**
|
|
5592
|
-
* <p>Describes
|
|
5593
|
-
* the resources, including ML instance types and ML instance count, to
|
|
5594
|
-
* use for the transform job.</p>
|
|
4542
|
+
* <p>Describes the resources, including ML instance types and ML instance count, to use for the transform job.</p>
|
|
5595
4543
|
* @public
|
|
5596
4544
|
*/
|
|
5597
4545
|
TransformResources: TransformResources | undefined;
|
|
@@ -5601,24 +4549,17 @@ export interface DescribeTransformJobResponse {
|
|
|
5601
4549
|
*/
|
|
5602
4550
|
CreationTime: Date | undefined;
|
|
5603
4551
|
/**
|
|
5604
|
-
* <p>Indicates when the transform job starts
|
|
5605
|
-
* on
|
|
5606
|
-
* ML instances. You are billed for the time interval between this time
|
|
5607
|
-
* and the value of <code>TransformEndTime</code>.</p>
|
|
4552
|
+
* <p>Indicates when the transform job starts on ML instances. You are billed for the time interval between this time and the value of <code>TransformEndTime</code>.</p>
|
|
5608
4553
|
* @public
|
|
5609
4554
|
*/
|
|
5610
4555
|
TransformStartTime?: Date | undefined;
|
|
5611
4556
|
/**
|
|
5612
|
-
* <p>Indicates when the transform job has been
|
|
5613
|
-
*
|
|
5614
|
-
* completed, or has stopped or failed. You are billed for the time
|
|
5615
|
-
* interval between this time and the value of <code>TransformStartTime</code>.</p>
|
|
4557
|
+
* <p>Indicates when the transform job has been completed, or has stopped or failed. You are billed for the time interval between this time and the value of <code>TransformStartTime</code>.</p>
|
|
5616
4558
|
* @public
|
|
5617
4559
|
*/
|
|
5618
4560
|
TransformEndTime?: Date | undefined;
|
|
5619
4561
|
/**
|
|
5620
|
-
* <p>The Amazon Resource Name (ARN) of the Amazon SageMaker Ground Truth labeling job that created the
|
|
5621
|
-
* transform or training job.</p>
|
|
4562
|
+
* <p>The Amazon Resource Name (ARN) of the Amazon SageMaker Ground Truth labeling job that created the transform or training job.</p>
|
|
5622
4563
|
* @public
|
|
5623
4564
|
*/
|
|
5624
4565
|
LabelingJobArn?: string | undefined;
|
|
@@ -5628,36 +4569,12 @@ export interface DescribeTransformJobResponse {
|
|
|
5628
4569
|
*/
|
|
5629
4570
|
AutoMLJobArn?: string | undefined;
|
|
5630
4571
|
/**
|
|
5631
|
-
* <p>The data structure used to specify the data to be used for inference in a batch
|
|
5632
|
-
* transform job and to associate the data that is relevant to the prediction results in
|
|
5633
|
-
* the output. The input filter provided allows you to exclude input data that is not
|
|
5634
|
-
* needed for inference in a batch transform job. The output filter provided allows you to
|
|
5635
|
-
* include input data relevant to interpreting the predictions in the output from the job.
|
|
5636
|
-
* For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/batch-transform-data-processing.html">Associate Prediction
|
|
5637
|
-
* Results with their Corresponding Input Records</a>.</p>
|
|
4572
|
+
* <p>The data structure used to specify the data to be used for inference in a batch transform job and to associate the data that is relevant to the prediction results in the output. The input filter provided allows you to exclude input data that is not needed for inference in a batch transform job. The output filter provided allows you to include input data relevant to interpreting the predictions in the output from the job. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/batch-transform-data-processing.html">Associate Prediction Results with their Corresponding Input Records</a>.</p>
|
|
5638
4573
|
* @public
|
|
5639
4574
|
*/
|
|
5640
4575
|
DataProcessing?: DataProcessing | undefined;
|
|
5641
4576
|
/**
|
|
5642
|
-
* <p>Associates a SageMaker job as a trial component with an experiment and trial. Specified when
|
|
5643
|
-
* you call the following APIs:</p>
|
|
5644
|
-
* <ul>
|
|
5645
|
-
* <li>
|
|
5646
|
-
* <p>
|
|
5647
|
-
* <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateProcessingJob.html">CreateProcessingJob</a>
|
|
5648
|
-
* </p>
|
|
5649
|
-
* </li>
|
|
5650
|
-
* <li>
|
|
5651
|
-
* <p>
|
|
5652
|
-
* <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingJob.html">CreateTrainingJob</a>
|
|
5653
|
-
* </p>
|
|
5654
|
-
* </li>
|
|
5655
|
-
* <li>
|
|
5656
|
-
* <p>
|
|
5657
|
-
* <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTransformJob.html">CreateTransformJob</a>
|
|
5658
|
-
* </p>
|
|
5659
|
-
* </li>
|
|
5660
|
-
* </ul>
|
|
4577
|
+
* <p>Associates a SageMaker job as a trial component with an experiment and trial. Specified when you call the following APIs:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateProcessingJob.html">CreateProcessingJob</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingJob.html">CreateTrainingJob</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTransformJob.html">CreateTransformJob</a> </p> </li> </ul>
|
|
5661
4578
|
* @public
|
|
5662
4579
|
*/
|
|
5663
4580
|
ExperimentConfig?: ExperimentConfig | undefined;
|
|
@@ -5703,8 +4620,7 @@ export interface DescribeTrialResponse {
|
|
|
5703
4620
|
*/
|
|
5704
4621
|
TrialArn?: string | undefined;
|
|
5705
4622
|
/**
|
|
5706
|
-
* <p>The name of the trial as displayed. If <code>DisplayName</code> isn't specified,
|
|
5707
|
-
* <code>TrialName</code> is displayed.</p>
|
|
4623
|
+
* <p>The name of the trial as displayed. If <code>DisplayName</code> isn't specified, <code>TrialName</code> is displayed.</p>
|
|
5708
4624
|
* @public
|
|
5709
4625
|
*/
|
|
5710
4626
|
DisplayName?: string | undefined;
|
|
@@ -5836,8 +4752,7 @@ export interface DescribeTrialComponentResponse {
|
|
|
5836
4752
|
*/
|
|
5837
4753
|
TrialComponentArn?: string | undefined;
|
|
5838
4754
|
/**
|
|
5839
|
-
* <p>The name of the component as displayed. If <code>DisplayName</code> isn't specified,
|
|
5840
|
-
* <code>TrialComponentName</code> is displayed.</p>
|
|
4755
|
+
* <p>The name of the component as displayed. If <code>DisplayName</code> isn't specified, <code>TrialComponentName</code> is displayed.</p>
|
|
5841
4756
|
* @public
|
|
5842
4757
|
*/
|
|
5843
4758
|
DisplayName?: string | undefined;
|
|
@@ -5847,18 +4762,7 @@ export interface DescribeTrialComponentResponse {
|
|
|
5847
4762
|
*/
|
|
5848
4763
|
Source?: TrialComponentSource | undefined;
|
|
5849
4764
|
/**
|
|
5850
|
-
* <p>The status of the component. States include:</p>
|
|
5851
|
-
* <ul>
|
|
5852
|
-
* <li>
|
|
5853
|
-
* <p>InProgress</p>
|
|
5854
|
-
* </li>
|
|
5855
|
-
* <li>
|
|
5856
|
-
* <p>Completed</p>
|
|
5857
|
-
* </li>
|
|
5858
|
-
* <li>
|
|
5859
|
-
* <p>Failed</p>
|
|
5860
|
-
* </li>
|
|
5861
|
-
* </ul>
|
|
4765
|
+
* <p>The status of the component. States include:</p> <ul> <li> <p>InProgress</p> </li> <li> <p>Completed</p> </li> <li> <p>Failed</p> </li> </ul>
|
|
5862
4766
|
* @public
|
|
5863
4767
|
*/
|
|
5864
4768
|
Status?: TrialComponentStatus | undefined;
|
|
@@ -5923,8 +4827,7 @@ export interface DescribeTrialComponentResponse {
|
|
|
5923
4827
|
*/
|
|
5924
4828
|
LineageGroupArn?: string | undefined;
|
|
5925
4829
|
/**
|
|
5926
|
-
* <p>A list of ARNs and, if applicable, job types for multiple sources of an experiment
|
|
5927
|
-
* run.</p>
|
|
4830
|
+
* <p>A list of ARNs and, if applicable, job types for multiple sources of an experiment run.</p>
|
|
5928
4831
|
* @public
|
|
5929
4832
|
*/
|
|
5930
4833
|
Sources?: TrialComponentSource[] | undefined;
|
|
@@ -6026,9 +4929,7 @@ export interface DescribeUserProfileResponse {
|
|
|
6026
4929
|
*/
|
|
6027
4930
|
export interface DescribeWorkforceRequest {
|
|
6028
4931
|
/**
|
|
6029
|
-
* <p>The name of the private workforce whose access you want to restrict.
|
|
6030
|
-
* <code>WorkforceName</code> is automatically set to <code>default</code> when a
|
|
6031
|
-
* workforce is created and cannot be modified. </p>
|
|
4932
|
+
* <p>The name of the private workforce whose access you want to restrict. <code>WorkforceName</code> is automatically set to <code>default</code> when a workforce is created and cannot be modified. </p>
|
|
6032
4933
|
* @public
|
|
6033
4934
|
*/
|
|
6034
4935
|
WorkforceName: string | undefined;
|
|
@@ -6126,10 +5027,7 @@ export interface WorkforceVpcConfigResponse {
|
|
|
6126
5027
|
VpcEndpointId?: string | undefined;
|
|
6127
5028
|
}
|
|
6128
5029
|
/**
|
|
6129
|
-
* <p>A single private workforce, which is automatically created when you create your first
|
|
6130
|
-
* private work team. You can create one private work force in each Amazon Web Services Region. By default,
|
|
6131
|
-
* any workforce-related API operation used in a specific region will apply to the
|
|
6132
|
-
* workforce created in that region. To learn how to create a private workforce, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/sms-workforce-create-private.html">Create a Private Workforce</a>.</p>
|
|
5030
|
+
* <p>A single private workforce, which is automatically created when you create your first private work team. You can create one private work force in each Amazon Web Services Region. By default, any workforce-related API operation used in a specific region will apply to the workforce created in that region. To learn how to create a private workforce, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/sms-workforce-create-private.html">Create a Private Workforce</a>.</p>
|
|
6133
5031
|
* @public
|
|
6134
5032
|
*/
|
|
6135
5033
|
export interface Workforce {
|
|
@@ -6144,15 +5042,12 @@ export interface Workforce {
|
|
|
6144
5042
|
*/
|
|
6145
5043
|
WorkforceArn: string | undefined;
|
|
6146
5044
|
/**
|
|
6147
|
-
* <p>The most recent date that <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateWorkforce.html">UpdateWorkforce</a> was used to
|
|
6148
|
-
* successfully add one or more IP address ranges (<a href="https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html">CIDRs</a>) to a private workforce's
|
|
6149
|
-
* allow list.</p>
|
|
5045
|
+
* <p>The most recent date that <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateWorkforce.html">UpdateWorkforce</a> was used to successfully add one or more IP address ranges (<a href="https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html">CIDRs</a>) to a private workforce's allow list.</p>
|
|
6150
5046
|
* @public
|
|
6151
5047
|
*/
|
|
6152
5048
|
LastUpdatedDate?: Date | undefined;
|
|
6153
5049
|
/**
|
|
6154
|
-
* <p>A list of one to ten IP address ranges (<a href="https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html">CIDRs</a>) to be added to the
|
|
6155
|
-
* workforce allow list. By default, a workforce isn't restricted to specific IP addresses.</p>
|
|
5050
|
+
* <p>A list of one to ten IP address ranges (<a href="https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html">CIDRs</a>) to be added to the workforce allow list. By default, a workforce isn't restricted to specific IP addresses.</p>
|
|
6156
5051
|
* @public
|
|
6157
5052
|
*/
|
|
6158
5053
|
SourceIpConfig?: SourceIpConfig | undefined;
|
|
@@ -6162,10 +5057,7 @@ export interface Workforce {
|
|
|
6162
5057
|
*/
|
|
6163
5058
|
SubDomain?: string | undefined;
|
|
6164
5059
|
/**
|
|
6165
|
-
* <p>The configuration of an Amazon Cognito workforce.
|
|
6166
|
-
* A single Cognito workforce is created using and corresponds to a single
|
|
6167
|
-
* <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools.html">
|
|
6168
|
-
* Amazon Cognito user pool</a>.</p>
|
|
5060
|
+
* <p>The configuration of an Amazon Cognito workforce. A single Cognito workforce is created using and corresponds to a single <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools.html"> Amazon Cognito user pool</a>.</p>
|
|
6169
5061
|
* @public
|
|
6170
5062
|
*/
|
|
6171
5063
|
CognitoConfig?: CognitoConfig | undefined;
|
|
@@ -6200,10 +5092,7 @@ export interface Workforce {
|
|
|
6200
5092
|
*/
|
|
6201
5093
|
export interface DescribeWorkforceResponse {
|
|
6202
5094
|
/**
|
|
6203
|
-
* <p>A single private workforce, which is automatically created when you create your first
|
|
6204
|
-
* private work team. You can create one private work force in each Amazon Web Services Region. By default,
|
|
6205
|
-
* any workforce-related API operation used in a specific region will apply to the
|
|
6206
|
-
* workforce created in that region. To learn how to create a private workforce, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/sms-workforce-create-private.html">Create a Private Workforce</a>.</p>
|
|
5095
|
+
* <p>A single private workforce, which is automatically created when you create your first private work team. You can create one private work force in each Amazon Web Services Region. By default, any workforce-related API operation used in a specific region will apply to the workforce created in that region. To learn how to create a private workforce, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/sms-workforce-create-private.html">Create a Private Workforce</a>.</p>
|
|
6207
5096
|
* @public
|
|
6208
5097
|
*/
|
|
6209
5098
|
Workforce: Workforce | undefined;
|
|
@@ -6229,12 +5118,7 @@ export interface Workteam {
|
|
|
6229
5118
|
*/
|
|
6230
5119
|
WorkteamName: string | undefined;
|
|
6231
5120
|
/**
|
|
6232
|
-
* <p>A list of <code>MemberDefinition</code> objects that contains objects that identify
|
|
6233
|
-
* the workers that make up the work team. </p>
|
|
6234
|
-
* <p>Workforces can be created using Amazon Cognito or your own OIDC Identity Provider (IdP).
|
|
6235
|
-
* For private workforces created using Amazon Cognito use
|
|
6236
|
-
* <code>CognitoMemberDefinition</code>. For workforces created using your own OIDC identity
|
|
6237
|
-
* provider (IdP) use <code>OidcMemberDefinition</code>.</p>
|
|
5121
|
+
* <p>A list of <code>MemberDefinition</code> objects that contains objects that identify the workers that make up the work team. </p> <p>Workforces can be created using Amazon Cognito or your own OIDC Identity Provider (IdP). For private workforces created using Amazon Cognito use <code>CognitoMemberDefinition</code>. For workforces created using your own OIDC identity provider (IdP) use <code>OidcMemberDefinition</code>.</p>
|
|
6238
5122
|
* @public
|
|
6239
5123
|
*/
|
|
6240
5124
|
MemberDefinitions: MemberDefinition[] | undefined;
|
|
@@ -6259,8 +5143,7 @@ export interface Workteam {
|
|
|
6259
5143
|
*/
|
|
6260
5144
|
Description: string | undefined;
|
|
6261
5145
|
/**
|
|
6262
|
-
* <p>The URI of the labeling job's user interface. Workers open this URI to start labeling
|
|
6263
|
-
* your data objects.</p>
|
|
5146
|
+
* <p>The URI of the labeling job's user interface. Workers open this URI to start labeling your data objects.</p>
|
|
6264
5147
|
* @public
|
|
6265
5148
|
*/
|
|
6266
5149
|
SubDomain?: string | undefined;
|
|
@@ -6275,8 +5158,7 @@ export interface Workteam {
|
|
|
6275
5158
|
*/
|
|
6276
5159
|
LastUpdatedDate?: Date | undefined;
|
|
6277
5160
|
/**
|
|
6278
|
-
* <p>Configures SNS notifications of available or expiring work items for work
|
|
6279
|
-
* teams.</p>
|
|
5161
|
+
* <p>Configures SNS notifications of available or expiring work items for work teams.</p>
|
|
6280
5162
|
* @public
|
|
6281
5163
|
*/
|
|
6282
5164
|
NotificationConfiguration?: NotificationConfiguration | undefined;
|
|
@@ -6291,8 +5173,7 @@ export interface Workteam {
|
|
|
6291
5173
|
*/
|
|
6292
5174
|
export interface DescribeWorkteamResponse {
|
|
6293
5175
|
/**
|
|
6294
|
-
* <p>A <code>Workteam</code> instance that contains information about the work team.
|
|
6295
|
-
* </p>
|
|
5176
|
+
* <p>A <code>Workteam</code> instance that contains information about the work team. </p>
|
|
6296
5177
|
* @public
|
|
6297
5178
|
*/
|
|
6298
5179
|
Workteam: Workteam | undefined;
|
|
@@ -6308,8 +5189,7 @@ export interface ProductionVariantServerlessUpdateConfig {
|
|
|
6308
5189
|
*/
|
|
6309
5190
|
MaxConcurrency?: number | undefined;
|
|
6310
5191
|
/**
|
|
6311
|
-
* <p>The updated amount of provisioned concurrency to allocate for the serverless endpoint.
|
|
6312
|
-
* Should be less than or equal to <code>MaxConcurrency</code>.</p>
|
|
5192
|
+
* <p>The updated amount of provisioned concurrency to allocate for the serverless endpoint. Should be less than or equal to <code>MaxConcurrency</code>.</p>
|
|
6313
5193
|
* @public
|
|
6314
5194
|
*/
|
|
6315
5195
|
ProvisionedConcurrency?: number | undefined;
|
|
@@ -6642,8 +5522,7 @@ export interface DomainDetails {
|
|
|
6642
5522
|
Url?: string | undefined;
|
|
6643
5523
|
}
|
|
6644
5524
|
/**
|
|
6645
|
-
* <p>A collection of settings that update the current configuration for the
|
|
6646
|
-
* <code>RStudioServerPro</code> Domain-level app.</p>
|
|
5525
|
+
* <p>A collection of settings that update the current configuration for the <code>RStudioServerPro</code> Domain-level app.</p>
|
|
6647
5526
|
* @public
|
|
6648
5527
|
*/
|
|
6649
5528
|
export interface RStudioServerProDomainSettingsForUpdate {
|
|
@@ -6653,11 +5532,7 @@ export interface RStudioServerProDomainSettingsForUpdate {
|
|
|
6653
5532
|
*/
|
|
6654
5533
|
DomainExecutionRoleArn: string | undefined;
|
|
6655
5534
|
/**
|
|
6656
|
-
* <p>Specifies the ARN's of a SageMaker AI image and SageMaker AI image version, and the instance type that
|
|
6657
|
-
* the version runs on.</p>
|
|
6658
|
-
* <note>
|
|
6659
|
-
* <p>When both <code>SageMakerImageVersionArn</code> and <code>SageMakerImageArn</code> are passed, <code>SageMakerImageVersionArn</code> is used. Any updates to <code>SageMakerImageArn</code> will not take effect if <code>SageMakerImageVersionArn</code> already exists in the <code>ResourceSpec</code> because <code>SageMakerImageVersionArn</code> always takes precedence. To clear the value set for <code>SageMakerImageVersionArn</code>, pass <code>None</code> as the value.</p>
|
|
6660
|
-
* </note>
|
|
5535
|
+
* <p>Specifies the ARN's of a SageMaker AI image and SageMaker AI image version, and the instance type that the version runs on.</p> <note> <p>When both <code>SageMakerImageVersionArn</code> and <code>SageMakerImageArn</code> are passed, <code>SageMakerImageVersionArn</code> is used. Any updates to <code>SageMakerImageArn</code> will not take effect if <code>SageMakerImageVersionArn</code> already exists in the <code>ResourceSpec</code> because <code>SageMakerImageVersionArn</code> always takes precedence. To clear the value set for <code>SageMakerImageVersionArn</code>, pass <code>None</code> as the value.</p> </note>
|
|
6661
5536
|
* @public
|
|
6662
5537
|
*/
|
|
6663
5538
|
DefaultResourceSpec?: ResourceSpec | undefined;
|
|
@@ -6678,21 +5553,17 @@ export interface RStudioServerProDomainSettingsForUpdate {
|
|
|
6678
5553
|
*/
|
|
6679
5554
|
export interface DomainSettingsForUpdate {
|
|
6680
5555
|
/**
|
|
6681
|
-
* <p>A collection of <code>RStudioServerPro</code> Domain-level app settings to update. A
|
|
6682
|
-
* single <code>RStudioServerPro</code> application is created for a domain.</p>
|
|
5556
|
+
* <p>A collection of <code>RStudioServerPro</code> Domain-level app settings to update. A single <code>RStudioServerPro</code> application is created for a domain.</p>
|
|
6683
5557
|
* @public
|
|
6684
5558
|
*/
|
|
6685
5559
|
RStudioServerProDomainSettingsForUpdate?: RStudioServerProDomainSettingsForUpdate | undefined;
|
|
6686
5560
|
/**
|
|
6687
|
-
* <p>The configuration for attaching a SageMaker AI user profile name to the execution
|
|
6688
|
-
* role as a <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_control-access_monitor.html">sts:SourceIdentity key</a>. This configuration can only be modified if there are no
|
|
6689
|
-
* apps in the <code>InService</code> or <code>Pending</code> state.</p>
|
|
5561
|
+
* <p>The configuration for attaching a SageMaker AI user profile name to the execution role as a <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_control-access_monitor.html">sts:SourceIdentity key</a>. This configuration can only be modified if there are no apps in the <code>InService</code> or <code>Pending</code> state.</p>
|
|
6690
5562
|
* @public
|
|
6691
5563
|
*/
|
|
6692
5564
|
ExecutionRoleIdentityConfig?: ExecutionRoleIdentityConfig | undefined;
|
|
6693
5565
|
/**
|
|
6694
|
-
* <p>The security groups for the Amazon Virtual Private Cloud that the <code>Domain</code> uses for
|
|
6695
|
-
* communication between Domain-level apps and user apps.</p>
|
|
5566
|
+
* <p>The security groups for the Amazon Virtual Private Cloud that the <code>Domain</code> uses for communication between Domain-level apps and user apps.</p>
|
|
6696
5567
|
* @public
|
|
6697
5568
|
*/
|
|
6698
5569
|
SecurityGroupIds?: string[] | undefined;
|
|
@@ -6707,8 +5578,7 @@ export interface DomainSettingsForUpdate {
|
|
|
6707
5578
|
*/
|
|
6708
5579
|
AmazonQSettings?: AmazonQSettings | undefined;
|
|
6709
5580
|
/**
|
|
6710
|
-
* <p>The settings that apply to an SageMaker AI domain when you use it in Amazon SageMaker
|
|
6711
|
-
* Unified Studio.</p>
|
|
5581
|
+
* <p>The settings that apply to an SageMaker AI domain when you use it in Amazon SageMaker Unified Studio.</p>
|
|
6712
5582
|
* @public
|
|
6713
5583
|
*/
|
|
6714
5584
|
UnifiedStudioSettings?: UnifiedStudioSettings | undefined;
|
|
@@ -6767,9 +5637,7 @@ export declare namespace MetricSpecification {
|
|
|
6767
5637
|
const visit: <T>(value: MetricSpecification, visitor: Visitor<T>) => T;
|
|
6768
5638
|
}
|
|
6769
5639
|
/**
|
|
6770
|
-
* <p>A target tracking scaling policy. Includes support for predefined or customized metrics.</p>
|
|
6771
|
-
* <p>When using the <a href="https://docs.aws.amazon.com/autoscaling/application/APIReference/API_PutScalingPolicy.html">PutScalingPolicy</a> API,
|
|
6772
|
-
* this parameter is required when you are creating a policy with the policy type <code>TargetTrackingScaling</code>.</p>
|
|
5640
|
+
* <p>A target tracking scaling policy. Includes support for predefined or customized metrics.</p> <p>When using the <a href="https://docs.aws.amazon.com/autoscaling/application/APIReference/API_PutScalingPolicy.html">PutScalingPolicy</a> API, this parameter is required when you are creating a policy with the policy type <code>TargetTrackingScaling</code>.</p>
|
|
6773
5641
|
* @public
|
|
6774
5642
|
*/
|
|
6775
5643
|
export interface TargetTrackingScalingPolicyConfiguration {
|
|
@@ -6861,8 +5729,7 @@ export interface Edge {
|
|
|
6861
5729
|
*/
|
|
6862
5730
|
DestinationArn?: string | undefined;
|
|
6863
5731
|
/**
|
|
6864
|
-
* <p>The type of the Association(Edge) between the source and destination. For example <code>ContributedTo</code>,
|
|
6865
|
-
* <code>Produced</code>, or <code>DerivedFrom</code>.</p>
|
|
5732
|
+
* <p>The type of the Association(Edge) between the source and destination. For example <code>ContributedTo</code>, <code>Produced</code>, or <code>DerivedFrom</code>.</p>
|
|
6866
5733
|
* @public
|
|
6867
5734
|
*/
|
|
6868
5735
|
AssociationType?: AssociationEdgeType | undefined;
|
|
@@ -7016,8 +5883,7 @@ export interface EMRStepMetadata {
|
|
|
7016
5883
|
*/
|
|
7017
5884
|
StepName?: string | undefined;
|
|
7018
5885
|
/**
|
|
7019
|
-
* <p>The path to the log file where the cluster step's failure root cause
|
|
7020
|
-
* is recorded.</p>
|
|
5886
|
+
* <p>The path to the log file where the cluster step's failure root cause is recorded.</p>
|
|
7021
5887
|
* @public
|
|
7022
5888
|
*/
|
|
7023
5889
|
LogFilePath?: string | undefined;
|
|
@@ -7033,8 +5899,7 @@ export interface EnableSagemakerServicecatalogPortfolioInput {
|
|
|
7033
5899
|
export interface EnableSagemakerServicecatalogPortfolioOutput {
|
|
7034
5900
|
}
|
|
7035
5901
|
/**
|
|
7036
|
-
* <p>A schedule for a model monitoring job. For information about model monitor, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/model-monitor.html">Amazon SageMaker Model
|
|
7037
|
-
* Monitor</a>.</p>
|
|
5902
|
+
* <p>A schedule for a model monitoring job. For information about model monitor, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/model-monitor.html">Amazon SageMaker Model Monitor</a>.</p>
|
|
7038
5903
|
* @public
|
|
7039
5904
|
*/
|
|
7040
5905
|
export interface MonitoringSchedule {
|
|
@@ -7049,25 +5914,7 @@ export interface MonitoringSchedule {
|
|
|
7049
5914
|
*/
|
|
7050
5915
|
MonitoringScheduleName?: string | undefined;
|
|
7051
5916
|
/**
|
|
7052
|
-
* <p>The status of the monitoring schedule. This can be one of the following values.</p>
|
|
7053
|
-
* <ul>
|
|
7054
|
-
* <li>
|
|
7055
|
-
* <p>
|
|
7056
|
-
* <code>PENDING</code> - The schedule is pending being created.</p>
|
|
7057
|
-
* </li>
|
|
7058
|
-
* <li>
|
|
7059
|
-
* <p>
|
|
7060
|
-
* <code>FAILED</code> - The schedule failed.</p>
|
|
7061
|
-
* </li>
|
|
7062
|
-
* <li>
|
|
7063
|
-
* <p>
|
|
7064
|
-
* <code>SCHEDULED</code> - The schedule was successfully created.</p>
|
|
7065
|
-
* </li>
|
|
7066
|
-
* <li>
|
|
7067
|
-
* <p>
|
|
7068
|
-
* <code>STOPPED</code> - The schedule was stopped.</p>
|
|
7069
|
-
* </li>
|
|
7070
|
-
* </ul>
|
|
5917
|
+
* <p>The status of the monitoring schedule. This can be one of the following values.</p> <ul> <li> <p> <code>PENDING</code> - The schedule is pending being created.</p> </li> <li> <p> <code>FAILED</code> - The schedule failed.</p> </li> <li> <p> <code>SCHEDULED</code> - The schedule was successfully created.</p> </li> <li> <p> <code>STOPPED</code> - The schedule was stopped.</p> </li> </ul>
|
|
7071
5918
|
* @public
|
|
7072
5919
|
*/
|
|
7073
5920
|
MonitoringScheduleStatus?: ScheduleStatus | undefined;
|
|
@@ -7107,9 +5954,7 @@ export interface MonitoringSchedule {
|
|
|
7107
5954
|
*/
|
|
7108
5955
|
LastMonitoringExecutionSummary?: MonitoringExecutionSummary | undefined;
|
|
7109
5956
|
/**
|
|
7110
|
-
* <p>A list of the tags associated with the monitoring schedlue. For more information, see
|
|
7111
|
-
* <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a> in the <i>Amazon Web Services General
|
|
7112
|
-
* Reference Guide</i>.</p>
|
|
5957
|
+
* <p>A list of the tags associated with the monitoring schedlue. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a> in the <i>Amazon Web Services General Reference Guide</i>.</p>
|
|
7113
5958
|
* @public
|
|
7114
5959
|
*/
|
|
7115
5960
|
Tags?: Tag[] | undefined;
|
|
@@ -7135,8 +5980,7 @@ export interface Endpoint {
|
|
|
7135
5980
|
*/
|
|
7136
5981
|
EndpointConfigName: string | undefined;
|
|
7137
5982
|
/**
|
|
7138
|
-
* <p>A list of the production variants hosted on the endpoint. Each production variant is a
|
|
7139
|
-
* model.</p>
|
|
5983
|
+
* <p>A list of the production variants hosted on the endpoint. Each production variant is a model.</p>
|
|
7140
5984
|
* @public
|
|
7141
5985
|
*/
|
|
7142
5986
|
ProductionVariants?: ProductionVariantSummary[] | undefined;
|
|
@@ -7166,20 +6010,17 @@ export interface Endpoint {
|
|
|
7166
6010
|
*/
|
|
7167
6011
|
LastModifiedTime: Date | undefined;
|
|
7168
6012
|
/**
|
|
7169
|
-
* <p>A list of monitoring schedules for the endpoint. For information about model
|
|
7170
|
-
* monitoring, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/model-monitor.html">Amazon SageMaker Model Monitor</a>.</p>
|
|
6013
|
+
* <p>A list of monitoring schedules for the endpoint. For information about model monitoring, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/model-monitor.html">Amazon SageMaker Model Monitor</a>.</p>
|
|
7171
6014
|
* @public
|
|
7172
6015
|
*/
|
|
7173
6016
|
MonitoringSchedules?: MonitoringSchedule[] | undefined;
|
|
7174
6017
|
/**
|
|
7175
|
-
* <p>A list of the tags associated with the endpoint. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a> in the <i>Amazon Web Services General
|
|
7176
|
-
* Reference Guide</i>.</p>
|
|
6018
|
+
* <p>A list of the tags associated with the endpoint. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a> in the <i>Amazon Web Services General Reference Guide</i>.</p>
|
|
7177
6019
|
* @public
|
|
7178
6020
|
*/
|
|
7179
6021
|
Tags?: Tag[] | undefined;
|
|
7180
6022
|
/**
|
|
7181
|
-
* <p>A list of the shadow variants hosted on the endpoint. Each shadow variant is a model
|
|
7182
|
-
* in shadow mode with production traffic replicated from the production variant.</p>
|
|
6023
|
+
* <p>A list of the shadow variants hosted on the endpoint. Each shadow variant is a model in shadow mode with production traffic replicated from the production variant.</p>
|
|
7183
6024
|
* @public
|
|
7184
6025
|
*/
|
|
7185
6026
|
ShadowProductionVariants?: ProductionVariantSummary[] | undefined;
|
|
@@ -7278,65 +6119,13 @@ export interface EndpointSummary {
|
|
|
7278
6119
|
*/
|
|
7279
6120
|
LastModifiedTime: Date | undefined;
|
|
7280
6121
|
/**
|
|
7281
|
-
* <p>The status of the endpoint.</p>
|
|
7282
|
-
* <ul>
|
|
7283
|
-
* <li>
|
|
7284
|
-
* <p>
|
|
7285
|
-
* <code>OutOfService</code>: Endpoint is not available to take incoming
|
|
7286
|
-
* requests.</p>
|
|
7287
|
-
* </li>
|
|
7288
|
-
* <li>
|
|
7289
|
-
* <p>
|
|
7290
|
-
* <code>Creating</code>: <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpoint.html">CreateEndpoint</a> is executing.</p>
|
|
7291
|
-
* </li>
|
|
7292
|
-
* <li>
|
|
7293
|
-
* <p>
|
|
7294
|
-
* <code>Updating</code>: <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpoint.html">UpdateEndpoint</a> or <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpointWeightsAndCapacities.html">UpdateEndpointWeightsAndCapacities</a> is executing.</p>
|
|
7295
|
-
* </li>
|
|
7296
|
-
* <li>
|
|
7297
|
-
* <p>
|
|
7298
|
-
* <code>SystemUpdating</code>: Endpoint is undergoing maintenance and cannot be
|
|
7299
|
-
* updated or deleted or re-scaled until it has completed. This maintenance
|
|
7300
|
-
* operation does not change any customer-specified values such as VPC config, KMS
|
|
7301
|
-
* encryption, model, instance type, or instance count.</p>
|
|
7302
|
-
* </li>
|
|
7303
|
-
* <li>
|
|
7304
|
-
* <p>
|
|
7305
|
-
* <code>RollingBack</code>: Endpoint fails to scale up or down or change its
|
|
7306
|
-
* variant weight and is in the process of rolling back to its previous
|
|
7307
|
-
* configuration. Once the rollback completes, endpoint returns to an
|
|
7308
|
-
* <code>InService</code> status. This transitional status only applies to an
|
|
7309
|
-
* endpoint that has autoscaling enabled and is undergoing variant weight or
|
|
7310
|
-
* capacity changes as part of an <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpointWeightsAndCapacities.html">UpdateEndpointWeightsAndCapacities</a> call or when the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpointWeightsAndCapacities.html">UpdateEndpointWeightsAndCapacities</a> operation is called
|
|
7311
|
-
* explicitly.</p>
|
|
7312
|
-
* </li>
|
|
7313
|
-
* <li>
|
|
7314
|
-
* <p>
|
|
7315
|
-
* <code>InService</code>: Endpoint is available to process incoming
|
|
7316
|
-
* requests.</p>
|
|
7317
|
-
* </li>
|
|
7318
|
-
* <li>
|
|
7319
|
-
* <p>
|
|
7320
|
-
* <code>Deleting</code>: <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DeleteEndpoint.html">DeleteEndpoint</a> is executing.</p>
|
|
7321
|
-
* </li>
|
|
7322
|
-
* <li>
|
|
7323
|
-
* <p>
|
|
7324
|
-
* <code>Failed</code>: Endpoint could not be created, updated, or re-scaled. Use
|
|
7325
|
-
* <code>DescribeEndpointOutput$FailureReason</code> for information about the
|
|
7326
|
-
* failure. <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DeleteEndpoint.html">DeleteEndpoint</a> is the only operation that can be performed on a
|
|
7327
|
-
* failed endpoint.</p>
|
|
7328
|
-
* </li>
|
|
7329
|
-
* </ul>
|
|
7330
|
-
* <p>To get a list of endpoints with a specified status, use the <code>StatusEquals</code>
|
|
7331
|
-
* filter with a call to <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ListEndpoints.html">ListEndpoints</a>.</p>
|
|
6122
|
+
* <p>The status of the endpoint.</p> <ul> <li> <p> <code>OutOfService</code>: Endpoint is not available to take incoming requests.</p> </li> <li> <p> <code>Creating</code>: <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpoint.html">CreateEndpoint</a> is executing.</p> </li> <li> <p> <code>Updating</code>: <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpoint.html">UpdateEndpoint</a> or <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpointWeightsAndCapacities.html">UpdateEndpointWeightsAndCapacities</a> is executing.</p> </li> <li> <p> <code>SystemUpdating</code>: Endpoint is undergoing maintenance and cannot be updated or deleted or re-scaled until it has completed. This maintenance operation does not change any customer-specified values such as VPC config, KMS encryption, model, instance type, or instance count.</p> </li> <li> <p> <code>RollingBack</code>: Endpoint fails to scale up or down or change its variant weight and is in the process of rolling back to its previous configuration. Once the rollback completes, endpoint returns to an <code>InService</code> status. This transitional status only applies to an endpoint that has autoscaling enabled and is undergoing variant weight or capacity changes as part of an <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpointWeightsAndCapacities.html">UpdateEndpointWeightsAndCapacities</a> call or when the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpointWeightsAndCapacities.html">UpdateEndpointWeightsAndCapacities</a> operation is called explicitly.</p> </li> <li> <p> <code>InService</code>: Endpoint is available to process incoming requests.</p> </li> <li> <p> <code>Deleting</code>: <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DeleteEndpoint.html">DeleteEndpoint</a> is executing.</p> </li> <li> <p> <code>Failed</code>: Endpoint could not be created, updated, or re-scaled. Use <code>DescribeEndpointOutput$FailureReason</code> for information about the failure. <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DeleteEndpoint.html">DeleteEndpoint</a> is the only operation that can be performed on a failed endpoint.</p> </li> </ul> <p>To get a list of endpoints with a specified status, use the <code>StatusEquals</code> filter with a call to <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ListEndpoints.html">ListEndpoints</a>.</p>
|
|
7332
6123
|
* @public
|
|
7333
6124
|
*/
|
|
7334
6125
|
EndpointStatus: EndpointStatus | undefined;
|
|
7335
6126
|
}
|
|
7336
6127
|
/**
|
|
7337
|
-
* <p>The properties of an experiment as returned by the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html">Search</a> API.
|
|
7338
|
-
* For information about experiments, see the
|
|
7339
|
-
* <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateExperiment.html">CreateExperiment</a> API.</p>
|
|
6128
|
+
* <p>The properties of an experiment as returned by the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html">Search</a> API. For information about experiments, see the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateExperiment.html">CreateExperiment</a> API.</p>
|
|
7340
6129
|
* @public
|
|
7341
6130
|
*/
|
|
7342
6131
|
export interface Experiment {
|
|
@@ -7351,8 +6140,7 @@ export interface Experiment {
|
|
|
7351
6140
|
*/
|
|
7352
6141
|
ExperimentArn?: string | undefined;
|
|
7353
6142
|
/**
|
|
7354
|
-
* <p>The name of the experiment as displayed. If <code>DisplayName</code> isn't specified,
|
|
7355
|
-
* <code>ExperimentName</code> is displayed.</p>
|
|
6143
|
+
* <p>The name of the experiment as displayed. If <code>DisplayName</code> isn't specified, <code>ExperimentName</code> is displayed.</p>
|
|
7356
6144
|
* @public
|
|
7357
6145
|
*/
|
|
7358
6146
|
DisplayName?: string | undefined;
|
|
@@ -7382,8 +6170,7 @@ export interface Experiment {
|
|
|
7382
6170
|
*/
|
|
7383
6171
|
LastModifiedTime?: Date | undefined;
|
|
7384
6172
|
/**
|
|
7385
|
-
* <p>Information about the user who created or modified an experiment, trial, trial
|
|
7386
|
-
* component, lineage group, project, or model card.</p>
|
|
6173
|
+
* <p>Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.</p>
|
|
7387
6174
|
* @public
|
|
7388
6175
|
*/
|
|
7389
6176
|
LastModifiedBy?: UserContext | undefined;
|
|
@@ -7394,9 +6181,7 @@ export interface Experiment {
|
|
|
7394
6181
|
Tags?: Tag[] | undefined;
|
|
7395
6182
|
}
|
|
7396
6183
|
/**
|
|
7397
|
-
* <p>A summary of the properties of an experiment. To get the complete set of properties, call
|
|
7398
|
-
* the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeExperiment.html">DescribeExperiment</a> API and provide the
|
|
7399
|
-
* <code>ExperimentName</code>.</p>
|
|
6184
|
+
* <p>A summary of the properties of an experiment. To get the complete set of properties, call the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeExperiment.html">DescribeExperiment</a> API and provide the <code>ExperimentName</code>.</p>
|
|
7400
6185
|
* @public
|
|
7401
6186
|
*/
|
|
7402
6187
|
export interface ExperimentSummary {
|
|
@@ -7411,8 +6196,7 @@ export interface ExperimentSummary {
|
|
|
7411
6196
|
*/
|
|
7412
6197
|
ExperimentName?: string | undefined;
|
|
7413
6198
|
/**
|
|
7414
|
-
* <p>The name of the experiment as displayed. If <code>DisplayName</code> isn't specified,
|
|
7415
|
-
* <code>ExperimentName</code> is displayed.</p>
|
|
6199
|
+
* <p>The name of the experiment as displayed. If <code>DisplayName</code> isn't specified, <code>ExperimentName</code> is displayed.</p>
|
|
7416
6200
|
* @public
|
|
7417
6201
|
*/
|
|
7418
6202
|
DisplayName?: string | undefined;
|
|
@@ -7438,17 +6222,13 @@ export interface ExperimentSummary {
|
|
|
7438
6222
|
*/
|
|
7439
6223
|
export interface FailStepMetadata {
|
|
7440
6224
|
/**
|
|
7441
|
-
* <p>A message that you define and then is processed and rendered by
|
|
7442
|
-
* the Fail step when the error occurs.</p>
|
|
6225
|
+
* <p>A message that you define and then is processed and rendered by the Fail step when the error occurs.</p>
|
|
7443
6226
|
* @public
|
|
7444
6227
|
*/
|
|
7445
6228
|
ErrorMessage?: string | undefined;
|
|
7446
6229
|
}
|
|
7447
6230
|
/**
|
|
7448
|
-
* <p>Amazon SageMaker Feature Store stores features in a collection called Feature Group. A
|
|
7449
|
-
* Feature Group can be visualized as a table which has rows, with a unique identifier for
|
|
7450
|
-
* each row where each column in the table is a feature. In principle, a Feature Group is
|
|
7451
|
-
* composed of features and values per features.</p>
|
|
6231
|
+
* <p>Amazon SageMaker Feature Store stores features in a collection called Feature Group. A Feature Group can be visualized as a table which has rows, with a unique identifier for each row where each column in the table is a feature. In principle, a Feature Group is composed of features and values per features.</p>
|
|
7452
6232
|
* @public
|
|
7453
6233
|
*/
|
|
7454
6234
|
export interface FeatureGroup {
|
|
@@ -7463,32 +6243,17 @@ export interface FeatureGroup {
|
|
|
7463
6243
|
*/
|
|
7464
6244
|
FeatureGroupName?: string | undefined;
|
|
7465
6245
|
/**
|
|
7466
|
-
* <p>The name of the <code>Feature</code> whose value uniquely identifies a
|
|
7467
|
-
* <code>Record</code> defined in the <code>FeatureGroup</code>
|
|
7468
|
-
* <code>FeatureDefinitions</code>.</p>
|
|
6246
|
+
* <p>The name of the <code>Feature</code> whose value uniquely identifies a <code>Record</code> defined in the <code>FeatureGroup</code> <code>FeatureDefinitions</code>.</p>
|
|
7469
6247
|
* @public
|
|
7470
6248
|
*/
|
|
7471
6249
|
RecordIdentifierFeatureName?: string | undefined;
|
|
7472
6250
|
/**
|
|
7473
|
-
* <p>The name of the feature that stores the <code>EventTime</code> of a Record in a
|
|
7474
|
-
* <code>FeatureGroup</code>.</p>
|
|
7475
|
-
* <p>A <code>EventTime</code> is point in time when a new event occurs that corresponds to
|
|
7476
|
-
* the creation or update of a <code>Record</code> in <code>FeatureGroup</code>. All
|
|
7477
|
-
* <code>Records</code> in the <code>FeatureGroup</code> must have a corresponding
|
|
7478
|
-
* <code>EventTime</code>.</p>
|
|
6251
|
+
* <p>The name of the feature that stores the <code>EventTime</code> of a Record in a <code>FeatureGroup</code>.</p> <p>A <code>EventTime</code> is point in time when a new event occurs that corresponds to the creation or update of a <code>Record</code> in <code>FeatureGroup</code>. All <code>Records</code> in the <code>FeatureGroup</code> must have a corresponding <code>EventTime</code>.</p>
|
|
7479
6252
|
* @public
|
|
7480
6253
|
*/
|
|
7481
6254
|
EventTimeFeatureName?: string | undefined;
|
|
7482
6255
|
/**
|
|
7483
|
-
* <p>A list of <code>Feature</code>s. Each <code>Feature</code> must include a
|
|
7484
|
-
* <code>FeatureName</code> and a <code>FeatureType</code>. </p>
|
|
7485
|
-
* <p>Valid <code>FeatureType</code>s are <code>Integral</code>, <code>Fractional</code> and
|
|
7486
|
-
* <code>String</code>. </p>
|
|
7487
|
-
* <p>
|
|
7488
|
-
* <code>FeatureName</code>s cannot be any of the following: <code>is_deleted</code>,
|
|
7489
|
-
* <code>write_time</code>, <code>api_invocation_time</code>.</p>
|
|
7490
|
-
* <p>You can create up to 2,500 <code>FeatureDefinition</code>s per
|
|
7491
|
-
* <code>FeatureGroup</code>.</p>
|
|
6256
|
+
* <p>A list of <code>Feature</code>s. Each <code>Feature</code> must include a <code>FeatureName</code> and a <code>FeatureType</code>. </p> <p>Valid <code>FeatureType</code>s are <code>Integral</code>, <code>Fractional</code> and <code>String</code>. </p> <p> <code>FeatureName</code>s cannot be any of the following: <code>is_deleted</code>, <code>write_time</code>, <code>api_invocation_time</code>.</p> <p>You can create up to 2,500 <code>FeatureDefinition</code>s per <code>FeatureGroup</code>.</p>
|
|
7492
6257
|
* @public
|
|
7493
6258
|
*/
|
|
7494
6259
|
FeatureDefinitions?: FeatureDefinition[] | undefined;
|
|
@@ -7503,26 +6268,17 @@ export interface FeatureGroup {
|
|
|
7503
6268
|
*/
|
|
7504
6269
|
LastModifiedTime?: Date | undefined;
|
|
7505
6270
|
/**
|
|
7506
|
-
* <p>Use this to specify the Amazon Web Services Key Management Service (KMS) Key ID, or
|
|
7507
|
-
* <code>KMSKeyId</code>, for at rest data encryption. You can turn
|
|
7508
|
-
* <code>OnlineStore</code> on or off by specifying the <code>EnableOnlineStore</code> flag
|
|
7509
|
-
* at General Assembly.</p>
|
|
7510
|
-
* <p>The default value is <code>False</code>.</p>
|
|
6271
|
+
* <p>Use this to specify the Amazon Web Services Key Management Service (KMS) Key ID, or <code>KMSKeyId</code>, for at rest data encryption. You can turn <code>OnlineStore</code> on or off by specifying the <code>EnableOnlineStore</code> flag at General Assembly.</p> <p>The default value is <code>False</code>.</p>
|
|
7511
6272
|
* @public
|
|
7512
6273
|
*/
|
|
7513
6274
|
OnlineStoreConfig?: OnlineStoreConfig | undefined;
|
|
7514
6275
|
/**
|
|
7515
|
-
* <p>The configuration of an <code>OfflineStore</code>.</p>
|
|
7516
|
-
* <p>Provide an <code>OfflineStoreConfig</code> in a request to
|
|
7517
|
-
* <code>CreateFeatureGroup</code> to create an <code>OfflineStore</code>.</p>
|
|
7518
|
-
* <p>To encrypt an <code>OfflineStore</code> using at rest data encryption, specify Amazon Web Services Key Management Service (KMS) key ID, or <code>KMSKeyId</code>, in
|
|
7519
|
-
* <code>S3StorageConfig</code>.</p>
|
|
6276
|
+
* <p>The configuration of an <code>OfflineStore</code>.</p> <p>Provide an <code>OfflineStoreConfig</code> in a request to <code>CreateFeatureGroup</code> to create an <code>OfflineStore</code>.</p> <p>To encrypt an <code>OfflineStore</code> using at rest data encryption, specify Amazon Web Services Key Management Service (KMS) key ID, or <code>KMSKeyId</code>, in <code>S3StorageConfig</code>.</p>
|
|
7520
6277
|
* @public
|
|
7521
6278
|
*/
|
|
7522
6279
|
OfflineStoreConfig?: OfflineStoreConfig | undefined;
|
|
7523
6280
|
/**
|
|
7524
|
-
* <p>The Amazon Resource Name (ARN) of the IAM execution role used to create the feature
|
|
7525
|
-
* group.</p>
|
|
6281
|
+
* <p>The Amazon Resource Name (ARN) of the IAM execution role used to create the feature group.</p>
|
|
7526
6282
|
* @public
|
|
7527
6283
|
*/
|
|
7528
6284
|
RoleArn?: string | undefined;
|
|
@@ -7542,10 +6298,7 @@ export interface FeatureGroup {
|
|
|
7542
6298
|
*/
|
|
7543
6299
|
LastUpdateStatus?: LastUpdateStatus | undefined;
|
|
7544
6300
|
/**
|
|
7545
|
-
* <p>The reason that the <code>FeatureGroup</code> failed to be replicated in the
|
|
7546
|
-
* <code>OfflineStore</code>. This is failure may be due to a failure to create a
|
|
7547
|
-
* <code>FeatureGroup</code> in or delete a <code>FeatureGroup</code> from the
|
|
7548
|
-
* <code>OfflineStore</code>.</p>
|
|
6301
|
+
* <p>The reason that the <code>FeatureGroup</code> failed to be replicated in the <code>OfflineStore</code>. This is failure may be due to a failure to create a <code>FeatureGroup</code> in or delete a <code>FeatureGroup</code> from the <code>OfflineStore</code>.</p>
|
|
7549
6302
|
* @public
|
|
7550
6303
|
*/
|
|
7551
6304
|
FailureReason?: string | undefined;
|
|
@@ -7587,9 +6340,7 @@ export declare const FeatureGroupSortOrder: {
|
|
|
7587
6340
|
*/
|
|
7588
6341
|
export type FeatureGroupSortOrder = (typeof FeatureGroupSortOrder)[keyof typeof FeatureGroupSortOrder];
|
|
7589
6342
|
/**
|
|
7590
|
-
* <p>The name, ARN, <code>CreationTime</code>, <code>FeatureGroup</code> values,
|
|
7591
|
-
* <code>LastUpdatedTime</code> and <code>EnableOnlineStorage</code> status of a
|
|
7592
|
-
* <code>FeatureGroup</code>.</p>
|
|
6343
|
+
* <p>The name, ARN, <code>CreationTime</code>, <code>FeatureGroup</code> values, <code>LastUpdatedTime</code> and <code>EnableOnlineStorage</code> status of a <code>FeatureGroup</code>.</p>
|
|
7593
6344
|
* @public
|
|
7594
6345
|
*/
|
|
7595
6346
|
export interface FeatureGroupSummary {
|
|
@@ -7604,28 +6355,23 @@ export interface FeatureGroupSummary {
|
|
|
7604
6355
|
*/
|
|
7605
6356
|
FeatureGroupArn: string | undefined;
|
|
7606
6357
|
/**
|
|
7607
|
-
* <p>A timestamp indicating the time of creation time of the
|
|
7608
|
-
* <code>FeatureGroup</code>.</p>
|
|
6358
|
+
* <p>A timestamp indicating the time of creation time of the <code>FeatureGroup</code>.</p>
|
|
7609
6359
|
* @public
|
|
7610
6360
|
*/
|
|
7611
6361
|
CreationTime: Date | undefined;
|
|
7612
6362
|
/**
|
|
7613
|
-
* <p>The status of a FeatureGroup. The status can be any of the following:
|
|
7614
|
-
* <code>Creating</code>, <code>Created</code>, <code>CreateFail</code>,
|
|
7615
|
-
* <code>Deleting</code> or <code>DetailFail</code>. </p>
|
|
6363
|
+
* <p>The status of a FeatureGroup. The status can be any of the following: <code>Creating</code>, <code>Created</code>, <code>CreateFail</code>, <code>Deleting</code> or <code>DetailFail</code>. </p>
|
|
7616
6364
|
* @public
|
|
7617
6365
|
*/
|
|
7618
6366
|
FeatureGroupStatus?: FeatureGroupStatus | undefined;
|
|
7619
6367
|
/**
|
|
7620
|
-
* <p>Notifies you if replicating data into the <code>OfflineStore</code> has failed. Returns
|
|
7621
|
-
* either: <code>Active</code> or <code>Blocked</code>.</p>
|
|
6368
|
+
* <p>Notifies you if replicating data into the <code>OfflineStore</code> has failed. Returns either: <code>Active</code> or <code>Blocked</code>.</p>
|
|
7622
6369
|
* @public
|
|
7623
6370
|
*/
|
|
7624
6371
|
OfflineStoreStatus?: OfflineStoreStatus | undefined;
|
|
7625
6372
|
}
|
|
7626
6373
|
/**
|
|
7627
|
-
* <p>The metadata for a feature. It can either be metadata that you specify, or metadata that
|
|
7628
|
-
* is updated automatically.</p>
|
|
6374
|
+
* <p>The metadata for a feature. It can either be metadata that you specify, or metadata that is updated automatically.</p>
|
|
7629
6375
|
* @public
|
|
7630
6376
|
*/
|
|
7631
6377
|
export interface FeatureMetadata {
|
|
@@ -7691,199 +6437,22 @@ export declare const Operator: {
|
|
|
7691
6437
|
*/
|
|
7692
6438
|
export type Operator = (typeof Operator)[keyof typeof Operator];
|
|
7693
6439
|
/**
|
|
7694
|
-
* <p>A conditional statement for a search expression that includes a resource property, a
|
|
7695
|
-
* Boolean operator, and a value. Resources that match the statement are returned in the results
|
|
7696
|
-
* from the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html">Search</a> API.</p>
|
|
7697
|
-
* <p>If you specify a <code>Value</code>, but not an <code>Operator</code>, SageMaker uses the
|
|
7698
|
-
* equals operator.</p>
|
|
7699
|
-
* <p>In search, there are several property types:</p>
|
|
7700
|
-
* <dl>
|
|
7701
|
-
* <dt>Metrics</dt>
|
|
7702
|
-
* <dd>
|
|
7703
|
-
* <p>To define a metric filter, enter a value using the form
|
|
7704
|
-
* <code>"Metrics.<name>"</code>, where <code><name></code> is a metric name.
|
|
7705
|
-
* For example, the following filter searches for training jobs with an
|
|
7706
|
-
* <code>"accuracy"</code> metric greater than <code>"0.9"</code>:</p>
|
|
7707
|
-
* <p>
|
|
7708
|
-
* <code>\{</code>
|
|
7709
|
-
* </p>
|
|
7710
|
-
* <p>
|
|
7711
|
-
* <code>"Name": "Metrics.accuracy",</code>
|
|
7712
|
-
* </p>
|
|
7713
|
-
* <p>
|
|
7714
|
-
* <code>"Operator": "GreaterThan",</code>
|
|
7715
|
-
* </p>
|
|
7716
|
-
* <p>
|
|
7717
|
-
* <code>"Value": "0.9"</code>
|
|
7718
|
-
* </p>
|
|
7719
|
-
* <p>
|
|
7720
|
-
* <code>\}</code>
|
|
7721
|
-
* </p>
|
|
7722
|
-
* </dd>
|
|
7723
|
-
* <dt>HyperParameters</dt>
|
|
7724
|
-
* <dd>
|
|
7725
|
-
* <p>To define a hyperparameter filter, enter a value with the form
|
|
7726
|
-
* <code>"HyperParameters.<name>"</code>. Decimal hyperparameter values are treated
|
|
7727
|
-
* as a decimal in a comparison if the specified <code>Value</code> is also a decimal
|
|
7728
|
-
* value. If the specified <code>Value</code> is an integer, the decimal hyperparameter
|
|
7729
|
-
* values are treated as integers. For example, the following filter is satisfied by
|
|
7730
|
-
* training jobs with a <code>"learning_rate"</code> hyperparameter that is less than
|
|
7731
|
-
* <code>"0.5"</code>:</p>
|
|
7732
|
-
* <p>
|
|
7733
|
-
* <code> \{</code>
|
|
7734
|
-
* </p>
|
|
7735
|
-
* <p>
|
|
7736
|
-
* <code> "Name": "HyperParameters.learning_rate",</code>
|
|
7737
|
-
* </p>
|
|
7738
|
-
* <p>
|
|
7739
|
-
* <code> "Operator": "LessThan",</code>
|
|
7740
|
-
* </p>
|
|
7741
|
-
* <p>
|
|
7742
|
-
* <code> "Value": "0.5"</code>
|
|
7743
|
-
* </p>
|
|
7744
|
-
* <p>
|
|
7745
|
-
* <code> \}</code>
|
|
7746
|
-
* </p>
|
|
7747
|
-
* </dd>
|
|
7748
|
-
* <dt>Tags</dt>
|
|
7749
|
-
* <dd>
|
|
7750
|
-
* <p>To define a tag filter, enter a value with the form
|
|
7751
|
-
* <code>Tags.<key></code>.</p>
|
|
7752
|
-
* </dd>
|
|
7753
|
-
* </dl>
|
|
6440
|
+
* <p>A conditional statement for a search expression that includes a resource property, a Boolean operator, and a value. Resources that match the statement are returned in the results from the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html">Search</a> API.</p> <p>If you specify a <code>Value</code>, but not an <code>Operator</code>, SageMaker uses the equals operator.</p> <p>In search, there are several property types:</p> <dl> <dt>Metrics</dt> <dd> <p>To define a metric filter, enter a value using the form <code>"Metrics.<name>"</code>, where <code><name></code> is a metric name. For example, the following filter searches for training jobs with an <code>"accuracy"</code> metric greater than <code>"0.9"</code>:</p> <p> <code>\{</code> </p> <p> <code>"Name": "Metrics.accuracy",</code> </p> <p> <code>"Operator": "GreaterThan",</code> </p> <p> <code>"Value": "0.9"</code> </p> <p> <code>\}</code> </p> </dd> <dt>HyperParameters</dt> <dd> <p>To define a hyperparameter filter, enter a value with the form <code>"HyperParameters.<name>"</code>. Decimal hyperparameter values are treated as a decimal in a comparison if the specified <code>Value</code> is also a decimal value. If the specified <code>Value</code> is an integer, the decimal hyperparameter values are treated as integers. For example, the following filter is satisfied by training jobs with a <code>"learning_rate"</code> hyperparameter that is less than <code>"0.5"</code>:</p> <p> <code> \{</code> </p> <p> <code> "Name": "HyperParameters.learning_rate",</code> </p> <p> <code> "Operator": "LessThan",</code> </p> <p> <code> "Value": "0.5"</code> </p> <p> <code> \}</code> </p> </dd> <dt>Tags</dt> <dd> <p>To define a tag filter, enter a value with the form <code>Tags.<key></code>.</p> </dd> </dl>
|
|
7754
6441
|
* @public
|
|
7755
6442
|
*/
|
|
7756
6443
|
export interface Filter {
|
|
7757
6444
|
/**
|
|
7758
|
-
* <p>A resource property name. For example, <code>TrainingJobName</code>. For valid property
|
|
7759
|
-
* names, see <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_SearchRecord.html">SearchRecord</a>. You must
|
|
7760
|
-
* specify a valid property for the resource.</p>
|
|
6445
|
+
* <p>A resource property name. For example, <code>TrainingJobName</code>. For valid property names, see <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_SearchRecord.html">SearchRecord</a>. You must specify a valid property for the resource.</p>
|
|
7761
6446
|
* @public
|
|
7762
6447
|
*/
|
|
7763
6448
|
Name: string | undefined;
|
|
7764
6449
|
/**
|
|
7765
|
-
* <p>A Boolean binary operator that is used to evaluate the filter. The operator field contains
|
|
7766
|
-
* one of the following values:</p>
|
|
7767
|
-
* <dl>
|
|
7768
|
-
* <dt>Equals</dt>
|
|
7769
|
-
* <dd>
|
|
7770
|
-
* <p>The value of <code>Name</code> equals <code>Value</code>.</p>
|
|
7771
|
-
* </dd>
|
|
7772
|
-
* <dt>NotEquals</dt>
|
|
7773
|
-
* <dd>
|
|
7774
|
-
* <p>The value of <code>Name</code> doesn't equal <code>Value</code>.</p>
|
|
7775
|
-
* </dd>
|
|
7776
|
-
* <dt>Exists</dt>
|
|
7777
|
-
* <dd>
|
|
7778
|
-
* <p>The <code>Name</code> property exists.</p>
|
|
7779
|
-
* </dd>
|
|
7780
|
-
* <dt>NotExists</dt>
|
|
7781
|
-
* <dd>
|
|
7782
|
-
* <p>The <code>Name</code> property does not exist.</p>
|
|
7783
|
-
* </dd>
|
|
7784
|
-
* <dt>GreaterThan</dt>
|
|
7785
|
-
* <dd>
|
|
7786
|
-
* <p>The value of <code>Name</code> is greater than <code>Value</code>. Not supported for
|
|
7787
|
-
* text properties.</p>
|
|
7788
|
-
* </dd>
|
|
7789
|
-
* <dt>GreaterThanOrEqualTo</dt>
|
|
7790
|
-
* <dd>
|
|
7791
|
-
* <p>The value of <code>Name</code> is greater than or equal to <code>Value</code>. Not
|
|
7792
|
-
* supported for text properties.</p>
|
|
7793
|
-
* </dd>
|
|
7794
|
-
* <dt>LessThan</dt>
|
|
7795
|
-
* <dd>
|
|
7796
|
-
* <p>The value of <code>Name</code> is less than <code>Value</code>. Not supported for
|
|
7797
|
-
* text properties.</p>
|
|
7798
|
-
* </dd>
|
|
7799
|
-
* <dt>LessThanOrEqualTo</dt>
|
|
7800
|
-
* <dd>
|
|
7801
|
-
* <p>The value of <code>Name</code> is less than or equal to <code>Value</code>. Not
|
|
7802
|
-
* supported for text properties.</p>
|
|
7803
|
-
* </dd>
|
|
7804
|
-
* <dt>In</dt>
|
|
7805
|
-
* <dd>
|
|
7806
|
-
* <p>The value of <code>Name</code> is one of the comma delimited strings in
|
|
7807
|
-
* <code>Value</code>. Only supported for text properties.</p>
|
|
7808
|
-
* </dd>
|
|
7809
|
-
* <dt>Contains</dt>
|
|
7810
|
-
* <dd>
|
|
7811
|
-
* <p>The value of <code>Name</code> contains the string <code>Value</code>. Only
|
|
7812
|
-
* supported for text properties.</p>
|
|
7813
|
-
* <p>A <code>SearchExpression</code> can include the <code>Contains</code> operator
|
|
7814
|
-
* multiple times when the value of <code>Name</code> is one of the following:</p>
|
|
7815
|
-
* <ul>
|
|
7816
|
-
* <li>
|
|
7817
|
-
* <p>
|
|
7818
|
-
* <code>Experiment.DisplayName</code>
|
|
7819
|
-
* </p>
|
|
7820
|
-
* </li>
|
|
7821
|
-
* <li>
|
|
7822
|
-
* <p>
|
|
7823
|
-
* <code>Experiment.ExperimentName</code>
|
|
7824
|
-
* </p>
|
|
7825
|
-
* </li>
|
|
7826
|
-
* <li>
|
|
7827
|
-
* <p>
|
|
7828
|
-
* <code>Experiment.Tags</code>
|
|
7829
|
-
* </p>
|
|
7830
|
-
* </li>
|
|
7831
|
-
* <li>
|
|
7832
|
-
* <p>
|
|
7833
|
-
* <code>Trial.DisplayName</code>
|
|
7834
|
-
* </p>
|
|
7835
|
-
* </li>
|
|
7836
|
-
* <li>
|
|
7837
|
-
* <p>
|
|
7838
|
-
* <code>Trial.TrialName</code>
|
|
7839
|
-
* </p>
|
|
7840
|
-
* </li>
|
|
7841
|
-
* <li>
|
|
7842
|
-
* <p>
|
|
7843
|
-
* <code>Trial.Tags</code>
|
|
7844
|
-
* </p>
|
|
7845
|
-
* </li>
|
|
7846
|
-
* <li>
|
|
7847
|
-
* <p>
|
|
7848
|
-
* <code>TrialComponent.DisplayName</code>
|
|
7849
|
-
* </p>
|
|
7850
|
-
* </li>
|
|
7851
|
-
* <li>
|
|
7852
|
-
* <p>
|
|
7853
|
-
* <code>TrialComponent.TrialComponentName</code>
|
|
7854
|
-
* </p>
|
|
7855
|
-
* </li>
|
|
7856
|
-
* <li>
|
|
7857
|
-
* <p>
|
|
7858
|
-
* <code>TrialComponent.Tags</code>
|
|
7859
|
-
* </p>
|
|
7860
|
-
* </li>
|
|
7861
|
-
* <li>
|
|
7862
|
-
* <p>
|
|
7863
|
-
* <code>TrialComponent.InputArtifacts</code>
|
|
7864
|
-
* </p>
|
|
7865
|
-
* </li>
|
|
7866
|
-
* <li>
|
|
7867
|
-
* <p>
|
|
7868
|
-
* <code>TrialComponent.OutputArtifacts</code>
|
|
7869
|
-
* </p>
|
|
7870
|
-
* </li>
|
|
7871
|
-
* </ul>
|
|
7872
|
-
* <p>A <code>SearchExpression</code> can include only one <code>Contains</code> operator
|
|
7873
|
-
* for all other values of <code>Name</code>. In these cases, if you include multiple
|
|
7874
|
-
* <code>Contains</code> operators in the <code>SearchExpression</code>, the result is
|
|
7875
|
-
* the following error message: "<code>'CONTAINS' operator usage limit of 1
|
|
7876
|
-
* exceeded.</code>"</p>
|
|
7877
|
-
* </dd>
|
|
7878
|
-
* </dl>
|
|
6450
|
+
* <p>A Boolean binary operator that is used to evaluate the filter. The operator field contains one of the following values:</p> <dl> <dt>Equals</dt> <dd> <p>The value of <code>Name</code> equals <code>Value</code>.</p> </dd> <dt>NotEquals</dt> <dd> <p>The value of <code>Name</code> doesn't equal <code>Value</code>.</p> </dd> <dt>Exists</dt> <dd> <p>The <code>Name</code> property exists.</p> </dd> <dt>NotExists</dt> <dd> <p>The <code>Name</code> property does not exist.</p> </dd> <dt>GreaterThan</dt> <dd> <p>The value of <code>Name</code> is greater than <code>Value</code>. Not supported for text properties.</p> </dd> <dt>GreaterThanOrEqualTo</dt> <dd> <p>The value of <code>Name</code> is greater than or equal to <code>Value</code>. Not supported for text properties.</p> </dd> <dt>LessThan</dt> <dd> <p>The value of <code>Name</code> is less than <code>Value</code>. Not supported for text properties.</p> </dd> <dt>LessThanOrEqualTo</dt> <dd> <p>The value of <code>Name</code> is less than or equal to <code>Value</code>. Not supported for text properties.</p> </dd> <dt>In</dt> <dd> <p>The value of <code>Name</code> is one of the comma delimited strings in <code>Value</code>. Only supported for text properties.</p> </dd> <dt>Contains</dt> <dd> <p>The value of <code>Name</code> contains the string <code>Value</code>. Only supported for text properties.</p> <p>A <code>SearchExpression</code> can include the <code>Contains</code> operator multiple times when the value of <code>Name</code> is one of the following:</p> <ul> <li> <p> <code>Experiment.DisplayName</code> </p> </li> <li> <p> <code>Experiment.ExperimentName</code> </p> </li> <li> <p> <code>Experiment.Tags</code> </p> </li> <li> <p> <code>Trial.DisplayName</code> </p> </li> <li> <p> <code>Trial.TrialName</code> </p> </li> <li> <p> <code>Trial.Tags</code> </p> </li> <li> <p> <code>TrialComponent.DisplayName</code> </p> </li> <li> <p> <code>TrialComponent.TrialComponentName</code> </p> </li> <li> <p> <code>TrialComponent.Tags</code> </p> </li> <li> <p> <code>TrialComponent.InputArtifacts</code> </p> </li> <li> <p> <code>TrialComponent.OutputArtifacts</code> </p> </li> </ul> <p>A <code>SearchExpression</code> can include only one <code>Contains</code> operator for all other values of <code>Name</code>. In these cases, if you include multiple <code>Contains</code> operators in the <code>SearchExpression</code>, the result is the following error message: "<code>'CONTAINS' operator usage limit of 1 exceeded.</code>"</p> </dd> </dl>
|
|
7879
6451
|
* @public
|
|
7880
6452
|
*/
|
|
7881
6453
|
Operator?: Operator | undefined;
|
|
7882
6454
|
/**
|
|
7883
|
-
* <p>A value used with <code>Name</code> and <code>Operator</code> to determine which resources
|
|
7884
|
-
* satisfy the filter's condition. For numerical properties, <code>Value</code> must be an
|
|
7885
|
-
* integer or floating-point decimal. For timestamp properties, <code>Value</code> must be an ISO
|
|
7886
|
-
* 8601 date-time string of the following format: <code>YYYY-mm-dd'T'HH:MM:SS</code>.</p>
|
|
6455
|
+
* <p>A value used with <code>Name</code> and <code>Operator</code> to determine which resources satisfy the filter's condition. For numerical properties, <code>Value</code> must be an integer or floating-point decimal. For timestamp properties, <code>Value</code> must be an ISO 8601 date-time string of the following format: <code>YYYY-mm-dd'T'HH:MM:SS</code>.</p>
|
|
7887
6456
|
* @public
|
|
7888
6457
|
*/
|
|
7889
6458
|
Value?: string | undefined;
|
|
@@ -8072,16 +6641,12 @@ export interface GetScalingConfigurationRecommendationRequest {
|
|
|
8072
6641
|
*/
|
|
8073
6642
|
InferenceRecommendationsJobName: string | undefined;
|
|
8074
6643
|
/**
|
|
8075
|
-
* <p>The recommendation ID of a previously completed inference recommendation. This ID should come from one of the
|
|
8076
|
-
* recommendations returned by the job specified in the <code>InferenceRecommendationsJobName</code> field.</p>
|
|
8077
|
-
* <p>Specify either this field or the <code>EndpointName</code> field.</p>
|
|
6644
|
+
* <p>The recommendation ID of a previously completed inference recommendation. This ID should come from one of the recommendations returned by the job specified in the <code>InferenceRecommendationsJobName</code> field.</p> <p>Specify either this field or the <code>EndpointName</code> field.</p>
|
|
8078
6645
|
* @public
|
|
8079
6646
|
*/
|
|
8080
6647
|
RecommendationId?: string | undefined;
|
|
8081
6648
|
/**
|
|
8082
|
-
* <p>The name of an endpoint benchmarked during a previously completed inference recommendation job. This name should come from one of the
|
|
8083
|
-
* recommendations returned by the job specified in the <code>InferenceRecommendationsJobName</code> field.</p>
|
|
8084
|
-
* <p>Specify either this field or the <code>RecommendationId</code> field.</p>
|
|
6649
|
+
* <p>The name of an endpoint benchmarked during a previously completed inference recommendation job. This name should come from one of the recommendations returned by the job specified in the <code>InferenceRecommendationsJobName</code> field.</p> <p>Specify either this field or the <code>RecommendationId</code> field.</p>
|
|
8085
6650
|
* @public
|
|
8086
6651
|
*/
|
|
8087
6652
|
EndpointName?: string | undefined;
|
|
@@ -8102,18 +6667,12 @@ export interface GetScalingConfigurationRecommendationRequest {
|
|
|
8102
6667
|
*/
|
|
8103
6668
|
export interface ScalingPolicyMetric {
|
|
8104
6669
|
/**
|
|
8105
|
-
* <p>The number of invocations sent to a model, normalized by <code>InstanceCount</code>
|
|
8106
|
-
* in each ProductionVariant. <code>1/numberOfInstances</code> is sent as the value on each
|
|
8107
|
-
* request, where <code>numberOfInstances</code> is the number of active instances for the
|
|
8108
|
-
* ProductionVariant behind the endpoint at the time of the request.</p>
|
|
6670
|
+
* <p>The number of invocations sent to a model, normalized by <code>InstanceCount</code> in each ProductionVariant. <code>1/numberOfInstances</code> is sent as the value on each request, where <code>numberOfInstances</code> is the number of active instances for the ProductionVariant behind the endpoint at the time of the request.</p>
|
|
8109
6671
|
* @public
|
|
8110
6672
|
*/
|
|
8111
6673
|
InvocationsPerInstance?: number | undefined;
|
|
8112
6674
|
/**
|
|
8113
|
-
* <p>The interval of time taken by a model to respond as viewed from SageMaker.
|
|
8114
|
-
* This interval includes the local communication times taken to send the request
|
|
8115
|
-
* and to fetch the response from the container of a model and the time taken to
|
|
8116
|
-
* complete the inference in the container.</p>
|
|
6675
|
+
* <p>The interval of time taken by a model to respond as viewed from SageMaker. This interval includes the local communication times taken to send the request and to fetch the response from the container of a model and the time taken to complete the inference in the container.</p>
|
|
8117
6676
|
* @public
|
|
8118
6677
|
*/
|
|
8119
6678
|
ModelLatency?: number | undefined;
|
|
@@ -8186,8 +6745,7 @@ export declare const ResourceType: {
|
|
|
8186
6745
|
*/
|
|
8187
6746
|
export type ResourceType = (typeof ResourceType)[keyof typeof ResourceType];
|
|
8188
6747
|
/**
|
|
8189
|
-
* <p>Part of the <code>SuggestionQuery</code> type. Specifies a hint for retrieving property
|
|
8190
|
-
* names that begin with the specified text.</p>
|
|
6748
|
+
* <p>Part of the <code>SuggestionQuery</code> type. Specifies a hint for retrieving property names that begin with the specified text.</p>
|
|
8191
6749
|
* @public
|
|
8192
6750
|
*/
|
|
8193
6751
|
export interface PropertyNameQuery {
|
|
@@ -8198,14 +6756,12 @@ export interface PropertyNameQuery {
|
|
|
8198
6756
|
PropertyNameHint: string | undefined;
|
|
8199
6757
|
}
|
|
8200
6758
|
/**
|
|
8201
|
-
* <p>Specified in the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_GetSearchSuggestions.html">GetSearchSuggestions</a> request. Limits the property names that are included in the
|
|
8202
|
-
* response.</p>
|
|
6759
|
+
* <p>Specified in the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_GetSearchSuggestions.html">GetSearchSuggestions</a> request. Limits the property names that are included in the response.</p>
|
|
8203
6760
|
* @public
|
|
8204
6761
|
*/
|
|
8205
6762
|
export interface SuggestionQuery {
|
|
8206
6763
|
/**
|
|
8207
|
-
* <p>Defines a property name hint. Only property names that begin with the specified hint are
|
|
8208
|
-
* included in the response.</p>
|
|
6764
|
+
* <p>Defines a property name hint. Only property names that begin with the specified hint are included in the response.</p>
|
|
8209
6765
|
* @public
|
|
8210
6766
|
*/
|
|
8211
6767
|
PropertyNameQuery?: PropertyNameQuery | undefined;
|
|
@@ -8226,14 +6782,12 @@ export interface GetSearchSuggestionsRequest {
|
|
|
8226
6782
|
SuggestionQuery?: SuggestionQuery | undefined;
|
|
8227
6783
|
}
|
|
8228
6784
|
/**
|
|
8229
|
-
* <p>A property name returned from a <code>GetSearchSuggestions</code> call that specifies a
|
|
8230
|
-
* value in the <code>PropertyNameQuery</code> field.</p>
|
|
6785
|
+
* <p>A property name returned from a <code>GetSearchSuggestions</code> call that specifies a value in the <code>PropertyNameQuery</code> field.</p>
|
|
8231
6786
|
* @public
|
|
8232
6787
|
*/
|
|
8233
6788
|
export interface PropertyNameSuggestion {
|
|
8234
6789
|
/**
|
|
8235
|
-
* <p>A suggested property name based on what you entered in the search textbox in the SageMaker
|
|
8236
|
-
* console.</p>
|
|
6790
|
+
* <p>A suggested property name based on what you entered in the search textbox in the SageMaker console.</p>
|
|
8237
6791
|
* @public
|
|
8238
6792
|
*/
|
|
8239
6793
|
PropertyName?: string | undefined;
|
|
@@ -8243,26 +6797,18 @@ export interface PropertyNameSuggestion {
|
|
|
8243
6797
|
*/
|
|
8244
6798
|
export interface GetSearchSuggestionsResponse {
|
|
8245
6799
|
/**
|
|
8246
|
-
* <p>A list of property names for a <code>Resource</code> that match a
|
|
8247
|
-
* <code>SuggestionQuery</code>.</p>
|
|
6800
|
+
* <p>A list of property names for a <code>Resource</code> that match a <code>SuggestionQuery</code>.</p>
|
|
8248
6801
|
* @public
|
|
8249
6802
|
*/
|
|
8250
6803
|
PropertyNameSuggestions?: PropertyNameSuggestion[] | undefined;
|
|
8251
6804
|
}
|
|
8252
6805
|
/**
|
|
8253
|
-
* <p>Specifies configuration details for a Git repository when the repository is
|
|
8254
|
-
* updated.</p>
|
|
6806
|
+
* <p>Specifies configuration details for a Git repository when the repository is updated.</p>
|
|
8255
6807
|
* @public
|
|
8256
6808
|
*/
|
|
8257
6809
|
export interface GitConfigForUpdate {
|
|
8258
6810
|
/**
|
|
8259
|
-
* <p>The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that
|
|
8260
|
-
* contains the credentials used to access the git repository. The secret must have a
|
|
8261
|
-
* staging label of <code>AWSCURRENT</code> and must be in the following format:</p>
|
|
8262
|
-
* <p>
|
|
8263
|
-
* <code>\{"username": <i>UserName</i>, "password":
|
|
8264
|
-
* <i>Password</i>\}</code>
|
|
8265
|
-
* </p>
|
|
6811
|
+
* <p>The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that contains the credentials used to access the git repository. The secret must have a staging label of <code>AWSCURRENT</code> and must be in the following format:</p> <p> <code>\{"username": <i>UserName</i>, "password": <i>Password</i>\}</code> </p>
|
|
8266
6812
|
* @public
|
|
8267
6813
|
*/
|
|
8268
6814
|
SecretArn?: string | undefined;
|
|
@@ -8433,8 +6979,7 @@ export interface HumanTaskUiSummary {
|
|
|
8433
6979
|
CreationTime: Date | undefined;
|
|
8434
6980
|
}
|
|
8435
6981
|
/**
|
|
8436
|
-
* <p>An entity returned by the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_SearchRecord.html">SearchRecord</a> API
|
|
8437
|
-
* containing the properties of a hyperparameter tuning job.</p>
|
|
6982
|
+
* <p>An entity returned by the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_SearchRecord.html">SearchRecord</a> API containing the properties of a hyperparameter tuning job.</p>
|
|
8438
6983
|
* @public
|
|
8439
6984
|
*/
|
|
8440
6985
|
export interface HyperParameterTuningJobSearchEntity {
|
|
@@ -8454,8 +6999,7 @@ export interface HyperParameterTuningJobSearchEntity {
|
|
|
8454
6999
|
*/
|
|
8455
7000
|
HyperParameterTuningJobConfig?: HyperParameterTuningJobConfig | undefined;
|
|
8456
7001
|
/**
|
|
8457
|
-
* <p>Defines
|
|
8458
|
-
* the training jobs launched by a hyperparameter tuning job.</p>
|
|
7002
|
+
* <p>Defines the training jobs launched by a hyperparameter tuning job.</p>
|
|
8459
7003
|
* @public
|
|
8460
7004
|
*/
|
|
8461
7005
|
TrainingJobDefinition?: HyperParameterTrainingJobDefinition | undefined;
|
|
@@ -8485,18 +7029,12 @@ export interface HyperParameterTuningJobSearchEntity {
|
|
|
8485
7029
|
*/
|
|
8486
7030
|
LastModifiedTime?: Date | undefined;
|
|
8487
7031
|
/**
|
|
8488
|
-
* <p>The numbers of training jobs launched by a hyperparameter tuning job, categorized by
|
|
8489
|
-
* status.</p>
|
|
7032
|
+
* <p>The numbers of training jobs launched by a hyperparameter tuning job, categorized by status.</p>
|
|
8490
7033
|
* @public
|
|
8491
7034
|
*/
|
|
8492
7035
|
TrainingJobStatusCounters?: TrainingJobStatusCounters | undefined;
|
|
8493
7036
|
/**
|
|
8494
|
-
* <p>Specifies the number of training jobs that this hyperparameter tuning job launched,
|
|
8495
|
-
* categorized by the status of their objective metric. The objective metric status shows
|
|
8496
|
-
* whether the
|
|
8497
|
-
* final
|
|
8498
|
-
* objective metric for the training job has been evaluated by the
|
|
8499
|
-
* tuning job and used in the hyperparameter tuning process.</p>
|
|
7037
|
+
* <p>Specifies the number of training jobs that this hyperparameter tuning job launched, categorized by the status of their objective metric. The objective metric status shows whether the final objective metric for the training job has been evaluated by the tuning job and used in the hyperparameter tuning process.</p>
|
|
8500
7038
|
* @public
|
|
8501
7039
|
*/
|
|
8502
7040
|
ObjectiveStatusCounters?: ObjectiveStatusCounters | undefined;
|
|
@@ -8511,20 +7049,7 @@ export interface HyperParameterTuningJobSearchEntity {
|
|
|
8511
7049
|
*/
|
|
8512
7050
|
OverallBestTrainingJob?: HyperParameterTrainingJobSummary | undefined;
|
|
8513
7051
|
/**
|
|
8514
|
-
* <p>Specifies the configuration for a hyperparameter tuning job that uses one or more
|
|
8515
|
-
* previous hyperparameter tuning jobs as a starting point. The results of previous tuning
|
|
8516
|
-
* jobs are used to inform which combinations of hyperparameters to search over in the new
|
|
8517
|
-
* tuning job.</p>
|
|
8518
|
-
* <p>All training jobs launched by the new hyperparameter tuning job are evaluated by using
|
|
8519
|
-
* the objective metric, and the training job that performs the best is compared to the
|
|
8520
|
-
* best training jobs from the parent tuning jobs. From these, the training job that
|
|
8521
|
-
* performs the best as measured by the objective metric is returned as the overall best
|
|
8522
|
-
* training job.</p>
|
|
8523
|
-
* <note>
|
|
8524
|
-
* <p>All training jobs launched by parent hyperparameter tuning jobs and the new
|
|
8525
|
-
* hyperparameter tuning jobs count against the limit of training jobs for the tuning
|
|
8526
|
-
* job.</p>
|
|
8527
|
-
* </note>
|
|
7052
|
+
* <p>Specifies the configuration for a hyperparameter tuning job that uses one or more previous hyperparameter tuning jobs as a starting point. The results of previous tuning jobs are used to inform which combinations of hyperparameters to search over in the new tuning job.</p> <p>All training jobs launched by the new hyperparameter tuning job are evaluated by using the objective metric, and the training job that performs the best is compared to the best training jobs from the parent tuning jobs. From these, the training job that performs the best as measured by the objective metric is returned as the overall best training job.</p> <note> <p>All training jobs launched by parent hyperparameter tuning jobs and the new hyperparameter tuning jobs count against the limit of training jobs for the tuning job.</p> </note>
|
|
8528
7053
|
* @public
|
|
8529
7054
|
*/
|
|
8530
7055
|
WarmStartConfig?: HyperParameterTuningJobWarmStartConfig | undefined;
|
|
@@ -8573,24 +7098,17 @@ export interface HyperParameterTuningJobSummary {
|
|
|
8573
7098
|
*/
|
|
8574
7099
|
HyperParameterTuningJobName: string | undefined;
|
|
8575
7100
|
/**
|
|
8576
|
-
* <p>The
|
|
8577
|
-
* Amazon
|
|
8578
|
-
* Resource Name (ARN) of the tuning job.</p>
|
|
7101
|
+
* <p>The Amazon Resource Name (ARN) of the tuning job.</p>
|
|
8579
7102
|
* @public
|
|
8580
7103
|
*/
|
|
8581
7104
|
HyperParameterTuningJobArn: string | undefined;
|
|
8582
7105
|
/**
|
|
8583
|
-
* <p>The status of the
|
|
8584
|
-
* tuning
|
|
8585
|
-
* job.</p>
|
|
7106
|
+
* <p>The status of the tuning job.</p>
|
|
8586
7107
|
* @public
|
|
8587
7108
|
*/
|
|
8588
7109
|
HyperParameterTuningJobStatus: HyperParameterTuningJobStatus | undefined;
|
|
8589
7110
|
/**
|
|
8590
|
-
* <p>Specifies the search strategy hyperparameter tuning uses to choose which
|
|
8591
|
-
* hyperparameters to
|
|
8592
|
-
* evaluate
|
|
8593
|
-
* at each iteration.</p>
|
|
7111
|
+
* <p>Specifies the search strategy hyperparameter tuning uses to choose which hyperparameters to evaluate at each iteration.</p>
|
|
8594
7112
|
* @public
|
|
8595
7113
|
*/
|
|
8596
7114
|
Strategy: HyperParameterTuningJobStrategyType | undefined;
|
|
@@ -8605,35 +7123,28 @@ export interface HyperParameterTuningJobSummary {
|
|
|
8605
7123
|
*/
|
|
8606
7124
|
HyperParameterTuningEndTime?: Date | undefined;
|
|
8607
7125
|
/**
|
|
8608
|
-
* <p>The date and time that the tuning job was
|
|
8609
|
-
* modified.</p>
|
|
7126
|
+
* <p>The date and time that the tuning job was modified.</p>
|
|
8610
7127
|
* @public
|
|
8611
7128
|
*/
|
|
8612
7129
|
LastModifiedTime?: Date | undefined;
|
|
8613
7130
|
/**
|
|
8614
|
-
* <p>The <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_TrainingJobStatusCounters.html">TrainingJobStatusCounters</a> object that specifies the numbers of training
|
|
8615
|
-
* jobs, categorized by status, that this tuning job launched.</p>
|
|
7131
|
+
* <p>The <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_TrainingJobStatusCounters.html">TrainingJobStatusCounters</a> object that specifies the numbers of training jobs, categorized by status, that this tuning job launched.</p>
|
|
8616
7132
|
* @public
|
|
8617
7133
|
*/
|
|
8618
7134
|
TrainingJobStatusCounters: TrainingJobStatusCounters | undefined;
|
|
8619
7135
|
/**
|
|
8620
|
-
* <p>The <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ObjectiveStatusCounters.html">ObjectiveStatusCounters</a> object that specifies the numbers of training jobs,
|
|
8621
|
-
* categorized by objective metric status, that this tuning job launched.</p>
|
|
7136
|
+
* <p>The <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ObjectiveStatusCounters.html">ObjectiveStatusCounters</a> object that specifies the numbers of training jobs, categorized by objective metric status, that this tuning job launched.</p>
|
|
8622
7137
|
* @public
|
|
8623
7138
|
*/
|
|
8624
7139
|
ObjectiveStatusCounters: ObjectiveStatusCounters | undefined;
|
|
8625
7140
|
/**
|
|
8626
|
-
* <p>The <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ResourceLimits.html">ResourceLimits</a>
|
|
8627
|
-
* object that specifies the maximum number of training jobs and parallel training jobs
|
|
8628
|
-
* allowed for this tuning job.</p>
|
|
7141
|
+
* <p>The <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ResourceLimits.html">ResourceLimits</a> object that specifies the maximum number of training jobs and parallel training jobs allowed for this tuning job.</p>
|
|
8629
7142
|
* @public
|
|
8630
7143
|
*/
|
|
8631
7144
|
ResourceLimits?: ResourceLimits | undefined;
|
|
8632
7145
|
}
|
|
8633
7146
|
/**
|
|
8634
|
-
* <p>A SageMaker AI image. A SageMaker AI image represents a set of container images that are derived from
|
|
8635
|
-
* a common base container image. Each of these container images is represented by a SageMaker AI
|
|
8636
|
-
* <code>ImageVersion</code>.</p>
|
|
7147
|
+
* <p>A SageMaker AI image. A SageMaker AI image represents a set of container images that are derived from a common base container image. Each of these container images is represented by a SageMaker AI <code>ImageVersion</code>.</p>
|
|
8637
7148
|
* @public
|
|
8638
7149
|
*/
|
|
8639
7150
|
export interface Image {
|
|
@@ -8704,8 +7215,7 @@ export declare const ImageSortOrder: {
|
|
|
8704
7215
|
*/
|
|
8705
7216
|
export type ImageSortOrder = (typeof ImageSortOrder)[keyof typeof ImageSortOrder];
|
|
8706
7217
|
/**
|
|
8707
|
-
* <p>A version of a SageMaker AI <code>Image</code>. A version represents an existing container
|
|
8708
|
-
* image.</p>
|
|
7218
|
+
* <p>A version of a SageMaker AI <code>Image</code>. A version represents an existing container image.</p>
|
|
8709
7219
|
* @public
|
|
8710
7220
|
*/
|
|
8711
7221
|
export interface ImageVersion {
|
|
@@ -8925,8 +7435,7 @@ export interface InferenceExperimentSummary {
|
|
|
8925
7435
|
*/
|
|
8926
7436
|
Type: InferenceExperimentType | undefined;
|
|
8927
7437
|
/**
|
|
8928
|
-
* <p>The duration for which the inference experiment ran or will run.</p>
|
|
8929
|
-
* <p>The maximum duration that you can set for an inference experiment is 30 days.</p>
|
|
7438
|
+
* <p>The duration for which the inference experiment ran or will run.</p> <p>The maximum duration that you can set for an inference experiment is 30 days.</p>
|
|
8930
7439
|
* @public
|
|
8931
7440
|
*/
|
|
8932
7441
|
Schedule?: InferenceExperimentSchedule | undefined;
|
|
@@ -8961,10 +7470,7 @@ export interface InferenceExperimentSummary {
|
|
|
8961
7470
|
*/
|
|
8962
7471
|
LastModifiedTime: Date | undefined;
|
|
8963
7472
|
/**
|
|
8964
|
-
* <p>
|
|
8965
|
-
* The ARN of the IAM role that Amazon SageMaker can assume to access model artifacts and container images, and manage
|
|
8966
|
-
* Amazon SageMaker Inference endpoints for model deployment.
|
|
8967
|
-
* </p>
|
|
7473
|
+
* <p> The ARN of the IAM role that Amazon SageMaker can assume to access model artifacts and container images, and manage Amazon SageMaker Inference endpoints for model deployment. </p>
|
|
8968
7474
|
* @public
|
|
8969
7475
|
*/
|
|
8970
7476
|
RoleArn?: string | undefined;
|
|
@@ -9022,8 +7528,7 @@ export interface InferenceRecommendationsJob {
|
|
|
9022
7528
|
*/
|
|
9023
7529
|
CompletionTime?: Date | undefined;
|
|
9024
7530
|
/**
|
|
9025
|
-
* <p>The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker
|
|
9026
|
-
* to perform tasks on your behalf.</p>
|
|
7531
|
+
* <p>The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.</p>
|
|
9027
7532
|
* @public
|
|
9028
7533
|
*/
|
|
9029
7534
|
RoleArn: string | undefined;
|
|
@@ -9043,8 +7548,7 @@ export interface InferenceRecommendationsJob {
|
|
|
9043
7548
|
*/
|
|
9044
7549
|
ModelName?: string | undefined;
|
|
9045
7550
|
/**
|
|
9046
|
-
* <p>The Amazon Simple Storage Service (Amazon S3) path where the sample payload is stored.
|
|
9047
|
-
* This path must point to a single gzip compressed tar archive (.tar.gz suffix).</p>
|
|
7551
|
+
* <p>The Amazon Simple Storage Service (Amazon S3) path where the sample payload is stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).</p>
|
|
9048
7552
|
* @public
|
|
9049
7553
|
*/
|
|
9050
7554
|
SamplePayloadUrl?: string | undefined;
|
|
@@ -9107,15 +7611,12 @@ export declare const RecommendationStepType: {
|
|
|
9107
7611
|
*/
|
|
9108
7612
|
export type RecommendationStepType = (typeof RecommendationStepType)[keyof typeof RecommendationStepType];
|
|
9109
7613
|
/**
|
|
9110
|
-
* <p>A returned array object for the <code>Steps</code> response field in the
|
|
9111
|
-
* <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ListInferenceRecommendationsJobSteps.html">ListInferenceRecommendationsJobSteps</a> API command.</p>
|
|
7614
|
+
* <p>A returned array object for the <code>Steps</code> response field in the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ListInferenceRecommendationsJobSteps.html">ListInferenceRecommendationsJobSteps</a> API command.</p>
|
|
9112
7615
|
* @public
|
|
9113
7616
|
*/
|
|
9114
7617
|
export interface InferenceRecommendationsJobStep {
|
|
9115
7618
|
/**
|
|
9116
|
-
* <p>The type of the subtask.</p>
|
|
9117
|
-
* <p>
|
|
9118
|
-
* <code>BENCHMARK</code>: Evaluate the performance of your model on different instance types.</p>
|
|
7619
|
+
* <p>The type of the subtask.</p> <p> <code>BENCHMARK</code>: Evaluate the performance of your model on different instance types.</p>
|
|
9119
7620
|
* @public
|
|
9120
7621
|
*/
|
|
9121
7622
|
StepType: RecommendationStepType | undefined;
|
|
@@ -9167,14 +7668,12 @@ export interface LabelingJobForWorkteamSummary {
|
|
|
9167
7668
|
*/
|
|
9168
7669
|
LabelingJobName?: string | undefined;
|
|
9169
7670
|
/**
|
|
9170
|
-
* <p>A unique identifier for a labeling job. You can use this to refer to a specific
|
|
9171
|
-
* labeling job.</p>
|
|
7671
|
+
* <p>A unique identifier for a labeling job. You can use this to refer to a specific labeling job.</p>
|
|
9172
7672
|
* @public
|
|
9173
7673
|
*/
|
|
9174
7674
|
JobReferenceCode: string | undefined;
|
|
9175
7675
|
/**
|
|
9176
|
-
* <p>The Amazon Web Services account ID of the account used to start the labeling
|
|
9177
|
-
* job.</p>
|
|
7676
|
+
* <p>The Amazon Web Services account ID of the account used to start the labeling job.</p>
|
|
9178
7677
|
* @public
|
|
9179
7678
|
*/
|
|
9180
7679
|
WorkRequesterAccountId: string | undefined;
|
|
@@ -9205,8 +7704,7 @@ export interface LabelingJobSummary {
|
|
|
9205
7704
|
*/
|
|
9206
7705
|
LabelingJobName: string | undefined;
|
|
9207
7706
|
/**
|
|
9208
|
-
* <p>The Amazon Resource Name (ARN) assigned to the labeling job when it was
|
|
9209
|
-
* created.</p>
|
|
7707
|
+
* <p>The Amazon Resource Name (ARN) assigned to the labeling job when it was created.</p>
|
|
9210
7708
|
* @public
|
|
9211
7709
|
*/
|
|
9212
7710
|
LabelingJobArn: string | undefined;
|
|
@@ -9236,22 +7734,17 @@ export interface LabelingJobSummary {
|
|
|
9236
7734
|
*/
|
|
9237
7735
|
WorkteamArn: string | undefined;
|
|
9238
7736
|
/**
|
|
9239
|
-
* <p>The Amazon Resource Name (ARN) of a Lambda function. The function is run before each
|
|
9240
|
-
* data object is sent to a worker.</p>
|
|
7737
|
+
* <p>The Amazon Resource Name (ARN) of a Lambda function. The function is run before each data object is sent to a worker.</p>
|
|
9241
7738
|
* @public
|
|
9242
7739
|
*/
|
|
9243
7740
|
PreHumanTaskLambdaArn?: string | undefined;
|
|
9244
7741
|
/**
|
|
9245
|
-
* <p>The Amazon Resource Name (ARN) of the Lambda function used to consolidate the
|
|
9246
|
-
* annotations from individual workers into a label for a data object. For more
|
|
9247
|
-
* information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/sms-annotation-consolidation.html">Annotation
|
|
9248
|
-
* Consolidation</a>.</p>
|
|
7742
|
+
* <p>The Amazon Resource Name (ARN) of the Lambda function used to consolidate the annotations from individual workers into a label for a data object. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/sms-annotation-consolidation.html">Annotation Consolidation</a>.</p>
|
|
9249
7743
|
* @public
|
|
9250
7744
|
*/
|
|
9251
7745
|
AnnotationConsolidationLambdaArn?: string | undefined;
|
|
9252
7746
|
/**
|
|
9253
|
-
* <p>If the <code>LabelingJobStatus</code> field is <code>Failed</code>, this field
|
|
9254
|
-
* contains a description of the error.</p>
|
|
7747
|
+
* <p>If the <code>LabelingJobStatus</code> field is <code>Failed</code>, this field contains a description of the error.</p>
|
|
9255
7748
|
* @public
|
|
9256
7749
|
*/
|
|
9257
7750
|
FailureReason?: string | undefined;
|
|
@@ -9283,8 +7776,7 @@ export interface LambdaStepMetadata {
|
|
|
9283
7776
|
OutputParameters?: OutputParameter[] | undefined;
|
|
9284
7777
|
}
|
|
9285
7778
|
/**
|
|
9286
|
-
* <p>Lists a summary of the properties of a lineage group. A lineage group provides a group of shareable lineage entity
|
|
9287
|
-
* resources.</p>
|
|
7779
|
+
* <p>Lists a summary of the properties of a lineage group. A lineage group provides a group of shareable lineage entity resources.</p>
|
|
9288
7780
|
* @public
|
|
9289
7781
|
*/
|
|
9290
7782
|
export interface LineageGroupSummary {
|
|
@@ -9387,8 +7879,7 @@ export interface ListActionsRequest {
|
|
|
9387
7879
|
*/
|
|
9388
7880
|
SortOrder?: SortOrder | undefined;
|
|
9389
7881
|
/**
|
|
9390
|
-
* <p>If the previous call to <code>ListActions</code> didn't return the full set of actions,
|
|
9391
|
-
* the call returns a token for getting the next set of actions.</p>
|
|
7882
|
+
* <p>If the previous call to <code>ListActions</code> didn't return the full set of actions, the call returns a token for getting the next set of actions.</p>
|
|
9392
7883
|
* @public
|
|
9393
7884
|
*/
|
|
9394
7885
|
NextToken?: string | undefined;
|
|
@@ -9418,14 +7909,12 @@ export interface ListActionsResponse {
|
|
|
9418
7909
|
*/
|
|
9419
7910
|
export interface ListAlgorithmsInput {
|
|
9420
7911
|
/**
|
|
9421
|
-
* <p>A filter that returns only algorithms created after the specified time
|
|
9422
|
-
* (timestamp).</p>
|
|
7912
|
+
* <p>A filter that returns only algorithms created after the specified time (timestamp).</p>
|
|
9423
7913
|
* @public
|
|
9424
7914
|
*/
|
|
9425
7915
|
CreationTimeAfter?: Date | undefined;
|
|
9426
7916
|
/**
|
|
9427
|
-
* <p>A filter that returns only algorithms created before the specified time
|
|
9428
|
-
* (timestamp).</p>
|
|
7917
|
+
* <p>A filter that returns only algorithms created before the specified time (timestamp).</p>
|
|
9429
7918
|
* @public
|
|
9430
7919
|
*/
|
|
9431
7920
|
CreationTimeBefore?: Date | undefined;
|
|
@@ -9435,21 +7924,17 @@ export interface ListAlgorithmsInput {
|
|
|
9435
7924
|
*/
|
|
9436
7925
|
MaxResults?: number | undefined;
|
|
9437
7926
|
/**
|
|
9438
|
-
* <p>A string in the algorithm name. This filter returns only algorithms whose name
|
|
9439
|
-
* contains the specified string.</p>
|
|
7927
|
+
* <p>A string in the algorithm name. This filter returns only algorithms whose name contains the specified string.</p>
|
|
9440
7928
|
* @public
|
|
9441
7929
|
*/
|
|
9442
7930
|
NameContains?: string | undefined;
|
|
9443
7931
|
/**
|
|
9444
|
-
* <p>If the response to a previous <code>ListAlgorithms</code> request was truncated, the
|
|
9445
|
-
* response includes a <code>NextToken</code>. To retrieve the next set of algorithms, use
|
|
9446
|
-
* the token in the next request.</p>
|
|
7932
|
+
* <p>If the response to a previous <code>ListAlgorithms</code> request was truncated, the response includes a <code>NextToken</code>. To retrieve the next set of algorithms, use the token in the next request.</p>
|
|
9447
7933
|
* @public
|
|
9448
7934
|
*/
|
|
9449
7935
|
NextToken?: string | undefined;
|
|
9450
7936
|
/**
|
|
9451
|
-
* <p>The parameter by which to sort the results. The default is
|
|
9452
|
-
* <code>CreationTime</code>.</p>
|
|
7937
|
+
* <p>The parameter by which to sort the results. The default is <code>CreationTime</code>.</p>
|
|
9453
7938
|
* @public
|
|
9454
7939
|
*/
|
|
9455
7940
|
SortBy?: AlgorithmSortBy | undefined;
|
|
@@ -9464,14 +7949,12 @@ export interface ListAlgorithmsInput {
|
|
|
9464
7949
|
*/
|
|
9465
7950
|
export interface ListAlgorithmsOutput {
|
|
9466
7951
|
/**
|
|
9467
|
-
* <p
|
|
9468
|
-
* algorithm.</p>
|
|
7952
|
+
* <p>>An array of <code>AlgorithmSummary</code> objects, each of which lists an algorithm.</p>
|
|
9469
7953
|
* @public
|
|
9470
7954
|
*/
|
|
9471
7955
|
AlgorithmSummaryList: AlgorithmSummary[] | undefined;
|
|
9472
7956
|
/**
|
|
9473
|
-
* <p>If the response is truncated, SageMaker returns this token. To retrieve the next set of
|
|
9474
|
-
* algorithms, use it in the subsequent request.</p>
|
|
7957
|
+
* <p>If the response is truncated, SageMaker returns this token. To retrieve the next set of algorithms, use it in the subsequent request.</p>
|
|
9475
7958
|
* @public
|
|
9476
7959
|
*/
|
|
9477
7960
|
NextToken?: string | undefined;
|
|
@@ -9501,8 +7984,7 @@ export interface ListAliasesRequest {
|
|
|
9501
7984
|
*/
|
|
9502
7985
|
MaxResults?: number | undefined;
|
|
9503
7986
|
/**
|
|
9504
|
-
* <p>If the previous call to <code>ListAliases</code> didn't return the full set of
|
|
9505
|
-
* aliases, the call returns a token for retrieving the next set of aliases.</p>
|
|
7987
|
+
* <p>If the previous call to <code>ListAliases</code> didn't return the full set of aliases, the call returns a token for retrieving the next set of aliases.</p>
|
|
9506
7988
|
* @public
|
|
9507
7989
|
*/
|
|
9508
7990
|
NextToken?: string | undefined;
|
|
@@ -9527,16 +8009,12 @@ export interface ListAliasesResponse {
|
|
|
9527
8009
|
*/
|
|
9528
8010
|
export interface ListAppImageConfigsRequest {
|
|
9529
8011
|
/**
|
|
9530
|
-
* <p>The total number of items to return in the response. If the total
|
|
9531
|
-
* number of items available is more than the value specified, a <code>NextToken</code>
|
|
9532
|
-
* is provided in the response. To resume pagination, provide the <code>NextToken</code>
|
|
9533
|
-
* value in the as part of a subsequent call. The default value is 10.</p>
|
|
8012
|
+
* <p>The total number of items to return in the response. If the total number of items available is more than the value specified, a <code>NextToken</code> is provided in the response. To resume pagination, provide the <code>NextToken</code> value in the as part of a subsequent call. The default value is 10.</p>
|
|
9534
8013
|
* @public
|
|
9535
8014
|
*/
|
|
9536
8015
|
MaxResults?: number | undefined;
|
|
9537
8016
|
/**
|
|
9538
|
-
* <p>If the previous call to <code>ListImages</code> didn't return the full set of
|
|
9539
|
-
* AppImageConfigs, the call returns a token for getting the next set of AppImageConfigs.</p>
|
|
8017
|
+
* <p>If the previous call to <code>ListImages</code> didn't return the full set of AppImageConfigs, the call returns a token for getting the next set of AppImageConfigs.</p>
|
|
9540
8018
|
* @public
|
|
9541
8019
|
*/
|
|
9542
8020
|
NextToken?: string | undefined;
|
|
@@ -9596,18 +8074,12 @@ export interface ListAppImageConfigsResponse {
|
|
|
9596
8074
|
*/
|
|
9597
8075
|
export interface ListAppsRequest {
|
|
9598
8076
|
/**
|
|
9599
|
-
* <p>If the previous response was truncated, you will receive this token. Use it in your next
|
|
9600
|
-
* request to receive the next set of results.</p>
|
|
8077
|
+
* <p>If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.</p>
|
|
9601
8078
|
* @public
|
|
9602
8079
|
*/
|
|
9603
8080
|
NextToken?: string | undefined;
|
|
9604
8081
|
/**
|
|
9605
|
-
* <p>This parameter defines the maximum number of results that can be return in a single
|
|
9606
|
-
* response. The <code>MaxResults</code> parameter is an upper bound, not a target. If there are
|
|
9607
|
-
* more results available than the value specified, a <code>NextToken</code> is provided in the
|
|
9608
|
-
* response. The <code>NextToken</code> indicates that the user should get the next set of
|
|
9609
|
-
* results by providing this token as a part of a subsequent call. The default value for
|
|
9610
|
-
* <code>MaxResults</code> is 10.</p>
|
|
8082
|
+
* <p>This parameter defines the maximum number of results that can be return in a single response. The <code>MaxResults</code> parameter is an upper bound, not a target. If there are more results available than the value specified, a <code>NextToken</code> is provided in the response. The <code>NextToken</code> indicates that the user should get the next set of results by providing this token as a part of a subsequent call. The default value for <code>MaxResults</code> is 10.</p>
|
|
9611
8083
|
* @public
|
|
9612
8084
|
*/
|
|
9613
8085
|
MaxResults?: number | undefined;
|
|
@@ -9627,14 +8099,12 @@ export interface ListAppsRequest {
|
|
|
9627
8099
|
*/
|
|
9628
8100
|
DomainIdEquals?: string | undefined;
|
|
9629
8101
|
/**
|
|
9630
|
-
* <p>A parameter to search by user profile name. If <code>SpaceNameEquals</code> is set, then
|
|
9631
|
-
* this value cannot be set.</p>
|
|
8102
|
+
* <p>A parameter to search by user profile name. If <code>SpaceNameEquals</code> is set, then this value cannot be set.</p>
|
|
9632
8103
|
* @public
|
|
9633
8104
|
*/
|
|
9634
8105
|
UserProfileNameEquals?: string | undefined;
|
|
9635
8106
|
/**
|
|
9636
|
-
* <p>A parameter to search by space name. If <code>UserProfileNameEquals</code> is set, then
|
|
9637
|
-
* this value cannot be set.</p>
|
|
8107
|
+
* <p>A parameter to search by space name. If <code>UserProfileNameEquals</code> is set, then this value cannot be set.</p>
|
|
9638
8108
|
* @public
|
|
9639
8109
|
*/
|
|
9640
8110
|
SpaceNameEquals?: string | undefined;
|
|
@@ -9649,8 +8119,7 @@ export interface ListAppsResponse {
|
|
|
9649
8119
|
*/
|
|
9650
8120
|
Apps?: AppDetails[] | undefined;
|
|
9651
8121
|
/**
|
|
9652
|
-
* <p>If the previous response was truncated, you will receive this token. Use it in your next
|
|
9653
|
-
* request to receive the next set of results.</p>
|
|
8122
|
+
* <p>If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.</p>
|
|
9654
8123
|
* @public
|
|
9655
8124
|
*/
|
|
9656
8125
|
NextToken?: string | undefined;
|
|
@@ -9701,8 +8170,7 @@ export interface ListArtifactsRequest {
|
|
|
9701
8170
|
*/
|
|
9702
8171
|
SortOrder?: SortOrder | undefined;
|
|
9703
8172
|
/**
|
|
9704
|
-
* <p>If the previous call to <code>ListArtifacts</code> didn't return the full set of artifacts,
|
|
9705
|
-
* the call returns a token for getting the next set of artifacts.</p>
|
|
8173
|
+
* <p>If the previous call to <code>ListArtifacts</code> didn't return the full set of artifacts, the call returns a token for getting the next set of artifacts.</p>
|
|
9706
8174
|
* @public
|
|
9707
8175
|
*/
|
|
9708
8176
|
NextToken?: string | undefined;
|
|
@@ -9792,8 +8260,7 @@ export interface ListAssociationsRequest {
|
|
|
9792
8260
|
*/
|
|
9793
8261
|
SortOrder?: SortOrder | undefined;
|
|
9794
8262
|
/**
|
|
9795
|
-
* <p>If the previous call to <code>ListAssociations</code> didn't return the full set of associations,
|
|
9796
|
-
* the call returns a token for getting the next set of associations.</p>
|
|
8263
|
+
* <p>If the previous call to <code>ListAssociations</code> didn't return the full set of associations, the call returns a token for getting the next set of associations.</p>
|
|
9797
8264
|
* @public
|
|
9798
8265
|
*/
|
|
9799
8266
|
NextToken?: string | undefined;
|
|
@@ -9868,8 +8335,7 @@ export interface ListAutoMLJobsRequest {
|
|
|
9868
8335
|
*/
|
|
9869
8336
|
MaxResults?: number | undefined;
|
|
9870
8337
|
/**
|
|
9871
|
-
* <p>If the previous response was truncated, you receive this token. Use it in your next
|
|
9872
|
-
* request to receive the next set of results.</p>
|
|
8338
|
+
* <p>If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.</p>
|
|
9873
8339
|
* @public
|
|
9874
8340
|
*/
|
|
9875
8341
|
NextToken?: string | undefined;
|
|
@@ -9884,8 +8350,7 @@ export interface ListAutoMLJobsResponse {
|
|
|
9884
8350
|
*/
|
|
9885
8351
|
AutoMLJobSummaries: AutoMLJobSummary[] | undefined;
|
|
9886
8352
|
/**
|
|
9887
|
-
* <p>If the previous response was truncated, you receive this token. Use it in your next
|
|
9888
|
-
* request to receive the next set of results.</p>
|
|
8353
|
+
* <p>If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.</p>
|
|
9889
8354
|
* @public
|
|
9890
8355
|
*/
|
|
9891
8356
|
NextToken?: string | undefined;
|
|
@@ -9915,8 +8380,7 @@ export interface ListCandidatesForAutoMLJobRequest {
|
|
|
9915
8380
|
*/
|
|
9916
8381
|
SortOrder?: AutoMLSortOrder | undefined;
|
|
9917
8382
|
/**
|
|
9918
|
-
* <p>The parameter by which to sort the results. The default is
|
|
9919
|
-
* <code>Descending</code>.</p>
|
|
8383
|
+
* <p>The parameter by which to sort the results. The default is <code>Descending</code>.</p>
|
|
9920
8384
|
* @public
|
|
9921
8385
|
*/
|
|
9922
8386
|
SortBy?: CandidateSortBy | undefined;
|
|
@@ -9926,8 +8390,7 @@ export interface ListCandidatesForAutoMLJobRequest {
|
|
|
9926
8390
|
*/
|
|
9927
8391
|
MaxResults?: number | undefined;
|
|
9928
8392
|
/**
|
|
9929
|
-
* <p>If the previous response was truncated, you receive this token. Use it in your next
|
|
9930
|
-
* request to receive the next set of results.</p>
|
|
8393
|
+
* <p>If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.</p>
|
|
9931
8394
|
* @public
|
|
9932
8395
|
*/
|
|
9933
8396
|
NextToken?: string | undefined;
|
|
@@ -9942,8 +8405,7 @@ export interface ListCandidatesForAutoMLJobResponse {
|
|
|
9942
8405
|
*/
|
|
9943
8406
|
Candidates: AutoMLCandidate[] | undefined;
|
|
9944
8407
|
/**
|
|
9945
|
-
* <p>If the previous response was truncated, you receive this token. Use it in your next
|
|
9946
|
-
* request to receive the next set of results.</p>
|
|
8408
|
+
* <p>If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.</p>
|
|
9947
8409
|
* @public
|
|
9948
8410
|
*/
|
|
9949
8411
|
NextToken?: string | undefined;
|
|
@@ -9953,49 +8415,17 @@ export interface ListCandidatesForAutoMLJobResponse {
|
|
|
9953
8415
|
*/
|
|
9954
8416
|
export interface ListClusterNodesRequest {
|
|
9955
8417
|
/**
|
|
9956
|
-
* <p>The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster in which you want to retrieve the
|
|
9957
|
-
* list of nodes.</p>
|
|
8418
|
+
* <p>The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster in which you want to retrieve the list of nodes.</p>
|
|
9958
8419
|
* @public
|
|
9959
8420
|
*/
|
|
9960
8421
|
ClusterName: string | undefined;
|
|
9961
8422
|
/**
|
|
9962
|
-
* <p>A filter that returns nodes in a SageMaker HyperPod cluster created after the specified time.
|
|
9963
|
-
* Timestamps are formatted according to the ISO 8601 standard. </p>
|
|
9964
|
-
* <p>Acceptable formats include:</p>
|
|
9965
|
-
* <ul>
|
|
9966
|
-
* <li>
|
|
9967
|
-
* <p>
|
|
9968
|
-
* <code>YYYY-MM-DDThh:mm:ss.sssTZD</code> (UTC), for example,
|
|
9969
|
-
* <code>2014-10-01T20:30:00.000Z</code>
|
|
9970
|
-
* </p>
|
|
9971
|
-
* </li>
|
|
9972
|
-
* <li>
|
|
9973
|
-
* <p>
|
|
9974
|
-
* <code>YYYY-MM-DDThh:mm:ss.sssTZD</code> (with offset), for example,
|
|
9975
|
-
* <code>2014-10-01T12:30:00.000-08:00</code>
|
|
9976
|
-
* </p>
|
|
9977
|
-
* </li>
|
|
9978
|
-
* <li>
|
|
9979
|
-
* <p>
|
|
9980
|
-
* <code>YYYY-MM-DD</code>, for example, <code>2014-10-01</code>
|
|
9981
|
-
* </p>
|
|
9982
|
-
* </li>
|
|
9983
|
-
* <li>
|
|
9984
|
-
* <p>Unix time in seconds, for example, <code>1412195400</code>. This is also referred
|
|
9985
|
-
* to as Unix Epoch time and represents the number of seconds since midnight, January 1,
|
|
9986
|
-
* 1970 UTC.</p>
|
|
9987
|
-
* </li>
|
|
9988
|
-
* </ul>
|
|
9989
|
-
* <p>For more information about the timestamp format, see <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-types.html#parameter-type-timestamp">Timestamp</a> in the <i>Amazon Web Services Command Line Interface User
|
|
9990
|
-
* Guide</i>.</p>
|
|
8423
|
+
* <p>A filter that returns nodes in a SageMaker HyperPod cluster created after the specified time. Timestamps are formatted according to the ISO 8601 standard. </p> <p>Acceptable formats include:</p> <ul> <li> <p> <code>YYYY-MM-DDThh:mm:ss.sssTZD</code> (UTC), for example, <code>2014-10-01T20:30:00.000Z</code> </p> </li> <li> <p> <code>YYYY-MM-DDThh:mm:ss.sssTZD</code> (with offset), for example, <code>2014-10-01T12:30:00.000-08:00</code> </p> </li> <li> <p> <code>YYYY-MM-DD</code>, for example, <code>2014-10-01</code> </p> </li> <li> <p>Unix time in seconds, for example, <code>1412195400</code>. This is also referred to as Unix Epoch time and represents the number of seconds since midnight, January 1, 1970 UTC.</p> </li> </ul> <p>For more information about the timestamp format, see <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-types.html#parameter-type-timestamp">Timestamp</a> in the <i>Amazon Web Services Command Line Interface User Guide</i>.</p>
|
|
9991
8424
|
* @public
|
|
9992
8425
|
*/
|
|
9993
8426
|
CreationTimeAfter?: Date | undefined;
|
|
9994
8427
|
/**
|
|
9995
|
-
* <p>A filter that returns nodes in a SageMaker HyperPod cluster created before the specified time. The
|
|
9996
|
-
* acceptable formats are the same as the timestamp formats for
|
|
9997
|
-
* <code>CreationTimeAfter</code>. For more information about the timestamp format, see <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-types.html#parameter-type-timestamp">Timestamp</a> in the <i>Amazon Web Services Command Line Interface User
|
|
9998
|
-
* Guide</i>.</p>
|
|
8428
|
+
* <p>A filter that returns nodes in a SageMaker HyperPod cluster created before the specified time. The acceptable formats are the same as the timestamp formats for <code>CreationTimeAfter</code>. For more information about the timestamp format, see <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-types.html#parameter-type-timestamp">Timestamp</a> in the <i>Amazon Web Services Command Line Interface User Guide</i>.</p>
|
|
9999
8429
|
* @public
|
|
10000
8430
|
*/
|
|
10001
8431
|
CreationTimeBefore?: Date | undefined;
|
|
@@ -10010,15 +8440,12 @@ export interface ListClusterNodesRequest {
|
|
|
10010
8440
|
*/
|
|
10011
8441
|
MaxResults?: number | undefined;
|
|
10012
8442
|
/**
|
|
10013
|
-
* <p>If the result of the previous <code>ListClusterNodes</code> request was truncated, the
|
|
10014
|
-
* response includes a <code>NextToken</code>. To retrieve the next set of cluster nodes, use
|
|
10015
|
-
* the token in the next request.</p>
|
|
8443
|
+
* <p>If the result of the previous <code>ListClusterNodes</code> request was truncated, the response includes a <code>NextToken</code>. To retrieve the next set of cluster nodes, use the token in the next request.</p>
|
|
10016
8444
|
* @public
|
|
10017
8445
|
*/
|
|
10018
8446
|
NextToken?: string | undefined;
|
|
10019
8447
|
/**
|
|
10020
|
-
* <p>The field by which to sort results. The default value is
|
|
10021
|
-
* <code>CREATION_TIME</code>.</p>
|
|
8448
|
+
* <p>The field by which to sort results. The default value is <code>CREATION_TIME</code>.</p>
|
|
10022
8449
|
* @public
|
|
10023
8450
|
*/
|
|
10024
8451
|
SortBy?: ClusterSortBy | undefined;
|
|
@@ -10048,44 +8475,12 @@ export interface ListClusterNodesResponse {
|
|
|
10048
8475
|
*/
|
|
10049
8476
|
export interface ListClustersRequest {
|
|
10050
8477
|
/**
|
|
10051
|
-
* <p>Set a start time for the time range during which you want to list SageMaker HyperPod clusters.
|
|
10052
|
-
* Timestamps are formatted according to the ISO 8601 standard. </p>
|
|
10053
|
-
* <p>Acceptable formats include:</p>
|
|
10054
|
-
* <ul>
|
|
10055
|
-
* <li>
|
|
10056
|
-
* <p>
|
|
10057
|
-
* <code>YYYY-MM-DDThh:mm:ss.sssTZD</code> (UTC), for example,
|
|
10058
|
-
* <code>2014-10-01T20:30:00.000Z</code>
|
|
10059
|
-
* </p>
|
|
10060
|
-
* </li>
|
|
10061
|
-
* <li>
|
|
10062
|
-
* <p>
|
|
10063
|
-
* <code>YYYY-MM-DDThh:mm:ss.sssTZD</code> (with offset), for example,
|
|
10064
|
-
* <code>2014-10-01T12:30:00.000-08:00</code>
|
|
10065
|
-
* </p>
|
|
10066
|
-
* </li>
|
|
10067
|
-
* <li>
|
|
10068
|
-
* <p>
|
|
10069
|
-
* <code>YYYY-MM-DD</code>, for example, <code>2014-10-01</code>
|
|
10070
|
-
* </p>
|
|
10071
|
-
* </li>
|
|
10072
|
-
* <li>
|
|
10073
|
-
* <p>Unix time in seconds, for example, <code>1412195400</code>. This is also referred
|
|
10074
|
-
* to as Unix Epoch time and represents the number of seconds since midnight, January 1,
|
|
10075
|
-
* 1970 UTC.</p>
|
|
10076
|
-
* </li>
|
|
10077
|
-
* </ul>
|
|
10078
|
-
* <p>For more information about the timestamp format, see <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-types.html#parameter-type-timestamp">Timestamp</a> in the <i>Amazon Web Services Command Line Interface User
|
|
10079
|
-
* Guide</i>.</p>
|
|
8478
|
+
* <p>Set a start time for the time range during which you want to list SageMaker HyperPod clusters. Timestamps are formatted according to the ISO 8601 standard. </p> <p>Acceptable formats include:</p> <ul> <li> <p> <code>YYYY-MM-DDThh:mm:ss.sssTZD</code> (UTC), for example, <code>2014-10-01T20:30:00.000Z</code> </p> </li> <li> <p> <code>YYYY-MM-DDThh:mm:ss.sssTZD</code> (with offset), for example, <code>2014-10-01T12:30:00.000-08:00</code> </p> </li> <li> <p> <code>YYYY-MM-DD</code>, for example, <code>2014-10-01</code> </p> </li> <li> <p>Unix time in seconds, for example, <code>1412195400</code>. This is also referred to as Unix Epoch time and represents the number of seconds since midnight, January 1, 1970 UTC.</p> </li> </ul> <p>For more information about the timestamp format, see <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-types.html#parameter-type-timestamp">Timestamp</a> in the <i>Amazon Web Services Command Line Interface User Guide</i>.</p>
|
|
10080
8479
|
* @public
|
|
10081
8480
|
*/
|
|
10082
8481
|
CreationTimeAfter?: Date | undefined;
|
|
10083
8482
|
/**
|
|
10084
|
-
* <p>Set an end time for the time range during which you want to list SageMaker HyperPod clusters. A
|
|
10085
|
-
* filter that returns nodes in a SageMaker HyperPod cluster created before the specified time. The
|
|
10086
|
-
* acceptable formats are the same as the timestamp formats for
|
|
10087
|
-
* <code>CreationTimeAfter</code>. For more information about the timestamp format, see <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-types.html#parameter-type-timestamp">Timestamp</a> in the <i>Amazon Web Services Command Line Interface User
|
|
10088
|
-
* Guide</i>.</p>
|
|
8483
|
+
* <p>Set an end time for the time range during which you want to list SageMaker HyperPod clusters. A filter that returns nodes in a SageMaker HyperPod cluster created before the specified time. The acceptable formats are the same as the timestamp formats for <code>CreationTimeAfter</code>. For more information about the timestamp format, see <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-types.html#parameter-type-timestamp">Timestamp</a> in the <i>Amazon Web Services Command Line Interface User Guide</i>.</p>
|
|
10089
8484
|
* @public
|
|
10090
8485
|
*/
|
|
10091
8486
|
CreationTimeBefore?: Date | undefined;
|
|
@@ -10105,8 +8500,7 @@ export interface ListClustersRequest {
|
|
|
10105
8500
|
*/
|
|
10106
8501
|
NextToken?: string | undefined;
|
|
10107
8502
|
/**
|
|
10108
|
-
* <p>The field by which to sort results. The default value is
|
|
10109
|
-
* <code>CREATION_TIME</code>.</p>
|
|
8503
|
+
* <p>The field by which to sort results. The default value is <code>CREATION_TIME</code>.</p>
|
|
10110
8504
|
* @public
|
|
10111
8505
|
*/
|
|
10112
8506
|
SortBy?: ClusterSortBy | undefined;
|
|
@@ -10116,10 +8510,7 @@ export interface ListClustersRequest {
|
|
|
10116
8510
|
*/
|
|
10117
8511
|
SortOrder?: SortOrder | undefined;
|
|
10118
8512
|
/**
|
|
10119
|
-
* <p>The Amazon Resource Name (ARN); of the training plan to filter clusters by. For more information about
|
|
10120
|
-
* reserving GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see <code>
|
|
10121
|
-
* <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingPlan.html">CreateTrainingPlan</a>
|
|
10122
|
-
* </code>.</p>
|
|
8513
|
+
* <p>The Amazon Resource Name (ARN); of the training plan to filter clusters by. For more information about reserving GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see <code> <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingPlan.html">CreateTrainingPlan</a> </code>.</p>
|
|
10123
8514
|
* @public
|
|
10124
8515
|
*/
|
|
10125
8516
|
TrainingPlanArn?: string | undefined;
|
|
@@ -10129,9 +8520,7 @@ export interface ListClustersRequest {
|
|
|
10129
8520
|
*/
|
|
10130
8521
|
export interface ListClustersResponse {
|
|
10131
8522
|
/**
|
|
10132
|
-
* <p>If the result of the previous <code>ListClusters</code> request was truncated, the
|
|
10133
|
-
* response includes a <code>NextToken</code>. To retrieve the next set of clusters, use the
|
|
10134
|
-
* token in the next request.</p>
|
|
8523
|
+
* <p>If the result of the previous <code>ListClusters</code> request was truncated, the response includes a <code>NextToken</code>. To retrieve the next set of clusters, use the token in the next request.</p>
|
|
10135
8524
|
* @public
|
|
10136
8525
|
*/
|
|
10137
8526
|
NextToken?: string | undefined;
|
|
@@ -10159,14 +8548,12 @@ export type SortClusterSchedulerConfigBy = (typeof SortClusterSchedulerConfigBy)
|
|
|
10159
8548
|
*/
|
|
10160
8549
|
export interface ListClusterSchedulerConfigsRequest {
|
|
10161
8550
|
/**
|
|
10162
|
-
* <p>Filter for after this creation time. The input for this parameter is a Unix timestamp.
|
|
10163
|
-
* To convert a date and time into a Unix timestamp, see <a href="https://www.epochconverter.com/">EpochConverter</a>.</p>
|
|
8551
|
+
* <p>Filter for after this creation time. The input for this parameter is a Unix timestamp. To convert a date and time into a Unix timestamp, see <a href="https://www.epochconverter.com/">EpochConverter</a>.</p>
|
|
10164
8552
|
* @public
|
|
10165
8553
|
*/
|
|
10166
8554
|
CreatedAfter?: Date | undefined;
|
|
10167
8555
|
/**
|
|
10168
|
-
* <p>Filter for before this creation time. The input for this parameter is a Unix timestamp.
|
|
10169
|
-
* To convert a date and time into a Unix timestamp, see <a href="https://www.epochconverter.com/">EpochConverter</a>.</p>
|
|
8556
|
+
* <p>Filter for before this creation time. The input for this parameter is a Unix timestamp. To convert a date and time into a Unix timestamp, see <a href="https://www.epochconverter.com/">EpochConverter</a>.</p>
|
|
10170
8557
|
* @public
|
|
10171
8558
|
*/
|
|
10172
8559
|
CreatedBefore?: Date | undefined;
|
|
@@ -10186,21 +8573,17 @@ export interface ListClusterSchedulerConfigsRequest {
|
|
|
10186
8573
|
*/
|
|
10187
8574
|
Status?: SchedulerResourceStatus | undefined;
|
|
10188
8575
|
/**
|
|
10189
|
-
* <p>Filter for sorting the list by a given value. For example, sort by name, creation time,
|
|
10190
|
-
* or status.</p>
|
|
8576
|
+
* <p>Filter for sorting the list by a given value. For example, sort by name, creation time, or status.</p>
|
|
10191
8577
|
* @public
|
|
10192
8578
|
*/
|
|
10193
8579
|
SortBy?: SortClusterSchedulerConfigBy | undefined;
|
|
10194
8580
|
/**
|
|
10195
|
-
* <p>The order of the list. By default, listed in <code>Descending</code> order according to
|
|
10196
|
-
* by <code>SortBy</code>. To change the list order, you can specify <code>SortOrder</code> to
|
|
10197
|
-
* be <code>Ascending</code>.</p>
|
|
8581
|
+
* <p>The order of the list. By default, listed in <code>Descending</code> order according to by <code>SortBy</code>. To change the list order, you can specify <code>SortOrder</code> to be <code>Ascending</code>.</p>
|
|
10198
8582
|
* @public
|
|
10199
8583
|
*/
|
|
10200
8584
|
SortOrder?: SortOrder | undefined;
|
|
10201
8585
|
/**
|
|
10202
|
-
* <p>If the previous response was truncated, you will receive this token. Use it in your next
|
|
10203
|
-
* request to receive the next set of results.</p>
|
|
8586
|
+
* <p>If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.</p>
|
|
10204
8587
|
* @public
|
|
10205
8588
|
*/
|
|
10206
8589
|
NextToken?: string | undefined;
|
|
@@ -10220,8 +8603,7 @@ export interface ListClusterSchedulerConfigsResponse {
|
|
|
10220
8603
|
*/
|
|
10221
8604
|
ClusterSchedulerConfigSummaries?: ClusterSchedulerConfigSummary[] | undefined;
|
|
10222
8605
|
/**
|
|
10223
|
-
* <p>If the previous response was truncated, you will receive this token. Use it in your next
|
|
10224
|
-
* request to receive the next set of results.</p>
|
|
8606
|
+
* <p>If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.</p>
|
|
10225
8607
|
* @public
|
|
10226
8608
|
*/
|
|
10227
8609
|
NextToken?: string | undefined;
|
|
@@ -10231,26 +8613,22 @@ export interface ListClusterSchedulerConfigsResponse {
|
|
|
10231
8613
|
*/
|
|
10232
8614
|
export interface ListCodeRepositoriesInput {
|
|
10233
8615
|
/**
|
|
10234
|
-
* <p>A filter that returns only Git repositories that were created after the specified
|
|
10235
|
-
* time.</p>
|
|
8616
|
+
* <p>A filter that returns only Git repositories that were created after the specified time.</p>
|
|
10236
8617
|
* @public
|
|
10237
8618
|
*/
|
|
10238
8619
|
CreationTimeAfter?: Date | undefined;
|
|
10239
8620
|
/**
|
|
10240
|
-
* <p>A filter that returns only Git repositories that were created before the specified
|
|
10241
|
-
* time.</p>
|
|
8621
|
+
* <p>A filter that returns only Git repositories that were created before the specified time.</p>
|
|
10242
8622
|
* @public
|
|
10243
8623
|
*/
|
|
10244
8624
|
CreationTimeBefore?: Date | undefined;
|
|
10245
8625
|
/**
|
|
10246
|
-
* <p>A filter that returns only Git repositories that were last modified after the
|
|
10247
|
-
* specified time.</p>
|
|
8626
|
+
* <p>A filter that returns only Git repositories that were last modified after the specified time.</p>
|
|
10248
8627
|
* @public
|
|
10249
8628
|
*/
|
|
10250
8629
|
LastModifiedTimeAfter?: Date | undefined;
|
|
10251
8630
|
/**
|
|
10252
|
-
* <p>A filter that returns only Git repositories that were last modified before the
|
|
10253
|
-
* specified time.</p>
|
|
8631
|
+
* <p>A filter that returns only Git repositories that were last modified before the specified time.</p>
|
|
10254
8632
|
* @public
|
|
10255
8633
|
*/
|
|
10256
8634
|
LastModifiedTimeBefore?: Date | undefined;
|
|
@@ -10260,15 +8638,12 @@ export interface ListCodeRepositoriesInput {
|
|
|
10260
8638
|
*/
|
|
10261
8639
|
MaxResults?: number | undefined;
|
|
10262
8640
|
/**
|
|
10263
|
-
* <p>A string in the Git repositories name. This filter returns only repositories whose
|
|
10264
|
-
* name contains the specified string.</p>
|
|
8641
|
+
* <p>A string in the Git repositories name. This filter returns only repositories whose name contains the specified string.</p>
|
|
10265
8642
|
* @public
|
|
10266
8643
|
*/
|
|
10267
8644
|
NameContains?: string | undefined;
|
|
10268
8645
|
/**
|
|
10269
|
-
* <p>If the result of a <code>ListCodeRepositoriesOutput</code> request was truncated, the
|
|
10270
|
-
* response includes a <code>NextToken</code>. To get the next set of Git repositories, use
|
|
10271
|
-
* the token in the next request.</p>
|
|
8646
|
+
* <p>If the result of a <code>ListCodeRepositoriesOutput</code> request was truncated, the response includes a <code>NextToken</code>. To get the next set of Git repositories, use the token in the next request.</p>
|
|
10272
8647
|
* @public
|
|
10273
8648
|
*/
|
|
10274
8649
|
NextToken?: string | undefined;
|
|
@@ -10288,34 +8663,12 @@ export interface ListCodeRepositoriesInput {
|
|
|
10288
8663
|
*/
|
|
10289
8664
|
export interface ListCodeRepositoriesOutput {
|
|
10290
8665
|
/**
|
|
10291
|
-
* <p>Gets a list of summaries of the Git repositories. Each summary specifies the following
|
|
10292
|
-
* values for the repository: </p>
|
|
10293
|
-
* <ul>
|
|
10294
|
-
* <li>
|
|
10295
|
-
* <p>Name</p>
|
|
10296
|
-
* </li>
|
|
10297
|
-
* <li>
|
|
10298
|
-
* <p>Amazon Resource Name (ARN)</p>
|
|
10299
|
-
* </li>
|
|
10300
|
-
* <li>
|
|
10301
|
-
* <p>Creation time</p>
|
|
10302
|
-
* </li>
|
|
10303
|
-
* <li>
|
|
10304
|
-
* <p>Last modified time</p>
|
|
10305
|
-
* </li>
|
|
10306
|
-
* <li>
|
|
10307
|
-
* <p>Configuration information, including the URL location of the repository and
|
|
10308
|
-
* the ARN of the Amazon Web Services Secrets Manager secret that contains the
|
|
10309
|
-
* credentials used to access the repository.</p>
|
|
10310
|
-
* </li>
|
|
10311
|
-
* </ul>
|
|
8666
|
+
* <p>Gets a list of summaries of the Git repositories. Each summary specifies the following values for the repository: </p> <ul> <li> <p>Name</p> </li> <li> <p>Amazon Resource Name (ARN)</p> </li> <li> <p>Creation time</p> </li> <li> <p>Last modified time</p> </li> <li> <p>Configuration information, including the URL location of the repository and the ARN of the Amazon Web Services Secrets Manager secret that contains the credentials used to access the repository.</p> </li> </ul>
|
|
10312
8667
|
* @public
|
|
10313
8668
|
*/
|
|
10314
8669
|
CodeRepositorySummaryList: CodeRepositorySummary[] | undefined;
|
|
10315
8670
|
/**
|
|
10316
|
-
* <p>If the result of a <code>ListCodeRepositoriesOutput</code> request was truncated, the
|
|
10317
|
-
* response includes a <code>NextToken</code>. To get the next set of Git repositories, use
|
|
10318
|
-
* the token in the next request.</p>
|
|
8671
|
+
* <p>If the result of a <code>ListCodeRepositoriesOutput</code> request was truncated, the response includes a <code>NextToken</code>. To get the next set of Git repositories, use the token in the next request.</p>
|
|
10319
8672
|
* @public
|
|
10320
8673
|
*/
|
|
10321
8674
|
NextToken?: string | undefined;
|
|
@@ -10338,9 +8691,7 @@ export type ListCompilationJobsSortBy = (typeof ListCompilationJobsSortBy)[keyof
|
|
|
10338
8691
|
*/
|
|
10339
8692
|
export interface ListCompilationJobsRequest {
|
|
10340
8693
|
/**
|
|
10341
|
-
* <p>If the result of the previous <code>ListCompilationJobs</code> request was truncated,
|
|
10342
|
-
* the response includes a <code>NextToken</code>. To retrieve the next set of model
|
|
10343
|
-
* compilation jobs, use the token in the next request.</p>
|
|
8694
|
+
* <p>If the result of the previous <code>ListCompilationJobs</code> request was truncated, the response includes a <code>NextToken</code>. To retrieve the next set of model compilation jobs, use the token in the next request.</p>
|
|
10344
8695
|
* @public
|
|
10345
8696
|
*/
|
|
10346
8697
|
NextToken?: string | undefined;
|
|
@@ -10350,38 +8701,32 @@ export interface ListCompilationJobsRequest {
|
|
|
10350
8701
|
*/
|
|
10351
8702
|
MaxResults?: number | undefined;
|
|
10352
8703
|
/**
|
|
10353
|
-
* <p>A filter that returns the model compilation jobs that were created after a specified
|
|
10354
|
-
* time. </p>
|
|
8704
|
+
* <p>A filter that returns the model compilation jobs that were created after a specified time. </p>
|
|
10355
8705
|
* @public
|
|
10356
8706
|
*/
|
|
10357
8707
|
CreationTimeAfter?: Date | undefined;
|
|
10358
8708
|
/**
|
|
10359
|
-
* <p>A filter that returns the model compilation jobs that were created before a specified
|
|
10360
|
-
* time.</p>
|
|
8709
|
+
* <p>A filter that returns the model compilation jobs that were created before a specified time.</p>
|
|
10361
8710
|
* @public
|
|
10362
8711
|
*/
|
|
10363
8712
|
CreationTimeBefore?: Date | undefined;
|
|
10364
8713
|
/**
|
|
10365
|
-
* <p>A filter that returns the model compilation jobs that were modified after a specified
|
|
10366
|
-
* time.</p>
|
|
8714
|
+
* <p>A filter that returns the model compilation jobs that were modified after a specified time.</p>
|
|
10367
8715
|
* @public
|
|
10368
8716
|
*/
|
|
10369
8717
|
LastModifiedTimeAfter?: Date | undefined;
|
|
10370
8718
|
/**
|
|
10371
|
-
* <p>A filter that returns the model compilation jobs that were modified before a specified
|
|
10372
|
-
* time.</p>
|
|
8719
|
+
* <p>A filter that returns the model compilation jobs that were modified before a specified time.</p>
|
|
10373
8720
|
* @public
|
|
10374
8721
|
*/
|
|
10375
8722
|
LastModifiedTimeBefore?: Date | undefined;
|
|
10376
8723
|
/**
|
|
10377
|
-
* <p>A filter that returns the model compilation jobs whose name contains a specified
|
|
10378
|
-
* string.</p>
|
|
8724
|
+
* <p>A filter that returns the model compilation jobs whose name contains a specified string.</p>
|
|
10379
8725
|
* @public
|
|
10380
8726
|
*/
|
|
10381
8727
|
NameContains?: string | undefined;
|
|
10382
8728
|
/**
|
|
10383
|
-
* <p>A filter that retrieves model compilation jobs with a specific
|
|
10384
|
-
* <code>CompilationJobStatus</code> status.</p>
|
|
8729
|
+
* <p>A filter that retrieves model compilation jobs with a specific <code>CompilationJobStatus</code> status.</p>
|
|
10385
8730
|
* @public
|
|
10386
8731
|
*/
|
|
10387
8732
|
StatusEquals?: CompilationJobStatus | undefined;
|
|
@@ -10401,14 +8746,12 @@ export interface ListCompilationJobsRequest {
|
|
|
10401
8746
|
*/
|
|
10402
8747
|
export interface ListCompilationJobsResponse {
|
|
10403
8748
|
/**
|
|
10404
|
-
* <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.
|
|
10405
|
-
* </p>
|
|
8749
|
+
* <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>
|
|
10406
8750
|
* @public
|
|
10407
8751
|
*/
|
|
10408
8752
|
CompilationJobSummaries: CompilationJobSummary[] | undefined;
|
|
10409
8753
|
/**
|
|
10410
|
-
* <p>If the response is truncated, Amazon SageMaker AI returns this <code>NextToken</code>. To retrieve
|
|
10411
|
-
* the next set of model compilation jobs, use this token in the next request.</p>
|
|
8754
|
+
* <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>
|
|
10412
8755
|
* @public
|
|
10413
8756
|
*/
|
|
10414
8757
|
NextToken?: string | undefined;
|