Amazonka.CodeGuruProfiler.GetRecommendations

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.

Creating a Request

data GetRecommendations

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 :: ISO8601

  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 :: ISO8601

  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

ToHeaders GetRecommendations

Defined in Amazonka.CodeGuruProfiler.GetRecommendations

Methods

toHeaders :: GetRecommendations -> [Header]

ToPath GetRecommendations

Defined in Amazonka.CodeGuruProfiler.GetRecommendations

Methods

toPath :: GetRecommendations -> ByteString

ToQuery GetRecommendations

Defined in Amazonka.CodeGuruProfiler.GetRecommendations

Methods

toQuery :: GetRecommendations -> QueryString

AWSRequest GetRecommendations

Defined in Amazonka.CodeGuruProfiler.GetRecommendations

Associated Types

type AWSResponse GetRecommendations

Methods

request :: (Service -> Service) -> GetRecommendations -> Request GetRecommendations

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetRecommendations -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetRecommendations)))

Generic GetRecommendations

Defined in Amazonka.CodeGuruProfiler.GetRecommendations

Associated Types

type Rep GetRecommendations :: Type -> Type

Methods

from :: GetRecommendations -> Rep GetRecommendations x

to :: Rep GetRecommendations x -> GetRecommendations

Read GetRecommendations

Defined in Amazonka.CodeGuruProfiler.GetRecommendations

Methods

readsPrec :: Int -> ReadS GetRecommendations

readList :: ReadS [GetRecommendations]

readPrec :: ReadPrec GetRecommendations

readListPrec :: ReadPrec [GetRecommendations]

Show GetRecommendations

Defined in Amazonka.CodeGuruProfiler.GetRecommendations

Methods

showsPrec :: Int -> GetRecommendations -> ShowS

show :: GetRecommendations -> String

showList :: [GetRecommendations] -> ShowS

NFData GetRecommendations

Defined in Amazonka.CodeGuruProfiler.GetRecommendations

Methods

rnf :: GetRecommendations -> ()

Eq GetRecommendations

Defined in Amazonka.CodeGuruProfiler.GetRecommendations

Methods

(==) :: GetRecommendations -> GetRecommendations -> Bool

(/=) :: GetRecommendations -> GetRecommendations -> Bool

Hashable GetRecommendations

Defined in Amazonka.CodeGuruProfiler.GetRecommendations

Methods

hashWithSalt :: Int -> GetRecommendations -> Int

hash :: GetRecommendations -> Int

type AWSResponse GetRecommendations

Defined in Amazonka.CodeGuruProfiler.GetRecommendations

type AWSResponse GetRecommendations = GetRecommendationsResponse

type Rep GetRecommendations

Defined in Amazonka.CodeGuruProfiler.GetRecommendations

type Rep GetRecommendations = D1 ('MetaData "GetRecommendations" "Amazonka.CodeGuruProfiler.GetRecommendations" "amazonka-codeguruprofiler-2.0-DsjyOqDx8Zb8uCUpe33U62" 'False) (C1 ('MetaCons "GetRecommendations'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "locale") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "endTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ISO8601)) :*: (S1 ('MetaSel ('Just "profilingGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "startTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ISO8601))))

newGetRecommendations

Arguments

:: UTCTime

GetRecommendations

-> Text

GetRecommendations

-> UTCTime

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

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.

GetRecommendations, getRecommendations_profilingGroupName - The name of the profiling group to get analysis data about.

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)

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

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

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

getRecommendations_startTime :: Lens' GetRecommendations UTCTime

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

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 :: ISO8601

  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 :: ISO8601

  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

Generic GetRecommendationsResponse

Defined in Amazonka.CodeGuruProfiler.GetRecommendations

Associated Types

type Rep GetRecommendationsResponse :: Type -> Type

Methods

from :: GetRecommendationsResponse -> Rep GetRecommendationsResponse x

to :: Rep GetRecommendationsResponse x -> GetRecommendationsResponse

Read GetRecommendationsResponse

Defined in Amazonka.CodeGuruProfiler.GetRecommendations

Methods

readsPrec :: Int -> ReadS GetRecommendationsResponse

readList :: ReadS [GetRecommendationsResponse]

readPrec :: ReadPrec GetRecommendationsResponse

readListPrec :: ReadPrec [GetRecommendationsResponse]

Show GetRecommendationsResponse

Defined in Amazonka.CodeGuruProfiler.GetRecommendations

Methods

showsPrec :: Int -> GetRecommendationsResponse -> ShowS

show :: GetRecommendationsResponse -> String

showList :: [GetRecommendationsResponse] -> ShowS

NFData GetRecommendationsResponse

Defined in Amazonka.CodeGuruProfiler.GetRecommendations

Methods

rnf :: GetRecommendationsResponse -> ()

Eq GetRecommendationsResponse

Defined in Amazonka.CodeGuruProfiler.GetRecommendations

Methods

(==) :: GetRecommendationsResponse -> GetRecommendationsResponse -> Bool

(/=) :: GetRecommendationsResponse -> GetRecommendationsResponse -> Bool

type Rep GetRecommendationsResponse

Defined in Amazonka.CodeGuruProfiler.GetRecommendations

type Rep GetRecommendationsResponse = D1 ('MetaData "GetRecommendationsResponse" "Amazonka.CodeGuruProfiler.GetRecommendations" "amazonka-codeguruprofiler-2.0-DsjyOqDx8Zb8uCUpe33U62" '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 ISO8601))) :*: (S1 ('MetaSel ('Just "profileStartTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ISO8601) :*: (S1 ('MetaSel ('Just "profilingGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "recommendations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Recommendation])))))

newGetRecommendationsResponse

Arguments

:: Int

$sel:httpStatus:GetRecommendationsResponse'

-> UTCTime

GetRecommendationsResponse

-> UTCTime

GetRecommendationsResponse

-> Text

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.

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.

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.

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

The response's http status code.

getRecommendationsResponse_anomalies :: Lens' GetRecommendationsResponse [Anomaly]

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

getRecommendationsResponse_profileEndTime :: Lens' GetRecommendationsResponse UTCTime

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

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

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

getRecommendationsResponse_recommendations :: Lens' GetRecommendationsResponse [Recommendation]

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