SageMaker / Client / delete_trial

delete_trial#

SageMaker.Client.delete_trial(**kwargs)#

Deletes the specified trial. All trial components that make up the trial must be deleted first. Use the DescribeTrialComponent API to get the list of trial components.

Request Syntax

response = client.delete_trial(
    TrialName='string'
)

Parameters:

TrialName (string) –

[REQUIRED]

The name of the trial to delete.

Return type:

dict

Returns:

Response Syntax

{
    'TrialArn': 'string'
}

Response Structure

(dict) –
- TrialArn (string) –
  
  The Amazon Resource Name (ARN) of the trial that is being deleted.

Exceptions

SageMaker.Client.exceptions.ResourceNotFound