@aws-sdk/client-sagemaker 3.936.0 → 3.938.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 (91) hide show
  1. package/README.md +16 -0
  2. package/dist-cjs/index.js +558 -168
  3. package/dist-es/SageMaker.js +4 -0
  4. package/dist-es/commands/BatchRebootClusterNodesCommand.js +16 -0
  5. package/dist-es/commands/BatchReplaceClusterNodesCommand.js +16 -0
  6. package/dist-es/commands/index.js +2 -0
  7. package/dist-es/models/enums.js +64 -0
  8. package/dist-es/schemas/schemas_0.js +460 -168
  9. package/dist-types/SageMaker.d.ts +14 -0
  10. package/dist-types/SageMakerClient.d.ts +4 -2
  11. package/dist-types/commands/BatchRebootClusterNodesCommand.d.ts +102 -0
  12. package/dist-types/commands/BatchReplaceClusterNodesCommand.d.ts +102 -0
  13. package/dist-types/commands/CreateClusterCommand.d.ts +17 -0
  14. package/dist-types/commands/CreateComputeQuotaCommand.d.ts +4 -0
  15. package/dist-types/commands/CreateDataQualityJobDefinitionCommand.d.ts +1 -1
  16. package/dist-types/commands/CreateDeviceFleetCommand.d.ts +1 -1
  17. package/dist-types/commands/CreateOptimizationJobCommand.d.ts +15 -1
  18. package/dist-types/commands/CreateTrainingJobCommand.d.ts +2 -1
  19. package/dist-types/commands/CreateTrainingPlanCommand.d.ts +1 -1
  20. package/dist-types/commands/CreateTransformJobCommand.d.ts +1 -1
  21. package/dist-types/commands/CreateTrialCommand.d.ts +1 -1
  22. package/dist-types/commands/CreateTrialComponentCommand.d.ts +1 -1
  23. package/dist-types/commands/CreateUserProfileCommand.d.ts +1 -1
  24. package/dist-types/commands/DescribeClusterCommand.d.ts +30 -0
  25. package/dist-types/commands/DescribeClusterEventCommand.d.ts +1 -0
  26. package/dist-types/commands/DescribeClusterNodeCommand.d.ts +23 -0
  27. package/dist-types/commands/DescribeComputeQuotaCommand.d.ts +4 -0
  28. package/dist-types/commands/DescribeOptimizationJobCommand.d.ts +15 -1
  29. package/dist-types/commands/DescribeTrainingPlanCommand.d.ts +2 -2
  30. package/dist-types/commands/DescribeTransformJobCommand.d.ts +1 -1
  31. package/dist-types/commands/DescribeTrialCommand.d.ts +1 -1
  32. package/dist-types/commands/DescribeTrialComponentCommand.d.ts +1 -1
  33. package/dist-types/commands/DescribeUserProfileCommand.d.ts +1 -1
  34. package/dist-types/commands/DescribeWorkforceCommand.d.ts +1 -1
  35. package/dist-types/commands/ListClusterNodesCommand.d.ts +1 -0
  36. package/dist-types/commands/ListComputeQuotasCommand.d.ts +4 -0
  37. package/dist-types/commands/ListOptimizationJobsCommand.d.ts +2 -1
  38. package/dist-types/commands/ListTrainingPlansCommand.d.ts +3 -2
  39. package/dist-types/commands/ListTransformJobsCommand.d.ts +1 -1
  40. package/dist-types/commands/ListTrialComponentsCommand.d.ts +1 -1
  41. package/dist-types/commands/ListTrialsCommand.d.ts +1 -1
  42. package/dist-types/commands/ListUltraServersByReservedCapacityCommand.d.ts +1 -1
  43. package/dist-types/commands/ListUserProfilesCommand.d.ts +1 -1
  44. package/dist-types/commands/ListWorkforcesCommand.d.ts +1 -1
  45. package/dist-types/commands/ListWorkteamsCommand.d.ts +1 -2
  46. package/dist-types/commands/SearchTrainingPlanOfferingsCommand.d.ts +2 -2
  47. package/dist-types/commands/UpdateClusterCommand.d.ts +17 -0
  48. package/dist-types/commands/UpdateComputeQuotaCommand.d.ts +4 -0
  49. package/dist-types/commands/index.d.ts +2 -0
  50. package/dist-types/models/enums.d.ts +128 -0
  51. package/dist-types/models/models_0.d.ts +368 -369
  52. package/dist-types/models/models_1.d.ts +3321 -3361
  53. package/dist-types/models/models_2.d.ts +3816 -4111
  54. package/dist-types/models/models_3.d.ts +4107 -3920
  55. package/dist-types/models/models_4.d.ts +607 -7
  56. package/dist-types/schemas/schemas_0.d.ts +28 -0
  57. package/dist-types/ts3.4/SageMaker.d.ts +34 -0
  58. package/dist-types/ts3.4/SageMakerClient.d.ts +12 -0
  59. package/dist-types/ts3.4/commands/BatchRebootClusterNodesCommand.d.ts +51 -0
  60. package/dist-types/ts3.4/commands/BatchReplaceClusterNodesCommand.d.ts +51 -0
  61. package/dist-types/ts3.4/commands/CreateDataQualityJobDefinitionCommand.d.ts +1 -1
  62. package/dist-types/ts3.4/commands/CreateDeviceFleetCommand.d.ts +1 -1
  63. package/dist-types/ts3.4/commands/CreateTrainingJobCommand.d.ts +2 -4
  64. package/dist-types/ts3.4/commands/CreateTrainingPlanCommand.d.ts +1 -1
  65. package/dist-types/ts3.4/commands/CreateTransformJobCommand.d.ts +1 -1
  66. package/dist-types/ts3.4/commands/CreateTrialCommand.d.ts +1 -1
  67. package/dist-types/ts3.4/commands/CreateTrialComponentCommand.d.ts +1 -1
  68. package/dist-types/ts3.4/commands/CreateUserProfileCommand.d.ts +1 -1
  69. package/dist-types/ts3.4/commands/DescribeTrainingPlanCommand.d.ts +1 -1
  70. package/dist-types/ts3.4/commands/DescribeTransformJobCommand.d.ts +1 -1
  71. package/dist-types/ts3.4/commands/DescribeTrialCommand.d.ts +1 -1
  72. package/dist-types/ts3.4/commands/DescribeTrialComponentCommand.d.ts +1 -1
  73. package/dist-types/ts3.4/commands/DescribeUserProfileCommand.d.ts +1 -1
  74. package/dist-types/ts3.4/commands/DescribeWorkforceCommand.d.ts +1 -1
  75. package/dist-types/ts3.4/commands/ListTrainingPlansCommand.d.ts +2 -4
  76. package/dist-types/ts3.4/commands/ListTransformJobsCommand.d.ts +1 -1
  77. package/dist-types/ts3.4/commands/ListTrialComponentsCommand.d.ts +1 -1
  78. package/dist-types/ts3.4/commands/ListTrialsCommand.d.ts +1 -1
  79. package/dist-types/ts3.4/commands/ListUltraServersByReservedCapacityCommand.d.ts +1 -1
  80. package/dist-types/ts3.4/commands/ListUserProfilesCommand.d.ts +1 -1
  81. package/dist-types/ts3.4/commands/ListWorkforcesCommand.d.ts +1 -1
  82. package/dist-types/ts3.4/commands/ListWorkteamsCommand.d.ts +4 -2
  83. package/dist-types/ts3.4/commands/index.d.ts +2 -0
  84. package/dist-types/ts3.4/models/enums.d.ts +80 -0
  85. package/dist-types/ts3.4/models/models_0.d.ts +93 -90
  86. package/dist-types/ts3.4/models/models_1.d.ts +121 -146
  87. package/dist-types/ts3.4/models/models_2.d.ts +139 -193
  88. package/dist-types/ts3.4/models/models_3.d.ts +195 -150
  89. package/dist-types/ts3.4/models/models_4.d.ts +161 -13
  90. package/dist-types/ts3.4/schemas/schemas_0.d.ts +28 -0
  91. package/package.json +1 -1
