{-# LANGUAGE DeriveGeneric #-}
{-# LANGUAGE DuplicateRecordFields #-}
{-# LANGUAGE NamedFieldPuns #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE RecordWildCards #-}
{-# LANGUAGE StrictData #-}
{-# LANGUAGE TypeFamilies #-}
{-# LANGUAGE NoImplicitPrelude #-}
{-# OPTIONS_GHC -fno-warn-unused-binds #-}
{-# OPTIONS_GHC -fno-warn-unused-imports #-}
{-# OPTIONS_GHC -fno-warn-unused-matches #-}

-- Derived from AWS service descriptions, licensed under Apache 2.0.

-- |
-- Module      : Amazonka.CodeGuruReviewer.ListRecommendations
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Returns the list of all recommendations for a completed code review.
module Amazonka.CodeGuruReviewer.ListRecommendations
  ( -- * Creating a Request
    ListRecommendations (..),
    newListRecommendations,

    -- * Request Lenses
    listRecommendations_maxResults,
    listRecommendations_nextToken,
    listRecommendations_codeReviewArn,

    -- * Destructuring the Response
    ListRecommendationsResponse (..),
    newListRecommendationsResponse,

    -- * Response Lenses
    listRecommendationsResponse_nextToken,
    listRecommendationsResponse_recommendationSummaries,
    listRecommendationsResponse_httpStatus,
  )
where

import Amazonka.CodeGuruReviewer.Types
import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import qualified Amazonka.Prelude as Prelude
import qualified Amazonka.Request as Request
import qualified Amazonka.Response as Response

-- | /See:/ 'newListRecommendations' smart constructor.
data ListRecommendations = ListRecommendations'
  { -- | The maximum number of results that are returned per call. The default is
    -- 100.
    ListRecommendations -> Maybe Natural
maxResults :: Prelude.Maybe Prelude.Natural,
    -- | Pagination token.
    ListRecommendations -> Maybe Text
nextToken :: Prelude.Maybe Prelude.Text,
    -- | The Amazon Resource Name (ARN) of the
    -- <https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CodeReview.html CodeReview>
    -- object.
    ListRecommendations -> Text
codeReviewArn :: Prelude.Text
  }
  deriving (ListRecommendations -> ListRecommendations -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: ListRecommendations -> ListRecommendations -> Bool
$c/= :: ListRecommendations -> ListRecommendations -> Bool
== :: ListRecommendations -> ListRecommendations -> Bool
$c== :: ListRecommendations -> ListRecommendations -> Bool
Prelude.Eq, ReadPrec [ListRecommendations]
ReadPrec ListRecommendations
Int -> ReadS ListRecommendations
ReadS [ListRecommendations]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [ListRecommendations]
$creadListPrec :: ReadPrec [ListRecommendations]
readPrec :: ReadPrec ListRecommendations
$creadPrec :: ReadPrec ListRecommendations
readList :: ReadS [ListRecommendations]
$creadList :: ReadS [ListRecommendations]
readsPrec :: Int -> ReadS ListRecommendations
$creadsPrec :: Int -> ReadS ListRecommendations
Prelude.Read, Int -> ListRecommendations -> ShowS
[ListRecommendations] -> ShowS
ListRecommendations -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [ListRecommendations] -> ShowS
$cshowList :: [ListRecommendations] -> ShowS
show :: ListRecommendations -> String
$cshow :: ListRecommendations -> String
showsPrec :: Int -> ListRecommendations -> ShowS
$cshowsPrec :: Int -> ListRecommendations -> ShowS
Prelude.Show, forall x. Rep ListRecommendations x -> ListRecommendations
forall x. ListRecommendations -> Rep ListRecommendations x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep ListRecommendations x -> ListRecommendations
$cfrom :: forall x. ListRecommendations -> Rep ListRecommendations x
Prelude.Generic)

-- |
-- Create a value of 'ListRecommendations' with all optional fields omitted.
--
-- Use <https://hackage.haskell.org/package/generic-lens generic-lens> or <https://hackage.haskell.org/package/optics optics> to modify other optional fields.
--
-- The following record fields are available, with the corresponding lenses provided
-- for backwards compatibility:
--
-- 'maxResults', 'listRecommendations_maxResults' - The maximum number of results that are returned per call. The default is
-- 100.
--
-- 'nextToken', 'listRecommendations_nextToken' - Pagination token.
--
-- 'codeReviewArn', 'listRecommendations_codeReviewArn' - The Amazon Resource Name (ARN) of the
-- <https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CodeReview.html CodeReview>
-- object.
newListRecommendations ::
  -- | 'codeReviewArn'
  Prelude.Text ->
  ListRecommendations
newListRecommendations :: Text -> ListRecommendations
newListRecommendations Text
pCodeReviewArn_ =
  ListRecommendations'
    { $sel:maxResults:ListRecommendations' :: Maybe Natural
maxResults = forall a. Maybe a
Prelude.Nothing,
      $sel:nextToken:ListRecommendations' :: Maybe Text
nextToken = forall a. Maybe a
Prelude.Nothing,
      $sel:codeReviewArn:ListRecommendations' :: Text
codeReviewArn = Text
pCodeReviewArn_
    }

-- | The maximum number of results that are returned per call. The default is
-- 100.
listRecommendations_maxResults :: Lens.Lens' ListRecommendations (Prelude.Maybe Prelude.Natural)
listRecommendations_maxResults :: Lens' ListRecommendations (Maybe Natural)
listRecommendations_maxResults = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListRecommendations' {Maybe Natural
maxResults :: Maybe Natural
$sel:maxResults:ListRecommendations' :: ListRecommendations -> Maybe Natural
maxResults} -> Maybe Natural
maxResults) (\s :: ListRecommendations
s@ListRecommendations' {} Maybe Natural
a -> ListRecommendations
s {$sel:maxResults:ListRecommendations' :: Maybe Natural
maxResults = Maybe Natural
a} :: ListRecommendations)

-- | Pagination token.
listRecommendations_nextToken :: Lens.Lens' ListRecommendations (Prelude.Maybe Prelude.Text)
listRecommendations_nextToken :: Lens' ListRecommendations (Maybe Text)
listRecommendations_nextToken = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListRecommendations' {Maybe Text
nextToken :: Maybe Text
$sel:nextToken:ListRecommendations' :: ListRecommendations -> Maybe Text
nextToken} -> Maybe Text
nextToken) (\s :: ListRecommendations
s@ListRecommendations' {} Maybe Text
a -> ListRecommendations
s {$sel:nextToken:ListRecommendations' :: Maybe Text
nextToken = Maybe Text
a} :: ListRecommendations)

-- | The Amazon Resource Name (ARN) of the
-- <https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CodeReview.html CodeReview>
-- object.
listRecommendations_codeReviewArn :: Lens.Lens' ListRecommendations Prelude.Text
listRecommendations_codeReviewArn :: Lens' ListRecommendations Text
listRecommendations_codeReviewArn = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListRecommendations' {Text
codeReviewArn :: Text
$sel:codeReviewArn:ListRecommendations' :: ListRecommendations -> Text
codeReviewArn} -> Text
codeReviewArn) (\s :: ListRecommendations
s@ListRecommendations' {} Text
a -> ListRecommendations
s {$sel:codeReviewArn:ListRecommendations' :: Text
codeReviewArn = Text
a} :: ListRecommendations)

instance Core.AWSRequest ListRecommendations where
  type
    AWSResponse ListRecommendations =
      ListRecommendationsResponse
  request :: (Service -> Service)
-> ListRecommendations -> Request ListRecommendations
request Service -> Service
overrides =
    forall a. ToRequest a => Service -> a -> Request a
Request.get (Service -> Service
overrides Service
defaultService)
  response :: forall (m :: * -> *).
MonadResource m =>
(ByteStringLazy -> IO ByteStringLazy)
-> Service
-> Proxy ListRecommendations
-> ClientResponse ClientBody
-> m (Either
        Error (ClientResponse (AWSResponse ListRecommendations)))
response =
    forall (m :: * -> *) a.
MonadResource m =>
(Int -> ResponseHeaders -> Object -> Either String (AWSResponse a))
-> (ByteStringLazy -> IO ByteStringLazy)
-> Service
-> Proxy a
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse a)))
Response.receiveJSON
      ( \Int
s ResponseHeaders
h Object
x ->
          Maybe Text
-> Maybe [RecommendationSummary]
-> Int
-> ListRecommendationsResponse
ListRecommendationsResponse'
            forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> (Object
x forall a. FromJSON a => Object -> Key -> Either String (Maybe a)
Data..?> Key
"NextToken")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> ( Object
x
                            forall a. FromJSON a => Object -> Key -> Either String (Maybe a)
Data..?> Key
"RecommendationSummaries"
                            forall (f :: * -> *) a. Functor f => f (Maybe a) -> a -> f a
Core..!@ forall a. Monoid a => a
Prelude.mempty
                        )
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (forall (f :: * -> *) a. Applicative f => a -> f a
Prelude.pure (forall a. Enum a => a -> Int
Prelude.fromEnum Int
s))
      )

