update_experiment

update_experiment(**kwargs)

Adds, updates, or removes the description of an experiment. Updates the display name of an experiment.

See also: AWS API Documentation

Request Syntax

response = client.update_experiment(
    ExperimentName='string',
    DisplayName='string',
    Description='string'
)
Parameters
  • ExperimentName (string) --

    [REQUIRED]

    The name of the experiment to update.

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

dict

Returns

Response Syntax

{
    'ExperimentArn': 'string'
}

Response Structure

  • (dict) --

    • ExperimentArn (string) --

      The Amazon Resource Name (ARN) of the experiment.

Exceptions

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