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

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