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

*******************
archive_application
*******************



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

  

  Archive application.

  

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


  **Request Syntax**
  ::

    response = client.archive_application(
        applicationID='string',
        accountID='string'
    )
    
  :type applicationID: string
  :param applicationID: **[REQUIRED]** 

    Application ID.

    

  
  :type accountID: string
  :param accountID: 

    Account ID.

    

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

    
    ::

      {
          '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'
      }
      
    **Response Structure**

    

    - *(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.

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

  
  *   :py:class:`mgn.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`mgn.Client.exceptions.ServiceQuotaExceededException`

  
  *   :py:class:`mgn.Client.exceptions.ConflictException`

  