@aws-sdk/client-sagemaker 3.131.0 → 3.132.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.
Files changed (116) hide show
  1. package/CHANGELOG.md +11 -0
  2. package/dist-cjs/SageMaker.js +135 -0
  3. package/dist-cjs/commands/CreateEdgeDeploymentPlanCommand.js +36 -0
  4. package/dist-cjs/commands/CreateEdgeDeploymentStageCommand.js +36 -0
  5. package/dist-cjs/commands/CreateHyperParameterTuningJobCommand.js +3 -3
  6. package/dist-cjs/commands/DeleteEdgeDeploymentPlanCommand.js +36 -0
  7. package/dist-cjs/commands/DeleteEdgeDeploymentStageCommand.js +36 -0
  8. package/dist-cjs/commands/DescribeEdgeDeploymentPlanCommand.js +36 -0
  9. package/dist-cjs/commands/DescribeHyperParameterTuningJobCommand.js +3 -3
  10. package/dist-cjs/commands/DescribeImageCommand.js +3 -3
  11. package/dist-cjs/commands/DescribeImageVersionCommand.js +3 -3
  12. package/dist-cjs/commands/DescribeInferenceRecommendationsJobCommand.js +1 -2
  13. package/dist-cjs/commands/ListEdgeDeploymentPlansCommand.js +36 -0
  14. package/dist-cjs/commands/ListPipelineExecutionStepsCommand.js +3 -3
  15. package/dist-cjs/commands/ListPipelineParametersForExecutionCommand.js +3 -3
  16. package/dist-cjs/commands/ListPipelinesCommand.js +3 -3
  17. package/dist-cjs/commands/ListProcessingJobsCommand.js +3 -3
  18. package/dist-cjs/commands/ListStageDevicesCommand.js +36 -0
  19. package/dist-cjs/commands/StartEdgeDeploymentStageCommand.js +36 -0
  20. package/dist-cjs/commands/StopEdgeDeploymentStageCommand.js +36 -0
  21. package/dist-cjs/commands/index.js +9 -0
  22. package/dist-cjs/models/models_0.js +54 -54
  23. package/dist-cjs/models/models_1.js +106 -112
  24. package/dist-cjs/models/models_2.js +152 -140
  25. package/dist-cjs/models/models_3.js +162 -3
  26. package/dist-cjs/pagination/ListEdgeDeploymentPlansPaginator.js +36 -0
  27. package/dist-cjs/pagination/ListStageDevicesPaginator.js +36 -0
  28. package/dist-cjs/pagination/index.js +2 -0
  29. package/dist-cjs/protocols/Aws_json1_1.js +710 -11
  30. package/dist-es/SageMaker.js +135 -0
  31. package/dist-es/commands/CreateEdgeDeploymentPlanCommand.js +39 -0
  32. package/dist-es/commands/CreateEdgeDeploymentStageCommand.js +39 -0
  33. package/dist-es/commands/CreateHyperParameterTuningJobCommand.js +1 -1
  34. package/dist-es/commands/DeleteEdgeDeploymentPlanCommand.js +39 -0
  35. package/dist-es/commands/DeleteEdgeDeploymentStageCommand.js +39 -0
  36. package/dist-es/commands/DescribeEdgeDeploymentPlanCommand.js +39 -0
  37. package/dist-es/commands/DescribeHyperParameterTuningJobCommand.js +1 -1
  38. package/dist-es/commands/DescribeImageCommand.js +1 -1
  39. package/dist-es/commands/DescribeImageVersionCommand.js +1 -1
  40. package/dist-es/commands/DescribeInferenceRecommendationsJobCommand.js +1 -2
  41. package/dist-es/commands/ListEdgeDeploymentPlansCommand.js +39 -0
  42. package/dist-es/commands/ListPipelineExecutionStepsCommand.js +1 -1
  43. package/dist-es/commands/ListPipelineParametersForExecutionCommand.js +1 -1
  44. package/dist-es/commands/ListPipelinesCommand.js +1 -1
  45. package/dist-es/commands/ListProcessingJobsCommand.js +1 -1
  46. package/dist-es/commands/ListStageDevicesCommand.js +39 -0
  47. package/dist-es/commands/StartEdgeDeploymentStageCommand.js +39 -0
  48. package/dist-es/commands/StopEdgeDeploymentStageCommand.js +39 -0
  49. package/dist-es/commands/index.js +9 -0
  50. package/dist-es/models/models_0.js +39 -37
  51. package/dist-es/models/models_1.js +72 -82
  52. package/dist-es/models/models_2.js +114 -94
  53. package/dist-es/models/models_3.js +110 -0
  54. package/dist-es/pagination/ListEdgeDeploymentPlansPaginator.js +75 -0
  55. package/dist-es/pagination/ListStageDevicesPaginator.js +75 -0
  56. package/dist-es/pagination/index.js +2 -0
  57. package/dist-es/protocols/Aws_json1_1.js +798 -12
  58. package/dist-types/SageMaker.d.ts +63 -0
  59. package/dist-types/SageMakerClient.d.ts +11 -2
  60. package/dist-types/commands/CreateEdgeDeploymentPlanCommand.d.ts +35 -0
  61. package/dist-types/commands/CreateEdgeDeploymentStageCommand.d.ts +35 -0
  62. package/dist-types/commands/CreateHyperParameterTuningJobCommand.d.ts +1 -1
  63. package/dist-types/commands/DeleteEdgeDeploymentPlanCommand.d.ts +35 -0
  64. package/dist-types/commands/DeleteEdgeDeploymentStageCommand.d.ts +35 -0
  65. package/dist-types/commands/DescribeEdgeDeploymentPlanCommand.d.ts +35 -0
  66. package/dist-types/commands/DescribeHyperParameterTuningJobCommand.d.ts +1 -1
  67. package/dist-types/commands/DescribeImageCommand.d.ts +1 -1
  68. package/dist-types/commands/DescribeImageVersionCommand.d.ts +1 -1
  69. package/dist-types/commands/DescribeInferenceRecommendationsJobCommand.d.ts +1 -2
  70. package/dist-types/commands/ListEdgeDeploymentPlansCommand.d.ts +35 -0
  71. package/dist-types/commands/ListPipelineExecutionStepsCommand.d.ts +1 -1
  72. package/dist-types/commands/ListPipelineParametersForExecutionCommand.d.ts +1 -1
  73. package/dist-types/commands/ListPipelinesCommand.d.ts +1 -1
  74. package/dist-types/commands/ListProcessingJobsCommand.d.ts +1 -1
  75. package/dist-types/commands/ListStageDevicesCommand.d.ts +35 -0
  76. package/dist-types/commands/StartEdgeDeploymentStageCommand.d.ts +35 -0
  77. package/dist-types/commands/StopEdgeDeploymentStageCommand.d.ts +35 -0
  78. package/dist-types/commands/index.d.ts +9 -0
  79. package/dist-types/models/models_0.d.ts +150 -451
  80. package/dist-types/models/models_1.d.ts +645 -504
  81. package/dist-types/models/models_2.d.ts +5430 -5423
  82. package/dist-types/models/models_3.d.ts +730 -3
  83. package/dist-types/pagination/ListEdgeDeploymentPlansPaginator.d.ts +4 -0
  84. package/dist-types/pagination/ListStageDevicesPaginator.d.ts +4 -0
  85. package/dist-types/pagination/index.d.ts +2 -0
  86. package/dist-types/protocols/Aws_json1_1.d.ts +27 -0
  87. package/dist-types/ts3.4/SageMaker.d.ts +45 -0
  88. package/dist-types/ts3.4/SageMakerClient.d.ts +11 -2
  89. package/dist-types/ts3.4/commands/CreateEdgeDeploymentPlanCommand.d.ts +17 -0
  90. package/dist-types/ts3.4/commands/CreateEdgeDeploymentStageCommand.d.ts +17 -0
  91. package/dist-types/ts3.4/commands/CreateHyperParameterTuningJobCommand.d.ts +1 -1
  92. package/dist-types/ts3.4/commands/DeleteEdgeDeploymentPlanCommand.d.ts +17 -0
  93. package/dist-types/ts3.4/commands/DeleteEdgeDeploymentStageCommand.d.ts +17 -0
  94. package/dist-types/ts3.4/commands/DescribeEdgeDeploymentPlanCommand.d.ts +17 -0
  95. package/dist-types/ts3.4/commands/DescribeHyperParameterTuningJobCommand.d.ts +1 -1
  96. package/dist-types/ts3.4/commands/DescribeImageCommand.d.ts +1 -1
  97. package/dist-types/ts3.4/commands/DescribeImageVersionCommand.d.ts +1 -1
  98. package/dist-types/ts3.4/commands/DescribeInferenceRecommendationsJobCommand.d.ts +1 -2
  99. package/dist-types/ts3.4/commands/ListEdgeDeploymentPlansCommand.d.ts +17 -0
  100. package/dist-types/ts3.4/commands/ListPipelineExecutionStepsCommand.d.ts +1 -1
  101. package/dist-types/ts3.4/commands/ListPipelineParametersForExecutionCommand.d.ts +1 -1
  102. package/dist-types/ts3.4/commands/ListPipelinesCommand.d.ts +1 -1
  103. package/dist-types/ts3.4/commands/ListProcessingJobsCommand.d.ts +1 -1
  104. package/dist-types/ts3.4/commands/ListStageDevicesCommand.d.ts +17 -0
  105. package/dist-types/ts3.4/commands/StartEdgeDeploymentStageCommand.d.ts +17 -0
  106. package/dist-types/ts3.4/commands/StopEdgeDeploymentStageCommand.d.ts +17 -0
  107. package/dist-types/ts3.4/commands/index.d.ts +9 -0
  108. package/dist-types/ts3.4/models/models_0.d.ts +91 -132
  109. package/dist-types/ts3.4/models/models_1.d.ts +235 -238
  110. package/dist-types/ts3.4/models/models_2.d.ts +341 -324
  111. package/dist-types/ts3.4/models/models_3.d.ts +371 -3
  112. package/dist-types/ts3.4/pagination/ListEdgeDeploymentPlansPaginator.d.ts +4 -0
  113. package/dist-types/ts3.4/pagination/ListStageDevicesPaginator.d.ts +4 -0
  114. package/dist-types/ts3.4/pagination/index.d.ts +2 -0
  115. package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +27 -0
  116. package/package.json +1 -1
