Skip to content

Get Inventory

ssm_get_inventory R Documentation

Query inventory information

Description

Query inventory information. This includes managed node status, such as Stopped or Terminated.

Usage

ssm_get_inventory(Filters, Aggregators, ResultAttributes, NextToken,
  MaxResults)

Arguments

Filters

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

Aggregators

Returns counts of inventory types based on one or more expressions. For example, if you aggregate by using an expression that uses the AWS:InstanceInformation.PlatformType type, you can see a count of how many Windows and Linux managed nodes exist in your inventoried fleet.

ResultAttributes

The list of inventory item types to return.

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(
  Entities = list(
    list(
      Id = "string",
      Data = list(
        list(
          TypeName = "string",
          SchemaVersion = "string",
          CaptureTime = "string",
          ContentHash = "string",
          Content = list(
            list(
              "string"
            )
          )
        )
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$get_inventory(
  Filters = list(
    list(
      Key = "string",
      Values = list(
        "string"
      ),
      Type = "Equal"|"NotEqual"|"BeginWith"|"LessThan"|"GreaterThan"|"Exists"
    )
  ),
  Aggregators = list(
    list(
      Expression = "string",
      Aggregators = list(),
      Groups = list(
        list(
          Name = "string",
          Filters = list(
            list(
              Key = "string",
              Values = list(
                "string"
              ),
              Type = "Equal"|"NotEqual"|"BeginWith"|"LessThan"|"GreaterThan"|"Exists"
            )
          )
        )
      )
    )
  ),
  ResultAttributes = list(
    list(
      TypeName = "string"
    )
  ),
  NextToken = "string",
  MaxResults = 123
)