:doc:`SageMaker <../../sagemaker>` / Client / update_experiment

*****************
update_experiment
*****************



.. py:method:: SageMaker.Client.update_experiment(**kwargs)

  

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

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/UpdateExperiment>`_  


  **Request Syntax**
  ::

    response = client.update_experiment(
        ExperimentName='string',
        DisplayName='string',
        Description='string'
    )
    
  :type ExperimentName: string
  :param ExperimentName: **[REQUIRED]** 

    The name of the experiment to update.

    

  
  :type DisplayName: string
  :param DisplayName: 

    The name of the experiment as displayed. The name doesn't need to be unique. If ``DisplayName`` isn't specified, ``ExperimentName`` is displayed.

    

  
  :type Description: string
  :param Description: 

    The description of the experiment.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'ExperimentArn': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **ExperimentArn** *(string) --* 

        The Amazon Resource Name (ARN) of the experiment.

        
  
  **Exceptions**
  
  *   :py:class:`SageMaker.Client.exceptions.ConflictException`

  
  *   :py:class:`SageMaker.Client.exceptions.ResourceNotFound`

  