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

**********************
update_trial_component
**********************



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

  

  Updates one or more properties of a trial component.

  

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


  **Request Syntax**
  ::

    response = client.update_trial_component(
        TrialComponentName='string',
        DisplayName='string',
        Status={
            'PrimaryStatus': 'InProgress'|'Completed'|'Failed'|'Stopping'|'Stopped',
            'Message': 'string'
        },
        StartTime=datetime(2015, 1, 1),
        EndTime=datetime(2015, 1, 1),
        Parameters={
            'string': {
                'StringValue': 'string',
                'NumberValue': 123.0
            }
        },
        ParametersToRemove=[
            'string',
        ],
        InputArtifacts={
            'string': {
                'MediaType': 'string',
                'Value': 'string'
            }
        },
        InputArtifactsToRemove=[
            'string',
        ],
        OutputArtifacts={
            'string': {
                'MediaType': 'string',
                'Value': 'string'
            }
        },
        OutputArtifactsToRemove=[
            'string',
        ]
    )
    
  :type TrialComponentName: string
  :param TrialComponentName: **[REQUIRED]** 

    The name of the component to update.

    

  
  :type DisplayName: string
  :param DisplayName: 

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

    

  
  :type Status: dict
  :param Status: 

    The new status of the component.

    

  
    - **PrimaryStatus** *(string) --* 

      The status of the trial component.

      

    
    - **Message** *(string) --* 

      If the component failed, a message describing why.

      

    
  
  :type StartTime: datetime
  :param StartTime: 

    When the component started.

    

  
  :type EndTime: datetime
  :param EndTime: 

    When the component ended.

    

  
  :type Parameters: dict
  :param Parameters: 

    Replaces all of the component's hyperparameters with the specified hyperparameters or add new hyperparameters. Existing hyperparameters are replaced if the trial component is updated with an identical hyperparameter key.

    

  
    - *(string) --* 

    
      - *(dict) --* 

        The value of a hyperparameter. Only one of ``NumberValue`` or ``StringValue`` can be specified.

         

        This object is specified in the `CreateTrialComponent <https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrialComponent.html>`__ request.

        

      
        - **StringValue** *(string) --* 

          The string value of a categorical hyperparameter. If you specify a value for this parameter, you can't specify the ``NumberValue`` parameter.

          

        
        - **NumberValue** *(float) --* 

          The numeric value of a numeric hyperparameter. If you specify a value for this parameter, you can't specify the ``StringValue`` parameter.

          

        
      


  :type ParametersToRemove: list
  :param ParametersToRemove: 

    The hyperparameters to remove from the component.

    

  
    - *(string) --* 

    

  :type InputArtifacts: dict
  :param InputArtifacts: 

    Replaces all of the component's input artifacts with the specified artifacts or adds new input artifacts. Existing input artifacts are replaced if the trial component is updated with an identical input artifact key.

    

  
    - *(string) --* 

    
      - *(dict) --* 

        Represents an input or output artifact of a trial component. You specify ``TrialComponentArtifact`` as part of the ``InputArtifacts`` and ``OutputArtifacts`` parameters in the `CreateTrialComponent <https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrialComponent.html>`__ request.

         

        Examples of input artifacts are datasets, algorithms, hyperparameters, source code, and instance types. Examples of output artifacts are metrics, snapshots, logs, and images.

        

      
        - **MediaType** *(string) --* 

          The media type of the artifact, which indicates the type of data in the artifact file. The media type consists of a *type* and a *subtype* concatenated with a slash (/) character, for example, text/csv, image/jpeg, and s3/uri. The type specifies the category of the media. The subtype specifies the kind of data.

          

        
        - **Value** *(string) --* **[REQUIRED]** 

          The location of the artifact.

          

        
      


  :type InputArtifactsToRemove: list
  :param InputArtifactsToRemove: 

    The input artifacts to remove from the component.

    

  
    - *(string) --* 

    

  :type OutputArtifacts: dict
  :param OutputArtifacts: 

    Replaces all of the component's output artifacts with the specified artifacts or adds new output artifacts. Existing output artifacts are replaced if the trial component is updated with an identical output artifact key.

    

  
    - *(string) --* 

    
      - *(dict) --* 

        Represents an input or output artifact of a trial component. You specify ``TrialComponentArtifact`` as part of the ``InputArtifacts`` and ``OutputArtifacts`` parameters in the `CreateTrialComponent <https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrialComponent.html>`__ request.

         

        Examples of input artifacts are datasets, algorithms, hyperparameters, source code, and instance types. Examples of output artifacts are metrics, snapshots, logs, and images.

        

      
        - **MediaType** *(string) --* 

          The media type of the artifact, which indicates the type of data in the artifact file. The media type consists of a *type* and a *subtype* concatenated with a slash (/) character, for example, text/csv, image/jpeg, and s3/uri. The type specifies the category of the media. The subtype specifies the kind of data.

          

        
        - **Value** *(string) --* **[REQUIRED]** 

          The location of the artifact.

          

        
      


  :type OutputArtifactsToRemove: list
  :param OutputArtifactsToRemove: 

    The output artifacts to remove from the component.

    

  
    - *(string) --* 

    

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

    
    ::

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

    

    - *(dict) --* 
      

      - **TrialComponentArn** *(string) --* 

        The Amazon Resource Name (ARN) of the trial component.

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

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

  