@aws-sdk/client-sagemaker 3.859.0 → 3.861.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 (104) hide show
  1. package/README.md +40 -0
  2. package/dist-cjs/index.js +596 -125
  3. package/dist-es/SageMaker.js +10 -0
  4. package/dist-es/commands/AttachClusterNodeVolumeCommand.js +22 -0
  5. package/dist-es/commands/BatchAddClusterNodesCommand.js +22 -0
  6. package/dist-es/commands/CreateModelCardCommand.js +1 -1
  7. package/dist-es/commands/DescribeClusterEventCommand.js +22 -0
  8. package/dist-es/commands/DetachClusterNodeVolumeCommand.js +22 -0
  9. package/dist-es/commands/ListClusterEventsCommand.js +22 -0
  10. package/dist-es/commands/index.js +5 -0
  11. package/dist-es/models/models_0.js +45 -101
  12. package/dist-es/models/models_1.js +94 -15
  13. package/dist-es/models/models_2.js +14 -40
  14. package/dist-es/models/models_3.js +43 -40
  15. package/dist-es/models/models_4.js +40 -14
  16. package/dist-es/models/models_5.js +14 -2
  17. package/dist-es/pagination/ListClusterEventsPaginator.js +4 -0
  18. package/dist-es/pagination/index.js +1 -0
  19. package/dist-es/protocols/Aws_json1_1.js +339 -0
  20. package/dist-types/SageMaker.d.ts +35 -0
  21. package/dist-types/SageMakerClient.d.ts +7 -2
  22. package/dist-types/commands/AttachClusterNodeVolumeCommand.d.ts +82 -0
  23. package/dist-types/commands/BatchAddClusterNodesCommand.d.ts +99 -0
  24. package/dist-types/commands/BatchDeleteClusterNodesCommand.d.ts +13 -0
  25. package/dist-types/commands/CreateClusterCommand.d.ts +2 -0
  26. package/dist-types/commands/CreateModelBiasJobDefinitionCommand.d.ts +2 -1
  27. package/dist-types/commands/CreateModelCardCommand.d.ts +1 -1
  28. package/dist-types/commands/CreateModelCardExportJobCommand.d.ts +1 -1
  29. package/dist-types/commands/CreateModelExplainabilityJobDefinitionCommand.d.ts +1 -1
  30. package/dist-types/commands/DescribeClusterCommand.d.ts +3 -0
  31. package/dist-types/commands/DescribeClusterEventCommand.d.ts +129 -0
  32. package/dist-types/commands/DescribeClusterNodeCommand.d.ts +5 -1
  33. package/dist-types/commands/DescribeContextCommand.d.ts +2 -1
  34. package/dist-types/commands/DescribeDataQualityJobDefinitionCommand.d.ts +1 -1
  35. package/dist-types/commands/DescribeDeviceCommand.d.ts +1 -1
  36. package/dist-types/commands/DescribeDeviceFleetCommand.d.ts +1 -1
  37. package/dist-types/commands/DescribeDomainCommand.d.ts +1 -1
  38. package/dist-types/commands/DescribeEdgeDeploymentPlanCommand.d.ts +1 -1
  39. package/dist-types/commands/DescribeEdgePackagingJobCommand.d.ts +1 -1
  40. package/dist-types/commands/DescribeEndpointCommand.d.ts +1 -2
  41. package/dist-types/commands/DetachClusterNodeVolumeCommand.d.ts +82 -0
  42. package/dist-types/commands/ImportHubContentCommand.d.ts +1 -1
  43. package/dist-types/commands/ListActionsCommand.d.ts +1 -1
  44. package/dist-types/commands/ListAlgorithmsCommand.d.ts +1 -1
  45. package/dist-types/commands/ListAliasesCommand.d.ts +1 -1
  46. package/dist-types/commands/ListClusterEventsCommand.d.ts +96 -0
  47. package/dist-types/commands/ListClusterNodesCommand.d.ts +3 -1
  48. package/dist-types/commands/PutModelPackageGroupPolicyCommand.d.ts +1 -1
  49. package/dist-types/commands/QueryLineageCommand.d.ts +1 -1
  50. package/dist-types/commands/RegisterDevicesCommand.d.ts +1 -1
  51. package/dist-types/commands/RenderUiTemplateCommand.d.ts +1 -1
  52. package/dist-types/commands/RetryPipelineExecutionCommand.d.ts +1 -1
  53. package/dist-types/commands/UpdateClusterCommand.d.ts +1 -0
  54. package/dist-types/commands/UpdateClusterSoftwareCommand.d.ts +1 -0
  55. package/dist-types/commands/UpdateWorkforceCommand.d.ts +1 -1
  56. package/dist-types/commands/index.d.ts +5 -0
  57. package/dist-types/models/models_0.d.ts +657 -531
  58. package/dist-types/models/models_1.d.ts +3755 -3694
  59. package/dist-types/models/models_2.d.ts +3169 -3559
  60. package/dist-types/models/models_3.d.ts +4492 -4376
  61. package/dist-types/models/models_4.d.ts +3841 -3859
  62. package/dist-types/models/models_5.d.ts +905 -5
  63. package/dist-types/pagination/ListClusterEventsPaginator.d.ts +7 -0
  64. package/dist-types/pagination/index.d.ts +1 -0
  65. package/dist-types/protocols/Aws_json1_1.d.ts +45 -0
  66. package/dist-types/ts3.4/SageMaker.d.ts +85 -0
  67. package/dist-types/ts3.4/SageMakerClient.d.ts +30 -0
  68. package/dist-types/ts3.4/commands/AttachClusterNodeVolumeCommand.d.ts +51 -0
  69. package/dist-types/ts3.4/commands/BatchAddClusterNodesCommand.d.ts +51 -0
  70. package/dist-types/ts3.4/commands/CreateModelBiasJobDefinitionCommand.d.ts +2 -4
  71. package/dist-types/ts3.4/commands/CreateModelCardCommand.d.ts +1 -1
  72. package/dist-types/ts3.4/commands/CreateModelCardExportJobCommand.d.ts +1 -1
  73. package/dist-types/ts3.4/commands/CreateModelExplainabilityJobDefinitionCommand.d.ts +1 -1
  74. package/dist-types/ts3.4/commands/DescribeClusterEventCommand.d.ts +51 -0
  75. package/dist-types/ts3.4/commands/DescribeContextCommand.d.ts +2 -4
  76. package/dist-types/ts3.4/commands/DescribeDataQualityJobDefinitionCommand.d.ts +1 -1
  77. package/dist-types/ts3.4/commands/DescribeDeviceCommand.d.ts +1 -1
  78. package/dist-types/ts3.4/commands/DescribeDeviceFleetCommand.d.ts +1 -1
  79. package/dist-types/ts3.4/commands/DescribeDomainCommand.d.ts +1 -1
  80. package/dist-types/ts3.4/commands/DescribeEdgeDeploymentPlanCommand.d.ts +1 -1
  81. package/dist-types/ts3.4/commands/DescribeEdgePackagingJobCommand.d.ts +1 -1
  82. package/dist-types/ts3.4/commands/DescribeEndpointCommand.d.ts +4 -2
  83. package/dist-types/ts3.4/commands/DetachClusterNodeVolumeCommand.d.ts +51 -0
  84. package/dist-types/ts3.4/commands/ImportHubContentCommand.d.ts +1 -1
  85. package/dist-types/ts3.4/commands/ListActionsCommand.d.ts +1 -1
  86. package/dist-types/ts3.4/commands/ListAlgorithmsCommand.d.ts +1 -1
  87. package/dist-types/ts3.4/commands/ListAliasesCommand.d.ts +1 -1
  88. package/dist-types/ts3.4/commands/ListClusterEventsCommand.d.ts +51 -0
  89. package/dist-types/ts3.4/commands/PutModelPackageGroupPolicyCommand.d.ts +1 -1
  90. package/dist-types/ts3.4/commands/QueryLineageCommand.d.ts +1 -1
  91. package/dist-types/ts3.4/commands/RegisterDevicesCommand.d.ts +1 -1
  92. package/dist-types/ts3.4/commands/RenderUiTemplateCommand.d.ts +1 -1
  93. package/dist-types/ts3.4/commands/RetryPipelineExecutionCommand.d.ts +1 -1
  94. package/dist-types/ts3.4/commands/index.d.ts +5 -0
  95. package/dist-types/ts3.4/models/models_0.d.ts +208 -204
  96. package/dist-types/ts3.4/models/models_1.d.ts +194 -132
  97. package/dist-types/ts3.4/models/models_2.d.ts +135 -248
  98. package/dist-types/ts3.4/models/models_3.d.ts +262 -229
  99. package/dist-types/ts3.4/models/models_4.d.ts +257 -266
  100. package/dist-types/ts3.4/models/models_5.d.ts +242 -21
  101. package/dist-types/ts3.4/pagination/ListClusterEventsPaginator.d.ts +11 -0
  102. package/dist-types/ts3.4/pagination/index.d.ts +1 -0
  103. package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +60 -0
  104. package/package.json +1 -1
