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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists all the code reviews that the customer has created in the past 90 days.

Synopsis

data ListCodeReviews = ListCodeReviews' {
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- providerTypes :: Maybe (NonEmpty ProviderType)
- repositoryNames :: Maybe (NonEmpty Text)
- states :: Maybe (NonEmpty JobState)
- type' :: Type
}
newListCodeReviews :: Type -> ListCodeReviews
listCodeReviews_maxResults :: Lens' ListCodeReviews (Maybe Natural)
listCodeReviews_nextToken :: Lens' ListCodeReviews (Maybe Text)
listCodeReviews_providerTypes :: Lens' ListCodeReviews (Maybe (NonEmpty ProviderType))
listCodeReviews_repositoryNames :: Lens' ListCodeReviews (Maybe (NonEmpty Text))
listCodeReviews_states :: Lens' ListCodeReviews (Maybe (NonEmpty JobState))
listCodeReviews_type :: Lens' ListCodeReviews Type
data ListCodeReviewsResponse = ListCodeReviewsResponse' {
- codeReviewSummaries :: Maybe [CodeReviewSummary]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newListCodeReviewsResponse :: Int -> ListCodeReviewsResponse
listCodeReviewsResponse_codeReviewSummaries :: Lens' ListCodeReviewsResponse (Maybe [CodeReviewSummary])
listCodeReviewsResponse_nextToken :: Lens' ListCodeReviewsResponse (Maybe Text)
listCodeReviewsResponse_httpStatus :: Lens' ListCodeReviewsResponse Int

Creating a Request

data ListCodeReviews Source #

See: newListCodeReviews smart constructor.

Constructors

ListCodeReviews'

Fields

maxResults :: Maybe Natural
The maximum number of results that are returned per call. The default is 100.
nextToken :: Maybe Text
If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.
providerTypes :: Maybe (NonEmpty ProviderType)
List of provider types for filtering that needs to be applied before displaying the result. For example, providerTypes=[GitHub] lists code reviews from GitHub.
repositoryNames :: Maybe (NonEmpty Text)
List of repository names for filtering that needs to be applied before displaying the result.
states :: Maybe (NonEmpty JobState)
List of states for filtering that needs to be applied before displaying the result. For example, states=[Pending] lists code reviews in the Pending state.
The valid code review states are:
- Completed: The code review is complete.
- Pending: The code review started and has not completed or failed.
- Failed: The code review failed.
- Deleting: The code review is being deleted.
type' :: Type
The type of code reviews to list in the response.

Instances

Instances details

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

newListCodeReviews Source #

Arguments

:: Type	`ListCodeReviews`
-> ListCodeReviews

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

ListCodeReviews, listCodeReviews_nextToken - If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

$sel:providerTypes:ListCodeReviews', listCodeReviews_providerTypes - List of provider types for filtering that needs to be applied before displaying the result. For example, providerTypes=[GitHub] lists code reviews from GitHub.

$sel:repositoryNames:ListCodeReviews', listCodeReviews_repositoryNames - List of repository names for filtering that needs to be applied before displaying the result.

$sel:states:ListCodeReviews', listCodeReviews_states - List of states for filtering that needs to be applied before displaying the result. For example, states=[Pending] lists code reviews in the Pending state.

The valid code review states are:

Completed: The code review is complete.
Pending: The code review started and has not completed or failed.
Failed: The code review failed.
Deleting: The code review is being deleted.

ListCodeReviews, listCodeReviews_type - The type of code reviews to list in the response.

Request Lenses

listCodeReviews_maxResults :: Lens' ListCodeReviews (Maybe Natural) Source #

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

listCodeReviews_nextToken :: Lens' ListCodeReviews (Maybe Text) Source #

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

listCodeReviews_providerTypes :: Lens' ListCodeReviews (Maybe (NonEmpty ProviderType)) Source #

List of provider types for filtering that needs to be applied before displaying the result. For example, providerTypes=[GitHub] lists code reviews from GitHub.

listCodeReviews_repositoryNames :: Lens' ListCodeReviews (Maybe (NonEmpty Text)) Source #

List of repository names for filtering that needs to be applied before displaying the result.

listCodeReviews_states :: Lens' ListCodeReviews (Maybe (NonEmpty JobState)) Source #

List of states for filtering that needs to be applied before displaying the result. For example, states=[Pending] lists code reviews in the Pending state.

The valid code review states are:

Completed: The code review is complete.
Pending: The code review started and has not completed or failed.
Failed: The code review failed.
Deleting: The code review is being deleted.

listCodeReviews_type :: Lens' ListCodeReviews Type Source #

The type of code reviews to list in the response.

Destructuring the Response

data ListCodeReviewsResponse Source #

See: newListCodeReviewsResponse smart constructor.

Constructors

ListCodeReviewsResponse'
Fields codeReviewSummaries :: Maybe [CodeReviewSummary] A list of code reviews that meet the criteria of the request. nextToken :: Maybe Text Pagination token. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newListCodeReviewsResponse Source #

Arguments

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

Create a value of ListCodeReviewsResponse 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:codeReviewSummaries:ListCodeReviewsResponse', listCodeReviewsResponse_codeReviewSummaries - A list of code reviews that meet the criteria of the request.

ListCodeReviews, listCodeReviewsResponse_nextToken - Pagination token.

$sel:httpStatus:ListCodeReviewsResponse', listCodeReviewsResponse_httpStatus - The response's http status code.

Response Lenses

listCodeReviewsResponse_codeReviewSummaries :: Lens' ListCodeReviewsResponse (Maybe [CodeReviewSummary]) Source #

A list of code reviews that meet the criteria of the request.

listCodeReviewsResponse_nextToken :: Lens' ListCodeReviewsResponse (Maybe Text) Source #

Pagination token.

listCodeReviewsResponse_httpStatus :: Lens' ListCodeReviewsResponse Int Source #

The response's http status code.