InventoryFilter
One or more filters. Use a filter to return a more specific list of results.
Example formats for the get-inventory
command:
aws ssm get-inventory --filters
Key=AWS:InstanceInformation.AgentType,Values=amazon-ssm-agent,Type= Equal
aws ssm get-inventory --filters Key=AWS:InstanceInformation.AgentVersion,Values=3.3.2299.0,Type=Equal
aws ssm get-inventory --filters Key=AWS:InstanceInformation.ComputerName,Values=ip-192.0.2.0.us-east-2.compute.internal,Type=Equal
aws ssm get-inventory --filters Key=AWS:InstanceInformation.InstanceId,Values=i-0a4cd6ceffEXAMPLE,i-1a2b3c4d5e6EXAMPLE,Type=Equal
aws ssm get-inventory --filters Key=AWS:InstanceInformation.InstanceStatus,Values=Active,Type=Equal
aws ssm get-inventory --filters Key=AWS:InstanceInformation.IpAddress,Values=198.51.100.0,Type=Equal
aws ssm get-inventory --filters Key=AWS:InstanceInformation.PlatformName,Values=Amazon Linux,Type=Equal
aws ssm get-inventory --filters Key=AWS:InstanceInformation.PlatformType,Values=Linux,Type=Equal
aws ssm get-inventory --filters Key=AWS:InstanceInformation.PlatformVersion,Values=2023,Type=BeginWith
aws ssm get-inventory --filters Key=AWS:InstanceInformation.ResourceType,Values=EC2Instance,Type=Equal
Contents
- Key
-
The name of the filter key.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Required: Yes
- Values
-
Inventory filter values.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 40 items.
Required: Yes
- Type
-
The type of filter.
Note
The
Exists
filter must be used with aggregators. For more information, see Aggregating inventory data in the AWS Systems Manager User Guide.Type: String
Valid Values:
Equal | NotEqual | BeginWith | LessThan | GreaterThan | Exists
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: