Skip to content

Get Inventory Schema

ssm_get_inventory_schema R Documentation

Return a list of inventory type names for the account, or return a list of attribute names for a specific Inventory item type

Description

Return a list of inventory type names for the account, or return a list of attribute names for a specific Inventory item type.

Usage

ssm_get_inventory_schema(TypeName, NextToken, MaxResults, Aggregator,
  SubType)

Arguments

TypeName

The type of inventory item 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.

Aggregator

Returns inventory schemas that support aggregation. For example, this call returns the AWS:InstanceInformation type, because it supports aggregation based on the PlatformName, PlatformType, and PlatformVersion attributes.

SubType

Returns the sub-type schema for a specified inventory type.

Value

A list with the following syntax: 

list(
  Schemas = list(
    list(
      TypeName = "string",
      Version = "string",
      Attributes = list(
        list(
          Name = "string",
          DataType = "string"|"number"
        )
      ),
      DisplayName = "string"
    )
  ),
  NextToken = "string"
)

Request syntax

svc$get_inventory_schema(
  TypeName = "string",
  NextToken = "string",
  MaxResults = 123,
  Aggregator = TRUE|FALSE,
  SubType = TRUE|FALSE
)