Class: Aws::SSM::Types::InventoryFilter

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
lib/aws-sdk-ssm/types.rb

Overview

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

**Example formats for the ‘aws ssm get-inventory` command:**

‘–filters Key=AWS:InstanceInformation.AgentType,Values=amazon-ssm-agent,Type=Equal`

‘–filters Key=AWS:InstanceInformation.AgentVersion,Values=3.3.2299.0,Type=Equal`

‘–filters Key=AWS:InstanceInformation.ComputerName,Values=ip-192.0.2.0.us-east-2.compute.internal,Type=Equal`

‘–filters Key=AWS:InstanceInformation.InstanceId,Values=i-0a4cd6ceffEXAMPLE,i-1a2b3c4d5e6EXAMPLE,Type=Equal`

‘–filters Key=AWS:InstanceInformation.InstanceStatus,Values=Active,Type=Equal`

‘–filters Key=AWS:InstanceInformation.IpAddress,Values=198.51.100.0,Type=Equal`

‘–filters Key=AWS:InstanceInformation.PlatformName,Values=“Amazon Linux”,Type=Equal`

‘–filters Key=AWS:InstanceInformation.PlatformType,Values=Linux,Type=Equal`

‘–filters Key=AWS:InstanceInformation.PlatformVersion,Values=2023,Type=BeginWith`

‘–filters Key=AWS:InstanceInformation.ResourceType,Values=EC2Instance,Type=Equal`

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#key ⇒ String

The name of the filter key.

Returns:

  • (String) 


11443
11444
11445
11446
11447
11448
11449
 
# File 'lib/aws-sdk-ssm/types.rb', line 11443

class InventoryFilter < Struct.new(
  :key,
  :values,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ String

The type of filter.

<note markdown=“1”> The Exists filter must be used with aggregators. For more information, see [Aggregating inventory data] in the *Amazon Web Services Systems Manager User Guide*.

</note>

[1]: docs.aws.amazon.com/systems-manager/latest/userguide/inventory-aggregate.html

Returns:

  • (String) 


11443
11444
11445
11446
11447
11448
11449
 
# File 'lib/aws-sdk-ssm/types.rb', line 11443

class InventoryFilter < Struct.new(
  :key,
  :values,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#values ⇒ Array<String>

Inventory filter values.

Returns:

  • (Array<String>) 


11443
11444
11445
11446
11447
11448
11449
 
# File 'lib/aws-sdk-ssm/types.rb', line 11443

class InventoryFilter < Struct.new(
  :key,
  :values,
  :type)
  SENSITIVE = []
  include Aws::Structure
end