2026/05/27 - Amazon SageMaker Service - 7 updated api methods
Changes Adds shared environment support for Restricted Instance Groups (RIGs) on SageMaker HyperPod, enabling cross-RIG workload scheduling and FSx sharing. This unlocks shared CPU-GPU environments needed for cost-efficient RL training (e.g., Nova Forge). Adds p6 instance support for recommendation jobs
{'ComputeSpec': {'InstanceTypes': {'ml.p6-b200.48xlarge'}}}
Creates a recommendation job that generates intelligent optimization recommendations for generative AI inference deployments. The job analyzes your model, workload configuration, and performance targets to recommend optimal instance types, model optimization techniques (such as quantization and speculative decoding), and deployment configurations.
See also: AWS API Documentation
Request Syntax
client.create_ai_recommendation_job(
AIRecommendationJobName='string',
ModelSource={
'S3': {
'S3Uri': 'string'
}
},
OutputConfig={
'S3OutputLocation': 'string',
'ModelPackageGroupIdentifier': 'string'
},
AIWorkloadConfigIdentifier='string',
PerformanceTarget={
'Constraints': [
{
'Metric': 'ttft-ms'|'throughput'|'cost'
},
]
},
RoleArn='string',
InferenceSpecification={
'Framework': 'LMI'|'VLLM'
},
OptimizeModel=True|False,
ComputeSpec={
'InstanceTypes': [
'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.12xlarge'|'ml.g5.16xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.g6.xlarge'|'ml.g6.2xlarge'|'ml.g6.4xlarge'|'ml.g6.8xlarge'|'ml.g6.12xlarge'|'ml.g6.16xlarge'|'ml.g6.24xlarge'|'ml.g6.48xlarge'|'ml.g6e.xlarge'|'ml.g6e.2xlarge'|'ml.g6e.4xlarge'|'ml.g6e.8xlarge'|'ml.g6e.12xlarge'|'ml.g6e.16xlarge'|'ml.g6e.24xlarge'|'ml.g6e.48xlarge'|'ml.g7e.2xlarge'|'ml.g7e.4xlarge'|'ml.g7e.8xlarge'|'ml.g7e.12xlarge'|'ml.g7e.24xlarge'|'ml.g7e.48xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.p5.4xlarge'|'ml.p5.48xlarge'|'ml.p5e.48xlarge'|'ml.p5en.48xlarge'|'ml.p6-b200.48xlarge',
],
'CapacityReservationConfig': {
'CapacityReservationPreference': 'capacity-reservations-only',
'MlReservationArns': [
'string',
]
}
},
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The name of the AI recommendation job. The name must be unique within your Amazon Web Services account in the current Amazon Web Services Region.
dict
[REQUIRED]
The source of the model to optimize. Specify the Amazon S3 location of the model artifacts.
S3 (dict) --
The Amazon S3 location of the model artifacts.
S3Uri (string) --
The Amazon S3 URI of the model artifacts.
dict
[REQUIRED]
The output configuration for the recommendation job, including the Amazon S3 location for results and an optional model package group where the optimized model is registered.
S3OutputLocation (string) --
The Amazon S3 URI where recommendation results are stored.
ModelPackageGroupIdentifier (string) --
The name or Amazon Resource Name (ARN) of the model package group where the optimized model is registered as a new model package version.
string
[REQUIRED]
The name or Amazon Resource Name (ARN) of the AI workload configuration to use for this recommendation job.
dict
[REQUIRED]
The performance targets for the recommendation job. Specify constraints on metrics such as time to first token ( ttft-ms), throughput, or cost.
Constraints (list) -- [REQUIRED]
An array of performance constraints that define the optimization objectives.
(dict) --
A performance constraint for an AI recommendation job.
Metric (string) -- [REQUIRED]
The performance metric. Valid values are ttft-ms (time to first token in milliseconds), throughput, and cost.
string
[REQUIRED]
The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker AI to perform tasks on your behalf.
dict
The inference framework configuration. Specify the framework (such as LMI or vLLM) for the recommendation job.
Framework (string) --
The inference framework. Valid values are LMI and VLLM.
boolean
Whether to allow model optimization techniques such as quantization, speculative decoding, and kernel tuning. The default is true.
dict
The compute resource specification for the recommendation job. You can specify up to 3 instance types to consider, and optionally provide capacity reservation configuration.
InstanceTypes (list) --
The list of instance types to consider for recommendations. You can specify up to 3 instance types.
(string) --
CapacityReservationConfig (dict) --
The capacity reservation configuration.
CapacityReservationPreference (string) --
The capacity reservation preference. The only valid value is capacity-reservations-only.
MlReservationArns (list) --
The list of ML reservation ARNs to use.
(string) --
list
The metadata that you apply to Amazon Web Services resources to help you categorize and organize them.
(dict) --
A tag object that consists of a key and an optional value, used to manage metadata for SageMaker Amazon Web Services resources.
You can add tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations, and endpoints. For more information on adding tags to SageMaker resources, see AddTags.
For more information on adding metadata to your Amazon Web Services resources with tagging, see Tagging Amazon Web Services resources. For advice on best practices for managing Amazon Web Services resources with tagging, see Tagging Best Practices: Implement an Effective Amazon Web Services Resource Tagging Strategy.
Key (string) -- [REQUIRED]
The tag key. Tag keys must be unique per resource.
Value (string) -- [REQUIRED]
The tag value.
dict
Response Syntax
{
'AIRecommendationJobArn': 'string'
}
Response Structure
(dict) --
AIRecommendationJobArn (string) --
The Amazon Resource Name (ARN) of the created recommendation job.
{'RestrictedInstanceGroupsConfig': {'SharedEnvironmentConfig': {'FSxLustreConfig': {'PerUnitStorageThroughput': 'integer',
'SizeInGiB': 'integer'},
'FSxLustreDeletionPolicy': 'DeleteIfNotUsed '
'| '
'Keep'}}}
Creates an Amazon SageMaker HyperPod cluster. SageMaker HyperPod is a capability of SageMaker for creating and managing persistent clusters for developing large machine learning models, such as large language models (LLMs) and diffusion models. To learn more, see Amazon SageMaker HyperPod in the Amazon SageMaker Developer Guide.
See also: AWS API Documentation
Request Syntax
client.create_cluster(
ClusterName='string',
InstanceGroups=[
{
'InstanceCount': 123,
'MinInstanceCount': 123,
'InstanceGroupName': 'string',
'InstanceType': 'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.p5.48xlarge'|'ml.p5.4xlarge'|'ml.p6e-gb200.36xlarge'|'ml.trn1.32xlarge'|'ml.trn1n.32xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.12xlarge'|'ml.g5.16xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.c5n.large'|'ml.c5n.2xlarge'|'ml.c5n.4xlarge'|'ml.c5n.9xlarge'|'ml.c5n.18xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.g6.xlarge'|'ml.g6.2xlarge'|'ml.g6.4xlarge'|'ml.g6.8xlarge'|'ml.g6.16xlarge'|'ml.g6.12xlarge'|'ml.g6.24xlarge'|'ml.g6.48xlarge'|'ml.gr6.4xlarge'|'ml.gr6.8xlarge'|'ml.g6e.xlarge'|'ml.g6e.2xlarge'|'ml.g6e.4xlarge'|'ml.g6e.8xlarge'|'ml.g6e.16xlarge'|'ml.g6e.12xlarge'|'ml.g6e.24xlarge'|'ml.g6e.48xlarge'|'ml.p5e.48xlarge'|'ml.p5en.48xlarge'|'ml.p6-b200.48xlarge'|'ml.trn2.3xlarge'|'ml.trn2.48xlarge'|'ml.c6i.large'|'ml.c6i.xlarge'|'ml.c6i.2xlarge'|'ml.c6i.4xlarge'|'ml.c6i.8xlarge'|'ml.c6i.12xlarge'|'ml.c6i.16xlarge'|'ml.c6i.24xlarge'|'ml.c6i.32xlarge'|'ml.m6i.large'|'ml.m6i.xlarge'|'ml.m6i.2xlarge'|'ml.m6i.4xlarge'|'ml.m6i.8xlarge'|'ml.m6i.12xlarge'|'ml.m6i.16xlarge'|'ml.m6i.24xlarge'|'ml.m6i.32xlarge'|'ml.r6i.large'|'ml.r6i.xlarge'|'ml.r6i.2xlarge'|'ml.r6i.4xlarge'|'ml.r6i.8xlarge'|'ml.r6i.12xlarge'|'ml.r6i.16xlarge'|'ml.r6i.24xlarge'|'ml.r6i.32xlarge'|'ml.i3en.large'|'ml.i3en.xlarge'|'ml.i3en.2xlarge'|'ml.i3en.3xlarge'|'ml.i3en.6xlarge'|'ml.i3en.12xlarge'|'ml.i3en.24xlarge'|'ml.m7i.large'|'ml.m7i.xlarge'|'ml.m7i.2xlarge'|'ml.m7i.4xlarge'|'ml.m7i.8xlarge'|'ml.m7i.12xlarge'|'ml.m7i.16xlarge'|'ml.m7i.24xlarge'|'ml.m7i.48xlarge'|'ml.r7i.large'|'ml.r7i.xlarge'|'ml.r7i.2xlarge'|'ml.r7i.4xlarge'|'ml.r7i.8xlarge'|'ml.r7i.12xlarge'|'ml.r7i.16xlarge'|'ml.r7i.24xlarge'|'ml.r7i.48xlarge'|'ml.r5d.16xlarge'|'ml.g7e.2xlarge'|'ml.g7e.4xlarge'|'ml.g7e.8xlarge'|'ml.g7e.12xlarge'|'ml.g7e.24xlarge'|'ml.g7e.48xlarge'|'ml.p6-b300.48xlarge',
'InstanceRequirements': {
'InstanceTypes': [
'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.p5.48xlarge'|'ml.p5.4xlarge'|'ml.p6e-gb200.36xlarge'|'ml.trn1.32xlarge'|'ml.trn1n.32xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.12xlarge'|'ml.g5.16xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.c5n.large'|'ml.c5n.2xlarge'|'ml.c5n.4xlarge'|'ml.c5n.9xlarge'|'ml.c5n.18xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.g6.xlarge'|'ml.g6.2xlarge'|'ml.g6.4xlarge'|'ml.g6.8xlarge'|'ml.g6.16xlarge'|'ml.g6.12xlarge'|'ml.g6.24xlarge'|'ml.g6.48xlarge'|'ml.gr6.4xlarge'|'ml.gr6.8xlarge'|'ml.g6e.xlarge'|'ml.g6e.2xlarge'|'ml.g6e.4xlarge'|'ml.g6e.8xlarge'|'ml.g6e.16xlarge'|'ml.g6e.12xlarge'|'ml.g6e.24xlarge'|'ml.g6e.48xlarge'|'ml.p5e.48xlarge'|'ml.p5en.48xlarge'|'ml.p6-b200.48xlarge'|'ml.trn2.3xlarge'|'ml.trn2.48xlarge'|'ml.c6i.large'|'ml.c6i.xlarge'|'ml.c6i.2xlarge'|'ml.c6i.4xlarge'|'ml.c6i.8xlarge'|'ml.c6i.12xlarge'|'ml.c6i.16xlarge'|'ml.c6i.24xlarge'|'ml.c6i.32xlarge'|'ml.m6i.large'|'ml.m6i.xlarge'|'ml.m6i.2xlarge'|'ml.m6i.4xlarge'|'ml.m6i.8xlarge'|'ml.m6i.12xlarge'|'ml.m6i.16xlarge'|'ml.m6i.24xlarge'|'ml.m6i.32xlarge'|'ml.r6i.large'|'ml.r6i.xlarge'|'ml.r6i.2xlarge'|'ml.r6i.4xlarge'|'ml.r6i.8xlarge'|'ml.r6i.12xlarge'|'ml.r6i.16xlarge'|'ml.r6i.24xlarge'|'ml.r6i.32xlarge'|'ml.i3en.large'|'ml.i3en.xlarge'|'ml.i3en.2xlarge'|'ml.i3en.3xlarge'|'ml.i3en.6xlarge'|'ml.i3en.12xlarge'|'ml.i3en.24xlarge'|'ml.m7i.large'|'ml.m7i.xlarge'|'ml.m7i.2xlarge'|'ml.m7i.4xlarge'|'ml.m7i.8xlarge'|'ml.m7i.12xlarge'|'ml.m7i.16xlarge'|'ml.m7i.24xlarge'|'ml.m7i.48xlarge'|'ml.r7i.large'|'ml.r7i.xlarge'|'ml.r7i.2xlarge'|'ml.r7i.4xlarge'|'ml.r7i.8xlarge'|'ml.r7i.12xlarge'|'ml.r7i.16xlarge'|'ml.r7i.24xlarge'|'ml.r7i.48xlarge'|'ml.r5d.16xlarge'|'ml.g7e.2xlarge'|'ml.g7e.4xlarge'|'ml.g7e.8xlarge'|'ml.g7e.12xlarge'|'ml.g7e.24xlarge'|'ml.g7e.48xlarge'|'ml.p6-b300.48xlarge',
]
},
'LifeCycleConfig': {
'SourceS3Uri': 'string',
'OnCreate': 'string',
'OnInitComplete': 'string'
},
'ExecutionRole': 'string',
'ThreadsPerCore': 123,
'InstanceStorageConfigs': [
{
'EbsVolumeConfig': {
'VolumeSizeInGB': 123,
'VolumeKmsKeyId': 'string',
'RootVolume': True|False
},
'FsxLustreConfig': {
'DnsName': 'string',
'MountName': 'string',
'MountPath': 'string'
},
'FsxOpenZfsConfig': {
'DnsName': 'string',
'MountPath': 'string'
}
},
],
'OnStartDeepHealthChecks': [
'InstanceStress'|'InstanceConnectivity',
],
'TrainingPlanArn': 'string',
'OverrideVpcConfig': {
'SecurityGroupIds': [
'string',
],
'Subnets': [
'string',
]
},
'ScheduledUpdateConfig': {
'ScheduleExpression': 'string',
'DeploymentConfig': {
'RollingUpdatePolicy': {
'MaximumBatchSize': {
'Type': 'INSTANCE_COUNT'|'CAPACITY_PERCENTAGE',
'Value': 123
},
'RollbackMaximumBatchSize': {
'Type': 'INSTANCE_COUNT'|'CAPACITY_PERCENTAGE',
'Value': 123
}
},
'WaitIntervalInSeconds': 123,
'AutoRollbackConfiguration': [
{
'AlarmName': 'string'
},
]
}
},
'ImageId': 'string',
'KubernetesConfig': {
'Labels': {
'string': 'string'
},
'Taints': [
{
'Key': 'string',
'Value': 'string',
'Effect': 'NoSchedule'|'PreferNoSchedule'|'NoExecute'
},
]
},
'SlurmConfig': {
'NodeType': 'Controller'|'Login'|'Compute',
'PartitionNames': [
'string',
]
},
'CapacityRequirements': {
'Spot': {}
,
'OnDemand': {}
},
'NetworkInterface': {
'InterfaceType': 'efa'|'efa-only'
}
},
],
RestrictedInstanceGroups=[
{
'InstanceCount': 123,
'InstanceGroupName': 'string',
'InstanceType': 'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.p5.48xlarge'|'ml.p5.4xlarge'|'ml.p6e-gb200.36xlarge'|'ml.trn1.32xlarge'|'ml.trn1n.32xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.12xlarge'|'ml.g5.16xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.c5n.large'|'ml.c5n.2xlarge'|'ml.c5n.4xlarge'|'ml.c5n.9xlarge'|'ml.c5n.18xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.g6.xlarge'|'ml.g6.2xlarge'|'ml.g6.4xlarge'|'ml.g6.8xlarge'|'ml.g6.16xlarge'|'ml.g6.12xlarge'|'ml.g6.24xlarge'|'ml.g6.48xlarge'|'ml.gr6.4xlarge'|'ml.gr6.8xlarge'|'ml.g6e.xlarge'|'ml.g6e.2xlarge'|'ml.g6e.4xlarge'|'ml.g6e.8xlarge'|'ml.g6e.16xlarge'|'ml.g6e.12xlarge'|'ml.g6e.24xlarge'|'ml.g6e.48xlarge'|'ml.p5e.48xlarge'|'ml.p5en.48xlarge'|'ml.p6-b200.48xlarge'|'ml.trn2.3xlarge'|'ml.trn2.48xlarge'|'ml.c6i.large'|'ml.c6i.xlarge'|'ml.c6i.2xlarge'|'ml.c6i.4xlarge'|'ml.c6i.8xlarge'|'ml.c6i.12xlarge'|'ml.c6i.16xlarge'|'ml.c6i.24xlarge'|'ml.c6i.32xlarge'|'ml.m6i.large'|'ml.m6i.xlarge'|'ml.m6i.2xlarge'|'ml.m6i.4xlarge'|'ml.m6i.8xlarge'|'ml.m6i.12xlarge'|'ml.m6i.16xlarge'|'ml.m6i.24xlarge'|'ml.m6i.32xlarge'|'ml.r6i.large'|'ml.r6i.xlarge'|'ml.r6i.2xlarge'|'ml.r6i.4xlarge'|'ml.r6i.8xlarge'|'ml.r6i.12xlarge'|'ml.r6i.16xlarge'|'ml.r6i.24xlarge'|'ml.r6i.32xlarge'|'ml.i3en.large'|'ml.i3en.xlarge'|'ml.i3en.2xlarge'|'ml.i3en.3xlarge'|'ml.i3en.6xlarge'|'ml.i3en.12xlarge'|'ml.i3en.24xlarge'|'ml.m7i.large'|'ml.m7i.xlarge'|'ml.m7i.2xlarge'|'ml.m7i.4xlarge'|'ml.m7i.8xlarge'|'ml.m7i.12xlarge'|'ml.m7i.16xlarge'|'ml.m7i.24xlarge'|'ml.m7i.48xlarge'|'ml.r7i.large'|'ml.r7i.xlarge'|'ml.r7i.2xlarge'|'ml.r7i.4xlarge'|'ml.r7i.8xlarge'|'ml.r7i.12xlarge'|'ml.r7i.16xlarge'|'ml.r7i.24xlarge'|'ml.r7i.48xlarge'|'ml.r5d.16xlarge'|'ml.g7e.2xlarge'|'ml.g7e.4xlarge'|'ml.g7e.8xlarge'|'ml.g7e.12xlarge'|'ml.g7e.24xlarge'|'ml.g7e.48xlarge'|'ml.p6-b300.48xlarge',
'ExecutionRole': 'string',
'ThreadsPerCore': 123,
'InstanceStorageConfigs': [
{
'EbsVolumeConfig': {
'VolumeSizeInGB': 123,
'VolumeKmsKeyId': 'string',
'RootVolume': True|False
},
'FsxLustreConfig': {
'DnsName': 'string',
'MountName': 'string',
'MountPath': 'string'
},
'FsxOpenZfsConfig': {
'DnsName': 'string',
'MountPath': 'string'
}
},
],
'OnStartDeepHealthChecks': [
'InstanceStress'|'InstanceConnectivity',
],
'TrainingPlanArn': 'string',
'OverrideVpcConfig': {
'SecurityGroupIds': [
'string',
],
'Subnets': [
'string',
]
},
'ScheduledUpdateConfig': {
'ScheduleExpression': 'string',
'DeploymentConfig': {
'RollingUpdatePolicy': {
'MaximumBatchSize': {
'Type': 'INSTANCE_COUNT'|'CAPACITY_PERCENTAGE',
'Value': 123
},
'RollbackMaximumBatchSize': {
'Type': 'INSTANCE_COUNT'|'CAPACITY_PERCENTAGE',
'Value': 123
}
},
'WaitIntervalInSeconds': 123,
'AutoRollbackConfiguration': [
{
'AlarmName': 'string'
},
]
}
},
'EnvironmentConfig': {
'FSxLustreConfig': {
'SizeInGiB': 123,
'PerUnitStorageThroughput': 123
}
}
},
],
RestrictedInstanceGroupsConfig={
'SharedEnvironmentConfig': {
'FSxLustreDeletionPolicy': 'DeleteIfNotUsed'|'Keep',
'FSxLustreConfig': {
'SizeInGiB': 123,
'PerUnitStorageThroughput': 123
}
}
},
VpcConfig={
'SecurityGroupIds': [
'string',
],
'Subnets': [
'string',
]
},
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
Orchestrator={
'Eks': {
'ClusterArn': 'string'
},
'Slurm': {
'SlurmConfigStrategy': 'Overwrite'|'Managed'|'Merge'
}
},
NodeRecovery='Automatic'|'None',
TieredStorageConfig={
'Mode': 'Enable'|'Disable',
'InstanceMemoryAllocationPercentage': 123
},
NodeProvisioningMode='Continuous',
ClusterRole='string',
AutoScaling={
'Mode': 'Enable'|'Disable',
'AutoScalerType': 'Karpenter'
}
)
string
[REQUIRED]
The name for the new SageMaker HyperPod cluster.
list
The instance groups to be created in the SageMaker HyperPod cluster.
(dict) --
The specifications of an instance group that you need to define.
InstanceCount (integer) -- [REQUIRED]
Specifies the number of instances to add to the instance group of a SageMaker HyperPod cluster.
MinInstanceCount (integer) --
Defines the minimum number of instances required for an instance group to become InService. If this threshold isn't met within 3 hours, the instance group rolls back to its previous state - zero instances for new instance groups, or previous settings for existing instance groups. MinInstanceCount only affects the initial transition to InService and does not guarantee maintaining this minimum afterward.
InstanceGroupName (string) -- [REQUIRED]
Specifies the name of the instance group.
InstanceType (string) --
Specifies the instance type of the instance group.
InstanceRequirements (dict) --
The instance requirements for the instance group, including the instance types to use. Use this to create a flexible instance group that supports multiple instance types. The InstanceType and InstanceRequirements properties are mutually exclusive.
InstanceTypes (list) -- [REQUIRED]
The list of instance types that the instance group can use. The order of instance types determines the priority—HyperPod attempts to provision instances using the first instance type in the list and falls back to subsequent types if capacity is unavailable.
(string) --
LifeCycleConfig (dict) --
Specifies the LifeCycle configuration for the instance group.
SourceS3Uri (string) --
An Amazon S3 bucket path where your lifecycle scripts are stored.
OnCreate (string) --
The file name of the entrypoint script of lifecycle scripts under SourceS3Uri. This entrypoint script runs during cluster creation.
OnInitComplete (string) --
The file name of the entrypoint script of lifecycle scripts under SourceS3Uri. This script runs on the node after the AMI-based initialization is complete.
ExecutionRole (string) -- [REQUIRED]
Specifies an IAM execution role to be assumed by the instance group.
ThreadsPerCore (integer) --
Specifies the value for Threads per core. For instance types that support multithreading, you can specify 1 for disabling multithreading and 2 for enabling multithreading. For instance types that doesn't support multithreading, specify 1. For more information, see the reference table of CPU cores and threads per CPU core per instance type in the Amazon Elastic Compute Cloud User Guide.
InstanceStorageConfigs (list) --
Specifies the additional storage configurations for the instances in the SageMaker HyperPod cluster instance group.
(dict) --
Defines the configuration for attaching additional storage to the instances in the SageMaker HyperPod cluster instance group. To learn more, see SageMaker HyperPod release notes: June 20, 2024.
EbsVolumeConfig (dict) --
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 /opt/sagemaker.
VolumeSizeInGB (integer) --
The size in gigabytes (GB) of the additional EBS volume to be attached 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 /opt/sagemaker.
VolumeKmsKeyId (string) --
The ID of a KMS key to encrypt the Amazon EBS volume.
RootVolume (boolean) --
Specifies whether the configuration is for the cluster's root or secondary Amazon EBS volume. You can specify two ClusterEbsVolumeConfig fields to configure both the root and secondary volumes. Set the value to True if you'd like to provide your own customer managed Amazon Web Services KMS key to encrypt the root volume. When True:
The configuration is applied to the root volume.
You can't specify the VolumeSizeInGB field. The size of the root volume is determined for you.
You must specify a KMS key ID for VolumeKmsKeyId to encrypt the root volume with your own KMS key instead of an Amazon Web Services owned KMS key.
Otherwise, by default, the value is False, and the following applies:
The configuration is applied to the secondary volume, while the root volume is encrypted with an Amazon Web Services owned key.
You must specify the VolumeSizeInGB field.
You can optionally specify the VolumeKmsKeyId to encrypt the secondary volume with your own KMS key instead of an Amazon Web Services owned KMS key.
FsxLustreConfig (dict) --
Defines the configuration for attaching an Amazon FSx for Lustre file system to the instances in the SageMaker HyperPod cluster instance group.
DnsName (string) -- [REQUIRED]
The DNS name of the Amazon FSx for Lustre file system.
MountName (string) -- [REQUIRED]
The mount name of the Amazon FSx for Lustre file system.
MountPath (string) --
The local path where the Amazon FSx for Lustre file system is mounted on instances.
FsxOpenZfsConfig (dict) --
Defines the configuration for attaching an Amazon FSx for OpenZFS file system to the instances in the SageMaker HyperPod cluster instance group.
DnsName (string) -- [REQUIRED]
The DNS name of the Amazon FSx for OpenZFS file system.
MountPath (string) --
The local path where the Amazon FSx for OpenZFS file system is mounted on instances.
OnStartDeepHealthChecks (list) --
A flag indicating whether deep health checks should be performed when the cluster instance group is created or updated.
(string) --
TrainingPlanArn (string) --
The Amazon Resource Name (ARN); of the training plan to use for this cluster instance group.
For more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see ``CreateTrainingPlan ``.
OverrideVpcConfig (dict) --
To configure multi-AZ deployments, customize the Amazon VPC configuration at the instance group level. You can specify different subnets and security groups across different AZs in the instance group specification to override a SageMaker HyperPod cluster's default Amazon VPC configuration. For more information about deploying a cluster in multiple AZs, see Setting up SageMaker HyperPod clusters across multiple AZs.
SecurityGroupIds (list) -- [REQUIRED]
The VPC security group IDs, in the form sg-xxxxxxxx. Specify the security groups for the VPC that is specified in the Subnets field.
(string) --
Subnets (list) -- [REQUIRED]
The ID of the subnets in the VPC to which you want to connect your training job or model. For information about the availability of specific instance types, see Supported Instance Types and Availability Zones.
(string) --
ScheduledUpdateConfig (dict) --
The configuration object of the schedule that SageMaker uses to update the AMI.
ScheduleExpression (string) -- [REQUIRED]
A cron expression that specifies the schedule that SageMaker follows when updating the AMI.
DeploymentConfig (dict) --
The configuration to use when updating the AMI versions.
RollingUpdatePolicy (dict) --
The policy that SageMaker uses when updating the AMI versions of the cluster.
MaximumBatchSize (dict) -- [REQUIRED]
The maximum amount of instances in the cluster that SageMaker can update at a time.
Type (string) -- [REQUIRED]
Specifies whether SageMaker should process the update by amount or percentage of instances.
Value (integer) -- [REQUIRED]
Specifies the amount or percentage of instances SageMaker updates at a time.
RollbackMaximumBatchSize (dict) --
The maximum amount of instances in the cluster that SageMaker can roll back at a time.
Type (string) -- [REQUIRED]
Specifies whether SageMaker should process the update by amount or percentage of instances.
Value (integer) -- [REQUIRED]
Specifies the amount or percentage of instances SageMaker updates at a time.
WaitIntervalInSeconds (integer) --
The duration in seconds that SageMaker waits before updating more instances in the cluster.
AutoRollbackConfiguration (list) --
An array that contains the alarms that SageMaker monitors to know whether to roll back the AMI update.
(dict) --
The details of the alarm to monitor during the AMI update.
AlarmName (string) -- [REQUIRED]
The name of the alarm.
ImageId (string) --
When configuring your HyperPod cluster, you can specify an image ID using one of the following options:
HyperPodPublicAmiId: Use a HyperPod public AMI
CustomAmiId: Use your custom AMI
default: Use the default latest system image
If you choose to use a custom AMI ( CustomAmiId), ensure it meets the following requirements:
Encryption: The custom AMI must be unencrypted.
Ownership: The custom AMI must be owned by the same Amazon Web Services account that is creating the HyperPod cluster.
Volume support: Only the primary AMI snapshot volume is supported; additional AMI volumes are not supported.
When updating the instance group's AMI through the UpdateClusterSoftware operation, if an instance group uses a custom AMI, you must provide an ImageId or use the default as input. Note that if you don't specify an instance group in your UpdateClusterSoftware request, then all of the instance groups are patched with the specified image.
KubernetesConfig (dict) --
Specifies the Kubernetes configuration for the instance group. You describe what you want the labels and taints to look like, and the cluster works to reconcile the actual state with the declared state for nodes in this instance group.
Labels (dict) --
Key-value pairs of labels to be applied to cluster nodes.
(string) --
(string) --
Taints (list) --
List of taints to be applied to cluster nodes.
(dict) --
A Kubernetes taint that can be applied to cluster nodes.
Key (string) -- [REQUIRED]
The key of the taint.
Value (string) --
The value of the taint.
Effect (string) -- [REQUIRED]
The effect of the taint. Valid values are NoSchedule, PreferNoSchedule, and NoExecute.
SlurmConfig (dict) --
Specifies the Slurm configuration for the instance group.
NodeType (string) -- [REQUIRED]
The type of Slurm node for the instance group. Valid values are Controller, Worker, and Login.
PartitionNames (list) --
The list of Slurm partition names that the instance group belongs to.
(string) --
CapacityRequirements (dict) --
Specifies the capacity requirements for the instance group.
Spot (dict) --
Configuration options specific to Spot instances.
OnDemand (dict) --
Configuration options specific to On-Demand instances.
NetworkInterface (dict) --
The network interface configuration for the instance group.
InterfaceType (string) --
The type of network interface for the instance group. Valid values:
efa – An EFA with ENA interface, which provides both the EFA device for low-latency, high-throughput communication and the ENA device for IP networking.
efa-only – An EFA-only interface, which provides only the EFA device capabilities without the ENA device for traditional IP networking.
For more information, see Elastic Fabric Adapter.
list
The specialized instance groups for training models like Amazon Nova to be created in the SageMaker HyperPod cluster.
(dict) --
The specifications of a restricted instance group that you need to define.
InstanceCount (integer) -- [REQUIRED]
Specifies the number of instances to add to the restricted instance group of a SageMaker HyperPod cluster.
InstanceGroupName (string) -- [REQUIRED]
Specifies the name of the restricted instance group.
InstanceType (string) -- [REQUIRED]
Specifies the instance type of the restricted instance group.
ExecutionRole (string) -- [REQUIRED]
Specifies an IAM execution role to be assumed by the restricted instance group.
ThreadsPerCore (integer) --
The number you specified to TreadsPerCore in CreateCluster for enabling or disabling multithreading. For instance types that support multithreading, you can specify 1 for disabling multithreading and 2 for enabling multithreading. For more information, see the reference table of CPU cores and threads per CPU core per instance type in the Amazon Elastic Compute Cloud User Guide.
InstanceStorageConfigs (list) --
Specifies the additional storage configurations for the instances in the SageMaker HyperPod cluster restricted instance group.
(dict) --
Defines the configuration for attaching additional storage to the instances in the SageMaker HyperPod cluster instance group. To learn more, see SageMaker HyperPod release notes: June 20, 2024.
EbsVolumeConfig (dict) --
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 /opt/sagemaker.
VolumeSizeInGB (integer) --
The size in gigabytes (GB) of the additional EBS volume to be attached 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 /opt/sagemaker.
VolumeKmsKeyId (string) --
The ID of a KMS key to encrypt the Amazon EBS volume.
RootVolume (boolean) --
Specifies whether the configuration is for the cluster's root or secondary Amazon EBS volume. You can specify two ClusterEbsVolumeConfig fields to configure both the root and secondary volumes. Set the value to True if you'd like to provide your own customer managed Amazon Web Services KMS key to encrypt the root volume. When True:
The configuration is applied to the root volume.
You can't specify the VolumeSizeInGB field. The size of the root volume is determined for you.
You must specify a KMS key ID for VolumeKmsKeyId to encrypt the root volume with your own KMS key instead of an Amazon Web Services owned KMS key.
Otherwise, by default, the value is False, and the following applies:
The configuration is applied to the secondary volume, while the root volume is encrypted with an Amazon Web Services owned key.
You must specify the VolumeSizeInGB field.
You can optionally specify the VolumeKmsKeyId to encrypt the secondary volume with your own KMS key instead of an Amazon Web Services owned KMS key.
FsxLustreConfig (dict) --
Defines the configuration for attaching an Amazon FSx for Lustre file system to the instances in the SageMaker HyperPod cluster instance group.
DnsName (string) -- [REQUIRED]
The DNS name of the Amazon FSx for Lustre file system.
MountName (string) -- [REQUIRED]
The mount name of the Amazon FSx for Lustre file system.
MountPath (string) --
The local path where the Amazon FSx for Lustre file system is mounted on instances.
FsxOpenZfsConfig (dict) --
Defines the configuration for attaching an Amazon FSx for OpenZFS file system to the instances in the SageMaker HyperPod cluster instance group.
DnsName (string) -- [REQUIRED]
The DNS name of the Amazon FSx for OpenZFS file system.
MountPath (string) --
The local path where the Amazon FSx for OpenZFS file system is mounted on instances.
OnStartDeepHealthChecks (list) --
A flag indicating whether deep health checks should be performed when the cluster restricted instance group is created or updated.
(string) --
TrainingPlanArn (string) --
The Amazon Resource Name (ARN) of the training plan to filter clusters by. For more information about reserving GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see ``CreateTrainingPlan ``.
OverrideVpcConfig (dict) --
Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources have access to. You can control access to and from your resources by configuring a VPC. For more information, see Give SageMaker Access to Resources in your Amazon VPC.
SecurityGroupIds (list) -- [REQUIRED]
The VPC security group IDs, in the form sg-xxxxxxxx. Specify the security groups for the VPC that is specified in the Subnets field.
(string) --
Subnets (list) -- [REQUIRED]
The ID of the subnets in the VPC to which you want to connect your training job or model. For information about the availability of specific instance types, see Supported Instance Types and Availability Zones.
(string) --
ScheduledUpdateConfig (dict) --
The configuration object of the schedule that SageMaker follows when updating the AMI.
ScheduleExpression (string) -- [REQUIRED]
A cron expression that specifies the schedule that SageMaker follows when updating the AMI.
DeploymentConfig (dict) --
The configuration to use when updating the AMI versions.
RollingUpdatePolicy (dict) --
The policy that SageMaker uses when updating the AMI versions of the cluster.
MaximumBatchSize (dict) -- [REQUIRED]
The maximum amount of instances in the cluster that SageMaker can update at a time.
Type (string) -- [REQUIRED]
Specifies whether SageMaker should process the update by amount or percentage of instances.
Value (integer) -- [REQUIRED]
Specifies the amount or percentage of instances SageMaker updates at a time.
RollbackMaximumBatchSize (dict) --
The maximum amount of instances in the cluster that SageMaker can roll back at a time.
Type (string) -- [REQUIRED]
Specifies whether SageMaker should process the update by amount or percentage of instances.
Value (integer) -- [REQUIRED]
Specifies the amount or percentage of instances SageMaker updates at a time.
WaitIntervalInSeconds (integer) --
The duration in seconds that SageMaker waits before updating more instances in the cluster.
AutoRollbackConfiguration (list) --
An array that contains the alarms that SageMaker monitors to know whether to roll back the AMI update.
(dict) --
The details of the alarm to monitor during the AMI update.
AlarmName (string) -- [REQUIRED]
The name of the alarm.
EnvironmentConfig (dict) --
The configuration for the restricted instance groups (RIG) environment.
FSxLustreConfig (dict) --
Configuration settings for an Amazon FSx for Lustre file system to be used with the cluster.
SizeInGiB (integer) -- [REQUIRED]
The storage capacity of the Amazon FSx for Lustre file system, specified in gibibytes (GiB).
PerUnitStorageThroughput (integer) -- [REQUIRED]
The throughput capacity of the Amazon FSx for Lustre file system, measured in MB/s per TiB of storage.
dict
The configuration for the restricted instance groups (RIG) in the SageMaker HyperPod cluster.
SharedEnvironmentConfig (dict) -- [REQUIRED]
The shared environment configuration for the restricted instance groups (RIG).
FSxLustreDeletionPolicy (string) -- [REQUIRED]
The deletion policy for the Amazon FSx for Lustre file system in the shared environment.
FSxLustreConfig (dict) -- [REQUIRED]
Configuration settings for an Amazon FSx for Lustre file system in the shared environment.
SizeInGiB (integer) -- [REQUIRED]
The storage capacity of the Amazon FSx for Lustre file system, specified in gibibytes (GiB).
PerUnitStorageThroughput (integer) -- [REQUIRED]
The throughput capacity of the Amazon FSx for Lustre file system, measured in MB/s per TiB of storage.
dict
Specifies the Amazon Virtual Private Cloud (VPC) that is associated with the Amazon SageMaker HyperPod cluster. You can control access to and from your resources by configuring your VPC. For more information, see Give SageMaker access to resources in your Amazon VPC.
SecurityGroupIds (list) -- [REQUIRED]
The VPC security group IDs, in the form sg-xxxxxxxx. Specify the security groups for the VPC that is specified in the Subnets field.
(string) --
Subnets (list) -- [REQUIRED]
The ID of the subnets in the VPC to which you want to connect your training job or model. For information about the availability of specific instance types, see Supported Instance Types and Availability Zones.
(string) --
list
Custom tags for managing the SageMaker HyperPod cluster as an Amazon Web Services resource. You can add tags to your cluster in the same way you add them in other Amazon Web Services services that support tagging. To learn more about tagging Amazon Web Services resources in general, see Tagging Amazon Web Services Resources User Guide.
(dict) --
A tag object that consists of a key and an optional value, used to manage metadata for SageMaker Amazon Web Services resources.
You can add tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations, and endpoints. For more information on adding tags to SageMaker resources, see AddTags.
For more information on adding metadata to your Amazon Web Services resources with tagging, see Tagging Amazon Web Services resources. For advice on best practices for managing Amazon Web Services resources with tagging, see Tagging Best Practices: Implement an Effective Amazon Web Services Resource Tagging Strategy.
Key (string) -- [REQUIRED]
The tag key. Tag keys must be unique per resource.
Value (string) -- [REQUIRED]
The tag value.
dict
The type of orchestrator to use for the SageMaker HyperPod cluster. Currently, supported values are "Eks" and "Slurm", which is to use an Amazon Elastic Kubernetes Service or Slurm cluster as the orchestrator.
Eks (dict) --
The Amazon EKS cluster used as the orchestrator for the SageMaker HyperPod cluster.
ClusterArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the Amazon EKS cluster associated with the SageMaker HyperPod cluster.
Slurm (dict) --
The Slurm orchestrator configuration for the SageMaker HyperPod cluster.
SlurmConfigStrategy (string) --
The strategy for managing partitions for the Slurm configuration. Valid values are Managed, Overwrite, and Merge.
string
The node recovery mode for the SageMaker HyperPod cluster. When set to Automatic, SageMaker HyperPod will automatically reboot or replace faulty nodes when issues are detected. When set to None, cluster administrators will need to manually manage any faulty cluster instances.
dict
The configuration for managed tier checkpointing on the HyperPod cluster. When enabled, this feature uses a multi-tier storage approach for storing model checkpoints, providing faster checkpoint operations and improved fault tolerance across cluster nodes.
Mode (string) -- [REQUIRED]
Specifies whether managed tier checkpointing is enabled or disabled for the HyperPod cluster. When set to Enable, the system installs a memory management daemon that provides disaggregated memory as a service for checkpoint storage. When set to Disable, the feature is turned off and the memory management daemon is removed from the cluster.
InstanceMemoryAllocationPercentage (integer) --
The percentage (int) of cluster memory to allocate for checkpointing.
string
The mode for provisioning nodes in the cluster. You can specify the following modes:
Continuous: Scaling behavior that enables 1) concurrent operation execution within instance groups, 2) continuous retry mechanisms for failed operations, 3) enhanced customer visibility into cluster events through detailed event streams, 4) partial provisioning capabilities. Your clusters and instance groups remain InService while scaling. This mode is only supported for EKS orchestrated clusters.
string
The Amazon Resource Name (ARN) of the IAM role that HyperPod assumes to perform cluster autoscaling operations. This role must have permissions for sagemaker:BatchAddClusterNodes and sagemaker:BatchDeleteClusterNodes. This is only required when autoscaling is enabled and when HyperPod is performing autoscaling operations.
dict
The autoscaling configuration for the cluster. Enables automatic scaling of cluster nodes based on workload demand using a Karpenter-based system.
Mode (string) -- [REQUIRED]
Describes whether autoscaling is enabled or disabled for the cluster. Valid values are Enable and Disable.
AutoScalerType (string) --
The type of autoscaler to use. Currently supported value is Karpenter.
dict
Response Syntax
{
'ClusterArn': 'string'
}
Response Structure
(dict) --
ClusterArn (string) --
The Amazon Resource Name (ARN) of the cluster.
{'ComputeSpec': {'InstanceTypes': {'ml.p6-b200.48xlarge'}},
'Recommendations': {'DeploymentConfiguration': {'InstanceType': {'ml.p6-b200.48xlarge'}},
'ModelDetails': {'InstanceDetails': {'InstanceType': {'ml.p6-b200.48xlarge'}}}}}
Returns details of an AI recommendation job, including its status, model source, performance targets, optimization recommendations, and deployment configurations.
See also: AWS API Documentation
Request Syntax
client.describe_ai_recommendation_job(
AIRecommendationJobName='string'
)
string
[REQUIRED]
The name of the AI recommendation job to describe.
dict
Response Syntax
{
'AIRecommendationJobName': 'string',
'AIRecommendationJobArn': 'string',
'AIRecommendationJobStatus': 'InProgress'|'Completed'|'Failed'|'Stopping'|'Stopped',
'FailureReason': 'string',
'ModelSource': {
'S3': {
'S3Uri': 'string'
}
},
'OutputConfig': {
'S3OutputLocation': 'string',
'ModelPackageGroupIdentifier': 'string'
},
'InferenceSpecification': {
'Framework': 'LMI'|'VLLM'
},
'AIWorkloadConfigIdentifier': 'string',
'OptimizeModel': True|False,
'PerformanceTarget': {
'Constraints': [
{
'Metric': 'ttft-ms'|'throughput'|'cost'
},
]
},
'Recommendations': [
{
'RecommendationDescription': 'string',
'OptimizationDetails': [
{
'OptimizationType': 'SpeculativeDecoding'|'KernelTuning',
'OptimizationConfig': {
'string': 'string'
}
},
],
'ModelDetails': {
'ModelPackageArn': 'string',
'InferenceSpecificationName': 'string',
'InstanceDetails': [
{
'InstanceType': 'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.12xlarge'|'ml.g5.16xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.g6.xlarge'|'ml.g6.2xlarge'|'ml.g6.4xlarge'|'ml.g6.8xlarge'|'ml.g6.12xlarge'|'ml.g6.16xlarge'|'ml.g6.24xlarge'|'ml.g6.48xlarge'|'ml.g6e.xlarge'|'ml.g6e.2xlarge'|'ml.g6e.4xlarge'|'ml.g6e.8xlarge'|'ml.g6e.12xlarge'|'ml.g6e.16xlarge'|'ml.g6e.24xlarge'|'ml.g6e.48xlarge'|'ml.g7e.2xlarge'|'ml.g7e.4xlarge'|'ml.g7e.8xlarge'|'ml.g7e.12xlarge'|'ml.g7e.24xlarge'|'ml.g7e.48xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.p5.4xlarge'|'ml.p5.48xlarge'|'ml.p5e.48xlarge'|'ml.p5en.48xlarge'|'ml.p6-b200.48xlarge',
'InstanceCount': 123,
'CopyCountPerInstance': 123
},
]
},
'DeploymentConfiguration': {
'S3': [
{
'ChannelName': 'string',
'Uri': 'string'
},
],
'ImageUri': 'string',
'InstanceType': 'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.12xlarge'|'ml.g5.16xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.g6.xlarge'|'ml.g6.2xlarge'|'ml.g6.4xlarge'|'ml.g6.8xlarge'|'ml.g6.12xlarge'|'ml.g6.16xlarge'|'ml.g6.24xlarge'|'ml.g6.48xlarge'|'ml.g6e.xlarge'|'ml.g6e.2xlarge'|'ml.g6e.4xlarge'|'ml.g6e.8xlarge'|'ml.g6e.12xlarge'|'ml.g6e.16xlarge'|'ml.g6e.24xlarge'|'ml.g6e.48xlarge'|'ml.g7e.2xlarge'|'ml.g7e.4xlarge'|'ml.g7e.8xlarge'|'ml.g7e.12xlarge'|'ml.g7e.24xlarge'|'ml.g7e.48xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.p5.4xlarge'|'ml.p5.48xlarge'|'ml.p5e.48xlarge'|'ml.p5en.48xlarge'|'ml.p6-b200.48xlarge',
'InstanceCount': 123,
'CopyCountPerInstance': 123,
'EnvironmentVariables': {
'string': 'string'
}
},
'AIBenchmarkJobArn': 'string',
'ExpectedPerformance': [
{
'Metric': 'string',
'Stat': 'string',
'Value': 'string',
'Unit': 'string'
},
]
},
],
'RoleArn': 'string',
'ComputeSpec': {
'InstanceTypes': [
'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.12xlarge'|'ml.g5.16xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.g6.xlarge'|'ml.g6.2xlarge'|'ml.g6.4xlarge'|'ml.g6.8xlarge'|'ml.g6.12xlarge'|'ml.g6.16xlarge'|'ml.g6.24xlarge'|'ml.g6.48xlarge'|'ml.g6e.xlarge'|'ml.g6e.2xlarge'|'ml.g6e.4xlarge'|'ml.g6e.8xlarge'|'ml.g6e.12xlarge'|'ml.g6e.16xlarge'|'ml.g6e.24xlarge'|'ml.g6e.48xlarge'|'ml.g7e.2xlarge'|'ml.g7e.4xlarge'|'ml.g7e.8xlarge'|'ml.g7e.12xlarge'|'ml.g7e.24xlarge'|'ml.g7e.48xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.p5.4xlarge'|'ml.p5.48xlarge'|'ml.p5e.48xlarge'|'ml.p5en.48xlarge'|'ml.p6-b200.48xlarge',
],
'CapacityReservationConfig': {
'CapacityReservationPreference': 'capacity-reservations-only',
'MlReservationArns': [
'string',
]
}
},
'CreationTime': datetime(2015, 1, 1),
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
Response Structure
(dict) --
AIRecommendationJobName (string) --
The name of the AI recommendation job.
AIRecommendationJobArn (string) --
The Amazon Resource Name (ARN) of the AI recommendation job.
AIRecommendationJobStatus (string) --
The status of the AI recommendation job.
FailureReason (string) --
If the recommendation job failed, the reason it failed.
ModelSource (dict) --
The source of the model that was analyzed.
S3 (dict) --
The Amazon S3 location of the model artifacts.
S3Uri (string) --
The Amazon S3 URI of the model artifacts.
OutputConfig (dict) --
The output configuration for the recommendation job.
S3OutputLocation (string) --
The Amazon S3 URI where the recommendation job writes its output results.
ModelPackageGroupIdentifier (string) --
The name or Amazon Resource Name (ARN) of the model package group where deployment-ready model packages are registered.
InferenceSpecification (dict) --
The inference framework configuration.
Framework (string) --
The inference framework. Valid values are LMI and VLLM.
AIWorkloadConfigIdentifier (string) --
The name or Amazon Resource Name (ARN) of the AI workload configuration used for this recommendation job.
OptimizeModel (boolean) --
Whether model optimization techniques were allowed.
PerformanceTarget (dict) --
The performance targets specified for the recommendation job.
Constraints (list) --
An array of performance constraints that define the optimization objectives.
(dict) --
A performance constraint for an AI recommendation job.
Metric (string) --
The performance metric. Valid values are ttft-ms (time to first token in milliseconds), throughput, and cost.
Recommendations (list) --
The list of optimization recommendations generated by the job. Each recommendation includes optimization details, deployment configuration, expected performance metrics, and the associated benchmark job ARN.
(dict) --
An optimization recommendation generated by an AI recommendation job.
RecommendationDescription (string) --
A description of the recommendation.
OptimizationDetails (list) --
The optimization techniques applied in this recommendation.
(dict) --
Details about an optimization technique applied in a recommendation.
OptimizationType (string) --
The type of optimization. Valid values are SpeculativeDecoding and KernelTuning.
OptimizationConfig (dict) --
A map of configuration parameters for the optimization technique.
(string) --
(string) --
ModelDetails (dict) --
Details about the model package associated with this recommendation.
ModelPackageArn (string) --
The Amazon Resource Name (ARN) of the model package.
InferenceSpecificationName (string) --
The name of the inference specification within the model package.
InstanceDetails (list) --
The instance details for this recommendation, including instance type, count, and model copies per instance.
(dict) --
Instance details for a recommendation.
InstanceType (string) --
The recommended instance type.
InstanceCount (integer) --
The recommended number of instances.
CopyCountPerInstance (integer) --
The number of model copies per instance.
DeploymentConfiguration (dict) --
The deployment configuration for this recommendation, including the container image, instance type, instance count, and environment variables.
S3 (list) --
The Amazon S3 data channels for the deployment.
(dict) --
An Amazon S3 data channel for a recommended deployment configuration, containing model artifacts or optimized model outputs.
ChannelName (string) --
A custom name for this Amazon S3 data channel.
Uri (string) --
The Amazon S3 URI of the data for this channel.
ImageUri (string) --
The URI of the container image for the deployment.
InstanceType (string) --
The recommended instance type for the deployment.
InstanceCount (integer) --
The recommended number of instances for the deployment.
CopyCountPerInstance (integer) --
The number of model copies per instance.
EnvironmentVariables (dict) --
The environment variables for the deployment.
(string) --
(string) --
AIBenchmarkJobArn (string) --
The Amazon Resource Name (ARN) of the benchmark job associated with this recommendation.
ExpectedPerformance (list) --
The expected performance metrics for this recommendation.
(dict) --
An expected performance metric for a recommendation.
Metric (string) --
The name of the performance metric.
Stat (string) --
The statistical measure for the metric.
Value (string) --
The value of the metric.
Unit (string) --
The unit of the metric value.
RoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role used by the recommendation job.
ComputeSpec (dict) --
The compute resource specification for the recommendation job.
InstanceTypes (list) --
The list of instance types to consider for recommendations. You can specify up to 3 instance types.
(string) --
CapacityReservationConfig (dict) --
The capacity reservation configuration.
CapacityReservationPreference (string) --
The capacity reservation preference. The only valid value is capacity-reservations-only.
MlReservationArns (list) --
The list of ML reservation ARNs to use.
(string) --
CreationTime (datetime) --
A timestamp that indicates when the recommendation job was created.
StartTime (datetime) --
A timestamp that indicates when the recommendation job started running.
EndTime (datetime) --
A timestamp that indicates when the recommendation job completed.
Tags (list) --
The tags associated with the recommendation job.
(dict) --
A tag object that consists of a key and an optional value, used to manage metadata for SageMaker Amazon Web Services resources.
You can add tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations, and endpoints. For more information on adding tags to SageMaker resources, see AddTags.
For more information on adding metadata to your Amazon Web Services resources with tagging, see Tagging Amazon Web Services resources. For advice on best practices for managing Amazon Web Services resources with tagging, see Tagging Best Practices: Implement an Effective Amazon Web Services Resource Tagging Strategy.
Key (string) --
The tag key. Tag keys must be unique per resource.
Value (string) --
The tag value.
{'RestrictedInstanceGroupsConfig': {'SharedEnvironmentConfig': {'CurrentFSxLustreConfig': {'PerUnitStorageThroughput': 'integer',
'SizeInGiB': 'integer'},
'CurrentFSxLustreDeletionPolicy': 'DeleteIfNotUsed '
'| '
'Keep',
'DesiredFSxLustreConfig': {'PerUnitStorageThroughput': 'integer',
'SizeInGiB': 'integer'},
'DesiredFSxLustreDeletionPolicy': 'DeleteIfNotUsed '
'| '
'Keep'}}}
Retrieves information of a SageMaker HyperPod cluster.
See also: AWS API Documentation
Request Syntax
client.describe_cluster(
ClusterName='string'
)
string
[REQUIRED]
The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster.
dict
Response Syntax
{
'ClusterArn': 'string',
'ClusterName': 'string',
'ClusterStatus': 'Creating'|'Deleting'|'Failed'|'InService'|'RollingBack'|'SystemUpdating'|'Updating',
'CreationTime': datetime(2015, 1, 1),
'FailureMessage': 'string',
'InstanceGroups': [
{
'CurrentCount': 123,
'TargetCount': 123,
'MinCount': 123,
'InstanceGroupName': 'string',
'InstanceType': 'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.p5.48xlarge'|'ml.p5.4xlarge'|'ml.p6e-gb200.36xlarge'|'ml.trn1.32xlarge'|'ml.trn1n.32xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.12xlarge'|'ml.g5.16xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.c5n.large'|'ml.c5n.2xlarge'|'ml.c5n.4xlarge'|'ml.c5n.9xlarge'|'ml.c5n.18xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.g6.xlarge'|'ml.g6.2xlarge'|'ml.g6.4xlarge'|'ml.g6.8xlarge'|'ml.g6.16xlarge'|'ml.g6.12xlarge'|'ml.g6.24xlarge'|'ml.g6.48xlarge'|'ml.gr6.4xlarge'|'ml.gr6.8xlarge'|'ml.g6e.xlarge'|'ml.g6e.2xlarge'|'ml.g6e.4xlarge'|'ml.g6e.8xlarge'|'ml.g6e.16xlarge'|'ml.g6e.12xlarge'|'ml.g6e.24xlarge'|'ml.g6e.48xlarge'|'ml.p5e.48xlarge'|'ml.p5en.48xlarge'|'ml.p6-b200.48xlarge'|'ml.trn2.3xlarge'|'ml.trn2.48xlarge'|'ml.c6i.large'|'ml.c6i.xlarge'|'ml.c6i.2xlarge'|'ml.c6i.4xlarge'|'ml.c6i.8xlarge'|'ml.c6i.12xlarge'|'ml.c6i.16xlarge'|'ml.c6i.24xlarge'|'ml.c6i.32xlarge'|'ml.m6i.large'|'ml.m6i.xlarge'|'ml.m6i.2xlarge'|'ml.m6i.4xlarge'|'ml.m6i.8xlarge'|'ml.m6i.12xlarge'|'ml.m6i.16xlarge'|'ml.m6i.24xlarge'|'ml.m6i.32xlarge'|'ml.r6i.large'|'ml.r6i.xlarge'|'ml.r6i.2xlarge'|'ml.r6i.4xlarge'|'ml.r6i.8xlarge'|'ml.r6i.12xlarge'|'ml.r6i.16xlarge'|'ml.r6i.24xlarge'|'ml.r6i.32xlarge'|'ml.i3en.large'|'ml.i3en.xlarge'|'ml.i3en.2xlarge'|'ml.i3en.3xlarge'|'ml.i3en.6xlarge'|'ml.i3en.12xlarge'|'ml.i3en.24xlarge'|'ml.m7i.large'|'ml.m7i.xlarge'|'ml.m7i.2xlarge'|'ml.m7i.4xlarge'|'ml.m7i.8xlarge'|'ml.m7i.12xlarge'|'ml.m7i.16xlarge'|'ml.m7i.24xlarge'|'ml.m7i.48xlarge'|'ml.r7i.large'|'ml.r7i.xlarge'|'ml.r7i.2xlarge'|'ml.r7i.4xlarge'|'ml.r7i.8xlarge'|'ml.r7i.12xlarge'|'ml.r7i.16xlarge'|'ml.r7i.24xlarge'|'ml.r7i.48xlarge'|'ml.r5d.16xlarge'|'ml.g7e.2xlarge'|'ml.g7e.4xlarge'|'ml.g7e.8xlarge'|'ml.g7e.12xlarge'|'ml.g7e.24xlarge'|'ml.g7e.48xlarge'|'ml.p6-b300.48xlarge',
'InstanceRequirements': {
'CurrentInstanceTypes': [
'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.p5.48xlarge'|'ml.p5.4xlarge'|'ml.p6e-gb200.36xlarge'|'ml.trn1.32xlarge'|'ml.trn1n.32xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.12xlarge'|'ml.g5.16xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.c5n.large'|'ml.c5n.2xlarge'|'ml.c5n.4xlarge'|'ml.c5n.9xlarge'|'ml.c5n.18xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.g6.xlarge'|'ml.g6.2xlarge'|'ml.g6.4xlarge'|'ml.g6.8xlarge'|'ml.g6.16xlarge'|'ml.g6.12xlarge'|'ml.g6.24xlarge'|'ml.g6.48xlarge'|'ml.gr6.4xlarge'|'ml.gr6.8xlarge'|'ml.g6e.xlarge'|'ml.g6e.2xlarge'|'ml.g6e.4xlarge'|'ml.g6e.8xlarge'|'ml.g6e.16xlarge'|'ml.g6e.12xlarge'|'ml.g6e.24xlarge'|'ml.g6e.48xlarge'|'ml.p5e.48xlarge'|'ml.p5en.48xlarge'|'ml.p6-b200.48xlarge'|'ml.trn2.3xlarge'|'ml.trn2.48xlarge'|'ml.c6i.large'|'ml.c6i.xlarge'|'ml.c6i.2xlarge'|'ml.c6i.4xlarge'|'ml.c6i.8xlarge'|'ml.c6i.12xlarge'|'ml.c6i.16xlarge'|'ml.c6i.24xlarge'|'ml.c6i.32xlarge'|'ml.m6i.large'|'ml.m6i.xlarge'|'ml.m6i.2xlarge'|'ml.m6i.4xlarge'|'ml.m6i.8xlarge'|'ml.m6i.12xlarge'|'ml.m6i.16xlarge'|'ml.m6i.24xlarge'|'ml.m6i.32xlarge'|'ml.r6i.large'|'ml.r6i.xlarge'|'ml.r6i.2xlarge'|'ml.r6i.4xlarge'|'ml.r6i.8xlarge'|'ml.r6i.12xlarge'|'ml.r6i.16xlarge'|'ml.r6i.24xlarge'|'ml.r6i.32xlarge'|'ml.i3en.large'|'ml.i3en.xlarge'|'ml.i3en.2xlarge'|'ml.i3en.3xlarge'|'ml.i3en.6xlarge'|'ml.i3en.12xlarge'|'ml.i3en.24xlarge'|'ml.m7i.large'|'ml.m7i.xlarge'|'ml.m7i.2xlarge'|'ml.m7i.4xlarge'|'ml.m7i.8xlarge'|'ml.m7i.12xlarge'|'ml.m7i.16xlarge'|'ml.m7i.24xlarge'|'ml.m7i.48xlarge'|'ml.r7i.large'|'ml.r7i.xlarge'|'ml.r7i.2xlarge'|'ml.r7i.4xlarge'|'ml.r7i.8xlarge'|'ml.r7i.12xlarge'|'ml.r7i.16xlarge'|'ml.r7i.24xlarge'|'ml.r7i.48xlarge'|'ml.r5d.16xlarge'|'ml.g7e.2xlarge'|'ml.g7e.4xlarge'|'ml.g7e.8xlarge'|'ml.g7e.12xlarge'|'ml.g7e.24xlarge'|'ml.g7e.48xlarge'|'ml.p6-b300.48xlarge',
],
'DesiredInstanceTypes': [
'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.p5.48xlarge'|'ml.p5.4xlarge'|'ml.p6e-gb200.36xlarge'|'ml.trn1.32xlarge'|'ml.trn1n.32xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.12xlarge'|'ml.g5.16xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.c5n.large'|'ml.c5n.2xlarge'|'ml.c5n.4xlarge'|'ml.c5n.9xlarge'|'ml.c5n.18xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.g6.xlarge'|'ml.g6.2xlarge'|'ml.g6.4xlarge'|'ml.g6.8xlarge'|'ml.g6.16xlarge'|'ml.g6.12xlarge'|'ml.g6.24xlarge'|'ml.g6.48xlarge'|'ml.gr6.4xlarge'|'ml.gr6.8xlarge'|'ml.g6e.xlarge'|'ml.g6e.2xlarge'|'ml.g6e.4xlarge'|'ml.g6e.8xlarge'|'ml.g6e.16xlarge'|'ml.g6e.12xlarge'|'ml.g6e.24xlarge'|'ml.g6e.48xlarge'|'ml.p5e.48xlarge'|'ml.p5en.48xlarge'|'ml.p6-b200.48xlarge'|'ml.trn2.3xlarge'|'ml.trn2.48xlarge'|'ml.c6i.large'|'ml.c6i.xlarge'|'ml.c6i.2xlarge'|'ml.c6i.4xlarge'|'ml.c6i.8xlarge'|'ml.c6i.12xlarge'|'ml.c6i.16xlarge'|'ml.c6i.24xlarge'|'ml.c6i.32xlarge'|'ml.m6i.large'|'ml.m6i.xlarge'|'ml.m6i.2xlarge'|'ml.m6i.4xlarge'|'ml.m6i.8xlarge'|'ml.m6i.12xlarge'|'ml.m6i.16xlarge'|'ml.m6i.24xlarge'|'ml.m6i.32xlarge'|'ml.r6i.large'|'ml.r6i.xlarge'|'ml.r6i.2xlarge'|'ml.r6i.4xlarge'|'ml.r6i.8xlarge'|'ml.r6i.12xlarge'|'ml.r6i.16xlarge'|'ml.r6i.24xlarge'|'ml.r6i.32xlarge'|'ml.i3en.large'|'ml.i3en.xlarge'|'ml.i3en.2xlarge'|'ml.i3en.3xlarge'|'ml.i3en.6xlarge'|'ml.i3en.12xlarge'|'ml.i3en.24xlarge'|'ml.m7i.large'|'ml.m7i.xlarge'|'ml.m7i.2xlarge'|'ml.m7i.4xlarge'|'ml.m7i.8xlarge'|'ml.m7i.12xlarge'|'ml.m7i.16xlarge'|'ml.m7i.24xlarge'|'ml.m7i.48xlarge'|'ml.r7i.large'|'ml.r7i.xlarge'|'ml.r7i.2xlarge'|'ml.r7i.4xlarge'|'ml.r7i.8xlarge'|'ml.r7i.12xlarge'|'ml.r7i.16xlarge'|'ml.r7i.24xlarge'|'ml.r7i.48xlarge'|'ml.r5d.16xlarge'|'ml.g7e.2xlarge'|'ml.g7e.4xlarge'|'ml.g7e.8xlarge'|'ml.g7e.12xlarge'|'ml.g7e.24xlarge'|'ml.g7e.48xlarge'|'ml.p6-b300.48xlarge',
]
},
'InstanceTypeDetails': [
{
'InstanceType': 'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.p5.48xlarge'|'ml.p5.4xlarge'|'ml.p6e-gb200.36xlarge'|'ml.trn1.32xlarge'|'ml.trn1n.32xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.12xlarge'|'ml.g5.16xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.c5n.large'|'ml.c5n.2xlarge'|'ml.c5n.4xlarge'|'ml.c5n.9xlarge'|'ml.c5n.18xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.g6.xlarge'|'ml.g6.2xlarge'|'ml.g6.4xlarge'|'ml.g6.8xlarge'|'ml.g6.16xlarge'|'ml.g6.12xlarge'|'ml.g6.24xlarge'|'ml.g6.48xlarge'|'ml.gr6.4xlarge'|'ml.gr6.8xlarge'|'ml.g6e.xlarge'|'ml.g6e.2xlarge'|'ml.g6e.4xlarge'|'ml.g6e.8xlarge'|'ml.g6e.16xlarge'|'ml.g6e.12xlarge'|'ml.g6e.24xlarge'|'ml.g6e.48xlarge'|'ml.p5e.48xlarge'|'ml.p5en.48xlarge'|'ml.p6-b200.48xlarge'|'ml.trn2.3xlarge'|'ml.trn2.48xlarge'|'ml.c6i.large'|'ml.c6i.xlarge'|'ml.c6i.2xlarge'|'ml.c6i.4xlarge'|'ml.c6i.8xlarge'|'ml.c6i.12xlarge'|'ml.c6i.16xlarge'|'ml.c6i.24xlarge'|'ml.c6i.32xlarge'|'ml.m6i.large'|'ml.m6i.xlarge'|'ml.m6i.2xlarge'|'ml.m6i.4xlarge'|'ml.m6i.8xlarge'|'ml.m6i.12xlarge'|'ml.m6i.16xlarge'|'ml.m6i.24xlarge'|'ml.m6i.32xlarge'|'ml.r6i.large'|'ml.r6i.xlarge'|'ml.r6i.2xlarge'|'ml.r6i.4xlarge'|'ml.r6i.8xlarge'|'ml.r6i.12xlarge'|'ml.r6i.16xlarge'|'ml.r6i.24xlarge'|'ml.r6i.32xlarge'|'ml.i3en.large'|'ml.i3en.xlarge'|'ml.i3en.2xlarge'|'ml.i3en.3xlarge'|'ml.i3en.6xlarge'|'ml.i3en.12xlarge'|'ml.i3en.24xlarge'|'ml.m7i.large'|'ml.m7i.xlarge'|'ml.m7i.2xlarge'|'ml.m7i.4xlarge'|'ml.m7i.8xlarge'|'ml.m7i.12xlarge'|'ml.m7i.16xlarge'|'ml.m7i.24xlarge'|'ml.m7i.48xlarge'|'ml.r7i.large'|'ml.r7i.xlarge'|'ml.r7i.2xlarge'|'ml.r7i.4xlarge'|'ml.r7i.8xlarge'|'ml.r7i.12xlarge'|'ml.r7i.16xlarge'|'ml.r7i.24xlarge'|'ml.r7i.48xlarge'|'ml.r5d.16xlarge'|'ml.g7e.2xlarge'|'ml.g7e.4xlarge'|'ml.g7e.8xlarge'|'ml.g7e.12xlarge'|'ml.g7e.24xlarge'|'ml.g7e.48xlarge'|'ml.p6-b300.48xlarge',
'CurrentCount': 123,
'ThreadsPerCore': 123
},
],
'LifeCycleConfig': {
'SourceS3Uri': 'string',
'OnCreate': 'string',
'OnInitComplete': 'string'
},
'ExecutionRole': 'string',
'ThreadsPerCore': 123,
'InstanceStorageConfigs': [
{
'EbsVolumeConfig': {
'VolumeSizeInGB': 123,
'VolumeKmsKeyId': 'string',
'RootVolume': True|False
},
'FsxLustreConfig': {
'DnsName': 'string',
'MountName': 'string',
'MountPath': 'string'
},
'FsxOpenZfsConfig': {
'DnsName': 'string',
'MountPath': 'string'
}
},
],
'OnStartDeepHealthChecks': [
'InstanceStress'|'InstanceConnectivity',
],
'Status': 'InService'|'Creating'|'Updating'|'Failed'|'Degraded'|'SystemUpdating'|'Deleting',
'TrainingPlanArn': 'string',
'TrainingPlanStatus': 'string',
'OverrideVpcConfig': {
'SecurityGroupIds': [
'string',
],
'Subnets': [
'string',
]
},
'ScheduledUpdateConfig': {
'ScheduleExpression': 'string',
'DeploymentConfig': {
'RollingUpdatePolicy': {
'MaximumBatchSize': {
'Type': 'INSTANCE_COUNT'|'CAPACITY_PERCENTAGE',
'Value': 123
},
'RollbackMaximumBatchSize': {
'Type': 'INSTANCE_COUNT'|'CAPACITY_PERCENTAGE',
'Value': 123
}
},
'WaitIntervalInSeconds': 123,
'AutoRollbackConfiguration': [
{
'AlarmName': 'string'
},
]
}
},
'CurrentImageId': 'string',
'DesiredImageId': 'string',
'ImageVersionStatus': 'UpToDate'|'UpdateAvailable',
'ActiveOperations': {
'string': 123
},
'KubernetesConfig': {
'CurrentLabels': {
'string': 'string'
},
'DesiredLabels': {
'string': 'string'
},
'CurrentTaints': [
{
'Key': 'string',
'Value': 'string',
'Effect': 'NoSchedule'|'PreferNoSchedule'|'NoExecute'
},
],
'DesiredTaints': [
{
'Key': 'string',
'Value': 'string',
'Effect': 'NoSchedule'|'PreferNoSchedule'|'NoExecute'
},
]
},
'CapacityRequirements': {
'Spot': {},
'OnDemand': {}
},
'TargetStateCount': 123,
'SoftwareUpdateStatus': 'Pending'|'InProgress'|'Succeeded'|'Failed'|'RollbackInProgress'|'RollbackComplete',
'ActiveSoftwareUpdateConfig': {
'RollingUpdatePolicy': {
'MaximumBatchSize': {
'Type': 'INSTANCE_COUNT'|'CAPACITY_PERCENTAGE',
'Value': 123
},
'RollbackMaximumBatchSize': {
'Type': 'INSTANCE_COUNT'|'CAPACITY_PERCENTAGE',
'Value': 123
}
},
'WaitIntervalInSeconds': 123,
'AutoRollbackConfiguration': [
{
'AlarmName': 'string'
},
]
},
'SlurmConfig': {
'NodeType': 'Controller'|'Login'|'Compute',
'PartitionNames': [
'string',
]
},
'NetworkInterface': {
'InterfaceType': 'efa'|'efa-only'
}
},
],
'RestrictedInstanceGroups': [
{
'CurrentCount': 123,
'TargetCount': 123,
'InstanceGroupName': 'string',
'InstanceType': 'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.p5.48xlarge'|'ml.p5.4xlarge'|'ml.p6e-gb200.36xlarge'|'ml.trn1.32xlarge'|'ml.trn1n.32xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.12xlarge'|'ml.g5.16xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.c5n.large'|'ml.c5n.2xlarge'|'ml.c5n.4xlarge'|'ml.c5n.9xlarge'|'ml.c5n.18xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.g6.xlarge'|'ml.g6.2xlarge'|'ml.g6.4xlarge'|'ml.g6.8xlarge'|'ml.g6.16xlarge'|'ml.g6.12xlarge'|'ml.g6.24xlarge'|'ml.g6.48xlarge'|'ml.gr6.4xlarge'|'ml.gr6.8xlarge'|'ml.g6e.xlarge'|'ml.g6e.2xlarge'|'ml.g6e.4xlarge'|'ml.g6e.8xlarge'|'ml.g6e.16xlarge'|'ml.g6e.12xlarge'|'ml.g6e.24xlarge'|'ml.g6e.48xlarge'|'ml.p5e.48xlarge'|'ml.p5en.48xlarge'|'ml.p6-b200.48xlarge'|'ml.trn2.3xlarge'|'ml.trn2.48xlarge'|'ml.c6i.large'|'ml.c6i.xlarge'|'ml.c6i.2xlarge'|'ml.c6i.4xlarge'|'ml.c6i.8xlarge'|'ml.c6i.12xlarge'|'ml.c6i.16xlarge'|'ml.c6i.24xlarge'|'ml.c6i.32xlarge'|'ml.m6i.large'|'ml.m6i.xlarge'|'ml.m6i.2xlarge'|'ml.m6i.4xlarge'|'ml.m6i.8xlarge'|'ml.m6i.12xlarge'|'ml.m6i.16xlarge'|'ml.m6i.24xlarge'|'ml.m6i.32xlarge'|'ml.r6i.large'|'ml.r6i.xlarge'|'ml.r6i.2xlarge'|'ml.r6i.4xlarge'|'ml.r6i.8xlarge'|'ml.r6i.12xlarge'|'ml.r6i.16xlarge'|'ml.r6i.24xlarge'|'ml.r6i.32xlarge'|'ml.i3en.large'|'ml.i3en.xlarge'|'ml.i3en.2xlarge'|'ml.i3en.3xlarge'|'ml.i3en.6xlarge'|'ml.i3en.12xlarge'|'ml.i3en.24xlarge'|'ml.m7i.large'|'ml.m7i.xlarge'|'ml.m7i.2xlarge'|'ml.m7i.4xlarge'|'ml.m7i.8xlarge'|'ml.m7i.12xlarge'|'ml.m7i.16xlarge'|'ml.m7i.24xlarge'|'ml.m7i.48xlarge'|'ml.r7i.large'|'ml.r7i.xlarge'|'ml.r7i.2xlarge'|'ml.r7i.4xlarge'|'ml.r7i.8xlarge'|'ml.r7i.12xlarge'|'ml.r7i.16xlarge'|'ml.r7i.24xlarge'|'ml.r7i.48xlarge'|'ml.r5d.16xlarge'|'ml.g7e.2xlarge'|'ml.g7e.4xlarge'|'ml.g7e.8xlarge'|'ml.g7e.12xlarge'|'ml.g7e.24xlarge'|'ml.g7e.48xlarge'|'ml.p6-b300.48xlarge',
'ExecutionRole': 'string',
'ThreadsPerCore': 123,
'InstanceStorageConfigs': [
{
'EbsVolumeConfig': {
'VolumeSizeInGB': 123,
'VolumeKmsKeyId': 'string',
'RootVolume': True|False
},
'FsxLustreConfig': {
'DnsName': 'string',
'MountName': 'string',
'MountPath': 'string'
},
'FsxOpenZfsConfig': {
'DnsName': 'string',
'MountPath': 'string'
}
},
],
'OnStartDeepHealthChecks': [
'InstanceStress'|'InstanceConnectivity',
],
'Status': 'InService'|'Creating'|'Updating'|'Failed'|'Degraded'|'SystemUpdating'|'Deleting',
'TrainingPlanArn': 'string',
'TrainingPlanStatus': 'string',
'OverrideVpcConfig': {
'SecurityGroupIds': [
'string',
],
'Subnets': [
'string',
]
},
'ScheduledUpdateConfig': {
'ScheduleExpression': 'string',
'DeploymentConfig': {
'RollingUpdatePolicy': {
'MaximumBatchSize': {
'Type': 'INSTANCE_COUNT'|'CAPACITY_PERCENTAGE',
'Value': 123
},
'RollbackMaximumBatchSize': {
'Type': 'INSTANCE_COUNT'|'CAPACITY_PERCENTAGE',
'Value': 123
}
},
'WaitIntervalInSeconds': 123,
'AutoRollbackConfiguration': [
{
'AlarmName': 'string'
},
]
}
},
'EnvironmentConfig': {
'FSxLustreConfig': {
'SizeInGiB': 123,
'PerUnitStorageThroughput': 123
},
'S3OutputPath': 'string'
}
},
],
'RestrictedInstanceGroupsConfig': {
'SharedEnvironmentConfig': {
'CurrentFSxLustreConfig': {
'SizeInGiB': 123,
'PerUnitStorageThroughput': 123
},
'DesiredFSxLustreConfig': {
'SizeInGiB': 123,
'PerUnitStorageThroughput': 123
},
'CurrentFSxLustreDeletionPolicy': 'DeleteIfNotUsed'|'Keep',
'DesiredFSxLustreDeletionPolicy': 'DeleteIfNotUsed'|'Keep'
}
},
'VpcConfig': {
'SecurityGroupIds': [
'string',
],
'Subnets': [
'string',
]
},
'Orchestrator': {
'Eks': {
'ClusterArn': 'string'
},
'Slurm': {
'SlurmConfigStrategy': 'Overwrite'|'Managed'|'Merge'
}
},
'TieredStorageConfig': {
'Mode': 'Enable'|'Disable',
'InstanceMemoryAllocationPercentage': 123
},
'NodeRecovery': 'Automatic'|'None',
'NodeProvisioningMode': 'Continuous',
'ClusterRole': 'string',
'AutoScaling': {
'Mode': 'Enable'|'Disable',
'AutoScalerType': 'Karpenter',
'Status': 'InService'|'Failed'|'Creating'|'Deleting',
'FailureMessage': 'string'
}
}
Response Structure
(dict) --
ClusterArn (string) --
The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster.
ClusterName (string) --
The name of the SageMaker HyperPod cluster.
ClusterStatus (string) --
The status of the SageMaker HyperPod cluster.
CreationTime (datetime) --
The time when the SageMaker Cluster is created.
FailureMessage (string) --
The failure message of the SageMaker HyperPod cluster.
InstanceGroups (list) --
The instance groups of the SageMaker HyperPod cluster.
(dict) --
Details of an instance group in a SageMaker HyperPod cluster.
CurrentCount (integer) --
The number of instances that are currently in the instance group of a SageMaker HyperPod cluster.
TargetCount (integer) --
The number of instances you specified to add to the instance group of a SageMaker HyperPod cluster.
MinCount (integer) --
The minimum number of instances that must be available in the instance group of a SageMaker HyperPod cluster before it transitions to InService status.
InstanceGroupName (string) --
The name of the instance group of a SageMaker HyperPod cluster.
InstanceType (string) --
The instance type of the instance group of a SageMaker HyperPod cluster.
InstanceRequirements (dict) --
The instance requirements for the instance group, including the current and desired instance types. This field is present for flexible instance groups that support multiple instance types.
CurrentInstanceTypes (list) --
The instance types currently in use by the instance group.
(string) --
DesiredInstanceTypes (list) --
The desired instance types for the instance group, as specified in the most recent update request.
(string) --
InstanceTypeDetails (list) --
Details about the instance types in the instance group, including the count and configuration of each instance type. This field is present for flexible instance groups that support multiple instance types.
(dict) --
Details about a specific instance type within a flexible instance group, including the count and configuration.
InstanceType (string) --
The instance type.
CurrentCount (integer) --
The number of instances of this type currently running in the instance group.
ThreadsPerCore (integer) --
The number of threads per CPU core for this instance type.
LifeCycleConfig (dict) --
Details of LifeCycle configuration for the instance group.
SourceS3Uri (string) --
An Amazon S3 bucket path where your lifecycle scripts are stored.
OnCreate (string) --
The file name of the entrypoint script of lifecycle scripts under SourceS3Uri. This entrypoint script runs during cluster creation.
OnInitComplete (string) --
The file name of the entrypoint script of lifecycle scripts under SourceS3Uri. This script runs on the node after the AMI-based initialization is complete.
ExecutionRole (string) --
The execution role for the instance group to assume.
ThreadsPerCore (integer) --
The number you specified to TreadsPerCore in CreateCluster for enabling or disabling multithreading. For instance types that support multithreading, you can specify 1 for disabling multithreading and 2 for enabling multithreading. For more information, see the reference table of CPU cores and threads per CPU core per instance type in the Amazon Elastic Compute Cloud User Guide.
InstanceStorageConfigs (list) --
The additional storage configurations for the instances in the SageMaker HyperPod cluster instance group.
(dict) --
Defines the configuration for attaching additional storage to the instances in the SageMaker HyperPod cluster instance group. To learn more, see SageMaker HyperPod release notes: June 20, 2024.
EbsVolumeConfig (dict) --
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 /opt/sagemaker.
VolumeSizeInGB (integer) --
The size in gigabytes (GB) of the additional EBS volume to be attached 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 /opt/sagemaker.
VolumeKmsKeyId (string) --
The ID of a KMS key to encrypt the Amazon EBS volume.
RootVolume (boolean) --
Specifies whether the configuration is for the cluster's root or secondary Amazon EBS volume. You can specify two ClusterEbsVolumeConfig fields to configure both the root and secondary volumes. Set the value to True if you'd like to provide your own customer managed Amazon Web Services KMS key to encrypt the root volume. When True:
The configuration is applied to the root volume.
You can't specify the VolumeSizeInGB field. The size of the root volume is determined for you.
You must specify a KMS key ID for VolumeKmsKeyId to encrypt the root volume with your own KMS key instead of an Amazon Web Services owned KMS key.
Otherwise, by default, the value is False, and the following applies:
The configuration is applied to the secondary volume, while the root volume is encrypted with an Amazon Web Services owned key.
You must specify the VolumeSizeInGB field.
You can optionally specify the VolumeKmsKeyId to encrypt the secondary volume with your own KMS key instead of an Amazon Web Services owned KMS key.
FsxLustreConfig (dict) --
Defines the configuration for attaching an Amazon FSx for Lustre file system to the instances in the SageMaker HyperPod cluster instance group.
DnsName (string) --
The DNS name of the Amazon FSx for Lustre file system.
MountName (string) --
The mount name of the Amazon FSx for Lustre file system.
MountPath (string) --
The local path where the Amazon FSx for Lustre file system is mounted on instances.
FsxOpenZfsConfig (dict) --
Defines the configuration for attaching an Amazon FSx for OpenZFS file system to the instances in the SageMaker HyperPod cluster instance group.
DnsName (string) --
The DNS name of the Amazon FSx for OpenZFS file system.
MountPath (string) --
The local path where the Amazon FSx for OpenZFS file system is mounted on instances.
OnStartDeepHealthChecks (list) --
A flag indicating whether deep health checks should be performed when the cluster instance group is created or updated.
(string) --
Status (string) --
The current status of the cluster instance group.
InService: The instance group is active and healthy.
Creating: The instance group is being provisioned.
Updating: The instance group is being updated.
Failed: The instance group has failed to provision or is no longer healthy.
Degraded: The instance group is degraded, meaning that some instances have failed to provision or are no longer healthy.
Deleting: The instance group is being deleted.
TrainingPlanArn (string) --
The Amazon Resource Name (ARN); of the training plan associated with this cluster instance group.
For more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see ``CreateTrainingPlan ``.
TrainingPlanStatus (string) --
The current status of the training plan associated with this cluster instance group.
OverrideVpcConfig (dict) --
The customized Amazon VPC configuration at the instance group level that overrides the default Amazon VPC configuration of the SageMaker HyperPod cluster.
SecurityGroupIds (list) --
The VPC security group IDs, in the form sg-xxxxxxxx. Specify the security groups for the VPC that is specified in the Subnets field.
(string) --
Subnets (list) --
The ID of the subnets in the VPC to which you want to connect your training job or model. For information about the availability of specific instance types, see Supported Instance Types and Availability Zones.
(string) --
ScheduledUpdateConfig (dict) --
The configuration object of the schedule that SageMaker follows when updating the AMI.
ScheduleExpression (string) --
A cron expression that specifies the schedule that SageMaker follows when updating the AMI.
DeploymentConfig (dict) --
The configuration to use when updating the AMI versions.
RollingUpdatePolicy (dict) --
The policy that SageMaker uses when updating the AMI versions of the cluster.
MaximumBatchSize (dict) --
The maximum amount of instances in the cluster that SageMaker can update at a time.
Type (string) --
Specifies whether SageMaker should process the update by amount or percentage of instances.
Value (integer) --
Specifies the amount or percentage of instances SageMaker updates at a time.
RollbackMaximumBatchSize (dict) --
The maximum amount of instances in the cluster that SageMaker can roll back at a time.
Type (string) --
Specifies whether SageMaker should process the update by amount or percentage of instances.
Value (integer) --
Specifies the amount or percentage of instances SageMaker updates at a time.
WaitIntervalInSeconds (integer) --
The duration in seconds that SageMaker waits before updating more instances in the cluster.
AutoRollbackConfiguration (list) --
An array that contains the alarms that SageMaker monitors to know whether to roll back the AMI update.
(dict) --
The details of the alarm to monitor during the AMI update.
AlarmName (string) --
The name of the alarm.
CurrentImageId (string) --
The ID of the Amazon Machine Image (AMI) currently in use by the instance group.
DesiredImageId (string) --
The ID of the Amazon Machine Image (AMI) desired for the instance group.
ImageVersionStatus (string) --
The status of the image version for the instance group. Indicates whether the instance group is running the latest image version or if an update is available.
ActiveOperations (dict) --
A map indicating active operations currently in progress for the instance group of a SageMaker HyperPod cluster. When there is a scaling operation in progress, this map contains a key Scaling with value 1.
(string) --
(integer) --
KubernetesConfig (dict) --
The Kubernetes configuration for the instance group that contains labels and taints to be applied for the nodes in this instance group.
CurrentLabels (dict) --
The current labels applied to cluster nodes of an instance group.
(string) --
(string) --
DesiredLabels (dict) --
The desired labels to be applied to cluster nodes of an instance group.
(string) --
(string) --
CurrentTaints (list) --
The current taints applied to cluster nodes of an instance group.
(dict) --
A Kubernetes taint that can be applied to cluster nodes.
Key (string) --
The key of the taint.
Value (string) --
The value of the taint.
Effect (string) --
The effect of the taint. Valid values are NoSchedule, PreferNoSchedule, and NoExecute.
DesiredTaints (list) --
The desired taints to be applied to cluster nodes of an instance group.
(dict) --
A Kubernetes taint that can be applied to cluster nodes.
Key (string) --
The key of the taint.
Value (string) --
The value of the taint.
Effect (string) --
The effect of the taint. Valid values are NoSchedule, PreferNoSchedule, and NoExecute.
CapacityRequirements (dict) --
The instance capacity requirements for the instance group.
Spot (dict) --
Configuration options specific to Spot instances.
OnDemand (dict) --
Configuration options specific to On-Demand instances.
TargetStateCount (integer) --
Represents the number of running nodes using the desired Image ID.
During software update operations: This count shows the number of nodes running on the desired Image ID. If a rollback occurs, the current image ID and desired image ID (both included in the describe cluster response) swap values. The TargetStateCount then shows the number of nodes running on the newly designated desired image ID (which was previously the current image ID).
During simultaneous scaling and software update operations: This count shows the number of instances running on the desired image ID, including any new instances created as part of the scaling request. New nodes are always created using the desired image ID, so TargetStateCount reflects the total count of nodes running on the desired image ID, even during rollback scenarios.
SoftwareUpdateStatus (string) --
Status of the last software udpate request.
Status transitions follow these possible sequences:
Pending -> InProgress -> Succeeded
Pending -> InProgress -> RollbackInProgress -> RollbackComplete
Pending -> InProgress -> RollbackInProgress -> Failed
ActiveSoftwareUpdateConfig (dict) --
The configuration to use when updating the AMI versions.
RollingUpdatePolicy (dict) --
The policy that SageMaker uses when updating the AMI versions of the cluster.
MaximumBatchSize (dict) --
The maximum amount of instances in the cluster that SageMaker can update at a time.
Type (string) --
Specifies whether SageMaker should process the update by amount or percentage of instances.
Value (integer) --
Specifies the amount or percentage of instances SageMaker updates at a time.
RollbackMaximumBatchSize (dict) --
The maximum amount of instances in the cluster that SageMaker can roll back at a time.
Type (string) --
Specifies whether SageMaker should process the update by amount or percentage of instances.
Value (integer) --
Specifies the amount or percentage of instances SageMaker updates at a time.
WaitIntervalInSeconds (integer) --
The duration in seconds that SageMaker waits before updating more instances in the cluster.
AutoRollbackConfiguration (list) --
An array that contains the alarms that SageMaker monitors to know whether to roll back the AMI update.
(dict) --
The details of the alarm to monitor during the AMI update.
AlarmName (string) --
The name of the alarm.
SlurmConfig (dict) --
The Slurm configuration for the instance group.
NodeType (string) --
The type of Slurm node for the instance group. Valid values are Controller, Worker, and Login.
PartitionNames (list) --
The list of Slurm partition names that the instance group belongs to.
(string) --
NetworkInterface (dict) --
The network interface configuration for the instance group.
InterfaceType (string) --
The type of network interface for the instance group. Valid values are efa and efa-only.
RestrictedInstanceGroups (list) --
The specialized instance groups for training models like Amazon Nova to be created in the SageMaker HyperPod cluster.
(dict) --
The instance group details of the restricted instance group (RIG).
CurrentCount (integer) --
The number of instances that are currently in the restricted instance group of a SageMaker HyperPod cluster.
TargetCount (integer) --
The number of instances you specified to add to the restricted instance group of a SageMaker HyperPod cluster.
InstanceGroupName (string) --
The name of the restricted instance group of a SageMaker HyperPod cluster.
InstanceType (string) --
The instance type of the restricted instance group of a SageMaker HyperPod cluster.
ExecutionRole (string) --
The execution role for the restricted instance group to assume.
ThreadsPerCore (integer) --
The number you specified to TreadsPerCore in CreateCluster for enabling or disabling multithreading. For instance types that support multithreading, you can specify 1 for disabling multithreading and 2 for enabling multithreading. For more information, see the reference table of CPU cores and threads per CPU core per instance type in the Amazon Elastic Compute Cloud User Guide.
InstanceStorageConfigs (list) --
The additional storage configurations for the instances in the SageMaker HyperPod cluster restricted instance group.
(dict) --
Defines the configuration for attaching additional storage to the instances in the SageMaker HyperPod cluster instance group. To learn more, see SageMaker HyperPod release notes: June 20, 2024.
EbsVolumeConfig (dict) --
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 /opt/sagemaker.
VolumeSizeInGB (integer) --
The size in gigabytes (GB) of the additional EBS volume to be attached 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 /opt/sagemaker.
VolumeKmsKeyId (string) --
The ID of a KMS key to encrypt the Amazon EBS volume.
RootVolume (boolean) --
Specifies whether the configuration is for the cluster's root or secondary Amazon EBS volume. You can specify two ClusterEbsVolumeConfig fields to configure both the root and secondary volumes. Set the value to True if you'd like to provide your own customer managed Amazon Web Services KMS key to encrypt the root volume. When True:
The configuration is applied to the root volume.
You can't specify the VolumeSizeInGB field. The size of the root volume is determined for you.
You must specify a KMS key ID for VolumeKmsKeyId to encrypt the root volume with your own KMS key instead of an Amazon Web Services owned KMS key.
Otherwise, by default, the value is False, and the following applies:
The configuration is applied to the secondary volume, while the root volume is encrypted with an Amazon Web Services owned key.
You must specify the VolumeSizeInGB field.
You can optionally specify the VolumeKmsKeyId to encrypt the secondary volume with your own KMS key instead of an Amazon Web Services owned KMS key.
FsxLustreConfig (dict) --
Defines the configuration for attaching an Amazon FSx for Lustre file system to the instances in the SageMaker HyperPod cluster instance group.
DnsName (string) --
The DNS name of the Amazon FSx for Lustre file system.
MountName (string) --
The mount name of the Amazon FSx for Lustre file system.
MountPath (string) --
The local path where the Amazon FSx for Lustre file system is mounted on instances.
FsxOpenZfsConfig (dict) --
Defines the configuration for attaching an Amazon FSx for OpenZFS file system to the instances in the SageMaker HyperPod cluster instance group.
DnsName (string) --
The DNS name of the Amazon FSx for OpenZFS file system.
MountPath (string) --
The local path where the Amazon FSx for OpenZFS file system is mounted on instances.
OnStartDeepHealthChecks (list) --
A flag indicating whether deep health checks should be performed when the cluster's restricted instance group is created or updated.
(string) --
Status (string) --
The current status of the cluster's restricted instance group.
InService: The restricted instance group is active and healthy.
Creating: The restricted instance group is being provisioned.
Updating: The restricted instance group is being updated.
Failed: The restricted instance group has failed to provision or is no longer healthy.
Degraded: The restricted instance group is degraded, meaning that some instances have failed to provision or are no longer healthy.
Deleting: The restricted instance group is being deleted.
TrainingPlanArn (string) --
The Amazon Resource Name (ARN) of the training plan to filter clusters by. For more information about reserving GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see ``CreateTrainingPlan ``.
TrainingPlanStatus (string) --
The current status of the training plan associated with this cluster restricted instance group.
OverrideVpcConfig (dict) --
Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources have access to. You can control access to and from your resources by configuring a VPC. For more information, see Give SageMaker Access to Resources in your Amazon VPC.
SecurityGroupIds (list) --
The VPC security group IDs, in the form sg-xxxxxxxx. Specify the security groups for the VPC that is specified in the Subnets field.
(string) --
Subnets (list) --
The ID of the subnets in the VPC to which you want to connect your training job or model. For information about the availability of specific instance types, see Supported Instance Types and Availability Zones.
(string) --
ScheduledUpdateConfig (dict) --
The configuration object of the schedule that SageMaker follows when updating the AMI.
ScheduleExpression (string) --
A cron expression that specifies the schedule that SageMaker follows when updating the AMI.
DeploymentConfig (dict) --
The configuration to use when updating the AMI versions.
RollingUpdatePolicy (dict) --
The policy that SageMaker uses when updating the AMI versions of the cluster.
MaximumBatchSize (dict) --
The maximum amount of instances in the cluster that SageMaker can update at a time.
Type (string) --
Specifies whether SageMaker should process the update by amount or percentage of instances.
Value (integer) --
Specifies the amount or percentage of instances SageMaker updates at a time.
RollbackMaximumBatchSize (dict) --
The maximum amount of instances in the cluster that SageMaker can roll back at a time.
Type (string) --
Specifies whether SageMaker should process the update by amount or percentage of instances.
Value (integer) --
Specifies the amount or percentage of instances SageMaker updates at a time.
WaitIntervalInSeconds (integer) --
The duration in seconds that SageMaker waits before updating more instances in the cluster.
AutoRollbackConfiguration (list) --
An array that contains the alarms that SageMaker monitors to know whether to roll back the AMI update.
(dict) --
The details of the alarm to monitor during the AMI update.
AlarmName (string) --
The name of the alarm.
EnvironmentConfig (dict) --
The configuration for the restricted instance groups (RIG) environment.
FSxLustreConfig (dict) --
Configuration settings for an Amazon FSx for Lustre file system to be used with the cluster.
SizeInGiB (integer) --
The storage capacity of the Amazon FSx for Lustre file system, specified in gibibytes (GiB).
PerUnitStorageThroughput (integer) --
The throughput capacity of the Amazon FSx for Lustre file system, measured in MB/s per TiB of storage.
S3OutputPath (string) --
The Amazon S3 path where output data from the restricted instance group (RIG) environment will be stored.
RestrictedInstanceGroupsConfig (dict) --
The configuration for the restricted instance groups (RIG) in the SageMaker HyperPod cluster.
SharedEnvironmentConfig (dict) --
The shared environment configuration details for the restricted instance groups (RIG).
CurrentFSxLustreConfig (dict) --
The current Amazon FSx for Lustre file system configuration in the shared environment.
SizeInGiB (integer) --
The storage capacity of the Amazon FSx for Lustre file system, specified in gibibytes (GiB).
PerUnitStorageThroughput (integer) --
The throughput capacity of the Amazon FSx for Lustre file system, measured in MB/s per TiB of storage.
DesiredFSxLustreConfig (dict) --
The desired Amazon FSx for Lustre file system configuration in the shared environment.
SizeInGiB (integer) --
The storage capacity of the Amazon FSx for Lustre file system, specified in gibibytes (GiB).
PerUnitStorageThroughput (integer) --
The throughput capacity of the Amazon FSx for Lustre file system, measured in MB/s per TiB of storage.
CurrentFSxLustreDeletionPolicy (string) --
The current deletion policy for the Amazon FSx for Lustre file system in the shared environment.
DesiredFSxLustreDeletionPolicy (string) --
The desired deletion policy for the Amazon FSx for Lustre file system in the shared environment.
VpcConfig (dict) --
Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources have access to. You can control access to and from your resources by configuring a VPC. For more information, see Give SageMaker Access to Resources in your Amazon VPC.
SecurityGroupIds (list) --
The VPC security group IDs, in the form sg-xxxxxxxx. Specify the security groups for the VPC that is specified in the Subnets field.
(string) --
Subnets (list) --
The ID of the subnets in the VPC to which you want to connect your training job or model. For information about the availability of specific instance types, see Supported Instance Types and Availability Zones.
(string) --
Orchestrator (dict) --
The type of orchestrator used for the SageMaker HyperPod cluster.
Eks (dict) --
The Amazon EKS cluster used as the orchestrator for the SageMaker HyperPod cluster.
ClusterArn (string) --
The Amazon Resource Name (ARN) of the Amazon EKS cluster associated with the SageMaker HyperPod cluster.
Slurm (dict) --
The Slurm orchestrator configuration for the SageMaker HyperPod cluster.
SlurmConfigStrategy (string) --
The strategy for managing partitions for the Slurm configuration. Valid values are Managed, Overwrite, and Merge.
TieredStorageConfig (dict) --
The current configuration for managed tier checkpointing on the HyperPod cluster. For example, this shows whether the feature is enabled and the percentage of cluster memory allocated for checkpoint storage.
Mode (string) --
Specifies whether managed tier checkpointing is enabled or disabled for the HyperPod cluster. When set to Enable, the system installs a memory management daemon that provides disaggregated memory as a service for checkpoint storage. When set to Disable, the feature is turned off and the memory management daemon is removed from the cluster.
InstanceMemoryAllocationPercentage (integer) --
The percentage (int) of cluster memory to allocate for checkpointing.
NodeRecovery (string) --
The node recovery mode configured for the SageMaker HyperPod cluster.
NodeProvisioningMode (string) --
The mode used for provisioning nodes in the cluster.
ClusterRole (string) --
The Amazon Resource Name (ARN) of the IAM role that HyperPod uses for cluster autoscaling operations.
AutoScaling (dict) --
The current autoscaling configuration and status for the autoscaler.
Mode (string) --
Describes whether autoscaling is enabled or disabled for the cluster.
AutoScalerType (string) --
The type of autoscaler configured for the cluster.
Status (string) --
The current status of the autoscaling configuration. Valid values are InService, Failed, Creating, and Deleting.
FailureMessage (string) --
If the autoscaling status is Failed, this field contains a message describing the failure.
{'ReservedCapacitySummaries': {'AvailabilityZoneId': 'string'}}
Retrieves detailed information about a specific training plan.
See also: AWS API Documentation
Request Syntax
client.describe_training_plan(
TrainingPlanName='string'
)
string
[REQUIRED]
The name of the training plan to describe.
dict
Response Syntax
{
'TrainingPlanArn': 'string',
'TrainingPlanName': 'string',
'Status': 'Pending'|'Active'|'Scheduled'|'Expired'|'Failed',
'StatusMessage': 'string',
'DurationHours': 123,
'DurationMinutes': 123,
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'UpfrontFee': 'string',
'CurrencyCode': 'string',
'TotalInstanceCount': 123,
'AvailableInstanceCount': 123,
'InUseInstanceCount': 123,
'UnhealthyInstanceCount': 123,
'AvailableSpareInstanceCount': 123,
'TotalUltraServerCount': 123,
'TargetResources': [
'training-job'|'hyperpod-cluster'|'endpoint'|'studio-apps',
],
'ReservedCapacitySummaries': [
{
'ReservedCapacityArn': 'string',
'ReservedCapacityType': 'UltraServer'|'Instance',
'UltraServerType': 'string',
'UltraServerCount': 123,
'InstanceType': 'ml.p4d.24xlarge'|'ml.p5.48xlarge'|'ml.p5e.48xlarge'|'ml.p5en.48xlarge'|'ml.trn1.32xlarge'|'ml.trn2.48xlarge'|'ml.p6-b200.48xlarge'|'ml.p4de.24xlarge'|'ml.p6e-gb200.36xlarge'|'ml.p5.4xlarge'|'ml.p6-b300.48xlarge',
'TotalInstanceCount': 123,
'Status': 'Pending'|'Active'|'Scheduled'|'Expired'|'Failed',
'AvailabilityZone': 'string',
'AvailabilityZoneId': 'string',
'DurationHours': 123,
'DurationMinutes': 123,
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1)
},
]
}
Response Structure
(dict) --
TrainingPlanArn (string) --
The Amazon Resource Name (ARN); of the training plan.
TrainingPlanName (string) --
The name of the training plan.
Status (string) --
The current status of the training plan (e.g., Pending, Active, Expired). To see the complete list of status values available for a training plan, refer to the Status attribute within the TrainingPlanSummary object.
StatusMessage (string) --
A message providing additional information about the current status of the training plan.
DurationHours (integer) --
The number of whole hours in the total duration for this training plan.
DurationMinutes (integer) --
The additional minutes beyond whole hours in the total duration for this training plan.
StartTime (datetime) --
The start time of the training plan.
EndTime (datetime) --
The end time of the training plan.
UpfrontFee (string) --
The upfront fee for the training plan.
CurrencyCode (string) --
The currency code for the upfront fee (e.g., USD).
TotalInstanceCount (integer) --
The total number of instances reserved in this training plan.
AvailableInstanceCount (integer) --
The number of instances currently available for use in this training plan.
InUseInstanceCount (integer) --
The number of instances currently in use from this training plan.
UnhealthyInstanceCount (integer) --
The number of instances in the training plan that are currently in an unhealthy state.
AvailableSpareInstanceCount (integer) --
The number of available spare instances in the training plan.
TotalUltraServerCount (integer) --
The total number of UltraServers reserved to this training plan.
TargetResources (list) --
The target resources (e.g., SageMaker Training Jobs, SageMaker HyperPod, SageMaker Endpoints, Studio apps) that can use this training plan.
Training plans are specific to their target resource.
A training plan designed for SageMaker training jobs can only be used to schedule and run training jobs.
A training plan for HyperPod clusters can be used exclusively to provide compute resources to a cluster's instance group.
A training plan for SageMaker endpoints can be used exclusively to provide compute resources to SageMaker endpoints for model deployment.
A training plan for Studio apps can be used to launch JupyterLab and Code Editor apps on reserved training plan capacity.
(string) --
ReservedCapacitySummaries (list) --
The list of Reserved Capacity providing the underlying compute resources of the plan.
(dict) --
Details of a reserved capacity for the training plan.
For more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see ``CreateTrainingPlan ``.
ReservedCapacityArn (string) --
The Amazon Resource Name (ARN); of the reserved capacity.
ReservedCapacityType (string) --
The type of reserved capacity.
UltraServerType (string) --
The type of UltraServer included in this reserved capacity, such as ml.u-p6e-gb200x72.
UltraServerCount (integer) --
The number of UltraServers included in this reserved capacity.
InstanceType (string) --
The instance type for the reserved capacity.
TotalInstanceCount (integer) --
The total number of instances in the reserved capacity.
Status (string) --
The current status of the reserved capacity.
AvailabilityZone (string) --
The availability zone for the reserved capacity.
AvailabilityZoneId (string) --
The Availability Zone ID of the reserved capacity.
DurationHours (integer) --
The number of whole hours in the total duration for this reserved capacity.
DurationMinutes (integer) --
The additional minutes beyond whole hours in the total duration for this reserved capacity.
StartTime (datetime) --
The start time of the reserved capacity.
EndTime (datetime) --
The end time of the reserved capacity.
{'TrainingPlanSummaries': {'ReservedCapacitySummaries': {'AvailabilityZoneId': 'string'}}}
Retrieves a list of training plans for the current account.
See also: AWS API Documentation
Request Syntax
client.list_training_plans(
NextToken='string',
MaxResults=123,
StartTimeAfter=datetime(2015, 1, 1),
StartTimeBefore=datetime(2015, 1, 1),
SortBy='TrainingPlanName'|'StartTime'|'Status',
SortOrder='Ascending'|'Descending',
Filters=[
{
'Name': 'Status',
'Value': 'string'
},
]
)
string
A token to continue pagination if more results are available.
integer
The maximum number of results to return in the response.
datetime
Filter to list only training plans with an actual start time after this date.
datetime
Filter to list only training plans with an actual start time before this date.
string
The training plan field to sort the results by (e.g., StartTime, Status).
string
The order to sort the results (Ascending or Descending).
list
Additional filters to apply to the list of training plans.
(dict) --
A filter to apply when listing or searching for training plans.
For more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see ``CreateTrainingPlan ``.
Name (string) -- [REQUIRED]
The name of the filter field (e.g., Status, InstanceType).
Value (string) -- [REQUIRED]
The value to filter by for the specified field.
dict
Response Syntax
{
'NextToken': 'string',
'TrainingPlanSummaries': [
{
'TrainingPlanArn': 'string',
'TrainingPlanName': 'string',
'Status': 'Pending'|'Active'|'Scheduled'|'Expired'|'Failed',
'StatusMessage': 'string',
'DurationHours': 123,
'DurationMinutes': 123,
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'UpfrontFee': 'string',
'CurrencyCode': 'string',
'TotalInstanceCount': 123,
'AvailableInstanceCount': 123,
'InUseInstanceCount': 123,
'TotalUltraServerCount': 123,
'TargetResources': [
'training-job'|'hyperpod-cluster'|'endpoint'|'studio-apps',
],
'ReservedCapacitySummaries': [
{
'ReservedCapacityArn': 'string',
'ReservedCapacityType': 'UltraServer'|'Instance',
'UltraServerType': 'string',
'UltraServerCount': 123,
'InstanceType': 'ml.p4d.24xlarge'|'ml.p5.48xlarge'|'ml.p5e.48xlarge'|'ml.p5en.48xlarge'|'ml.trn1.32xlarge'|'ml.trn2.48xlarge'|'ml.p6-b200.48xlarge'|'ml.p4de.24xlarge'|'ml.p6e-gb200.36xlarge'|'ml.p5.4xlarge'|'ml.p6-b300.48xlarge',
'TotalInstanceCount': 123,
'Status': 'Pending'|'Active'|'Scheduled'|'Expired'|'Failed',
'AvailabilityZone': 'string',
'AvailabilityZoneId': 'string',
'DurationHours': 123,
'DurationMinutes': 123,
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1)
},
]
},
]
}
Response Structure
(dict) --
NextToken (string) --
A token to continue pagination if more results are available.
TrainingPlanSummaries (list) --
A list of summary information for the training plans.
(dict) --
Details of the training plan.
For more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see ``CreateTrainingPlan ``.
TrainingPlanArn (string) --
The Amazon Resource Name (ARN); of the training plan.
TrainingPlanName (string) --
The name of the training plan.
Status (string) --
The current status of the training plan (e.g., Pending, Active, Expired). To see the complete list of status values available for a training plan, refer to the Status attribute within the TrainingPlanSummary object.
StatusMessage (string) --
A message providing additional information about the current status of the training plan.
DurationHours (integer) --
The number of whole hours in the total duration for this training plan.
DurationMinutes (integer) --
The additional minutes beyond whole hours in the total duration for this training plan.
StartTime (datetime) --
The start time of the training plan.
EndTime (datetime) --
The end time of the training plan.
UpfrontFee (string) --
The upfront fee for the training plan.
CurrencyCode (string) --
The currency code for the upfront fee (e.g., USD).
TotalInstanceCount (integer) --
The total number of instances reserved in this training plan.
AvailableInstanceCount (integer) --
The number of instances currently available for use in this training plan.
InUseInstanceCount (integer) --
The number of instances currently in use from this training plan.
TotalUltraServerCount (integer) --
The total number of UltraServers allocated to this training plan.
TargetResources (list) --
The target resources (e.g., training jobs, HyperPod clusters, Endpoints, Studio apps) that can use this training plan.
Training plans are specific to their target resource.
A training plan designed for SageMaker training jobs can only be used to schedule and run training jobs.
A training plan for HyperPod clusters can be used exclusively to provide compute resources to a cluster's instance group.
A training plan for SageMaker endpoints can be used exclusively to provide compute resources to SageMaker endpoints for model deployment.
A training plan for Studio apps can be used to launch JupyterLab and Code Editor apps on reserved training plan capacity.
(string) --
ReservedCapacitySummaries (list) --
A list of reserved capacities associated with this training plan, including details such as instance types, counts, and availability zones.
(dict) --
Details of a reserved capacity for the training plan.
For more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see ``CreateTrainingPlan ``.
ReservedCapacityArn (string) --
The Amazon Resource Name (ARN); of the reserved capacity.
ReservedCapacityType (string) --
The type of reserved capacity.
UltraServerType (string) --
The type of UltraServer included in this reserved capacity, such as ml.u-p6e-gb200x72.
UltraServerCount (integer) --
The number of UltraServers included in this reserved capacity.
InstanceType (string) --
The instance type for the reserved capacity.
TotalInstanceCount (integer) --
The total number of instances in the reserved capacity.
Status (string) --
The current status of the reserved capacity.
AvailabilityZone (string) --
The availability zone for the reserved capacity.
AvailabilityZoneId (string) --
The Availability Zone ID of the reserved capacity.
DurationHours (integer) --
The number of whole hours in the total duration for this reserved capacity.
DurationMinutes (integer) --
The additional minutes beyond whole hours in the total duration for this reserved capacity.
StartTime (datetime) --
The start time of the reserved capacity.
EndTime (datetime) --
The end time of the reserved capacity.
{'RestrictedInstanceGroupsConfig': {'SharedEnvironmentConfig': {'FSxLustreConfig': {'PerUnitStorageThroughput': 'integer',
'SizeInGiB': 'integer'},
'FSxLustreDeletionPolicy': 'DeleteIfNotUsed '
'| '
'Keep'}}}
Updates a SageMaker HyperPod cluster.
See also: AWS API Documentation
Request Syntax
client.update_cluster(
ClusterName='string',
InstanceGroups=[
{
'InstanceCount': 123,
'MinInstanceCount': 123,
'InstanceGroupName': 'string',
'InstanceType': 'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.p5.48xlarge'|'ml.p5.4xlarge'|'ml.p6e-gb200.36xlarge'|'ml.trn1.32xlarge'|'ml.trn1n.32xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.12xlarge'|'ml.g5.16xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.c5n.large'|'ml.c5n.2xlarge'|'ml.c5n.4xlarge'|'ml.c5n.9xlarge'|'ml.c5n.18xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.g6.xlarge'|'ml.g6.2xlarge'|'ml.g6.4xlarge'|'ml.g6.8xlarge'|'ml.g6.16xlarge'|'ml.g6.12xlarge'|'ml.g6.24xlarge'|'ml.g6.48xlarge'|'ml.gr6.4xlarge'|'ml.gr6.8xlarge'|'ml.g6e.xlarge'|'ml.g6e.2xlarge'|'ml.g6e.4xlarge'|'ml.g6e.8xlarge'|'ml.g6e.16xlarge'|'ml.g6e.12xlarge'|'ml.g6e.24xlarge'|'ml.g6e.48xlarge'|'ml.p5e.48xlarge'|'ml.p5en.48xlarge'|'ml.p6-b200.48xlarge'|'ml.trn2.3xlarge'|'ml.trn2.48xlarge'|'ml.c6i.large'|'ml.c6i.xlarge'|'ml.c6i.2xlarge'|'ml.c6i.4xlarge'|'ml.c6i.8xlarge'|'ml.c6i.12xlarge'|'ml.c6i.16xlarge'|'ml.c6i.24xlarge'|'ml.c6i.32xlarge'|'ml.m6i.large'|'ml.m6i.xlarge'|'ml.m6i.2xlarge'|'ml.m6i.4xlarge'|'ml.m6i.8xlarge'|'ml.m6i.12xlarge'|'ml.m6i.16xlarge'|'ml.m6i.24xlarge'|'ml.m6i.32xlarge'|'ml.r6i.large'|'ml.r6i.xlarge'|'ml.r6i.2xlarge'|'ml.r6i.4xlarge'|'ml.r6i.8xlarge'|'ml.r6i.12xlarge'|'ml.r6i.16xlarge'|'ml.r6i.24xlarge'|'ml.r6i.32xlarge'|'ml.i3en.large'|'ml.i3en.xlarge'|'ml.i3en.2xlarge'|'ml.i3en.3xlarge'|'ml.i3en.6xlarge'|'ml.i3en.12xlarge'|'ml.i3en.24xlarge'|'ml.m7i.large'|'ml.m7i.xlarge'|'ml.m7i.2xlarge'|'ml.m7i.4xlarge'|'ml.m7i.8xlarge'|'ml.m7i.12xlarge'|'ml.m7i.16xlarge'|'ml.m7i.24xlarge'|'ml.m7i.48xlarge'|'ml.r7i.large'|'ml.r7i.xlarge'|'ml.r7i.2xlarge'|'ml.r7i.4xlarge'|'ml.r7i.8xlarge'|'ml.r7i.12xlarge'|'ml.r7i.16xlarge'|'ml.r7i.24xlarge'|'ml.r7i.48xlarge'|'ml.r5d.16xlarge'|'ml.g7e.2xlarge'|'ml.g7e.4xlarge'|'ml.g7e.8xlarge'|'ml.g7e.12xlarge'|'ml.g7e.24xlarge'|'ml.g7e.48xlarge'|'ml.p6-b300.48xlarge',
'InstanceRequirements': {
'InstanceTypes': [
'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.p5.48xlarge'|'ml.p5.4xlarge'|'ml.p6e-gb200.36xlarge'|'ml.trn1.32xlarge'|'ml.trn1n.32xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.12xlarge'|'ml.g5.16xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.c5n.large'|'ml.c5n.2xlarge'|'ml.c5n.4xlarge'|'ml.c5n.9xlarge'|'ml.c5n.18xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.g6.xlarge'|'ml.g6.2xlarge'|'ml.g6.4xlarge'|'ml.g6.8xlarge'|'ml.g6.16xlarge'|'ml.g6.12xlarge'|'ml.g6.24xlarge'|'ml.g6.48xlarge'|'ml.gr6.4xlarge'|'ml.gr6.8xlarge'|'ml.g6e.xlarge'|'ml.g6e.2xlarge'|'ml.g6e.4xlarge'|'ml.g6e.8xlarge'|'ml.g6e.16xlarge'|'ml.g6e.12xlarge'|'ml.g6e.24xlarge'|'ml.g6e.48xlarge'|'ml.p5e.48xlarge'|'ml.p5en.48xlarge'|'ml.p6-b200.48xlarge'|'ml.trn2.3xlarge'|'ml.trn2.48xlarge'|'ml.c6i.large'|'ml.c6i.xlarge'|'ml.c6i.2xlarge'|'ml.c6i.4xlarge'|'ml.c6i.8xlarge'|'ml.c6i.12xlarge'|'ml.c6i.16xlarge'|'ml.c6i.24xlarge'|'ml.c6i.32xlarge'|'ml.m6i.large'|'ml.m6i.xlarge'|'ml.m6i.2xlarge'|'ml.m6i.4xlarge'|'ml.m6i.8xlarge'|'ml.m6i.12xlarge'|'ml.m6i.16xlarge'|'ml.m6i.24xlarge'|'ml.m6i.32xlarge'|'ml.r6i.large'|'ml.r6i.xlarge'|'ml.r6i.2xlarge'|'ml.r6i.4xlarge'|'ml.r6i.8xlarge'|'ml.r6i.12xlarge'|'ml.r6i.16xlarge'|'ml.r6i.24xlarge'|'ml.r6i.32xlarge'|'ml.i3en.large'|'ml.i3en.xlarge'|'ml.i3en.2xlarge'|'ml.i3en.3xlarge'|'ml.i3en.6xlarge'|'ml.i3en.12xlarge'|'ml.i3en.24xlarge'|'ml.m7i.large'|'ml.m7i.xlarge'|'ml.m7i.2xlarge'|'ml.m7i.4xlarge'|'ml.m7i.8xlarge'|'ml.m7i.12xlarge'|'ml.m7i.16xlarge'|'ml.m7i.24xlarge'|'ml.m7i.48xlarge'|'ml.r7i.large'|'ml.r7i.xlarge'|'ml.r7i.2xlarge'|'ml.r7i.4xlarge'|'ml.r7i.8xlarge'|'ml.r7i.12xlarge'|'ml.r7i.16xlarge'|'ml.r7i.24xlarge'|'ml.r7i.48xlarge'|'ml.r5d.16xlarge'|'ml.g7e.2xlarge'|'ml.g7e.4xlarge'|'ml.g7e.8xlarge'|'ml.g7e.12xlarge'|'ml.g7e.24xlarge'|'ml.g7e.48xlarge'|'ml.p6-b300.48xlarge',
]
},
'LifeCycleConfig': {
'SourceS3Uri': 'string',
'OnCreate': 'string',
'OnInitComplete': 'string'
},
'ExecutionRole': 'string',
'ThreadsPerCore': 123,
'InstanceStorageConfigs': [
{
'EbsVolumeConfig': {
'VolumeSizeInGB': 123,
'VolumeKmsKeyId': 'string',
'RootVolume': True|False
},
'FsxLustreConfig': {
'DnsName': 'string',
'MountName': 'string',
'MountPath': 'string'
},
'FsxOpenZfsConfig': {
'DnsName': 'string',
'MountPath': 'string'
}
},
],
'OnStartDeepHealthChecks': [
'InstanceStress'|'InstanceConnectivity',
],
'TrainingPlanArn': 'string',
'OverrideVpcConfig': {
'SecurityGroupIds': [
'string',
],
'Subnets': [
'string',
]
},
'ScheduledUpdateConfig': {
'ScheduleExpression': 'string',
'DeploymentConfig': {
'RollingUpdatePolicy': {
'MaximumBatchSize': {
'Type': 'INSTANCE_COUNT'|'CAPACITY_PERCENTAGE',
'Value': 123
},
'RollbackMaximumBatchSize': {
'Type': 'INSTANCE_COUNT'|'CAPACITY_PERCENTAGE',
'Value': 123
}
},
'WaitIntervalInSeconds': 123,
'AutoRollbackConfiguration': [
{
'AlarmName': 'string'
},
]
}
},
'ImageId': 'string',
'KubernetesConfig': {
'Labels': {
'string': 'string'
},
'Taints': [
{
'Key': 'string',
'Value': 'string',
'Effect': 'NoSchedule'|'PreferNoSchedule'|'NoExecute'
},
]
},
'SlurmConfig': {
'NodeType': 'Controller'|'Login'|'Compute',
'PartitionNames': [
'string',
]
},
'CapacityRequirements': {
'Spot': {}
,
'OnDemand': {}
},
'NetworkInterface': {
'InterfaceType': 'efa'|'efa-only'
}
},
],
RestrictedInstanceGroups=[
{
'InstanceCount': 123,
'InstanceGroupName': 'string',
'InstanceType': 'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.p5.48xlarge'|'ml.p5.4xlarge'|'ml.p6e-gb200.36xlarge'|'ml.trn1.32xlarge'|'ml.trn1n.32xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.12xlarge'|'ml.g5.16xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.c5n.large'|'ml.c5n.2xlarge'|'ml.c5n.4xlarge'|'ml.c5n.9xlarge'|'ml.c5n.18xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.g6.xlarge'|'ml.g6.2xlarge'|'ml.g6.4xlarge'|'ml.g6.8xlarge'|'ml.g6.16xlarge'|'ml.g6.12xlarge'|'ml.g6.24xlarge'|'ml.g6.48xlarge'|'ml.gr6.4xlarge'|'ml.gr6.8xlarge'|'ml.g6e.xlarge'|'ml.g6e.2xlarge'|'ml.g6e.4xlarge'|'ml.g6e.8xlarge'|'ml.g6e.16xlarge'|'ml.g6e.12xlarge'|'ml.g6e.24xlarge'|'ml.g6e.48xlarge'|'ml.p5e.48xlarge'|'ml.p5en.48xlarge'|'ml.p6-b200.48xlarge'|'ml.trn2.3xlarge'|'ml.trn2.48xlarge'|'ml.c6i.large'|'ml.c6i.xlarge'|'ml.c6i.2xlarge'|'ml.c6i.4xlarge'|'ml.c6i.8xlarge'|'ml.c6i.12xlarge'|'ml.c6i.16xlarge'|'ml.c6i.24xlarge'|'ml.c6i.32xlarge'|'ml.m6i.large'|'ml.m6i.xlarge'|'ml.m6i.2xlarge'|'ml.m6i.4xlarge'|'ml.m6i.8xlarge'|'ml.m6i.12xlarge'|'ml.m6i.16xlarge'|'ml.m6i.24xlarge'|'ml.m6i.32xlarge'|'ml.r6i.large'|'ml.r6i.xlarge'|'ml.r6i.2xlarge'|'ml.r6i.4xlarge'|'ml.r6i.8xlarge'|'ml.r6i.12xlarge'|'ml.r6i.16xlarge'|'ml.r6i.24xlarge'|'ml.r6i.32xlarge'|'ml.i3en.large'|'ml.i3en.xlarge'|'ml.i3en.2xlarge'|'ml.i3en.3xlarge'|'ml.i3en.6xlarge'|'ml.i3en.12xlarge'|'ml.i3en.24xlarge'|'ml.m7i.large'|'ml.m7i.xlarge'|'ml.m7i.2xlarge'|'ml.m7i.4xlarge'|'ml.m7i.8xlarge'|'ml.m7i.12xlarge'|'ml.m7i.16xlarge'|'ml.m7i.24xlarge'|'ml.m7i.48xlarge'|'ml.r7i.large'|'ml.r7i.xlarge'|'ml.r7i.2xlarge'|'ml.r7i.4xlarge'|'ml.r7i.8xlarge'|'ml.r7i.12xlarge'|'ml.r7i.16xlarge'|'ml.r7i.24xlarge'|'ml.r7i.48xlarge'|'ml.r5d.16xlarge'|'ml.g7e.2xlarge'|'ml.g7e.4xlarge'|'ml.g7e.8xlarge'|'ml.g7e.12xlarge'|'ml.g7e.24xlarge'|'ml.g7e.48xlarge'|'ml.p6-b300.48xlarge',
'ExecutionRole': 'string',
'ThreadsPerCore': 123,
'InstanceStorageConfigs': [
{
'EbsVolumeConfig': {
'VolumeSizeInGB': 123,
'VolumeKmsKeyId': 'string',
'RootVolume': True|False
},
'FsxLustreConfig': {
'DnsName': 'string',
'MountName': 'string',
'MountPath': 'string'
},
'FsxOpenZfsConfig': {
'DnsName': 'string',
'MountPath': 'string'
}
},
],
'OnStartDeepHealthChecks': [
'InstanceStress'|'InstanceConnectivity',
],
'TrainingPlanArn': 'string',
'OverrideVpcConfig': {
'SecurityGroupIds': [
'string',
],
'Subnets': [
'string',
]
},
'ScheduledUpdateConfig': {
'ScheduleExpression': 'string',
'DeploymentConfig': {
'RollingUpdatePolicy': {
'MaximumBatchSize': {
'Type': 'INSTANCE_COUNT'|'CAPACITY_PERCENTAGE',
'Value': 123
},
'RollbackMaximumBatchSize': {
'Type': 'INSTANCE_COUNT'|'CAPACITY_PERCENTAGE',
'Value': 123
}
},
'WaitIntervalInSeconds': 123,
'AutoRollbackConfiguration': [
{
'AlarmName': 'string'
},
]
}
},
'EnvironmentConfig': {
'FSxLustreConfig': {
'SizeInGiB': 123,
'PerUnitStorageThroughput': 123
}
}
},
],
RestrictedInstanceGroupsConfig={
'SharedEnvironmentConfig': {
'FSxLustreDeletionPolicy': 'DeleteIfNotUsed'|'Keep',
'FSxLustreConfig': {
'SizeInGiB': 123,
'PerUnitStorageThroughput': 123
}
}
},
TieredStorageConfig={
'Mode': 'Enable'|'Disable',
'InstanceMemoryAllocationPercentage': 123
},
NodeRecovery='Automatic'|'None',
InstanceGroupsToDelete=[
'string',
],
NodeProvisioningMode='Continuous',
ClusterRole='string',
AutoScaling={
'Mode': 'Enable'|'Disable',
'AutoScalerType': 'Karpenter'
},
Orchestrator={
'Eks': {
'ClusterArn': 'string'
},
'Slurm': {
'SlurmConfigStrategy': 'Overwrite'|'Managed'|'Merge'
}
}
)
string
[REQUIRED]
Specify the name of the SageMaker HyperPod cluster you want to update.
list
Specify the instance groups to update.
(dict) --
The specifications of an instance group that you need to define.
InstanceCount (integer) -- [REQUIRED]
Specifies the number of instances to add to the instance group of a SageMaker HyperPod cluster.
MinInstanceCount (integer) --
Defines the minimum number of instances required for an instance group to become InService. If this threshold isn't met within 3 hours, the instance group rolls back to its previous state - zero instances for new instance groups, or previous settings for existing instance groups. MinInstanceCount only affects the initial transition to InService and does not guarantee maintaining this minimum afterward.
InstanceGroupName (string) -- [REQUIRED]
Specifies the name of the instance group.
InstanceType (string) --
Specifies the instance type of the instance group.
InstanceRequirements (dict) --
The instance requirements for the instance group, including the instance types to use. Use this to create a flexible instance group that supports multiple instance types. The InstanceType and InstanceRequirements properties are mutually exclusive.
InstanceTypes (list) -- [REQUIRED]
The list of instance types that the instance group can use. The order of instance types determines the priority—HyperPod attempts to provision instances using the first instance type in the list and falls back to subsequent types if capacity is unavailable.
(string) --
LifeCycleConfig (dict) --
Specifies the LifeCycle configuration for the instance group.
SourceS3Uri (string) --
An Amazon S3 bucket path where your lifecycle scripts are stored.
OnCreate (string) --
The file name of the entrypoint script of lifecycle scripts under SourceS3Uri. This entrypoint script runs during cluster creation.
OnInitComplete (string) --
The file name of the entrypoint script of lifecycle scripts under SourceS3Uri. This script runs on the node after the AMI-based initialization is complete.
ExecutionRole (string) -- [REQUIRED]
Specifies an IAM execution role to be assumed by the instance group.
ThreadsPerCore (integer) --
Specifies the value for Threads per core. For instance types that support multithreading, you can specify 1 for disabling multithreading and 2 for enabling multithreading. For instance types that doesn't support multithreading, specify 1. For more information, see the reference table of CPU cores and threads per CPU core per instance type in the Amazon Elastic Compute Cloud User Guide.
InstanceStorageConfigs (list) --
Specifies the additional storage configurations for the instances in the SageMaker HyperPod cluster instance group.
(dict) --
Defines the configuration for attaching additional storage to the instances in the SageMaker HyperPod cluster instance group. To learn more, see SageMaker HyperPod release notes: June 20, 2024.
EbsVolumeConfig (dict) --
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 /opt/sagemaker.
VolumeSizeInGB (integer) --
The size in gigabytes (GB) of the additional EBS volume to be attached 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 /opt/sagemaker.
VolumeKmsKeyId (string) --
The ID of a KMS key to encrypt the Amazon EBS volume.
RootVolume (boolean) --
Specifies whether the configuration is for the cluster's root or secondary Amazon EBS volume. You can specify two ClusterEbsVolumeConfig fields to configure both the root and secondary volumes. Set the value to True if you'd like to provide your own customer managed Amazon Web Services KMS key to encrypt the root volume. When True:
The configuration is applied to the root volume.
You can't specify the VolumeSizeInGB field. The size of the root volume is determined for you.
You must specify a KMS key ID for VolumeKmsKeyId to encrypt the root volume with your own KMS key instead of an Amazon Web Services owned KMS key.
Otherwise, by default, the value is False, and the following applies:
The configuration is applied to the secondary volume, while the root volume is encrypted with an Amazon Web Services owned key.
You must specify the VolumeSizeInGB field.
You can optionally specify the VolumeKmsKeyId to encrypt the secondary volume with your own KMS key instead of an Amazon Web Services owned KMS key.
FsxLustreConfig (dict) --
Defines the configuration for attaching an Amazon FSx for Lustre file system to the instances in the SageMaker HyperPod cluster instance group.
DnsName (string) -- [REQUIRED]
The DNS name of the Amazon FSx for Lustre file system.
MountName (string) -- [REQUIRED]
The mount name of the Amazon FSx for Lustre file system.
MountPath (string) --
The local path where the Amazon FSx for Lustre file system is mounted on instances.
FsxOpenZfsConfig (dict) --
Defines the configuration for attaching an Amazon FSx for OpenZFS file system to the instances in the SageMaker HyperPod cluster instance group.
DnsName (string) -- [REQUIRED]
The DNS name of the Amazon FSx for OpenZFS file system.
MountPath (string) --
The local path where the Amazon FSx for OpenZFS file system is mounted on instances.
OnStartDeepHealthChecks (list) --
A flag indicating whether deep health checks should be performed when the cluster instance group is created or updated.
(string) --
TrainingPlanArn (string) --
The Amazon Resource Name (ARN); of the training plan to use for this cluster instance group.
For more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see ``CreateTrainingPlan ``.
OverrideVpcConfig (dict) --
To configure multi-AZ deployments, customize the Amazon VPC configuration at the instance group level. You can specify different subnets and security groups across different AZs in the instance group specification to override a SageMaker HyperPod cluster's default Amazon VPC configuration. For more information about deploying a cluster in multiple AZs, see Setting up SageMaker HyperPod clusters across multiple AZs.
SecurityGroupIds (list) -- [REQUIRED]
The VPC security group IDs, in the form sg-xxxxxxxx. Specify the security groups for the VPC that is specified in the Subnets field.
(string) --
Subnets (list) -- [REQUIRED]
The ID of the subnets in the VPC to which you want to connect your training job or model. For information about the availability of specific instance types, see Supported Instance Types and Availability Zones.
(string) --
ScheduledUpdateConfig (dict) --
The configuration object of the schedule that SageMaker uses to update the AMI.
ScheduleExpression (string) -- [REQUIRED]
A cron expression that specifies the schedule that SageMaker follows when updating the AMI.
DeploymentConfig (dict) --
The configuration to use when updating the AMI versions.
RollingUpdatePolicy (dict) --
The policy that SageMaker uses when updating the AMI versions of the cluster.
MaximumBatchSize (dict) -- [REQUIRED]
The maximum amount of instances in the cluster that SageMaker can update at a time.
Type (string) -- [REQUIRED]
Specifies whether SageMaker should process the update by amount or percentage of instances.
Value (integer) -- [REQUIRED]
Specifies the amount or percentage of instances SageMaker updates at a time.
RollbackMaximumBatchSize (dict) --
The maximum amount of instances in the cluster that SageMaker can roll back at a time.
Type (string) -- [REQUIRED]
Specifies whether SageMaker should process the update by amount or percentage of instances.
Value (integer) -- [REQUIRED]
Specifies the amount or percentage of instances SageMaker updates at a time.
WaitIntervalInSeconds (integer) --
The duration in seconds that SageMaker waits before updating more instances in the cluster.
AutoRollbackConfiguration (list) --
An array that contains the alarms that SageMaker monitors to know whether to roll back the AMI update.
(dict) --
The details of the alarm to monitor during the AMI update.
AlarmName (string) -- [REQUIRED]
The name of the alarm.
ImageId (string) --
When configuring your HyperPod cluster, you can specify an image ID using one of the following options:
HyperPodPublicAmiId: Use a HyperPod public AMI
CustomAmiId: Use your custom AMI
default: Use the default latest system image
If you choose to use a custom AMI ( CustomAmiId), ensure it meets the following requirements:
Encryption: The custom AMI must be unencrypted.
Ownership: The custom AMI must be owned by the same Amazon Web Services account that is creating the HyperPod cluster.
Volume support: Only the primary AMI snapshot volume is supported; additional AMI volumes are not supported.
When updating the instance group's AMI through the UpdateClusterSoftware operation, if an instance group uses a custom AMI, you must provide an ImageId or use the default as input. Note that if you don't specify an instance group in your UpdateClusterSoftware request, then all of the instance groups are patched with the specified image.
KubernetesConfig (dict) --
Specifies the Kubernetes configuration for the instance group. You describe what you want the labels and taints to look like, and the cluster works to reconcile the actual state with the declared state for nodes in this instance group.
Labels (dict) --
Key-value pairs of labels to be applied to cluster nodes.
(string) --
(string) --
Taints (list) --
List of taints to be applied to cluster nodes.
(dict) --
A Kubernetes taint that can be applied to cluster nodes.
Key (string) -- [REQUIRED]
The key of the taint.
Value (string) --
The value of the taint.
Effect (string) -- [REQUIRED]
The effect of the taint. Valid values are NoSchedule, PreferNoSchedule, and NoExecute.
SlurmConfig (dict) --
Specifies the Slurm configuration for the instance group.
NodeType (string) -- [REQUIRED]
The type of Slurm node for the instance group. Valid values are Controller, Worker, and Login.
PartitionNames (list) --
The list of Slurm partition names that the instance group belongs to.
(string) --
CapacityRequirements (dict) --
Specifies the capacity requirements for the instance group.
Spot (dict) --
Configuration options specific to Spot instances.
OnDemand (dict) --
Configuration options specific to On-Demand instances.
NetworkInterface (dict) --
The network interface configuration for the instance group.
InterfaceType (string) --
The type of network interface for the instance group. Valid values:
efa – An EFA with ENA interface, which provides both the EFA device for low-latency, high-throughput communication and the ENA device for IP networking.
efa-only – An EFA-only interface, which provides only the EFA device capabilities without the ENA device for traditional IP networking.
For more information, see Elastic Fabric Adapter.
list
The specialized instance groups for training models like Amazon Nova to be created in the SageMaker HyperPod cluster.
(dict) --
The specifications of a restricted instance group that you need to define.
InstanceCount (integer) -- [REQUIRED]
Specifies the number of instances to add to the restricted instance group of a SageMaker HyperPod cluster.
InstanceGroupName (string) -- [REQUIRED]
Specifies the name of the restricted instance group.
InstanceType (string) -- [REQUIRED]
Specifies the instance type of the restricted instance group.
ExecutionRole (string) -- [REQUIRED]
Specifies an IAM execution role to be assumed by the restricted instance group.
ThreadsPerCore (integer) --
The number you specified to TreadsPerCore in CreateCluster for enabling or disabling multithreading. For instance types that support multithreading, you can specify 1 for disabling multithreading and 2 for enabling multithreading. For more information, see the reference table of CPU cores and threads per CPU core per instance type in the Amazon Elastic Compute Cloud User Guide.
InstanceStorageConfigs (list) --
Specifies the additional storage configurations for the instances in the SageMaker HyperPod cluster restricted instance group.
(dict) --
Defines the configuration for attaching additional storage to the instances in the SageMaker HyperPod cluster instance group. To learn more, see SageMaker HyperPod release notes: June 20, 2024.
EbsVolumeConfig (dict) --
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 /opt/sagemaker.
VolumeSizeInGB (integer) --
The size in gigabytes (GB) of the additional EBS volume to be attached 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 /opt/sagemaker.
VolumeKmsKeyId (string) --
The ID of a KMS key to encrypt the Amazon EBS volume.
RootVolume (boolean) --
Specifies whether the configuration is for the cluster's root or secondary Amazon EBS volume. You can specify two ClusterEbsVolumeConfig fields to configure both the root and secondary volumes. Set the value to True if you'd like to provide your own customer managed Amazon Web Services KMS key to encrypt the root volume. When True:
The configuration is applied to the root volume.
You can't specify the VolumeSizeInGB field. The size of the root volume is determined for you.
You must specify a KMS key ID for VolumeKmsKeyId to encrypt the root volume with your own KMS key instead of an Amazon Web Services owned KMS key.
Otherwise, by default, the value is False, and the following applies:
The configuration is applied to the secondary volume, while the root volume is encrypted with an Amazon Web Services owned key.
You must specify the VolumeSizeInGB field.
You can optionally specify the VolumeKmsKeyId to encrypt the secondary volume with your own KMS key instead of an Amazon Web Services owned KMS key.
FsxLustreConfig (dict) --
Defines the configuration for attaching an Amazon FSx for Lustre file system to the instances in the SageMaker HyperPod cluster instance group.
DnsName (string) -- [REQUIRED]
The DNS name of the Amazon FSx for Lustre file system.
MountName (string) -- [REQUIRED]
The mount name of the Amazon FSx for Lustre file system.
MountPath (string) --
The local path where the Amazon FSx for Lustre file system is mounted on instances.
FsxOpenZfsConfig (dict) --
Defines the configuration for attaching an Amazon FSx for OpenZFS file system to the instances in the SageMaker HyperPod cluster instance group.
DnsName (string) -- [REQUIRED]
The DNS name of the Amazon FSx for OpenZFS file system.
MountPath (string) --
The local path where the Amazon FSx for OpenZFS file system is mounted on instances.
OnStartDeepHealthChecks (list) --
A flag indicating whether deep health checks should be performed when the cluster restricted instance group is created or updated.
(string) --
TrainingPlanArn (string) --
The Amazon Resource Name (ARN) of the training plan to filter clusters by. For more information about reserving GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see ``CreateTrainingPlan ``.
OverrideVpcConfig (dict) --
Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources have access to. You can control access to and from your resources by configuring a VPC. For more information, see Give SageMaker Access to Resources in your Amazon VPC.
SecurityGroupIds (list) -- [REQUIRED]
The VPC security group IDs, in the form sg-xxxxxxxx. Specify the security groups for the VPC that is specified in the Subnets field.
(string) --
Subnets (list) -- [REQUIRED]
The ID of the subnets in the VPC to which you want to connect your training job or model. For information about the availability of specific instance types, see Supported Instance Types and Availability Zones.
(string) --
ScheduledUpdateConfig (dict) --
The configuration object of the schedule that SageMaker follows when updating the AMI.
ScheduleExpression (string) -- [REQUIRED]
A cron expression that specifies the schedule that SageMaker follows when updating the AMI.
DeploymentConfig (dict) --
The configuration to use when updating the AMI versions.
RollingUpdatePolicy (dict) --
The policy that SageMaker uses when updating the AMI versions of the cluster.
MaximumBatchSize (dict) -- [REQUIRED]
The maximum amount of instances in the cluster that SageMaker can update at a time.
Type (string) -- [REQUIRED]
Specifies whether SageMaker should process the update by amount or percentage of instances.
Value (integer) -- [REQUIRED]
Specifies the amount or percentage of instances SageMaker updates at a time.
RollbackMaximumBatchSize (dict) --
The maximum amount of instances in the cluster that SageMaker can roll back at a time.
Type (string) -- [REQUIRED]
Specifies whether SageMaker should process the update by amount or percentage of instances.
Value (integer) -- [REQUIRED]
Specifies the amount or percentage of instances SageMaker updates at a time.
WaitIntervalInSeconds (integer) --
The duration in seconds that SageMaker waits before updating more instances in the cluster.
AutoRollbackConfiguration (list) --
An array that contains the alarms that SageMaker monitors to know whether to roll back the AMI update.
(dict) --
The details of the alarm to monitor during the AMI update.
AlarmName (string) -- [REQUIRED]
The name of the alarm.
EnvironmentConfig (dict) --
The configuration for the restricted instance groups (RIG) environment.
FSxLustreConfig (dict) --
Configuration settings for an Amazon FSx for Lustre file system to be used with the cluster.
SizeInGiB (integer) -- [REQUIRED]
The storage capacity of the Amazon FSx for Lustre file system, specified in gibibytes (GiB).
PerUnitStorageThroughput (integer) -- [REQUIRED]
The throughput capacity of the Amazon FSx for Lustre file system, measured in MB/s per TiB of storage.
dict
The configuration for the restricted instance groups (RIG) in the SageMaker HyperPod cluster.
SharedEnvironmentConfig (dict) -- [REQUIRED]
The shared environment configuration for the restricted instance groups (RIG).
FSxLustreDeletionPolicy (string) -- [REQUIRED]
The deletion policy for the Amazon FSx for Lustre file system in the shared environment.
FSxLustreConfig (dict) -- [REQUIRED]
Configuration settings for an Amazon FSx for Lustre file system in the shared environment.
SizeInGiB (integer) -- [REQUIRED]
The storage capacity of the Amazon FSx for Lustre file system, specified in gibibytes (GiB).
PerUnitStorageThroughput (integer) -- [REQUIRED]
The throughput capacity of the Amazon FSx for Lustre file system, measured in MB/s per TiB of storage.
dict
Updates the configuration for managed tier checkpointing on the HyperPod cluster. For example, you can enable or disable the feature and modify the percentage of cluster memory allocated for checkpoint storage.
Mode (string) -- [REQUIRED]
Specifies whether managed tier checkpointing is enabled or disabled for the HyperPod cluster. When set to Enable, the system installs a memory management daemon that provides disaggregated memory as a service for checkpoint storage. When set to Disable, the feature is turned off and the memory management daemon is removed from the cluster.
InstanceMemoryAllocationPercentage (integer) --
The percentage (int) of cluster memory to allocate for checkpointing.
string
The node recovery mode to be applied to the SageMaker HyperPod cluster.
list
Specify the names of the instance groups to delete. Use a single , as the separator between multiple names.
(string) --
string
Determines how instance provisioning is handled during cluster operations. In Continuous mode, the cluster provisions available instances incrementally and retries until the target count is reached. The cluster becomes operational once cluster-level resources are ready. Use CurrentCount and TargetCount in DescribeCluster to track provisioning progress.
string
The Amazon Resource Name (ARN) of the IAM role that HyperPod assumes for cluster autoscaling operations. Cannot be updated while autoscaling is enabled.
dict
Updates the autoscaling configuration for the cluster. Use to enable or disable automatic node scaling.
Mode (string) -- [REQUIRED]
Describes whether autoscaling is enabled or disabled for the cluster. Valid values are Enable and Disable.
AutoScalerType (string) --
The type of autoscaler to use. Currently supported value is Karpenter.
dict
The type of orchestrator used for the SageMaker HyperPod cluster.
Eks (dict) --
The Amazon EKS cluster used as the orchestrator for the SageMaker HyperPod cluster.
ClusterArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the Amazon EKS cluster associated with the SageMaker HyperPod cluster.
Slurm (dict) --
The Slurm orchestrator configuration for the SageMaker HyperPod cluster.
SlurmConfigStrategy (string) --
The strategy for managing partitions for the Slurm configuration. Valid values are Managed, Overwrite, and Merge.
dict
Response Syntax
{
'ClusterArn': 'string'
}
Response Structure
(dict) --
ClusterArn (string) --
The Amazon Resource Name (ARN) of the updated SageMaker HyperPod cluster.