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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Use to create a code review with a CodeReviewType of RepositoryAnalysis. This type of code review analyzes all code under a specified branch in an associated repository. PullRequest code reviews are automatically triggered by a pull request.

Creating a Request

data CreateCodeReview Source #

See: newCreateCodeReview smart constructor.

Constructors

CreateCodeReview'

Fields

clientRequestToken :: Maybe Text
Amazon CodeGuru Reviewer uses this value to prevent the accidental creation of duplicate code reviews if there are failures and retries.
name :: Text
The name of the code review. The name of each code review in your Amazon Web Services account must be unique.
repositoryAssociationArn :: Text
The Amazon Resource Name (ARN) of the RepositoryAssociation object. You can retrieve this ARN by calling ListRepositoryAssociations.
A code review can only be created on an associated repository. This is the ARN of the associated repository.
type' :: CodeReviewType
The type of code review to create. This is specified using a CodeReviewType object. You can create a code review only of type RepositoryAnalysis.

Instances

Instances details

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

newCreateCodeReview Source #

Arguments

:: Text	`CreateCodeReview`
-> Text	`$sel:repositoryAssociationArn:CreateCodeReview'`
-> CodeReviewType	`CreateCodeReview`
-> CreateCodeReview

Create a value of CreateCodeReview 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:clientRequestToken:CreateCodeReview', createCodeReview_clientRequestToken - Amazon CodeGuru Reviewer uses this value to prevent the accidental creation of duplicate code reviews if there are failures and retries.

CreateCodeReview, createCodeReview_name - The name of the code review. The name of each code review in your Amazon Web Services account must be unique.

$sel:repositoryAssociationArn:CreateCodeReview', createCodeReview_repositoryAssociationArn - The Amazon Resource Name (ARN) of the RepositoryAssociation object. You can retrieve this ARN by calling ListRepositoryAssociations.

A code review can only be created on an associated repository. This is the ARN of the associated repository.

CreateCodeReview, createCodeReview_type - The type of code review to create. This is specified using a CodeReviewType object. You can create a code review only of type RepositoryAnalysis.

Request Lenses

createCodeReview_clientRequestToken :: Lens' CreateCodeReview (Maybe Text) Source #

Amazon CodeGuru Reviewer uses this value to prevent the accidental creation of duplicate code reviews if there are failures and retries.

createCodeReview_name :: Lens' CreateCodeReview Text Source #

The name of the code review. The name of each code review in your Amazon Web Services account must be unique.

createCodeReview_repositoryAssociationArn :: Lens' CreateCodeReview Text Source #

The Amazon Resource Name (ARN) of the RepositoryAssociation object. You can retrieve this ARN by calling ListRepositoryAssociations.

A code review can only be created on an associated repository. This is the ARN of the associated repository.

createCodeReview_type :: Lens' CreateCodeReview CodeReviewType Source #

The type of code review to create. This is specified using a CodeReviewType object. You can create a code review only of type RepositoryAnalysis.

Destructuring the Response

data CreateCodeReviewResponse Source #

See: newCreateCodeReviewResponse smart constructor.

Constructors

CreateCodeReviewResponse'
Fields codeReview :: Maybe CodeReview httpStatus :: Int The response's http status code.

Instances

Instances details

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

newCreateCodeReviewResponse Source #

Arguments

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

Create a value of CreateCodeReviewResponse 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:codeReview:CreateCodeReviewResponse', createCodeReviewResponse_codeReview - Undocumented member.

$sel:httpStatus:CreateCodeReviewResponse', createCodeReviewResponse_httpStatus - The response's http status code.

Response Lenses

createCodeReviewResponse_codeReview :: Lens' CreateCodeReviewResponse (Maybe CodeReview) Source #

Undocumented member.

createCodeReviewResponse_httpStatus :: Lens' CreateCodeReviewResponse Int Source #

The response's http status code.