SageMaker / Client / delete_cluster

delete_cluster#

SageMaker.Client.delete_cluster(**kwargs)#

Delete a SageMaker HyperPod cluster.

See also: AWS API Documentation

Request Syntax

response = client.delete_cluster(
    ClusterName='string'
)
Parameters:

ClusterName (string) –

[REQUIRED]

The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster to delete.

Return type:

dict

Returns:

Response Syntax

{
    'ClusterArn': 'string'
}

Response Structure

  • (dict) –

    • ClusterArn (string) –

      The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster to delete.

Exceptions

  • SageMaker.Client.exceptions.ResourceNotFound

  • SageMaker.Client.exceptions.ConflictException