Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.CodeGuruReviewer.ListRecommendations

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns the list of all recommendations for a completed code review.

Synopsis

data ListRecommendations = ListRecommendations' {
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- codeReviewArn :: Text
}
newListRecommendations :: Text -> ListRecommendations
listRecommendations_maxResults :: Lens' ListRecommendations (Maybe Natural)
listRecommendations_nextToken :: Lens' ListRecommendations (Maybe Text)
listRecommendations_codeReviewArn :: Lens' ListRecommendations Text
data ListRecommendationsResponse = ListRecommendationsResponse' {
- nextToken :: Maybe Text
- recommendationSummaries :: Maybe [RecommendationSummary]
- httpStatus :: Int
}
newListRecommendationsResponse :: Int -> ListRecommendationsResponse
listRecommendationsResponse_nextToken :: Lens' ListRecommendationsResponse (Maybe Text)
listRecommendationsResponse_recommendationSummaries :: Lens' ListRecommendationsResponse (Maybe [RecommendationSummary])
listRecommendationsResponse_httpStatus :: Lens' ListRecommendationsResponse Int

Creating a Request

data ListRecommendations Source #

See: newListRecommendations smart constructor.

Constructors

ListRecommendations'
Fields maxResults :: Maybe Natural The maximum number of results that are returned per call. The default is 100. nextToken :: Maybe Text Pagination token. codeReviewArn :: Text The Amazon Resource Name (ARN) of the CodeReview object.

Instances

Instances details

