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

Inherits:

Struct

• Object
• Struct
• Aws::IoT::Types::ListThingGroupsRequest

Includes:

Structure

Defined in:

lib/aws-sdk-iot/types.rb

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #max_results ⇒ Integer

  The maximum number of results to return at one time.

• #name_prefix_filter ⇒ String

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

• #next_token ⇒ String

  To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

• #parent_group ⇒ String

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

• #recursive ⇒ Boolean

  If true, return child groups as well.

Instance Attribute Details

#max_results ⇒ Integer

The maximum number of results to return at one time.

Returns:

# File 'lib/aws-sdk-iot/types.rb', line 12861

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

#name_prefix_filter ⇒ String

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

Returns:

# File 'lib/aws-sdk-iot/types.rb', line 12861

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

#next_token ⇒ String

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

Returns:

# File 'lib/aws-sdk-iot/types.rb', line 12861

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

#parent_group ⇒ String

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

Returns:

# File 'lib/aws-sdk-iot/types.rb', line 12861

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

#recursive ⇒ Boolean

If true, return child groups as well.

Returns:

# File 'lib/aws-sdk-iot/types.rb', line 12861

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