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

*************************
describe_app_image_config
*************************



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

  

  Describes an AppImageConfig.

  

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


  **Request Syntax**
  ::

    response = client.describe_app_image_config(
        AppImageConfigName='string'
    )
    
  :type AppImageConfigName: string
  :param AppImageConfigName: **[REQUIRED]** 

    The name of the AppImageConfig to describe.

    

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

    
    ::

      {
          'AppImageConfigArn': 'string',
          'AppImageConfigName': 'string',
          'CreationTime': datetime(2015, 1, 1),
          'LastModifiedTime': datetime(2015, 1, 1),
          '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'
                  }
              }
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

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

        The ARN of the AppImageConfig.

        
      

      - **AppImageConfigName** *(string) --* 

        The name of the AppImageConfig.

        
      

      - **CreationTime** *(datetime) --* 

        When the AppImageConfig was created.

        
      

      - **LastModifiedTime** *(datetime) --* 

        When the AppImageConfig was last modified.

        
      

      - **KernelGatewayImageConfig** *(dict) --* 

        The configuration of a KernelGateway app.

        
        

        - **KernelSpecs** *(list) --* 

          The specification of the Jupyter kernels in the image.

          
          

          - *(dict) --* 

            The specification of a Jupyter kernel.

            
            

            - **Name** *(string) --* 

              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``.

            
      
    
      

      - **JupyterLabAppImageConfig** *(dict) --* 

        The configuration of the JupyterLab app.

        
        

        - **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) --* 
        
      
      
    
      

      - **CodeEditorAppImageConfig** *(dict) --* 

        The configuration of the Code Editor app.

        
        

        - **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) --* 
        
      
      
    
  
  **Exceptions**
  
  *   :py:class:`SageMaker.Client.exceptions.ResourceNotFound`

  