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.GetRecommendations

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns a list of Recommendation objects that contain recommendations for a profiling group for a given time period. A list of Anomaly objects that contains details about anomalies detected in the profiling group for the same time period is also returned.

Synopsis

data GetRecommendations = GetRecommendations' {
- locale :: Maybe Text
- endTime :: POSIX
- profilingGroupName :: Text
- startTime :: POSIX
}
newGetRecommendations :: UTCTime -> Text -> UTCTime -> GetRecommendations
getRecommendations_locale :: Lens' GetRecommendations (Maybe Text)
getRecommendations_endTime :: Lens' GetRecommendations UTCTime
getRecommendations_profilingGroupName :: Lens' GetRecommendations Text
getRecommendations_startTime :: Lens' GetRecommendations UTCTime
data GetRecommendationsResponse = GetRecommendationsResponse' {
- httpStatus :: Int
- anomalies :: [Anomaly]
- profileEndTime :: POSIX
- profileStartTime :: POSIX
- profilingGroupName :: Text
- recommendations :: [Recommendation]
}
newGetRecommendationsResponse :: Int -> UTCTime -> UTCTime -> Text -> GetRecommendationsResponse
getRecommendationsResponse_httpStatus :: Lens' GetRecommendationsResponse Int
getRecommendationsResponse_anomalies :: Lens' GetRecommendationsResponse [Anomaly]
getRecommendationsResponse_profileEndTime :: Lens' GetRecommendationsResponse UTCTime
getRecommendationsResponse_profileStartTime :: Lens' GetRecommendationsResponse UTCTime
getRecommendationsResponse_profilingGroupName :: Lens' GetRecommendationsResponse Text
getRecommendationsResponse_recommendations :: Lens' GetRecommendationsResponse [Recommendation]

Creating a Request

data GetRecommendations Source #

The structure representing the GetRecommendationsRequest.

See: newGetRecommendations smart constructor.

Constructors

GetRecommendations'

Fields

locale :: Maybe Text
The language used to provide analysis. Specify using a string that is one of the following BCP 47 language codes.
- de-DE - German, Germany
- en-GB - English, United Kingdom
- en-US - English, United States
- es-ES - Spanish, Spain
- fr-FR - French, France
- it-IT - Italian, Italy
- ja-JP - Japanese, Japan
- ko-KR - Korean, Republic of Korea
- pt-BR - Portugese, Brazil
- zh-CN - Chinese, China
- zh-TW - Chinese, Taiwan
endTime :: POSIX
The start time of the profile to get analysis data about. You must specify startTime and endTime. This is specified 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.
profilingGroupName :: Text
The name of the profiling group to get analysis data about.
startTime :: POSIX
The end time of the profile to get analysis data about. You must specify startTime and endTime. This is specified 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.

Instances

Instances details

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

newGetRecommendations Source #

Arguments

:: UTCTime	`$sel:endTime:GetRecommendations'`
-> Text	`$sel:profilingGroupName:GetRecommendations'`
-> UTCTime	`$sel:startTime:GetRecommendations'`
-> GetRecommendations

Create a value of GetRecommendations 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:locale:GetRecommendations', getRecommendations_locale - The language used to provide analysis. Specify using a string that is one of the following BCP 47 language codes.

de-DE - German, Germany
en-GB - English, United Kingdom
en-US - English, United States
es-ES - Spanish, Spain
fr-FR - French, France
it-IT - Italian, Italy
ja-JP - Japanese, Japan
ko-KR - Korean, Republic of Korea
pt-BR - Portugese, Brazil
zh-CN - Chinese, China
zh-TW - Chinese, Taiwan

$sel:endTime:GetRecommendations', getRecommendations_endTime - The start time of the profile to get analysis data about. You must specify startTime and endTime. This is specified 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.

$sel:profilingGroupName:GetRecommendations', getRecommendations_profilingGroupName - The name of the profiling group to get analysis data about.

$sel:startTime:GetRecommendations', getRecommendations_startTime - The end time of the profile to get analysis data about. You must specify startTime and endTime. This is specified 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.

