Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.CodeGuruProfiler.GetProfile

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets the aggregated profile of a profiling group for a specified time range. Amazon CodeGuru Profiler collects posted agent profiles for a profiling group into aggregated profiles.

 <note> <p> Because aggregated profiles expire over time <code>GetProfile</code> is not idempotent. </p> </note> <p> Specify the time range for the requested aggregated profile using 1 or 2 of the following parameters: <code>startTime</code>, <code>endTime</code>, <code>period</code>. The maximum time range allowed is 7 days. If you specify all 3 parameters, an exception is thrown. If you specify only <code>period</code>, the latest aggregated profile is returned. </p> <p> Aggregated profiles are available with aggregation periods of 5 minutes, 1 hour, and 1 day, aligned to UTC. The aggregation period of an aggregated profile determines how long it is retained. For more information, see <a href="https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_AggregatedProfileTime.html"> <code>AggregatedProfileTime</code> </a>. The aggregated profile's aggregation period determines how long it is retained by CodeGuru Profiler. </p> <ul> <li> <p> If the aggregation period is 5 minutes, the aggregated profile is retained for 15 days. </p> </li> <li> <p> If the aggregation period is 1 hour, the aggregated profile is retained for 60 days. </p> </li> <li> <p> If the aggregation period is 1 day, the aggregated profile is retained for 3 years. </p> </li> </ul> <p>There are two use cases for calling <code>GetProfile</code>.</p> <ol> <li> <p> If you want to return an aggregated profile that already exists, use <a href="https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ListProfileTimes.html"> <code>ListProfileTimes</code> </a> to view the time ranges of existing aggregated profiles. Use them in a <code>GetProfile</code> request to return a specific, existing aggregated profile. </p> </li> <li> <p> If you want to return an aggregated profile for a time range that doesn't align with an existing aggregated profile, then CodeGuru Profiler makes a best effort to combine existing aggregated profiles from the requested time range and return them as one aggregated profile. </p> <p> If aggregated profiles do not exist for the full time range requested, then aggregated profiles for a smaller time range are returned. For example, if the requested time range is from 00:00 to 00:20, and the existing aggregated profiles are from 00:15 and 00:25, then the aggregated profiles from 00:15 to 00:20 are returned. </p> </li> </ol>

Synopsis

data GetProfile = GetProfile' {
- startTime :: Maybe POSIX
- period :: Maybe Text
- accept :: Maybe Text
- endTime :: Maybe POSIX
- maxDepth :: Maybe Natural
- profilingGroupName :: Text
}
newGetProfile :: Text -> GetProfile
getProfile_startTime :: Lens' GetProfile (Maybe UTCTime)
getProfile_period :: Lens' GetProfile (Maybe Text)
getProfile_accept :: Lens' GetProfile (Maybe Text)
getProfile_endTime :: Lens' GetProfile (Maybe UTCTime)
getProfile_maxDepth :: Lens' GetProfile (Maybe Natural)
getProfile_profilingGroupName :: Lens' GetProfile Text
data GetProfileResponse = GetProfileResponse' {
- contentEncoding :: Maybe Text
- httpStatus :: Int
- contentType :: Text
- profile :: ByteString
}
newGetProfileResponse :: Int -> Text -> ByteString -> GetProfileResponse
getProfileResponse_contentEncoding :: Lens' GetProfileResponse (Maybe Text)
getProfileResponse_httpStatus :: Lens' GetProfileResponse Int
getProfileResponse_contentType :: Lens' GetProfileResponse Text
getProfileResponse_profile :: Lens' GetProfileResponse ByteString

Creating a Request

data GetProfile Source #

The structure representing the getProfileRequest.

See: newGetProfile smart constructor.

Constructors

GetProfile'

Fields

startTime :: Maybe POSIX
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>
```
period :: Maybe Text
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>
```

accept :: Maybe Text

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 :: Maybe POSIX
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 :: Maybe Natural
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.
profilingGroupName :: Text
The name of the profiling group to get.

Instances

Instances details