instance Prelude.Hashable ListRecommendations where
  hashWithSalt :: Int -> ListRecommendations -> Int
hashWithSalt Int
_salt ListRecommendations' {Maybe Natural
Maybe Text
Text
codeReviewArn :: Text
nextToken :: Maybe Text
maxResults :: Maybe Natural
$sel:codeReviewArn:ListRecommendations' :: ListRecommendations -> Text
$sel:nextToken:ListRecommendations' :: ListRecommendations -> Maybe Text
$sel:maxResults:ListRecommendations' :: ListRecommendations -> Maybe Natural
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Natural
maxResults
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
nextToken
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
codeReviewArn

instance Prelude.NFData ListRecommendations where
  rnf :: ListRecommendations -> ()
rnf ListRecommendations' {Maybe Natural
Maybe Text
Text
codeReviewArn :: Text
nextToken :: Maybe Text
maxResults :: Maybe Natural
$sel:codeReviewArn:ListRecommendations' :: ListRecommendations -> Text
$sel:nextToken:ListRecommendations' :: ListRecommendations -> Maybe Text
$sel:maxResults:ListRecommendations' :: ListRecommendations -> Maybe Natural
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Natural
maxResults
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
nextToken
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
codeReviewArn

instance Data.ToHeaders ListRecommendations where
  toHeaders :: ListRecommendations -> ResponseHeaders
