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

***********
update_wave
***********



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

  

  Update wave.

  

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


  **Request Syntax**
  ::

    response = client.update_wave(
        waveID='string',
        name='string',
        description='string',
        accountID='string'
    )
    
  :type waveID: string
  :param waveID: **[REQUIRED]** 

    Wave ID.

    

  
  :type name: string
  :param name: 

    Wave name.

    

  
  :type description: string
  :param description: 

    Wave description.

    

  
  :type accountID: string
  :param accountID: 

    Account ID.

    

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

    
    ::

      {
          'waveID': 'string',
          'arn': 'string',
          'name': 'string',
          'description': 'string',
          'isArchived': True|False,
          'waveAggregatedStatus': {
              'lastUpdateDateTime': 'string',
              'replicationStartedDateTime': 'string',
              'healthStatus': 'HEALTHY'|'LAGGING'|'ERROR',
              'progressStatus': 'NOT_STARTED'|'IN_PROGRESS'|'COMPLETED',
              'totalApplications': 123
          },
          'creationDateTime': 'string',
          'lastModifiedDateTime': 'string',
          'tags': {
              'string': 'string'
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

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

        Wave ID.

        
      

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

        Wave ARN.

        
      

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

        Wave name.

        
      

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

        Wave description.

        
      

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

        Wave archival status.

        
      

      - **waveAggregatedStatus** *(dict) --* 

        Wave aggregated status.

        
        

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

          Wave aggregated status last update dateTime.

          
        

        - **replicationStartedDateTime** *(string) --* 

          DateTime marking when the first source server in the wave started replication.

          
        

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

          Wave aggregated status health status.

          
        

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

          Wave aggregated status progress status.

          
        

        - **totalApplications** *(integer) --* 

          Wave aggregated status total applications amount.

          
    
      

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

        Wave creation dateTime.

        
      

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

        Wave last modified dateTime.

        
      

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

        Wave tags.

        
        

        - *(string) --* 
          

          - *(string) --* 
    
  
  
  **Exceptions**
  
  *   :py:class:`mgn.Client.exceptions.UninitializedAccountException`

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

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

  