The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.

NAME

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

DESCRIPTION

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

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

SYNOPSIS

my $codeguru-profiler = Paws->service('CodeGuruProfiler');
my $GetProfileResponse = $codeguru -profiler->GetProfile(
  ProfilingGroupName => 'MyProfilingGroupName',
  Accept             => 'MyString',               # OPTIONAL
  EndTime            => '1970-01-01T01:00:00',    # OPTIONAL
  MaxDepth           => 1,                        # OPTIONAL
  Period             => 'MyPeriod',               # OPTIONAL
  StartTime          => '1970-01-01T01:00:00',    # OPTIONAL
);

# Results:
my $ContentEncoding = $GetProfileResponse->ContentEncoding;
my $ContentType     = $GetProfileResponse->ContentType;
my $Profile         = $GetProfileResponse->Profile;

# Returns a L<Paws::CodeGuruProfiler::GetProfileResponse> 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/GetProfile

ATTRIBUTES

Accept => Str

The format of the returned profiling data. The format maps to the Accept and Content-Type headers of the HTTP request. You can specify one of the following: or the default .

<ul> <li> <p> <code>application/json</code> - standard JSON format </p> </li> <li> <p> <code>application/x-amzn-ion</code> - the Amazon Ion data format. For more information, see <a href="http://amzn.github.io/ion-docs/">Amazon Ion</a>. </p> </li> </ul>

EndTime => Str

The end time of the requested profile. Specify using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.

If you specify endTime, then you must also specify period or startTime, but not both.

MaxDepth => Int

The maximum depth of the stacks in the code that is represented in the aggregated profile. For example, if CodeGuru Profiler finds a method A, which calls method B, which calls method C, which calls method D, then the depth is 4. If the maxDepth is set to 2, then the aggregated profile contains representations of methods A and B.

Period => Str

Used with startTime or endTime to specify the time range for the returned aggregated profile. Specify using the ISO 8601 format. For example, P1DT1H1M1S.

<p> To get the latest aggregated profile, specify only <code>period</code>. </p>

REQUIRED ProfilingGroupName => Str

The name of the profiling group to get.

StartTime => Str

The start time of the profile to get. Specify using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.

<p> If you specify <code>startTime</code>, then you must also specify <code>period</code> or <code>endTime</code>, but not both. </p>

SEE ALSO

This class forms part of Paws, documenting arguments for method GetProfile 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