@@ -1,8 +1,608 @@
1
- import { _InstanceType, ActionStatus, ActivationState, AppNetworkAccessType, AppSecurityGroupManagement, BatchStrategy, BooleanOperator, ClusterNodeProvisioningMode, ClusterNodeRecovery, CrossAccountFilterOption, Direction, EndpointStatus, HubContentSupportStatus, HubContentType, InferenceExperimentStopDesiredState, IPAddressType, JobType, LineageType, ModelApprovalStatus, ModelCardStatus, ModelPackageGroupStatus, ModelPackageStatus, ModelVariantAction, MonitoringType, NotebookInstanceAcceleratorType, PipelineExecutionStatus, PipelineStatus, ProcessingJobStatus, Processor, ProjectStatus, Relation, ReservedCapacityInstanceType, ReservedCapacityType, ResourceType, RootAccess, SageMakerResourceName, ScheduleStatus, SearchSortOrder, SecondaryStatus, SkipModelValidation, TagPropagation, ThroughputMode, TrackingServerSize, TrainingJobStatus, TransformJobStatus, VariantPropertyType, VendorGuidance, WorkforceIpAddressType } from "./enums";
2
- import { AdditionalInferenceSpecificationDefinition, AlgorithmSpecification, AppSpecification, BatchDataCaptureConfig, BatchTransformInput, CfnUpdateTemplateProvider, Channel, CheckpointConfig, ClusterAutoScalingConfig, ClusterInstanceGroupSpecification, ClusterRestrictedInstanceGroupSpecification, ClusterTieredStorageConfig, CodeEditorAppImageConfig, ComputeQuotaConfig, ComputeQuotaTarget, ContainerDefinition, DeploymentConfiguration, EdgeOutputConfig, InferenceSpecification, JupyterLabAppImageConfig, KernelGatewayImageConfig, MetadataProperties, OutputDataConfig, OutputParameter, ResourceConfig, SchedulerConfig, StoppingCondition, Tag, TransformInput, TransformOutput, TransformResources, UserContext, VpcConfig } from "./models_0";
3
- import { DataProcessing, DebugHookConfig, DebugRuleConfiguration, DefaultSpaceSettings, DeploymentConfig, DriftCheckBaselines, ExperimentConfig, FeatureDefinition, InferenceComponentRuntimeConfig, InferenceComponentSpecification, InferenceExecutionConfig, InferenceExperimentDataStorageConfig, InferenceExperimentSchedule, InstanceMetadataServiceConfiguration, ModelCardSecurityConfig, ModelClientConfig, ModelLifeCycle, ModelMetrics, ModelPackageModelCard, ModelPackageSecurityConfig, ModelPackageValidationSpecification, ModelVariantConfig, MonitoringScheduleConfig, NetworkConfig, NotebookInstanceLifecycleHook, OidcConfig, ParallelismConfiguration, PartnerAppConfig, PartnerAppMaintenanceConfig, PipelineDefinitionS3Location, ProcessingInput, ProcessingOutputConfig, ProcessingResources, ProcessingStoppingCondition, ProfilerConfig, ProfilerRuleConfiguration, ProvisioningParameter, RetryStrategy, ServiceCatalogProvisioningDetails, ShadowModeConfig, SourceAlgorithmSpecification, SourceIpConfig, SpaceSettings, TensorBoardOutputConfig, TrialComponentArtifact, TrialComponentParameterValue, TrialComponentStatus, TtlDuration, UiTemplate, UserSettings, WorkforceVpcConfigRequest } from "./models_1";
4
- import { DebugRuleEvaluationStatus, DeploymentRecommendation, FeatureParameter, InferenceComponentDeploymentConfig, MemberDefinition, MetricData, ModelArtifacts, ModelPackageStatusDetails, MonitoringExecutionSummary, NotificationConfiguration, PipelineExperimentConfig, SecondaryStatusTransition, SelectiveExecutionConfig, ServiceCatalogProvisionedProductDetails, TemplateProviderDetail, TrialComponentMetricSummary, TrialComponentSource, TrialSource, WorkerAccessConfiguration, Workforce } from "./models_2";
5
- import { DesiredWeightAndCapacity, Device, DomainSettingsForUpdate, Edge, Endpoint, Experiment, FeatureGroup, FeatureMetadata, Filter, GitConfigForUpdate, HyperParameterTuningJobSearchEntity, MonitoringAlertSummary, Parameter, Workteam } from "./models_3";
1
+ import { _InstanceType, ActionStatus, ActivationState, AppNetworkAccessType, AppSecurityGroupManagement, BatchStrategy, BooleanOperator, ClusterNodeProvisioningMode, ClusterNodeRecovery, CrossAccountFilterOption, Direction, EndpointStatus, HubContentSupportStatus, HubContentType, InferenceExperimentStopDesiredState, IPAddressType, JobType, LineageType, ListWorkforcesSortByOptions, ListWorkteamsSortByOptions, ModelApprovalStatus, ModelCardStatus, ModelPackageGroupStatus, ModelPackageStatus, ModelVariantAction, MonitoringType, NotebookInstanceAcceleratorType, PipelineExecutionStatus, PipelineStatus, ProcessingJobStatus, Processor, ProjectStatus, Relation, ReservedCapacityInstanceType, ReservedCapacityType, ResourceType, RootAccess, SageMakerResourceName, ScheduleStatus, SearchSortOrder, SecondaryStatus, SkipModelValidation, SortBy, SortOrder, SortTrialComponentsBy, SortTrialsBy, TagPropagation, ThroughputMode, TrackingServerSize, TrainingJobStatus, TransformJobStatus, UltraServerHealthStatus, UserProfileSortKey, UserProfileStatus, VariantPropertyType, VendorGuidance, WorkforceIpAddressType } from "./enums";
2
+ import { AdditionalInferenceSpecificationDefinition, AlgorithmSpecification, AppSpecification, BatchDataCaptureConfig, BatchTransformInput, CfnUpdateTemplateProvider, Channel, CheckpointConfig, ClusterAutoScalingConfig, ClusterInstanceGroupSpecification, ClusterRestrictedInstanceGroupSpecification, ClusterTieredStorageConfig, CodeEditorAppImageConfig, ComputeQuotaConfig, ComputeQuotaTarget, ContainerDefinition, DeploymentConfiguration, InferenceSpecification, JupyterLabAppImageConfig, KernelGatewayImageConfig, MetadataProperties, OutputDataConfig, OutputParameter, ResourceConfig, SchedulerConfig, StoppingCondition, Tag, TransformInput, TransformOutput, TransformResources, UserContext, VpcConfig } from "./models_0";
3
+ import { DebugHookConfig, DebugRuleConfiguration, DefaultSpaceSettings, DeploymentConfig, DriftCheckBaselines, EdgeOutputConfig, ExperimentConfig, FeatureDefinition, InferenceComponentRuntimeConfig, InferenceComponentSpecification, InferenceExecutionConfig, InferenceExperimentDataStorageConfig, InferenceExperimentSchedule, InstanceMetadataServiceConfiguration, ModelCardSecurityConfig, ModelLifeCycle, ModelMetrics, ModelPackageModelCard, ModelPackageSecurityConfig, ModelPackageValidationSpecification, ModelVariantConfig, MonitoringScheduleConfig, NetworkConfig, NotebookInstanceLifecycleHook, ParallelismConfiguration, PartnerAppConfig, PartnerAppMaintenanceConfig, PipelineDefinitionS3Location, ProcessingInput, ProcessingOutputConfig, ProcessingResources, ProcessingStoppingCondition, ProfilerConfig, ProfilerRuleConfiguration, ProvisioningParameter, RetryStrategy, ServiceCatalogProvisioningDetails, ShadowModeConfig, SourceAlgorithmSpecification, SpaceSettings, TensorBoardOutputConfig, TtlDuration, UiTemplate, UserSettings } from "./models_1";
4
+ import { DataProcessing, DebugRuleEvaluationStatus, DeploymentRecommendation, FeatureParameter, InferenceComponentDeploymentConfig, MemberDefinition, MetricData, ModelArtifacts, ModelClientConfig, ModelPackageStatusDetails, MonitoringExecutionSummary, NotificationConfiguration, OidcConfig, PipelineExperimentConfig, SecondaryStatusTransition, SelectiveExecutionConfig, ServiceCatalogProvisionedProductDetails, SourceIpConfig, TemplateProviderDetail, TrialComponentArtifact, TrialComponentParameterValue, TrialComponentStatus, WorkerAccessConfiguration, WorkforceVpcConfigRequest } from "./models_2";
5
+ import { DesiredWeightAndCapacity, Device, DomainSettingsForUpdate, Edge, Endpoint, Experiment, FeatureGroup, FeatureMetadata, Filter, GitConfigForUpdate, HyperParameterTuningJobSearchEntity, MonitoringAlertSummary, Parameter, TrainingPlanSummary, TrialComponentMetricSummary, TrialComponentSource, TrialSource, Workforce, Workteam } from "./models_3";
6
+ /**
7
+ * @public
8
+ */
9
+ export interface ListTrainingPlansResponse {
10
+ /**
11
+ * <p>A token to continue pagination if more results are available.</p>
12
+ * @public
13
+ */
14
+ NextToken?: string | undefined;
15
+ /**
16
+ * <p>A list of summary information for the training plans.</p>
17
+ * @public
18
+ */
19
+ TrainingPlanSummaries: TrainingPlanSummary[] | undefined;
20
+ }
21
+ /**
22
+ * @public
23
+ */
24
+ export interface ListTransformJobsRequest {
25
+ /**
26
+ * <p>A filter that returns only transform jobs created after the specified time.</p>
27
+ * @public
28
+ */
29
+ CreationTimeAfter?: Date | undefined;
30
+ /**
31
+ * <p>A filter that returns only transform jobs created before the specified time.</p>
32
+ * @public
33
+ */
34
+ CreationTimeBefore?: Date | undefined;
35
+ /**
36
+ * <p>A filter that returns only transform jobs modified after the specified time.</p>
37
+ * @public
38
+ */
39
+ LastModifiedTimeAfter?: Date | undefined;
40
+ /**
41
+ * <p>A filter that returns only transform jobs modified before the specified time.</p>
42
+ * @public
43
+ */
44
+ LastModifiedTimeBefore?: Date | undefined;
45
+ /**
46
+ * <p>A string in the transform job name. This filter returns only transform jobs whose name contains the specified string.</p>
47
+ * @public
48
+ */
49
+ NameContains?: string | undefined;
50
+ /**
51
+ * <p>A filter that retrieves only transform jobs with a specific status.</p>
52
+ * @public
53
+ */
54
+ StatusEquals?: TransformJobStatus | undefined;
55
+ /**
56
+ * <p>The field to sort results by. The default is <code>CreationTime</code>.</p>
57
+ * @public
58
+ */
59
+ SortBy?: SortBy | undefined;
60
+ /**
61
+ * <p>The sort order for results. The default is <code>Descending</code>.</p>
62
+ * @public
63
+ */
64
+ SortOrder?: SortOrder | undefined;
65
+ /**
66
+ * <p>If the result of the previous <code>ListTransformJobs</code> request was truncated, the response includes a <code>NextToken</code>. To retrieve the next set of transform jobs, use the token in the next request.</p>
67
+ * @public
68
+ */
69
+ NextToken?: string | undefined;
70
+ /**
71
+ * <p>The maximum number of transform jobs to return in the response. The default value is <code>10</code>.</p>
72
+ * @public
73
+ */
74
+ MaxResults?: number | undefined;
75
+ }
76
+ /**
77
+ * <p>Provides a summary of a transform job. Multiple <code>TransformJobSummary</code> objects are returned as a list after in response to a <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ListTransformJobs.html">ListTransformJobs</a> call.</p>
78
+ * @public
79
+ */
80
+ export interface TransformJobSummary {
81
+ /**
82
+ * <p>The name of the transform job.</p>
83
+ * @public
84
+ */
85
+ TransformJobName: string | undefined;
86
+ /**
87
+ * <p>The Amazon Resource Name (ARN) of the transform job.</p>
88
+ * @public
89
+ */
90
+ TransformJobArn: string | undefined;
91
+ /**
92
+ * <p>A timestamp that shows when the transform Job was created.</p>
93
+ * @public
94
+ */
95
+ CreationTime: Date | undefined;
96
+ /**
97
+ * <p>Indicates when the transform job ends on compute instances. For successful jobs and stopped jobs, this is the exact time recorded after the results are uploaded. For failed jobs, this is when Amazon SageMaker detected that the job failed.</p>
98
+ * @public
99
+ */
100
+ TransformEndTime?: Date | undefined;
101
+ /**
102
+ * <p>Indicates when the transform job was last modified.</p>
103
+ * @public
104
+ */
105
+ LastModifiedTime?: Date | undefined;
106
+ /**
107
+ * <p>The status of the transform job.</p>
108
+ * @public
109
+ */
110
+ TransformJobStatus: TransformJobStatus | undefined;
111
+ /**
112
+ * <p>If the transform job failed, the reason it failed.</p>
113
+ * @public
114
+ */
115
+ FailureReason?: string | undefined;
116
+ }
117
+ /**
118
+ * @public
119
+ */
120
+ export interface ListTransformJobsResponse {
121
+ /**
122
+ * <p>An array of <code>TransformJobSummary</code> objects.</p>
123
+ * @public
124
+ */
125
+ TransformJobSummaries: TransformJobSummary[] | undefined;
126
+ /**
127
+ * <p>If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of transform jobs, use it in the next request.</p>
128
+ * @public
129
+ */
130
+ NextToken?: string | undefined;
131
+ }
132
+ /**
133
+ * @public
134
+ */
135
+ export interface ListTrialComponentsRequest {
136
+ /**
137
+ * <p>A filter that returns only components that are part of the specified experiment. If you specify <code>ExperimentName</code>, you can't filter by <code>SourceArn</code> or <code>TrialName</code>.</p>
138
+ * @public
139
+ */
140
+ ExperimentName?: string | undefined;
141
+ /**
142
+ * <p>A filter that returns only components that are part of the specified trial. If you specify <code>TrialName</code>, you can't filter by <code>ExperimentName</code> or <code>SourceArn</code>.</p>
143
+ * @public
144
+ */
145
+ TrialName?: string | undefined;
146
+ /**
147
+ * <p>A filter that returns only components that have the specified source Amazon Resource Name (ARN). If you specify <code>SourceArn</code>, you can't filter by <code>ExperimentName</code> or <code>TrialName</code>.</p>
148
+ * @public
149
+ */
150
+ SourceArn?: string | undefined;
151
+ /**
152
+ * <p>A filter that returns only components created after the specified time.</p>
153
+ * @public
154
+ */
155
+ CreatedAfter?: Date | undefined;
156
+ /**
157
+ * <p>A filter that returns only components created before the specified time.</p>
158
+ * @public
159
+ */
160
+ CreatedBefore?: Date | undefined;
161
+ /**
162
+ * <p>The property used to sort results. The default value is <code>CreationTime</code>.</p>
163
+ * @public
164
+ */
165
+ SortBy?: SortTrialComponentsBy | undefined;
166
+ /**
167
+ * <p>The sort order. The default value is <code>Descending</code>.</p>
168
+ * @public
169
+ */
170
+ SortOrder?: SortOrder | undefined;
171
+ /**
172
+ * <p>The maximum number of components to return in the response. The default value is 10.</p>
173
+ * @public
174
+ */
175
+ MaxResults?: number | undefined;
176
+ /**
177
+ * <p>If the previous call to <code>ListTrialComponents</code> didn't return the full set of components, the call returns a token for getting the next set of components.</p>
178
+ * @public
179
+ */
180
+ NextToken?: string | undefined;
181
+ }
182
+ /**
183
+ * <p>A summary of the properties of a trial component. To get all the properties, call the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeTrialComponent.html">DescribeTrialComponent</a> API and provide the <code>TrialComponentName</code>.</p>
184
+ * @public
185
+ */
186
+ export interface TrialComponentSummary {
187
+ /**
188
+ * <p>The name of the trial component.</p>
189
+ * @public
190
+ */
191
+ TrialComponentName?: string | undefined;
192
+ /**
193
+ * <p>The Amazon Resource Name (ARN) of the trial component.</p>
194
+ * @public
195
+ */
196
+ TrialComponentArn?: string | undefined;
197
+ /**
198
+ * <p>The name of the component as displayed. If <code>DisplayName</code> isn't specified, <code>TrialComponentName</code> is displayed.</p>
199
+ * @public
200
+ */
201
+ DisplayName?: string | undefined;
202
+ /**
203
+ * <p>The Amazon Resource Name (ARN) and job type of the source of a trial component.</p>
204
+ * @public
205
+ */
206
+ TrialComponentSource?: TrialComponentSource | undefined;
207
+ /**
208
+ * <p>The status of the component. States include:</p> <ul> <li> <p>InProgress</p> </li> <li> <p>Completed</p> </li> <li> <p>Failed</p> </li> </ul>
209
+ * @public
210
+ */
211
+ Status?: TrialComponentStatus | undefined;
212
+ /**
213
+ * <p>When the component started.</p>
214
+ * @public
215
+ */
216
+ StartTime?: Date | undefined;
217
+ /**
218
+ * <p>When the component ended.</p>
219
+ * @public
220
+ */
221
+ EndTime?: Date | undefined;
222
+ /**
223
+ * <p>When the component was created.</p>
224
+ * @public
225
+ */
226
+ CreationTime?: Date | undefined;
227
+ /**
228
+ * <p>Who created the trial component.</p>
229
+ * @public
230
+ */
231
+ CreatedBy?: UserContext | undefined;
232
+ /**
233
+ * <p>When the component was last modified.</p>
234
+ * @public
235
+ */
236
+ LastModifiedTime?: Date | undefined;
237
+ /**
238
+ * <p>Who last modified the component.</p>
239
+ * @public
240
+ */
241
+ LastModifiedBy?: UserContext | undefined;
242
+ }
243
+ /**
244
+ * @public
245
+ */
246
+ export interface ListTrialComponentsResponse {
247
+ /**
248
+ * <p>A list of the summaries of your trial components.</p>
249
+ * @public
250
+ */
251
+ TrialComponentSummaries?: TrialComponentSummary[] | undefined;
252
+ /**
253
+ * <p>A token for getting the next set of components, if there are any.</p>
254
+ * @public
255
+ */
256
+ NextToken?: string | undefined;
257
+ }
258
+ /**
259
+ * @public
260
+ */
261
+ export interface ListTrialsRequest {
262
+ /**
263
+ * <p>A filter that returns only trials that are part of the specified experiment.</p>
264
+ * @public
265
+ */
266
+ ExperimentName?: string | undefined;
267
+ /**
268
+ * <p>A filter that returns only trials that are associated with the specified trial component.</p>
269
+ * @public
270
+ */
271
+ TrialComponentName?: string | undefined;
272
+ /**
273
+ * <p>A filter that returns only trials created after the specified time.</p>
274
+ * @public
275
+ */
276
+ CreatedAfter?: Date | undefined;
277
+ /**
278
+ * <p>A filter that returns only trials created before the specified time.</p>
279
+ * @public
280
+ */
281
+ CreatedBefore?: Date | undefined;
282
+ /**
283
+ * <p>The property used to sort results. The default value is <code>CreationTime</code>.</p>
284
+ * @public
285
+ */
286
+ SortBy?: SortTrialsBy | undefined;
287
+ /**
288
+ * <p>The sort order. The default value is <code>Descending</code>.</p>
289
+ * @public
290
+ */
291
+ SortOrder?: SortOrder | undefined;
292
+ /**
293
+ * <p>The maximum number of trials to return in the response. The default value is 10.</p>
294
+ * @public
295
+ */
296
+ MaxResults?: number | undefined;
297
+ /**
298
+ * <p>If the previous call to <code>ListTrials</code> didn't return the full set of trials, the call returns a token for getting the next set of trials.</p>
299
+ * @public
300
+ */
301
+ NextToken?: string | undefined;
302
+ }
303
+ /**
304
+ * <p>A summary of the properties of a trial. To get the complete set of properties, call the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeTrial.html">DescribeTrial</a> API and provide the <code>TrialName</code>.</p>
305
+ * @public
306
+ */
307
+ export interface TrialSummary {
308
+ /**
309
+ * <p>The Amazon Resource Name (ARN) of the trial.</p>
310
+ * @public
311
+ */
312
+ TrialArn?: string | undefined;
313
+ /**
314
+ * <p>The name of the trial.</p>
315
+ * @public
316
+ */
317
+ TrialName?: string | undefined;
318
+ /**
319
+ * <p>The name of the trial as displayed. If <code>DisplayName</code> isn't specified, <code>TrialName</code> is displayed.</p>
320
+ * @public
321
+ */
322
+ DisplayName?: string | undefined;
323
+ /**
324
+ * <p>The source of the trial.</p>
325
+ * @public
326
+ */
327
+ TrialSource?: TrialSource | undefined;
328
+ /**
329
+ * <p>When the trial was created.</p>
330
+ * @public
331
+ */
332
+ CreationTime?: Date | undefined;
333
+ /**
334
+ * <p>When the trial was last modified.</p>
335
+ * @public
336
+ */
337
+ LastModifiedTime?: Date | undefined;
338
+ }
339
+ /**
340
+ * @public
341
+ */
342
+ export interface ListTrialsResponse {
343
+ /**
344
+ * <p>A list of the summaries of your trials.</p>
345
+ * @public
346
+ */
347
+ TrialSummaries?: TrialSummary[] | undefined;
348
+ /**
349
+ * <p>A token for getting the next set of trials, if there are any.</p>
350
+ * @public
351
+ */
352
+ NextToken?: string | undefined;
353
+ }
354
+ /**
355
+ * @public
356
+ */
357
+ export interface ListUltraServersByReservedCapacityRequest {
358
+ /**
359
+ * <p>The ARN of the reserved capacity to list UltraServers for.</p>
360
+ * @public
361
+ */
362
+ ReservedCapacityArn: string | undefined;
363
+ /**
364
+ * <p>The maximum number of UltraServers to return in the response. The default value is 10.</p>
365
+ * @public
366
+ */
367
+ MaxResults?: number | undefined;
368
+ /**
369
+ * <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>
370
+ * @public
371
+ */
372
+ NextToken?: string | undefined;
373
+ }
374
+ /**
375
+ * <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>
376
+ * @public
377
+ */
378
+ export interface UltraServer {
379
+ /**
380
+ * <p>The unique identifier for the UltraServer.</p>
381
+ * @public
382
+ */
383
+ UltraServerId: string | undefined;
384
+ /**
385
+ * <p>The type of UltraServer, such as ml.u-p6e-gb200x72.</p>
386
+ * @public
387
+ */
388
+ UltraServerType: string | undefined;
389
+ /**
390
+ * <p>The name of the Availability Zone where the UltraServer is provisioned.</p>
391
+ * @public
392
+ */
393
+ AvailabilityZone: string | undefined;
394
+ /**
395
+ * <p>The Amazon EC2 instance type used in the UltraServer.</p>
396
+ * @public
397
+ */
398
+ InstanceType: ReservedCapacityInstanceType | undefined;
399
+ /**
400
+ * <p>The total number of instances in this UltraServer.</p>
401
+ * @public
402
+ */
403
+ TotalInstanceCount: number | undefined;
404
+ /**
405
+ * <p>The number of spare instances configured for this UltraServer to provide enhanced resiliency.</p>
406
+ * @public
407
+ */
408
+ ConfiguredSpareInstanceCount?: number | undefined;
409
+ /**
410
+ * <p>The number of instances currently available for use in this UltraServer.</p>
411
+ * @public
412
+ */
413
+ AvailableInstanceCount?: number | undefined;
414
+ /**
415
+ * <p>The number of instances currently in use in this UltraServer.</p>
416
+ * @public
417
+ */
418
+ InUseInstanceCount?: number | undefined;
419
+ /**
420
+ * <p>The number of available spare instances in the UltraServer.</p>
421
+ * @public
422
+ */
423
+ AvailableSpareInstanceCount?: number | undefined;
424
+ /**
425
+ * <p>The number of instances in this UltraServer that are currently in an unhealthy state.</p>
426
+ * @public
427
+ */
428
+ UnhealthyInstanceCount?: number | undefined;
429
+ /**
430
+ * <p>The overall health status of the UltraServer.</p>
431
+ * @public
432
+ */
433
+ HealthStatus?: UltraServerHealthStatus | undefined;
434
+ }
435
+ /**
436
+ * @public
437
+ */
438
+ export interface ListUltraServersByReservedCapacityResponse {
439
+ /**
440
+ * <p>If the response is truncated, SageMaker returns this token. Use it in the next request to retrieve the next set of UltraServers.</p>
441
+ * @public
442
+ */
443
+ NextToken?: string | undefined;
444
+ /**
445
+ * <p>A list of UltraServers that are part of the specified reserved capacity.</p>
446
+ * @public
447
+ */
448
+ UltraServers: UltraServer[] | undefined;
449
+ }
450
+ /**
451
+ * @public
452
+ */
453
+ export interface ListUserProfilesRequest {
454
+ /**
455
+ * <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>
456
+ * @public
457
+ */
458
+ NextToken?: string | undefined;
459
+ /**
460
+ * <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>
461
+ * @public
462
+ */
463
+ MaxResults?: number | undefined;
464
+ /**
465
+ * <p>The sort order for the results. The default is Ascending.</p>
466
+ * @public
467
+ */
468
+ SortOrder?: SortOrder | undefined;
469
+ /**
470
+ * <p>The parameter by which to sort the results. The default is CreationTime.</p>
471
+ * @public
472
+ */
473
+ SortBy?: UserProfileSortKey | undefined;
474
+ /**
475
+ * <p>A parameter by which to filter the results.</p>
476
+ * @public
477
+ */
478
+ DomainIdEquals?: string | undefined;
479
+ /**
480
+ * <p>A parameter by which to filter the results.</p>
481
+ * @public
482
+ */
483
+ UserProfileNameContains?: string | undefined;
484
+ }
485
+ /**
486
+ * <p>The user profile details.</p>
487
+ * @public
488
+ */
489
+ export interface UserProfileDetails {
490
+ /**
491
+ * <p>The domain ID.</p>
492
+ * @public
493
+ */
494
+ DomainId?: string | undefined;
495
+ /**
496
+ * <p>The user profile name.</p>
497
+ * @public
498
+ */
499
+ UserProfileName?: string | undefined;
500
+ /**
501
+ * <p>The status.</p>
502
+ * @public
503
+ */
504
+ Status?: UserProfileStatus | undefined;
505
+ /**
506
+ * <p>The creation time.</p>
507
+ * @public
508
+ */
509
+ CreationTime?: Date | undefined;
510
+ /**
511
+ * <p>The last modified time.</p>
512
+ * @public
513
+ */
514
+ LastModifiedTime?: Date | undefined;
515
+ }
516
+ /**
517
+ * @public
518
+ */
519
+ export interface ListUserProfilesResponse {
520
+ /**
521
+ * <p>The list of user profiles.</p>
522
+ * @public
523
+ */
524
+ UserProfiles?: UserProfileDetails[] | undefined;
525
+ /**
526
+ * <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>
527
+ * @public
528
+ */
529
+ NextToken?: string | undefined;
530
+ }
531
+ /**
532
+ * @public
533
+ */
534
+ export interface ListWorkforcesRequest {
535
+ /**
536
+ * <p>Sort workforces using the workforce name or creation date.</p>
537
+ * @public
538
+ */
539
+ SortBy?: ListWorkforcesSortByOptions | undefined;
540
+ /**
541
+ * <p>Sort workforces in ascending or descending order.</p>
542
+ * @public
543
+ */
544
+ SortOrder?: SortOrder | undefined;
545
+ /**
546
+ * <p>A filter you can use to search for workforces using part of the workforce name.</p>
547
+ * @public
548
+ */
549
+ NameContains?: string | undefined;
550
+ /**
551
+ * <p>A token to resume pagination.</p>
552
+ * @public
553
+ */
554
+ NextToken?: string | undefined;
555
+ /**
556
+ * <p>The maximum number of workforces returned in the response.</p>
557
+ * @public
558
+ */
559
+ MaxResults?: number | undefined;
560
+ }
561
+ /**
562
+ * @public
563
+ */
564
+ export interface ListWorkforcesResponse {
565
+ /**
566
+ * <p>A list containing information about your workforce.</p>
567
+ * @public
568
+ */
569
+ Workforces: Workforce[] | undefined;
570
+ /**
571
+ * <p>A token to resume pagination.</p>
572
+ * @public
573
+ */
574
+ NextToken?: string | undefined;
575
+ }
576
+ /**
577
+ * @public
578
+ */
579
+ export interface ListWorkteamsRequest {
580
+ /**
581
+ * <p>The field to sort results by. The default is <code>CreationTime</code>.</p>
582
+ * @public
583
+ */
584
+ SortBy?: ListWorkteamsSortByOptions | undefined;
585
+ /**
586
+ * <p>The sort order for results. The default is <code>Ascending</code>.</p>
587
+ * @public
588
+ */
589
+ SortOrder?: SortOrder | undefined;
590
+ /**
591
+ * <p>A string in the work team's name. This filter returns only work teams whose name contains the specified string.</p>
592
+ * @public
593
+ */
594
+ NameContains?: string | undefined;
595
+ /**
596
+ * <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>
597
+ * @public
598
+ */
599
+ NextToken?: string | undefined;
600
+ /**
601
+ * <p>The maximum number of work teams to return in each page of the response.</p>
602
+ * @public
603
+ */
604
+ MaxResults?: number | undefined;
605
+ }
6
606
  /**
7
607
  * @public
8
608
  */
