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

Class: Aws::IoT::Types::ListThingGroupsRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb

Overview

Note:

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

{
  next_token: "NextToken",
  max_results: 1,
  parent_group: "ThingGroupName",
  name_prefix_filter: "ThingGroupName",
  recursive: false,
}

Instance Attribute Summary collapse

Instance Attribute Details

#max_resultsInteger

The maximum number of results to return at one time.

Returns:

  • (Integer)


4929
4930
4931
4932
4933
4934
4935
4936
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 4929

class ListThingGroupsRequest < Struct.new(
  :next_token,
  :max_results,
  :parent_group,
  :name_prefix_filter,
  :recursive)
  include Aws::Structure
end

#name_prefix_filterString

A filter that limits the results to those with the specified name prefix.

Returns:

  • (String)


4929
4930
4931
4932
4933
4934
4935
4936
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 4929

class ListThingGroupsRequest < Struct.new(
  :next_token,
  :max_results,
  :parent_group,
  :name_prefix_filter,
  :recursive)
  include Aws::Structure
end

#next_tokenString

The token used to get the next set of results, or null if there are no additional results.

Returns:

  • (String)


4929
4930
4931
4932
4933
4934
4935
4936
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 4929

class ListThingGroupsRequest < Struct.new(
  :next_token,
  :max_results,
  :parent_group,
  :name_prefix_filter,
  :recursive)
  include Aws::Structure
end

#parent_groupString

A filter that limits the results to those with the specified parent group.

Returns:

  • (String)


4929
4930
4931
4932
4933
4934
4935
4936
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 4929

class ListThingGroupsRequest < Struct.new(
  :next_token,
  :max_results,
  :parent_group,
  :name_prefix_filter,
  :recursive)
  include Aws::Structure
end

#recursiveBoolean

If true, return child groups as well.

Returns:

  • (Boolean)


4929
4930
4931
4932
4933
4934
4935
4936
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 4929

class ListThingGroupsRequest < Struct.new(
  :next_token,
  :max_results,
  :parent_group,
  :name_prefix_filter,
  :recursive)
  include Aws::Structure
end