ListInventoryEntries
A list of inventory items returned by the request.
Request Syntax
{ "Filters": [ { "Key": "string", "Type": "string", "Values": [ "string" ] } ], "InstanceId": "string", "MaxResults":number, "NextToken": "string", "TypeName": "string" }
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- Filters
-
One or more filters. Use a filter to return a more specific list of results.
Type: Array of InventoryFilter objects
Array Members: Minimum number of 1 item. Maximum number of 5 items.
Required: No
- InstanceId
-
The instance ID for which you want inventory information.
Type: String
Pattern:
(^i-(\w{8}|\w{17})$)|(^mi-\w{17}$)Required: Yes
- 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.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 50.
Required: No
- NextToken
-
The token for the next set of items to return. (You received this token from a previous call.)
Type: String
Required: No
- TypeName
-
The type of inventory item for which you want information.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
^(AWS|Custom):.*$Required: Yes
Response Syntax
{ "CaptureTime": "string", "Entries": [ { "string" : "string" } ], "InstanceId": "string", "NextToken": "string", "SchemaVersion": "string", "TypeName": "string" }
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- CaptureTime
-
The time that inventory information was collected for the instance(s).
Type: String
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
-
A list of inventory items on the instance(s).
Type: Array of string to string maps
Array Members: Minimum number of 0 items. Maximum number of 10000 items.
Key Length Constraints: Minimum length of 1. Maximum length of 64.
Value Length Constraints: Minimum length of 0. Maximum length of 4096.
- InstanceId
-
The instance ID targeted by the request to query inventory information.
Type: String
Pattern:
(^i-(\w{8}|\w{17})$)|(^mi-\w{17}$) - NextToken
-
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
Type: String
- SchemaVersion
-
The inventory schema version used by the instance(s).
Type: String
Pattern:
^([0-9]{1,6})(\.[0-9]{1,6})$ - TypeName
-
The type of inventory item returned by the request.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
^(AWS|Custom):.*$
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalServerError
-
An error occurred on the server side.
HTTP Status Code: 500
- InvalidFilter
-
The filter name is not valid. Verify the you entered the correct name and try again.
HTTP Status Code: 400
- InvalidInstanceId
-
The following problems can cause this exception:
You do not have permission to access the instance.
SSM Agent is not running. Verify that SSM Agent is running.
SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
HTTP Status Code: 400
- InvalidNextToken
-
The specified token is not valid.
HTTP Status Code: 400
- InvalidTypeNameException
-
The parameter type name is not valid.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
