describeTrial method

Future<DescribeTrialResponse> describeTrial({
  1. required String trialName,
})

Provides a list of a trial's properties.

May throw ResourceNotFound.

Parameter trialName : The name of the trial to describe.

Implementation

Future<DescribeTrialResponse> describeTrial({
  required String trialName,
}) async {
  ArgumentError.checkNotNull(trialName, 'trialName');
  _s.validateStringLength(
    'trialName',
    trialName,
    1,
    120,
    isRequired: true,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'SageMaker.DescribeTrial'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'TrialName': trialName,
    },
  );

  return DescribeTrialResponse.fromJson(jsonResponse.body);
}