@aws-sdk/client-sagemaker 3.860.0 → 3.862.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 +24 -0
  2. package/dist-cjs/index.js +492 -124
  3. package/dist-es/SageMaker.js +6 -0
  4. package/dist-es/commands/BatchAddClusterNodesCommand.js +22 -0
  5. package/dist-es/commands/CreateModelCardCommand.js +1 -1
  6. package/dist-es/commands/DescribeClusterEventCommand.js +22 -0
  7. package/dist-es/commands/ListClusterEventsCommand.js +22 -0
  8. package/dist-es/commands/index.js +3 -0
  9. package/dist-es/models/models_0.js +38 -93
  10. package/dist-es/models/models_1.js +86 -15
  11. package/dist-es/models/models_2.js +14 -40
  12. package/dist-es/models/models_3.js +43 -40
  13. package/dist-es/models/models_4.js +40 -10
  14. package/dist-es/models/models_5.js +10 -2
  15. package/dist-es/pagination/ListClusterEventsPaginator.js +4 -0
  16. package/dist-es/pagination/index.js +1 -0
  17. package/dist-es/protocols/Aws_json1_1.js +281 -0
  18. package/dist-types/SageMaker.d.ts +21 -0
  19. package/dist-types/SageMakerClient.d.ts +5 -2
  20. package/dist-types/commands/BatchAddClusterNodesCommand.d.ts +99 -0
  21. package/dist-types/commands/BatchDeleteClusterNodesCommand.d.ts +13 -0
  22. package/dist-types/commands/CreateClusterCommand.d.ts +2 -0
  23. package/dist-types/commands/CreateModelBiasJobDefinitionCommand.d.ts +2 -1
  24. package/dist-types/commands/CreateModelCardCommand.d.ts +1 -1
  25. package/dist-types/commands/CreateModelCardExportJobCommand.d.ts +1 -1
  26. package/dist-types/commands/CreateModelExplainabilityJobDefinitionCommand.d.ts +1 -1
  27. package/dist-types/commands/DescribeClusterCommand.d.ts +3 -0
  28. package/dist-types/commands/DescribeClusterEventCommand.d.ts +129 -0
  29. package/dist-types/commands/DescribeClusterNodeCommand.d.ts +5 -1
  30. package/dist-types/commands/DescribeContextCommand.d.ts +2 -1
  31. package/dist-types/commands/DescribeDataQualityJobDefinitionCommand.d.ts +1 -1
  32. package/dist-types/commands/DescribeDeviceCommand.d.ts +1 -1
  33. package/dist-types/commands/DescribeDeviceFleetCommand.d.ts +1 -1
  34. package/dist-types/commands/DescribeDomainCommand.d.ts +1 -1
  35. package/dist-types/commands/DescribeEdgeDeploymentPlanCommand.d.ts +1 -1
  36. package/dist-types/commands/DescribeEdgePackagingJobCommand.d.ts +1 -1
  37. package/dist-types/commands/DescribeEndpointCommand.d.ts +1 -2
  38. package/dist-types/commands/ImportHubContentCommand.d.ts +1 -1
  39. package/dist-types/commands/ListActionsCommand.d.ts +1 -2
  40. package/dist-types/commands/ListClusterEventsCommand.d.ts +96 -0
  41. package/dist-types/commands/ListClusterNodesCommand.d.ts +3 -1
  42. package/dist-types/commands/PutModelPackageGroupPolicyCommand.d.ts +1 -1
  43. package/dist-types/commands/QueryLineageCommand.d.ts +1 -1
  44. package/dist-types/commands/RegisterDevicesCommand.d.ts +1 -1
  45. package/dist-types/commands/RenderUiTemplateCommand.d.ts +1 -1
  46. package/dist-types/commands/UpdateClusterCommand.d.ts +1 -0
  47. package/dist-types/commands/UpdateClusterSoftwareCommand.d.ts +1 -0
  48. package/dist-types/commands/index.d.ts +3 -0
  49. package/dist-types/models/models_0.d.ts +635 -539
  50. package/dist-types/models/models_1.d.ts +3626 -3557
  51. package/dist-types/models/models_2.d.ts +3079 -3394
  52. package/dist-types/models/models_3.d.ts +4419 -4366
  53. package/dist-types/models/models_4.d.ts +3813 -3877
  54. package/dist-types/models/models_5.d.ts +836 -5
  55. package/dist-types/pagination/ListClusterEventsPaginator.d.ts +7 -0
  56. package/dist-types/pagination/index.d.ts +1 -0
  57. package/dist-types/protocols/Aws_json1_1.d.ts +27 -0
  58. package/dist-types/ts3.4/SageMaker.d.ts +51 -0
  59. package/dist-types/ts3.4/SageMakerClient.d.ts +18 -0
  60. package/dist-types/ts3.4/commands/BatchAddClusterNodesCommand.d.ts +51 -0
  61. package/dist-types/ts3.4/commands/CreateModelBiasJobDefinitionCommand.d.ts +2 -4
  62. package/dist-types/ts3.4/commands/CreateModelCardCommand.d.ts +1 -1
  63. package/dist-types/ts3.4/commands/CreateModelCardExportJobCommand.d.ts +1 -1
  64. package/dist-types/ts3.4/commands/CreateModelExplainabilityJobDefinitionCommand.d.ts +1 -1
  65. package/dist-types/ts3.4/commands/DescribeClusterEventCommand.d.ts +51 -0
  66. package/dist-types/ts3.4/commands/DescribeContextCommand.d.ts +2 -4
  67. package/dist-types/ts3.4/commands/DescribeDataQualityJobDefinitionCommand.d.ts +1 -1
  68. package/dist-types/ts3.4/commands/DescribeDeviceCommand.d.ts +1 -1
  69. package/dist-types/ts3.4/commands/DescribeDeviceFleetCommand.d.ts +1 -1
  70. package/dist-types/ts3.4/commands/DescribeDomainCommand.d.ts +1 -1
  71. package/dist-types/ts3.4/commands/DescribeEdgeDeploymentPlanCommand.d.ts +1 -1
  72. package/dist-types/ts3.4/commands/DescribeEdgePackagingJobCommand.d.ts +1 -1
  73. package/dist-types/ts3.4/commands/DescribeEndpointCommand.d.ts +4 -2
  74. package/dist-types/ts3.4/commands/ImportHubContentCommand.d.ts +1 -1
  75. package/dist-types/ts3.4/commands/ListActionsCommand.d.ts +1 -2
  76. package/dist-types/ts3.4/commands/ListClusterEventsCommand.d.ts +51 -0
  77. package/dist-types/ts3.4/commands/PutModelPackageGroupPolicyCommand.d.ts +1 -1
  78. package/dist-types/ts3.4/commands/QueryLineageCommand.d.ts +1 -1
  79. package/dist-types/ts3.4/commands/RegisterDevicesCommand.d.ts +1 -1
  80. package/dist-types/ts3.4/commands/RenderUiTemplateCommand.d.ts +1 -1
  81. package/dist-types/ts3.4/commands/index.d.ts +3 -0
  82. package/dist-types/ts3.4/models/models_0.d.ts +186 -188
  83. package/dist-types/ts3.4/models/models_1.d.ts +177 -117
  84. package/dist-types/ts3.4/models/models_2.d.ts +123 -214
  85. package/dist-types/ts3.4/models/models_3.d.ts +219 -195
  86. package/dist-types/ts3.4/models/models_4.d.ts +225 -244
  87. package/dist-types/ts3.4/models/models_5.d.ts +220 -17
  88. package/dist-types/ts3.4/pagination/ListClusterEventsPaginator.d.ts +11 -0
  89. package/dist-types/ts3.4/pagination/index.d.ts +1 -0
  90. package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +36 -0
  91. package/package.json +34 -34
@@ -166,6 +166,33 @@ export declare class ResourceNotFound extends __BaseException {
166
166
  */
167
167
  constructor(opts: __ExceptionOptionType<ResourceNotFound, __BaseException>);
168
168
  }
169
+ /**
170
+ * <p>Specifies an instance group and the number of nodes to add to it.</p>
171
+ * @public
172
+ */
173
+ export interface AddClusterNodeSpecification {
174
+ /**
175
+ * <p>The name of the instance group to which you want to add nodes.</p>
176
+ * @public
177
+ */
178
+ InstanceGroupName: string | undefined;
179
+ /**
180
+ * <p>The number of nodes to add to the specified instance group. The total number of nodes across all instance groups in a single request cannot exceed 50.</p>
181
+ * @public
182
+ */
183
+ IncrementTargetCountBy: number | undefined;
184
+ }
185
+ /**
186
+ * <p>Information about additional Elastic Network Interfaces (ENIs) associated with an instance.</p>
187
+ * @public
188
+ */
189
+ export interface AdditionalEnis {
190
+ /**
191
+ * <p>A list of Elastic Fabric Adapter (EFA) ENIs associated with the instance.</p>
192
+ * @public
193
+ */
194
+ EfaEnis?: string[] | undefined;
195
+ }
169
196
  /**
170
197
  * @public
171
198
  * @enum
@@ -4279,40 +4306,136 @@ export declare const AwsManagedHumanLoopRequestSource: {
4279
4306
  */
