:doc:`mgn <../../mgn>` / Paginator / ListWaves

*********
ListWaves
*********



.. py:class:: mgn.Paginator.ListWaves

  ::

    
    paginator = client.get_paginator('list_waves')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`mgn.Client.list_waves`.

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          filters={
              'waveIDs': [
                  'string',
              ],
              'isArchived': True|False
          },
          accountID='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type filters: dict
    :param filters: 

      Waves list filters.

      

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

        Filter waves list by wave ID.

        

      
        - *(string) --* 

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

        Filter waves list by archival status.

        

      
    
    :type accountID: string
    :param accountID: 

      Request account ID.

      

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

      
      ::

        {
            'items': [
                {
                    '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'
                    }
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

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

          Waves list.

          
          

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

        - **NextToken** *(string) --* 

          A token to resume pagination.

          
    