List Nodes Summary

ssm_list_nodes_summary

R Documentation

Generates a summary of managed instance/node metadata based on the filters and aggregators you specify¶

Description¶

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.

Usage¶

ssm_list_nodes_summary(SyncName, Filters, Aggregators, NextToken,
  MaxResults)

Arguments¶

SyncName: 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: One or more filters. Use a filter to generate a summary that matches your specified filter criteria.
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.
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.
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.

Value¶

A list with the following syntax:

list(
  Summary = list(
    list(
      "string"
    )
  ),
  NextToken = "string"
)

Request syntax¶

svc$list_nodes_summary(
  SyncName = "string",
  Filters = list(
    list(
      Key = "AgentType"|"AgentVersion"|"ComputerName"|"InstanceId"|"InstanceStatus"|"IpAddress"|"ManagedStatus"|"PlatformName"|"PlatformType"|"PlatformVersion"|"ResourceType"|"OrganizationalUnitId"|"OrganizationalUnitPath"|"Region"|"AccountId",
      Values = list(
        "string"
      ),
      Type = "Equal"|"NotEqual"|"BeginWith"
    )
  ),
  Aggregators = list(
    list(
      AggregatorType = "Count",
      TypeName = "Instance",
      AttributeName = "AgentVersion"|"PlatformName"|"PlatformType"|"PlatformVersion"|"Region"|"ResourceType",
      Aggregators = list()
    )
  ),
  NextToken = "string",
  MaxResults = 123
)