@aws-sdk/client-sagemaker 3.863.0 → 3.866.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 (74) hide show
  1. package/README.md +16 -0
  2. package/dist-cjs/index.js +582 -392
  3. package/dist-es/SageMaker.js +4 -0
  4. package/dist-es/commands/DescribeReservedCapacityCommand.js +22 -0
  5. package/dist-es/commands/ListUltraServersByReservedCapacityCommand.js +22 -0
  6. package/dist-es/commands/index.js +2 -0
  7. package/dist-es/models/models_0.js +1 -13
  8. package/dist-es/models/models_1.js +13 -0
  9. package/dist-es/models/models_3.js +22 -33
  10. package/dist-es/models/models_4.js +21 -14
  11. package/dist-es/models/models_5.js +12 -1
  12. package/dist-es/pagination/ListUltraServersByReservedCapacityPaginator.js +4 -0
  13. package/dist-es/pagination/index.js +1 -0
  14. package/dist-es/protocols/Aws_json1_1.js +140 -0
  15. package/dist-types/SageMaker.d.ts +14 -0
  16. package/dist-types/SageMakerClient.d.ts +4 -2
  17. package/dist-types/commands/AttachClusterNodeVolumeCommand.d.ts +1 -1
  18. package/dist-types/commands/CreateAlgorithmCommand.d.ts +12 -3
  19. package/dist-types/commands/CreateDomainCommand.d.ts +3 -0
  20. package/dist-types/commands/CreateHyperParameterTuningJobCommand.d.ts +26 -8
  21. package/dist-types/commands/CreateModelBiasJobDefinitionCommand.d.ts +1 -2
  22. package/dist-types/commands/CreateTrainingJobCommand.d.ts +11 -2
  23. package/dist-types/commands/CreateTrainingPlanCommand.d.ts +1 -0
  24. package/dist-types/commands/DescribeAlgorithmCommand.d.ts +12 -3
  25. package/dist-types/commands/DescribeAppCommand.d.ts +1 -0
  26. package/dist-types/commands/DescribeClusterNodeCommand.d.ts +3 -0
  27. package/dist-types/commands/DescribeCompilationJobCommand.d.ts +2 -1
  28. package/dist-types/commands/DescribeComputeQuotaCommand.d.ts +1 -1
  29. package/dist-types/commands/DescribeContextCommand.d.ts +1 -2
  30. package/dist-types/commands/DescribeDomainCommand.d.ts +3 -0
  31. package/dist-types/commands/DescribeHyperParameterTuningJobCommand.d.ts +26 -8
  32. package/dist-types/commands/DescribeReservedCapacityCommand.d.ts +93 -0
  33. package/dist-types/commands/DescribeTrainingJobCommand.d.ts +11 -2
  34. package/dist-types/commands/DescribeTrainingPlanCommand.d.ts +7 -1
  35. package/dist-types/commands/DetachClusterNodeVolumeCommand.d.ts +1 -1
  36. package/dist-types/commands/ListClusterNodesCommand.d.ts +3 -0
  37. package/dist-types/commands/ListTrainingPlansCommand.d.ts +5 -1
  38. package/dist-types/commands/ListUltraServersByReservedCapacityCommand.d.ts +92 -0
  39. package/dist-types/commands/ListWorkforcesCommand.d.ts +2 -1
  40. package/dist-types/commands/ListWorkteamsCommand.d.ts +1 -1
  41. package/dist-types/commands/SearchCommand.d.ts +26 -8
  42. package/dist-types/commands/SearchTrainingPlanOfferingsCommand.d.ts +7 -2
  43. package/dist-types/commands/UpdateDomainCommand.d.ts +3 -0
  44. package/dist-types/commands/index.d.ts +2 -0
  45. package/dist-types/models/models_0.d.ts +71 -87
  46. package/dist-types/models/models_1.d.ts +94 -106
  47. package/dist-types/models/models_2.d.ts +115 -202
  48. package/dist-types/models/models_3.d.ts +463 -409
  49. package/dist-types/models/models_4.d.ts +414 -683
  50. package/dist-types/models/models_5.d.ts +718 -5
  51. package/dist-types/pagination/ListUltraServersByReservedCapacityPaginator.d.ts +7 -0
  52. package/dist-types/pagination/index.d.ts +1 -0
  53. package/dist-types/protocols/Aws_json1_1.d.ts +18 -0
  54. package/dist-types/ts3.4/SageMaker.d.ts +40 -0
  55. package/dist-types/ts3.4/SageMakerClient.d.ts +12 -0
  56. package/dist-types/ts3.4/commands/CreateModelBiasJobDefinitionCommand.d.ts +4 -2
  57. package/dist-types/ts3.4/commands/DescribeCompilationJobCommand.d.ts +2 -4
  58. package/dist-types/ts3.4/commands/DescribeComputeQuotaCommand.d.ts +1 -1
  59. package/dist-types/ts3.4/commands/DescribeContextCommand.d.ts +4 -2
  60. package/dist-types/ts3.4/commands/DescribeReservedCapacityCommand.d.ts +51 -0
  61. package/dist-types/ts3.4/commands/ListUltraServersByReservedCapacityCommand.d.ts +51 -0
  62. package/dist-types/ts3.4/commands/ListWorkforcesCommand.d.ts +2 -4
  63. package/dist-types/ts3.4/commands/ListWorkteamsCommand.d.ts +1 -1
  64. package/dist-types/ts3.4/commands/index.d.ts +2 -0
  65. package/dist-types/ts3.4/models/models_0.d.ts +15 -25
  66. package/dist-types/ts3.4/models/models_1.d.ts +31 -25
  67. package/dist-types/ts3.4/models/models_2.d.ts +28 -53
  68. package/dist-types/ts3.4/models/models_3.d.ts +119 -104
  69. package/dist-types/ts3.4/models/models_4.d.ts +123 -190
  70. package/dist-types/ts3.4/models/models_5.d.ts +187 -5
  71. package/dist-types/ts3.4/pagination/ListUltraServersByReservedCapacityPaginator.d.ts +11 -0
  72. package/dist-types/ts3.4/pagination/index.d.ts +1 -0
  73. package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +24 -0
  74. package/package.json +5 -5