toHeaders =
    forall a b. a -> b -> a
Prelude.const
      ( forall a. Monoid a => [a] -> a
Prelude.mconcat
          [ HeaderName
"Content-Type"
              forall a. ToHeader a => HeaderName -> a -> ResponseHeaders
Data.=# ( ByteString
"application/x-amz-json-1.1" ::
                          Prelude.ByteString
                      )
          ]
      )

instance Data.ToPath ListRecommendations where
  toPath :: ListRecommendations -> ByteString
toPath ListRecommendations' {Maybe Natural
Maybe Text
Text
codeReviewArn :: Text
nextToken :: Maybe Text
maxResults :: Maybe Natural
$sel:codeReviewArn:ListRecommendations' :: ListRecommendations -> Text
$sel:nextToken:ListRecommendations' :: ListRecommendations -> Maybe Text
$sel:maxResults:ListRecommendations' :: ListRecommendations -> Maybe Natural
..} =
    forall a. Monoid a => [a] -> a
Prelude.mconcat
      [ ByteString
"/codereviews/",
        forall a. ToByteString a => a -> ByteString
Data.toBS Text
codeReviewArn,
        ByteString
"/Recommendations"
      ]

instance Data.ToQuery ListRecommendations where
  toQuery :: ListRecommendations -> QueryString
toQuery ListRecommendations' {Maybe Natural
Maybe Text
Text
codeReviewArn :: Text
nextToken :: Maybe Text
maxResults :: Maybe Natural
$sel:codeReviewArn:ListRecommendations' :: ListRecommendations -> Text
$sel:nextToken:ListRecommendations' :: ListRecommendations -> Maybe Text
$sel:maxResults:ListRecommendations' :: ListRecommendations -> Maybe Natural
..} =
    forall a. Monoid a => [a] -> a