@@ -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
@@ -2842,6 +2869,76 @@ export interface AthenaDatasetDefinition {
2842
2869
  */
2843
2870
  OutputCompression?: AthenaResultCompressionType | undefined;
2844
2871
  }
2872
+ /**
2873
+ * @public
2874
+ */
2875
+ export interface AttachClusterNodeVolumeRequest {
2876
+ /**
2877
+ * <p> The Amazon Resource Name (ARN) of your SageMaker HyperPod cluster containing the target node. Your cluster must use EKS as the orchestration and be in the <code>InService</code> state. </p>
2878
+ * @public
2879
+ */
2880
+ ClusterArn: string | undefined;
2881
+ /**
2882
+ * <p> The unique identifier of the cluster node to which you want to attach the volume. The node must belong to your specified HyperPod cluster and cannot be part of a Restricted Instance Group (RIG). </p>
2883
+ * @public
2884
+ */
2885
+ NodeId: string | undefined;
2886
+ /**
2887
+ * <p> The unique identifier of your EBS volume to attach. The volume must be in the <code>available</code> state. </p>
2888
+ * @public
2889
+ */
2890
+ VolumeId: string | undefined;
2891
+ }
2892
+ /**
2893
+ * @public
2894
+ * @enum
2895
+ */
2896
+ export declare const VolumeAttachmentStatus: {
2897
+ readonly ATTACHED: "attached";
2898
+ readonly ATTACHING: "attaching";
2899
+ readonly BUSY: "busy";
2900
+ readonly DETACHED: "detached";
2901
+ readonly DETACHING: "detaching";
2902
+ };
2903
+ /**
2904
+ * @public
2905
+ */
2906
+ export type VolumeAttachmentStatus = (typeof VolumeAttachmentStatus)[keyof typeof VolumeAttachmentStatus];
2907
+ /**
2908
+ * @public
2909
+ */
2910
+ export interface AttachClusterNodeVolumeResponse {
2911
+ /**
2912
+ * <p> The Amazon Resource Name (ARN) of your SageMaker HyperPod cluster where the volume attachment operation was performed. </p>
2913
+ * @public
2914
+ */
2915
+ ClusterArn: string | undefined;
2916
+ /**
2917
+ * <p> The unique identifier of the cluster node where your volume was attached. </p>
2918
+ * @public
2919
+ */
2920
+ NodeId: string | undefined;
2921
+ /**
2922
+ * <p> The unique identifier of your EBS volume that was attached. </p>
2923
+ * @public
2924
+ */
2925
+ VolumeId: string | undefined;
2926
+ /**
2927
+ * <p> The timestamp when the volume attachment operation was initiated by the SageMaker HyperPod service. </p>
2928
+ * @public
2929
+ */
2930
+ AttachTime: Date | undefined;
2931
+ /**
2932
+ * <p> The current status of your volume attachment operation. </p>
2933
+ * @public
2934
+ */
2935
+ Status: VolumeAttachmentStatus | undefined;
2936
+ /**
2937
+ * <p> The device name assigned to your attached volume on the target instance. </p>
2938
+ * @public
2939
+ */
2940
+ DeviceName: string | undefined;
2941
+ }
2845
2942
  /**
2846
2943
  * @public
2847
2944
  * @enum
@@ -4209,40 +4306,136 @@ export declare const AwsManagedHumanLoopRequestSource: {
4209
4306
  */