4280
4307
  export type AwsManagedHumanLoopRequestSource = (typeof AwsManagedHumanLoopRequestSource)[keyof typeof AwsManagedHumanLoopRequestSource];
4281
4308
  /**
4282
- * <p>Configuration to control how SageMaker captures inference data for batch transform jobs.</p>
4283
4309
  * @public
4284
4310
  */
4285
- export interface BatchDataCaptureConfig {
4311
+ export interface BatchAddClusterNodesRequest {
4286
4312
  /**
4287
- * <p>The Amazon S3 location being used to capture the data.</p>
4313
+ * <p>The name of the HyperPod cluster to which you want to add nodes.</p>
4288
4314
  * @public
4289
4315
  */
4290
- DestinationS3Uri: string | undefined;
4316
+ ClusterName: string | undefined;
4291
4317
  /**
4292
- * <p>The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the batch transform job.</p> <p>The KmsKeyId can be any of the following formats: </p> <ul> <li> <p>Key ID: <code>1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> <li> <p>Key ARN: <code>arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> <li> <p>Alias name: <code>alias/ExampleAlias</code> </p> </li> <li> <p>Alias name ARN: <code>arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias</code> </p> </li> </ul>
4318
+ * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This token is valid for 8 hours. If you retry the request with the same client token within this timeframe and the same parameters, the API returns the same set of <code>NodeLogicalIds</code> with their latest status.</p>
4293
4319
  * @public
4294
4320
  */
4295
- KmsKeyId?: string | undefined;
4321
+ ClientToken?: string | undefined;
4296
4322
  /**
4297
- * <p>Flag that indicates whether to append inference id to the output.</p>
4323
+ * <p>A list of instance groups and the number of nodes to add to each. You can specify up to 5 instance groups in a single request, with a maximum of 50 nodes total across all instance groups.</p>
4298
4324
  * @public
4299
4325
  */
4300
- GenerateInferenceId?: boolean | undefined;
4326
+ NodesToAdd: AddClusterNodeSpecification[] | undefined;
4301
4327
  }
4302
4328
  /**
4303
4329
  * @public
4330
+ * @enum
4304
4331
  */
4305
- export interface BatchDeleteClusterNodesRequest {
4332
+ export declare const BatchAddClusterNodesErrorCode: {
4333
+ readonly INSTANCE_GROUP_NOT_FOUND: "InstanceGroupNotFound";
4334
+ readonly INVALID_INSTANCE_GROUP_STATUS: "InvalidInstanceGroupStatus";
4335
+ };
4336
+ /**
4337
+ * @public
4338
+ */
4339
+ export type BatchAddClusterNodesErrorCode = (typeof BatchAddClusterNodesErrorCode)[keyof typeof BatchAddClusterNodesErrorCode];
4340
+ /**
4341
+ * <p>Information about an error that occurred during the node addition operation.</p>
4342
+ * @public
4343
+ */
4344
+ export interface BatchAddClusterNodesError {
4306
4345
  /**
4307
- * <p>The name of the SageMaker HyperPod cluster from which to delete the specified nodes.</p>
4346
+ * <p>The name of the instance group for which the error occurred.</p>
4308
4347
  * @public
4309
4348
  */
4310
- ClusterName: string | undefined;
4349
+ InstanceGroupName: string | undefined;
4311
4350
  /**
4312
- * <p>A list of node IDs to be deleted from the specified cluster.</p> <note> <ul> <li> <p>For SageMaker HyperPod clusters using the Slurm workload manager, you cannot remove instances that are configured as Slurm controller nodes.</p> </li> <li> <p>If you need to delete more than 99 instances, contact <a href="http://aws.amazon.com/contact-us/">Support</a> for assistance.</p> </li> </ul> </note>
4351
+ * <p>The error code associated with the failure. Possible values include <code>InstanceGroupNotFound</code> and <code>InvalidInstanceGroupState</code>.</p>
4313
4352
  * @public
4314
4353
  */
4315
- NodeIds?: string[] | undefined;
4354
+ ErrorCode: BatchAddClusterNodesErrorCode | undefined;
4355
+ /**
4356
+ * <p>The number of nodes that failed to be added to the specified instance group.</p>
4357
+ * @public
4358
+ */
4359
+ FailedCount: number | undefined;
4360
+ /**
4361
+ * <p>A descriptive message providing additional details about the error.</p>
4362
+ * @public
4363
+ */
4364
+ Message?: string | undefined;
4365
+ }
4366
+ /**
4367
+ * @public
4368
+ * @enum
4369
+ */
4370
+ export declare const ClusterInstanceStatus: {
4371
+ readonly DEEP_HEALTH_CHECK_IN_PROGRESS: "DeepHealthCheckInProgress";
4372
+ readonly FAILURE: "Failure";
4373
+ readonly NOT_FOUND: "NotFound";
4374
+ readonly PENDING: "Pending";
4375
+ readonly RUNNING: "Running";
4376
+ readonly SHUTTING_DOWN: "ShuttingDown";
4377
+ readonly SYSTEM_UPDATING: "SystemUpdating";
4378
+ };
4379
+ /**
4380
+ * @public
4381
+ */
4382
+ export type ClusterInstanceStatus = (typeof ClusterInstanceStatus)[keyof typeof ClusterInstanceStatus];
4383
+ /**
4384
+ * <p>Information about a node that was successfully added to the cluster.</p>
4385
+ * @public
4386
+ */
4387
+ export interface NodeAdditionResult {
4388
+ /**
4389
+ * <p>A unique identifier assigned to the node that can be used to track its provisioning status through the <code>DescribeClusterNode</code> operation.</p>
4390
+ * @public
4391
+ */
4392
+ NodeLogicalId: string | undefined;
4393
+ /**
4394
+ * <p>The name of the instance group to which the node was added.</p>
4395
+ * @public
4396
+ */
4397
+ InstanceGroupName: string | undefined;
4398
+ /**
4399
+ * <p>The current status of the node. Possible values include <code>Pending</code>, <code>Running</code>, <code>Failed</code>, <code>ShuttingDown</code>, <code>SystemUpdating</code>, <code>DeepHealthCheckInProgress</code>, and <code>NotFound</code>.</p>
4400
+ * @public
4401
+ */
4402
+ Status: ClusterInstanceStatus | undefined;
4403
+ }
4404
+ /**
4405
+ * @public
4406
+ */
4407
+ export interface BatchAddClusterNodesResponse {
4408
+ /**
4409
+ * <p>A list of <code>NodeLogicalIDs</code> that were successfully added to the cluster. The <code>NodeLogicalID</code> is unique per cluster and does not change between instance replacements. Each entry includes a <code>NodeLogicalId</code> that can be used to track the node's provisioning status (with <code>DescribeClusterNode</code>), the instance group name, and the current status of the node.</p>
4410
+ * @public
4411
+ */
4412
+ Successful: NodeAdditionResult[] | undefined;
4413
+ /**
4414
+ * <p>A list of errors that occurred during the node addition operation. Each entry includes the instance group name, error code, number of failed additions, and an error message.</p>
4415
+ * @public
4416
+ */
4417
+ Failed: BatchAddClusterNodesError[] | undefined;
4418
+ }
4419
+ /**
4420
+ * <p>Configuration to control how SageMaker captures inference data for batch transform jobs.</p>
4421
+ * @public
4422
+ */
4423
+ export interface BatchDataCaptureConfig {
4424
+ /**
4425
+ * <p>The Amazon S3 location being used to capture the data.</p>
4426
+ * @public
4427
+ */
4428
+ DestinationS3Uri: string | undefined;
4429
+ /**
4430
+ * <p>The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the batch transform job.</p> <p>The KmsKeyId can be any of the following formats: </p> <ul> <li> <p>Key ID: <code>1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> <li> <p>Key ARN: <code>arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> <li> <p>Alias name: <code>alias/ExampleAlias</code> </p> </li> <li> <p>Alias name ARN: <code>arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias</code> </p> </li> </ul>
4431
+ * @public
4432
+ */
4433
+ KmsKeyId?: string | undefined;
4434
+ /**
4435
+ * <p>Flag that indicates whether to append inference id to the output.</p>
4436
+ * @public
4437
+ */
4438
+ GenerateInferenceId?: boolean | undefined;
4316
4439
  }
4317
4440
  /**
4318
4441
  * @public
@@ -4327,6 +4450,47 @@ export declare const BatchDeleteClusterNodesErrorCode: {
4327
4450
  * @public
4328
4451
  */
4329
4452
  export type BatchDeleteClusterNodesErrorCode = (typeof BatchDeleteClusterNodesErrorCode)[keyof typeof BatchDeleteClusterNodesErrorCode];
4453
+ /**
4454
+ * <p>Information about an error that occurred when attempting to delete a node identified by its <code>NodeLogicalId</code>.</p>
4455
+ * @public
4456
+ */
4457
+ export interface BatchDeleteClusterNodeLogicalIdsError {
4458
+ /**
4459
+ * <p>The error code associated with the failure. Possible values include <code>NodeLogicalIdNotFound</code>, <code>InvalidNodeStatus</code>, and <code>InternalError</code>.</p>
4460
+ * @public
4461
+ */
4462
+ Code: BatchDeleteClusterNodesErrorCode | undefined;
4463
+ /**
4464
+ * <p>A descriptive message providing additional details about the error.</p>
4465
+ * @public
4466
+ */
4467
+ Message: string | undefined;
4468
+ /**
4469
+ * <p>The <code>NodeLogicalId</code> of the node that could not be deleted.</p>
4470
+ * @public
4471
+ */
4472
+ NodeLogicalId: string | undefined;
4473
+ }
4474
+ /**
4475
+ * @public
4476
+ */
4477
+ export interface BatchDeleteClusterNodesRequest {
4478
+ /**
4479
+ * <p>The name of the SageMaker HyperPod cluster from which to delete the specified nodes.</p>
4480
+ * @public
4481
+ */
4482
+ ClusterName: string | undefined;
4483
+ /**
4484
+ * <p>A list of node IDs to be deleted from the specified cluster.</p> <note> <ul> <li> <p>For SageMaker HyperPod clusters using the Slurm workload manager, you cannot remove instances that are configured as Slurm controller nodes.</p> </li> <li> <p>If you need to delete more than 99 instances, contact <a href="http://aws.amazon.com/contact-us/">Support</a> for assistance.</p> </li> </ul> </note>
4485
+ * @public
4486
+ */
4487
+ NodeIds?: string[] | undefined;
4488
+ /**
4489
+ * <p>A list of <code>NodeLogicalIds</code> identifying the nodes to be deleted. You can specify up to 50 <code>NodeLogicalIds</code>. You must specify either <code>NodeLogicalIds</code>, <code>InstanceIds</code>, or both, with a combined maximum of 50 identifiers.</p>
4490
+ * @public
4491
+ */
4492
+ NodeLogicalIds?: string[] | undefined;
4493
+ }
4330
4494
  /**
4331
4495
  * <p>Represents an error encountered when deleting a node from a SageMaker HyperPod cluster.</p>
4332
4496
  * @public
@@ -4362,6 +4526,16 @@ export interface BatchDeleteClusterNodesResponse {
4362
4526
  * @public
4363
4527
  */
4364
4528
  Successful?: string[] | undefined;
4529
+ /**
4530
+ * <p>A list of <code>NodeLogicalIds</code> that could not be deleted, along with error information explaining why the deletion failed.</p>
4531
+ * @public
4532
+ */
4533
+ FailedNodeLogicalIds?: BatchDeleteClusterNodeLogicalIdsError[] | undefined;
4534
+ /**
4535
+ * <p>A list of <code>NodeLogicalIds</code> that were successfully deleted from the cluster.</p>
4536
+ * @public
4537
+ */
4538
+ SuccessfulNodeLogicalIds?: string[] | undefined;
4365
4539
  }
4366
4540
  /**
4367
4541
  * @public
@@ -5038,6 +5212,34 @@ export interface CanvasAppSettings {
5038
5212
  */
5039
5213
  EmrServerlessSettings?: EmrServerlessSettings | undefined;
5040
5214
  }
