SSM / Client / list_nodes_summary

list_nodes_summary#

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

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

  • NextToken (string) – 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.

  • MaxResults (integer) – 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.

Return type:

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