/ - Amazon Simple Systems Manager (SSM)

A list of inventory items returned by the request.

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

Request

Header Params

X-Amz-Target

string

required

Body Params application/json

InstanceId

string

required

The managed node ID for which you want inventory information.

Match pattern:

(^i-(\w{8}|\w{17})$)|(^mi-\w{17}$)

TypeName

string

required

The type of inventory item for which you want information.

>= 1 characters<= 100 characters

Match pattern:

^(AWS|Custom):.*$

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

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

TypeName

string

optional

The type of inventory item returned by the request.

>= 1 characters<= 100 characters

Match pattern:

^(AWS|Custom):.*$

InstanceId

string

optional

The managed node ID targeted by the request to query inventory information.

Match pattern:

(^i-(\w{8}|\w{17})$)|(^mi-\w{17}$)

SchemaVersion

string

optional

The inventory schema version used by the managed node(s).

Match pattern:

^([0-9]{1,6})(\.[0-9]{1,6})$

CaptureTime

string

optional

The time that inventory information was collected for the managed node(s).

Match pattern:

^(20)[0-9][0-9]-(0[1-9]|1[012])-([12][0-9]|3[01]|0[1-9])(T)(2[0-3]|[0-1][0-9])(:[0-5][0-9])(:[0-5][0-9])(Z)$

Entries

array[object (InventoryItemEntry)]

optional

A list of inventory items on the managed node(s).

>= 0 items<= 10000 items

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

🟠481InvalidInstanceId

🟠482InvalidTypeNameException

🟠483InvalidFilter

🟠484InvalidNextToken