5215
+ /**
5216
+ * @public
5217
+ * @enum
5218
+ */
5219
+ export declare const CapacityReservationType: {
5220
+ readonly CRG: "CRG";
5221
+ readonly ODCR: "ODCR";
5222
+ };
5223
+ /**
5224
+ * @public
5225
+ */
5226
+ export type CapacityReservationType = (typeof CapacityReservationType)[keyof typeof CapacityReservationType];
5227
+ /**
5228
+ * <p>Information about the Capacity Reservation used by an instance or instance group.</p>
5229
+ * @public
5230
+ */
5231
+ export interface CapacityReservation {
5232
+ /**
5233
+ * <p>The Amazon Resource Name (ARN) of the Capacity Reservation.</p>
5234
+ * @public
5235
+ */
5236
+ Arn?: string | undefined;
5237
+ /**
5238
+ * <p>The type of Capacity Reservation. Valid values are <code>ODCR</code> (On-Demand Capacity Reservation) or <code>CRG</code> (Capacity Reservation Group).</p>
5239
+ * @public
5240
+ */
5241
+ Type?: CapacityReservationType | undefined;
5242
+ }
5041
5243
  /**
5042
5244
  * @public
5043
5245
  * @enum
@@ -5675,87 +5877,394 @@ export interface ClusterEbsVolumeConfig {
5675
5877
  VolumeSizeInGB?: number | undefined;
5676
5878
  }
5677
5879
  /**
5678
- * <p>Defines the configuration for attaching additional storage to the instances in the SageMaker HyperPod cluster instance group. To learn more, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-hyperpod-release-notes.html#sagemaker-hyperpod-release-notes-20240620">SageMaker HyperPod release notes: June 20, 2024</a>.</p>
5880
+ * <p>Metadata information about a SageMaker HyperPod cluster showing information about the cluster level operations, such as creating, updating, and deleting.</p>
5679
5881
  * @public
5680
5882
  */
5681
- export type ClusterInstanceStorageConfig = ClusterInstanceStorageConfig.EbsVolumeConfigMember | ClusterInstanceStorageConfig.$UnknownMember;
5883
+ export interface ClusterMetadata {
5884
+ /**
5885
+ * <p>An error message describing why the cluster level operation (such as creating, updating, or deleting) failed.</p>
5886
+ * @public
5887
+ */
5888
+ FailureMessage?: string | undefined;
5889
+ /**
5890
+ * <p>A list of Amazon EKS IAM role ARNs associated with the cluster. This is created by SageMaker HyperPod on your behalf and only applies for EKS-orchestrated clusters.</p>
5891
+ * @public
5892
+ */
5893
+ EksRoleAccessEntries?: string[] | undefined;
5894
+ /**
5895
+ * <p>The Service-Linked Role (SLR) associated with the cluster. This is created by SageMaker HyperPod on your behalf and only applies for EKS-orchestrated clusters.</p>
5896
+ * @public
5897
+ */
5898
+ SlrAccessEntry?: string | undefined;
5899
+ }
5682
5900
  /**
5901
+ * <p>Metadata information about an instance in a HyperPod cluster.</p>
5683
5902
  * @public
5684
5903
  */