@@ -1,4 +1,455 @@
1
- import { ActionSource, ActionStatus, AdditionalInferenceSpecificationDefinition, AlgorithmSpecification, AlgorithmStatus, AlgorithmStatusDetails, AlgorithmValidationSpecification, AnnotationConsolidationConfig, AppNetworkAccessType, AppSecurityGroupManagement, AppSpecification, AppStatus, AppType, ArtifactSource, AsyncInferenceConfig, AthenaDatasetDefinition, AuthMode, AutoMLCandidate, AutoMLChannel, AutoMLJobArtifacts, AutoMLJobCompletionCriteria, AutoMLJobConfig, AutoMLJobObjective, AutoMLJobSecondaryStatus, AutoMLJobStatus, AutoMLOutputDataConfig, AutoMLPartialFailureReason, BatchStrategy, Bias, CaptureStatus, CategoricalParameter, Channel, CheckpointConfig, CognitoConfig, CognitoMemberDefinition, CollectionConfiguration, CompilationJobStatus, ContainerDefinition, ContentClassifier, ContextSource, DataCaptureConfig, DataQualityAppSpecification, DataQualityBaselineConfig, DataQualityJobInput, DeploymentConfig, DomainSettings, EdgeOutputConfig, EdgePresetDeploymentType, EndpointInput, FeatureDefinition, FeatureType, FlowDefinitionOutputConfig, GitConfig, HumanLoopActivationConfig, HumanLoopConfig, HumanLoopRequestSource, HyperParameterTrainingJobDefinition, HyperParameterTuningJobConfig, HyperParameterTuningJobObjectiveType, HyperParameterTuningJobWarmStartConfig, InferenceSpecification, InputConfig, KernelGatewayImageConfig, MetadataProperties, MetricsSource, ModelApprovalStatus, ModelDeployConfig, MonitoringConstraintsResource, MonitoringNetworkConfig, MonitoringOutputConfig, MonitoringResources, MonitoringStatisticsResource, MonitoringStoppingCondition, NeoVpcConfig, ObjectiveStatus, OfflineStoreConfig, OnlineStoreConfig, OutputConfig, OutputDataConfig, ProblemType, ProcessingInstanceType, ProcessingS3DataDistributionType, ProcessingS3InputMode, ProcessingS3UploadMode, ProductionVariant, ProductionVariantAcceleratorType, ProductionVariantInstanceType, ProductionVariantServerlessConfig, PublicWorkforceTaskPrice, ResourceConfig, ResourceSpec, RetryStrategy, StoppingCondition, Tag, TrainingSpecification, TransformInput, TransformJobDefinition, TransformOutput, TransformResources, UserContext, UserSettings, VpcConfig } from "./models_0";
1
+ import { ActionSource, ActionStatus, AdditionalInferenceSpecificationDefinition, AlgorithmSpecification, AlgorithmStatus, AlgorithmStatusDetails, AlgorithmValidationSpecification, AnnotationConsolidationConfig, AppNetworkAccessType, AppSecurityGroupManagement, AppSpecification, AppStatus, AppType, ArtifactSource, AsyncInferenceConfig, AthenaDatasetDefinition, AuthMode, AutoMLCandidate, AutoMLChannel, AutoMLJobArtifacts, AutoMLJobCompletionCriteria, AutoMLJobConfig, AutoMLJobObjective, AutoMLJobSecondaryStatus, AutoMLJobStatus, AutoMLOutputDataConfig, AutoMLPartialFailureReason, BatchStrategy, Bias, CaptureStatus, CategoricalParameter, Channel, CheckpointConfig, CognitoConfig, CognitoMemberDefinition, CollectionConfiguration, CompilationJobStatus, ContainerDefinition, ContentClassifier, ContextSource, DataCaptureConfig, DataQualityAppSpecification, DataQualityBaselineConfig, DataQualityJobInput, DeploymentConfig, DeviceSelectionConfig, DomainSettings, EdgeDeploymentConfig, EdgeDeploymentModelConfig, EdgeOutputConfig, EdgePresetDeploymentType, EndpointInput, FeatureDefinition, FeatureType, FlowDefinitionOutputConfig, GitConfig, HumanLoopActivationConfig, HumanLoopConfig, HumanLoopRequestSource, HyperParameterTuningJobObjective, HyperParameterTuningJobStrategyType, InferenceSpecification, InputConfig, KernelGatewayImageConfig, MetadataProperties, MetricDefinition, MetricsSource, ModelApprovalStatus, ModelDeployConfig, MonitoringConstraintsResource, MonitoringNetworkConfig, MonitoringOutputConfig, MonitoringResources, MonitoringStatisticsResource, MonitoringStoppingCondition, NeoVpcConfig, OfflineStoreConfig, OnlineStoreConfig, OutputConfig, OutputDataConfig, ParameterRanges, ProblemType, ProcessingInstanceType, ProcessingS3DataDistributionType, ProcessingS3InputMode, ProcessingS3UploadMode, ProductionVariant, ProductionVariantAcceleratorType, ProductionVariantInstanceType, ProductionVariantServerlessConfig, PublicWorkforceTaskPrice, ResourceConfig, ResourceLimits, ResourceSpec, StoppingCondition, Tag, TrainingInputMode, TrainingJobEarlyStoppingType, TrainingSpecification, TransformInput, TransformJobDefinition, TransformOutput, TransformResources, TuningJobCompletionCriteria, UserContext, UserSettings, VpcConfig } from "./models_0";
2
+ /**
3
+ * <p>Configures a hyperparameter tuning job.</p>
4
+ */
5
+ export interface HyperParameterTuningJobConfig {
6
+ /**
7
+ * <p>Specifies how hyperparameter tuning chooses the combinations of hyperparameter values
8
+ * to use for the training job it launches. To use the Bayesian search strategy, set this
9
+ * to <code>Bayesian</code>. To randomly search, set it to <code>Random</code>. For
10
+ * information about search strategies, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-how-it-works.html">How
11
+ * Hyperparameter Tuning Works</a>.</p>
12
+ */
13
+ Strategy: HyperParameterTuningJobStrategyType | string | undefined;
14
+ /**
15
+ * <p>The <a>HyperParameterTuningJobObjective</a> object that specifies the
16
+ * objective
17
+ * metric for this tuning job.</p>
18
+ */
19
+ HyperParameterTuningJobObjective?: HyperParameterTuningJobObjective;
20
+ /**
21
+ * <p>The <a>ResourceLimits</a> object that specifies the
22
+ * maximum
23
+ * number of training jobs and parallel training jobs for this tuning
24
+ * job.</p>
25
+ */
26
+ ResourceLimits: ResourceLimits | undefined;
27
+ /**
28
+ * <p>The <a>ParameterRanges</a> object that specifies the ranges of
29
+ * hyperparameters
30
+ * that this tuning job searches.</p>
31
+ */
32
+ ParameterRanges?: ParameterRanges;
33
+ /**
34
+ * <p>Specifies whether to use early stopping for training jobs launched by the
35
+ * hyperparameter tuning job. This can be one of the following values (the default value is
36
+ * <code>OFF</code>):</p>
37
+ * <dl>
38
+ * <dt>OFF</dt>
39
+ * <dd>
40
+ * <p>Training jobs launched by the hyperparameter tuning job do not use early
41
+ * stopping.</p>
42
+ * </dd>
43
+ * <dt>AUTO</dt>
44
+ * <dd>
45
+ * <p>SageMaker stops training jobs launched by the hyperparameter tuning job when
46
+ * they are unlikely to perform better than previously completed training jobs.
47
+ * For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-early-stopping.html">Stop Training Jobs Early</a>.</p>
48
+ * </dd>
49
+ * </dl>
50
+ */
51
+ TrainingJobEarlyStoppingType?: TrainingJobEarlyStoppingType | string;
52
+ /**
53
+ * <p>The tuning job's completion criteria.</p>
54
+ */
55
+ TuningJobCompletionCriteria?: TuningJobCompletionCriteria;
56
+ }
57
+ export declare namespace HyperParameterTuningJobConfig {
58
+ /**
59
+ * @internal
60
+ */
61
+ const filterSensitiveLog: (obj: HyperParameterTuningJobConfig) => any;
62
+ }
63
+ /**
64
+ * <p>Specifies
65
+ * which
66
+ * training algorithm to use for training jobs that a hyperparameter
67
+ * tuning job launches and the metrics to monitor.</p>
68
+ */
69
+ export interface HyperParameterAlgorithmSpecification {
70
+ /**
71
+ * <p> The registry path of the Docker image that contains the training algorithm. For
72
+ * information about Docker registry paths for built-in algorithms, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-algo-docker-registry-paths.html">Algorithms
73
+ * Provided by Amazon SageMaker: Common Parameters</a>. SageMaker supports both
74
+ * <code>registry/repository[:tag]</code> and <code>registry/repository[@digest]</code>
75
+ * image path formats. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms.html">Using Your Own Algorithms with Amazon
76
+ * SageMaker</a>.</p>
77
+ */
78
+ TrainingImage?: string;
79
+ /**
80
+ * <p>The training input mode that the algorithm supports. For more information about input modes, see
81
+ * <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/algos.html">Algorithms</a>.</p>
82
+ *
83
+ * <p>
84
+ * <b>Pipe mode</b>
85
+ * </p>
86
+ * <p>If an algorithm supports <code>Pipe</code> mode, Amazon SageMaker streams data directly
87
+ * from Amazon S3 to the container.</p>
88
+ *
89
+ * <p>
90
+ * <b>File mode</b>
91
+ * </p>
92
+ * <p>If an algorithm supports <code>File</code> mode, SageMaker
93
+ * downloads the training data from S3 to the provisioned ML storage volume, and mounts the
94
+ * directory to the Docker volume for the training container.</p>
95
+ * <p>You must provision the ML storage volume with sufficient capacity
96
+ * to accommodate the data downloaded from S3. In addition to the training data, the ML
97
+ * storage volume also stores the output model. The algorithm container uses the ML storage
98
+ * volume to also store intermediate information, if any.</p>
99
+ * <p>For distributed algorithms, training data is distributed uniformly.
100
+ * Your training duration is predictable if the input data objects sizes are
101
+ * approximately the same. SageMaker does not split the files any further for model training.
102
+ * If the object sizes are skewed, training won't be optimal as the data distribution is also
103
+ * skewed when one host in a training cluster is overloaded, thus becoming a bottleneck in
104
+ * training.</p>
105
+ *
106
+ * <p>
107
+ * <b>FastFile mode</b>
108
+ * </p>
109
+ * <p>If an algorithm supports <code>FastFile</code> mode, SageMaker streams data directly
110
+ * from S3 to the container with no code changes, and provides file system access to
111
+ * the data. Users can author their training script to interact with these files as if
112
+ * they were stored on disk.</p>
113
+ * <p>
114
+ * <code>FastFile</code> mode works best when the data is read sequentially.
115
+ * Augmented manifest files aren't supported.
116
+ * The startup time is lower when there are fewer files in the S3 bucket provided.</p>
117
+ */
118
+ TrainingInputMode: TrainingInputMode | string | undefined;
119
+ /**
120
+ * <p>The name of the resource algorithm to use for the hyperparameter tuning job. If you
121
+ * specify a value for this parameter, do not specify a value for
122
+ * <code>TrainingImage</code>.</p>
123
+ */
124
+ AlgorithmName?: string;
125
+ /**
126
+ * <p>An array of <a>MetricDefinition</a> objects that specify the
127
+ * metrics
128
+ * that the algorithm emits.</p>
129
+ */
130
+ MetricDefinitions?: MetricDefinition[];
131
+ }
132
+ export declare namespace HyperParameterAlgorithmSpecification {
133
+ /**
134
+ * @internal
135
+ */
136
+ const filterSensitiveLog: (obj: HyperParameterAlgorithmSpecification) => any;
137
+ }
138
+ /**
139
+ * <p>The retry strategy to use when a training job fails due to an
140
+ * <code>InternalServerError</code>. <code>RetryStrategy</code> is specified as part of
141
+ * the <code>CreateTrainingJob</code> and <code>CreateHyperParameterTuningJob</code>
142
+ * requests. You can add the <code>StoppingCondition</code> parameter to the request to
143
+ * limit the training time for the complete job.</p>
144
+ */
145
+ export interface RetryStrategy {
146
+ /**
147
+ * <p>The number of times to retry the job. When the job is retried, it's
148
+ * <code>SecondaryStatus</code> is changed to <code>STARTING</code>.</p>
149
+ */
150
+ MaximumRetryAttempts: number | undefined;
151
+ }
152
+ export declare namespace RetryStrategy {
153
+ /**
154
+ * @internal
155
+ */
156
+ const filterSensitiveLog: (obj: RetryStrategy) => any;
157
+ }
158
+ /**
159
+ * <p>Defines
160
+ * the training jobs launched by a hyperparameter tuning job.</p>
161
+ */
162
+ export interface HyperParameterTrainingJobDefinition {
163
+ /**
164
+ * <p>The job definition name.</p>
165
+ */
166
+ DefinitionName?: string;
167
+ /**
168
+ * <p>Defines the objective metric for a hyperparameter tuning job.
169
+ * Hyperparameter
170
+ * tuning uses the value of this metric to evaluate the training jobs it launches, and
171
+ * returns the training job that results in either the highest or lowest value for this
172
+ * metric, depending on the value you specify for the <code>Type</code>
173
+ * parameter.</p>
174
+ */
175
+ TuningObjective?: HyperParameterTuningJobObjective;
176
+ /**
177
+ * <p>Specifies ranges of integer, continuous, and categorical hyperparameters that a
178
+ * hyperparameter tuning job searches. The hyperparameter tuning job launches training jobs
179
+ * with hyperparameter values within these ranges to find the combination of values that
180
+ * result in the training job with the best performance as measured by the objective metric
181
+ * of the hyperparameter tuning job.</p>
182
+ * <note>
183
+ * <p>The maximum number of items specified for <code>Array Members</code> refers to
184
+ * the maximum number of hyperparameters for each range and also the maximum for the
185
+ * hyperparameter tuning job itself. That is, the sum of the number of hyperparameters
186
+ * for all the ranges can't exceed the maximum number specified.</p>
187
+ * </note>
188
+ */
189
+ HyperParameterRanges?: ParameterRanges;
190
+ /**
191
+ * <p>Specifies the values of hyperparameters
192
+ * that
193
+ * do not change for the tuning job.</p>
194
+ */
195
+ StaticHyperParameters?: Record<string, string>;
196
+ /**
197
+ * <p>The <a>HyperParameterAlgorithmSpecification</a> object that
198
+ * specifies
199
+ * the resource algorithm to use for the training jobs that the tuning
200
+ * job launches.</p>
201
+ */
202
+ AlgorithmSpecification: HyperParameterAlgorithmSpecification | undefined;
203
+ /**
204
+ * <p>The Amazon Resource Name (ARN) of the
205
+ * IAM
206
+ * role associated with the training jobs that the tuning job
207
+ * launches.</p>
208
+ */
209
+ RoleArn: string | undefined;
210
+ /**
211
+ * <p>An array of <a>Channel</a> objects that specify
212
+ * the
213
+ * input for the training jobs that the tuning job launches.</p>
214
+ */
215
+ InputDataConfig?: Channel[];
216
+ /**
217
+ * <p>The <a>VpcConfig</a> object that
218
+ * specifies
219
+ * the VPC that you want the training jobs that this hyperparameter
220
+ * tuning job launches to connect to. Control access to and from your
221
+ * training
222
+ * container by configuring the VPC. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/train-vpc.html">Protect Training Jobs
223
+ * by Using an Amazon Virtual Private Cloud</a>.</p>
224
+ */
225
+ VpcConfig?: VpcConfig;
226
+ /**
227
+ * <p>Specifies the path to the Amazon S3 bucket where you
228
+ * store
229
+ * model artifacts from the training jobs that the tuning job
230
+ * launches.</p>
231
+ */
232
+ OutputDataConfig: OutputDataConfig | undefined;
233
+ /**
234
+ * <p>The resources,
235
+ * including
236
+ * the compute instances and storage volumes, to use for the training
237
+ * jobs that the tuning job launches.</p>
238
+ * <p>Storage volumes store model artifacts and
239
+ * incremental
240
+ * states. Training algorithms might also use storage volumes for
241
+ * scratch
242
+ * space. If you want SageMaker to use the storage volume to store the
243
+ * training data, choose <code>File</code> as the <code>TrainingInputMode</code> in the
244
+ * algorithm specification. For distributed training algorithms, specify an instance count
245
+ * greater than 1.</p>
246
+ */
247
+ ResourceConfig: ResourceConfig | undefined;
248
+ /**
249
+ * <p>Specifies a limit to how long a model hyperparameter training job can run. It also
250
+ * specifies how long a managed spot training job has to complete. When the job reaches the
251
+ * time limit, SageMaker ends the training job. Use this API to cap model training costs.</p>
252
+ */
253
+ StoppingCondition: StoppingCondition | undefined;
254
+ /**
255
+ * <p>Isolates the training container. No inbound or outbound network calls can be made,
256
+ * except for calls between peers within a training cluster for distributed training. If
257
+ * network isolation is used for training jobs that are configured to use a VPC, SageMaker
258
+ * downloads and uploads customer data and model artifacts through the specified VPC, but
259
+ * the training container does not have network access.</p>
260
+ */
261
+ EnableNetworkIsolation?: boolean;
262
+ /**
263
+ * <p>To encrypt all communications between ML compute instances in distributed training,
264
+ * choose <code>True</code>. Encryption provides greater security for distributed training,
265
+ * but training might take longer. How long it takes depends on the amount of communication
266
+ * between compute instances, especially if you use a deep learning algorithm in
267
+ * distributed training.</p>
268
+ */
269
+ EnableInterContainerTrafficEncryption?: boolean;
270
+ /**
271
+ * <p>A Boolean indicating whether managed spot training is enabled (<code>True</code>) or
272
+ * not (<code>False</code>).</p>
273
+ */
274
+ EnableManagedSpotTraining?: boolean;
275
+ /**
276
+ * <p>Contains information about the output location for managed spot training checkpoint
277
+ * data. </p>
278
+ */
279
+ CheckpointConfig?: CheckpointConfig;
280
+ /**
281
+ * <p>The number of times to retry the job when the job fails due to an
282
+ * <code>InternalServerError</code>.</p>
283
+ */
284
+ RetryStrategy?: RetryStrategy;
285
+ }
286
+ export declare namespace HyperParameterTrainingJobDefinition {
287
+ /**
288
+ * @internal
289
+ */
290
+ const filterSensitiveLog: (obj: HyperParameterTrainingJobDefinition) => any;
291
+ }
292
+ /**
293
+ * <p>A previously completed or stopped hyperparameter tuning job to be used as a starting
294
+ * point for a new hyperparameter tuning job.</p>
295
+ */
296
+ export interface ParentHyperParameterTuningJob {
297
+ /**
298
+ * <p>The name of the hyperparameter tuning job to be used as a starting point for a new
299
+ * hyperparameter tuning job.</p>
300
+ */
301
+ HyperParameterTuningJobName?: string;
302
+ }
303
+ export declare namespace ParentHyperParameterTuningJob {
304
+ /**
305
+ * @internal
306
+ */
307
+ const filterSensitiveLog: (obj: ParentHyperParameterTuningJob) => any;
308
+ }
309
+ export declare enum HyperParameterTuningJobWarmStartType {
310
+ IDENTICAL_DATA_AND_ALGORITHM = "IdenticalDataAndAlgorithm",
311
+ TRANSFER_LEARNING = "TransferLearning"
312
+ }
313
+ /**
314
+ * <p>Specifies the configuration for a hyperparameter tuning job that uses one or more
315
+ * previous hyperparameter tuning jobs as a starting point. The results of previous tuning
316
+ * jobs are used to inform which combinations of hyperparameters to search over in the new
317
+ * tuning job.</p>
318
+ * <p>All training jobs launched by the new hyperparameter tuning job are evaluated by using
319
+ * the objective metric, and the training job that performs the best is compared to the
320
+ * best training jobs from the parent tuning jobs. From these, the training job that
321
+ * performs the best as measured by the objective metric is returned as the overall best
322
+ * training job.</p>
323
+ * <note>
324
+ * <p>All training jobs launched by parent hyperparameter tuning jobs and the new
325
+ * hyperparameter tuning jobs count against the limit of training jobs for the tuning
326
+ * job.</p>
327
+ * </note>
328
+ */
329
+ export interface HyperParameterTuningJobWarmStartConfig {
330
+ /**
331
+ * <p>An array of hyperparameter tuning jobs that are used as the starting point for the new
332
+ * hyperparameter tuning job. For more information about warm starting a hyperparameter
333
+ * tuning job, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-warm-start.html">Using a Previous
334
+ * Hyperparameter Tuning Job as a Starting Point</a>.</p>
335
+ * <p>Hyperparameter tuning jobs created before October 1, 2018 cannot be used as parent
336
+ * jobs for warm start tuning jobs.</p>
337
+ */
338
+ ParentHyperParameterTuningJobs: ParentHyperParameterTuningJob[] | undefined;
339
+ /**
340
+ * <p>Specifies one of the following:</p>
341
+ * <dl>
342
+ * <dt>IDENTICAL_DATA_AND_ALGORITHM</dt>
343
+ * <dd>
344
+ * <p>The new hyperparameter tuning job uses the same input data and training
345
+ * image as the parent tuning jobs. You can change the hyperparameter ranges to
346
+ * search and the maximum number of training jobs that the hyperparameter
347
+ * tuning job launches. You cannot use a new version of the training algorithm,
348
+ * unless the changes in the new version do not affect the algorithm itself.
349
+ * For example, changes that improve logging or adding support for a different
350
+ * data format are allowed. You can also change hyperparameters from tunable to
351
+ * static, and from static to tunable, but the total number of static plus
352
+ * tunable hyperparameters must remain the same as it is in all parent jobs.
353
+ * The objective metric for the new tuning job must be the same as for all
354
+ * parent jobs.</p>
355
+ * </dd>
356
+ * <dt>TRANSFER_LEARNING</dt>
357
+ * <dd>
358
+ * <p>The new hyperparameter tuning job can include input data, hyperparameter
359
+ * ranges, maximum number of concurrent training jobs, and maximum number of
360
+ * training jobs that are different than those of its parent hyperparameter
361
+ * tuning jobs. The training image can also be a different version from the
362
+ * version used in the parent hyperparameter tuning job. You can also change
363
+ * hyperparameters from tunable to static, and from static to tunable, but the
364
+ * total number of static plus tunable hyperparameters must remain the same as
365
+ * it is in all parent jobs. The objective metric for the new tuning job must
366
+ * be the same as for all parent jobs.</p>
367
+ * </dd>
368
+ * </dl>
369
+ */
370
+ WarmStartType: HyperParameterTuningJobWarmStartType | string | undefined;
371
+ }
372
+ export declare namespace HyperParameterTuningJobWarmStartConfig {
373
+ /**
374
+ * @internal
375
+ */
376
+ const filterSensitiveLog: (obj: HyperParameterTuningJobWarmStartConfig) => any;
377
+ }
378
+ export interface CreateHyperParameterTuningJobRequest {
379
+ /**
380
+ * <p>The name of the tuning job. This name is the prefix for the names of all training jobs
381
+ * that this tuning job launches. The name must be unique within the same Amazon Web Services account and
382
+ * Amazon Web Services Region. The name must have 1 to 32 characters. Valid characters are a-z, A-Z, 0-9,
383
+ * and : + = @ _ % - (hyphen). The name is not case sensitive.</p>
384
+ */
385
+ HyperParameterTuningJobName: string | undefined;
386
+ /**
387
+ * <p>The <a>HyperParameterTuningJobConfig</a> object that describes the tuning
388
+ * job, including the search strategy, the objective metric used to evaluate training jobs,
389
+ * ranges of parameters to search, and resource limits for the tuning job. For more
390
+ * information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-how-it-works.html">How
391
+ * Hyperparameter Tuning Works</a>.</p>
392
+ */
393
+ HyperParameterTuningJobConfig: HyperParameterTuningJobConfig | undefined;
394
+ /**
395
+ * <p>The <a>HyperParameterTrainingJobDefinition</a> object that describes the
396
+ * training jobs that this tuning job launches, including static hyperparameters, input
397
+ * data configuration, output data configuration, resource configuration, and stopping
398
+ * condition.</p>
399
+ */
400
+ TrainingJobDefinition?: HyperParameterTrainingJobDefinition;
401
+ /**
402
+ * <p>A list of the <a>HyperParameterTrainingJobDefinition</a> objects launched
403
+ * for this tuning job.</p>
404
+ */
405
+ TrainingJobDefinitions?: HyperParameterTrainingJobDefinition[];
406
+ /**
407
+ * <p>Specifies the configuration for starting the hyperparameter tuning job using one or
408
+ * more previous tuning jobs as a starting point. The results of previous tuning jobs are
409
+ * used to inform which combinations of hyperparameters to search over in the new tuning
410
+ * job.</p>
411
+ * <p>All training jobs launched by the new hyperparameter tuning job are evaluated by using
412
+ * the objective metric. If you specify <code>IDENTICAL_DATA_AND_ALGORITHM</code> as the
413
+ * <code>WarmStartType</code> value for the warm start configuration, the training job
414
+ * that performs the best in the new tuning job is compared to the best training jobs from
415
+ * the parent tuning jobs. From these, the training job that performs the best as measured
416
+ * by the objective metric is returned as the overall best training job.</p>
417
+ * <note>
418
+ * <p>All training jobs launched by parent hyperparameter tuning jobs and the new
419
+ * hyperparameter tuning jobs count against the limit of training jobs for the tuning
420
+ * job.</p>
421
+ * </note>
422
+ */
423
+ WarmStartConfig?: HyperParameterTuningJobWarmStartConfig;
424
+ /**
425
+ * <p>An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in
426
+ * different ways, for example, by purpose, owner, or environment. For more information,
427
+ * see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services
428
+ * Resources</a>.</p>
429
+ * <p>Tags that you specify for the tuning job are also added to all training jobs that the
430
+ * tuning job launches.</p>
431
+ */
432
+ Tags?: Tag[];
433
+ }
434
+ export declare namespace CreateHyperParameterTuningJobRequest {
435
+ /**
436
+ * @internal
437
+ */
438
+ const filterSensitiveLog: (obj: CreateHyperParameterTuningJobRequest) => any;
439
+ }
440
+ export interface CreateHyperParameterTuningJobResponse {
441
+ /**
442
+ * <p>The Amazon Resource Name (ARN) of the tuning job. SageMaker assigns an ARN to a
443
+ * hyperparameter tuning job when you create it.</p>
444
+ */
445
+ HyperParameterTuningJobArn: string | undefined;
446
+ }
447
+ export declare namespace CreateHyperParameterTuningJobResponse {
448
+ /**
449
+ * @internal
450
+ */
451
+ const filterSensitiveLog: (obj: CreateHyperParameterTuningJobResponse) => any;
452
+ }
2
453
  export interface CreateImageRequest {
3
454
  /**
4
455
  * <p>The description of the image.</p>
@@ -6426,6 +6877,34 @@ export declare namespace DeleteDomainRequest {
6426
6877
  */
6427
6878
  const filterSensitiveLog: (obj: DeleteDomainRequest) => any;
6428
6879
  }