ToHeaders ListRecommendations Source #
Instance details Defined in Amazonka.CodeGuruReviewer.ListRecommendations Methods toHeaders :: ListRecommendations -> [Header] #
ToPath ListRecommendations Source #
Instance details Defined in Amazonka.CodeGuruReviewer.ListRecommendations Methods toPath :: ListRecommendations -> ByteString #
ToQuery ListRecommendations Source #
Instance details Defined in Amazonka.CodeGuruReviewer.ListRecommendations Methods toQuery :: ListRecommendations -> QueryString #
AWSRequest ListRecommendations Source #
Instance details Defined in Amazonka.CodeGuruReviewer.ListRecommendations Associated Types type AWSResponse ListRecommendations # Methods request :: (Service -> Service) -> ListRecommendations -> Request ListRecommendations # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListRecommendations -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListRecommendations))) #
Generic ListRecommendations Source #
Instance details Defined in Amazonka.CodeGuruReviewer.ListRecommendations Associated Types type Rep ListRecommendations :: Type -> Type # Methods from :: ListRecommendations -> Rep ListRecommendations x # to :: Rep ListRecommendations x -> ListRecommendations #
Read ListRecommendations Source #
Instance details Defined in Amazonka.CodeGuruReviewer.ListRecommendations Methods readsPrec :: Int -> ReadS ListRecommendations # readList :: ReadS [ListRecommendations] # readPrec :: ReadPrec ListRecommendations # readListPrec :: ReadPrec [ListRecommendations] #
Show ListRecommendations Source #
Instance details Defined in Amazonka.CodeGuruReviewer.ListRecommendations Methods showsPrec :: Int -> ListRecommendations -> ShowS # show :: ListRecommendations -> String # showList :: [ListRecommendations] -> ShowS #
NFData ListRecommendations Source #
Instance details Defined in Amazonka.CodeGuruReviewer.ListRecommendations Methods rnf :: ListRecommendations -> () #
Eq ListRecommendations Source #
Instance details Defined in Amazonka.CodeGuruReviewer.ListRecommendations Methods (==) :: ListRecommendations -> ListRecommendations -> Bool # (/=) :: ListRecommendations -> ListRecommendations -> Bool #
Hashable ListRecommendations Source #
Instance details Defined in Amazonka.CodeGuruReviewer.ListRecommendations Methods hashWithSalt :: Int -> ListRecommendations -> Int # hash :: ListRecommendations -> Int #
type AWSResponse ListRecommendations Source #
Instance details Defined in Amazonka.CodeGuruReviewer.ListRecommendations type AWSResponse ListRecommendations = ListRecommendationsResponse
type Rep ListRecommendations Source #
Instance details Defined in Amazonka.CodeGuruReviewer.ListRecommendations type Rep ListRecommendations = D1 ('MetaData "ListRecommendations" "Amazonka.CodeGuruReviewer.ListRecommendations" "amazonka-codeguru-reviewer-2.0-5PMDLaQhmT9HEhVpSUty9z" 'False) (C1 ('MetaCons "ListRecommendations'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "codeReviewArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newListRecommendations Source #

Arguments

:: Text	`ListRecommendations`
-> ListRecommendations

Create a value of ListRecommendations 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:maxResults:ListRecommendations', listRecommendations_maxResults - The maximum number of results that are returned per call. The default is 100.

ListRecommendations, listRecommendations_nextToken - Pagination token.

ListRecommendations, listRecommendations_codeReviewArn - The Amazon Resource Name (ARN) of the CodeReview object.

Request Lenses

listRecommendations_maxResults :: Lens' ListRecommendations (Maybe Natural) Source #

The maximum number of results that are returned per call. The default is 100.

listRecommendations_nextToken :: Lens' ListRecommendations (Maybe Text) Source #

Pagination token.

listRecommendations_codeReviewArn :: Lens' ListRecommendations Text Source #

The Amazon Resource Name (ARN) of the CodeReview object.

Destructuring the Response

data ListRecommendationsResponse Source #

See: newListRecommendationsResponse smart constructor.

Constructors

ListRecommendationsResponse'
Fields nextToken :: Maybe Text Pagination token. recommendationSummaries :: Maybe [RecommendationSummary] List of recommendations for the requested code review. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic ListRecommendationsResponse Source #
Instance details Defined in Amazonka.CodeGuruReviewer.ListRecommendations Associated Types type Rep ListRecommendationsResponse :: Type -> Type # Methods from :: ListRecommendationsResponse -> Rep ListRecommendationsResponse x # to :: Rep ListRecommendationsResponse x -> ListRecommendationsResponse #
Read ListRecommendationsResponse Source #
Instance details Defined in Amazonka.CodeGuruReviewer.ListRecommendations Methods readsPrec :: Int -> ReadS ListRecommendationsResponse # readList :: ReadS [ListRecommendationsResponse] # readPrec :: ReadPrec ListRecommendationsResponse # readListPrec :: ReadPrec [ListRecommendationsResponse] #
Show ListRecommendationsResponse Source #
Instance details Defined in Amazonka.CodeGuruReviewer.ListRecommendations Methods showsPrec :: Int -> ListRecommendationsResponse -> ShowS # show :: ListRecommendationsResponse -> String # showList :: [ListRecommendationsResponse] -> ShowS #
NFData ListRecommendationsResponse Source #
Instance details Defined in Amazonka.CodeGuruReviewer.ListRecommendations Methods rnf :: ListRecommendationsResponse -> () #
Eq ListRecommendationsResponse Source #
Instance details Defined in Amazonka.CodeGuruReviewer.ListRecommendations Methods (==) :: ListRecommendationsResponse -> ListRecommendationsResponse -> Bool # (/=) :: ListRecommendationsResponse -> ListRecommendationsResponse -> Bool #
type Rep ListRecommendationsResponse Source #
Instance details Defined in Amazonka.CodeGuruReviewer.ListRecommendations type Rep ListRecommendationsResponse = D1 ('MetaData "ListRecommendationsResponse" "Amazonka.CodeGuruReviewer.ListRecommendations" "amazonka-codeguru-reviewer-2.0-5PMDLaQhmT9HEhVpSUty9z" 'False) (C1 ('MetaCons "ListRecommendationsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "recommendationSummaries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [RecommendationSummary])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListRecommendationsResponse Source #

Arguments

:: Int	`$sel:httpStatus:ListRecommendationsResponse'`
-> ListRecommendationsResponse

Create a value of ListRecommendationsResponse 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:

ListRecommendations, listRecommendationsResponse_nextToken - Pagination token.

$sel:recommendationSummaries:ListRecommendationsResponse', listRecommendationsResponse_recommendationSummaries - List of recommendations for the requested code review.

$sel:httpStatus:ListRecommendationsResponse', listRecommendationsResponse_httpStatus - The response's http status code.

Response Lenses

listRecommendationsResponse_nextToken :: Lens' ListRecommendationsResponse (Maybe Text) Source #

Pagination token.

listRecommendationsResponse_recommendationSummaries :: Lens' ListRecommendationsResponse (Maybe [RecommendationSummary]) Source #

List of recommendations for the requested code review.

listRecommendationsResponse_httpStatus :: Lens' ListRecommendationsResponse Int Source #

The response's http status code.