Jump to Content

New API Documentation - Developer Preview Available

We are excited to announce the developer preview of our new API documentation for AWS SDK for JavaScript v3. Please follow instructions on the landing page to leave us your feedback.

Interface GetProfileCommandInputProtected

The input for GetProfileCommand.

Hierarchy

Properties

accept?: string

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?: Date

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?: number

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?: string

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>
profilingGroupName: undefined | string

The name of the profiling group to get.

startTime?: Date

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>