6880
+ export interface DeleteEdgeDeploymentPlanRequest {
6881
+ /**
6882
+ * <p>The name of the edge deployment plan to delete.</p>
6883
+ */
6884
+ EdgeDeploymentPlanName: string | undefined;
6885
+ }
6886
+ export declare namespace DeleteEdgeDeploymentPlanRequest {
6887
+ /**
6888
+ * @internal
6889
+ */
6890
+ const filterSensitiveLog: (obj: DeleteEdgeDeploymentPlanRequest) => any;
6891
+ }
6892
+ export interface DeleteEdgeDeploymentStageRequest {
6893
+ /**
6894
+ * <p>The name of the edge deployment plan from which the stage will be deleted.</p>
6895
+ */
6896
+ EdgeDeploymentPlanName: string | undefined;
6897
+ /**
6898
+ * <p>The name of the stage.</p>
6899
+ */
6900
+ StageName: string | undefined;
6901
+ }
6902
+ export declare namespace DeleteEdgeDeploymentStageRequest {
6903
+ /**
6904
+ * @internal
6905
+ */
6906
+ const filterSensitiveLog: (obj: DeleteEdgeDeploymentStageRequest) => any;
6907
+ }
6429
6908
  export interface DeleteEndpointInput {
6430
6909
  /**
6431
6910
  * <p>The name of the endpoint that you want to delete.</p>
@@ -6911,6 +7390,78 @@ export declare namespace DeployedImage {
6911
7390
  */
6912
7391
  const filterSensitiveLog: (obj: DeployedImage) => any;
6913
7392
  }
