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.
Parameters:
Raises:
Source code in docs_src/capo_sagemaker/_services/async_sage_maker.py
| async def delete_trial(
self,
*,
config_overrides: Optional[AsyncSageMakerClientConfig] = None,
trial_name: Optional[
"capo_sagemaker.types.experiment_entity_name.ExperimentEntityName"
] = None,
) -> "capo_sagemaker.types.delete_trial_response.DeleteTrialResponse":
"""<p>Deletes the specified trial. All trial components that make up the trial must be deleted first. Use the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeTrialComponent.html">DescribeTrialComponent</a> API to get the list of trial components.</p>
Args:
trial_name: <p>The name of the trial to delete.</p>
Raises:
capo_sagemaker.errors.resource_not_found.ResourceNotFound: <p>Resource being access is not found.</p>
capo_sagemaker.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
async def _handler(
req: "AsyncOperationRequest[capo_sagemaker.types.delete_trial_request.DeleteTrialRequest]",
) -> AsyncOperationResponse[
"capo_sagemaker.types.delete_trial_response.DeleteTrialResponse"
]:
import capo_sagemaker._operations.sage_maker.delete_trial
(
output,
http_response,
) = await capo_sagemaker._operations.sage_maker.delete_trial.async_delete_trial(
req.options, req.input
)
return AsyncOperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("DeleteTrial")
)
input_: capo_sagemaker.types.delete_trial_request.DeleteTrialRequest = {}
if trial_name is not None:
input_["trial_name"] = trial_name
response = await aexecute_pipeline(
AsyncOperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
await response.response.aclose()
return response.output
|