/ - Amazon Simple Systems Manager (SSM)

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

curl --location -g --request POST 'http://ssm.{region}.amazonaws.com/' \ --header 'X-Amz-Target;' \ --header 'Content-Type: application/json' \ --data-raw '{ "Filters": [], "Aggregators": [], "ResultAttributes": [], "NextToken": "string", "MaxResults": 0 }'

Request

Query Params

MaxResults

string

optional

Pagination limit

NextToken

string

optional

Pagination token

Header Params

X-Amz-Target

string

required

Body Params application/json

Filters

array[object (InventoryFilter) {3}]

optional

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

>= 1 items<= 5 items

Key

string

required

The name of the filter key.

>= 1 characters<= 200 characters

Values

array[string]

required

Inventory filter values. Example: inventory filter where managed node IDs are specified as values Key=AWS:InstanceInformation.InstanceId,Values= i-a12b3c4d5e6g, i-1a2b3c4d5e6,Type=Equal.

>= 1 items<= 40 items

Type

enum<string>

optional

The type of filter.

Allowed values:

EqualNotEqualBeginWithLessThanGreaterThanExists

Aggregators

array[object (InventoryAggregator) {3}]

optional

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.

>= 1 items<= 10 items

Expression

string

optional

The inventory type and attribute name for aggregation.

>= 1 characters<= 1000 characters

Aggregators

array[object (InventoryAggregator) {3}]

optional

Nested aggregators to further refine aggregation for an inventory type.

>= 1 items<= 10 items

Groups

array[object (InventoryGroup) {2}]

optional

A user-defined set of one or more filters on which to aggregate inventory data. Groups return a count of resources that match and don't match the specified criteria.

>= 1 items<= 15 items

ResultAttributes

array[object (ResultAttribute) {1}]

optional

The list of inventory item types to return.

>= 1 items<= 1 items

TypeName

string

required

Name of the inventory item type. Valid value: AWS:InstanceInformation. Default Value: AWS:InstanceInformation.

>= 1 characters<= 100 characters

Match pattern:

^(AWS|Custom):.*$

NextToken

string

optional

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

MaxResults

integer

optional

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.

>= 1<= 50

Examples

Responses

🟢200Success

application/json

Body

Entities

array[object (InventoryResultEntity) {2}]

optional

Collection of inventory entities such as a collection of managed node inventory.

string

optional

ID of the inventory result entity. For example, for managed node inventory the result will be the managed node ID. For EC2 instance inventory, the result will be the instance ID.

Data

object

optional

The data section in the inventory result entity JSON.

NextToken

string

optional

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

🟠480InternalServerError

🟠481InvalidFilter

🟠482InvalidInventoryGroupException

🟠483InvalidNextToken

🟠484InvalidTypeNameException

🟠485InvalidAggregatorException

🟠486InvalidResultAttributeException