update_trial

update_trial(**kwargs)

Updates the display name of a trial.

See also: AWS API Documentation

Request Syntax

response = client.update_trial(
    TrialName='string',
    DisplayName='string'
)
Parameters
  • TrialName (string) --

    [REQUIRED]

    The name of the trial to update.

  • DisplayName (string) -- The name of the trial as displayed. The name doesn't need to be unique. If DisplayName isn't specified, TrialName is displayed.
Return type

dict

Returns

Response Syntax

{
    'TrialArn': 'string'
}

Response Structure

  • (dict) --

    • TrialArn (string) --

      The Amazon Resource Name (ARN) of the trial.

Exceptions

  • SageMaker.Client.exceptions.ConflictException
  • SageMaker.Client.exceptions.ResourceNotFound