/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::CodeGuruProfiler::ListProfilingGroups

NAME

Paws::CodeGuruProfiler::ListProfilingGroups - Arguments for method ListProfilingGroups on Paws::CodeGuruProfiler

DESCRIPTION

This class represents the parameters used for calling the method ListProfilingGroups on the Amazon CodeGuru Profiler service. Use the attributes of this class as arguments to method ListProfilingGroups.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListProfilingGroups.

SYNOPSIS

my $codeguru-profiler = Paws->service('CodeGuruProfiler');
my $ListProfilingGroupsResponse = $codeguru -profiler->ListProfilingGroups(
  IncludeDescription => 1,                      # OPTIONAL
  MaxResults         => 1,                      # OPTIONAL
  NextToken          => 'MyPaginationToken',    # OPTIONAL
);

# Results:
my $NextToken           = $ListProfilingGroupsResponse->NextToken;
my $ProfilingGroupNames = $ListProfilingGroupsResponse->ProfilingGroupNames;
my $ProfilingGroups     = $ListProfilingGroupsResponse->ProfilingGroups;

# Returns a L<Paws::CodeGuruProfiler::ListProfilingGroupsResponse> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/codeguru-profiler/ListProfilingGroups

ATTRIBUTES

IncludeDescription => Bool

A Boolean value indicating whether to include a description. If true, then a list of ProfilingGroupDescription (https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ProfilingGroupDescription.html) objects that contain detailed information about profiling groups is returned. If false, then a list of profiling group names is returned.

MaxResults => Int

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.

NextToken => Str

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.

SEE ALSO

This class forms part of Paws, documenting arguments for method ListProfilingGroups in Paws::CodeGuruProfiler

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues