GetProfile - Amazon CodeGuru Profiler

GetProfile

Gets the aggregated profile of a profiling group for the specified time range. If the requested time range does not align with the available aggregated profiles, it is expanded to attain alignment. If aggregated profiles are available only for part of the period requested, the profile is returned from the earliest available to the latest within the requested time range.

For example, if the requested time range is from 00:00 to 00:20 and the available profiles are from 00:15 to 00:25, the returned profile will be from 00:15 to 00:20.

You must specify exactly two of the following parameters: startTime, period, and endTime.

Request Syntax

GET /profilingGroups/profilingGroupName/profile?endTime=endTime&maxDepth=maxDepth&period=period&startTime=startTime HTTP/1.1 Accept: accept

URI Request Parameters

The request requires the following URI parameters.

accept

The format of the profile to return. You can choose application/json or the default application/x-amzn-ion.

endTime

You must specify exactly two of the following parameters: startTime, period, and endTime.

maxDepth

The maximum depth of the graph.

Valid Range: Minimum value of 1. Maximum value of 10000.

period

The period of the profile to get. The time range must be in the past and not longer than one week.

You must specify exactly two of the following parameters: startTime, period, and endTime.

Length Constraints: Minimum length of 1. Maximum length of 64.

profilingGroupName

The name of the profiling group to get.

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: ^[\w-]+$

startTime

The start time of the profile to get.

You must specify exactly two of the following parameters: startTime, period, and endTime.

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-Encoding: contentEncoding Content-Type: contentType profile

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The response returns the following HTTP headers.

contentEncoding

The content encoding of the profile.

contentType

The content type of the profile in the payload. It is either application/json or the default application/x-amzn-ion.

The response returns the following as the HTTP body.

profile

Information about the profile.

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServerException

The server encountered an internal error and is unable to complete the request.

HTTP Status Code: 500

ResourceNotFoundException

The resource specified in the request does not exist.

HTTP Status Code: 404

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The parameter is not valid.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: