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

Class: Aws::SSM::Types::GetInventorySchemaRequest

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 GetInventorySchemaRequest data as a hash:

{
  type_name: "InventoryItemTypeNameFilter",
  next_token: "NextToken",
  max_results: 1,
  aggregator: false,
  sub_type: false,
}

Instance Attribute Summary collapse

Instance Attribute Details

#aggregatorBoolean

Returns inventory schemas that support aggregation. For example, this call returns the AWS:InstanceInformation type, because it supports aggregation based on the PlatformName, PlatformType, and PlatformVersion attributes.

Returns:

  • (Boolean)


4760
4761
4762
4763
4764
4765
4766
4767
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 4760

class GetInventorySchemaRequest < Struct.new(
  :type_name,
  :next_token,
  :max_results,
  :aggregator,
  :sub_type)
  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)


4760
4761
4762
4763
4764
4765
4766
4767
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 4760

class GetInventorySchemaRequest < Struct.new(
  :type_name,
  :next_token,
  :max_results,
  :aggregator,
  :sub_type)
  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)


4760
4761
4762
4763
4764
4765
4766
4767
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 4760

class GetInventorySchemaRequest < Struct.new(
  :type_name,
  :next_token,
  :max_results,
  :aggregator,
  :sub_type)
  include Aws::Structure
end

#sub_typeBoolean

Returns the sub-type schema for a specified inventory type.

Returns:

  • (Boolean)


4760
4761
4762
4763
4764
4765
4766
4767
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 4760

class GetInventorySchemaRequest < Struct.new(
  :type_name,
  :next_token,
  :max_results,
  :aggregator,
  :sub_type)
  include Aws::Structure
end

#type_nameString

The type of inventory item to return.

Returns:

  • (String)


4760
4761
4762
4763
4764
4765
4766
4767
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 4760

class GetInventorySchemaRequest < Struct.new(
  :type_name,
  :next_token,
  :max_results,
  :aggregator,
  :sub_type)
  include Aws::Structure
end