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

************
update_image
************



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

  

  Updates the properties of a SageMaker AI image. To change the image's tags, use the `AddTags <https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AddTags.html>`__ and `DeleteTags <https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DeleteTags.html>`__ APIs.

  

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


  **Request Syntax**
  ::

    response = client.update_image(
        DeleteProperties=[
            'string',
        ],
        Description='string',
        DisplayName='string',
        ImageName='string',
        RoleArn='string'
    )
    
  :type DeleteProperties: list
  :param DeleteProperties: 

    A list of properties to delete. Only the ``Description`` and ``DisplayName`` properties can be deleted.

    

  
    - *(string) --* 

    

  :type Description: string
  :param Description: 

    The new description for the image.

    

  
  :type DisplayName: string
  :param DisplayName: 

    The new display name for the image.

    

  
  :type ImageName: string
  :param ImageName: **[REQUIRED]** 

    The name of the image to update.

    

  
  :type RoleArn: string
  :param RoleArn: 

    The new ARN for the IAM role that enables Amazon SageMaker AI to perform tasks on your behalf.

    

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

    
    ::

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

    

    - *(dict) --* 
      

      - **ImageArn** *(string) --* 

        The ARN of the image.

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

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

  