4210
4307
  export type AwsManagedHumanLoopRequestSource = (typeof AwsManagedHumanLoopRequestSource)[keyof typeof AwsManagedHumanLoopRequestSource];
4211
4308
  /**
4212
- * <p>Configuration to control how SageMaker captures inference data for batch transform jobs.</p>
4213
4309
  * @public
4214
4310
  */
4215
- export interface BatchDataCaptureConfig {
4311
+ export interface BatchAddClusterNodesRequest {
4216
4312
  /**
4217
- * <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>
4218
4314
  * @public
4219
4315
  */
4220
- DestinationS3Uri: string | undefined;
4316
+ ClusterName: string | undefined;
4221
4317
  /**
4222
- * <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>
4223
4319
  * @public
4224
4320
  */
4225
- KmsKeyId?: string | undefined;
4321
+ ClientToken?: string | undefined;
4226
4322
  /**
4227
- * <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>
4228
4324
  * @public
4229
4325
  */
4230
- GenerateInferenceId?: boolean | undefined;
4326
+ NodesToAdd: AddClusterNodeSpecification[] | undefined;
4231
4327
  }
4232
4328
  /**
4233
4329
  * @public
4330
+ * @enum
4234
4331
  */
4235
- 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 {
4236
4345
  /**
4237
- * <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>
4238
4347
  * @public
4239
4348
  */
4240
- ClusterName: string | undefined;
4349
+ InstanceGroupName: string | undefined;
4241
4350
  /**
4242
- * <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>
4243
4352
  * @public
4244
4353
  */
4245
- 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;
4246
4439
  }
4247
4440
  /**
4248
4441
  * @public
@@ -4257,6 +4450,47 @@ export declare const BatchDeleteClusterNodesErrorCode: {
4257
4450
  * @public
4258
4451
  */
4259
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
+ }
4260
4494
  /**
4261
4495
  * <p>Represents an error encountered when deleting a node from a SageMaker HyperPod cluster.</p>
4262
4496
  * @public
@@ -4292,6 +4526,16 @@ export interface BatchDeleteClusterNodesResponse {
4292
4526
  * @public
4293
4527
  */
