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

Class: Aws::CodeGuruProfiler::Types::ListProfilingGroupsRequest

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

Overview

Note:

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

{
  include_description: false,
  max_results: 1,
  next_token: "PaginationToken",
}

The structure representing the listProfilingGroupsRequest.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#include_description ⇒ Boolean

A Boolean value indicating whether to include a description. If true, then a list of ProfilingGroupDescription objects that contain detailed information about profiling groups is returned. If false, then a list of profiling group names is returned.

Returns:

  • (Boolean) —

    A Boolean value indicating whether to include a description.

#max_results ⇒ Integer

The maximum number of profiling groups results returned by ListProfilingGroups in paginated output. When this parameter is used, ListProfilingGroups only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListProfilingGroups request with the returned nextToken value.

Returns:

  • (Integer) —

    The maximum number of profiling groups results returned by ListProfilingGroups in paginated output.

#next_token ⇒ String

The nextToken value returned from a previous paginated ListProfilingGroups request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

Returns:

  • (String) —

    The nextToken value returned from a previous paginated ListProfilingGroups request where maxResults was used and the results exceeded the value of that parameter.