Provides a list of a trial's properties.
Parameters:
Raises:
Source code in docs_src/capo_sagemaker/_services/sage_maker.py
| def describe_trial(
self,
*,
config_overrides: Optional[SageMakerClientConfig] = None,
trial_name: Optional[
"capo_sagemaker.types.experiment_entity_name.ExperimentEntityName"
] = None,
) -> "capo_sagemaker.types.describe_trial_response.DescribeTrialResponse":
"""<p>Provides a list of a trial's properties.</p>
Args:
trial_name: <p>The name of the trial to describe.</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.
"""
def _handler(
req: "OperationRequest[capo_sagemaker.types.describe_trial_request.DescribeTrialRequest]",
) -> OperationResponse[
"capo_sagemaker.types.describe_trial_response.DescribeTrialResponse"
]:
import capo_sagemaker._operations.sage_maker.describe_trial
output, http_response = (
capo_sagemaker._operations.sage_maker.describe_trial.describe_trial(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("DescribeTrial")
)
input_: capo_sagemaker.types.describe_trial_request.DescribeTrialRequest = {}
if trial_name is not None:
input_["trial_name"] = trial_name
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|