Class: Aws::SSM::Types::GetInventoryRequest

Inherits:

Struct

• Object
• Struct
• Aws::SSM::Types::GetInventoryRequest

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-ssm/types.rb

Overview

Note:

When making an API call, you may pass GetInventoryRequest data as a hash:

{
  filters: [
    {
      key: "InventoryFilterKey", # required
      values: ["InventoryFilterValue"], # required
      type: "Equal", # accepts Equal, NotEqual, BeginWith, LessThan, GreaterThan, Exists
    },
  ],
  aggregators: [
    {
      expression: "InventoryAggregatorExpression",
      aggregators: {
        # recursive InventoryAggregatorList
      },
      groups: [
        {
          name: "InventoryGroupName", # required
          filters: [ # required
            {
              key: "InventoryFilterKey", # required
              values: ["InventoryFilterValue"], # required
              type: "Equal", # accepts Equal, NotEqual, BeginWith, LessThan, GreaterThan, Exists
            },
          ],
        },
      ],
    },
  ],
  result_attributes: [
    {
      type_name: "InventoryItemTypeName", # required
    },
  ],
  next_token: "NextToken",
  max_results: 1,
}

See Also:

• AWS API Documentation

Instance Attribute Summary

• #aggregators ⇒ Array<Types::InventoryAggregator>

  Returns counts of inventory types based on one or more expressions.

• #filters ⇒ Array<Types::InventoryFilter>

  One or more filters.

• #max_results ⇒ Integer

  The maximum number of items to return for this call.

• #next_token ⇒ String

  The token for the next set of items to return.

• #result_attributes ⇒ Array<Types::ResultAttribute>

  The list of inventory item types to return.

Instance Attribute Details

#aggregators ⇒ Array<Types::InventoryAggregator>

Returns counts of inventory types based on one or more expressions. For example, if you aggregate by using an expression that uses the ‘AWS:InstanceInformation.PlatformType` type, you can see a count of how many Windows and Linux instances exist in your inventoried fleet.

Returns:

• (Array<Types::InventoryAggregator>)

# File 'lib/aws-sdk-ssm/types.rb', line 6092

class GetInventoryRequest < Struct.new(
  :filters,
  :aggregators,
  :result_attributes,
  :next_token,
  :max_results)
  include Aws::Structure
end

#filters ⇒ Array<Types::InventoryFilter>

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

Returns:

• (Array<Types::InventoryFilter>)

# File 'lib/aws-sdk-ssm/types.rb', line 6092

class GetInventoryRequest < Struct.new(
  :filters,
  :aggregators,
  :result_attributes,
  :next_token,
  :max_results)
  include Aws::Structure
end

#max_results ⇒ 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.

Returns:

• (Integer)

# File 'lib/aws-sdk-ssm/types.rb', line 6092

class GetInventoryRequest < Struct.new(
  :filters,
  :aggregators,
  :result_attributes,
  :next_token,
  :max_results)
  include Aws::Structure
end

#next_token ⇒ String

The token for the next set of items to return. (You received this token from a previous call.)

Returns:

• (String)

# File 'lib/aws-sdk-ssm/types.rb', line 6092

class GetInventoryRequest < Struct.new(
  :filters,
  :aggregators,
  :result_attributes,
  :next_token,
  :max_results)
  include Aws::Structure
end

#result_attributes ⇒ Array<Types::ResultAttribute>

The list of inventory item types to return.

Returns:

• (Array<Types::ResultAttribute>)

# File 'lib/aws-sdk-ssm/types.rb', line 6092

class GetInventoryRequest < Struct.new(
  :filters,
  :aggregators,
  :result_attributes,
  :next_token,
  :max_results)
  include Aws::Structure
end