SageMaker / Client / update_cluster

update_cluster#

SageMaker.Client.update_cluster(**kwargs)#

Updates a SageMaker HyperPod cluster.

Request Syntax

response = client.update_cluster(
    ClusterName='string',
    InstanceGroups=[
        {
            'InstanceCount': 123,
            'InstanceGroupName': 'string',
            'InstanceType': 'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.p5.48xlarge'|'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',
            'LifeCycleConfig': {
                'SourceS3Uri': 'string',
                'OnCreate': 'string'
            },
            'ExecutionRole': 'string',
            'ThreadsPerCore': 123,
            'InstanceStorageConfigs': [
                {
                    'EbsVolumeConfig': {
                        'VolumeSizeInGB': 123
                    }
                },
            ],
            'OnStartDeepHealthChecks': [
                'InstanceStress'|'InstanceConnectivity',
            ]
        },
    ],
    NodeRecovery='Automatic'|'None'
)

Parameters:

ClusterName (string) –
[REQUIRED]

Specify the name of the SageMaker HyperPod cluster you want to update.
InstanceGroups (list) –
[REQUIRED]

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.
  - InstanceGroupName (string) – [REQUIRED]
    
    Specifies the name of the instance group.
  - InstanceType (string) – [REQUIRED]
    
    Specifies the instance type of the instance group.
  - LifeCycleConfig (dict) – [REQUIRED]
    
    Specifies the LifeCycle configuration for the instance group.
    - SourceS3Uri (string) – [REQUIRED]
      
      An Amazon S3 bucket path where your lifecycle scripts are stored.
      
      Warning
      Make sure that the S3 bucket path starts with s3://sagemaker-. The IAM role for SageMaker HyperPod has the managed AmazonSageMakerClusterInstanceRolePolicy attached, which allows access to S3 buckets with the specific prefix sagemaker-.
    - OnCreate (string) – [REQUIRED]
      
      The file name of the entrypoint script of lifecycle scripts under SourceS3Uri. This entrypoint script runs during cluster creation.
  - 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.
      
      Note
      This is a Tagged Union structure. Only one of the following top level keys can be set: EbsVolumeConfig.
      - 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) – [REQUIRED]
        
        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.
  - OnStartDeepHealthChecks (list) –
    
    A flag indicating whether deep health checks should be performed when the cluster instance group is created or updated.
    - (string) –
NodeRecovery (string) – The node recovery mode to be applied to the SageMaker HyperPod cluster.

Return type:

dict

Returns:

Response Syntax

{
    'ClusterArn': 'string'
}

Response Structure

(dict) –
- ClusterArn (string) –
  
  The Amazon Resource Name (ARN) of the updated SageMaker HyperPod cluster.

Exceptions

SageMaker.Client.exceptions.ResourceLimitExceeded
SageMaker.Client.exceptions.ResourceNotFound
SageMaker.Client.exceptions.ConflictException