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

Inherits:

Struct

• Object
• Struct
• Aws::CodeGuruProfiler::Types::ListProfilingGroupsRequest

Includes:

Structure

Defined in:

lib/aws-sdk-codeguruprofiler/types.rb

Overview

The structure representing the listProfilingGroupsRequest.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #include_description ⇒ 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.

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

Instance Attribute Details

#include_description ⇒ Boolean

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

[1]: docs.aws.amazon.com/codeguru/latest/profiler-api/API_ProfilingGroupDescription.html

Returns:

• (Boolean)

# File 'lib/aws-sdk-codeguruprofiler/types.rb', line 1232

class ListProfilingGroupsRequest < Struct.new(
  :include_description,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#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)

# File 'lib/aws-sdk-codeguruprofiler/types.rb', line 1232

class ListProfilingGroupsRequest < Struct.new(
  :include_description,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#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.

<note markdown=“1”> 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.

</note>

Returns:

• (String)

# File 'lib/aws-sdk-codeguruprofiler/types.rb', line 1232

class ListProfilingGroupsRequest < Struct.new(
  :include_description,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end