7393
+ export declare enum StageStatus {
7394
+ Creating = "CREATING",
7395
+ Deployed = "DEPLOYED",
7396
+ Failed = "FAILED",
7397
+ InProgress = "INPROGRESS",
7398
+ ReadyToDeploy = "READYTODEPLOY",
7399
+ Starting = "STARTING",
7400
+ Stopped = "STOPPED",
7401
+ Stopping = "STOPPING"
7402
+ }
7403
+ /**
7404
+ * <p>Contains information summarizing the deployment stage results.</p>
7405
+ */
7406
+ export interface EdgeDeploymentStatus {
7407
+ /**
7408
+ * <p>The general status of the current stage.</p>
7409
+ */
7410
+ StageStatus: StageStatus | string | undefined;
7411
+ /**
7412
+ * <p>The number of edge devices with the successful deployment in the current stage.</p>
7413
+ */
7414
+ EdgeDeploymentSuccessInStage: number | undefined;
7415
+ /**
7416
+ * <p>The number of edge devices yet to pick up the deployment in current stage, or in progress.</p>
7417
+ */
7418
+ EdgeDeploymentPendingInStage: number | undefined;
7419
+ /**
7420
+ * <p>The number of edge devices that failed the deployment in current stage.</p>
7421
+ */
7422
+ EdgeDeploymentFailedInStage: number | undefined;
7423
+ /**
7424
+ * <p>A detailed message about deployment status in current stage.</p>
7425
+ */
7426
+ EdgeDeploymentStatusMessage?: string;
7427
+ /**
7428
+ * <p>The time when the deployment API started.</p>
7429
+ */
7430
+ EdgeDeploymentStageStartTime?: Date;
7431
+ }
7432
+ export declare namespace EdgeDeploymentStatus {
7433
+ /**
7434
+ * @internal
7435
+ */
7436
+ const filterSensitiveLog: (obj: EdgeDeploymentStatus) => any;
7437
+ }
7438
+ /**
7439
+ * <p>Contains information summarizing the deployment stage results.</p>
7440
+ */
7441
+ export interface DeploymentStageStatusSummary {
7442
+ /**
7443
+ * <p>The name of the stage.</p>
7444
+ */
7445
+ StageName: string | undefined;
7446
+ /**
7447
+ * <p>Configuration of the devices in the stage.</p>
7448
+ */
7449
+ DeviceSelectionConfig: DeviceSelectionConfig | undefined;
7450
+ /**
7451
+ * <p>Configuration of the deployment details.</p>
7452
+ */
7453
+ DeploymentConfig: EdgeDeploymentConfig | undefined;
7454
+ /**
7455
+ * <p>General status of the current state.</p>
7456
+ */
7457
+ DeploymentStatus: EdgeDeploymentStatus | undefined;
7458
+ }
7459
+ export declare namespace DeploymentStageStatusSummary {
7460
+ /**
7461
+ * @internal
7462
+ */
7463
+ const filterSensitiveLog: (obj: DeploymentStageStatusSummary) => any;
7464
+ }
6914
7465
  export interface DeregisterDevicesRequest {
6915
7466
  /**
6916
7467
  * <p>The name of the fleet the devices belong to.</p>
@@ -7997,34 +8548,106 @@ export declare namespace DescribeDomainResponse {
7997
8548
  */
7998
8549
  const filterSensitiveLog: (obj: DescribeDomainResponse) => any;
7999
8550
  }