4294
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;
4295
4539
  }
4296
4540
  /**
4297
4541
  * @public
@@ -4968,6 +5212,34 @@ export interface CanvasAppSettings {
4968
5212
  */
4969
5213
  EmrServerlessSettings?: EmrServerlessSettings | undefined;
4970
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
+ }
4971
5243
  /**
4972
5244
  * @public
4973
5245
  * @enum
@@ -5605,40 +5877,347 @@ export interface ClusterEbsVolumeConfig {
5605
5877
  VolumeSizeInGB?: number | undefined;
5606
5878
  }
5607
5879
  /**
5608
- * <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>
5609
5881
  * @public
5610
5882
  */
5611
- 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
+ }
5612
5900
  /**
5901
+ * <p>Metadata information about an instance in a HyperPod cluster.</p>
5613
5902
  * @public
5614
5903
  */
5615
- export declare namespace ClusterInstanceStorageConfig {
5904
+ export interface InstanceMetadata {
5616
5905
  /**
5617
- * <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>
5618
5907
  * @public
5619
5908
  */
5620
- interface EbsVolumeConfigMember {
5621
- EbsVolumeConfig: ClusterEbsVolumeConfig;
5622
- $unknown?: never;
5623
- }
5909
+ CustomerEni?: string | undefined;
5624
5910
  /**
5911
+ * <p>Information about additional Elastic Network Interfaces (ENIs) associated with the instance.</p>
5625
5912
  * @public
5626
5913
  */
5627
- interface $UnknownMember {
5628
- EbsVolumeConfig?: never;
5629
- $unknown: [string, any];
5630
- }
5631
- interface Visitor<T> {
5632
- EbsVolumeConfig: (value: ClusterEbsVolumeConfig) => T;
5633
- _: (name: string, value: any) => T;
5634
- }
5635
- 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;
5636
5935
  }
5637
5936
  /**
5937
+ * <p>Metadata information about an instance group in a SageMaker HyperPod cluster.</p>
5638
5938
  * @public
5639
- * @enum
5640
5939
  */
5641
- export declare const ClusterInstanceType: {
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: {
5642
6221
  readonly ML_C5N_18XLARGE: "ml.c5n.18xlarge";
5643
6222
  readonly ML_C5N_2XLARGE: "ml.c5n.2xlarge";
5644
6223
  readonly ML_C5N_4XLARGE: "ml.c5n.4xlarge";
@@ -5929,6 +6508,16 @@ export interface ClusterInstanceGroupDetails {
5929
6508
  * @public
5930
6509
  */
5931
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;
5932
6521
  }
5933
6522
  /**
5934
6523
  * <p>The specifications of an instance group that you need to define.</p>
@@ -5990,6 +6579,11 @@ export interface ClusterInstanceGroupSpecification {
5990
6579
  * @public
5991
6580
  */
5992
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;
5993
6587
  }
5994
6588
  /**
5995
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>
@@ -6007,22 +6601,6 @@ export interface ClusterInstancePlacement {
6007
6601
  */
6008
6602
  AvailabilityZoneId?: string | undefined;
6009
6603
  }
6010
- /**
6011
- * @public
6012
- * @enum
6013
- */
6014
- export declare const ClusterInstanceStatus: {
6015
- readonly DEEP_HEALTH_CHECK_IN_PROGRESS: "DeepHealthCheckInProgress";
6016
- readonly FAILURE: "Failure";
6017
- readonly PENDING: "Pending";
6018
- readonly RUNNING: "Running";
6019
- readonly SHUTTING_DOWN: "ShuttingDown";
6020
- readonly SYSTEM_UPDATING: "SystemUpdating";
6021
- };
6022
- /**
6023
- * @public
6024
- */
6025
- export type ClusterInstanceStatus = (typeof ClusterInstanceStatus)[keyof typeof ClusterInstanceStatus];
6026
6604
  /**
6027
6605
  * <p>Details of an instance in a SageMaker HyperPod cluster.</p>
6028
6606
  * @public
@@ -6054,6 +6632,11 @@ export interface ClusterNodeDetails {
6054
6632
  * @public
6055
6633
  */
6056
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;
6057
6640
  /**
6058
6641
  * <p>The status of the instance.</p>
6059
6642
  * @public
@@ -6114,7 +6697,28 @@ export interface ClusterNodeDetails {
6114
6697
  * @public
6115
6698
  */
6116
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;
6117
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];
6118
6722
  /**
6119
6723
  * @public
6120
6724
  * @enum
@@ -6142,6 +6746,11 @@ export interface ClusterNodeSummary {
6142
6746
  * @public
6143
6747
  */