@@ -1,7 +1,312 @@
1
- import { ActionSummary, AdditionalInferenceSpecificationDefinition, AlgorithmSortBy, AlgorithmSummary, AppDetails, AppImageConfigDetails, AppImageConfigSortKey, AppSortKey, AppType, ArtifactSummary, AssociationEdgeType, AssociationSummary, AutoMLCandidate, AutoMLJobStatus, AutoMLJobStepMetadata, AutoMLJobSummary, AutoMLSortBy, AutoMLSortOrder, BatchDataCaptureConfig, BatchStrategy, BatchTransformInput, CacheHitResult, CallbackStepMetadata, CandidateSortBy, CandidateStatus, ClarifyCheckStepMetadata, ClusterEventResourceType, ClusterEventSummary, ClusterNodeSummary, ClusterSchedulerConfigSummary, ClusterSortBy, FeatureStatus, InferenceSpecification, ModelApprovalStatus, ModelPackageStatus, OutputParameter, SchedulerResourceStatus, Tag, TransformInput, TransformOutput, TransformResources, UserContext, VpcConfig } from "./models_0";
2
- import { _InstanceType, ClusterSummary, CodeRepositorySortBy, CodeRepositorySortOrder, CodeRepositorySummary, CompilationJobStatus, CompilationJobSummary, ComputeQuotaSummary, ConditionStepMetadata, ContainerDefinition, ContextSummary, HubContentType, InferenceExecutionConfig, InferenceExperimentSchedule, InferenceExperimentType, LabelingJobInputConfig, MetadataProperties, RecommendationJobType } from "./models_1";
3
- import { CrossAccountFilterOption, DataProcessing, DeploymentRecommendation, DriftCheckBaselines, ExperimentConfig, ModelCardSecurityConfig, ModelCardStatus, ModelClientConfig, ModelLifeCycle, ModelMetrics, ModelPackageModelCard, ModelPackageSecurityConfig, ModelPackageValidationSpecification, MonitoringScheduleConfig, MonitoringType, OptimizationJobDeploymentInstanceType, PartnerAppType, SharingType, SkipModelValidation, SourceAlgorithmSpecification, SpaceStorageSettings, StudioLifecycleConfigAppType, TrialComponentStatus } from "./models_2";
4
- import { DeviceDeploymentSummary, DeviceFleetSummary, DeviceSummary, DomainDetails, EdgeDeploymentPlanSummary, EdgePackagingJobStatus, EdgePackagingJobSummary, EMRStepMetadata, EndpointConfigSortKey, EndpointConfigStepMetadata, EndpointConfigSummary, EndpointOutputConfiguration, EndpointSortKey, EndpointStatus, EndpointStepMetadata, EndpointSummary, EventSortBy, ExecutionStatus, ExperimentSummary, FailStepMetadata, FeatureGroupSortBy, FeatureGroupSortOrder, FeatureGroupStatus, FeatureGroupSummary, FlowDefinitionSummary, HubContentInfo, HubContentSortBy, HubContentSupportStatus, HubInfo, HubSortBy, HumanTaskUiSummary, HyperParameterTrainingJobSummary, HyperParameterTuningJobSortByOptions, HyperParameterTuningJobStatus, HyperParameterTuningJobSummary, Image, ImageSortBy, ImageVersionStatus, InferenceComponentStatus, InferenceExperimentStatus, InferenceMetrics, IsTrackingServerActive, LabelCounters, LabelingJobOutput, LabelingJobStatus, ModelCardExportJobStatus, ModelConfiguration, ModelPackageGroupStatus, ModelPackageStatusDetails, MonitoringExecutionSummary, NotebookInstanceStatus, OfflineStoreStatusValue, OptimizationJobStatus, PartnerAppStatus, PipelineExecutionStatus, ProcessingJobStatus, ProjectStatus, RecommendationJobStatus, RecommendationMetrics, ReservedCapacitySummary, SageMakerResourceName, ScheduleStatus, SecondaryStatus, SpaceStatus, SubscribedWorkteam, TrackingServerStatus, TrainingJobStatus, TrainingPlanStatus, TransformJobStatus, TrialComponentSource, TrialSource, UserProfileStatus, WarmPoolResourceStatus, WarmPoolStatus, Workforce, Workteam } from "./models_3";
1
+ import { ActionSummary, AlgorithmSortBy, AlgorithmSummary, AppDetails, AppImageConfigDetails, AppImageConfigSortKey, AppSortKey, AppType, ArtifactSummary, AssociationEdgeType, AssociationSummary, AutoMLCandidate, AutoMLJobStatus, AutoMLJobStepMetadata, AutoMLJobSummary, AutoMLSortBy, AutoMLSortOrder, CacheHitResult, CallbackStepMetadata, CandidateSortBy, CandidateStatus, ClarifyCheckStepMetadata, ClusterEventResourceType, ClusterEventSummary, ClusterNodeSummary, FeatureStatus, ModelApprovalStatus, ModelPackageStatus, OutputParameter, SchedulerResourceStatus, Tag, UserContext } from "./models_0";
2
+ import { _InstanceType, ClusterSchedulerConfigSummary, ClusterSortBy, ClusterSummary, CodeRepositorySortBy, CodeRepositorySortOrder, CodeRepositorySummary, CompilationJobStatus, CompilationJobSummary, ComputeQuotaSummary, ConditionStepMetadata, ContextSummary, HubContentType, HyperParameterTrainingJobDefinition, HyperParameterTuningJobConfig, HyperParameterTuningJobStrategyType, HyperParameterTuningJobWarmStartConfig, InferenceExperimentSchedule, InferenceExperimentType, LabelingJobInputConfig, RecommendationJobType, ResourceLimits } from "./models_1";
3
+ import { CrossAccountFilterOption, ModelCardStatus, ModelLifeCycle, MonitoringType, OptimizationJobDeploymentInstanceType, PartnerAppType, SharingType, SpaceStorageSettings, StudioLifecycleConfigAppType, TrialComponentStatus } from "./models_2";
4
+ import { DeviceDeploymentSummary, DeviceFleetSummary, DeviceSummary, DomainDetails, EdgeDeploymentPlanSummary, EdgePackagingJobStatus, EdgePackagingJobSummary, EMRStepMetadata, EndpointConfigSortKey, EndpointConfigStepMetadata, EndpointConfigSummary, EndpointOutputConfiguration, EndpointSortKey, EndpointStatus, EndpointStepMetadata, EndpointSummary, EventSortBy, ExecutionStatus, ExperimentSummary, FailStepMetadata, FeatureGroupSortBy, FeatureGroupSortOrder, FeatureGroupStatus, FeatureGroupSummary, FlowDefinitionSummary, HubContentInfo, HubContentSortBy, HubContentSupportStatus, HubStatus, HyperParameterTrainingJobSummary, HyperParameterTuningJobCompletionDetails, HyperParameterTuningJobConsumedResources, HyperParameterTuningJobStatus, ImageStatus, ImageVersionStatus, InferenceComponentStatus, InferenceExperimentStatus, InferenceMetrics, IsTrackingServerActive, LabelCounters, LabelingJobOutput, LabelingJobStatus, ModelCardExportJobStatus, ModelConfiguration, ModelPackageGroupStatus, MonitoringExecutionSummary, NotebookInstanceStatus, ObjectiveStatusCounters, OfflineStoreStatusValue, OptimizationJobStatus, PartnerAppStatus, PipelineExecutionStatus, ProcessingJobStatus, ProjectStatus, RecommendationJobStatus, RecommendationMetrics, ReservedCapacityInstanceType, ReservedCapacitySummary, SageMakerResourceName, ScheduleStatus, SecondaryStatus, SpaceStatus, SubscribedWorkteam, TrackingServerStatus, TrainingJobStatus, TrainingJobStatusCounters, TrainingPlanStatus, TransformJobStatus, TrialComponentSource, TrialSource, UserProfileStatus, WarmPoolResourceStatus, WarmPoolStatus } from "./models_3";
5
+ /**
6
+ * <p>Information about a hub.</p>
7
+ * @public
8
+ */
9
+ export interface HubInfo {
10
+ /**
11
+ * <p>The name of the hub.</p>
12
+ * @public
13
+ */
14
+ HubName: string | undefined;
15
+ /**
16
+ * <p>The Amazon Resource Name (ARN) of the hub.</p>
17
+ * @public
18
+ */
19
+ HubArn: string | undefined;
20
+ /**
21
+ * <p>The display name of the hub.</p>
22
+ * @public
23
+ */
24
+ HubDisplayName?: string | undefined;
25
+ /**
26
+ * <p>A description of the hub.</p>
27
+ * @public
28
+ */
29
+ HubDescription?: string | undefined;
30
+ /**
31
+ * <p>The searchable keywords for the hub.</p>
32
+ * @public
33
+ */
34
+ HubSearchKeywords?: string[] | undefined;
35
+ /**
36
+ * <p>The status of the hub.</p>
37
+ * @public
38
+ */
39
+ HubStatus: HubStatus | undefined;
40
+ /**
41
+ * <p>The date and time that the hub was created.</p>
42
+ * @public
43
+ */
44
+ CreationTime: Date | undefined;
45
+ /**
46
+ * <p>The date and time that the hub was last modified.</p>
47
+ * @public
48
+ */
49
+ LastModifiedTime: Date | undefined;
50
+ }
51
+ /**
52
+ * @public
53
+ * @enum
54
+ */
55
+ export declare const HubSortBy: {
56
+ readonly ACCOUNT_ID_OWNER: "AccountIdOwner";
57
+ readonly CREATION_TIME: "CreationTime";
58
+ readonly HUB_NAME: "HubName";
59
+ readonly HUB_STATUS: "HubStatus";
60
+ };
61
+ /**
62
+ * @public
63
+ */
64
+ export type HubSortBy = (typeof HubSortBy)[keyof typeof HubSortBy];
65
+ /**
66
+ * <p>Container for human task user interface information.</p>
67
+ * @public
68
+ */
69
+ export interface HumanTaskUiSummary {
70
+ /**
71
+ * <p>The name of the human task user interface.</p>
72
+ * @public
73
+ */
74
+ HumanTaskUiName: string | undefined;
75
+ /**
76
+ * <p>The Amazon Resource Name (ARN) of the human task user interface.</p>
77
+ * @public
78
+ */
79
+ HumanTaskUiArn: string | undefined;
80
+ /**
81
+ * <p>A timestamp when SageMaker created the human task user interface.</p>
82
+ * @public
83
+ */
84
+ CreationTime: Date | undefined;
85
+ }
86
+ /**
87
+ * <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>
88
+ * @public
89
+ */
90
+ export interface HyperParameterTuningJobSearchEntity {
91
+ /**
92
+ * <p>The name of a hyperparameter tuning job.</p>
93
+ * @public
94
+ */
95
+ HyperParameterTuningJobName?: string | undefined;
96
+ /**
97
+ * <p>The Amazon Resource Name (ARN) of a hyperparameter tuning job.</p>
98
+ * @public
99
+ */
100
+ HyperParameterTuningJobArn?: string | undefined;
101
+ /**
102
+ * <p>Configures a hyperparameter tuning job.</p>
103
+ * @public
104
+ */
105
+ HyperParameterTuningJobConfig?: HyperParameterTuningJobConfig | undefined;
106
+ /**
107
+ * <p>Defines the training jobs launched by a hyperparameter tuning job.</p>
108
+ * @public
109
+ */
110
+ TrainingJobDefinition?: HyperParameterTrainingJobDefinition | undefined;
111
+ /**
112
+ * <p>The job definitions included in a hyperparameter tuning job.</p>
113
+ * @public
114
+ */
115
+ TrainingJobDefinitions?: HyperParameterTrainingJobDefinition[] | undefined;
116
+ /**
117
+ * <p>The status of a hyperparameter tuning job.</p>
118
+ * @public
119
+ */
120
+ HyperParameterTuningJobStatus?: HyperParameterTuningJobStatus | undefined;
121
+ /**
122
+ * <p>The time that a hyperparameter tuning job was created.</p>
123
+ * @public
124
+ */
125
+ CreationTime?: Date | undefined;
126
+ /**
127
+ * <p>The time that a hyperparameter tuning job ended.</p>
128
+ * @public
129
+ */
130
+ HyperParameterTuningEndTime?: Date | undefined;
131
+ /**
132
+ * <p>The time that a hyperparameter tuning job was last modified.</p>
133
+ * @public
134
+ */
135
+ LastModifiedTime?: Date | undefined;
136
+ /**
137
+ * <p>The numbers of training jobs launched by a hyperparameter tuning job, categorized by status.</p>
138
+ * @public
139
+ */
140
+ TrainingJobStatusCounters?: TrainingJobStatusCounters | undefined;
141
+ /**
142
+ * <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>
143
+ * @public
144
+ */
145
+ ObjectiveStatusCounters?: ObjectiveStatusCounters | undefined;
146
+ /**
147
+ * <p>The container for the summary information about a training job.</p>
148
+ * @public
149
+ */
150
+ BestTrainingJob?: HyperParameterTrainingJobSummary | undefined;
151
+ /**
152
+ * <p>The container for the summary information about a training job.</p>
153
+ * @public
154
+ */
155
+ OverallBestTrainingJob?: HyperParameterTrainingJobSummary | undefined;
156
+ /**
157
+ * <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>
158
+ * @public
159
+ */
160
+ WarmStartConfig?: HyperParameterTuningJobWarmStartConfig | undefined;
161
+ /**
162
+ * <p>The error that was created when a hyperparameter tuning job failed.</p>
163
+ * @public
164
+ */
165
+ FailureReason?: string | undefined;
166
+ /**
167
+ * <p>Information about either a current or completed hyperparameter tuning job.</p>
168
+ * @public
169
+ */
170
+ TuningJobCompletionDetails?: HyperParameterTuningJobCompletionDetails | undefined;
171
+ /**
172
+ * <p>The total amount of resources consumed by a hyperparameter tuning job.</p>
173
+ * @public
174
+ */
175
+ ConsumedResources?: HyperParameterTuningJobConsumedResources | undefined;
176
+ /**
177
+ * <p>The tags associated with a hyperparameter tuning job. For more information see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a>.</p>
178
+ * @public
179
+ */
180
+ Tags?: Tag[] | undefined;
181
+ }
182
+ /**
183
+ * @public
184
+ * @enum
185
+ */
186
+ export declare const HyperParameterTuningJobSortByOptions: {
187
+ readonly CreationTime: "CreationTime";
188
+ readonly Name: "Name";
189
+ readonly Status: "Status";
190
+ };
191
+ /**
192
+ * @public
193
+ */
194
+ export type HyperParameterTuningJobSortByOptions = (typeof HyperParameterTuningJobSortByOptions)[keyof typeof HyperParameterTuningJobSortByOptions];
195
+ /**
196
+ * <p>Provides summary information about a hyperparameter tuning job.</p>
197
+ * @public
198
+ */
199
+ export interface HyperParameterTuningJobSummary {
200
+ /**
201
+ * <p>The name of the tuning job.</p>
202
+ * @public
203
+ */
204
+ HyperParameterTuningJobName: string | undefined;
205
+ /**
206
+ * <p>The Amazon Resource Name (ARN) of the tuning job.</p>
207
+ * @public
208
+ */
209
+ HyperParameterTuningJobArn: string | undefined;
210
+ /**
211
+ * <p>The status of the tuning job.</p>
212
+ * @public
213
+ */
214
+ HyperParameterTuningJobStatus: HyperParameterTuningJobStatus | undefined;
215
+ /**
216
+ * <p>Specifies the search strategy hyperparameter tuning uses to choose which hyperparameters to evaluate at each iteration.</p>
217
+ * @public
218
+ */
219
+ Strategy: HyperParameterTuningJobStrategyType | undefined;
220
+ /**
221
+ * <p>The date and time that the tuning job was created.</p>
222
+ * @public
223
+ */
224
+ CreationTime: Date | undefined;
225
+ /**
226
+ * <p>The date and time that the tuning job ended.</p>
227
+ * @public
228
+ */
229
+ HyperParameterTuningEndTime?: Date | undefined;
230
+ /**
231
+ * <p>The date and time that the tuning job was modified.</p>
232
+ * @public
233
+ */
234
+ LastModifiedTime?: Date | undefined;
235
+ /**
236
+ * <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>
237
+ * @public
238
+ */
239
+ TrainingJobStatusCounters: TrainingJobStatusCounters | undefined;
240
+ /**
241
+ * <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>
242
+ * @public
243
+ */
244
+ ObjectiveStatusCounters: ObjectiveStatusCounters | undefined;
245
+ /**
246
+ * <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>
247
+ * @public
248
+ */
249
+ ResourceLimits?: ResourceLimits | undefined;
250
+ }
251
+ /**
252
+ * <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>
253
+ * @public
254
+ */
255
+ export interface Image {
256
+ /**
257
+ * <p>When the image was created.</p>
258
+ * @public
259
+ */
260
+ CreationTime: Date | undefined;
261
+ /**
262
+ * <p>The description of the image.</p>
263
+ * @public
264
+ */
265
+ Description?: string | undefined;
266
+ /**
267
+ * <p>The name of the image as displayed.</p>
268
+ * @public
269
+ */
270
+ DisplayName?: string | undefined;
271
+ /**
272
+ * <p>When a create, update, or delete operation fails, the reason for the failure.</p>
273
+ * @public
274
+ */
275
+ FailureReason?: string | undefined;
276
+ /**
277
+ * <p>The ARN of the image.</p>
278
+ * @public
279
+ */
280
+ ImageArn: string | undefined;
281
+ /**
282
+ * <p>The name of the image.</p>
283
+ * @public
284
+ */
285
+ ImageName: string | undefined;
286
+ /**
287
+ * <p>The status of the image.</p>
288
+ * @public
289
+ */
290
+ ImageStatus: ImageStatus | undefined;
291
+ /**
292
+ * <p>When the image was last modified.</p>
293
+ * @public
294
+ */
295
+ LastModifiedTime: Date | undefined;
296
+ }
297
+ /**
298
+ * @public
299
+ * @enum
300
+ */
301
+ export declare const ImageSortBy: {
302
+ readonly CREATION_TIME: "CREATION_TIME";
303
+ readonly IMAGE_NAME: "IMAGE_NAME";
304
+ readonly LAST_MODIFIED_TIME: "LAST_MODIFIED_TIME";
305
+ };
306
+ /**
307
+ * @public
308
+ */
309
+ export type ImageSortBy = (typeof ImageSortBy)[keyof typeof ImageSortBy];
5
310
  /**
6
311
  * @public
7
312
  * @enum
@@ -7302,6 +7607,11 @@ export interface TrainingPlanSummary {
7302
7607
  * @public
7303
7608
  */
