| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.CodeGuruReviewer
Contents
- Service Configuration
- Errors
- Waiters
- Operations
- ListRecommendationFeedback
- ListTagsForResource
- DisassociateRepository
- DescribeRepositoryAssociation
- DescribeCodeReview
- ListRepositoryAssociations (Paginated)
- DescribeRecommendationFeedback
- ListRecommendations
- TagResource
- CreateCodeReview
- UntagResource
- ListCodeReviews
- AssociateRepository
- PutRecommendationFeedback
- Types
- AnalysisType
- EncryptionOption
- JobState
- ProviderType
- Reaction
- RecommendationCategory
- RepositoryAssociationState
- Severity
- Type
- VendorName
- BranchDiffSourceCodeType
- CodeArtifacts
- CodeCommitRepository
- CodeReview
- CodeReviewSummary
- CodeReviewType
- CommitDiffSourceCodeType
- EventInfo
- KMSKeyDetails
- Metrics
- MetricsSummary
- RecommendationFeedback
- RecommendationFeedbackSummary
- RecommendationSummary
- Repository
- RepositoryAnalysis
- RepositoryAssociation
- RepositoryAssociationSummary
- RepositoryHeadSourceCodeType
- RequestMetadata
- RuleMetadata
- S3BucketRepository
- S3Repository
- S3RepositoryDetails
- SourceCodeType
- ThirdPartySourceRepository
Description
Derived from API version 2019-09-19 of the AWS service descriptions, licensed under Apache 2.0.
This section provides documentation for the Amazon CodeGuru Reviewer API operations. CodeGuru Reviewer is a service that uses program analysis and machine learning to detect potential defects that are difficult for developers to find and recommends fixes in your Java and Python code.
By proactively detecting and providing recommendations for addressing code defects and implementing best practices, CodeGuru Reviewer improves the overall quality and maintainability of your code base during the code review stage. For more information about CodeGuru Reviewer, see the <https:docs.aws.amazon.comcodegurulatestreviewer-ugwelcome.html Amazon CodeGuru Reviewer User Guide>.
To improve the security of your CodeGuru Reviewer API calls, you can establish a private connection between your VPC and CodeGuru Reviewer by creating an interface VPC endpoint. For more information, see CodeGuru Reviewer and interface VPC endpoints (Amazon Web Services PrivateLink) in the Amazon CodeGuru Reviewer User Guide.
Synopsis
- defaultService :: Service
- _ValidationException :: AsError a => Getting (First ServiceError) a ServiceError
- _AccessDeniedException :: AsError a => Getting (First ServiceError) a ServiceError
- _ConflictException :: AsError a => Getting (First ServiceError) a ServiceError
- _NotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _ThrottlingException :: AsError a => Getting (First ServiceError) a ServiceError
- _InternalServerException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- newCodeReviewCompleted :: Wait DescribeCodeReview
- newRepositoryAssociationSucceeded :: Wait DescribeRepositoryAssociation
- data ListRecommendationFeedback = ListRecommendationFeedback' (Maybe (NonEmpty Text)) (Maybe Text) (Maybe (NonEmpty Text)) (Maybe Natural) Text
- newListRecommendationFeedback :: Text -> ListRecommendationFeedback
- data ListRecommendationFeedbackResponse = ListRecommendationFeedbackResponse' (Maybe Text) (Maybe [RecommendationFeedbackSummary]) Int
- newListRecommendationFeedbackResponse :: Int -> ListRecommendationFeedbackResponse
- data ListTagsForResource = ListTagsForResource' Text
- newListTagsForResource :: Text -> ListTagsForResource
- data ListTagsForResourceResponse = ListTagsForResourceResponse' (Maybe (HashMap Text Text)) Int
- newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
- data DisassociateRepository = DisassociateRepository' Text
- newDisassociateRepository :: Text -> DisassociateRepository
- data DisassociateRepositoryResponse = DisassociateRepositoryResponse' (Maybe RepositoryAssociation) (Maybe (HashMap Text Text)) Int
- newDisassociateRepositoryResponse :: Int -> DisassociateRepositoryResponse
- data DescribeRepositoryAssociation = DescribeRepositoryAssociation' Text
- newDescribeRepositoryAssociation :: Text -> DescribeRepositoryAssociation
- data DescribeRepositoryAssociationResponse = DescribeRepositoryAssociationResponse' (Maybe RepositoryAssociation) (Maybe (HashMap Text Text)) Int
- newDescribeRepositoryAssociationResponse :: Int -> DescribeRepositoryAssociationResponse
- data DescribeCodeReview = DescribeCodeReview' Text
- newDescribeCodeReview :: Text -> DescribeCodeReview
- data DescribeCodeReviewResponse = DescribeCodeReviewResponse' (Maybe CodeReview) Int
- newDescribeCodeReviewResponse :: Int -> DescribeCodeReviewResponse
- data ListRepositoryAssociations = ListRepositoryAssociations' (Maybe (NonEmpty RepositoryAssociationState)) (Maybe (NonEmpty Text)) (Maybe (NonEmpty ProviderType)) (Maybe Text) (Maybe (NonEmpty Text)) (Maybe Natural)
- newListRepositoryAssociations :: ListRepositoryAssociations
- data ListRepositoryAssociationsResponse = ListRepositoryAssociationsResponse' (Maybe Text) (Maybe [RepositoryAssociationSummary]) Int
- newListRepositoryAssociationsResponse :: Int -> ListRepositoryAssociationsResponse
- data DescribeRecommendationFeedback = DescribeRecommendationFeedback' (Maybe Text) Text Text
- newDescribeRecommendationFeedback :: Text -> Text -> DescribeRecommendationFeedback
- data DescribeRecommendationFeedbackResponse = DescribeRecommendationFeedbackResponse' (Maybe RecommendationFeedback) Int
- newDescribeRecommendationFeedbackResponse :: Int -> DescribeRecommendationFeedbackResponse
- data ListRecommendations = ListRecommendations' (Maybe Text) (Maybe Natural) Text
- newListRecommendations :: Text -> ListRecommendations
- data ListRecommendationsResponse = ListRecommendationsResponse' (Maybe Text) (Maybe [RecommendationSummary]) Int
- newListRecommendationsResponse :: Int -> ListRecommendationsResponse
- data TagResource = TagResource' Text (HashMap Text Text)
- newTagResource :: Text -> TagResource
- data TagResourceResponse = TagResourceResponse' Int
- newTagResourceResponse :: Int -> TagResourceResponse
- data CreateCodeReview = CreateCodeReview' (Maybe Text) Text Text CodeReviewType
- newCreateCodeReview :: Text -> Text -> CodeReviewType -> CreateCodeReview
- data CreateCodeReviewResponse = CreateCodeReviewResponse' (Maybe CodeReview) Int
- newCreateCodeReviewResponse :: Int -> CreateCodeReviewResponse
- data UntagResource = UntagResource' Text (NonEmpty Text)
- newUntagResource :: Text -> NonEmpty Text -> UntagResource
- data UntagResourceResponse = UntagResourceResponse' Int
- newUntagResourceResponse :: Int -> UntagResourceResponse
- data ListCodeReviews = ListCodeReviews' (Maybe (NonEmpty JobState)) (Maybe (NonEmpty ProviderType)) (Maybe (NonEmpty Text)) (Maybe Text) (Maybe Natural) Type
- newListCodeReviews :: Type -> ListCodeReviews
- data ListCodeReviewsResponse = ListCodeReviewsResponse' (Maybe [CodeReviewSummary]) (Maybe Text) Int
- newListCodeReviewsResponse :: Int -> ListCodeReviewsResponse
- data AssociateRepository = AssociateRepository' (Maybe KMSKeyDetails) (Maybe Text) (Maybe (HashMap Text Text)) Repository
- newAssociateRepository :: Repository -> AssociateRepository
- data AssociateRepositoryResponse = AssociateRepositoryResponse' (Maybe RepositoryAssociation) (Maybe (HashMap Text Text)) Int
- newAssociateRepositoryResponse :: Int -> AssociateRepositoryResponse
- data PutRecommendationFeedback = PutRecommendationFeedback' Text Text [Reaction]
- newPutRecommendationFeedback :: Text -> Text -> PutRecommendationFeedback
- data PutRecommendationFeedbackResponse = PutRecommendationFeedbackResponse' Int
- newPutRecommendationFeedbackResponse :: Int -> PutRecommendationFeedbackResponse
- newtype AnalysisType where
- AnalysisType' { }
- pattern AnalysisType_CodeQuality :: AnalysisType
- pattern AnalysisType_Security :: AnalysisType
- newtype EncryptionOption where
- newtype JobState where
- JobState' {
- fromJobState :: Text
- pattern JobState_Completed :: JobState
- pattern JobState_Deleting :: JobState
- pattern JobState_Failed :: JobState
- pattern JobState_Pending :: JobState
- JobState' {
- newtype ProviderType where
- ProviderType' { }
- pattern ProviderType_Bitbucket :: ProviderType
- pattern ProviderType_CodeCommit :: ProviderType
- pattern ProviderType_GitHub :: ProviderType
- pattern ProviderType_GitHubEnterpriseServer :: ProviderType
- pattern ProviderType_S3Bucket :: ProviderType
- newtype Reaction where
- Reaction' {
- fromReaction :: Text
- pattern Reaction_ThumbsDown :: Reaction
- pattern Reaction_ThumbsUp :: Reaction
- Reaction' {
- newtype RecommendationCategory where
- RecommendationCategory' { }
- pattern RecommendationCategory_AWSBestPractices :: RecommendationCategory
- pattern RecommendationCategory_AWSCloudFormationIssues :: RecommendationCategory
- pattern RecommendationCategory_CodeInconsistencies :: RecommendationCategory
- pattern RecommendationCategory_CodeMaintenanceIssues :: RecommendationCategory
- pattern RecommendationCategory_ConcurrencyIssues :: RecommendationCategory
- pattern RecommendationCategory_DuplicateCode :: RecommendationCategory
- pattern RecommendationCategory_InputValidations :: RecommendationCategory
- pattern RecommendationCategory_JavaBestPractices :: RecommendationCategory
- pattern RecommendationCategory_PythonBestPractices :: RecommendationCategory
- pattern RecommendationCategory_ResourceLeaks :: RecommendationCategory
- pattern RecommendationCategory_SecurityIssues :: RecommendationCategory
- newtype RepositoryAssociationState where
- RepositoryAssociationState' { }
- pattern RepositoryAssociationState_Associated :: RepositoryAssociationState
- pattern RepositoryAssociationState_Associating :: RepositoryAssociationState
- pattern RepositoryAssociationState_Disassociated :: RepositoryAssociationState
- pattern RepositoryAssociationState_Disassociating :: RepositoryAssociationState
- pattern RepositoryAssociationState_Failed :: RepositoryAssociationState
- newtype Severity where
- Severity' {
- fromSeverity :: Text
- pattern Severity_Critical :: Severity
- pattern Severity_High :: Severity
- pattern Severity_Info :: Severity
- pattern Severity_Low :: Severity
- pattern Severity_Medium :: Severity
- Severity' {
- newtype Type where
- Type' { }
- pattern Type_PullRequest :: Type
- pattern Type_RepositoryAnalysis :: Type
- newtype VendorName where
- VendorName' { }
- pattern VendorName_GitHub :: VendorName
- pattern VendorName_GitLab :: VendorName
- pattern VendorName_NativeS3 :: VendorName
- data BranchDiffSourceCodeType = BranchDiffSourceCodeType' Text Text
- newBranchDiffSourceCodeType :: Text -> Text -> BranchDiffSourceCodeType
- data CodeArtifacts = CodeArtifacts' (Maybe Text) Text
- newCodeArtifacts :: Text -> CodeArtifacts
- data CodeCommitRepository = CodeCommitRepository' Text
- newCodeCommitRepository :: Text -> CodeCommitRepository
- data CodeReview = CodeReview' (Maybe Text) (Maybe JobState) (Maybe Metrics) (Maybe Text) (Maybe ProviderType) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Type) (Maybe SourceCodeType) (Maybe Text) (Maybe POSIX) (Maybe [AnalysisType]) (Maybe POSIX)
- newCodeReview :: CodeReview
- data CodeReviewSummary = CodeReviewSummary' (Maybe JobState) (Maybe Text) (Maybe ProviderType) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Type) (Maybe SourceCodeType) (Maybe MetricsSummary) (Maybe POSIX) (Maybe POSIX)
- newCodeReviewSummary :: CodeReviewSummary
- data CodeReviewType = CodeReviewType' (Maybe [AnalysisType]) RepositoryAnalysis
- newCodeReviewType :: RepositoryAnalysis -> CodeReviewType
- data CommitDiffSourceCodeType = CommitDiffSourceCodeType' (Maybe Text) (Maybe Text) (Maybe Text)
- newCommitDiffSourceCodeType :: CommitDiffSourceCodeType
- data EventInfo = EventInfo' (Maybe Text) (Maybe Text)
- newEventInfo :: EventInfo
- data KMSKeyDetails = KMSKeyDetails' (Maybe EncryptionOption) (Maybe Text)
- newKMSKeyDetails :: KMSKeyDetails
- data Metrics = Metrics' (Maybe Integer) (Maybe Integer)
- newMetrics :: Metrics
- data MetricsSummary = MetricsSummary' (Maybe Integer) (Maybe Integer)
- newMetricsSummary :: MetricsSummary
- data RecommendationFeedback = RecommendationFeedback' (Maybe Text) (Maybe Text) (Maybe [Reaction]) (Maybe Text) (Maybe POSIX) (Maybe POSIX)
- newRecommendationFeedback :: RecommendationFeedback
- data RecommendationFeedbackSummary = RecommendationFeedbackSummary' (Maybe Text) (Maybe Text) (Maybe [Reaction])
- newRecommendationFeedbackSummary :: RecommendationFeedbackSummary
- data RecommendationSummary = RecommendationSummary' (Maybe Text) (Maybe Text) (Maybe Severity) (Maybe RuleMetadata) (Maybe Int) (Maybe Int) (Maybe Text) (Maybe RecommendationCategory)
- newRecommendationSummary :: RecommendationSummary
- data Repository = Repository' (Maybe CodeCommitRepository) (Maybe ThirdPartySourceRepository) (Maybe S3Repository) (Maybe ThirdPartySourceRepository)
- newRepository :: Repository
- data RepositoryAnalysis = RepositoryAnalysis' (Maybe RepositoryHeadSourceCodeType) (Maybe SourceCodeType)
- newRepositoryAnalysis :: RepositoryAnalysis
- data RepositoryAssociation = RepositoryAssociation' (Maybe Text) (Maybe Text) (Maybe RepositoryAssociationState) (Maybe S3RepositoryDetails) (Maybe ProviderType) (Maybe Text) (Maybe Text) (Maybe KMSKeyDetails) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe POSIX)
- newRepositoryAssociation :: RepositoryAssociation
- data RepositoryAssociationSummary = RepositoryAssociationSummary' (Maybe Text) (Maybe Text) (Maybe RepositoryAssociationState) (Maybe ProviderType) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX)
- newRepositoryAssociationSummary :: RepositoryAssociationSummary
- data RepositoryHeadSourceCodeType = RepositoryHeadSourceCodeType' Text
- newRepositoryHeadSourceCodeType :: Text -> RepositoryHeadSourceCodeType
- data RequestMetadata = RequestMetadata' (Maybe Text) (Maybe EventInfo) (Maybe VendorName) (Maybe Text)
- newRequestMetadata :: RequestMetadata
- data RuleMetadata = RuleMetadata' (Maybe Text) (Maybe (NonEmpty Text)) (Maybe Text) (Maybe Text) (Maybe Text)
- newRuleMetadata :: RuleMetadata
- data S3BucketRepository = S3BucketRepository' (Maybe S3RepositoryDetails) Text
- newS3BucketRepository :: Text -> S3BucketRepository
- data S3Repository = S3Repository' Text Text
- newS3Repository :: Text -> Text -> S3Repository
- data S3RepositoryDetails = S3RepositoryDetails' (Maybe CodeArtifacts) (Maybe Text)
- newS3RepositoryDetails :: S3RepositoryDetails
- data SourceCodeType = SourceCodeType' (Maybe S3BucketRepository) (Maybe RequestMetadata) (Maybe RepositoryHeadSourceCodeType) (Maybe CommitDiffSourceCodeType) (Maybe BranchDiffSourceCodeType)
- newSourceCodeType :: SourceCodeType
- data ThirdPartySourceRepository = ThirdPartySourceRepository' Text Text Text
- newThirdPartySourceRepository :: Text -> Text -> Text -> ThirdPartySourceRepository
Service Configuration
defaultService :: Service Source #
API version 2019-09-19 of the Amazon CodeGuru Reviewer SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by CodeGuruReviewer.
ValidationException
_ValidationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The input fails to satisfy the specified constraints.
AccessDeniedException
_AccessDeniedException :: AsError a => Getting (First ServiceError) a ServiceError Source #
You do not have sufficient access to perform this action.
ConflictException
_ConflictException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.
NotFoundException
_NotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The resource specified in the request was not found.
ThrottlingException
_ThrottlingException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request was denied due to request throttling.
InternalServerException
_InternalServerException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The server encountered an internal error and is unable to complete the request.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The resource specified in the request was not found.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait specification is fulfilled. The Wait specification
determines how many attempts should be made, in addition to delay and retry strategies.
CodeReviewCompleted
newCodeReviewCompleted :: Wait DescribeCodeReview Source #
Polls DescribeCodeReview every 10 seconds until a successful state is reached. An error is returned after 60 failed checks.
RepositoryAssociationSucceeded
newRepositoryAssociationSucceeded :: Wait DescribeRepositoryAssociation Source #
Polls DescribeRepositoryAssociation every 10 seconds until a successful state is reached. An error is returned after 20 failed checks.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
ListRecommendationFeedback
data ListRecommendationFeedback Source #
See: newListRecommendationFeedback smart constructor.
Constructors
| ListRecommendationFeedback' (Maybe (NonEmpty Text)) (Maybe Text) (Maybe (NonEmpty Text)) (Maybe Natural) Text |
Instances
newListRecommendationFeedback Source #
Create a value of ListRecommendationFeedback 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:userIds:ListRecommendationFeedback', listRecommendationFeedback_userIds - An Amazon Web Services user's account ID or Amazon Resource Name (ARN).
Use this ID to query the recommendation feedback for a code review from
that user.
The UserId is an IAM principal that can be specified as an Amazon Web
Services account ID or an Amazon Resource Name (ARN). For more
information, see
Specifying a Principal
in the Amazon Web Services Identity and Access Management User Guide.
$sel:nextToken:ListRecommendationFeedback', listRecommendationFeedback_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:recommendationIds:ListRecommendationFeedback', listRecommendationFeedback_recommendationIds - Used to query the recommendation feedback for a given recommendation.
$sel:maxResults:ListRecommendationFeedback', listRecommendationFeedback_maxResults - The maximum number of results that are returned per call. The default is
100.
$sel:codeReviewArn:ListRecommendationFeedback', listRecommendationFeedback_codeReviewArn - The Amazon Resource Name (ARN) of the
CodeReview
object.
data ListRecommendationFeedbackResponse Source #
See: newListRecommendationFeedbackResponse smart constructor.
Constructors
| ListRecommendationFeedbackResponse' (Maybe Text) (Maybe [RecommendationFeedbackSummary]) Int |
Instances
newListRecommendationFeedbackResponse Source #
Arguments
| :: Int | |
| -> ListRecommendationFeedbackResponse |
Create a value of ListRecommendationFeedbackResponse 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:nextToken:ListRecommendationFeedback', listRecommendationFeedbackResponse_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:recommendationFeedbackSummaries:ListRecommendationFeedbackResponse', listRecommendationFeedbackResponse_recommendationFeedbackSummaries - Recommendation feedback summaries corresponding to the code review ARN.
$sel:httpStatus:ListRecommendationFeedbackResponse', listRecommendationFeedbackResponse_httpStatus - The response's http status code.
ListTagsForResource
data ListTagsForResource Source #
See: newListTagsForResource smart constructor.
Constructors
| ListTagsForResource' Text |
Instances
newListTagsForResource Source #
Arguments
| :: Text | |
| -> ListTagsForResource |
Create a value of ListTagsForResource 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:resourceArn:ListTagsForResource', listTagsForResource_resourceArn - The Amazon Resource Name (ARN) of the
RepositoryAssociation
object. You can retrieve this ARN by calling
ListRepositoryAssociations
.
data ListTagsForResourceResponse Source #
See: newListTagsForResourceResponse smart constructor.
Instances
newListTagsForResourceResponse Source #
Create a value of ListTagsForResourceResponse 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:tags:ListTagsForResourceResponse', listTagsForResourceResponse_tags - An array of key-value pairs used to tag an associated repository. A tag
is a custom attribute label with two parts:
- A tag key (for example,
CostCenter,Environment,Project, orSecret). Tag keys are case sensitive. - An optional field known as a tag value (for example,
111122223333,Production, or a team name). Omitting the tag value is the same as using an empty string. Like tag keys, tag values are case sensitive.
$sel:httpStatus:ListTagsForResourceResponse', listTagsForResourceResponse_httpStatus - The response's http status code.
DisassociateRepository
data DisassociateRepository Source #
See: newDisassociateRepository smart constructor.
Constructors
| DisassociateRepository' Text |
Instances
newDisassociateRepository Source #
Create a value of DisassociateRepository 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:associationArn:DisassociateRepository', disassociateRepository_associationArn - The Amazon Resource Name (ARN) of the
RepositoryAssociation
object. You can retrieve this ARN by calling
ListRepositoryAssociations
.
data DisassociateRepositoryResponse Source #
See: newDisassociateRepositoryResponse smart constructor.
Constructors
| DisassociateRepositoryResponse' (Maybe RepositoryAssociation) (Maybe (HashMap Text Text)) Int |
Instances
newDisassociateRepositoryResponse Source #
Create a value of DisassociateRepositoryResponse 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:repositoryAssociation:DisassociateRepositoryResponse', disassociateRepositoryResponse_repositoryAssociation - Information about the disassociated repository.
$sel:tags:DisassociateRepositoryResponse', disassociateRepositoryResponse_tags - An array of key-value pairs used to tag an associated repository. A tag
is a custom attribute label with two parts:
- A tag key (for example,
CostCenter,Environment,Project, orSecret). Tag keys are case sensitive. - An optional field known as a tag value (for example,
111122223333,Production, or a team name). Omitting the tag value is the same as using an empty string. Like tag keys, tag values are case sensitive.
$sel:httpStatus:DisassociateRepositoryResponse', disassociateRepositoryResponse_httpStatus - The response's http status code.
DescribeRepositoryAssociation
data DescribeRepositoryAssociation Source #
See: newDescribeRepositoryAssociation smart constructor.
Constructors
| DescribeRepositoryAssociation' Text |
Instances
newDescribeRepositoryAssociation Source #
Create a value of DescribeRepositoryAssociation 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:associationArn:DescribeRepositoryAssociation', describeRepositoryAssociation_associationArn - The Amazon Resource Name (ARN) of the
RepositoryAssociation
object. You can retrieve this ARN by calling
ListRepositoryAssociations
.
data DescribeRepositoryAssociationResponse Source #
See: newDescribeRepositoryAssociationResponse smart constructor.
Constructors
| DescribeRepositoryAssociationResponse' (Maybe RepositoryAssociation) (Maybe (HashMap Text Text)) Int |
Instances
newDescribeRepositoryAssociationResponse Source #
Arguments
| :: Int | |
| -> DescribeRepositoryAssociationResponse |
Create a value of DescribeRepositoryAssociationResponse 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:repositoryAssociation:DescribeRepositoryAssociationResponse', describeRepositoryAssociationResponse_repositoryAssociation - Information about the repository association.
$sel:tags:DescribeRepositoryAssociationResponse', describeRepositoryAssociationResponse_tags - An array of key-value pairs used to tag an associated repository. A tag
is a custom attribute label with two parts:
- A tag key (for example,
CostCenter,Environment,Project, orSecret). Tag keys are case sensitive. - An optional field known as a tag value (for example,
111122223333,Production, or a team name). Omitting the tag value is the same as using an empty string. Like tag keys, tag values are case sensitive.
$sel:httpStatus:DescribeRepositoryAssociationResponse', describeRepositoryAssociationResponse_httpStatus - The response's http status code.
DescribeCodeReview
data DescribeCodeReview Source #
See: newDescribeCodeReview smart constructor.
Constructors
| DescribeCodeReview' Text |
Instances
newDescribeCodeReview Source #
Arguments
| :: Text | |
| -> DescribeCodeReview |
Create a value of DescribeCodeReview 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:codeReviewArn:DescribeCodeReview', describeCodeReview_codeReviewArn - The Amazon Resource Name (ARN) of the
CodeReview
object.
data DescribeCodeReviewResponse Source #
See: newDescribeCodeReviewResponse smart constructor.
Constructors
| DescribeCodeReviewResponse' (Maybe CodeReview) Int |
Instances
newDescribeCodeReviewResponse Source #
Create a value of DescribeCodeReviewResponse 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:DescribeCodeReviewResponse', describeCodeReviewResponse_codeReview - Information about the code review.
$sel:httpStatus:DescribeCodeReviewResponse', describeCodeReviewResponse_httpStatus - The response's http status code.
ListRepositoryAssociations (Paginated)
data ListRepositoryAssociations Source #
See: newListRepositoryAssociations smart constructor.
Constructors
| ListRepositoryAssociations' (Maybe (NonEmpty RepositoryAssociationState)) (Maybe (NonEmpty Text)) (Maybe (NonEmpty ProviderType)) (Maybe Text) (Maybe (NonEmpty Text)) (Maybe Natural) |
Instances
newListRepositoryAssociations :: ListRepositoryAssociations Source #
Create a value of ListRepositoryAssociations 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:states:ListRepositoryAssociations', listRepositoryAssociations_states - List of repository association states to use as a filter.
The valid repository association states are:
- Associated: The repository association is complete.
Associating: CodeGuru Reviewer is:
Setting up pull request notifications. This is required for pull requests to trigger a CodeGuru Reviewer review.
If your repository
ProviderTypeisGitHub,GitHub Enterprise Server, orBitbucket, CodeGuru Reviewer creates webhooks in your repository to trigger CodeGuru Reviewer reviews. If you delete these webhooks, reviews of code in your repository cannot be triggered.- Setting up source code access. This is required for CodeGuru Reviewer to securely clone code in your repository.
- Failed: The repository failed to associate or disassociate.
- Disassociating: CodeGuru Reviewer is removing the repository's pull request notifications and source code access.
- Disassociated: CodeGuru Reviewer successfully disassociated the repository. You can create a new association with this repository if you want to review source code in it later. You can control access to code reviews created in an associated repository with tags after it has been disassociated. For more information, see Using tags to control access to associated repositories in the Amazon CodeGuru Reviewer User Guide.
$sel:owners:ListRepositoryAssociations', listRepositoryAssociations_owners - List of owners to use as a filter. For Amazon Web Services CodeCommit,
it is the name of the CodeCommit account that was used to associate the
repository. For other repository source providers, such as Bitbucket and
GitHub Enterprise Server, this is name of the account that was used to
associate the repository.
$sel:providerTypes:ListRepositoryAssociations', listRepositoryAssociations_providerTypes - List of provider types to use as a filter.
$sel:nextToken:ListRepositoryAssociations', listRepositoryAssociations_nextToken - The nextToken value returned from a previous paginated
ListRepositoryAssociations request where maxResults was used and the
results exceeded the value of that parameter. Pagination continues from
the end of the previous results that returned the nextToken value.
Treat this token as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
$sel:names:ListRepositoryAssociations', listRepositoryAssociations_names - List of repository names to use as a filter.
$sel:maxResults:ListRepositoryAssociations', listRepositoryAssociations_maxResults - The maximum number of repository association results returned by
ListRepositoryAssociations in paginated output. When this parameter is
used, ListRepositoryAssociations only returns maxResults results in
a single page with a nextToken response element. The remaining results
of the initial request can be seen by sending another
ListRepositoryAssociations request with the returned nextToken
value. This value can be between 1 and 100. If this parameter is not
used, ListRepositoryAssociations returns up to 100 results and a
nextToken value if applicable.
data ListRepositoryAssociationsResponse Source #
See: newListRepositoryAssociationsResponse smart constructor.
Constructors
| ListRepositoryAssociationsResponse' (Maybe Text) (Maybe [RepositoryAssociationSummary]) Int |
Instances
newListRepositoryAssociationsResponse Source #
Arguments
| :: Int | |
| -> ListRepositoryAssociationsResponse |
Create a value of ListRepositoryAssociationsResponse 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:nextToken:ListRepositoryAssociations', listRepositoryAssociationsResponse_nextToken - The nextToken value to include in a future ListRecommendations
request. When the results of a ListRecommendations request exceed
maxResults, this value can be used to retrieve the next page of
results. This value is null when there are no more results to return.
$sel:repositoryAssociationSummaries:ListRepositoryAssociationsResponse', listRepositoryAssociationsResponse_repositoryAssociationSummaries - A list of repository associations that meet the criteria of the request.
$sel:httpStatus:ListRepositoryAssociationsResponse', listRepositoryAssociationsResponse_httpStatus - The response's http status code.
DescribeRecommendationFeedback
data DescribeRecommendationFeedback Source #
See: newDescribeRecommendationFeedback smart constructor.
Constructors
| DescribeRecommendationFeedback' (Maybe Text) Text Text |
Instances
newDescribeRecommendationFeedback Source #
Arguments
| :: Text | |
| -> Text | |
| -> DescribeRecommendationFeedback |
Create a value of DescribeRecommendationFeedback 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:userId:DescribeRecommendationFeedback', describeRecommendationFeedback_userId - Optional parameter to describe the feedback for a given user. If this is
not supplied, it defaults to the user making the request.
The UserId is an IAM principal that can be specified as an Amazon Web
Services account ID or an Amazon Resource Name (ARN). For more
information, see
Specifying a Principal
in the Amazon Web Services Identity and Access Management User Guide.
$sel:codeReviewArn:DescribeRecommendationFeedback', describeRecommendationFeedback_codeReviewArn - The Amazon Resource Name (ARN) of the
CodeReview
object.
$sel:recommendationId:DescribeRecommendationFeedback', describeRecommendationFeedback_recommendationId - The recommendation ID that can be used to track the provided
recommendations and then to collect the feedback.
data DescribeRecommendationFeedbackResponse Source #
See: newDescribeRecommendationFeedbackResponse smart constructor.
Instances
newDescribeRecommendationFeedbackResponse Source #
Arguments
| :: Int | |
| -> DescribeRecommendationFeedbackResponse |
Create a value of DescribeRecommendationFeedbackResponse 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:recommendationFeedback:DescribeRecommendationFeedbackResponse', describeRecommendationFeedbackResponse_recommendationFeedback - The recommendation feedback given by the user.
$sel:httpStatus:DescribeRecommendationFeedbackResponse', describeRecommendationFeedbackResponse_httpStatus - The response's http status code.
ListRecommendations
data ListRecommendations Source #
See: newListRecommendations smart constructor.
Instances
newListRecommendations Source #
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:nextToken:ListRecommendations', listRecommendations_nextToken - Pagination token.
$sel:maxResults:ListRecommendations', listRecommendations_maxResults - The maximum number of results that are returned per call. The default is
100.
$sel:codeReviewArn:ListRecommendations', listRecommendations_codeReviewArn - The Amazon Resource Name (ARN) of the
CodeReview
object.
data ListRecommendationsResponse Source #
See: newListRecommendationsResponse smart constructor.
Constructors
| ListRecommendationsResponse' (Maybe Text) (Maybe [RecommendationSummary]) Int |
Instances
newListRecommendationsResponse Source #
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:
$sel:nextToken: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.
TagResource
data TagResource Source #
See: newTagResource smart constructor.
Constructors
| TagResource' Text (HashMap Text Text) |
Instances
Arguments
| :: Text | |
| -> TagResource |
Create a value of TagResource 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:resourceArn:TagResource', tagResource_resourceArn - The Amazon Resource Name (ARN) of the
RepositoryAssociation
object. You can retrieve this ARN by calling
ListRepositoryAssociations
.
$sel:tags:TagResource', tagResource_tags - An array of key-value pairs used to tag an associated repository. A tag
is a custom attribute label with two parts:
- A tag key (for example,
CostCenter,Environment,Project, orSecret). Tag keys are case sensitive. - An optional field known as a tag value (for example,
111122223333,Production, or a team name). Omitting the tag value is the same as using an empty string. Like tag keys, tag values are case sensitive.
data TagResourceResponse Source #
See: newTagResourceResponse smart constructor.
Constructors
| TagResourceResponse' Int |
Instances
newTagResourceResponse Source #
Arguments
| :: Int | |
| -> TagResourceResponse |
Create a value of TagResourceResponse 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:TagResourceResponse', tagResourceResponse_httpStatus - The response's http status code.
CreateCodeReview
data CreateCodeReview Source #
See: newCreateCodeReview smart constructor.
Constructors
| CreateCodeReview' (Maybe Text) Text Text CodeReviewType |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> CodeReviewType | |
| -> 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.
$sel:name: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.
$sel:type':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.
data CreateCodeReviewResponse Source #
See: newCreateCodeReviewResponse smart constructor.
Constructors
| CreateCodeReviewResponse' (Maybe CodeReview) Int |
Instances
newCreateCodeReviewResponse Source #
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.
UntagResource
data UntagResource Source #
See: newUntagResource smart constructor.
Constructors
| UntagResource' Text (NonEmpty Text) |
Instances
Arguments
| :: Text | |
| -> NonEmpty Text | |
| -> UntagResource |
Create a value of UntagResource 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:resourceArn:UntagResource', untagResource_resourceArn - The Amazon Resource Name (ARN) of the
RepositoryAssociation
object. You can retrieve this ARN by calling
ListRepositoryAssociations
.
$sel:tagKeys:UntagResource', untagResource_tagKeys - A list of the keys for each tag you want to remove from an associated
repository.
data UntagResourceResponse Source #
See: newUntagResourceResponse smart constructor.
Constructors
| UntagResourceResponse' Int |
Instances
newUntagResourceResponse Source #
Create a value of UntagResourceResponse 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:UntagResourceResponse', untagResourceResponse_httpStatus - The response's http status code.
ListCodeReviews
data ListCodeReviews Source #
See: newListCodeReviews smart constructor.
Constructors
| ListCodeReviews' (Maybe (NonEmpty JobState)) (Maybe (NonEmpty ProviderType)) (Maybe (NonEmpty Text)) (Maybe Text) (Maybe Natural) Type |
Instances
Arguments
| :: Type | |
| -> 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: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.
$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:nextToken: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:maxResults:ListCodeReviews', listCodeReviews_maxResults - The maximum number of results that are returned per call. The default is
100.
$sel:type':ListCodeReviews', listCodeReviews_type - The type of code reviews to list in the response.
data ListCodeReviewsResponse Source #
See: newListCodeReviewsResponse smart constructor.
Constructors
| ListCodeReviewsResponse' (Maybe [CodeReviewSummary]) (Maybe Text) Int |
Instances
newListCodeReviewsResponse Source #
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.
$sel:nextToken:ListCodeReviews', listCodeReviewsResponse_nextToken - Pagination token.
$sel:httpStatus:ListCodeReviewsResponse', listCodeReviewsResponse_httpStatus - The response's http status code.
AssociateRepository
data AssociateRepository Source #
See: newAssociateRepository smart constructor.
Constructors
| AssociateRepository' (Maybe KMSKeyDetails) (Maybe Text) (Maybe (HashMap Text Text)) Repository |
Instances
newAssociateRepository Source #
Create a value of AssociateRepository 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:kmsKeyDetails:AssociateRepository', associateRepository_kmsKeyDetails - A KMSKeyDetails object that contains:
- The encryption option for this repository association. It is either
owned by Amazon Web Services Key Management Service (KMS)
(
AWS_OWNED_CMK) or customer managed (CUSTOMER_MANAGED_CMK). - The ID of the Amazon Web Services KMS key that is associated with this respository association.
$sel:clientRequestToken:AssociateRepository', associateRepository_clientRequestToken - Amazon CodeGuru Reviewer uses this value to prevent the accidental
creation of duplicate repository associations if there are failures and
retries.
$sel:tags:AssociateRepository', associateRepository_tags - An array of key-value pairs used to tag an associated repository. A tag
is a custom attribute label with two parts:
- A tag key (for example,
CostCenter,Environment,Project, orSecret). Tag keys are case sensitive. - An optional field known as a tag value (for example,
111122223333,Production, or a team name). Omitting the tag value is the same as using an empty string. Like tag keys, tag values are case sensitive.
$sel:repository:AssociateRepository', associateRepository_repository - The repository to associate.
data AssociateRepositoryResponse Source #
See: newAssociateRepositoryResponse smart constructor.
Constructors
| AssociateRepositoryResponse' (Maybe RepositoryAssociation) (Maybe (HashMap Text Text)) Int |
Instances
newAssociateRepositoryResponse Source #
Create a value of AssociateRepositoryResponse 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:repositoryAssociation:AssociateRepositoryResponse', associateRepositoryResponse_repositoryAssociation - Information about the repository association.
$sel:tags:AssociateRepository', associateRepositoryResponse_tags - An array of key-value pairs used to tag an associated repository. A tag
is a custom attribute label with two parts:
- A tag key (for example,
CostCenter,Environment,Project, orSecret). Tag keys are case sensitive. - An optional field known as a tag value (for example,
111122223333,Production, or a team name). Omitting the tag value is the same as using an empty string. Like tag keys, tag values are case sensitive.
$sel:httpStatus:AssociateRepositoryResponse', associateRepositoryResponse_httpStatus - The response's http status code.
PutRecommendationFeedback
data PutRecommendationFeedback Source #
See: newPutRecommendationFeedback smart constructor.
Constructors
| PutRecommendationFeedback' Text Text [Reaction] |
Instances
newPutRecommendationFeedback Source #
Arguments
| :: Text | |
| -> Text | |
| -> PutRecommendationFeedback |
Create a value of PutRecommendationFeedback 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:codeReviewArn:PutRecommendationFeedback', putRecommendationFeedback_codeReviewArn - The Amazon Resource Name (ARN) of the
CodeReview
object.
$sel:recommendationId:PutRecommendationFeedback', putRecommendationFeedback_recommendationId - The recommendation ID that can be used to track the provided
recommendations and then to collect the feedback.
$sel:reactions:PutRecommendationFeedback', putRecommendationFeedback_reactions - List for storing reactions. Reactions are utf-8 text code for emojis. If
you send an empty list it clears all your feedback.
data PutRecommendationFeedbackResponse Source #
See: newPutRecommendationFeedbackResponse smart constructor.
Constructors
| PutRecommendationFeedbackResponse' Int |
Instances
newPutRecommendationFeedbackResponse Source #
Arguments
| :: Int | |
| -> PutRecommendationFeedbackResponse |
Create a value of PutRecommendationFeedbackResponse 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:PutRecommendationFeedbackResponse', putRecommendationFeedbackResponse_httpStatus - The response's http status code.
Types
AnalysisType
newtype AnalysisType Source #
Constructors
| AnalysisType' | |
Fields | |
Bundled Patterns
| pattern AnalysisType_CodeQuality :: AnalysisType | |
| pattern AnalysisType_Security :: AnalysisType |
Instances
EncryptionOption
newtype EncryptionOption Source #
Constructors
| EncryptionOption' | |
Fields | |
Bundled Patterns
| pattern EncryptionOption_AWS_OWNED_CMK :: EncryptionOption | |
| pattern EncryptionOption_CUSTOMER_MANAGED_CMK :: EncryptionOption |
Instances
JobState
Constructors
| JobState' | |
Fields
| |
Bundled Patterns
| pattern JobState_Completed :: JobState | |
| pattern JobState_Deleting :: JobState | |
| pattern JobState_Failed :: JobState | |
| pattern JobState_Pending :: JobState |
Instances
ProviderType
newtype ProviderType Source #
Constructors
| ProviderType' | |
Fields | |
Bundled Patterns
| pattern ProviderType_Bitbucket :: ProviderType | |
| pattern ProviderType_CodeCommit :: ProviderType | |
| pattern ProviderType_GitHub :: ProviderType | |
| pattern ProviderType_GitHubEnterpriseServer :: ProviderType | |
| pattern ProviderType_S3Bucket :: ProviderType |
Instances
Reaction
Constructors
| Reaction' | |
Fields
| |
Bundled Patterns
| pattern Reaction_ThumbsDown :: Reaction | |
| pattern Reaction_ThumbsUp :: Reaction |
Instances
RecommendationCategory
newtype RecommendationCategory Source #
Constructors
| RecommendationCategory' | |
Fields | |
Bundled Patterns
Instances
RepositoryAssociationState
newtype RepositoryAssociationState Source #
Constructors
| RepositoryAssociationState' | |
Fields | |
Bundled Patterns
Instances
Severity
Constructors
| Severity' | |
Fields
| |
Bundled Patterns
| pattern Severity_Critical :: Severity | |
| pattern Severity_High :: Severity | |
| pattern Severity_Info :: Severity | |
| pattern Severity_Low :: Severity | |
| pattern Severity_Medium :: Severity |
Instances
Type
Bundled Patterns
| pattern Type_PullRequest :: Type | |
| pattern Type_RepositoryAnalysis :: Type |
Instances
VendorName
newtype VendorName Source #
Constructors
| VendorName' | |
Fields | |
Bundled Patterns
| pattern VendorName_GitHub :: VendorName | |
| pattern VendorName_GitLab :: VendorName | |
| pattern VendorName_NativeS3 :: VendorName |
Instances
BranchDiffSourceCodeType
data BranchDiffSourceCodeType Source #
A type of SourceCodeType that specifies a code diff between a source and destination branch in an associated repository.
See: newBranchDiffSourceCodeType smart constructor.
Constructors
| BranchDiffSourceCodeType' Text Text |
Instances
newBranchDiffSourceCodeType Source #
Arguments
| :: Text | |
| -> Text | |
| -> BranchDiffSourceCodeType |
Create a value of BranchDiffSourceCodeType 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:sourceBranchName:BranchDiffSourceCodeType', branchDiffSourceCodeType_sourceBranchName - The source branch for a diff in an associated repository.
$sel:destinationBranchName:BranchDiffSourceCodeType', branchDiffSourceCodeType_destinationBranchName - The destination branch for a diff in an associated repository.
CodeArtifacts
data CodeArtifacts Source #
Code artifacts are source code artifacts and build artifacts used in a repository analysis or a pull request review.
- Source code artifacts are source code files in a Git repository that are compressed into a .zip file.
- Build artifacts are .jar or .class files that are compressed in a .zip file.
See: newCodeArtifacts smart constructor.
Constructors
| CodeArtifacts' (Maybe Text) Text |
Instances
Create a value of CodeArtifacts 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:buildArtifactsObjectKey:CodeArtifacts', codeArtifacts_buildArtifactsObjectKey - The S3 object key for a build artifacts .zip file that contains .jar or
.class files. This is required for a code review with security analysis.
For more information, see
Create code reviews with security analysis
in the Amazon CodeGuru Reviewer User Guide.
$sel:sourceCodeArtifactsObjectKey:CodeArtifacts', codeArtifacts_sourceCodeArtifactsObjectKey - The S3 object key for a source code .zip file. This is required for all
code reviews.
CodeCommitRepository
data CodeCommitRepository Source #
Information about an Amazon Web Services CodeCommit repository. The CodeCommit repository must be in the same Amazon Web Services Region and Amazon Web Services account where its CodeGuru Reviewer code reviews are configured.
See: newCodeCommitRepository smart constructor.
Constructors
| CodeCommitRepository' Text |
Instances
newCodeCommitRepository Source #
Arguments
| :: Text | |
| -> CodeCommitRepository |
Create a value of CodeCommitRepository 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:name:CodeCommitRepository', codeCommitRepository_name - The name of the Amazon Web Services CodeCommit repository. For more
information, see
repositoryName
in the Amazon Web Services CodeCommit API Reference.
CodeReview
data CodeReview Source #
Information about a code review. A code review belongs to the associated repository that contains the reviewed code.
See: newCodeReview smart constructor.
Constructors
| CodeReview' (Maybe Text) (Maybe JobState) (Maybe Metrics) (Maybe Text) (Maybe ProviderType) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Type) (Maybe SourceCodeType) (Maybe Text) (Maybe POSIX) (Maybe [AnalysisType]) (Maybe POSIX) |
Instances
newCodeReview :: CodeReview Source #
Create a value of CodeReview 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:associationArn:CodeReview', codeReview_associationArn - The Amazon Resource Name (ARN) of the
RepositoryAssociation
that contains the reviewed source code. You can retrieve associated
repository ARNs by calling
ListRepositoryAssociations
.
$sel:state:CodeReview', codeReview_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.
$sel:metrics:CodeReview', codeReview_metrics - The statistics from the code review.
$sel:pullRequestId:CodeReview', codeReview_pullRequestId - The pull request ID for the code review.
$sel:providerType:CodeReview', codeReview_providerType - The type of repository that contains the reviewed code (for example,
GitHub or Bitbucket).
$sel:owner:CodeReview', codeReview_owner - The owner of the repository. For an Amazon Web Services CodeCommit
repository, this is the Amazon Web Services account ID of the account
that owns the repository. For a GitHub, GitHub Enterprise Server, or
Bitbucket repository, this is the username for the account that owns the
repository. For an S3 repository, it can be the username or Amazon Web
Services account ID.
$sel:name:CodeReview', codeReview_name - The name of the code review.
$sel:codeReviewArn:CodeReview', codeReview_codeReviewArn - The Amazon Resource Name (ARN) of the
CodeReview
object.
$sel:repositoryName:CodeReview', codeReview_repositoryName - The name of the repository.
$sel:type':CodeReview', codeReview_type - The type of code review.
$sel:sourceCodeType:CodeReview', codeReview_sourceCodeType - The type of the source code for the code review.
$sel:stateReason:CodeReview', codeReview_stateReason - The reason for the state of the code review.
$sel:createdTimeStamp:CodeReview', codeReview_createdTimeStamp - The time, in milliseconds since the epoch, when the code review was
created.
$sel:analysisTypes:CodeReview', codeReview_analysisTypes - They types of analysis performed during a repository analysis or a pull
request review. You can specify either Security, CodeQuality, or
both.
$sel:lastUpdatedTimeStamp:CodeReview', codeReview_lastUpdatedTimeStamp - The time, in milliseconds since the epoch, when the code review was last
updated.
CodeReviewSummary
data CodeReviewSummary Source #
Information about the summary of the code review.
See: newCodeReviewSummary smart constructor.
Constructors
| CodeReviewSummary' (Maybe JobState) (Maybe Text) (Maybe ProviderType) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Type) (Maybe SourceCodeType) (Maybe MetricsSummary) (Maybe POSIX) (Maybe POSIX) |
Instances
newCodeReviewSummary :: CodeReviewSummary Source #
Create a value of CodeReviewSummary 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:state:CodeReviewSummary', codeReviewSummary_state - The state of the code review.
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.
$sel:pullRequestId:CodeReviewSummary', codeReviewSummary_pullRequestId - The pull request ID for the code review.
$sel:providerType:CodeReviewSummary', codeReviewSummary_providerType - The provider type of the repository association.
$sel:owner:CodeReviewSummary', codeReviewSummary_owner - The owner of the repository. For an Amazon Web Services CodeCommit
repository, this is the Amazon Web Services account ID of the account
that owns the repository. For a GitHub, GitHub Enterprise Server, or
Bitbucket repository, this is the username for the account that owns the
repository. For an S3 repository, it can be the username or Amazon Web
Services account ID.
$sel:name:CodeReviewSummary', codeReviewSummary_name - The name of the code review.
$sel:codeReviewArn:CodeReviewSummary', codeReviewSummary_codeReviewArn - The Amazon Resource Name (ARN) of the
CodeReview
object.
$sel:repositoryName:CodeReviewSummary', codeReviewSummary_repositoryName - The name of the repository.
$sel:type':CodeReviewSummary', codeReviewSummary_type - The type of the code review.
$sel:sourceCodeType:CodeReviewSummary', codeReviewSummary_sourceCodeType - Undocumented member.
$sel:metricsSummary:CodeReviewSummary', codeReviewSummary_metricsSummary - The statistics from the code review.
$sel:createdTimeStamp:CodeReviewSummary', codeReviewSummary_createdTimeStamp - The time, in milliseconds since the epoch, when the code review was
created.
$sel:lastUpdatedTimeStamp:CodeReviewSummary', codeReviewSummary_lastUpdatedTimeStamp - The time, in milliseconds since the epoch, when the code review was last
updated.
CodeReviewType
data CodeReviewType Source #
The type of a code review. There are two code review types:
PullRequest- A code review that is automatically triggered by a pull request on an associated repository.RepositoryAnalysis- A code review that analyzes all code under a specified branch in an associated repository. The associated repository is specified using its ARN in CreateCodeReview .
See: newCodeReviewType smart constructor.
Constructors
| CodeReviewType' (Maybe [AnalysisType]) RepositoryAnalysis |
Instances
Create a value of CodeReviewType 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:analysisTypes:CodeReviewType', codeReviewType_analysisTypes - They types of analysis performed during a repository analysis or a pull
request review. You can specify either Security, CodeQuality, or
both.
$sel:repositoryAnalysis:CodeReviewType', codeReviewType_repositoryAnalysis - A code review that analyzes all code under a specified branch in an
associated repository. The associated repository is specified using its
ARN in
CreateCodeReview
.
CommitDiffSourceCodeType
data CommitDiffSourceCodeType Source #
A type of
SourceCodeType
that specifies the commit diff for a pull request on an associated
repository. The SourceCommit and DestinationCommit fields are
required to do a pull request code review.
See: newCommitDiffSourceCodeType smart constructor.
Instances
newCommitDiffSourceCodeType :: CommitDiffSourceCodeType Source #
Create a value of CommitDiffSourceCodeType 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:sourceCommit:CommitDiffSourceCodeType', commitDiffSourceCodeType_sourceCommit - The SHA of the source commit used to generate a commit diff. This field
is required for a pull request code review.
$sel:mergeBaseCommit:CommitDiffSourceCodeType', commitDiffSourceCodeType_mergeBaseCommit - The SHA of the merge base of a commit.
$sel:destinationCommit:CommitDiffSourceCodeType', commitDiffSourceCodeType_destinationCommit - The SHA of the destination commit used to generate a commit diff. This
field is required for a pull request code review.
EventInfo
Information about an event. The event might be a push, pull request, scheduled request, or another type of event.
See: newEventInfo smart constructor.
Constructors
| EventInfo' (Maybe Text) (Maybe Text) |
Instances
| Eq EventInfo Source # | |
| Read EventInfo Source # | |
| Show EventInfo Source # | |
| Generic EventInfo Source # | |
| NFData EventInfo Source # | |
Defined in Amazonka.CodeGuruReviewer.Types.EventInfo | |
| Hashable EventInfo Source # | |
Defined in Amazonka.CodeGuruReviewer.Types.EventInfo | |
| ToJSON EventInfo Source # | |
Defined in Amazonka.CodeGuruReviewer.Types.EventInfo | |
| FromJSON EventInfo Source # | |
| type Rep EventInfo Source # | |
Defined in Amazonka.CodeGuruReviewer.Types.EventInfo type Rep EventInfo = D1 ('MetaData "EventInfo" "Amazonka.CodeGuruReviewer.Types.EventInfo" "libZSservicesZSamazonka-codeguru-reviewerZSamazonka-codeguru-reviewer" 'False) (C1 ('MetaCons "EventInfo'" 'PrefixI 'True) (S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) | |
newEventInfo :: EventInfo Source #
Create a value of EventInfo 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:state:EventInfo', eventInfo_state - The state of an event. The state might be open, closed, or another
state.
$sel:name:EventInfo', eventInfo_name - The name of the event. The possible names are pull_request,
workflow_dispatch, schedule, and push
KMSKeyDetails
data KMSKeyDetails Source #
An object that contains:
- The encryption option for a repository association. It is either
owned by Amazon Web Services Key Management Service (KMS)
(
AWS_OWNED_CMK) or customer managed (CUSTOMER_MANAGED_CMK). - The ID of the Amazon Web Services KMS key that is associated with a respository association.
See: newKMSKeyDetails smart constructor.
Constructors
| KMSKeyDetails' (Maybe EncryptionOption) (Maybe Text) |
Instances
newKMSKeyDetails :: KMSKeyDetails Source #
Create a value of KMSKeyDetails 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:encryptionOption:KMSKeyDetails', kmsKeyDetails_encryptionOption - The encryption option for a repository association. It is either owned
by Amazon Web Services Key Management Service (KMS) (AWS_OWNED_CMK) or
customer managed (CUSTOMER_MANAGED_CMK).
$sel:kmsKeyId:KMSKeyDetails', kmsKeyDetails_kmsKeyId - The ID of the Amazon Web Services KMS key that is associated with a
respository association.
Metrics
Information about the statistics from the code review.
See: newMetrics smart constructor.
Instances
| Eq Metrics Source # | |
| Read Metrics Source # | |
| Show Metrics Source # | |
| Generic Metrics Source # | |
| NFData Metrics Source # | |
Defined in Amazonka.CodeGuruReviewer.Types.Metrics | |
| Hashable Metrics Source # | |
Defined in Amazonka.CodeGuruReviewer.Types.Metrics | |
| FromJSON Metrics Source # | |
| type Rep Metrics Source # | |
Defined in Amazonka.CodeGuruReviewer.Types.Metrics type Rep Metrics = D1 ('MetaData "Metrics" "Amazonka.CodeGuruReviewer.Types.Metrics" "libZSservicesZSamazonka-codeguru-reviewerZSamazonka-codeguru-reviewer" 'False) (C1 ('MetaCons "Metrics'" 'PrefixI 'True) (S1 ('MetaSel ('Just "findingsCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: S1 ('MetaSel ('Just "meteredLinesOfCodeCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)))) | |
newMetrics :: Metrics Source #
Create a value of Metrics 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:findingsCount:Metrics', metrics_findingsCount - Total number of recommendations found in the code review.
$sel:meteredLinesOfCodeCount:Metrics', metrics_meteredLinesOfCodeCount - MeteredLinesOfCode is the number of lines of code in the repository
where the code review happened. This does not include non-code lines
such as comments and blank lines.
MetricsSummary
data MetricsSummary Source #
Information about metrics summaries.
See: newMetricsSummary smart constructor.
Constructors
| MetricsSummary' (Maybe Integer) (Maybe Integer) |
Instances
newMetricsSummary :: MetricsSummary Source #
Create a value of MetricsSummary 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:findingsCount:MetricsSummary', metricsSummary_findingsCount - Total number of recommendations found in the code review.
$sel:meteredLinesOfCodeCount:MetricsSummary', metricsSummary_meteredLinesOfCodeCount - Lines of code metered in the code review. For the initial code review
pull request and all subsequent revisions, this includes all lines of
code in the files added to the pull request. In subsequent revisions,
for files that already existed in the pull request, this includes only
the changed lines of code. In both cases, this does not include non-code
lines such as comments and import statements. For example, if you submit
a pull request containing 5 files, each with 500 lines of code, and in a
subsequent revision you added a new file with 200 lines of code, and
also modified a total of 25 lines across the initial 5 files,
MeteredLinesOfCodeCount includes the first 5 files (5 * 500 = 2,500
lines), the new file (200 lines) and the 25 changed lines of code for a
total of 2,725 lines of code.
RecommendationFeedback
data RecommendationFeedback Source #
Information about the recommendation feedback.
See: newRecommendationFeedback smart constructor.
Constructors
| RecommendationFeedback' (Maybe Text) (Maybe Text) (Maybe [Reaction]) (Maybe Text) (Maybe POSIX) (Maybe POSIX) |
Instances
newRecommendationFeedback :: RecommendationFeedback Source #
Create a value of RecommendationFeedback 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:recommendationId:RecommendationFeedback', recommendationFeedback_recommendationId - The recommendation ID that can be used to track the provided
recommendations. Later on it can be used to collect the feedback.
$sel:userId:RecommendationFeedback', recommendationFeedback_userId - The ID of the user that made the API call.
The UserId is an IAM principal that can be specified as an Amazon Web
Services account ID or an Amazon Resource Name (ARN). For more
information, see
Specifying a Principal
in the Amazon Web Services Identity and Access Management User Guide.
$sel:reactions:RecommendationFeedback', recommendationFeedback_reactions - List for storing reactions. Reactions are utf-8 text code for emojis.
You can send an empty list to clear off all your feedback.
$sel:codeReviewArn:RecommendationFeedback', recommendationFeedback_codeReviewArn - The Amazon Resource Name (ARN) of the
CodeReview
object.
$sel:createdTimeStamp:RecommendationFeedback', recommendationFeedback_createdTimeStamp - The time at which the feedback was created.
$sel:lastUpdatedTimeStamp:RecommendationFeedback', recommendationFeedback_lastUpdatedTimeStamp - The time at which the feedback was last updated.
RecommendationFeedbackSummary
data RecommendationFeedbackSummary Source #
Information about recommendation feedback summaries.
See: newRecommendationFeedbackSummary smart constructor.
Instances
newRecommendationFeedbackSummary :: RecommendationFeedbackSummary Source #
Create a value of RecommendationFeedbackSummary 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:recommendationId:RecommendationFeedbackSummary', recommendationFeedbackSummary_recommendationId - The recommendation ID that can be used to track the provided
recommendations. Later on it can be used to collect the feedback.
$sel:userId:RecommendationFeedbackSummary', recommendationFeedbackSummary_userId - The ID of the user that gave the feedback.
The UserId is an IAM principal that can be specified as an Amazon Web
Services account ID or an Amazon Resource Name (ARN). For more
information, see
Specifying a Principal
in the Amazon Web Services Identity and Access Management User Guide.
$sel:reactions:RecommendationFeedbackSummary', recommendationFeedbackSummary_reactions - List for storing reactions. Reactions are utf-8 text code for emojis.
RecommendationSummary
data RecommendationSummary Source #
Information about recommendations.
See: newRecommendationSummary smart constructor.
Constructors
| RecommendationSummary' (Maybe Text) (Maybe Text) (Maybe Severity) (Maybe RuleMetadata) (Maybe Int) (Maybe Int) (Maybe Text) (Maybe RecommendationCategory) |
Instances
newRecommendationSummary :: RecommendationSummary Source #
Create a value of RecommendationSummary 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:recommendationId:RecommendationSummary', recommendationSummary_recommendationId - The recommendation ID that can be used to track the provided
recommendations. Later on it can be used to collect the feedback.
$sel:filePath:RecommendationSummary', recommendationSummary_filePath - Name of the file on which a recommendation is provided.
$sel:severity:RecommendationSummary', recommendationSummary_severity - The severity of the issue in the code that generated this
recommendation.
$sel:ruleMetadata:RecommendationSummary', recommendationSummary_ruleMetadata - Metadata about a rule. Rule metadata includes an ID, a name, a list of
tags, and a short and long description. CodeGuru Reviewer uses rules to
analyze code. A rule's recommendation is included in analysis results
if code is detected that violates the rule.
$sel:startLine:RecommendationSummary', recommendationSummary_startLine - Start line from where the recommendation is applicable in the source
commit or source branch.
$sel:endLine:RecommendationSummary', recommendationSummary_endLine - Last line where the recommendation is applicable in the source commit or
source branch. For a single line comment the start line and end line
values are the same.
$sel:description:RecommendationSummary', recommendationSummary_description - A description of the recommendation generated by CodeGuru Reviewer for
the lines of code between the start line and the end line.
$sel:recommendationCategory:RecommendationSummary', recommendationSummary_recommendationCategory - The type of a recommendation.
Repository
data Repository Source #
Information about an associated Amazon Web Services CodeCommit
repository or an associated repository that is managed by Amazon Web
Services CodeStar Connections (for example, Bitbucket). This
Repository object is not used if your source code is in an associated
GitHub repository.
See: newRepository smart constructor.
Constructors
| Repository' (Maybe CodeCommitRepository) (Maybe ThirdPartySourceRepository) (Maybe S3Repository) (Maybe ThirdPartySourceRepository) |
Instances
newRepository :: Repository Source #
Create a value of Repository 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:codeCommit:Repository', repository_codeCommit - Information about an Amazon Web Services CodeCommit repository.
$sel:gitHubEnterpriseServer:Repository', repository_gitHubEnterpriseServer - Information about a GitHub Enterprise Server repository.
$sel:s3Bucket:Repository', repository_s3Bucket - Undocumented member.
$sel:bitbucket:Repository', repository_bitbucket - Information about a Bitbucket repository.
RepositoryAnalysis
data RepositoryAnalysis Source #
A code review type that analyzes all code under a specified branch in an associated repository. The associated repository is specified using its ARN when you call CreateCodeReview .
See: newRepositoryAnalysis smart constructor.
Constructors
| RepositoryAnalysis' (Maybe RepositoryHeadSourceCodeType) (Maybe SourceCodeType) |
Instances
newRepositoryAnalysis :: RepositoryAnalysis Source #
Create a value of RepositoryAnalysis 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:repositoryHead:RepositoryAnalysis', repositoryAnalysis_repositoryHead - A
SourceCodeType
that specifies the tip of a branch in an associated repository.
$sel:sourceCodeType:RepositoryAnalysis', repositoryAnalysis_sourceCodeType - Undocumented member.
RepositoryAssociation
data RepositoryAssociation Source #
Information about a repository association. The
DescribeRepositoryAssociation
operation returns a RepositoryAssociation object.
See: newRepositoryAssociation smart constructor.
Constructors
| RepositoryAssociation' (Maybe Text) (Maybe Text) (Maybe RepositoryAssociationState) (Maybe S3RepositoryDetails) (Maybe ProviderType) (Maybe Text) (Maybe Text) (Maybe KMSKeyDetails) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe POSIX) |
Instances
newRepositoryAssociation :: RepositoryAssociation Source #
Create a value of RepositoryAssociation 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:associationArn:RepositoryAssociation', repositoryAssociation_associationArn - The Amazon Resource Name (ARN) identifying the repository association.
$sel:associationId:RepositoryAssociation', repositoryAssociation_associationId - The ID of the repository association.
$sel:state:RepositoryAssociation', repositoryAssociation_state - The state of the repository association.
The valid repository association states are:
- Associated: The repository association is complete.
Associating: CodeGuru Reviewer is:
Setting up pull request notifications. This is required for pull requests to trigger a CodeGuru Reviewer review.
If your repository
ProviderTypeisGitHub,GitHub Enterprise Server, orBitbucket, CodeGuru Reviewer creates webhooks in your repository to trigger CodeGuru Reviewer reviews. If you delete these webhooks, reviews of code in your repository cannot be triggered.- Setting up source code access. This is required for CodeGuru Reviewer to securely clone code in your repository.
- Failed: The repository failed to associate or disassociate.
- Disassociating: CodeGuru Reviewer is removing the repository's pull request notifications and source code access.
- Disassociated: CodeGuru Reviewer successfully disassociated the repository. You can create a new association with this repository if you want to review source code in it later. You can control access to code reviews created in an associated repository with tags after it has been disassociated. For more information, see Using tags to control access to associated repositories in the Amazon CodeGuru Reviewer User Guide.
$sel:s3RepositoryDetails:RepositoryAssociation', repositoryAssociation_s3RepositoryDetails - Undocumented member.
$sel:providerType:RepositoryAssociation', repositoryAssociation_providerType - The provider type of the repository association.
$sel:owner:RepositoryAssociation', repositoryAssociation_owner - The owner of the repository. For an Amazon Web Services CodeCommit
repository, this is the Amazon Web Services account ID of the account
that owns the repository. For a GitHub, GitHub Enterprise Server, or
Bitbucket repository, this is the username for the account that owns the
repository. For an S3 repository, it can be the username or Amazon Web
Services account ID.
$sel:name:RepositoryAssociation', repositoryAssociation_name - The name of the repository.
$sel:kmsKeyDetails:RepositoryAssociation', repositoryAssociation_kmsKeyDetails - A KMSKeyDetails object that contains:
- The encryption option for this repository association. It is either
owned by Amazon Web Services Key Management Service (KMS)
(
AWS_OWNED_CMK) or customer managed (CUSTOMER_MANAGED_CMK). - The ID of the Amazon Web Services KMS key that is associated with this respository association.
$sel:connectionArn:RepositoryAssociation', repositoryAssociation_connectionArn - The Amazon Resource Name (ARN) of an Amazon Web Services CodeStar
Connections connection. Its format is
arn:aws:codestar-connections:region-id:aws-account_id:connection/connection-id.
For more information, see
Connection
in the Amazon Web Services CodeStar Connections API Reference.
$sel:stateReason:RepositoryAssociation', repositoryAssociation_stateReason - A description of why the repository association is in the current state.
$sel:createdTimeStamp:RepositoryAssociation', repositoryAssociation_createdTimeStamp - The time, in milliseconds since the epoch, when the repository
association was created.
$sel:lastUpdatedTimeStamp:RepositoryAssociation', repositoryAssociation_lastUpdatedTimeStamp - The time, in milliseconds since the epoch, when the repository
association was last updated.
RepositoryAssociationSummary
data RepositoryAssociationSummary Source #
Summary information about a repository association. The
ListRepositoryAssociations
operation returns a list of RepositoryAssociationSummary objects.
See: newRepositoryAssociationSummary smart constructor.
Constructors
| RepositoryAssociationSummary' (Maybe Text) (Maybe Text) (Maybe RepositoryAssociationState) (Maybe ProviderType) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) |
Instances
newRepositoryAssociationSummary :: RepositoryAssociationSummary Source #
Create a value of RepositoryAssociationSummary 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:associationArn:RepositoryAssociationSummary', repositoryAssociationSummary_associationArn - The Amazon Resource Name (ARN) of the
RepositoryAssociation
object. You can retrieve this ARN by calling
ListRepositoryAssociations
.
$sel:associationId:RepositoryAssociationSummary', repositoryAssociationSummary_associationId - The repository association ID.
$sel:state:RepositoryAssociationSummary', repositoryAssociationSummary_state - The state of the repository association.
The valid repository association states are:
- Associated: The repository association is complete.
Associating: CodeGuru Reviewer is:
Setting up pull request notifications. This is required for pull requests to trigger a CodeGuru Reviewer review.
If your repository
ProviderTypeisGitHub,GitHub Enterprise Server, orBitbucket, CodeGuru Reviewer creates webhooks in your repository to trigger CodeGuru Reviewer reviews. If you delete these webhooks, reviews of code in your repository cannot be triggered.- Setting up source code access. This is required for CodeGuru Reviewer to securely clone code in your repository.
- Failed: The repository failed to associate or disassociate.
- Disassociating: CodeGuru Reviewer is removing the repository's pull request notifications and source code access.
- Disassociated: CodeGuru Reviewer successfully disassociated the repository. You can create a new association with this repository if you want to review source code in it later. You can control access to code reviews created in an associated repository with tags after it has been disassociated. For more information, see Using tags to control access to associated repositories in the Amazon CodeGuru Reviewer User Guide.
$sel:providerType:RepositoryAssociationSummary', repositoryAssociationSummary_providerType - The provider type of the repository association.
$sel:owner:RepositoryAssociationSummary', repositoryAssociationSummary_owner - The owner of the repository. For an Amazon Web Services CodeCommit
repository, this is the Amazon Web Services account ID of the account
that owns the repository. For a GitHub, GitHub Enterprise Server, or
Bitbucket repository, this is the username for the account that owns the
repository. For an S3 repository, it can be the username or Amazon Web
Services account ID.
$sel:name:RepositoryAssociationSummary', repositoryAssociationSummary_name - The name of the repository association.
$sel:connectionArn:RepositoryAssociationSummary', repositoryAssociationSummary_connectionArn - The Amazon Resource Name (ARN) of an Amazon Web Services CodeStar
Connections connection. Its format is
arn:aws:codestar-connections:region-id:aws-account_id:connection/connection-id.
For more information, see
Connection
in the Amazon Web Services CodeStar Connections API Reference.
$sel:lastUpdatedTimeStamp:RepositoryAssociationSummary', repositoryAssociationSummary_lastUpdatedTimeStamp - The time, in milliseconds since the epoch, since the repository
association was last updated.
RepositoryHeadSourceCodeType
data RepositoryHeadSourceCodeType Source #
A SourceCodeType that specifies the tip of a branch in an associated repository.
See: newRepositoryHeadSourceCodeType smart constructor.
Constructors
| RepositoryHeadSourceCodeType' Text |
Instances
newRepositoryHeadSourceCodeType Source #
Create a value of RepositoryHeadSourceCodeType 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:branchName:RepositoryHeadSourceCodeType', repositoryHeadSourceCodeType_branchName - The name of the branch in an associated repository. The
RepositoryHeadSourceCodeType specifies the tip of this branch.
RequestMetadata
data RequestMetadata Source #
Metadata that is associated with a code review. This applies to both pull request and repository analysis code reviews.
See: newRequestMetadata smart constructor.
Constructors
| RequestMetadata' (Maybe Text) (Maybe EventInfo) (Maybe VendorName) (Maybe Text) |
Instances
newRequestMetadata :: RequestMetadata Source #
Create a value of RequestMetadata 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:requestId:RequestMetadata', requestMetadata_requestId - The ID of the request. This is required for a pull request code review.
$sel:eventInfo:RequestMetadata', requestMetadata_eventInfo - Information about the event associated with a code review.
$sel:vendorName:RequestMetadata', requestMetadata_vendorName - The name of the repository vendor used to upload code to an S3 bucket
for a CI/CD code review. For example, if code and artifacts are
uploaded to an S3 bucket for a CI/CD code review by GitHub scripts from
a GitHub repository, then the repository association's ProviderType
is S3Bucket and the CI/CD repository vendor name is GitHub. For more
information, see the definition for ProviderType in
RepositoryAssociation.
$sel:requester:RequestMetadata', requestMetadata_requester - An identifier, such as a name or account ID, that is associated with the
requester. The Requester is used to capture the author/actor name
of the event request.
RuleMetadata
data RuleMetadata Source #
Metadata about a rule. Rule metadata includes an ID, a name, a list of tags, and a short and long description. CodeGuru Reviewer uses rules to analyze code. A rule's recommendation is included in analysis results if code is detected that violates the rule.
See: newRuleMetadata smart constructor.
Constructors
| RuleMetadata' (Maybe Text) (Maybe (NonEmpty Text)) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
newRuleMetadata :: RuleMetadata Source #
Create a value of RuleMetadata 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:longDescription:RuleMetadata', ruleMetadata_longDescription - A long description of the rule.
$sel:ruleTags:RuleMetadata', ruleMetadata_ruleTags - Tags that are associated with the rule.
$sel:ruleId:RuleMetadata', ruleMetadata_ruleId - The ID of the rule.
$sel:ruleName:RuleMetadata', ruleMetadata_ruleName - The name of the rule.
$sel:shortDescription:RuleMetadata', ruleMetadata_shortDescription - A short description of the rule.
S3BucketRepository
data S3BucketRepository Source #
Information about an associated repository in an S3 bucket. The associated repository contains a source code .zip file and a build artifacts .zip file that contains .jar or .class files.
See: newS3BucketRepository smart constructor.
Constructors
| S3BucketRepository' (Maybe S3RepositoryDetails) Text |
Instances
newS3BucketRepository Source #
Arguments
| :: Text | |
| -> S3BucketRepository |
Create a value of S3BucketRepository 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:details:S3BucketRepository', s3BucketRepository_details - An S3RepositoryDetails object that specifies the name of an S3 bucket
and a CodeArtifacts object. The CodeArtifacts object includes the S3
object keys for a source code .zip file and for a build artifacts .zip
file.
$sel:name:S3BucketRepository', s3BucketRepository_name - The name of the repository when the ProviderType is S3Bucket.
S3Repository
data S3Repository Source #
Information about a repository in an S3 bucket.
See: newS3Repository smart constructor.
Constructors
| S3Repository' Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> S3Repository |
Create a value of S3Repository 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:name:S3Repository', s3Repository_name - The name of the repository in the S3 bucket.
$sel:bucketName:S3Repository', s3Repository_bucketName - The name of the S3 bucket used for associating a new S3 repository. It
must begin with codeguru-reviewer-.
S3RepositoryDetails
data S3RepositoryDetails Source #
Specifies the name of an S3 bucket and a CodeArtifacts object that
contains the S3 object keys for a source code .zip file and for a build
artifacts .zip file that contains .jar or .class files.
See: newS3RepositoryDetails smart constructor.
Constructors
| S3RepositoryDetails' (Maybe CodeArtifacts) (Maybe Text) |
Instances
newS3RepositoryDetails :: S3RepositoryDetails Source #
Create a value of S3RepositoryDetails 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:codeArtifacts:S3RepositoryDetails', s3RepositoryDetails_codeArtifacts - A CodeArtifacts object. The CodeArtifacts object includes the S3
object key for a source code .zip file and for a build artifacts .zip
file that contains .jar or .class files.
$sel:bucketName:S3RepositoryDetails', s3RepositoryDetails_bucketName - The name of the S3 bucket used for associating a new S3 repository. It
must begin with codeguru-reviewer-.
SourceCodeType
data SourceCodeType Source #
Specifies the source code that is analyzed in a code review.
See: newSourceCodeType smart constructor.
Constructors
| SourceCodeType' (Maybe S3BucketRepository) (Maybe RequestMetadata) (Maybe RepositoryHeadSourceCodeType) (Maybe CommitDiffSourceCodeType) (Maybe BranchDiffSourceCodeType) |
Instances
newSourceCodeType :: SourceCodeType Source #
Create a value of SourceCodeType 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:s3BucketRepository:SourceCodeType', sourceCodeType_s3BucketRepository - Information about an associated repository in an S3 bucket that includes
its name and an S3RepositoryDetails object. The S3RepositoryDetails
object includes the name of an S3 bucket, an S3 key for a source code
.zip file, and an S3 key for a build artifacts .zip file.
S3BucketRepository is required in
SourceCodeType
for S3BucketRepository based code reviews.
$sel:requestMetadata:SourceCodeType', sourceCodeType_requestMetadata - Metadata that is associated with a code review. This applies to any type
of code review supported by CodeGuru Reviewer. The RequestMetadaa
field captures any event metadata. For example, it might capture
metadata associated with an event trigger, such as a push or a pull
request.
$sel:repositoryHead:SourceCodeType', sourceCodeType_repositoryHead - Undocumented member.
$sel:commitDiff:SourceCodeType', sourceCodeType_commitDiff - A
SourceCodeType
that specifies a commit diff created by a pull request on an associated
repository.
$sel:branchDiff:SourceCodeType', sourceCodeType_branchDiff - A type of
SourceCodeType
that specifies a source branch name and a destination branch name in an
associated repository.
ThirdPartySourceRepository
data ThirdPartySourceRepository Source #
Information about a third-party source repository connected to CodeGuru Reviewer.
See: newThirdPartySourceRepository smart constructor.
Constructors
| ThirdPartySourceRepository' Text Text Text |
Instances
newThirdPartySourceRepository Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> ThirdPartySourceRepository |
Create a value of ThirdPartySourceRepository 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:name:ThirdPartySourceRepository', thirdPartySourceRepository_name - The name of the third party source repository.
$sel:connectionArn:ThirdPartySourceRepository', thirdPartySourceRepository_connectionArn - The Amazon Resource Name (ARN) of an Amazon Web Services CodeStar
Connections connection. Its format is
arn:aws:codestar-connections:region-id:aws-account_id:connection/connection-id.
For more information, see
Connection
in the Amazon Web Services CodeStar Connections API Reference.
$sel:owner:ThirdPartySourceRepository', thirdPartySourceRepository_owner - The owner of the repository. For a GitHub, GitHub Enterprise, or
Bitbucket repository, this is the username for the account that owns the
repository. For an S3 repository, this can be the username or Amazon Web
Services account ID.