:doc:`SSM <../../ssm>` / Paginator / ListNodesSummary

****************
ListNodesSummary
****************



.. py:class:: SSM.Paginator.ListNodesSummary

  ::

    
    paginator = client.get_paginator('list_nodes_summary')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`SSM.Client.list_nodes_summary`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/ListNodesSummary>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          SyncName='string',
          Filters=[
              {
                  'Key': 'AgentType'|'AgentVersion'|'ComputerName'|'InstanceId'|'InstanceStatus'|'IpAddress'|'ManagedStatus'|'PlatformName'|'PlatformType'|'PlatformVersion'|'ResourceType'|'OrganizationalUnitId'|'OrganizationalUnitPath'|'Region'|'AccountId',
                  'Values': [
                      'string',
                  ],
                  'Type': 'Equal'|'NotEqual'|'BeginWith'
              },
          ],
          Aggregators=[
              {
                  'AggregatorType': 'Count',
                  'TypeName': 'Instance',
                  'AttributeName': 'AgentVersion'|'PlatformName'|'PlatformType'|'PlatformVersion'|'Region'|'ResourceType',
                  'Aggregators': {'... recursive ...'}
              },
          ],
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type SyncName: string
    :param SyncName: 

      The name of the Amazon Web Services managed resource data sync to retrieve information about.

       

      For cross-account/cross-Region configurations, this parameter is required, and the name of the supported resource data sync is ``AWS-QuickSetup-ManagedNode``.

       

      For single account/single-Region configurations, the parameter is not required.

      

    
    :type Filters: list
    :param Filters: 

      One or more filters. Use a filter to generate a summary that matches your specified filter criteria.

      

    
      - *(dict) --* 

        The filters for the operation.

        

      
        - **Key** *(string) --* **[REQUIRED]** 

          The name of the filter.

          

        
        - **Values** *(list) --* **[REQUIRED]** 

          A filter value supported by the specified key. For example, for the key ``PlatformType``, supported values include ``Linux`` and ``Windows``.

          

        
          - *(string) --* 

          
      
        - **Type** *(string) --* 

          The type of filter operator.

          

        
      
  
    :type Aggregators: list
    :param Aggregators: **[REQUIRED]** 

      Specify one or more aggregators to return a count of managed nodes that match that expression. For example, a count of managed nodes by operating system.

      

    
      - *(dict) --* 

        One or more aggregators for viewing counts of nodes using different dimensions.

        

      
        - **AggregatorType** *(string) --* **[REQUIRED]** 

          The aggregator type for limiting a node summary. Currently, only ``Count`` is supported.

          

        
        - **TypeName** *(string) --* **[REQUIRED]** 

          The data type name to use for viewing counts of nodes. Currently, only ``Instance`` is supported.

          

        
        - **AttributeName** *(string) --* **[REQUIRED]** 

          The name of a node attribute on which to limit the count of nodes.

          

        
        - **Aggregators** *(list) --* 

          Information about aggregators used to refine a node summary.

          

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

      
      ::

        {
            'Summary': [
                {
                    'string': 'string'
                },
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **Summary** *(list) --* 

          A collection of objects reporting information about your managed nodes, such as the count of nodes by operating system.

          
          

          - *(dict) --* 
            

            - *(string) --* 
              

              - *(string) --* 
        
      
      
    