:doc:`SageMaker <../../sagemaker>` / Paginator / ListAppImageConfigs

*******************
ListAppImageConfigs
*******************



.. py:class:: SageMaker.Paginator.ListAppImageConfigs

  ::

    
    paginator = client.get_paginator('list_app_image_configs')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`SageMaker.Client.list_app_image_configs`.

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          NameContains='string',
          CreationTimeBefore=datetime(2015, 1, 1),
          CreationTimeAfter=datetime(2015, 1, 1),
          ModifiedTimeBefore=datetime(2015, 1, 1),
          ModifiedTimeAfter=datetime(2015, 1, 1),
          SortBy='CreationTime'|'LastModifiedTime'|'Name',
          SortOrder='Ascending'|'Descending',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type NameContains: string
    :param NameContains: 

      A filter that returns only AppImageConfigs whose name contains the specified string.

      

    
    :type CreationTimeBefore: datetime
    :param CreationTimeBefore: 

      A filter that returns only AppImageConfigs created on or before the specified time.

      

    
    :type CreationTimeAfter: datetime
    :param CreationTimeAfter: 

      A filter that returns only AppImageConfigs created on or after the specified time.

      

    
    :type ModifiedTimeBefore: datetime
    :param ModifiedTimeBefore: 

      A filter that returns only AppImageConfigs modified on or before the specified time.

      

    
    :type ModifiedTimeAfter: datetime
    :param ModifiedTimeAfter: 

      A filter that returns only AppImageConfigs modified on or after the specified time.

      

    
    :type SortBy: string
    :param SortBy: 

      The property used to sort results. The default value is ``CreationTime``.

      

    
    :type SortOrder: string
    :param SortOrder: 

      The sort order. The default value is ``Descending``.

      

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      A dictionary that provides parameters to control pagination.

      

    
      - **MaxItems** *(integer) --* 

        The total number of items to return. If the total number of items available is more than the value specified in max-items then a ``NextToken`` will be provided in the output that you can use to resume pagination.

        

      
      - **PageSize** *(integer) --* 

        The size of each page.

        

      
      - **StartingToken** *(string) --* 

        A token to specify where to start paginating. This is the ``NextToken`` from a previous response.

        

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

      
      ::

        {
            'AppImageConfigs': [
                {
                    '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) --* 
        

        - **AppImageConfigs** *(list) --* 

          A list of AppImageConfigs and their properties.

          
          

          - *(dict) --* 

            The configuration for running a SageMaker AI image as a KernelGateway app.

            
            

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

              The ARN of the AppImageConfig.

              
            

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

              The name of the AppImageConfig. Must be unique to your account.

              
            

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

              When the AppImageConfig was created.

              
            

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

              When the AppImageConfig was last modified.

              
            

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

              The configuration for the file system and kernels in the SageMaker AI image.

              
              

              - **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 for the file system and the runtime, such as the environment variables and entry point.

              
              

              - **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 for the file system and the runtime, such as the environment variables and entry point.

              
              

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