7304
7609
  InUseInstanceCount?: number | undefined;
7610
+ /**
7611
+ * <p>The total number of UltraServers allocated to this training plan.</p>
7612
+ * @public
7613
+ */
7614
+ TotalUltraServerCount?: number | undefined;
7305
7615
  /**
7306
7616
  * <p>The target resources (e.g., training jobs, HyperPod clusters) 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>
7307
7617
  * @public
@@ -7685,826 +7995,247 @@ export interface ListTrialsResponse {
7685
7995
  */
7686
7996
  NextToken?: string | undefined;
7687
7997
  }
7998
+ /**
7999
+ * @public
8000
+ */
8001
+ export interface ListUltraServersByReservedCapacityRequest {
8002
+ /**
8003
+ * <p>The ARN of the reserved capacity to list UltraServers for.</p>
8004
+ * @public
8005
+ */
8006
+ ReservedCapacityArn: string | undefined;
8007
+ /**
8008
+ * <p>The maximum number of UltraServers to return in the response. The default value is 10.</p>
8009
+ * @public
8010
+ */
8011
+ MaxResults?: number | undefined;
8012
+ /**
8013
+ * <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>
8014
+ * @public
8015
+ */
8016
+ NextToken?: string | undefined;
8017
+ }
7688
8018
  /**
7689
8019
  * @public
7690
8020
  * @enum
7691
8021
  */