Prelude.mconcat
      [ ByteString
"MaxResults" forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: Maybe Natural
maxResults,
        ByteString
"NextToken" forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: Maybe Text
nextToken
      ]

-- | /See:/ 'newListRecommendationsResponse' smart constructor.
data ListRecommendationsResponse = ListRecommendationsResponse'
  { -- | Pagination token.
    ListRecommendationsResponse -> Maybe Text
nextToken :: Prelude.Maybe Prelude.Text,
    -- | List of recommendations for the requested code review.
    ListRecommendationsResponse -> Maybe [RecommendationSummary]
recommendationSummaries :: Prelude.Maybe [RecommendationSummary],
    -- | The response's http status code.
    ListRecommendationsResponse -> Int
httpStatus :: Prelude.Int
  }
  deriving (ListRecommendationsResponse -> ListRecommendationsResponse -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: ListRecommendationsResponse -> ListRecommendationsResponse -> Bool
$c/= :: ListRecommendationsResponse -> ListRecommendationsResponse -> Bool
== :: ListRecommendationsResponse -> ListRecommendationsResponse -> Bool
$c== :: ListRecommendationsResponse -> ListRecommendationsResponse -> Bool
Prelude.Eq, ReadPrec [ListRecommendationsResponse]
ReadPrec ListRecommendationsResponse
Int -> ReadS ListRecommendationsResponse
ReadS [ListRecommendationsResponse]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [ListRecommendationsResponse]
$creadListPrec :: ReadPrec [ListRecommendationsResponse]
readPrec :: ReadPrec ListRecommendationsResponse
$creadPrec :: ReadPrec ListRecommendationsResponse
readList :: ReadS [ListRecommendationsResponse]
$creadList :: ReadS [ListRecommendationsResponse]
readsPrec :: Int -> ReadS ListRecommendationsResponse
$creadsPrec :: Int -> ReadS ListRecommendationsResponse
Prelude.Read, Int -> ListRecommendationsResponse -> ShowS
[ListRecommendationsResponse] -> ShowS
ListRecommendationsResponse -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [ListRecommendationsResponse] -> ShowS
$cshowList :: [ListRecommendationsResponse] -> ShowS
show :: ListRecommendationsResponse -> String
$cshow :: ListRecommendationsResponse -> String
showsPrec :: Int -> ListRecommendationsResponse -> ShowS
$cshowsPrec :: Int -> ListRecommendationsResponse -> ShowS
Prelude.Show, forall x.
Rep ListRecommendationsResponse x -> ListRecommendationsResponse
forall x.
ListRecommendationsResponse -> Rep ListRecommendationsResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep ListRecommendationsResponse x -> ListRecommendationsResponse
$cfrom :: forall x.
ListRecommendationsResponse -> Rep ListRecommendationsResponse x
Prelude.Generic)

-- |
-- Create a value of 'ListRecommendationsResponse' with all optional fields omitted.
--
-- Use <https://hackage.haskell.org/package/generic-lens generic-lens> or <https://hackage.haskell.org/package/optics optics> to modify other optional fields.
--
-- The following record fields are available, with the corresponding lenses provided
-- for backwards compatibility:
--
-- 'nextToken', 'listRecommendationsResponse_nextToken' - Pagination token.
--
-- 'recommendationSummaries', 'listRecommendationsResponse_recommendationSummaries' - List of recommendations for the requested code review.
--
-- 'httpStatus', 'listRecommendationsResponse_httpStatus' - The response's http status code.
newListRecommendationsResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  ListRecommendationsResponse
newListRecommendationsResponse :: Int -> ListRecommendationsResponse
newListRecommendationsResponse Int
pHttpStatus_ =
  ListRecommendationsResponse'
    { $sel:nextToken:ListRecommendationsResponse' :: Maybe Text
nextToken =
        forall a. Maybe a
Prelude.Nothing,
      $sel:recommendationSummaries:ListRecommendationsResponse' :: Maybe [RecommendationSummary]
recommendationSummaries = forall a. Maybe a
Prelude.Nothing,
      $sel:httpStatus:ListRecommendationsResponse' :: Int
httpStatus = Int
pHttpStatus_
    }

