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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing ListThingGroupsRequest as input to an Aws::Client method, you can use a vanilla Hash:

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

Instance Attribute Summary collapse

Instance Attribute Details

#max_results ⇒ Integer

The maximum number of results to return at one time.

Returns:

  • (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.

Returns:

  • (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.

Returns:

  • (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.

Returns:

  • (String) —

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

#recursive ⇒ Boolean

If true, return child groups as well.

Returns:

  • (Boolean) —

    If true, return child groups as well.