5685
- export declare namespace ClusterInstanceStorageConfig {
5904
+ export interface InstanceMetadata {
5686
5905
  /**
5687
- * <p>Defines the configuration for attaching additional Amazon Elastic Block Store (EBS) volumes to the instances in the SageMaker HyperPod cluster instance group. The additional EBS volume is attached to each instance within the SageMaker HyperPod cluster instance group and mounted to <code>/opt/sagemaker</code>.</p>
5906
+ * <p>The ID of the customer-managed Elastic Network Interface (ENI) associated with the instance.</p>
5688
5907
  * @public
5689
5908
  */
5690
- interface EbsVolumeConfigMember {
5691
- EbsVolumeConfig: ClusterEbsVolumeConfig;
5692
- $unknown?: never;
5693
- }
5909
+ CustomerEni?: string | undefined;
5694
5910
  /**
5911
+ * <p>Information about additional Elastic Network Interfaces (ENIs) associated with the instance.</p>
5695
5912
  * @public
5696
5913
  */
5697
- interface $UnknownMember {
5698
- EbsVolumeConfig?: never;
5699
- $unknown: [string, any];
5700
- }
5701
- interface Visitor<T> {
5702
- EbsVolumeConfig: (value: ClusterEbsVolumeConfig) => T;
5703
- _: (name: string, value: any) => T;
5704
- }
5705
- const visit: <T>(value: ClusterInstanceStorageConfig, visitor: Visitor<T>) => T;
5914
+ AdditionalEnis?: AdditionalEnis | undefined;
5915
+ /**
5916
+ * <p>Information about the Capacity Reservation used by the instance.</p>
5917
+ * @public
5918
+ */
5919
+ CapacityReservation?: CapacityReservation | undefined;
5920
+ /**
5921
+ * <p>An error message describing why the instance creation or update failed, if applicable.</p>
5922
+ * @public
5923
+ */
5924
+ FailureMessage?: string | undefined;
5925
+ /**
5926
+ * <p>The execution state of the Lifecycle Script (LCS) for the instance.</p>
5927
+ * @public
5928
+ */
5929
+ LcsExecutionState?: string | undefined;
5930
+ /**
5931
+ * <p>The unique logical identifier of the node within the cluster. The ID used here is the same object as in the <code>BatchAddClusterNodes</code> API.</p>
5932
+ * @public
5933
+ */
5934
+ NodeLogicalId?: string | undefined;
5706
5935
  }
5707
5936
  /**
5937
+ * <p>Metadata information about an instance group in a SageMaker HyperPod cluster.</p>
5708
5938
  * @public
5709
- * @enum
5710
5939
  */
5711
- export declare const ClusterInstanceType: {
5712
- readonly ML_C5N_18XLARGE: "ml.c5n.18xlarge";
5713
- readonly ML_C5N_2XLARGE: "ml.c5n.2xlarge";
5714
- readonly ML_C5N_4XLARGE: "ml.c5n.4xlarge";
5715
- readonly ML_C5N_9XLARGE: "ml.c5n.9xlarge";
5716
- readonly ML_C5N_LARGE: "ml.c5n.large";
5717
- readonly ML_C5_12XLARGE: "ml.c5.12xlarge";
5718
- readonly ML_C5_18XLARGE: "ml.c5.18xlarge";
5719
- readonly ML_C5_24XLARGE: "ml.c5.24xlarge";
5720
- readonly ML_C5_2XLARGE: "ml.c5.2xlarge";
5721
- readonly ML_C5_4XLARGE: "ml.c5.4xlarge";
5722
- readonly ML_C5_9XLARGE: "ml.c5.9xlarge";
5723
- readonly ML_C5_LARGE: "ml.c5.large";
5724
- readonly ML_C5_XLARGE: "ml.c5.xlarge";
5725
- readonly ML_C6I_12XLARGE: "ml.c6i.12xlarge";
5726
- readonly ML_C6I_16XLARGE: "ml.c6i.16xlarge";
5727
- readonly ML_C6I_24XLARGE: "ml.c6i.24xlarge";
5728
- readonly ML_C6I_2XLARGE: "ml.c6i.2xlarge";
5729
- readonly ML_C6I_32XLARGE: "ml.c6i.32xlarge";
5730
- readonly ML_C6I_4XLARGE: "ml.c6i.4xlarge";
5731
- readonly ML_C6I_8XLARGE: "ml.c6i.8xlarge";
5732
- readonly ML_C6I_LARGE: "ml.c6i.large";
5733
- readonly ML_C6I_XLARGE: "ml.c6i.xlarge";
5734
- readonly ML_G5_12XLARGE: "ml.g5.12xlarge";
5735
- readonly ML_G5_16XLARGE: "ml.g5.16xlarge";
5736
- readonly ML_G5_24XLARGE: "ml.g5.24xlarge";
5737
- readonly ML_G5_2XLARGE: "ml.g5.2xlarge";
5738
- readonly ML_G5_48XLARGE: "ml.g5.48xlarge";
5739
- readonly ML_G5_4XLARGE: "ml.g5.4xlarge";
5740
- readonly ML_G5_8XLARGE: "ml.g5.8xlarge";
5741
- readonly ML_G5_XLARGE: "ml.g5.xlarge";
5742
- readonly ML_G6E_12XLARGE: "ml.g6e.12xlarge";
5743
- readonly ML_G6E_16XLARGE: "ml.g6e.16xlarge";
5744
- readonly ML_G6E_24XLARGE: "ml.g6e.24xlarge";
5745
- readonly ML_G6E_2XLARGE: "ml.g6e.2xlarge";
5746
- readonly ML_G6E_48XLARGE: "ml.g6e.48xlarge";
5747
- readonly ML_G6E_4XLARGE: "ml.g6e.4xlarge";
5748
- readonly ML_G6E_8XLARGE: "ml.g6e.8xlarge";
5749
- readonly ML_G6E_XLARGE: "ml.g6e.xlarge";
5750
- readonly ML_G6_12XLARGE: "ml.g6.12xlarge";
5751
- readonly ML_G6_16XLARGE: "ml.g6.16xlarge";
5752
- readonly ML_G6_24XLARGE: "ml.g6.24xlarge";
5753
- readonly ML_G6_2XLARGE: "ml.g6.2xlarge";
5754
- readonly ML_G6_48XLARGE: "ml.g6.48xlarge";
5755
- readonly ML_G6_4XLARGE: "ml.g6.4xlarge";
5756
- readonly ML_G6_8XLARGE: "ml.g6.8xlarge";
5757
- readonly ML_G6_XLARGE: "ml.g6.xlarge";
5758
- readonly ML_GR6_4XLARGE: "ml.gr6.4xlarge";
5940
+ export interface InstanceGroupMetadata {
5941
+ /**
5942
+ * <p>An error message describing why the instance group level operation (such as creating, scaling, or deleting) failed.</p>
5943
+ * @public
5944
+ */
5945
+ FailureMessage?: string | undefined;
5946
+ /**
5947
+ * <p>The ID of the Availability Zone where the instance group is located.</p>
5948
+ * @public
5949
+ */
5950
+ AvailabilityZoneId?: string | undefined;
5951
+ /**
5952
+ * <p>Information about the Capacity Reservation used by the instance group.</p>
5953
+ * @public
5954
+ */
5955
+ CapacityReservation?: CapacityReservation | undefined;
5956
+ /**
5957
+ * <p>The ID of the subnet where the instance group is located.</p>
5958
+ * @public
5959
+ */
5960
+ SubnetId?: string | undefined;
5961
+ /**
5962
+ * <p>A list of security group IDs associated with the instance group.</p>
5963
+ * @public
5964
+ */
5965
+ SecurityGroupIds?: string[] | undefined;
5966
+ /**
5967
+ * <p>If you use a custom Amazon Machine Image (AMI) for the instance group, this field shows the ID of the custom AMI.</p>
5968
+ * @public
5969
+ */
5970
+ AmiOverride?: string | undefined;
5971
+ }
5972
+ /**
5973
+ * <p>Metadata information about scaling operations for an instance group.</p>
5974
+ * @public
5975
+ */
5976
+ export interface InstanceGroupScalingMetadata {
5977
+ /**
5978
+ * <p>The current number of instances in the group.</p>
5979
+ * @public
5980
+ */
5981
+ InstanceCount?: number | undefined;
5982
+ /**
5983
+ * <p>The desired number of instances for the group after scaling.</p>
5984
+ * @public
5985
+ */
5986
+ TargetCount?: number | undefined;
5987
+ /**
5988
+ * <p>An error message describing why the scaling operation failed, if applicable.</p>
5989
+ * @public
5990
+ */
5991
+ FailureMessage?: string | undefined;
5992
+ }
5993
+ /**
5994
+ * <p>Metadata associated with a cluster event, which may include details about various resource types.</p>
5995
+ * @public
5996
+ */
5997
+ export type EventMetadata = EventMetadata.ClusterMember | EventMetadata.InstanceMember | EventMetadata.InstanceGroupMember | EventMetadata.InstanceGroupScalingMember | EventMetadata.$UnknownMember;
5998
+ /**
5999
+ * @public
6000
+ */
6001
+ export declare namespace EventMetadata {
6002
+ /**
6003
+ * <p>Metadata specific to cluster-level events.</p>
6004
+ * @public
6005
+ */
6006
+ interface ClusterMember {
6007
+ Cluster: ClusterMetadata;
6008
+ InstanceGroup?: never;
6009
+ InstanceGroupScaling?: never;
6010
+ Instance?: never;
6011
+ $unknown?: never;
6012
+ }
6013
+ /**
6014
+ * <p>Metadata specific to instance group-level events.</p>
6015
+ * @public
6016
+ */
6017
+ interface InstanceGroupMember {
6018
+ Cluster?: never;
6019
+ InstanceGroup: InstanceGroupMetadata;
6020
+ InstanceGroupScaling?: never;
6021
+ Instance?: never;
6022
+ $unknown?: never;
6023
+ }
6024
+ /**
6025
+ * <p>Metadata related to instance group scaling events.</p>
6026
+ * @public
6027
+ */
6028
+ interface InstanceGroupScalingMember {
6029
+ Cluster?: never;
6030
+ InstanceGroup?: never;
6031
+ InstanceGroupScaling: InstanceGroupScalingMetadata;
6032
+ Instance?: never;
6033
+ $unknown?: never;
6034
+ }
6035
+ /**
6036
+ * <p>Metadata specific to instance-level events.</p>
6037
+ * @public
6038
+ */
6039
+ interface InstanceMember {
6040
+ Cluster?: never;
6041
+ InstanceGroup?: never;
6042
+ InstanceGroupScaling?: never;
6043
+ Instance: InstanceMetadata;
6044
+ $unknown?: never;
6045
+ }
6046
+ /**
6047
+ * @public
6048
+ */
6049
+ interface $UnknownMember {
6050
+ Cluster?: never;
6051
+ InstanceGroup?: never;
6052
+ InstanceGroupScaling?: never;
6053
+ Instance?: never;
6054
+ $unknown: [string, any];
6055
+ }
6056
+ interface Visitor<T> {
6057
+ Cluster: (value: ClusterMetadata) => T;
6058
+ InstanceGroup: (value: InstanceGroupMetadata) => T;
6059
+ InstanceGroupScaling: (value: InstanceGroupScalingMetadata) => T;
6060
+ Instance: (value: InstanceMetadata) => T;
6061
+ _: (name: string, value: any) => T;
6062
+ }
6063
+ const visit: <T>(value: EventMetadata, visitor: Visitor<T>) => T;
6064
+ }
6065
+ /**
6066
+ * <p>Detailed information about a specific event, including event metadata.</p>
6067
+ * @public
6068
+ */
6069
+ export interface EventDetails {
6070
+ /**
6071
+ * <p>Metadata specific to the event, which may include information about the cluster, instance group, or instance involved.</p>
6072
+ * @public
6073
+ */
6074
+ EventMetadata?: EventMetadata | undefined;
6075
+ }
6076
+ /**
6077
+ * @public
6078
+ * @enum
6079
+ */
6080
+ export declare const ClusterEventResourceType: {
6081
+ readonly CLUSTER: "Cluster";
6082
+ readonly INSTANCE: "Instance";
6083
+ readonly INSTANCE_GROUP: "InstanceGroup";
6084
+ };
6085
+ /**
6086
+ * @public
6087
+ */
6088
+ export type ClusterEventResourceType = (typeof ClusterEventResourceType)[keyof typeof ClusterEventResourceType];
6089
+ /**
6090
+ * <p>Detailed information about a specific event in a HyperPod cluster.</p>
6091
+ * @public
6092
+ */
6093
+ export interface ClusterEventDetail {
6094
+ /**
6095
+ * <p>The unique identifier (UUID) of the event.</p>
6096
+ * @public
6097
+ */
6098
+ EventId: string | undefined;
6099
+ /**
6100
+ * <p>The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster associated with the event.</p>
6101
+ * @public
6102
+ */
6103
+ ClusterArn: string | undefined;
6104
+ /**
6105
+ * <p>The name of the SageMaker HyperPod cluster associated with the event.</p>
6106
+ * @public
6107
+ */
6108
+ ClusterName: string | undefined;
6109
+ /**
6110
+ * <p>The name of the instance group associated with the event, if applicable.</p>
6111
+ * @public
6112
+ */
6113
+ InstanceGroupName?: string | undefined;
6114
+ /**
6115
+ * <p>The EC2 instance ID associated with the event, if applicable.</p>
6116
+ * @public
6117
+ */
6118
+ InstanceId?: string | undefined;
6119
+ /**
6120
+ * <p>The type of resource associated with the event. Valid values are "Cluster", "InstanceGroup", or "Instance".</p>
6121
+ * @public
6122
+ */
6123
+ ResourceType: ClusterEventResourceType | undefined;
6124
+ /**
6125
+ * <p>The timestamp when the event occurred.</p>
6126
+ * @public
6127
+ */
6128
+ EventTime: Date | undefined;
6129
+ /**
6130
+ * <p>Additional details about the event, including event-specific metadata.</p>
6131
+ * @public
6132
+ */
6133
+ EventDetails?: EventDetails | undefined;
6134
+ /**
6135
+ * <p>A human-readable description of the event.</p>
6136
+ * @public
6137
+ */
6138
+ Description?: string | undefined;
6139
+ }
6140
+ /**
6141
+ * <p>A summary of an event in a SageMaker HyperPod cluster.</p>
6142
+ * @public
6143
+ */
6144
+ export interface ClusterEventSummary {
6145
+ /**
6146
+ * <p>The unique identifier (UUID) of the event.</p>
6147
+ * @public
6148
+ */
6149
+ EventId: string | undefined;
6150
+ /**
6151
+ * <p>The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster associated with the event.</p>
6152
+ * @public
6153
+ */
6154
+ ClusterArn: string | undefined;
6155
+ /**
6156
+ * <p>The name of the SageMaker HyperPod cluster associated with the event.</p>
6157
+ * @public
6158
+ */
6159
+ ClusterName: string | undefined;
6160
+ /**
6161
+ * <p>The name of the instance group associated with the event, if applicable.</p>
6162
+ * @public
6163
+ */
6164
+ InstanceGroupName?: string | undefined;
6165
+ /**
6166
+ * <p>The EC2 instance ID associated with the event, if applicable.</p>
6167
+ * @public
6168
+ */
6169
+ InstanceId?: string | undefined;
6170
+ /**
6171
+ * <p>The type of resource associated with the event. Valid values are "Cluster", "InstanceGroup", or "Instance".</p>
6172
+ * @public
6173
+ */
6174
+ ResourceType: ClusterEventResourceType | undefined;
6175
+ /**
6176
+ * <p>The timestamp when the event occurred.</p>
6177
+ * @public
6178
+ */
6179
+ EventTime: Date | undefined;
6180
+ /**
6181
+ * <p>A brief, human-readable description of the event.</p>
6182
+ * @public
6183
+ */
6184
+ Description?: string | undefined;
6185
+ }
6186
+ /**
6187
+ * <p>Defines the configuration for attaching additional storage to the instances in the SageMaker HyperPod cluster instance group. To learn more, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-hyperpod-release-notes.html#sagemaker-hyperpod-release-notes-20240620">SageMaker HyperPod release notes: June 20, 2024</a>.</p>
6188
+ * @public
6189
+ */
6190
+ export type ClusterInstanceStorageConfig = ClusterInstanceStorageConfig.EbsVolumeConfigMember | ClusterInstanceStorageConfig.$UnknownMember;
6191
+ /**
6192
+ * @public
6193
+ */
6194
+ export declare namespace ClusterInstanceStorageConfig {
6195
+ /**
6196
+ * <p>Defines the configuration for attaching additional Amazon Elastic Block Store (EBS) volumes to the instances in the SageMaker HyperPod cluster instance group. The additional EBS volume is attached to each instance within the SageMaker HyperPod cluster instance group and mounted to <code>/opt/sagemaker</code>.</p>
6197
+ * @public
6198
+ */
6199
+ interface EbsVolumeConfigMember {
6200
+ EbsVolumeConfig: ClusterEbsVolumeConfig;
6201
+ $unknown?: never;
6202
+ }
6203
+ /**
6204
+ * @public
6205
+ */
6206
+ interface $UnknownMember {
6207
+ EbsVolumeConfig?: never;
6208
+ $unknown: [string, any];
6209
+ }
6210
+ interface Visitor<T> {
6211
+ EbsVolumeConfig: (value: ClusterEbsVolumeConfig) => T;
6212
+ _: (name: string, value: any) => T;
6213
+ }
6214
+ const visit: <T>(value: ClusterInstanceStorageConfig, visitor: Visitor<T>) => T;
6215
+ }
6216
+ /**
6217
+ * @public
6218
+ * @enum
6219
+ */
6220
+ export declare const ClusterInstanceType: {
6221
+ readonly ML_C5N_18XLARGE: "ml.c5n.18xlarge";
6222
+ readonly ML_C5N_2XLARGE: "ml.c5n.2xlarge";
6223
+ readonly ML_C5N_4XLARGE: "ml.c5n.4xlarge";
6224
+ readonly ML_C5N_9XLARGE: "ml.c5n.9xlarge";
6225
+ readonly ML_C5N_LARGE: "ml.c5n.large";
6226
+ readonly ML_C5_12XLARGE: "ml.c5.12xlarge";
6227
+ readonly ML_C5_18XLARGE: "ml.c5.18xlarge";
6228
+ readonly ML_C5_24XLARGE: "ml.c5.24xlarge";
6229
+ readonly ML_C5_2XLARGE: "ml.c5.2xlarge";
6230
+ readonly ML_C5_4XLARGE: "ml.c5.4xlarge";
6231
+ readonly ML_C5_9XLARGE: "ml.c5.9xlarge";
6232
+ readonly ML_C5_LARGE: "ml.c5.large";
6233
+ readonly ML_C5_XLARGE: "ml.c5.xlarge";
6234
+ readonly ML_C6I_12XLARGE: "ml.c6i.12xlarge";
6235
+ readonly ML_C6I_16XLARGE: "ml.c6i.16xlarge";
6236
+ readonly ML_C6I_24XLARGE: "ml.c6i.24xlarge";
6237
+ readonly ML_C6I_2XLARGE: "ml.c6i.2xlarge";
6238
+ readonly ML_C6I_32XLARGE: "ml.c6i.32xlarge";
6239
+ readonly ML_C6I_4XLARGE: "ml.c6i.4xlarge";
6240
+ readonly ML_C6I_8XLARGE: "ml.c6i.8xlarge";
6241
+ readonly ML_C6I_LARGE: "ml.c6i.large";
6242
+ readonly ML_C6I_XLARGE: "ml.c6i.xlarge";
6243
+ readonly ML_G5_12XLARGE: "ml.g5.12xlarge";
6244
+ readonly ML_G5_16XLARGE: "ml.g5.16xlarge";
6245
+ readonly ML_G5_24XLARGE: "ml.g5.24xlarge";
6246
+ readonly ML_G5_2XLARGE: "ml.g5.2xlarge";
6247
+ readonly ML_G5_48XLARGE: "ml.g5.48xlarge";
6248
+ readonly ML_G5_4XLARGE: "ml.g5.4xlarge";
6249
+ readonly ML_G5_8XLARGE: "ml.g5.8xlarge";
6250
+ readonly ML_G5_XLARGE: "ml.g5.xlarge";
6251
+ readonly ML_G6E_12XLARGE: "ml.g6e.12xlarge";
6252
+ readonly ML_G6E_16XLARGE: "ml.g6e.16xlarge";
6253
+ readonly ML_G6E_24XLARGE: "ml.g6e.24xlarge";
6254
+ readonly ML_G6E_2XLARGE: "ml.g6e.2xlarge";
6255
+ readonly ML_G6E_48XLARGE: "ml.g6e.48xlarge";
6256
+ readonly ML_G6E_4XLARGE: "ml.g6e.4xlarge";
6257
+ readonly ML_G6E_8XLARGE: "ml.g6e.8xlarge";
6258
+ readonly ML_G6E_XLARGE: "ml.g6e.xlarge";
6259
+ readonly ML_G6_12XLARGE: "ml.g6.12xlarge";
6260
+ readonly ML_G6_16XLARGE: "ml.g6.16xlarge";
6261
+ readonly ML_G6_24XLARGE: "ml.g6.24xlarge";
6262
+ readonly ML_G6_2XLARGE: "ml.g6.2xlarge";
6263
+ readonly ML_G6_48XLARGE: "ml.g6.48xlarge";
6264
+ readonly ML_G6_4XLARGE: "ml.g6.4xlarge";
6265
+ readonly ML_G6_8XLARGE: "ml.g6.8xlarge";
6266
+ readonly ML_G6_XLARGE: "ml.g6.xlarge";
6267
+ readonly ML_GR6_4XLARGE: "ml.gr6.4xlarge";
5759
6268
  readonly ML_GR6_8XLARGE: "ml.gr6.8xlarge";
5760
6269
  readonly ML_I3EN_12XLARGE: "ml.i3en.12xlarge";
5761
6270
  readonly ML_I3EN_24XLARGE: "ml.i3en.24xlarge";
@@ -5999,6 +6508,16 @@ export interface ClusterInstanceGroupDetails {
5999
6508
  * @public
6000
6509
  */
6001
6510
  ScheduledUpdateConfig?: ScheduledUpdateConfig | undefined;
6511
+ /**
6512
+ * <p>The ID of the Amazon Machine Image (AMI) currently in use by the instance group.</p>
6513
+ * @public
6514
+ */
6515
+ CurrentImageId?: string | undefined;
6516
+ /**
6517
+ * <p>The ID of the Amazon Machine Image (AMI) desired for the instance group.</p>
6518
+ * @public
6519
+ */
6520
+ DesiredImageId?: string | undefined;
6002
6521
  }
6003
6522
  /**
6004
6523
  * <p>The specifications of an instance group that you need to define.</p>
@@ -6060,6 +6579,11 @@ export interface ClusterInstanceGroupSpecification {
6060
6579
  * @public
6061
6580
  */
6062
6581
  ScheduledUpdateConfig?: ScheduledUpdateConfig | undefined;
6582
+ /**
6583
+ * <p>When configuring your HyperPod cluster, you can specify an image ID using one of the following options:</p> <ul> <li> <p> <code>HyperPodPublicAmiId</code>: Use a HyperPod public AMI</p> </li> <li> <p> <code>CustomAmiId</code>: Use your custom AMI</p> </li> <li> <p> <code>default</code>: Use the default latest system image</p> </li> </ul> <p>f you choose to use a custom AMI (<code>CustomAmiId</code>), ensure it meets the following requirements:</p> <ul> <li> <p>Encryption: The custom AMI must be unencrypted.</p> </li> <li> <p>Ownership: The custom AMI must be owned by the same Amazon Web Services account that is creating the HyperPod cluster.</p> </li> <li> <p>Volume support: Only the primary AMI snapshot volume is supported; additional AMI volumes are not supported.</p> </li> </ul> <p>When updating the instance group's AMI through the <code>UpdateClusterSoftware</code> operation, if an instance group uses a custom AMI, you must provide an <code>ImageId</code> or use the default as input.</p>
6584
+ * @public
6585
+ */
6586
+ ImageId?: string | undefined;
6063
6587
  }
6064
6588
  /**
6065
6589
  * <p>Specifies the placement details for the node in the SageMaker HyperPod cluster, including the Availability Zone and the unique identifier (ID) of the Availability Zone.</p>
@@ -6078,23 +6602,7 @@ export interface ClusterInstancePlacement {
6078
6602
  AvailabilityZoneId?: string | undefined;
6079
6603
  }
6080
6604
  /**
6081
- * @public
6082
- * @enum
6083
- */
6084
- export declare const ClusterInstanceStatus: {
6085
- readonly DEEP_HEALTH_CHECK_IN_PROGRESS: "DeepHealthCheckInProgress";
6086
- readonly FAILURE: "Failure";
6087
- readonly PENDING: "Pending";
6088
- readonly RUNNING: "Running";
6089
- readonly SHUTTING_DOWN: "ShuttingDown";
6090
- readonly SYSTEM_UPDATING: "SystemUpdating";
6091
- };
6092
- /**
6093
- * @public
6094
- */
6095
- export type ClusterInstanceStatus = (typeof ClusterInstanceStatus)[keyof typeof ClusterInstanceStatus];
6096
- /**
6097
- * <p>Details of an instance in a SageMaker HyperPod cluster.</p>
6605
+ * <p>Details of an instance in a SageMaker HyperPod cluster.</p>
6098
6606
  * @public
6099
6607
  */
6100
6608
  export interface ClusterInstanceStatusDetails {
@@ -6124,6 +6632,11 @@ export interface ClusterNodeDetails {
6124
6632
  * @public
6125
6633
  */
6126
6634
  InstanceId?: string | undefined;
6635
+ /**
6636
+ * <p>A unique identifier for the node that persists throughout its lifecycle, from provisioning request to termination. This identifier can be used to track the node even before it has an assigned <code>InstanceId</code>.</p>
6637
+ * @public
6638
+ */
6639
+ NodeLogicalId?: string | undefined;
6127
6640
  /**
6128
6641
  * <p>The status of the instance.</p>
6129
6642
  * @public
@@ -6184,7 +6697,28 @@ export interface ClusterNodeDetails {
6184
6697
  * @public
6185
6698
  */
6186
6699
  Placement?: ClusterInstancePlacement | undefined;
6700
+ /**
6701
+ * <p>The ID of the Amazon Machine Image (AMI) currently in use by the node.</p>
6702
+ * @public
6703
+ */
6704
+ CurrentImageId?: string | undefined;
6705
+ /**
6706
+ * <p>The ID of the Amazon Machine Image (AMI) desired for the node.</p>
6707
+ * @public
6708
+ */
6709
+ DesiredImageId?: string | undefined;
6187
6710
  }
6711
+ /**
6712
+ * @public
6713
+ * @enum
6714
+ */
6715
+ export declare const ClusterNodeProvisioningMode: {
6716
+ readonly CONTINUOUS: "Continuous";
6717
+ };
6718
+ /**
6719
+ * @public
6720
+ */
6721
+ export type ClusterNodeProvisioningMode = (typeof ClusterNodeProvisioningMode)[keyof typeof ClusterNodeProvisioningMode];
6188
6722
  /**
6189
6723
  * @public
6190
6724
  * @enum
@@ -6212,6 +6746,11 @@ export interface ClusterNodeSummary {
6212
6746
  * @public
6213
6747
  */
6214
6748
  InstanceId: string | undefined;
6749
+ /**
6750
+ * <p>A unique identifier for the node that persists throughout its lifecycle, from provisioning request to termination. This identifier can be used to track the node even before it has an assigned <code>InstanceId</code>. This field is only included when <code>IncludeNodeLogicalIds</code> is set to <code>True</code> in the <code>ListClusterNodes</code> request.</p>
6751
+ * @public
6752
+ */
6753
+ NodeLogicalId?: string | undefined;
6215
6754
  /**
6216
6755
  * <p>The type of the instance.</p>
6217
6756
  * @public
@@ -6532,446 +7071,3 @@ export declare const ClusterStatus: {
6532
7071
  * @public
6533
7072
  */
6534
7073
  export type ClusterStatus = (typeof ClusterStatus)[keyof typeof ClusterStatus];
6535
- /**
6536
- * <p>Lists a summary of the properties of a SageMaker HyperPod cluster.</p>
6537
- * @public
6538
- */
6539
- export interface ClusterSummary {
6540
- /**
6541
- * <p>The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster.</p>
6542
- * @public
6543
- */
6544
- ClusterArn: string | undefined;
6545
- /**
6546
- * <p>The name of the SageMaker HyperPod cluster.</p>
6547
- * @public
6548
- */
6549
- ClusterName: string | undefined;
6550
- /**
6551
- * <p>The time when the SageMaker HyperPod cluster is created.</p>
6552
- * @public
6553
- */
6554
- CreationTime: Date | undefined;
6555
- /**
6556
- * <p>The status of the SageMaker HyperPod cluster.</p>
6557
- * @public
6558
- */
6559
- ClusterStatus: ClusterStatus | undefined;
6560
- /**
6561
- * <p>A list of Amazon Resource Names (ARNs) of the training plans associated with this cluster.</p> <p>For more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see <code> <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingPlan.html">CreateTrainingPlan</a> </code>.</p>
6562
- * @public
6563
- */
6564
- TrainingPlanArns?: string[] | undefined;
6565
- }
6566
- /**
6567
- * <p>A custom SageMaker AI image. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/studio-byoi.html">Bring your own SageMaker AI image</a>.</p>
6568
- * @public
6569
- */
6570
- export interface CustomImage {
6571
- /**
6572
- * <p>The name of the CustomImage. Must be unique to your account.</p>
6573
- * @public
6574
- */
6575
- ImageName: string | undefined;
6576
- /**
6577
- * <p>The version number of the CustomImage.</p>
6578
- * @public
6579
- */
6580
- ImageVersionNumber?: number | undefined;
6581
- /**
6582
- * <p>The name of the AppImageConfig.</p>
6583
- * @public
6584
- */
6585
- AppImageConfigName: string | undefined;
6586
- }
6587
- /**
6588
- * <p>The Code Editor application settings.</p> <p>For more information about Code Editor, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/code-editor.html">Get started with Code Editor in Amazon SageMaker</a>.</p>
6589
- * @public
6590
- */
6591
- export interface CodeEditorAppSettings {
6592
- /**
6593
- * <p>Specifies the ARN's of a SageMaker AI image and SageMaker AI image version, and the instance type that the version runs on.</p> <note> <p>When both <code>SageMakerImageVersionArn</code> and <code>SageMakerImageArn</code> are passed, <code>SageMakerImageVersionArn</code> is used. Any updates to <code>SageMakerImageArn</code> will not take effect if <code>SageMakerImageVersionArn</code> already exists in the <code>ResourceSpec</code> because <code>SageMakerImageVersionArn</code> always takes precedence. To clear the value set for <code>SageMakerImageVersionArn</code>, pass <code>None</code> as the value.</p> </note>
6594
- * @public
6595
- */
6596
- DefaultResourceSpec?: ResourceSpec | undefined;
6597
- /**
6598
- * <p>A list of custom SageMaker images that are configured to run as a Code Editor app.</p>
6599
- * @public
6600
- */
6601
- CustomImages?: CustomImage[] | undefined;
6602
- /**
6603
- * <p>The Amazon Resource Name (ARN) of the Code Editor application lifecycle configuration.</p>
6604
- * @public
6605
- */
6606
- LifecycleConfigArns?: string[] | undefined;
6607
- /**
6608
- * <p>Settings that are used to configure and manage the lifecycle of CodeEditor applications.</p>
6609
- * @public
6610
- */
6611
- AppLifecycleManagement?: AppLifecycleManagement | undefined;
6612
- /**
6613
- * <p>The lifecycle configuration that runs before the default lifecycle configuration. It can override changes made in the default lifecycle configuration.</p>
6614
- * @public
6615
- */
6616
- BuiltInLifecycleConfigArn?: string | undefined;
6617
- }
6618
- /**
6619
- * <p>A Git repository that SageMaker AI automatically displays to users for cloning in the JupyterServer application.</p>
6620
- * @public
6621
- */
6622
- export interface CodeRepository {
6623
- /**
6624
- * <p>The URL of the Git repository.</p>
6625
- * @public
6626
- */
6627
- RepositoryUrl: string | undefined;
6628
- }
6629
- /**
6630
- * @public
6631
- * @enum
6632
- */
6633
- export declare const CodeRepositorySortBy: {
6634
- readonly CREATION_TIME: "CreationTime";
6635
- readonly LAST_MODIFIED_TIME: "LastModifiedTime";
6636
- readonly NAME: "Name";
6637
- };
6638
- /**
6639
- * @public
6640
- */
6641
- export type CodeRepositorySortBy = (typeof CodeRepositorySortBy)[keyof typeof CodeRepositorySortBy];
6642
- /**
6643
- * @public
6644
- * @enum
6645
- */
6646
- export declare const CodeRepositorySortOrder: {
6647
- readonly ASCENDING: "Ascending";
6648
- readonly DESCENDING: "Descending";
6649
- };
6650
- /**
6651
- * @public
6652
- */
6653
- export type CodeRepositorySortOrder = (typeof CodeRepositorySortOrder)[keyof typeof CodeRepositorySortOrder];
6654
- /**
6655
- * <p>Specifies configuration details for a Git repository in your Amazon Web Services account.</p>
6656
- * @public
6657
- */
6658
- export interface GitConfig {
6659
- /**
6660
- * <p>The URL where the Git repository is located.</p>
6661
- * @public
6662
- */
6663
- RepositoryUrl: string | undefined;
6664
- /**
6665
- * <p>The default branch for the Git repository.</p>
6666
- * @public
6667
- */
6668
- Branch?: string | undefined;
6669
- /**
6670
- * <p>The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that contains the credentials used to access the git repository. The secret must have a staging label of <code>AWSCURRENT</code> and must be in the following format:</p> <p> <code>\{"username": <i>UserName</i>, "password": <i>Password</i>\}</code> </p>
6671
- * @public
6672
- */
6673
- SecretArn?: string | undefined;
6674
- }
6675
- /**
6676
- * <p>Specifies summary information about a Git repository.</p>
6677
- * @public
6678
- */
6679
- export interface CodeRepositorySummary {
6680
- /**
6681
- * <p>The name of the Git repository.</p>
6682
- * @public
6683
- */
6684
- CodeRepositoryName: string | undefined;
6685
- /**
6686
- * <p>The Amazon Resource Name (ARN) of the Git repository.</p>
6687
- * @public
6688
- */
6689
- CodeRepositoryArn: string | undefined;
6690
- /**
6691
- * <p>The date and time that the Git repository was created.</p>
6692
- * @public
6693
- */
6694
- CreationTime: Date | undefined;
6695
- /**
6696
- * <p>The date and time that the Git repository was last modified.</p>
6697
- * @public
6698
- */
6699
- LastModifiedTime: Date | undefined;
6700
- /**
6701
- * <p>Configuration details for the Git repository, including the URL where it is located and the ARN of the Amazon Web Services Secrets Manager secret that contains the credentials used to access the repository.</p>
6702
- * @public
6703
- */
6704
- GitConfig?: GitConfig | undefined;
6705
- }
6706
- /**
6707
- * <p>Use this parameter to configure your Amazon Cognito workforce. A single Cognito workforce is created using and corresponds to a single <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools.html"> Amazon Cognito user pool</a>.</p>
6708
- * @public
6709
- */
6710
- export interface CognitoConfig {
6711
- /**
6712
- * <p>A <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools.html"> user pool</a> is a user directory in Amazon Cognito. With a user pool, your users can sign in to your web or mobile app through Amazon Cognito. Your users can also sign in through social identity providers like Google, Facebook, Amazon, or Apple, and through SAML identity providers.</p>
6713
- * @public
6714
- */
6715
- UserPool: string | undefined;
6716
- /**
6717
- * <p>The client ID for your Amazon Cognito user pool.</p>
6718
- * @public
6719
- */
6720
- ClientId: string | undefined;
6721
- }
6722
- /**
6723
- * <p>Identifies a Amazon Cognito user group. A user group can be used in on or more work teams.</p>
6724
- * @public
6725
- */
6726
- export interface CognitoMemberDefinition {
6727
- /**
6728
- * <p>An identifier for a user pool. The user pool must be in the same region as the service that you are calling.</p>
6729
- * @public
6730
- */
6731
- UserPool: string | undefined;
6732
- /**
6733
- * <p>An identifier for a user group.</p>
6734
- * @public
6735
- */
6736
- UserGroup: string | undefined;
6737
- /**
6738
- * <p>An identifier for an application client. You must create the app client ID using Amazon Cognito.</p>
6739
- * @public
6740
- */
6741
- ClientId: string | undefined;
6742
- }
6743
- /**
6744
- * <p>Configuration for your vector collection type.</p>
6745
- * @public
6746
- */
6747
- export interface VectorConfig {
6748
- /**
6749
- * <p>The number of elements in your vector.</p>
6750
- * @public
6751
- */
6752
- Dimension: number | undefined;
6753
- }
6754
- /**
6755
- * <p>Configuration for your collection.</p>
6756
- * @public
6757
- */
6758
- export type CollectionConfig = CollectionConfig.VectorConfigMember | CollectionConfig.$UnknownMember;
6759
- /**
6760
- * @public
6761
- */
6762
- export declare namespace CollectionConfig {
6763
- /**
6764
- * <p>Configuration for your vector collection type.</p> <ul> <li> <p> <code>Dimension</code>: The number of elements in your vector.</p> </li> </ul>
6765
- * @public
6766
- */
6767
- interface VectorConfigMember {
6768
- VectorConfig: VectorConfig;
6769
- $unknown?: never;
6770
- }
6771
- /**
6772
- * @public
6773
- */
6774
- interface $UnknownMember {
6775
- VectorConfig?: never;
6776
- $unknown: [string, any];
6777
- }
6778
- interface Visitor<T> {
6779
- VectorConfig: (value: VectorConfig) => T;
6780
- _: (name: string, value: any) => T;
6781
- }
6782
- const visit: <T>(value: CollectionConfig, visitor: Visitor<T>) => T;
6783
- }
6784
- /**
6785
- * <p>Configuration information for the Amazon SageMaker Debugger output tensor collections.</p>
6786
- * @public
6787
- */
6788
- export interface CollectionConfiguration {
6789
- /**
6790
- * <p>The name of the tensor collection. The name must be unique relative to other rule configuration names.</p>
6791
- * @public
6792
- */
6793
- CollectionName?: string | undefined;
6794
- /**
6795
- * <p>Parameter values for the tensor collection. The allowed parameters are <code>"name"</code>, <code>"include_regex"</code>, <code>"reduction_config"</code>, <code>"save_config"</code>, <code>"tensor_names"</code>, and <code>"save_histogram"</code>.</p>
6796
- * @public
6797
- */
6798
- CollectionParameters?: Record<string, string> | undefined;
6799
- }
6800
- /**
6801
- * @public
6802
- * @enum
6803
- */
6804
- export declare const CollectionType: {
6805
- readonly LIST: "List";
6806
- readonly SET: "Set";
6807
- readonly VECTOR: "Vector";
6808
- };
6809
- /**
6810
- * @public
6811
- */
6812
- export type CollectionType = (typeof CollectionType)[keyof typeof CollectionType];
6813
- /**
6814
- * @public
6815
- * @enum
6816
- */
6817
- export declare const CompilationJobStatus: {
6818
- readonly COMPLETED: "COMPLETED";
6819
- readonly FAILED: "FAILED";
6820
- readonly INPROGRESS: "INPROGRESS";
6821
- readonly STARTING: "STARTING";
6822
- readonly STOPPED: "STOPPED";
6823
- readonly STOPPING: "STOPPING";
6824
- };
6825
- /**
6826
- * @public
6827
- */
6828
- export type CompilationJobStatus = (typeof CompilationJobStatus)[keyof typeof CompilationJobStatus];
6829
- /**
6830
- * @public
6831
- * @enum
6832
- */
6833
- export declare const TargetDevice: {
6834
- readonly AISAGE: "aisage";
6835
- readonly AMBA_CV2: "amba_cv2";
6836
- readonly AMBA_CV22: "amba_cv22";
6837
- readonly AMBA_CV25: "amba_cv25";
6838
- readonly COREML: "coreml";
6839
- readonly DEEPLENS: "deeplens";
6840
- readonly IMX8MPLUS: "imx8mplus";
6841
- readonly IMX8QM: "imx8qm";
6842
- readonly JACINTO_TDA4VM: "jacinto_tda4vm";
6843
- readonly JETSON_NANO: "jetson_nano";
6844
- readonly JETSON_TX1: "jetson_tx1";
6845
- readonly JETSON_TX2: "jetson_tx2";
6846
- readonly JETSON_XAVIER: "jetson_xavier";
6847
- readonly LAMBDA: "lambda";
6848
- readonly ML_C4: "ml_c4";
6849
- readonly ML_C5: "ml_c5";
6850
- readonly ML_C6G: "ml_c6g";
6851
- readonly ML_EIA2: "ml_eia2";
6852
- readonly ML_G4DN: "ml_g4dn";
6853
- readonly ML_INF1: "ml_inf1";
6854
- readonly ML_INF2: "ml_inf2";
6855
- readonly ML_M4: "ml_m4";
6856
- readonly ML_M5: "ml_m5";
6857
- readonly ML_M6G: "ml_m6g";
6858
- readonly ML_P2: "ml_p2";
6859
- readonly ML_P3: "ml_p3";
6860
- readonly ML_TRN1: "ml_trn1";
6861
- readonly QCS603: "qcs603";
6862
- readonly QCS605: "qcs605";
6863
- readonly RASP3B: "rasp3b";
6864
- readonly RASP4B: "rasp4b";
6865
- readonly RK3288: "rk3288";
6866
- readonly RK3399: "rk3399";
6867
- readonly SBE_C: "sbe_c";
6868
- readonly SITARA_AM57X: "sitara_am57x";
6869
- readonly X86_WIN32: "x86_win32";
6870
- readonly X86_WIN64: "x86_win64";
6871
- };
6872
- /**
6873
- * @public
6874
- */
6875
- export type TargetDevice = (typeof TargetDevice)[keyof typeof TargetDevice];
6876
- /**
6877
- * @public
6878
- * @enum
6879
- */
6880
- export declare const TargetPlatformAccelerator: {
6881
- readonly INTEL_GRAPHICS: "INTEL_GRAPHICS";
6882
- readonly MALI: "MALI";
6883
- readonly NNA: "NNA";
6884
- readonly NVIDIA: "NVIDIA";
6885
- };
6886
- /**
6887
- * @public
6888
- */
6889
- export type TargetPlatformAccelerator = (typeof TargetPlatformAccelerator)[keyof typeof TargetPlatformAccelerator];
6890
- /**
6891
- * @public
6892
- * @enum
6893
- */
6894
- export declare const TargetPlatformArch: {
6895
- readonly ARM64: "ARM64";
6896
- readonly ARM_EABI: "ARM_EABI";
6897
- readonly ARM_EABIHF: "ARM_EABIHF";
6898
- readonly X86: "X86";
6899
- readonly X86_64: "X86_64";
6900
- };
6901
- /**
6902
- * @public
6903
- */
6904
- export type TargetPlatformArch = (typeof TargetPlatformArch)[keyof typeof TargetPlatformArch];
6905
- /**
6906
- * @public
6907
- * @enum
6908
- */
6909
- export declare const TargetPlatformOs: {
6910
- readonly ANDROID: "ANDROID";
6911
- readonly LINUX: "LINUX";
6912
- };
6913
- /**
6914
- * @public
6915
- */
6916
- export type TargetPlatformOs = (typeof TargetPlatformOs)[keyof typeof TargetPlatformOs];
6917
- /**
6918
- * <p>A summary of a model compilation job.</p>
6919
- * @public
6920
- */
6921
- export interface CompilationJobSummary {
6922
- /**
6923
- * <p>The name of the model compilation job that you want a summary for.</p>
6924
- * @public
6925
- */
6926
- CompilationJobName: string | undefined;
6927
- /**
6928
- * <p>The Amazon Resource Name (ARN) of the model compilation job.</p>
6929
- * @public
6930
- */
6931
- CompilationJobArn: string | undefined;
6932
- /**
6933
- * <p>The time when the model compilation job was created.</p>
6934
- * @public
6935
- */
6936
- CreationTime: Date | undefined;
6937
- /**
6938
- * <p>The time when the model compilation job started.</p>
6939
- * @public
6940
- */
6941
- CompilationStartTime?: Date | undefined;
6942
- /**
6943
- * <p>The time when the model compilation job completed.</p>
6944
- * @public
6945
- */
6946
- CompilationEndTime?: Date | undefined;
6947
- /**
6948
- * <p>The type of device that the model will run on after the compilation job has completed.</p>
6949
- * @public
6950
- */
6951
- CompilationTargetDevice?: TargetDevice | undefined;
6952
- /**
6953
- * <p>The type of OS that the model will run on after the compilation job has completed.</p>
6954
- * @public
6955
- */
6956
- CompilationTargetPlatformOs?: TargetPlatformOs | undefined;
6957
- /**
6958
- * <p>The type of architecture that the model will run on after the compilation job has completed.</p>
6959
- * @public
6960
- */
6961
- CompilationTargetPlatformArch?: TargetPlatformArch | undefined;
6962
- /**
6963
- * <p>The type of accelerator that the model will run on after the compilation job has completed.</p>
6964
- * @public
6965
- */
6966
- CompilationTargetPlatformAccelerator?: TargetPlatformAccelerator | undefined;
6967
- /**
6968
- * <p>The time when the model compilation job was last modified.</p>
6969
- * @public
6970
- */
6971
- LastModifiedTime?: Date | undefined;
6972
- /**
6973
- * <p>The status of the model compilation job.</p>
6974
- * @public
6975
- */
6976
- CompilationJobStatus: CompilationJobStatus | undefined;
6977
- }