DeleteTrial
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
{
"TrialName": "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.
- TrialName
-
The name of the trial to delete.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 120.
Pattern:
^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,119}Required: Yes
Response Syntax
{
"TrialArn": "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.
- TrialArn
-
The Amazon Resource Name (ARN) of the trial that is being deleted.
Type: String
Length Constraints: Maximum length of 256.
Pattern:
arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:experiment-trial/.*
Errors
For information about the errors that are common to all actions, see Common Errors.
- ResourceNotFound
-
Resource being access is not found.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
