:doc:`SSM <../../ssm>` / Client / list_nodes_summary

******************
list_nodes_summary
******************



.. py:method:: SSM.Client.list_nodes_summary(**kwargs)

  

  Generates a summary of managed instance/node metadata based on the filters and aggregators you specify. Results are grouped by the input aggregator you specify.

  

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


  **Request Syntax**
  ::

    response = client.list_nodes_summary(
        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 ...'}
            },
        ],
        NextToken='string',
        MaxResults=123
    )
    
  :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 NextToken: string
  :param NextToken: 

    The token for the next set of items to return. (You received this token from a previous call.) The call also returns a token that you can specify in a subsequent call to get the next set of results.

    

  
  :type MaxResults: integer
  :param MaxResults: 

    The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

    

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

    
    ::

      {
          'Summary': [
              {
                  'string': 'string'
              },
          ],
          'NextToken': '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) --* 
      
    
    
      

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

        The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

        
  
  **Exceptions**
  
  *   :py:class:`SSM.Client.exceptions.InternalServerError`

  
  *   :py:class:`SSM.Client.exceptions.InvalidAggregatorException`

  
  *   :py:class:`SSM.Client.exceptions.InvalidFilter`

  
  *   :py:class:`SSM.Client.exceptions.InvalidNextToken`

  
  *   :py:class:`SSM.Client.exceptions.ResourceDataSyncNotFoundException`

  
  *   :py:class:`SSM.Client.exceptions.UnsupportedOperationException`

  