@@ -2091,7 +2691,7 @@ export interface SearchTrainingPlanOfferingsRequest {
2091
2691
  */
2092
2692
  DurationHours: number | undefined;
2093
2693
  /**
2094
- * <p>The target resources (e.g., SageMaker Training Jobs, SageMaker HyperPod) to search for in the offerings.</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>
2694
+ * <p>The target resources (e.g., SageMaker Training Jobs, SageMaker HyperPod, SageMaker Endpoints) to search for in the offerings.</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> <li> <p>A training plan for SageMaker endpoints can be used exclusively to provide compute resources to SageMaker endpoints for model deployment.</p> </li> </ul>
2095
2695
  * @public
2096
2696
  */
2097
2697
  TargetResources: SageMakerResourceName[] | undefined;
@@ -2107,7 +2707,7 @@ export interface TrainingPlanOffering {
2107
2707
  */
2108
2708
  TrainingPlanOfferingId: string | undefined;
2109
2709
  /**
2110
- * <p>The target resources (e.g., SageMaker Training Jobs, SageMaker HyperPod) for this training plan offering.</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>
2710
+ * <p>The target resources (e.g., SageMaker Training Jobs, SageMaker HyperPod, SageMaker Endpoints) for this training plan offering.</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> <li> <p>A training plan for SageMaker endpoints can be used exclusively to provide compute resources to SageMaker endpoints for model deployment.</p> </li> </ul>
2111
2711
  * @public
2112
2712
  */
2113
2713
  TargetResources: SageMakerResourceName[] | undefined;