Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

UpdateClusterSoftware

Updates the platform software of a SageMaker HyperPod cluster for security patching. To learn how to use this API, see Update the SageMaker HyperPod platform software of a cluster.

Important

The UpgradeClusterSoftware API call may impact your SageMaker HyperPod cluster uptime and availability. Plan accordingly to mitigate potential disruptions to your workloads.

Request Syntax


{
   "ClusterName": "string",
   "DeploymentConfig": { 
      "AutoRollbackConfiguration": [ 
         { 
            "AlarmName": "string"
         }
      ],
      "RollingUpdatePolicy": { 
         "MaximumBatchSize": { 
            "Type": "string",
            "Value": number
         },
         "RollbackMaximumBatchSize": { 
            "Type": "string",
            "Value": number
         }
      },
      "WaitIntervalInSeconds": number
   },
   "ImageId": "string",
   "InstanceGroups": [ 
      { 
         "InstanceGroupName": "string"
      }
   ]
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

ClusterName

Specify the name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster you want to update for security patching.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 256.

Pattern: (arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:cluster/[a-z0-9]{12})|([a-zA-Z0-9](-*[a-zA-Z0-9]){0,62})

Required: Yes

DeploymentConfig

The configuration to use when updating the AMI versions.

Type: DeploymentConfiguration object

Required: No

ImageId

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 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.

Type: String

Length Constraints: Minimum length of 7. Maximum length of 21.

Pattern: ami-[0-9a-fA-F]{8,17}|default

Required: No

InstanceGroups

The array of instance groups for which to update AMI versions.

Type: Array of UpdateClusterSoftwareInstanceGroupSpecification objects

Array Members: Minimum number of 1 item. Maximum number of 100 items.

Required: No

Response Syntax


{
   "ClusterArn": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ClusterArn

The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster being updated for security patching.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 256.

Pattern: arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:cluster/[a-z0-9]{12}

Errors

For information about the errors that are common to all actions, see Common Errors.

ConflictException

There was a conflict when you attempted to modify a SageMaker entity such as an Experiment or Artifact.

HTTP Status Code: 400

ResourceNotFound

Resource being access is not found.

HTTP Status Code: 400