SSM / Paginator / ListNodesSummary

ListNodesSummary

class SSM.Paginator.ListNodesSummary

paginator = client.get_paginator('list_nodes_summary')

paginate(**kwargs)

Creates an iterator that will paginate through responses from SSM.Client.list_nodes_summary().

See also: AWS API Documentation

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'
    }
)

Parameters:

• SyncName (string) – The name of the resource data sync to retrieve information about. Required for cross-account/cross-Region configuration. Optional for single account/single-Region configurations.

• Filters (list) –

  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.

• Aggregators (list) –

  [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.

• PaginationConfig (dict) –

  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.

Return type:

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) –