7692
- export declare const UserProfileSortKey: {
7693
- readonly CreationTime: "CreationTime";
7694
- readonly LastModifiedTime: "LastModifiedTime";
8022
+ export declare const UltraServerHealthStatus: {
8023
+ readonly IMPAIRED: "Impaired";
8024
+ readonly INSUFFICIENT_DATA: "Insufficient-Data";
8025
+ readonly OK: "OK";
7695
8026
  };
7696
8027
  /**
7697
8028
  * @public
7698
8029
  */
7699
- export type UserProfileSortKey = (typeof UserProfileSortKey)[keyof typeof UserProfileSortKey];
8030
+ export type UltraServerHealthStatus = (typeof UltraServerHealthStatus)[keyof typeof UltraServerHealthStatus];
7700
8031
  /**
8032
+ * <p>Represents a high-performance compute server used for distributed training in SageMaker AI. An UltraServer consists of multiple instances within a shared NVLink interconnect domain.</p>
7701
8033
  * @public
7702
8034
  */
7703
- export interface ListUserProfilesRequest {
8035
+ export interface UltraServer {
7704
8036
  /**
7705
- * <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>
8037
+ * <p>The unique identifier for the UltraServer.</p>
7706
8038
  * @public
7707
8039
  */
7708
- NextToken?: string | undefined;
8040
+ UltraServerId: string | undefined;
7709
8041
  /**
7710
- * <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>
8042
+ * <p>The type of UltraServer, such as ml.u-p6e-gb200x72.</p>
7711
8043
  * @public
7712
8044
  */
7713
- MaxResults?: number | undefined;
8045
+ UltraServerType: string | undefined;
7714
8046
  /**
7715
- * <p>The sort order for the results. The default is Ascending.</p>
8047
+ * <p>The name of the Availability Zone where the UltraServer is provisioned.</p>
7716
8048
  * @public
7717
8049
  */
7718
- SortOrder?: SortOrder | undefined;
8050
+ AvailabilityZone: string | undefined;
7719
8051
  /**
7720
- * <p>The parameter by which to sort the results. The default is CreationTime.</p>
8052
+ * <p>The Amazon EC2 instance type used in the UltraServer.</p>
7721
8053
  * @public
7722
8054
  */
7723
- SortBy?: UserProfileSortKey | undefined;
8055
+ InstanceType: ReservedCapacityInstanceType | undefined;
7724
8056
  /**
7725
- * <p>A parameter by which to filter the results.</p>
8057
+ * <p>The total number of instances in this UltraServer.</p>
7726
8058
  * @public
7727
8059
  */
7728
- DomainIdEquals?: string | undefined;
8060
+ TotalInstanceCount: number | undefined;
7729
8061
  /**
7730
- * <p>A parameter by which to filter the results.</p>
8062
+ * <p>The number of spare instances configured for this UltraServer to provide enhanced resiliency.</p>
7731
8063
  * @public
7732
8064
  */
7733
- UserProfileNameContains?: string | undefined;
7734
- }
7735
- /**
7736
- * <p>The user profile details.</p>
7737
- * @public
7738
- */
7739
- export interface UserProfileDetails {
8065
+ ConfiguredSpareInstanceCount?: number | undefined;
7740
8066
  /**
7741
- * <p>The domain ID.</p>
8067
+ * <p>The number of instances currently available for use in this UltraServer.</p>
7742
8068
  * @public
7743
8069
  */
7744
- DomainId?: string | undefined;
7745
- /**
7746
- * <p>The user profile name.</p>
7747
- * @public
7748
- */
7749
- UserProfileName?: string | undefined;
7750
- /**
7751
- * <p>The status.</p>
7752
- * @public
7753
- */
7754
- Status?: UserProfileStatus | undefined;
8070
+ AvailableInstanceCount?: number | undefined;
7755
8071
  /**
7756
- * <p>The creation time.</p>
8072
+ * <p>The number of instances currently in use in this UltraServer.</p>
7757
8073
  * @public
7758
8074
  */
7759
- CreationTime?: Date | undefined;
8075
+ InUseInstanceCount?: number | undefined;
7760
8076
  /**
7761
- * <p>The last modified time.</p>
8077
+ * <p>The number of available spare instances in the UltraServer.</p>
7762
8078
  * @public
7763
8079
  */
7764
- LastModifiedTime?: Date | undefined;
7765
- }
7766
- /**
7767
- * @public
7768
- */
7769
- export interface ListUserProfilesResponse {
8080
+ AvailableSpareInstanceCount?: number | undefined;
7770
8081
  /**
7771
- * <p>The list of user profiles.</p>
8082
+ * <p>The number of instances in this UltraServer that are currently in an unhealthy state.</p>
7772
8083
  * @public
7773
8084
  */
7774
- UserProfiles?: UserProfileDetails[] | undefined;
8085
+ UnhealthyInstanceCount?: number | undefined;
7775
8086
  /**
7776
- * <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>
8087
+ * <p>The overall health status of the UltraServer.</p>
7777
8088
  * @public
7778
8089
  */
7779
- NextToken?: string | undefined;
8090
+ HealthStatus?: UltraServerHealthStatus | undefined;
7780
8091
  }
7781
- /**
7782
- * @public
7783
- * @enum
7784
- */
7785
- export declare const ListWorkforcesSortByOptions: {
7786
- readonly CreateDate: "CreateDate";
7787
- readonly Name: "Name";
7788
- };
7789
- /**
7790
- * @public
7791
- */
7792
- export type ListWorkforcesSortByOptions = (typeof ListWorkforcesSortByOptions)[keyof typeof ListWorkforcesSortByOptions];
7793
8092
  /**
7794
8093
  * @public
7795
8094
  */
7796
- export interface ListWorkforcesRequest {
7797
- /**
7798
- * <p>Sort workforces using the workforce name or creation date.</p>
7799
- * @public
7800
- */
7801
- SortBy?: ListWorkforcesSortByOptions | undefined;
7802
- /**
7803
- * <p>Sort workforces in ascending or descending order.</p>
7804
- * @public
7805
- */
7806
- SortOrder?: SortOrder | undefined;
8095
+ export interface ListUltraServersByReservedCapacityResponse {
7807
8096
  /**
7808
- * <p>A filter you can use to search for workforces using part of the workforce name.</p>
7809
- * @public
7810
- */
7811
- NameContains?: string | undefined;
7812
- /**
7813
- * <p>A token to resume pagination.</p>
8097
+ * <p>If the response is truncated, SageMaker returns this token. Use it in the next request to retrieve the next set of UltraServers.</p>
7814
8098
  * @public
7815
8099
  */
7816
8100
  NextToken?: string | undefined;
7817
8101
  /**
7818
- * <p>The maximum number of workforces returned in the response.</p>
7819
- * @public
7820
- */
7821
- MaxResults?: number | undefined;
7822
- }
7823
- /**
7824
- * @public
7825
- */
7826
- export interface ListWorkforcesResponse {
7827
- /**
7828
- * <p>A list containing information about your workforce.</p>
7829
- * @public
7830
- */
7831
- Workforces: Workforce[] | undefined;
7832
- /**
7833
- * <p>A token to resume pagination.</p>
8102
+ * <p>A list of UltraServers that are part of the specified reserved capacity.</p>
7834
8103
  * @public
7835
8104
  */
7836
- NextToken?: string | undefined;
8105
+ UltraServers: UltraServer[] | undefined;
7837
8106
  }
7838
8107
  /**
7839
8108
  * @public
7840
8109
  * @enum
7841
8110
  */
7842
- export declare const ListWorkteamsSortByOptions: {
7843
- readonly CreateDate: "CreateDate";
7844
- readonly Name: "Name";
8111
+ export declare const UserProfileSortKey: {
8112
+ readonly CreationTime: "CreationTime";
8113
+ readonly LastModifiedTime: "LastModifiedTime";
7845
8114
  };
7846
8115
  /**
7847
8116
  * @public
7848
8117
  */
7849
- export type ListWorkteamsSortByOptions = (typeof ListWorkteamsSortByOptions)[keyof typeof ListWorkteamsSortByOptions];
8118
+ export type UserProfileSortKey = (typeof UserProfileSortKey)[keyof typeof UserProfileSortKey];
7850
8119
  /**
7851
8120
  * @public
7852
8121
  */
7853
- export interface ListWorkteamsRequest {
7854
- /**
7855
- * <p>The field to sort results by. The default is <code>CreationTime</code>.</p>
7856
- * @public
7857
- */
7858
- SortBy?: ListWorkteamsSortByOptions | undefined;
7859
- /**
7860
- * <p>The sort order for results. The default is <code>Ascending</code>.</p>
7861
- * @public
7862
- */
7863
- SortOrder?: SortOrder | undefined;
7864
- /**
7865
- * <p>A string in the work team's name. This filter returns only work teams whose name contains the specified string.</p>
7866
- * @public
7867
- */
7868
- NameContains?: string | undefined;
8122
+ export interface ListUserProfilesRequest {
7869
8123
  /**
7870
- * <p>If the result of the previous <code>ListWorkteams</code> request was truncated, the response includes a <code>NextToken</code>. To retrieve the next set of labeling jobs, use the token in the next request.</p>
8124
+ * <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>
7871
8125
  * @public
7872
8126
  */
7873
8127
  NextToken?: string | undefined;
7874
8128
  /**
7875
- * <p>The maximum number of work teams to return in each page of the response.</p>
8129
+ * <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>
7876
8130
  * @public
7877
8131
  */
7878
8132
  MaxResults?: number | undefined;
7879
- }
7880
- /**
7881
- * @public
7882
- */
7883
- export interface ListWorkteamsResponse {
7884
- /**
7885
- * <p>An array of <code>Workteam</code> objects, each describing a work team.</p>
7886
- * @public
7887
- */
7888
- Workteams: Workteam[] | undefined;
7889
- /**
7890
- * <p>If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of work teams, use it in the subsequent request.</p>
7891
- * @public
7892
- */
7893
- NextToken?: string | undefined;
7894
- }
7895
- /**
7896
- * <p>The properties of a model as returned by the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html">Search</a> API.</p>
7897
- * @public
7898
- */
7899
- export interface Model {
7900
- /**
7901
- * <p>The name of the model.</p>
7902
- * @public
7903
- */
7904
- ModelName?: string | undefined;
7905
- /**
7906
- * <p>Describes the container, as part of model definition.</p>
7907
- * @public
7908
- */
7909
- PrimaryContainer?: ContainerDefinition | undefined;
7910
- /**
7911
- * <p>The containers in the inference pipeline.</p>
7912
- * @public
7913
- */
7914
- Containers?: ContainerDefinition[] | undefined;
7915
- /**
7916
- * <p>Specifies details about how containers in a multi-container endpoint are run.</p>
7917
- * @public
7918
- */
7919
- InferenceExecutionConfig?: InferenceExecutionConfig | undefined;
7920
- /**
7921
- * <p>The Amazon Resource Name (ARN) of the IAM role that you specified for the model.</p>
7922
- * @public
7923
- */
7924
- ExecutionRoleArn?: string | undefined;
7925
- /**
7926
- * <p>Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources have access to. You can control access to and from your resources by configuring a VPC. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/infrastructure-give-access.html">Give SageMaker Access to Resources in your Amazon VPC</a>. </p>
7927
- * @public
7928
- */
7929
- VpcConfig?: VpcConfig | undefined;
7930
8133
  /**
7931
- * <p>A timestamp that indicates when the model was created.</p>
7932
- * @public
7933
- */
7934
- CreationTime?: Date | undefined;
7935
- /**
7936
- * <p>The Amazon Resource Name (ARN) of the model.</p>
8134
+ * <p>The sort order for the results. The default is Ascending.</p>
7937
8135
  * @public
7938
8136
  */
7939
- ModelArn?: string | undefined;
8137
+ SortOrder?: SortOrder | undefined;
7940
8138
  /**
7941
- * <p>Isolates the model container. No inbound or outbound network calls can be made to or from the model container.</p>
8139
+ * <p>The parameter by which to sort the results. The default is CreationTime.</p>
7942
8140
  * @public
7943
8141
  */
7944
- EnableNetworkIsolation?: boolean | undefined;
8142
+ SortBy?: UserProfileSortKey | undefined;
7945
8143
  /**
7946
- * <p>A list of key-value pairs associated with the model. 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>
8144
+ * <p>A parameter by which to filter the results.</p>
7947
8145
  * @public
7948
8146
  */
7949
- Tags?: Tag[] | undefined;
8147
+ DomainIdEquals?: string | undefined;
7950
8148
  /**
7951
- * <p>A set of recommended deployment configurations for the model.</p>
8149
+ * <p>A parameter by which to filter the results.</p>
7952
8150
  * @public
7953
8151
  */
7954
- DeploymentRecommendation?: DeploymentRecommendation | undefined;
8152
+ UserProfileNameContains?: string | undefined;
7955
8153
  }
7956
8154
  /**
7957
- * <p>An Amazon SageMaker Model Card.</p>
8155
+ * <p>The user profile details.</p>
7958
8156
  * @public
7959
8157
  */
7960
- export interface ModelCard {
7961
- /**
7962
- * <p>The Amazon Resource Name (ARN) of the model card.</p>
7963
- * @public
7964
- */
7965
- ModelCardArn?: string | undefined;
7966
- /**
7967
- * <p>The unique name of the model card.</p>
7968
- * @public
7969
- */
7970
- ModelCardName?: string | undefined;
7971
- /**
7972
- * <p>The version of the model card.</p>
7973
- * @public
7974
- */
7975
- ModelCardVersion?: number | undefined;
8158
+ export interface UserProfileDetails {
7976
8159
  /**
7977
- * <p>The content of the model card. Content uses the <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/model-cards.html#model-cards-json-schema">model card JSON schema</a> and provided as a string.</p>
8160
+ * <p>The domain ID.</p>
7978
8161
  * @public
7979
8162
  */
7980
- Content?: string | undefined;
8163
+ DomainId?: string | undefined;
7981
8164
  /**
7982
- * <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>
8165
+ * <p>The user profile name.</p>
7983
8166
  * @public
7984
8167
  */
7985
- ModelCardStatus?: ModelCardStatus | undefined;
8168
+ UserProfileName?: string | undefined;
7986
8169
  /**
7987
- * <p>The security configuration used to protect model card data.</p>
8170
+ * <p>The status.</p>
7988
8171
  * @public
7989
8172
  */
7990
- SecurityConfig?: ModelCardSecurityConfig | undefined;
8173
+ Status?: UserProfileStatus | undefined;
7991
8174
  /**
7992
- * <p>The date and time that the model card was created.</p>
8175
+ * <p>The creation time.</p>
7993
8176
  * @public
7994
8177
  */
7995
8178
  CreationTime?: Date | undefined;
7996
8179
  /**
7997
- * <p>Information about the user who created or modified a SageMaker resource.</p>
7998
- * @public
7999
- */
8000
- CreatedBy?: UserContext | undefined;
8001
- /**
8002
- * <p>The date and time that the model card was last modified.</p>
8180
+ * <p>The last modified time.</p>
8003
8181
  * @public
8004
8182
  */
8005
8183
  LastModifiedTime?: Date | undefined;
8006
- /**
8007
- * <p>Information about the user who created or modified a SageMaker resource.</p>
8008
- * @public
8009
- */
8010
- LastModifiedBy?: UserContext | undefined;
8011
- /**
8012
- * <p>Key-value pairs used to manage metadata for the model card.</p>
8013
- * @public
8014
- */
8015
- Tags?: Tag[] | undefined;
8016
- /**
8017
- * <p>The unique name (ID) of the model.</p>
8018
- * @public
8019
- */
8020
- ModelId?: string | undefined;
8021
- /**
8022
- * <p>The risk rating of the model. Different organizations might have different criteria for model card risk ratings. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/model-cards-risk-rating.html">Risk ratings</a>.</p>
8023
- * @public
8024
- */
8025
- RiskRating?: string | undefined;
8026
- /**
8027
- * <p>The model package group that contains the model package. Only relevant for model cards created for model packages in the Amazon SageMaker Model Registry. </p>
8028
- * @public
8029
- */
8030
- ModelPackageGroupName?: string | undefined;
8031
- }
8032
- /**
8033
- * <p>An endpoint that hosts a model displayed in the Amazon SageMaker Model Dashboard.</p>
8034
- * @public
8035
- */
8036
- export interface ModelDashboardEndpoint {
8037
- /**
8038
- * <p>The endpoint name.</p>
8039
- * @public
8040
- */
8041
- EndpointName: string | undefined;
8042
- /**
8043
- * <p>The Amazon Resource Name (ARN) of the endpoint.</p>
8044
- * @public
8045
- */
8046
- EndpointArn: string | undefined;
8047
- /**
8048
- * <p>A timestamp that indicates when the endpoint was created.</p>
8049
- * @public
8050
- */
8051
- CreationTime: Date | undefined;
8052
- /**
8053
- * <p>The last time the endpoint was modified.</p>
8054
- * @public
8055
- */
8056
- LastModifiedTime: Date | undefined;
8057
- /**
8058
- * <p>The endpoint status.</p>
8059
- * @public
8060
- */
8061
- EndpointStatus: EndpointStatus | undefined;
8062
- }
8063
- /**
8064
- * <p>A batch transform job. For information about SageMaker batch transform, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/batch-transform.html">Use Batch Transform</a>.</p>
8065
- * @public
8066
- */
8067
- export interface TransformJob {
8068
- /**
8069
- * <p>The name of the transform job.</p>
8070
- * @public
8071
- */
8072
- TransformJobName?: string | undefined;
8073
- /**
8074
- * <p>The Amazon Resource Name (ARN) of the transform job.</p>
8075
- * @public
8076
- */
8077
- TransformJobArn?: string | undefined;
8078
- /**
8079
- * <p>The status of the transform job.</p> <p>Transform job statuses are:</p> <ul> <li> <p> <code>InProgress</code> - The job is in progress.</p> </li> <li> <p> <code>Completed</code> - The job has completed.</p> </li> <li> <p> <code>Failed</code> - The transform job has failed. To see the reason for the failure, see the <code>FailureReason</code> field in the response to a <code>DescribeTransformJob</code> call.</p> </li> <li> <p> <code>Stopping</code> - The transform job is stopping.</p> </li> <li> <p> <code>Stopped</code> - The transform job has stopped.</p> </li> </ul>
8080
- * @public
8081
- */
8082
- TransformJobStatus?: TransformJobStatus | undefined;
8083
- /**
8084
- * <p>If the transform job failed, the reason it failed.</p>
8085
- * @public
8086
- */
8087
- FailureReason?: string | undefined;
8088
- /**
8089
- * <p>The name of the model associated with the transform job.</p>
8090
- * @public
8091
- */
8092
- ModelName?: string | undefined;
8093
- /**
8094
- * <p>The maximum number of parallel requests that can be sent to each instance in a transform job. If <code>MaxConcurrentTransforms</code> is set to 0 or left unset, SageMaker checks the optional execution-parameters to determine the settings for your chosen algorithm. If the execution-parameters endpoint is not enabled, the default value is 1. For built-in algorithms, you don't need to set a value for <code>MaxConcurrentTransforms</code>.</p>
8095
- * @public
8096
- */
8097
- MaxConcurrentTransforms?: number | undefined;
8098
- /**
8099
- * <p>Configures the timeout and maximum number of retries for processing a transform job invocation.</p>
8100
- * @public
8101
- */
8102
- ModelClientConfig?: ModelClientConfig | undefined;
8103
- /**
8104
- * <p>The maximum allowed size of the payload, in MB. A payload is the data portion of a record (without metadata). The value in <code>MaxPayloadInMB</code> must be greater than, or equal to, the size of a single record. To estimate the size of a record in MB, divide the size of your dataset by the number of records. To ensure that the records fit within the maximum payload size, we recommend using a slightly larger value. The default value is 6 MB. For cases where the payload might be arbitrarily large and is transmitted using HTTP chunked encoding, set the value to 0. This feature works only in supported algorithms. Currently, SageMaker built-in algorithms do not support HTTP chunked encoding.</p>
8105
- * @public
8106
- */
8107
- MaxPayloadInMB?: number | undefined;
8108
- /**
8109
- * <p>Specifies the number of records to include in a mini-batch for an HTTP inference request. A record 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>
8110
- * @public
8111
- */
8112
- BatchStrategy?: BatchStrategy | undefined;
8113
- /**
8114
- * <p>The environment variables to set in the Docker container. We support up to 16 key and values entries in the map.</p>
8115
- * @public
8116
- */
8117
- Environment?: Record<string, string> | undefined;
8118
- /**
8119
- * <p>Describes the input source of a transform job and the way the transform job consumes it.</p>
8120
- * @public
8121
- */
8122
- TransformInput?: TransformInput | undefined;
8123
- /**
8124
- * <p>Describes the results of a transform job.</p>
8125
- * @public
8126
- */
8127
- TransformOutput?: TransformOutput | undefined;
8128
- /**
8129
- * <p>Configuration to control how SageMaker captures inference data for batch transform jobs.</p>
8130
- * @public
8131
- */
8132
- DataCaptureConfig?: BatchDataCaptureConfig | undefined;
8133
- /**
8134
- * <p>Describes the resources, including ML instance types and ML instance count, to use for transform job.</p>
8135
- * @public
8136
- */
8137
- TransformResources?: TransformResources | undefined;
8138
- /**
8139
- * <p>A timestamp that shows when the transform Job was created.</p>
8140
- * @public
8141
- */
8142
- CreationTime?: Date | undefined;
8143
- /**
8144
- * <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>
8145
- * @public
8146
- */
8147
- TransformStartTime?: Date | undefined;
8148
- /**
8149
- * <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>
8150
- * @public
8151
- */
8152
- TransformEndTime?: Date | undefined;
8153
- /**
8154
- * <p>The Amazon Resource Name (ARN) of the labeling job that created the transform job.</p>
8155
- * @public
8156
- */
8157
- LabelingJobArn?: string | undefined;
8158
- /**
8159
- * <p>The Amazon Resource Name (ARN) of the AutoML job that created the transform job.</p>
8160
- * @public
8161
- */
8162
- AutoMLJobArn?: string | undefined;
8163
- /**
8164
- * <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>
8165
- * @public
8166
- */
8167
- DataProcessing?: DataProcessing | undefined;
8168
- /**
8169
- * <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>
8170
- * @public
8171
- */
8172
- ExperimentConfig?: ExperimentConfig | undefined;
8173
- /**
8174
- * <p>A list of tags associated with the transform job.</p>
8175
- * @public
8176
- */
8177
- Tags?: Tag[] | undefined;
8178
8184
  }
8179
8185
  /**
8180
- * <p>The model card for a model displayed in the Amazon SageMaker Model Dashboard.</p>
8181
8186
  * @public
8182
8187
  */
8183
- export interface ModelDashboardModelCard {
8184
- /**
8185
- * <p>The Amazon Resource Name (ARN) for a model card.</p>
8186
- * @public
8187
- */
8188
- ModelCardArn?: string | undefined;
8189
- /**
8190
- * <p>The name of a model card.</p>
8191
- * @public
8192
- */
8193
- ModelCardName?: string | undefined;
8194
- /**
8195
- * <p>The model card version.</p>
8196
- * @public
8197
- */
8198
- ModelCardVersion?: number | undefined;
8199
- /**
8200
- * <p>The model card status.</p>
8201
- * @public
8202
- */
8203
- ModelCardStatus?: ModelCardStatus | undefined;
8204
- /**
8205
- * <p>The KMS Key ID (<code>KMSKeyId</code>) for encryption of model card information.</p>
8206
- * @public
8207
- */
8208
- SecurityConfig?: ModelCardSecurityConfig | undefined;
8209
- /**
8210
- * <p>A timestamp that indicates when the model card was created.</p>
8211
- * @public
8212
- */
8213
- CreationTime?: Date | undefined;
8214
- /**
8215
- * <p>Information about the user who created or modified a SageMaker resource.</p>
8216
- * @public
8217
- */
8218
- CreatedBy?: UserContext | undefined;
8219
- /**
8220
- * <p>A timestamp that indicates when the model card was last updated.</p>
8221
- * @public
8222
- */
8223
- LastModifiedTime?: Date | undefined;
8224
- /**
8225
- * <p>Information about the user who created or modified a SageMaker resource.</p>
8226
- * @public
8227
- */
8228
- LastModifiedBy?: UserContext | undefined;
8229
- /**
8230
- * <p>The tags associated with a model card.</p>
8231
- * @public
8232
- */
8233
- Tags?: Tag[] | undefined;
8188
+ export interface ListUserProfilesResponse {
8234
8189
  /**
8235
- * <p>For models created in SageMaker, this is the model ARN. For models created outside of SageMaker, this is a user-customized string.</p>
8190
+ * <p>The list of user profiles.</p>
8236
8191
  * @public
8237
8192
  */
8238
- ModelId?: string | undefined;
8193
+ UserProfiles?: UserProfileDetails[] | undefined;
8239
8194
  /**
8240
- * <p>A model card's risk rating. Can be low, medium, or high.</p>
8195
+ * <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>
8241
8196
  * @public
8242
8197
  */
8243
- RiskRating?: string | undefined;
8198
+ NextToken?: string | undefined;
8244
8199
  }
8245
8200
  /**
8246
- * <p>A monitoring schedule for a model displayed in the Amazon SageMaker Model Dashboard.</p>
8247
8201
  * @public
8202
+ * @enum
8248
8203
  */
8249
- export interface ModelDashboardMonitoringSchedule {
8250
- /**
8251
- * <p>The Amazon Resource Name (ARN) of a monitoring schedule.</p>
8252
- * @public
8253
- */
8254
- MonitoringScheduleArn?: string | undefined;
8255
- /**
8256
- * <p>The name of a monitoring schedule.</p>
8257
- * @public
8258
- */
8259
- MonitoringScheduleName?: string | undefined;
8260
- /**
8261
- * <p>The status of the monitoring schedule.</p>
8262
- * @public
8263
- */
8264
- MonitoringScheduleStatus?: ScheduleStatus | undefined;
8265
- /**
8266
- * <p>The monitor type of a model monitor.</p>
8267
- * @public
8268
- */
8269
- MonitoringType?: MonitoringType | undefined;
8270
- /**
8271
- * <p>If a monitoring job failed, provides the reason.</p>
8272
- * @public
8273
- */
8274
- FailureReason?: string | undefined;
8275
- /**
8276
- * <p>A timestamp that indicates when the monitoring schedule was created.</p>
8277
- * @public
8278
- */
8279
- CreationTime?: Date | undefined;
8280
- /**
8281
- * <p>A timestamp that indicates when the monitoring schedule was last updated.</p>
8282
- * @public
8283
- */
8284
- LastModifiedTime?: Date | undefined;
8285
- /**
8286
- * <p>Configures the monitoring schedule and defines the monitoring job.</p>
8287
- * @public
8288
- */
8289
- MonitoringScheduleConfig?: MonitoringScheduleConfig | undefined;
8290
- /**
8291
- * <p>The endpoint which is monitored.</p>
8292
- * @public
8293
- */
8294
- EndpointName?: string | undefined;
8295
- /**
8296
- * <p>A JSON array where each element is a summary for a monitoring alert.</p>
8297
- * @public
8298
- */
8299
- MonitoringAlertSummaries?: MonitoringAlertSummary[] | undefined;
8300
- /**
8301
- * <p>Summary of information about the last monitoring job to run.</p>
8302
- * @public
8303
- */
8304
- LastMonitoringExecutionSummary?: MonitoringExecutionSummary | undefined;
8305
- /**
8306
- * <p>Input object for the batch transform job.</p>
8307
- * @public
8308
- */
8309
- BatchTransformInput?: BatchTransformInput | undefined;
8310
- }
8204
+ export declare const ListWorkforcesSortByOptions: {
8205
+ readonly CreateDate: "CreateDate";
8206
+ readonly Name: "Name";
8207
+ };
8311
8208
  /**
8312
- * <p>A model displayed in the Amazon SageMaker Model Dashboard.</p>
8313
8209
  * @public
8314
8210
  */
8315
- export interface ModelDashboardModel {
8316
- /**
8317
- * <p>A model displayed in the Model Dashboard.</p>
8318
- * @public
8319
- */
8320
- Model?: Model | undefined;
8321
- /**
8322
- * <p>The endpoints that host a model.</p>
8323
- * @public
8324
- */
8325
- Endpoints?: ModelDashboardEndpoint[] | undefined;
8326
- /**
8327
- * <p>A batch transform job. For information about SageMaker batch transform, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/batch-transform.html">Use Batch Transform</a>.</p>
8328
- * @public
8329
- */
8330
- LastBatchTransformJob?: TransformJob | undefined;
8331
- /**
8332
- * <p>The monitoring schedules for a model.</p>
8333
- * @public
8334
- */
8335
- MonitoringSchedules?: ModelDashboardMonitoringSchedule[] | undefined;
8336
- /**
8337
- * <p>The model card for a model.</p>
8338
- * @public
8339
- */
8340
- ModelCard?: ModelDashboardModelCard | undefined;
8341
- }
8211
+ export type ListWorkforcesSortByOptions = (typeof ListWorkforcesSortByOptions)[keyof typeof ListWorkforcesSortByOptions];
8342
8212
  /**
8343
- * <p>A container for your trained model that can be deployed for SageMaker inference. This can include inference code, artifacts, and metadata. The model package type can be one of the following.</p> <ul> <li> <p>Versioned model: A part of a model package group in Model Registry.</p> </li> <li> <p>Unversioned model: Not part of a model package group and used in Amazon Web Services Marketplace.</p> </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateModelPackage.html"> <code>CreateModelPackage</code> </a>.</p>
8344
8213
  * @public
8345
8214
  */
8346
- export interface ModelPackage {
8347
- /**
8348
- * <p>The name of the model package. The name can be as follows:</p> <ul> <li> <p>For a versioned model, the name is automatically generated by SageMaker Model Registry and follows the format '<code>ModelPackageGroupName/ModelPackageVersion</code>'.</p> </li> <li> <p>For an unversioned model, you must provide the name.</p> </li> </ul>
8349
- * @public
8350
- */
8351
- ModelPackageName?: string | undefined;
8352
- /**
8353
- * <p>The model group to which the model belongs.</p>
8354
- * @public
8355
- */
8356
- ModelPackageGroupName?: string | undefined;
8357
- /**
8358
- * <p>The version number of a versioned model.</p>
8359
- * @public
8360
- */
8361
- ModelPackageVersion?: number | undefined;
8362
- /**
8363
- * <p>The Amazon Resource Name (ARN) of the model package.</p>
8364
- * @public
8365
- */
8366
- ModelPackageArn?: string | undefined;
8367
- /**
8368
- * <p>The description of the model package.</p>
8369
- * @public
8370
- */
8371
- ModelPackageDescription?: string | undefined;
8372
- /**
8373
- * <p>The time that the model package was created.</p>
8374
- * @public
8375
- */
8376
- CreationTime?: Date | undefined;
8377
- /**
8378
- * <p>Defines how to perform inference generation after a training job is run.</p>
8379
- * @public
8380
- */
8381
- InferenceSpecification?: InferenceSpecification | undefined;
8382
- /**
8383
- * <p>A list of algorithms that were used to create a model package.</p>
8384
- * @public
8385
- */
8386
- SourceAlgorithmSpecification?: SourceAlgorithmSpecification | undefined;
8387
- /**
8388
- * <p>Specifies batch transform jobs that SageMaker runs to validate your model package.</p>
8389
- * @public
8390
- */
8391
- ValidationSpecification?: ModelPackageValidationSpecification | undefined;
8392
- /**
8393
- * <p>The status of the model package. This can be one of the following values.</p> <ul> <li> <p> <code>PENDING</code> - The model package is pending being created.</p> </li> <li> <p> <code>IN_PROGRESS</code> - The model package is in the process of being created.</p> </li> <li> <p> <code>COMPLETED</code> - The model package was successfully created.</p> </li> <li> <p> <code>FAILED</code> - The model package failed.</p> </li> <li> <p> <code>DELETING</code> - The model package is in the process of being deleted.</p> </li> </ul>
8394
- * @public
8395
- */
8396
- ModelPackageStatus?: ModelPackageStatus | undefined;
8397
- /**
8398
- * <p>Specifies the validation and image scan statuses of the model package.</p>
8399
- * @public
8400
- */
8401
- ModelPackageStatusDetails?: ModelPackageStatusDetails | undefined;
8402
- /**
8403
- * <p>Whether the model package is to be certified to be listed on Amazon Web Services Marketplace. For information about listing model packages on Amazon Web Services Marketplace, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-mkt-list.html">List Your Algorithm or Model Package on Amazon Web Services Marketplace</a>.</p>
8404
- * @public
8405
- */
8406
- CertifyForMarketplace?: boolean | undefined;
8407
- /**
8408
- * <p>The approval status of the model. This can be one of the following values.</p> <ul> <li> <p> <code>APPROVED</code> - The model is approved</p> </li> <li> <p> <code>REJECTED</code> - The model is rejected.</p> </li> <li> <p> <code>PENDING_MANUAL_APPROVAL</code> - The model is waiting for manual approval.</p> </li> </ul>
8409
- * @public
8410
- */
8411
- ModelApprovalStatus?: ModelApprovalStatus | undefined;
8412
- /**
8413
- * <p>Information about the user who created or modified an experiment, trial, trial component, lineage group, or project.</p>
8414
- * @public
8415
- */
8416
- CreatedBy?: UserContext | undefined;
8417
- /**
8418
- * <p>Metadata properties of the tracking entity, trial, or trial component.</p>
8419
- * @public
8420
- */
8421
- MetadataProperties?: MetadataProperties | undefined;
8422
- /**
8423
- * <p>Metrics for the model.</p>
8424
- * @public
8425
- */
8426
- ModelMetrics?: ModelMetrics | undefined;
8427
- /**
8428
- * <p>The last time the model package was modified.</p>
8429
- * @public
8430
- */
8431
- LastModifiedTime?: Date | undefined;
8432
- /**
8433
- * <p>Information about the user who created or modified an experiment, trial, trial component, lineage group, or project.</p>
8434
- * @public
8435
- */
8436
- LastModifiedBy?: UserContext | undefined;
8437
- /**
8438
- * <p>A description provided when the model approval is set.</p>
8439
- * @public
8440
- */
8441
- ApprovalDescription?: string | undefined;
8442
- /**
8443
- * <p>The machine learning domain of your model package and its components. Common machine learning domains include computer vision and natural language processing.</p>
8444
- * @public
8445
- */
8446
- Domain?: string | undefined;
8447
- /**
8448
- * <p>The machine learning task your model package accomplishes. Common machine learning tasks include object detection and image classification.</p>
8449
- * @public
8450
- */
8451
- Task?: string | undefined;
8452
- /**
8453
- * <p>The Amazon Simple Storage Service path where the sample payload are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).</p>
8454
- * @public
8455
- */
8456
- SamplePayloadUrl?: string | undefined;
8457
- /**
8458
- * <p>An array of additional Inference Specification objects.</p>
8459
- * @public
8460
- */
8461
- AdditionalInferenceSpecifications?: AdditionalInferenceSpecificationDefinition[] | undefined;
8462
- /**
8463
- * <p>The URI of the source for the model package.</p>
8464
- * @public
8465
- */
8466
- SourceUri?: string | undefined;
8467
- /**
8468
- * <p>An optional Key Management Service key to encrypt, decrypt, and re-encrypt model package information for regulated workloads with highly sensitive data.</p>
8469
- * @public
8470
- */
8471
- SecurityConfig?: ModelPackageSecurityConfig | undefined;
8472
- /**
8473
- * <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>
8474
- * @public
8475
- */
8476
- ModelCard?: ModelPackageModelCard | undefined;
8215
+ export interface ListWorkforcesRequest {
8477
8216
  /**
8478
- * <p> A structure describing the current state of the model in its life cycle. </p>
8217
+ * <p>Sort workforces using the workforce name or creation date.</p>
8479
8218
  * @public
8480
8219
  */
8481
- ModelLifeCycle?: ModelLifeCycle | undefined;
8220
+ SortBy?: ListWorkforcesSortByOptions | undefined;
8482
8221
  /**
8483
- * <p>A list of the tags associated with the model package. 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>
8222
+ * <p>Sort workforces in ascending or descending order.</p>
8484
8223
  * @public
8485
8224
  */
8486
- Tags?: Tag[] | undefined;
8225
+ SortOrder?: SortOrder | undefined;
8487
8226
  /**
8488
- * <p>The metadata properties for the model package. </p>
8227
+ * <p>A filter you can use to search for workforces using part of the workforce name.</p>
8489
8228
  * @public
8490
8229
  */
8491
- CustomerMetadataProperties?: Record<string, string> | undefined;
8230
+ NameContains?: string | undefined;
8492
8231
  /**
8493
- * <p>Represents the drift check baselines that can be used when the model monitor is set using the model package.</p>
8232
+ * <p>A token to resume pagination.</p>
8494
8233
  * @public
8495
8234
  */
8496
- DriftCheckBaselines?: DriftCheckBaselines | undefined;
8235
+ NextToken?: string | undefined;
8497
8236
  /**
8498
- * <p>Indicates if you want to skip model validation.</p>
8237
+ * <p>The maximum number of workforces returned in the response.</p>
8499
8238
  * @public
8500
8239
  */
8501
- SkipModelValidation?: SkipModelValidation | undefined;
8240
+ MaxResults?: number | undefined;
8502
8241
  }
8503
- /**
8504
- * @internal
8505
- */
8506
- export declare const ModelCardFilterSensitiveLog: (obj: ModelCard) => any;
8507
- /**
8508
- * @internal
8509
- */
8510
- export declare const ModelPackageFilterSensitiveLog: (obj: ModelPackage) => any;