List Nodes

ssm_list_nodes

R Documentation

Takes in filters and returns a list of managed nodes matching the filter criteria

Description

Takes in filters and returns a list of managed nodes matching the filter criteria.

Usage

ssm_list_nodes(SyncName, Filters, NextToken, MaxResults)

Arguments

SyncName

The name of the resource data sync to retrieve information about. Required for cross-account/cross-Region configurations. Optional for single account/single-Region configurations.

Filters

One or more filters. Use a filter to return a more specific list of managed nodes.

NextToken

The token for the next set of items to return. (You received this token from a previous call.)

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(
  Nodes = list(
    list(
      CaptureTime = as.POSIXct(
        "2015-01-01"
      ),
      Id = "string",
      Owner = list(
        AccountId = "string",
        OrganizationalUnitId = "string",
        OrganizationalUnitPath = "string"
      ),
      Region = "string",
      NodeType = list(
        Instance = list(
          AgentType = "string",
          AgentVersion = "string",
          ComputerName = "string",
          InstanceStatus = "string",
          IpAddress = "string",
          ManagedStatus = "All"|"Managed"|"Unmanaged",
          PlatformType = "Windows"|"Linux"|"MacOS",
          PlatformName = "string",
          PlatformVersion = "string",
          ResourceType = "ManagedInstance"|"EC2Instance"
        )
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_nodes(
  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"
    )
  ),
  NextToken = "string",
  MaxResults = 123
)