-- | Pagination token.
listRecommendationsResponse_nextToken :: Lens.Lens' ListRecommendationsResponse (Prelude.Maybe Prelude.Text)
listRecommendationsResponse_nextToken :: Lens' ListRecommendationsResponse (Maybe Text)
listRecommendationsResponse_nextToken = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListRecommendationsResponse' {Maybe Text
nextToken :: Maybe Text
$sel:nextToken:ListRecommendationsResponse' :: ListRecommendationsResponse -> Maybe Text
nextToken} -> Maybe Text
nextToken) (\s :: ListRecommendationsResponse
s@ListRecommendationsResponse' {} Maybe Text
a -> ListRecommendationsResponse
s {$sel:nextToken:ListRecommendationsResponse' :: Maybe Text
nextToken = Maybe Text
a} :: ListRecommendationsResponse)

-- | List of recommendations for the requested code review.
listRecommendationsResponse_recommendationSummaries :: Lens.Lens' ListRecommendationsResponse (Prelude.Maybe [RecommendationSummary])
listRecommendationsResponse_recommendationSummaries :: Lens' ListRecommendationsResponse (Maybe [RecommendationSummary])
listRecommendationsResponse_recommendationSummaries = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListRecommendationsResponse' {Maybe [RecommendationSummary]
recommendationSummaries :: Maybe [RecommendationSummary]
$sel:recommendationSummaries:ListRecommendationsResponse' :: ListRecommendationsResponse -> Maybe [RecommendationSummary]
recommendationSummaries} -> Maybe [RecommendationSummary]
recommendationSummaries) (\s :: ListRecommendationsResponse
s@ListRecommendationsResponse' {} Maybe [RecommendationSummary]
a -> ListRecommendationsResponse
s {$sel:recommendationSummaries:ListRecommendationsResponse' :: Maybe [RecommendationSummary]
recommendationSummaries = Maybe [RecommendationSummary]
a} :: ListRecommendationsResponse) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall (f :: * -> *) (g :: * -> *) s t a b.
(Functor f, Functor g) =>
AnIso s t a b -> Iso (f s) (g t) (f a) (g b)
Lens.mapping forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

-- | The response's http status code.
listRecommendationsResponse_httpStatus :: Lens.Lens' ListRecommendationsResponse Prelude.Int
listRecommendationsResponse_httpStatus :: Lens' ListRecommendationsResponse Int
listRecommendationsResponse_httpStatus = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListRecommendationsResponse' {Int
httpStatus :: Int
$sel:httpStatus:ListRecommendationsResponse' :: ListRecommendationsResponse -> Int
httpStatus} -> Int
httpStatus) (\s :: ListRecommendationsResponse
s@ListRecommendationsResponse' {} Int
a -> ListRecommendationsResponse
s {$sel:httpStatus:ListRecommendationsResponse' :: Int
httpStatus = Int
a} :: ListRecommendationsResponse)

instance Prelude.NFData ListRecommendationsResponse where
  rnf :: ListRecommendationsResponse -> ()
rnf ListRecommendationsResponse' {Int
Maybe [RecommendationSummary]
Maybe Text
httpStatus :: Int
recommendationSummaries :: Maybe [RecommendationSummary]
nextToken :: Maybe Text
$sel:httpStatus:ListRecommendationsResponse' :: ListRecommendationsResponse -> Int
$sel:recommendationSummaries:ListRecommendationsResponse' :: ListRecommendationsResponse -> Maybe [RecommendationSummary]
$sel:nextToken:ListRecommendationsResponse' :: ListRecommendationsResponse -> Maybe Text
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
nextToken
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe [RecommendationSummary]
recommendationSummaries
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Int
httpStatus