8000
- export interface DescribeEdgePackagingJobRequest {
8551
+ export interface DescribeEdgeDeploymentPlanRequest {
8001
8552
  /**
8002
- * <p>The name of the edge packaging job.</p>
8553
+ * <p>The name of the deployment plan to describe.</p>
8003
8554
  */
8004
- EdgePackagingJobName: string | undefined;
8555
+ EdgeDeploymentPlanName: string | undefined;
8556
+ /**
8557
+ * <p>If the edge deployment plan has enough stages to require tokening, then this is the response from the last list of stages returned.</p>
8558
+ */
8559
+ NextToken?: string;
8560
+ /**
8561
+ * <p>The maximum number of results to select (50 by default).</p>
8562
+ */
8563
+ MaxResults?: number;
8005
8564
  }
8006
- export declare namespace DescribeEdgePackagingJobRequest {
8565
+ export declare namespace DescribeEdgeDeploymentPlanRequest {
8007
8566
  /**
8008
8567
  * @internal
8009
8568
  */
8010
- const filterSensitiveLog: (obj: DescribeEdgePackagingJobRequest) => any;
8569
+ const filterSensitiveLog: (obj: DescribeEdgeDeploymentPlanRequest) => any;
8011
8570
  }
8012
- export declare enum EdgePackagingJobStatus {
8013
- Completed = "COMPLETED",
8014
- Failed = "FAILED",
8015
- InProgress = "INPROGRESS",
8016
- Starting = "STARTING",
8017
- Stopped = "STOPPED",
8018
- Stopping = "STOPPING"
8019
- }
8020
- export declare enum EdgePresetDeploymentStatus {
8021
- Completed = "COMPLETED",
8022
- Failed = "FAILED"
8023
- }
8024
- /**
8025
- * <p>The output of a SageMaker Edge Manager deployable resource.</p>
8026
- */
8027
- export interface EdgePresetDeploymentOutput {
8571
+ export interface DescribeEdgeDeploymentPlanResponse {
8572
+ /**
8573
+ * <p>The ARN of edge deployment plan.</p>
8574
+ */
8575
+ EdgeDeploymentPlanArn: string | undefined;
8576
+ /**
8577
+ * <p>The name of the edge deployment plan.</p>
8578
+ */
8579
+ EdgeDeploymentPlanName: string | undefined;
8580
+ /**
8581
+ * <p>List of models associated with the edge deployment plan.</p>
8582
+ */
8583
+ ModelConfigs: EdgeDeploymentModelConfig[] | undefined;
8584
+ /**
8585
+ * <p>The device fleet used for this edge deployment plan.</p>
8586
+ */
8587
+ DeviceFleetName: string | undefined;
8588
+ /**
8589
+ * <p>The number of edge devices with the successful deployment.</p>
8590
+ */
8591
+ EdgeDeploymentSuccess?: number;
8592
+ /**
8593
+ * <p>The number of edge devices yet to pick up deployment, or in progress.</p>
8594
+ */
8595
+ EdgeDeploymentPending?: number;
8596
+ /**
8597
+ * <p>The number of edge devices that failed the deployment.</p>
8598
+ */
8599
+ EdgeDeploymentFailed?: number;
8600
+ /**
8601
+ * <p>List of stages in the edge deployment plan.</p>
8602
+ */
8603
+ Stages: DeploymentStageStatusSummary[] | undefined;
8604
+ /**
8605
+ * <p>Token to use when calling the next set of stages in the edge deployment plan.</p>
8606
+ */
8607
+ NextToken?: string;
8608
+ /**
8609
+ * <p>The time when the edge deployment plan was created.</p>
8610
+ */
8611
+ CreationTime?: Date;
8612
+ /**
8613
+ * <p>The time when the edge deployment plan was last updated.</p>
8614
+ */
8615
+ LastModifiedTime?: Date;
8616
+ }
8617
+ export declare namespace DescribeEdgeDeploymentPlanResponse {
8618
+ /**
8619
+ * @internal
8620
+ */
8621
+ const filterSensitiveLog: (obj: DescribeEdgeDeploymentPlanResponse) => any;
8622
+ }
8623
+ export interface DescribeEdgePackagingJobRequest {
8624
+ /**
8625
+ * <p>The name of the edge packaging job.</p>
8626
+ */
8627
+ EdgePackagingJobName: string | undefined;
8628
+ }
8629
+ export declare namespace DescribeEdgePackagingJobRequest {
8630
+ /**
8631
+ * @internal
8632
+ */
8633
+ const filterSensitiveLog: (obj: DescribeEdgePackagingJobRequest) => any;
8634
+ }
8635
+ export declare enum EdgePackagingJobStatus {
8636
+ Completed = "COMPLETED",
8637
+ Failed = "FAILED",
8638
+ InProgress = "INPROGRESS",
8639
+ Starting = "STARTING",
8640
+ Stopped = "STOPPED",
8641
+ Stopping = "STOPPING"
8642
+ }
8643
+ export declare enum EdgePresetDeploymentStatus {
8644
+ Completed = "COMPLETED",
8645
+ Failed = "FAILED"
8646
+ }
8647
+ /**
8648
+ * <p>The output of a SageMaker Edge Manager deployable resource.</p>
8649
+ */
8650
+ export interface EdgePresetDeploymentOutput {
8028
8651
  /**
8029
8652
  * <p>The deployment type created by SageMaker Edge Manager. Currently only
8030
8653
  * supports Amazon Web Services IoT Greengrass Version 2 components.</p>
@@ -8963,485 +9586,3 @@ export declare namespace DescribeHumanTaskUiResponse {
8963
9586
  */
8964
9587
  const filterSensitiveLog: (obj: DescribeHumanTaskUiResponse) => any;
8965
9588
  }
8966
- export interface DescribeHyperParameterTuningJobRequest {
8967
- /**
8968
- * <p>The name of the tuning job.</p>
8969
- */
8970
- HyperParameterTuningJobName: string | undefined;
8971
- }
8972
- export declare namespace DescribeHyperParameterTuningJobRequest {
8973
- /**
8974
- * @internal
8975
- */
8976
- const filterSensitiveLog: (obj: DescribeHyperParameterTuningJobRequest) => any;
8977
- }
8978
- /**
8979
- * <p>Shows the final value for the
8980
- * objective
8981
- * metric for a training job that was launched by a hyperparameter
8982
- * tuning job. You define the objective metric in the
8983
- * <code>HyperParameterTuningJobObjective</code> parameter of <a>HyperParameterTuningJobConfig</a>.</p>
8984
- */
8985
- export interface FinalHyperParameterTuningJobObjectiveMetric {
8986
- /**
8987
- * <p>Whether to
8988
- * minimize
8989
- * or maximize the objective metric. Valid values are Minimize and
8990
- * Maximize.</p>
8991
- */
8992
- Type?: HyperParameterTuningJobObjectiveType | string;
8993
- /**
8994
- * <p>The name of the
8995
- * objective
8996
- * metric.</p>
8997
- */
8998
- MetricName: string | undefined;
8999
- /**
9000
- * <p>The value of the objective metric.</p>
9001
- */
9002
- Value: number | undefined;
9003
- }
9004
- export declare namespace FinalHyperParameterTuningJobObjectiveMetric {
9005
- /**
9006
- * @internal
9007
- */
9008
- const filterSensitiveLog: (obj: FinalHyperParameterTuningJobObjectiveMetric) => any;
9009
- }
9010
- export declare enum TrainingJobStatus {
9011
- COMPLETED = "Completed",
9012
- FAILED = "Failed",
9013
- IN_PROGRESS = "InProgress",
9014
- STOPPED = "Stopped",
9015
- STOPPING = "Stopping"
9016
- }
9017
- /**
9018
- * <p>The container for the summary information about a training job.</p>
9019
- */
9020
- export interface HyperParameterTrainingJobSummary {
9021
- /**
9022
- * <p>The training job definition name.</p>
9023
- */
9024
- TrainingJobDefinitionName?: string;
9025
- /**
9026
- * <p>The name of the training job.</p>
9027
- */
9028
- TrainingJobName: string | undefined;
9029
- /**
9030
- * <p>The Amazon Resource Name (ARN) of the training job.</p>
9031
- */
9032
- TrainingJobArn: string | undefined;
9033
- /**
9034
- * <p>The HyperParameter tuning job that launched the training job.</p>
9035
- */
9036
- TuningJobName?: string;
9037
- /**
9038
- * <p>The date and time that the training job was created.</p>
9039
- */
9040
- CreationTime: Date | undefined;
9041
- /**
9042
- * <p>The date and time that the training job started.</p>
9043
- */
9044
- TrainingStartTime?: Date;
9045
- /**
9046
- * <p>Specifies the time when the training job ends on training instances. You are billed
9047
- * for the time interval between the value of <code>TrainingStartTime</code> and this time.
9048
- * For successful jobs and stopped jobs, this is the time after model artifacts are
9049
- * uploaded. For failed jobs, this is the time when SageMaker detects a job failure.</p>
9050
- */
9051
- TrainingEndTime?: Date;
9052
- /**
9053
- * <p>The
9054
- * status
9055
- * of the training job.</p>
9056
- */
9057
- TrainingJobStatus: TrainingJobStatus | string | undefined;
9058
- /**
9059
- * <p>A
9060
- * list of the hyperparameters for which you specified ranges to
9061
- * search.</p>
9062
- */
9063
- TunedHyperParameters: Record<string, string> | undefined;
9064
- /**
9065
- * <p>The
9066
- * reason that the training job failed.
9067
- * </p>
9068
- */
9069
- FailureReason?: string;
9070
- /**
9071
- * <p>The <a>FinalHyperParameterTuningJobObjectiveMetric</a> object that
9072
- * specifies the
9073
- * value
9074
- * of the
9075
- * objective
9076
- * metric of the tuning job that launched this training job.</p>
9077
- */
9078
- FinalHyperParameterTuningJobObjectiveMetric?: FinalHyperParameterTuningJobObjectiveMetric;
9079
- /**
9080
- * <p>The status of the objective metric for the training job:</p>
9081
- * <ul>
9082
- * <li>
9083
- * <p>Succeeded: The
9084
- * final
9085
- * objective metric for the training job was evaluated by the
9086
- * hyperparameter tuning job and
9087
- * used
9088
- * in the hyperparameter tuning process.</p>
9089
- * </li>
9090
- * </ul>
9091
- * <ul>
9092
- * <li>
9093
- * <p>Pending: The training job is in progress and evaluation of its final objective
9094
- * metric is pending.</p>
9095
- * </li>
9096
- * </ul>
9097
- * <ul>
9098
- * <li>
9099
- * <p>Failed:
9100
- * The final objective metric for the training job was not evaluated, and was not
9101
- * used in the hyperparameter tuning process. This typically occurs when the
9102
- * training job failed or did not emit an objective
9103
- * metric.</p>
9104
- * </li>
9105
- * </ul>
9106
- */
9107
- ObjectiveStatus?: ObjectiveStatus | string;
9108
- }
9109
- export declare namespace HyperParameterTrainingJobSummary {
9110
- /**
9111
- * @internal
9112
- */
9113
- const filterSensitiveLog: (obj: HyperParameterTrainingJobSummary) => any;
9114
- }
9115
- export declare enum HyperParameterTuningJobStatus {
9116
- COMPLETED = "Completed",
9117
- FAILED = "Failed",
9118
- IN_PROGRESS = "InProgress",
9119
- STOPPED = "Stopped",
9120
- STOPPING = "Stopping"
9121
- }
9122
- /**
9123
- * <p>Specifies the number of training jobs that this hyperparameter tuning job launched,
9124
- * categorized by the status of their objective metric. The objective metric status shows
9125
- * whether the
9126
- * final
9127
- * objective metric for the training job has been evaluated by the
9128
- * tuning job and used in the hyperparameter tuning process.</p>
9129
- */
9130
- export interface ObjectiveStatusCounters {
9131
- /**
9132
- * <p>The number of training jobs whose final objective metric was evaluated by the
9133
- * hyperparameter tuning job and used in the hyperparameter tuning process.</p>
9134
- */
9135
- Succeeded?: number;
9136
- /**
9137
- * <p>The number of training jobs that are in progress and pending evaluation of their final
9138
- * objective metric.</p>
9139
- */
9140
- Pending?: number;
9141
- /**
9142
- * <p>The number of training jobs whose final objective metric was not evaluated and used in
9143
- * the hyperparameter tuning process. This typically occurs when the training job failed or
9144
- * did not emit an objective metric.</p>
9145
- */
9146
- Failed?: number;
9147
- }
9148
- export declare namespace ObjectiveStatusCounters {
9149
- /**
9150
- * @internal
9151
- */
9152
- const filterSensitiveLog: (obj: ObjectiveStatusCounters) => any;
9153
- }
9154
- /**
9155
- * <p>The numbers of training jobs launched by a hyperparameter tuning job, categorized by
9156
- * status.</p>
9157
- */
9158
- export interface TrainingJobStatusCounters {
9159
- /**
9160
- * <p>The number of completed training jobs launched by the hyperparameter tuning
9161
- * job.</p>
9162
- */
9163
- Completed?: number;
9164
- /**
9165
- * <p>The number of in-progress training jobs launched by a hyperparameter tuning
9166
- * job.</p>
9167
- */
9168
- InProgress?: number;
9169
- /**
9170
- * <p>The number of training jobs that failed, but can be retried. A failed training job can
9171
- * be retried only if it failed because an internal service error occurred.</p>
9172
- */
9173
- RetryableError?: number;
9174
- /**
9175
- * <p>The number of training jobs that failed and can't be retried. A failed training job
9176
- * can't be retried if it failed because a client error occurred.</p>
9177
- */
9178
- NonRetryableError?: number;
9179
- /**
9180
- * <p>The number of training jobs launched by a hyperparameter tuning job that were
9181
- * manually
9182
- * stopped.</p>
9183
- */
9184
- Stopped?: number;
9185
- }
9186
- export declare namespace TrainingJobStatusCounters {
9187
- /**
9188
- * @internal
9189
- */
9190
- const filterSensitiveLog: (obj: TrainingJobStatusCounters) => any;
9191
- }
9192
- export interface DescribeHyperParameterTuningJobResponse {
9193
- /**
9194
- * <p>The name of the tuning job.</p>
9195
- */
9196
- HyperParameterTuningJobName: string | undefined;
9197
- /**
9198
- * <p>The
9199
- * Amazon Resource Name (ARN) of the tuning job.</p>
9200
- */
9201
- HyperParameterTuningJobArn: string | undefined;
9202
- /**
9203
- * <p>The <a>HyperParameterTuningJobConfig</a> object that specifies the
9204
- * configuration of the tuning job.</p>
9205
- */
9206
- HyperParameterTuningJobConfig: HyperParameterTuningJobConfig | undefined;
9207
- /**
9208
- * <p>The <a>HyperParameterTrainingJobDefinition</a> object that specifies the
9209
- * definition of the training jobs that this tuning job launches.</p>
9210
- */
9211
- TrainingJobDefinition?: HyperParameterTrainingJobDefinition;
9212
- /**
9213
- * <p>A list of the <a>HyperParameterTrainingJobDefinition</a> objects launched
9214
- * for this tuning job.</p>
9215
- */
9216
- TrainingJobDefinitions?: HyperParameterTrainingJobDefinition[];
9217
- /**
9218
- * <p>The status of the tuning job: InProgress, Completed, Failed, Stopping, or
9219
- * Stopped.</p>
9220
- */
9221
- HyperParameterTuningJobStatus: HyperParameterTuningJobStatus | string | undefined;
9222
- /**
9223
- * <p>The date and time that the tuning job started.</p>
9224
- */
9225
- CreationTime: Date | undefined;
9226
- /**
9227
- * <p>The date and time that the tuning job ended.</p>
9228
- */
9229
- HyperParameterTuningEndTime?: Date;
9230
- /**
9231
- * <p>The date and time that the status of the tuning job was modified. </p>
9232
- */
9233
- LastModifiedTime?: Date;
9234
- /**
9235
- * <p>The <a>TrainingJobStatusCounters</a> object that specifies the number of
9236
- * training jobs, categorized by status, that this tuning job launched.</p>
9237
- */
9238
- TrainingJobStatusCounters: TrainingJobStatusCounters | undefined;
9239
- /**
9240
- * <p>The <a>ObjectiveStatusCounters</a> object that specifies the number of
9241
- * training jobs, categorized by the status of their final objective metric, that this
9242
- * tuning job launched.</p>
9243
- */
9244
- ObjectiveStatusCounters: ObjectiveStatusCounters | undefined;
9245
- /**
9246
- * <p>A <a>TrainingJobSummary</a> object that describes the training job that
9247
- * completed with the best current <a>HyperParameterTuningJobObjective</a>.</p>
9248
- */
9249
- BestTrainingJob?: HyperParameterTrainingJobSummary;
9250
- /**
9251
- * <p>If the hyperparameter tuning job is an warm start tuning job with a
9252
- * <code>WarmStartType</code> of <code>IDENTICAL_DATA_AND_ALGORITHM</code>, this is the
9253
- * <a>TrainingJobSummary</a> for the training job with the best objective
9254
- * metric value of all training jobs launched by this tuning job and all parent jobs
9255
- * specified for the warm start tuning job.</p>
9256
- */
9257
- OverallBestTrainingJob?: HyperParameterTrainingJobSummary;
9258
- /**
9259
- * <p>The configuration for starting the hyperparameter parameter tuning job using one or
9260
- * more previous tuning jobs as a starting point. The results of previous tuning jobs are
9261
- * used to inform which combinations of hyperparameters to search over in the new tuning
9262
- * job.</p>
9263
- */
9264
- WarmStartConfig?: HyperParameterTuningJobWarmStartConfig;
9265
- /**
9266
- * <p>If the tuning job failed, the reason it failed.</p>
9267
- */
9268
- FailureReason?: string;
9269
- }
9270
- export declare namespace DescribeHyperParameterTuningJobResponse {
9271
- /**
9272
- * @internal
9273
- */
9274
- const filterSensitiveLog: (obj: DescribeHyperParameterTuningJobResponse) => any;
9275
- }
9276
- export interface DescribeImageRequest {
9277
- /**
9278
- * <p>The name of the image to describe.</p>
9279
- */
9280
- ImageName: string | undefined;
9281
- }
9282
- export declare namespace DescribeImageRequest {
9283
- /**
9284
- * @internal
9285
- */
9286
- const filterSensitiveLog: (obj: DescribeImageRequest) => any;
9287
- }
9288
- export declare enum ImageStatus {
9289
- CREATED = "CREATED",
9290
- CREATE_FAILED = "CREATE_FAILED",
9291
- CREATING = "CREATING",
9292
- DELETE_FAILED = "DELETE_FAILED",
9293
- DELETING = "DELETING",
9294
- UPDATE_FAILED = "UPDATE_FAILED",
9295
- UPDATING = "UPDATING"
9296
- }
9297
- export interface DescribeImageResponse {
9298
- /**
9299
- * <p>When the image was created.</p>
9300
- */
9301
- CreationTime?: Date;
9302
- /**
9303
- * <p>The description of the image.</p>
9304
- */
9305
- Description?: string;
9306
- /**
9307
- * <p>The name of the image as displayed.</p>
9308
- */
9309
- DisplayName?: string;
9310
- /**
9311
- * <p>When a create, update, or delete operation fails, the reason for the failure.</p>
9312
- */
9313
- FailureReason?: string;
9314
- /**
9315
- * <p>The Amazon Resource Name (ARN) of the image.</p>
9316
- */
9317
- ImageArn?: string;
9318
- /**
9319
- * <p>The name of the image.</p>
9320
- */
9321
- ImageName?: string;
9322
- /**
9323
- * <p>The status of the image.</p>
9324
- */
9325
- ImageStatus?: ImageStatus | string;
9326
- /**
9327
- * <p>When the image was last modified.</p>
9328
- */
9329
- LastModifiedTime?: Date;
9330
- /**
9331
- * <p>The Amazon Resource Name (ARN) of the IAM role that enables Amazon SageMaker to perform tasks on your behalf.</p>
9332
- */
9333
- RoleArn?: string;
9334
- }
9335
- export declare namespace DescribeImageResponse {
9336
- /**
9337
- * @internal
9338
- */
9339
- const filterSensitiveLog: (obj: DescribeImageResponse) => any;
9340
- }
9341
- export interface DescribeImageVersionRequest {
9342
- /**
9343
- * <p>The name of the image.</p>
9344
- */
9345
- ImageName: string | undefined;
9346
- /**
9347
- * <p>The version of the image. If not specified, the latest version is described.</p>
9348
- */
9349
- Version?: number;
9350
- }
9351
- export declare namespace DescribeImageVersionRequest {
9352
- /**
9353
- * @internal
9354
- */
9355
- const filterSensitiveLog: (obj: DescribeImageVersionRequest) => any;
9356
- }
9357
- export declare enum ImageVersionStatus {
9358
- CREATED = "CREATED",
9359
- CREATE_FAILED = "CREATE_FAILED",
9360
- CREATING = "CREATING",
9361
- DELETE_FAILED = "DELETE_FAILED",
9362
- DELETING = "DELETING"
9363
- }
9364
- export interface DescribeImageVersionResponse {
9365
- /**
9366
- * <p>The registry path of the container image on which this image version is based.</p>
9367
- */
9368
- BaseImage?: string;
9369
- /**
9370
- * <p>The registry path of the container image that contains this image version.</p>
9371
- */
9372
- ContainerImage?: string;
9373
- /**
9374
- * <p>When the version was created.</p>
9375
- */
9376
- CreationTime?: Date;
9377
- /**
9378
- * <p>When a create or delete operation fails, the reason for the failure.</p>
9379
- */
9380
- FailureReason?: string;
9381
- /**
9382
- * <p>The Amazon Resource Name (ARN) of the image the version is based on.</p>
9383
- */
9384
- ImageArn?: string;
9385
- /**
9386
- * <p>The ARN of the version.</p>
9387
- */
9388
- ImageVersionArn?: string;
9389
- /**
9390
- * <p>The status of the version.</p>
9391
- */
9392
- ImageVersionStatus?: ImageVersionStatus | string;
9393
- /**
9394
- * <p>When the version was last modified.</p>
9395
- */
9396
- LastModifiedTime?: Date;
9397
- /**
9398
- * <p>The version number.</p>
9399
- */
9400
- Version?: number;
9401
- }
9402
- export declare namespace DescribeImageVersionResponse {
9403
- /**
9404
- * @internal
9405
- */
9406
- const filterSensitiveLog: (obj: DescribeImageVersionResponse) => any;
9407
- }
9408
- export interface DescribeInferenceRecommendationsJobRequest {
9409
- /**
9410
- * <p>The name of the job. The name must be unique within an
9411
- * Amazon Web Services Region in the Amazon Web Services account.</p>
9412
- */
9413
- JobName: string | undefined;
9414
- }
9415
- export declare namespace DescribeInferenceRecommendationsJobRequest {
9416
- /**
9417
- * @internal
9418
- */
9419
- const filterSensitiveLog: (obj: DescribeInferenceRecommendationsJobRequest) => any;
9420
- }
9421
- /**
9422
- * <p>The endpoint configuration made by Inference Recommender during a recommendation job.</p>
9423
- */
9424
- export interface EndpointOutputConfiguration {
9425
- /**
9426
- * <p>The name of the endpoint made during a recommendation job.</p>
9427
- */
9428
- EndpointName: string | undefined;
9429
- /**
9430
- * <p>The name of the production variant (deployed model) made during a recommendation job.</p>
9431
- */
9432
- VariantName: string | undefined;
9433
- /**
9434
- * <p>The instance type recommended by Amazon SageMaker Inference Recommender.</p>
9435
- */
9436
- InstanceType: ProductionVariantInstanceType | string | undefined;
9437
- /**
9438
- * <p>The number of instances recommended to launch initially.</p>
9439
- */
9440
- InitialInstanceCount: number | undefined;
9441
- }
9442
- export declare namespace EndpointOutputConfiguration {
9443
- /**
9444
- * @internal
9445
- */
9446
- const filterSensitiveLog: (obj: EndpointOutputConfiguration) => any;
9447
- }