SSM / Client / list_inventory_entries
list_inventory_entries#
- SSM.Client.list_inventory_entries(**kwargs)#
A list of inventory items returned by the request.
See also: AWS API Documentation
Request Syntax
response = client.list_inventory_entries( InstanceId='string', TypeName='string', Filters=[ { 'Key': 'string', 'Values': [ 'string', ], 'Type': 'Equal'|'NotEqual'|'BeginWith'|'LessThan'|'GreaterThan'|'Exists' }, ], NextToken='string', MaxResults=123 )
- Parameters:
InstanceId (string) –
[REQUIRED]
The managed node ID for which you want inventory information.
TypeName (string) –
[REQUIRED]
The type of inventory item for which you want information.
Filters (list) –
One or more filters. Use a filter to return a more specific list of results.
(dict) –
One or more filters. Use a filter to return a more specific list of results.
Key (string) – [REQUIRED]
The name of the filter key.
Values (list) – [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
.(string) –
Type (string) –
The type of filter.
Note
The
Exists
filter must be used with aggregators. For more information, see Aggregating inventory data in the Amazon Web Services Systems Manager User Guide .
NextToken (string) – The token for the next set of items to return. (You received this token from a previous call.)
MaxResults (integer) – 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.
- Return type:
dict
- Returns:
Response Syntax
{ 'TypeName': 'string', 'InstanceId': 'string', 'SchemaVersion': 'string', 'CaptureTime': 'string', 'Entries': [ { 'string': 'string' }, ], 'NextToken': 'string' }
Response Structure
(dict) –
TypeName (string) –
The type of inventory item returned by the request.
InstanceId (string) –
The managed node ID targeted by the request to query inventory information.
SchemaVersion (string) –
The inventory schema version used by the managed node(s).
CaptureTime (string) –
The time that inventory information was collected for the managed node(s).
Entries (list) –
A list of inventory items on the managed node(s).
(dict) –
(string) –
(string) –
NextToken (string) –
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
Exceptions
SSM.Client.exceptions.InternalServerError
SSM.Client.exceptions.InvalidInstanceId
SSM.Client.exceptions.InvalidTypeNameException
SSM.Client.exceptions.InvalidFilter
SSM.Client.exceptions.InvalidNextToken