6144
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;
6145
6754
  /**
6146
6755
  * <p>The type of the instance.</p>
6147
6756
  * @public
@@ -6462,486 +7071,3 @@ export declare const ClusterStatus: {
6462
7071
  * @public
6463
7072
  */
6464
7073
  export type ClusterStatus = (typeof ClusterStatus)[keyof typeof ClusterStatus];
6465
- /**
6466
- * <p>Lists a summary of the properties of a SageMaker HyperPod cluster.</p>
6467
- * @public
6468
- */
6469
- export interface ClusterSummary {
6470
- /**
6471
- * <p>The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster.</p>
6472
- * @public
6473
- */
6474
- ClusterArn: string | undefined;
6475
- /**
6476
- * <p>The name of the SageMaker HyperPod cluster.</p>
6477
- * @public
6478
- */
6479
- ClusterName: string | undefined;
6480
- /**
6481
- * <p>The time when the SageMaker HyperPod cluster is created.</p>
6482
- * @public
6483
- */
6484
- CreationTime: Date | undefined;
6485
- /**
6486
- * <p>The status of the SageMaker HyperPod cluster.</p>
6487
- * @public
6488
- */
6489
- ClusterStatus: ClusterStatus | undefined;
6490
- /**
6491
- * <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>
6492
- * @public
6493
- */
6494
- TrainingPlanArns?: string[] | undefined;
6495
- }
6496
- /**
6497
- * <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>
6498
- * @public
6499
- */
6500
- export interface CustomImage {
6501
- /**
6502
- * <p>The name of the CustomImage. Must be unique to your account.</p>
6503
- * @public
6504
- */
6505
- ImageName: string | undefined;
6506
- /**
6507
- * <p>The version number of the CustomImage.</p>
6508
- * @public
6509
- */
6510
- ImageVersionNumber?: number | undefined;
6511
- /**
6512
- * <p>The name of the AppImageConfig.</p>
6513
- * @public
6514
- */
6515
- AppImageConfigName: string | undefined;
6516
- }
6517
- /**
6518
- * <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>
6519
- * @public
6520
- */
6521
- export interface CodeEditorAppSettings {
6522
- /**
6523
- * <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>
6524
- * @public
6525
- */
6526
- DefaultResourceSpec?: ResourceSpec | undefined;
6527
- /**
6528
- * <p>A list of custom SageMaker images that are configured to run as a Code Editor app.</p>
6529
- * @public
6530
- */
6531
- CustomImages?: CustomImage[] | undefined;
6532
- /**
6533
- * <p>The Amazon Resource Name (ARN) of the Code Editor application lifecycle configuration.</p>
6534
- * @public
6535
- */
6536
- LifecycleConfigArns?: string[] | undefined;
6537
- /**
6538
- * <p>Settings that are used to configure and manage the lifecycle of CodeEditor applications.</p>
6539
- * @public
6540
- */
6541
- AppLifecycleManagement?: AppLifecycleManagement | undefined;
6542
- /**
6543
- * <p>The lifecycle configuration that runs before the default lifecycle configuration. It can override changes made in the default lifecycle configuration.</p>
6544
- * @public
6545
- */
6546
- BuiltInLifecycleConfigArn?: string | undefined;
6547
- }
6548
- /**
6549
- * <p>A Git repository that SageMaker AI automatically displays to users for cloning in the JupyterServer application.</p>
6550
- * @public
6551
- */
6552
- export interface CodeRepository {
6553
- /**
6554
- * <p>The URL of the Git repository.</p>
6555
- * @public
6556
- */
6557
- RepositoryUrl: string | undefined;
6558
- }
6559
- /**
6560
- * @public
6561
- * @enum
6562
- */
6563
- export declare const CodeRepositorySortBy: {
6564
- readonly CREATION_TIME: "CreationTime";
6565
- readonly LAST_MODIFIED_TIME: "LastModifiedTime";
6566
- readonly NAME: "Name";
6567
- };
6568
- /**
6569
- * @public
6570
- */
6571
- export type CodeRepositorySortBy = (typeof CodeRepositorySortBy)[keyof typeof CodeRepositorySortBy];
6572
- /**
6573
- * @public
6574
- * @enum
6575
- */
6576
- export declare const CodeRepositorySortOrder: {
6577
- readonly ASCENDING: "Ascending";
6578
- readonly DESCENDING: "Descending";
6579
- };
6580
- /**
6581
- * @public
6582
- */
6583
- export type CodeRepositorySortOrder = (typeof CodeRepositorySortOrder)[keyof typeof CodeRepositorySortOrder];
6584
- /**
6585
- * <p>Specifies configuration details for a Git repository in your Amazon Web Services account.</p>
6586
- * @public
6587
- */
6588
- export interface GitConfig {
6589
- /**
6590
- * <p>The URL where the Git repository is located.</p>
6591
- * @public
6592
- */
6593
- RepositoryUrl: string | undefined;
6594
- /**
6595
- * <p>The default branch for the Git repository.</p>
6596
- * @public
6597
- */
6598
- Branch?: string | undefined;
6599
- /**
6600
- * <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>
6601
- * @public
6602
- */
6603
- SecretArn?: string | undefined;
6604
- }
6605
- /**
6606
- * <p>Specifies summary information about a Git repository.</p>
6607
- * @public
6608
- */
6609
- export interface CodeRepositorySummary {
6610
- /**
6611
- * <p>The name of the Git repository.</p>
6612
- * @public
6613
- */
6614
- CodeRepositoryName: string | undefined;
6615
- /**
6616
- * <p>The Amazon Resource Name (ARN) of the Git repository.</p>
6617
- * @public
6618
- */
6619
- CodeRepositoryArn: string | undefined;
6620
- /**
6621
- * <p>The date and time that the Git repository was created.</p>
6622
- * @public
6623
- */
6624
- CreationTime: Date | undefined;
6625
- /**
6626
- * <p>The date and time that the Git repository was last modified.</p>
6627
- * @public
6628
- */
6629
- LastModifiedTime: Date | undefined;
6630
- /**
6631
- * <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>
6632
- * @public
6633
- */
6634
- GitConfig?: GitConfig | undefined;
6635
- }
6636
- /**
6637
- * <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>
6638
- * @public
6639
- */
6640
- export interface CognitoConfig {
6641
- /**
6642
- * <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>
6643
- * @public
6644
- */
6645
- UserPool: string | undefined;
6646
- /**
6647
- * <p>The client ID for your Amazon Cognito user pool.</p>
6648
- * @public
6649
- */
6650
- ClientId: string | undefined;
6651
- }
6652
- /**
6653
- * <p>Identifies a Amazon Cognito user group. A user group can be used in on or more work teams.</p>
6654
- * @public
6655
- */
6656
- export interface CognitoMemberDefinition {
6657
- /**
6658
- * <p>An identifier for a user pool. The user pool must be in the same region as the service that you are calling.</p>
6659
- * @public
6660
- */
6661
- UserPool: string | undefined;
6662
- /**
6663
- * <p>An identifier for a user group.</p>
6664
- * @public
6665
- */
6666
- UserGroup: string | undefined;
6667
- /**
6668
- * <p>An identifier for an application client. You must create the app client ID using Amazon Cognito.</p>
6669
- * @public
6670
- */
6671
- ClientId: string | undefined;
6672
- }
6673
- /**
6674
- * <p>Configuration for your vector collection type.</p>
6675
- * @public
6676
- */
6677
- export interface VectorConfig {
6678
- /**
6679
- * <p>The number of elements in your vector.</p>
6680
- * @public
6681
- */
6682
- Dimension: number | undefined;
6683
- }
6684
- /**
6685
- * <p>Configuration for your collection.</p>
6686
- * @public
6687
- */
6688
- export type CollectionConfig = CollectionConfig.VectorConfigMember | CollectionConfig.$UnknownMember;
6689
- /**
6690
- * @public
6691
- */
6692
- export declare namespace CollectionConfig {
6693
- /**
6694
- * <p>Configuration for your vector collection type.</p> <ul> <li> <p> <code>Dimension</code>: The number of elements in your vector.</p> </li> </ul>
6695
- * @public
6696
- */
6697
- interface VectorConfigMember {
6698
- VectorConfig: VectorConfig;
6699
- $unknown?: never;
6700
- }
6701
- /**
6702
- * @public
6703
- */
6704
- interface $UnknownMember {
6705
- VectorConfig?: never;
6706
- $unknown: [string, any];
6707
- }
6708
- interface Visitor<T> {
6709
- VectorConfig: (value: VectorConfig) => T;
6710
- _: (name: string, value: any) => T;
6711
- }
6712
- const visit: <T>(value: CollectionConfig, visitor: Visitor<T>) => T;
6713
- }
6714
- /**
6715
- * <p>Configuration information for the Amazon SageMaker Debugger output tensor collections.</p>
6716
- * @public
6717
- */
6718
- export interface CollectionConfiguration {
6719
- /**
6720
- * <p>The name of the tensor collection. The name must be unique relative to other rule configuration names.</p>
6721
- * @public
6722
- */
6723
- CollectionName?: string | undefined;
6724
- /**
6725
- * <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>
6726
- * @public
6727
- */
6728
- CollectionParameters?: Record<string, string> | undefined;
6729
- }
6730
- /**
6731
- * @public
6732
- * @enum
6733
- */
6734
- export declare const CollectionType: {
6735
- readonly LIST: "List";
6736
- readonly SET: "Set";
6737
- readonly VECTOR: "Vector";
6738
- };
6739
- /**
6740
- * @public
6741
- */
6742
- export type CollectionType = (typeof CollectionType)[keyof typeof CollectionType];
6743
- /**
6744
- * @public
6745
- * @enum
6746
- */
6747
- export declare const CompilationJobStatus: {
6748
- readonly COMPLETED: "COMPLETED";
6749
- readonly FAILED: "FAILED";
6750
- readonly INPROGRESS: "INPROGRESS";
6751
- readonly STARTING: "STARTING";
6752
- readonly STOPPED: "STOPPED";
6753
- readonly STOPPING: "STOPPING";
6754
- };
6755
- /**
6756
- * @public
6757
- */
6758
- export type CompilationJobStatus = (typeof CompilationJobStatus)[keyof typeof CompilationJobStatus];
6759
- /**
6760
- * @public
6761
- * @enum
6762
- */
6763
- export declare const TargetDevice: {
6764
- readonly AISAGE: "aisage";
6765
- readonly AMBA_CV2: "amba_cv2";
6766
- readonly AMBA_CV22: "amba_cv22";
6767
- readonly AMBA_CV25: "amba_cv25";
6768
- readonly COREML: "coreml";
6769
- readonly DEEPLENS: "deeplens";
6770
- readonly IMX8MPLUS: "imx8mplus";
6771
- readonly IMX8QM: "imx8qm";
6772
- readonly JACINTO_TDA4VM: "jacinto_tda4vm";
6773
- readonly JETSON_NANO: "jetson_nano";
6774
- readonly JETSON_TX1: "jetson_tx1";
6775
- readonly JETSON_TX2: "jetson_tx2";
6776
- readonly JETSON_XAVIER: "jetson_xavier";
6777
- readonly LAMBDA: "lambda";
6778
- readonly ML_C4: "ml_c4";
6779
- readonly ML_C5: "ml_c5";
6780
- readonly ML_C6G: "ml_c6g";
6781
- readonly ML_EIA2: "ml_eia2";
6782
- readonly ML_G4DN: "ml_g4dn";
6783
- readonly ML_INF1: "ml_inf1";
6784
- readonly ML_INF2: "ml_inf2";
6785
- readonly ML_M4: "ml_m4";
6786
- readonly ML_M5: "ml_m5";
6787
- readonly ML_M6G: "ml_m6g";
6788
- readonly ML_P2: "ml_p2";
6789
- readonly ML_P3: "ml_p3";
6790
- readonly ML_TRN1: "ml_trn1";
6791
- readonly QCS603: "qcs603";
6792
- readonly QCS605: "qcs605";
6793
- readonly RASP3B: "rasp3b";
6794
- readonly RASP4B: "rasp4b";
6795
- readonly RK3288: "rk3288";
6796
- readonly RK3399: "rk3399";
6797
- readonly SBE_C: "sbe_c";
6798
- readonly SITARA_AM57X: "sitara_am57x";
6799
- readonly X86_WIN32: "x86_win32";
6800
- readonly X86_WIN64: "x86_win64";
6801
- };
6802
- /**
6803
- * @public
6804
- */
6805
- export type TargetDevice = (typeof TargetDevice)[keyof typeof TargetDevice];
6806
- /**
6807
- * @public
6808
- * @enum
6809
- */
6810
- export declare const TargetPlatformAccelerator: {
6811
- readonly INTEL_GRAPHICS: "INTEL_GRAPHICS";
6812
- readonly MALI: "MALI";
6813
- readonly NNA: "NNA";
6814
- readonly NVIDIA: "NVIDIA";
6815
- };
6816
- /**
6817
- * @public
6818
- */
6819
- export type TargetPlatformAccelerator = (typeof TargetPlatformAccelerator)[keyof typeof TargetPlatformAccelerator];
6820
- /**
6821
- * @public
6822
- * @enum
6823
- */
6824
- export declare const TargetPlatformArch: {
6825
- readonly ARM64: "ARM64";
6826
- readonly ARM_EABI: "ARM_EABI";
6827
- readonly ARM_EABIHF: "ARM_EABIHF";
6828
- readonly X86: "X86";
6829
- readonly X86_64: "X86_64";
6830
- };
6831
- /**
6832
- * @public
6833
- */
6834
- export type TargetPlatformArch = (typeof TargetPlatformArch)[keyof typeof TargetPlatformArch];
6835
- /**
6836
- * @public
6837
- * @enum
6838
- */
6839
- export declare const TargetPlatformOs: {
6840
- readonly ANDROID: "ANDROID";
6841
- readonly LINUX: "LINUX";
6842
- };
6843
- /**
6844
- * @public
6845
- */
6846
- export type TargetPlatformOs = (typeof TargetPlatformOs)[keyof typeof TargetPlatformOs];
6847
- /**
6848
- * <p>A summary of a model compilation job.</p>
6849
- * @public
6850
- */
6851
- export interface CompilationJobSummary {
6852
- /**
6853
- * <p>The name of the model compilation job that you want a summary for.</p>
6854
- * @public
6855
- */
6856
- CompilationJobName: string | undefined;
6857
- /**
6858
- * <p>The Amazon Resource Name (ARN) of the model compilation job.</p>
6859
- * @public
6860
- */
6861
- CompilationJobArn: string | undefined;
6862
- /**
6863
- * <p>The time when the model compilation job was created.</p>
6864
- * @public
6865
- */
6866
- CreationTime: Date | undefined;
6867
- /**
6868
- * <p>The time when the model compilation job started.</p>
6869
- * @public
6870
- */
6871
- CompilationStartTime?: Date | undefined;
6872
- /**
6873
- * <p>The time when the model compilation job completed.</p>
6874
- * @public
6875
- */
6876
- CompilationEndTime?: Date | undefined;
6877
- /**
6878
- * <p>The type of device that the model will run on after the compilation job has completed.</p>
6879
- * @public
6880
- */
6881
- CompilationTargetDevice?: TargetDevice | undefined;
6882
- /**
6883
- * <p>The type of OS that the model will run on after the compilation job has completed.</p>
6884
- * @public
6885
- */
6886
- CompilationTargetPlatformOs?: TargetPlatformOs | undefined;
6887
- /**
6888
- * <p>The type of architecture that the model will run on after the compilation job has completed.</p>
6889
- * @public
6890
- */
6891
- CompilationTargetPlatformArch?: TargetPlatformArch | undefined;
6892
- /**
6893
- * <p>The type of accelerator that the model will run on after the compilation job has completed.</p>
6894
- * @public
6895
- */
6896
- CompilationTargetPlatformAccelerator?: TargetPlatformAccelerator | undefined;
6897
- /**
6898
- * <p>The time when the model compilation job was last modified.</p>
6899
- * @public
6900
- */
6901
- LastModifiedTime?: Date | undefined;
6902
- /**
6903
- * <p>The status of the model compilation job.</p>
6904
- * @public
6905
- */
6906
- CompilationJobStatus: CompilationJobStatus | undefined;
6907
- }
6908
- /**
6909
- * @public
6910
- * @enum
6911
- */
6912
- export declare const CompleteOnConvergence: {
6913
- readonly DISABLED: "Disabled";
6914
- readonly ENABLED: "Enabled";
6915
- };
6916
- /**
6917
- * @public
6918
- */
6919
- export type CompleteOnConvergence = (typeof CompleteOnConvergence)[keyof typeof CompleteOnConvergence];
6920
- /**
6921
- * <p>Configuration of the resources used for the compute allocation definition.</p>
6922
- * @public
6923
- */
6924
- export interface ComputeQuotaResourceConfig {
6925
- /**
6926
- * <p>The instance type of the instance group for the cluster.</p>
6927
- * @public
6928
- */
6929
- InstanceType: ClusterInstanceType | undefined;
6930
- /**
6931
- * <p>The number of instances to add to the instance group of a SageMaker HyperPod cluster.</p>
6932
- * @public
6933
- */
6934
- Count?: number | undefined;
6935
- }
6936
- /**
6937
- * @public
6938
- * @enum
6939
- */
6940
- export declare const PreemptTeamTasks: {
6941
- readonly LOWERPRIORITY: "LowerPriority";
6942
- readonly NEVER: "Never";
6943
- };
6944
- /**
6945
- * @public
6946
- */
6947
- export type PreemptTeamTasks = (typeof PreemptTeamTasks)[keyof typeof PreemptTeamTasks];