You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ssm/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
    },
  ],
  result_attributes: [
    {
      type_name: "InventoryItemTypeName", # required
    },
  ],
  next_token: "NextToken",
  max_results: 1,
}

Instance Attribute Summary collapse

Instance Attribute Details

#filtersArray<Types::InventoryFilter>

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

Returns:



4404
4405
4406
4407
4408
4409
4410
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 4404

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

#max_resultsInteger

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)


4404
4405
4406
4407
4408
4409
4410
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 4404

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

#next_tokenString

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

Returns:

  • (String)


4404
4405
4406
4407
4408
4409
4410
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 4404

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

#result_attributesArray<Types::ResultAttribute>

The list of inventory item types to return.

Returns:



4404
4405
4406
4407
4408
4409
4410
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 4404

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