Request Lenses

getRecommendations_locale :: Lens' GetRecommendations (Maybe Text) Source #

The language used to provide analysis. Specify using a string that is one of the following BCP 47 language codes.

de-DE - German, Germany
en-GB - English, United Kingdom
en-US - English, United States
es-ES - Spanish, Spain
fr-FR - French, France
it-IT - Italian, Italy
ja-JP - Japanese, Japan
ko-KR - Korean, Republic of Korea
pt-BR - Portugese, Brazil
zh-CN - Chinese, China
zh-TW - Chinese, Taiwan

getRecommendations_endTime :: Lens' GetRecommendations UTCTime Source #

The start time of the profile to get analysis data about. You must specify startTime and endTime. This is specified 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.

getRecommendations_profilingGroupName :: Lens' GetRecommendations Text Source #

The name of the profiling group to get analysis data about.

getRecommendations_startTime :: Lens' GetRecommendations UTCTime Source #

The end time of the profile to get analysis data about. You must specify startTime and endTime. This is specified 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.

Destructuring the Response

data GetRecommendationsResponse Source #

The structure representing the GetRecommendationsResponse.

See: newGetRecommendationsResponse smart constructor.

Constructors

GetRecommendationsResponse'

Fields

httpStatus :: Int
The response's http status code.
anomalies :: [Anomaly]
The list of anomalies that the analysis has found for this profile.
profileEndTime :: POSIX
The end time of the profile the analysis data is about. This is specified 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.
profileStartTime :: POSIX
The start time of the profile the analysis data is about. This is specified 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.
profilingGroupName :: Text
The name of the profiling group the analysis data is about.
recommendations :: [Recommendation]
The list of recommendations that the analysis found for this profile.

Instances

Instances details

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

newGetRecommendationsResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetRecommendationsResponse'`
-> UTCTime	`$sel:profileEndTime:GetRecommendationsResponse'`
-> UTCTime	`$sel:profileStartTime:GetRecommendationsResponse'`
-> Text	`$sel:profilingGroupName:GetRecommendations'`
-> GetRecommendationsResponse

Create a value of GetRecommendationsResponse 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:httpStatus:GetRecommendationsResponse', getRecommendationsResponse_httpStatus - The response's http status code.

$sel:anomalies:GetRecommendationsResponse', getRecommendationsResponse_anomalies - The list of anomalies that the analysis has found for this profile.

$sel:profileEndTime:GetRecommendationsResponse', getRecommendationsResponse_profileEndTime - The end time of the profile the analysis data is about. This is specified 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.

$sel:profileStartTime:GetRecommendationsResponse', getRecommendationsResponse_profileStartTime - The start time of the profile the analysis data is about. This is specified 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.

$sel:profilingGroupName:GetRecommendations', getRecommendationsResponse_profilingGroupName - The name of the profiling group the analysis data is about.

$sel:recommendations:GetRecommendationsResponse', getRecommendationsResponse_recommendations - The list of recommendations that the analysis found for this profile.

Response Lenses

getRecommendationsResponse_httpStatus :: Lens' GetRecommendationsResponse Int Source #

The response's http status code.

getRecommendationsResponse_anomalies :: Lens' GetRecommendationsResponse [Anomaly] Source #

The list of anomalies that the analysis has found for this profile.

getRecommendationsResponse_profileEndTime :: Lens' GetRecommendationsResponse UTCTime Source #

The end time of the profile the analysis data is about. This is specified 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.

getRecommendationsResponse_profileStartTime :: Lens' GetRecommendationsResponse UTCTime Source #

The start time of the profile the analysis data is about. This is specified 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.

getRecommendationsResponse_profilingGroupName :: Lens' GetRecommendationsResponse Text Source #

The name of the profiling group the analysis data is about.

getRecommendationsResponse_recommendations :: Lens' GetRecommendationsResponse [Recommendation] Source #

The list of recommendations that the analysis found for this profile.