SageMaker / Client / update_cluster_software
update_cluster_software¶
- SageMaker.Client.update_cluster_software(**kwargs)¶
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.
Warning
The
UpgradeClusterSoftware
API call may impact your SageMaker HyperPod cluster uptime and availability. Plan accordingly to mitigate potential disruptions to your workloads.See also: AWS API Documentation
Request Syntax
response = client.update_cluster_software( ClusterName='string', InstanceGroups=[ { 'InstanceGroupName': 'string' }, ], DeploymentConfig={ 'RollingUpdatePolicy': { 'MaximumBatchSize': { 'Type': 'INSTANCE_COUNT'|'CAPACITY_PERCENTAGE', 'Value': 123 }, 'RollbackMaximumBatchSize': { 'Type': 'INSTANCE_COUNT'|'CAPACITY_PERCENTAGE', 'Value': 123 } }, 'WaitIntervalInSeconds': 123, 'AutoRollbackConfiguration': [ { 'AlarmName': 'string' }, ] } )
- Parameters:
ClusterName (string) –
[REQUIRED]
Specify the name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster you want to update for security patching.
InstanceGroups (list) –
The array of instance groups for which to update AMI versions.
(dict) –
The configuration that describes specifications of the instance groups to update.
InstanceGroupName (string) – [REQUIRED]
The name of the instance group to update.
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.
- Return type:
dict
- Returns:
Response Syntax
{ 'ClusterArn': 'string' }
Response Structure
(dict) –
ClusterArn (string) –
The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster being updated for security patching.
Exceptions