:doc:`mgn <../../mgn>` / Client / list_applications

*****************
list_applications
*****************



.. py:method:: mgn.Client.list_applications(**kwargs)

  

  Retrieves all applications or multiple applications by ID.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/mgn-2020-02-26/ListApplications>`_  


  **Request Syntax**
  ::

    response = client.list_applications(
        filters={
            'applicationIDs': [
                'string',
            ],
            'isArchived': True|False,
            'waveIDs': [
                'string',
            ]
        },
        maxResults=123,
        nextToken='string',
        accountID='string'
    )
    
  :type filters: dict
  :param filters: 

    Applications list filters.

    

  
    - **applicationIDs** *(list) --* 

      Filter applications list by application ID.

      

    
      - *(string) --* 

      
  
    - **isArchived** *(boolean) --* 

      Filter applications list by archival status.

      

    
    - **waveIDs** *(list) --* 

      Filter applications list by wave ID.

      

    
      - *(string) --* 

      
  
  
  :type maxResults: integer
  :param maxResults: 

    Maximum results to return when listing applications.

    

  
  :type nextToken: string
  :param nextToken: 

    Request next token.

    

  
  :type accountID: string
  :param accountID: 

    Applications list Account ID.

    

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

    
    ::

      {
          'items': [
              {
                  'applicationID': 'string',
                  'arn': 'string',
                  'name': 'string',
                  'description': 'string',
                  'isArchived': True|False,
                  'applicationAggregatedStatus': {
                      'lastUpdateDateTime': 'string',
                      'healthStatus': 'HEALTHY'|'LAGGING'|'ERROR',
                      'progressStatus': 'NOT_STARTED'|'IN_PROGRESS'|'COMPLETED',
                      'totalSourceServers': 123
                  },
                  'creationDateTime': 'string',
                  'lastModifiedDateTime': 'string',
                  'tags': {
                      'string': 'string'
                  },
                  'waveID': 'string'
              },
          ],
          'nextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **items** *(list) --* 

        Applications list.

        
        

        - *(dict) --* 
          

          - **applicationID** *(string) --* 

            Application ID.

            
          

          - **arn** *(string) --* 

            Application ARN.

            
          

          - **name** *(string) --* 

            Application name.

            
          

          - **description** *(string) --* 

            Application description.

            
          

          - **isArchived** *(boolean) --* 

            Application archival status.

            
          

          - **applicationAggregatedStatus** *(dict) --* 

            Application aggregated status.

            
            

            - **lastUpdateDateTime** *(string) --* 

              Application aggregated status last update dateTime.

              
            

            - **healthStatus** *(string) --* 

              Application aggregated status health status.

              
            

            - **progressStatus** *(string) --* 

              Application aggregated status progress status.

              
            

            - **totalSourceServers** *(integer) --* 

              Application aggregated status total source servers amount.

              
        
          

          - **creationDateTime** *(string) --* 

            Application creation dateTime.

            
          

          - **lastModifiedDateTime** *(string) --* 

            Application last modified dateTime.

            
          

          - **tags** *(dict) --* 

            Application tags.

            
            

            - *(string) --* 
              

              - *(string) --* 
        
      
          

          - **waveID** *(string) --* 

            Application wave ID.

            
      
    
      

      - **nextToken** *(string) --* 

        Response next token.

        
  
  **Exceptions**
  
  *   :py:class:`mgn.Client.exceptions.UninitializedAccountException`

  