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

***********************
update_app_image_config
***********************



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

  

  Updates the properties of an AppImageConfig.

  

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


  **Request Syntax**
  ::

    response = client.update_app_image_config(
        AppImageConfigName='string',
        KernelGatewayImageConfig={
            'KernelSpecs': [
                {
                    'Name': 'string',
                    'DisplayName': 'string'
                },
            ],
            'FileSystemConfig': {
                'MountPath': 'string',
                'DefaultUid': 123,
                'DefaultGid': 123
            }
        },
        JupyterLabAppImageConfig={
            'FileSystemConfig': {
                'MountPath': 'string',
                'DefaultUid': 123,
                'DefaultGid': 123
            },
            'ContainerConfig': {
                'ContainerArguments': [
                    'string',
                ],
                'ContainerEntrypoint': [
                    'string',
                ],
                'ContainerEnvironmentVariables': {
                    'string': 'string'
                }
            }
        },
        CodeEditorAppImageConfig={
            'FileSystemConfig': {
                'MountPath': 'string',
                'DefaultUid': 123,
                'DefaultGid': 123
            },
            'ContainerConfig': {
                'ContainerArguments': [
                    'string',
                ],
                'ContainerEntrypoint': [
                    'string',
                ],
                'ContainerEnvironmentVariables': {
                    'string': 'string'
                }
            }
        }
    )
    
  :type AppImageConfigName: string
  :param AppImageConfigName: **[REQUIRED]** 

    The name of the AppImageConfig to update.

    

  
  :type KernelGatewayImageConfig: dict
  :param KernelGatewayImageConfig: 

    The new KernelGateway app to run on the image.

    

  
    - **KernelSpecs** *(list) --* **[REQUIRED]** 

      The specification of the Jupyter kernels in the image.

      

    
      - *(dict) --* 

        The specification of a Jupyter kernel.

        

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

          The name of the Jupyter kernel in the image. This value is case sensitive.

          

        
        - **DisplayName** *(string) --* 

          The display name of the kernel.

          

        
      
  
    - **FileSystemConfig** *(dict) --* 

      The Amazon Elastic File System storage configuration for a SageMaker AI image.

      

    
      - **MountPath** *(string) --* 

        The path within the image to mount the user's EFS home directory. The directory should be empty. If not specified, defaults to */home/sagemaker-user*.

        

      
      - **DefaultUid** *(integer) --* 

        The default POSIX user ID (UID). If not specified, defaults to ``1000``.

        

      
      - **DefaultGid** *(integer) --* 

        The default POSIX group ID (GID). If not specified, defaults to ``100``.

        

      
    
  
  :type JupyterLabAppImageConfig: dict
  :param JupyterLabAppImageConfig: 

    The JupyterLab app running on the image.

    

  
    - **FileSystemConfig** *(dict) --* 

      The Amazon Elastic File System storage configuration for a SageMaker AI image.

      

    
      - **MountPath** *(string) --* 

        The path within the image to mount the user's EFS home directory. The directory should be empty. If not specified, defaults to */home/sagemaker-user*.

        

      
      - **DefaultUid** *(integer) --* 

        The default POSIX user ID (UID). If not specified, defaults to ``1000``.

        

      
      - **DefaultGid** *(integer) --* 

        The default POSIX group ID (GID). If not specified, defaults to ``100``.

        

      
    
    - **ContainerConfig** *(dict) --* 

      The configuration used to run the application image container.

      

    
      - **ContainerArguments** *(list) --* 

        The arguments for the container when you're running the application.

        

      
        - *(string) --* 

        
    
      - **ContainerEntrypoint** *(list) --* 

        The entrypoint used to run the application in the container.

        

      
        - *(string) --* 

        
    
      - **ContainerEnvironmentVariables** *(dict) --* 

        The environment variables to set in the container

        

      
        - *(string) --* 

        
          - *(string) --* 

          
    
  
    
  
  :type CodeEditorAppImageConfig: dict
  :param CodeEditorAppImageConfig: 

    The Code Editor app running on the image.

    

  
    - **FileSystemConfig** *(dict) --* 

      The Amazon Elastic File System storage configuration for a SageMaker AI image.

      

    
      - **MountPath** *(string) --* 

        The path within the image to mount the user's EFS home directory. The directory should be empty. If not specified, defaults to */home/sagemaker-user*.

        

      
      - **DefaultUid** *(integer) --* 

        The default POSIX user ID (UID). If not specified, defaults to ``1000``.

        

      
      - **DefaultGid** *(integer) --* 

        The default POSIX group ID (GID). If not specified, defaults to ``100``.

        

      
    
    - **ContainerConfig** *(dict) --* 

      The configuration used to run the application image container.

      

    
      - **ContainerArguments** *(list) --* 

        The arguments for the container when you're running the application.

        

      
        - *(string) --* 

        
    
      - **ContainerEntrypoint** *(list) --* 

        The entrypoint used to run the application in the container.

        

      
        - *(string) --* 

        
    
      - **ContainerEnvironmentVariables** *(dict) --* 

        The environment variables to set in the container

        

      
        - *(string) --* 

        
          - *(string) --* 

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

    
    ::

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

    

    - *(dict) --* 
      

      - **AppImageConfigArn** *(string) --* 

        The ARN for the AppImageConfig.

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

  