Eq GetProfile Source #
Instance details Defined in Amazonka.CodeGuruProfiler.GetProfile Methods (==) :: GetProfile -> GetProfile -> Bool # (/=) :: GetProfile -> GetProfile -> Bool #
Read GetProfile Source #
Instance details Defined in Amazonka.CodeGuruProfiler.GetProfile Methods readsPrec :: Int -> ReadS GetProfile # readList :: ReadS [GetProfile] # readPrec :: ReadPrec GetProfile # readListPrec :: ReadPrec [GetProfile] #
Show GetProfile Source #
Instance details Defined in Amazonka.CodeGuruProfiler.GetProfile Methods showsPrec :: Int -> GetProfile -> ShowS # show :: GetProfile -> String # showList :: [GetProfile] -> ShowS #
Generic GetProfile Source #
Instance details Defined in Amazonka.CodeGuruProfiler.GetProfile Associated Types type Rep GetProfile :: Type -> Type # Methods from :: GetProfile -> Rep GetProfile x # to :: Rep GetProfile x -> GetProfile #
NFData GetProfile Source #
Instance details Defined in Amazonka.CodeGuruProfiler.GetProfile Methods rnf :: GetProfile -> () #
Hashable GetProfile Source #
Instance details Defined in Amazonka.CodeGuruProfiler.GetProfile Methods hashWithSalt :: Int -> GetProfile -> Int # hash :: GetProfile -> Int #
AWSRequest GetProfile Source #
Instance details Defined in Amazonka.CodeGuruProfiler.GetProfile Associated Types type AWSResponse GetProfile # Methods request :: GetProfile -> Request GetProfile # response :: MonadResource m => Logger -> Service -> Proxy GetProfile -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetProfile))) #
ToHeaders GetProfile Source #
Instance details Defined in Amazonka.CodeGuruProfiler.GetProfile Methods toHeaders :: GetProfile -> [Header] #
ToPath GetProfile Source #
Instance details Defined in Amazonka.CodeGuruProfiler.GetProfile Methods toPath :: GetProfile -> ByteString #
ToQuery GetProfile Source #
Instance details Defined in Amazonka.CodeGuruProfiler.GetProfile Methods toQuery :: GetProfile -> QueryString #
type Rep GetProfile Source #
Instance details Defined in Amazonka.CodeGuruProfiler.GetProfile type Rep GetProfile = D1 ('MetaData "GetProfile" "Amazonka.CodeGuruProfiler.GetProfile" "libZSservicesZSamazonka-codeguruprofilerZSamazonka-codeguruprofiler" 'False) (C1 ('MetaCons "GetProfile'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "startTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: (S1 ('MetaSel ('Just "period") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "accept") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "endTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: (S1 ('MetaSel ('Just "maxDepth") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "profilingGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse GetProfile Source #
Instance details Defined in Amazonka.CodeGuruProfiler.GetProfile type AWSResponse GetProfile = GetProfileResponse

newGetProfile Source #

Arguments

:: Text	`$sel:profilingGroupName:GetProfile'`
-> GetProfile

Create a value of GetProfile with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:startTime:GetProfile', getProfile_startTime - 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>

$sel:period:GetProfile', getProfile_period - 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>

$sel:accept:GetProfile', getProfile_accept - 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>

$sel:endTime:GetProfile', getProfile_endTime - 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.

$sel:maxDepth:GetProfile', getProfile_maxDepth - 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.

$sel:profilingGroupName:GetProfile', getProfile_profilingGroupName - The name of the profiling group to get.

Request Lenses

getProfile_startTime :: Lens' GetProfile (Maybe UTCTime) Source #

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>

getProfile_period :: Lens' GetProfile (Maybe Text) Source #

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>

getProfile_accept :: Lens' GetProfile (Maybe Text) Source #

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>

getProfile_endTime :: Lens' GetProfile (Maybe UTCTime) Source #

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.

getProfile_maxDepth :: Lens' GetProfile (Maybe Natural) Source #

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.

getProfile_profilingGroupName :: Lens' GetProfile Text Source #

The name of the profiling group to get.

Destructuring the Response

data GetProfileResponse Source #

The structure representing the getProfileResponse.

See: newGetProfileResponse smart constructor.

Constructors

GetProfileResponse'
Fields contentEncoding :: Maybe Text The content encoding of the profile. httpStatus :: Int The response's http status code. contentType :: Text The content type of the profile in the payload. It is either `application/json` or the default `application/x-amzn-ion`. profile :: ByteString Information about the profile.

Instances

Instances details

Eq GetProfileResponse Source #
Instance details Defined in Amazonka.CodeGuruProfiler.GetProfile Methods (==) :: GetProfileResponse -> GetProfileResponse -> Bool # (/=) :: GetProfileResponse -> GetProfileResponse -> Bool #
Read GetProfileResponse Source #
Instance details Defined in Amazonka.CodeGuruProfiler.GetProfile Methods readsPrec :: Int -> ReadS GetProfileResponse # readList :: ReadS [GetProfileResponse] # readPrec :: ReadPrec GetProfileResponse # readListPrec :: ReadPrec [GetProfileResponse] #
Show GetProfileResponse Source #
Instance details Defined in Amazonka.CodeGuruProfiler.GetProfile Methods showsPrec :: Int -> GetProfileResponse -> ShowS # show :: GetProfileResponse -> String # showList :: [GetProfileResponse] -> ShowS #
Generic GetProfileResponse Source #
Instance details Defined in Amazonka.CodeGuruProfiler.GetProfile Associated Types type Rep GetProfileResponse :: Type -> Type # Methods from :: GetProfileResponse -> Rep GetProfileResponse x # to :: Rep GetProfileResponse x -> GetProfileResponse #
NFData GetProfileResponse Source #
Instance details Defined in Amazonka.CodeGuruProfiler.GetProfile Methods rnf :: GetProfileResponse -> () #
type Rep GetProfileResponse Source #
Instance details Defined in Amazonka.CodeGuruProfiler.GetProfile type Rep GetProfileResponse = D1 ('MetaData "GetProfileResponse" "Amazonka.CodeGuruProfiler.GetProfile" "libZSservicesZSamazonka-codeguruprofilerZSamazonka-codeguruprofiler" 'False) (C1 ('MetaCons "GetProfileResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "contentEncoding") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)) :: (S1 ('MetaSel ('Just "contentType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "profile") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ByteString))))

newGetProfileResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetProfileResponse'`
-> Text	`$sel:contentType:GetProfileResponse'`
-> ByteString	`$sel:profile:GetProfileResponse'`
-> GetProfileResponse

Create a value of GetProfileResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:contentEncoding:GetProfileResponse', getProfileResponse_contentEncoding - The content encoding of the profile.

$sel:httpStatus:GetProfileResponse', getProfileResponse_httpStatus - The response's http status code.

$sel:contentType:GetProfileResponse', getProfileResponse_contentType - The content type of the profile in the payload. It is either application/json or the default application/x-amzn-ion.

$sel:profile:GetProfileResponse', getProfileResponse_profile - Information about the profile.

Response Lenses

getProfileResponse_contentEncoding :: Lens' GetProfileResponse (Maybe Text) Source #

The content encoding of the profile.

getProfileResponse_httpStatus :: Lens' GetProfileResponse Int Source #

The response's http status code.

getProfileResponse_contentType :: Lens' GetProfileResponse Text Source #

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

getProfileResponse_profile :: Lens' GetProfileResponse ByteString Source #

Information about the profile.