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

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
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,
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#aggregator ⇒ Boolean

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) 


6158
6159
6160
6161
6162
6163
6164
6165
 
# File 'lib/aws-sdk-ssm/types.rb', line 6158

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


6158
6159
6160
6161
6162
6163
6164
6165
 
# File 'lib/aws-sdk-ssm/types.rb', line 6158

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


6158
6159
6160
6161
6162
6163
6164
6165
 
# File 'lib/aws-sdk-ssm/types.rb', line 6158

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

#sub_type ⇒ Boolean

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

Returns:

  • (Boolean) 


6158
6159
6160
6161
6162
6163
6164
6165
 
# File 'lib/aws-sdk-ssm/types.rb', line 6158

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

#type_name ⇒ String

The type of inventory item to return.

Returns:

  • (String) 


6158
6159
6160
6161
6162
6163
6164
6165
 
# File 'lib/aws-sdk-ssm/types.rb', line 6158

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