| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.CodeGuruReviewer.Types
Contents
- Service Configuration
- Errors
- AnalysisType
- ConfigFileState
- 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
Synopsis
- defaultService :: Service
- _AccessDeniedException :: AsError a => Fold a ServiceError
- _ConflictException :: AsError a => Fold a ServiceError
- _InternalServerException :: AsError a => Fold a ServiceError
- _NotFoundException :: AsError a => Fold a ServiceError
- _ResourceNotFoundException :: AsError a => Fold a ServiceError
- _ThrottlingException :: AsError a => Fold a ServiceError
- _ValidationException :: AsError a => Fold a ServiceError
- newtype AnalysisType where
- AnalysisType' { }
- pattern AnalysisType_CodeQuality :: AnalysisType
- pattern AnalysisType_Security :: AnalysisType
- newtype ConfigFileState where
- ConfigFileState' { }
- pattern ConfigFileState_Absent :: ConfigFileState
- pattern ConfigFileState_Present :: ConfigFileState
- pattern ConfigFileState_PresentWithErrors :: ConfigFileState
- 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' {}
- newBranchDiffSourceCodeType :: Text -> Text -> BranchDiffSourceCodeType
- branchDiffSourceCodeType_sourceBranchName :: Lens' BranchDiffSourceCodeType Text
- branchDiffSourceCodeType_destinationBranchName :: Lens' BranchDiffSourceCodeType Text
- data CodeArtifacts = CodeArtifacts' {}
- newCodeArtifacts :: Text -> CodeArtifacts
- codeArtifacts_buildArtifactsObjectKey :: Lens' CodeArtifacts (Maybe Text)
- codeArtifacts_sourceCodeArtifactsObjectKey :: Lens' CodeArtifacts Text
- data CodeCommitRepository = CodeCommitRepository' {}
- newCodeCommitRepository :: Text -> CodeCommitRepository
- codeCommitRepository_name :: Lens' CodeCommitRepository Text
- data CodeReview = CodeReview' {
- analysisTypes :: Maybe [AnalysisType]
- associationArn :: Maybe Text
- codeReviewArn :: Maybe Text
- configFileState :: Maybe ConfigFileState
- createdTimeStamp :: Maybe POSIX
- lastUpdatedTimeStamp :: Maybe POSIX
- metrics :: Maybe Metrics
- name :: Maybe Text
- owner :: Maybe Text
- providerType :: Maybe ProviderType
- pullRequestId :: Maybe Text
- repositoryName :: Maybe Text
- sourceCodeType :: Maybe SourceCodeType
- state :: Maybe JobState
- stateReason :: Maybe Text
- type' :: Maybe Type
- newCodeReview :: CodeReview
- codeReview_analysisTypes :: Lens' CodeReview (Maybe [AnalysisType])
- codeReview_associationArn :: Lens' CodeReview (Maybe Text)
- codeReview_codeReviewArn :: Lens' CodeReview (Maybe Text)
- codeReview_configFileState :: Lens' CodeReview (Maybe ConfigFileState)
- codeReview_createdTimeStamp :: Lens' CodeReview (Maybe UTCTime)
- codeReview_lastUpdatedTimeStamp :: Lens' CodeReview (Maybe UTCTime)
- codeReview_metrics :: Lens' CodeReview (Maybe Metrics)
- codeReview_name :: Lens' CodeReview (Maybe Text)
- codeReview_owner :: Lens' CodeReview (Maybe Text)
- codeReview_providerType :: Lens' CodeReview (Maybe ProviderType)
- codeReview_pullRequestId :: Lens' CodeReview (Maybe Text)
- codeReview_repositoryName :: Lens' CodeReview (Maybe Text)
- codeReview_sourceCodeType :: Lens' CodeReview (Maybe SourceCodeType)
- codeReview_state :: Lens' CodeReview (Maybe JobState)
- codeReview_stateReason :: Lens' CodeReview (Maybe Text)
- codeReview_type :: Lens' CodeReview (Maybe Type)
- data CodeReviewSummary = CodeReviewSummary' {
- codeReviewArn :: Maybe Text
- createdTimeStamp :: Maybe POSIX
- lastUpdatedTimeStamp :: Maybe POSIX
- metricsSummary :: Maybe MetricsSummary
- name :: Maybe Text
- owner :: Maybe Text
- providerType :: Maybe ProviderType
- pullRequestId :: Maybe Text
- repositoryName :: Maybe Text
- sourceCodeType :: Maybe SourceCodeType
- state :: Maybe JobState
- type' :: Maybe Type
- newCodeReviewSummary :: CodeReviewSummary
- codeReviewSummary_codeReviewArn :: Lens' CodeReviewSummary (Maybe Text)
- codeReviewSummary_createdTimeStamp :: Lens' CodeReviewSummary (Maybe UTCTime)
- codeReviewSummary_lastUpdatedTimeStamp :: Lens' CodeReviewSummary (Maybe UTCTime)
- codeReviewSummary_metricsSummary :: Lens' CodeReviewSummary (Maybe MetricsSummary)
- codeReviewSummary_name :: Lens' CodeReviewSummary (Maybe Text)
- codeReviewSummary_owner :: Lens' CodeReviewSummary (Maybe Text)
- codeReviewSummary_providerType :: Lens' CodeReviewSummary (Maybe ProviderType)
- codeReviewSummary_pullRequestId :: Lens' CodeReviewSummary (Maybe Text)
- codeReviewSummary_repositoryName :: Lens' CodeReviewSummary (Maybe Text)
- codeReviewSummary_sourceCodeType :: Lens' CodeReviewSummary (Maybe SourceCodeType)
- codeReviewSummary_state :: Lens' CodeReviewSummary (Maybe JobState)
- codeReviewSummary_type :: Lens' CodeReviewSummary (Maybe Type)
- data CodeReviewType = CodeReviewType' {}
- newCodeReviewType :: RepositoryAnalysis -> CodeReviewType
- codeReviewType_analysisTypes :: Lens' CodeReviewType (Maybe [AnalysisType])
- codeReviewType_repositoryAnalysis :: Lens' CodeReviewType RepositoryAnalysis
- data CommitDiffSourceCodeType = CommitDiffSourceCodeType' {}
- newCommitDiffSourceCodeType :: CommitDiffSourceCodeType
- commitDiffSourceCodeType_destinationCommit :: Lens' CommitDiffSourceCodeType (Maybe Text)
- commitDiffSourceCodeType_mergeBaseCommit :: Lens' CommitDiffSourceCodeType (Maybe Text)
- commitDiffSourceCodeType_sourceCommit :: Lens' CommitDiffSourceCodeType (Maybe Text)
- data EventInfo = EventInfo' {}
- newEventInfo :: EventInfo
- eventInfo_name :: Lens' EventInfo (Maybe Text)
- eventInfo_state :: Lens' EventInfo (Maybe Text)
- data KMSKeyDetails = KMSKeyDetails' {}
- newKMSKeyDetails :: KMSKeyDetails
- kmsKeyDetails_encryptionOption :: Lens' KMSKeyDetails (Maybe EncryptionOption)
- kmsKeyDetails_kmsKeyId :: Lens' KMSKeyDetails (Maybe Text)
- data Metrics = Metrics' {}
- newMetrics :: Metrics
- metrics_findingsCount :: Lens' Metrics (Maybe Integer)
- metrics_meteredLinesOfCodeCount :: Lens' Metrics (Maybe Integer)
- metrics_suppressedLinesOfCodeCount :: Lens' Metrics (Maybe Integer)
- data MetricsSummary = MetricsSummary' {}
- newMetricsSummary :: MetricsSummary
- metricsSummary_findingsCount :: Lens' MetricsSummary (Maybe Integer)
- metricsSummary_meteredLinesOfCodeCount :: Lens' MetricsSummary (Maybe Integer)
- metricsSummary_suppressedLinesOfCodeCount :: Lens' MetricsSummary (Maybe Integer)
- data RecommendationFeedback = RecommendationFeedback' {}
- newRecommendationFeedback :: RecommendationFeedback
- recommendationFeedback_codeReviewArn :: Lens' RecommendationFeedback (Maybe Text)
- recommendationFeedback_createdTimeStamp :: Lens' RecommendationFeedback (Maybe UTCTime)
- recommendationFeedback_lastUpdatedTimeStamp :: Lens' RecommendationFeedback (Maybe UTCTime)
- recommendationFeedback_reactions :: Lens' RecommendationFeedback (Maybe [Reaction])
- recommendationFeedback_recommendationId :: Lens' RecommendationFeedback (Maybe Text)
- recommendationFeedback_userId :: Lens' RecommendationFeedback (Maybe Text)
- data RecommendationFeedbackSummary = RecommendationFeedbackSummary' {}
- newRecommendationFeedbackSummary :: RecommendationFeedbackSummary
- recommendationFeedbackSummary_reactions :: Lens' RecommendationFeedbackSummary (Maybe [Reaction])
- recommendationFeedbackSummary_recommendationId :: Lens' RecommendationFeedbackSummary (Maybe Text)
- recommendationFeedbackSummary_userId :: Lens' RecommendationFeedbackSummary (Maybe Text)
- data RecommendationSummary = RecommendationSummary' {}
- newRecommendationSummary :: RecommendationSummary
- recommendationSummary_description :: Lens' RecommendationSummary (Maybe Text)
- recommendationSummary_endLine :: Lens' RecommendationSummary (Maybe Int)
- recommendationSummary_filePath :: Lens' RecommendationSummary (Maybe Text)
- recommendationSummary_recommendationCategory :: Lens' RecommendationSummary (Maybe RecommendationCategory)
- recommendationSummary_recommendationId :: Lens' RecommendationSummary (Maybe Text)
- recommendationSummary_ruleMetadata :: Lens' RecommendationSummary (Maybe RuleMetadata)
- recommendationSummary_severity :: Lens' RecommendationSummary (Maybe Severity)
- recommendationSummary_startLine :: Lens' RecommendationSummary (Maybe Int)
- data Repository = Repository' {}
- newRepository :: Repository
- repository_bitbucket :: Lens' Repository (Maybe ThirdPartySourceRepository)
- repository_codeCommit :: Lens' Repository (Maybe CodeCommitRepository)
- repository_gitHubEnterpriseServer :: Lens' Repository (Maybe ThirdPartySourceRepository)
- repository_s3Bucket :: Lens' Repository (Maybe S3Repository)
- data RepositoryAnalysis = RepositoryAnalysis' {}
- newRepositoryAnalysis :: RepositoryAnalysis
- repositoryAnalysis_repositoryHead :: Lens' RepositoryAnalysis (Maybe RepositoryHeadSourceCodeType)
- repositoryAnalysis_sourceCodeType :: Lens' RepositoryAnalysis (Maybe SourceCodeType)
- data RepositoryAssociation = RepositoryAssociation' {
- associationArn :: Maybe Text
- associationId :: Maybe Text
- connectionArn :: Maybe Text
- createdTimeStamp :: Maybe POSIX
- kmsKeyDetails :: Maybe KMSKeyDetails
- lastUpdatedTimeStamp :: Maybe POSIX
- name :: Maybe Text
- owner :: Maybe Text
- providerType :: Maybe ProviderType
- s3RepositoryDetails :: Maybe S3RepositoryDetails
- state :: Maybe RepositoryAssociationState
- stateReason :: Maybe Text
- newRepositoryAssociation :: RepositoryAssociation
- repositoryAssociation_associationArn :: Lens' RepositoryAssociation (Maybe Text)
- repositoryAssociation_associationId :: Lens' RepositoryAssociation (Maybe Text)
- repositoryAssociation_connectionArn :: Lens' RepositoryAssociation (Maybe Text)
- repositoryAssociation_createdTimeStamp :: Lens' RepositoryAssociation (Maybe UTCTime)
- repositoryAssociation_kmsKeyDetails :: Lens' RepositoryAssociation (Maybe KMSKeyDetails)
- repositoryAssociation_lastUpdatedTimeStamp :: Lens' RepositoryAssociation (Maybe UTCTime)
- repositoryAssociation_name :: Lens' RepositoryAssociation (Maybe Text)
- repositoryAssociation_owner :: Lens' RepositoryAssociation (Maybe Text)
- repositoryAssociation_providerType :: Lens' RepositoryAssociation (Maybe ProviderType)
- repositoryAssociation_s3RepositoryDetails :: Lens' RepositoryAssociation (Maybe S3RepositoryDetails)
- repositoryAssociation_state :: Lens' RepositoryAssociation (Maybe RepositoryAssociationState)
- repositoryAssociation_stateReason :: Lens' RepositoryAssociation (Maybe Text)
- data RepositoryAssociationSummary = RepositoryAssociationSummary' {}
- newRepositoryAssociationSummary :: RepositoryAssociationSummary
- repositoryAssociationSummary_associationArn :: Lens' RepositoryAssociationSummary (Maybe Text)
- repositoryAssociationSummary_associationId :: Lens' RepositoryAssociationSummary (Maybe Text)
- repositoryAssociationSummary_connectionArn :: Lens' RepositoryAssociationSummary (Maybe Text)
- repositoryAssociationSummary_lastUpdatedTimeStamp :: Lens' RepositoryAssociationSummary (Maybe UTCTime)
- repositoryAssociationSummary_name :: Lens' RepositoryAssociationSummary (Maybe Text)
- repositoryAssociationSummary_owner :: Lens' RepositoryAssociationSummary (Maybe Text)
- repositoryAssociationSummary_providerType :: Lens' RepositoryAssociationSummary (Maybe ProviderType)
- repositoryAssociationSummary_state :: Lens' RepositoryAssociationSummary (Maybe RepositoryAssociationState)
- data RepositoryHeadSourceCodeType = RepositoryHeadSourceCodeType' {
- branchName :: Text
- newRepositoryHeadSourceCodeType :: Text -> RepositoryHeadSourceCodeType
- repositoryHeadSourceCodeType_branchName :: Lens' RepositoryHeadSourceCodeType Text
- data RequestMetadata = RequestMetadata' {}
- newRequestMetadata :: RequestMetadata
- requestMetadata_eventInfo :: Lens' RequestMetadata (Maybe EventInfo)
- requestMetadata_requestId :: Lens' RequestMetadata (Maybe Text)
- requestMetadata_requester :: Lens' RequestMetadata (Maybe Text)
- requestMetadata_vendorName :: Lens' RequestMetadata (Maybe VendorName)
- data RuleMetadata = RuleMetadata' {}
- newRuleMetadata :: RuleMetadata
- ruleMetadata_longDescription :: Lens' RuleMetadata (Maybe Text)
- ruleMetadata_ruleId :: Lens' RuleMetadata (Maybe Text)
- ruleMetadata_ruleName :: Lens' RuleMetadata (Maybe Text)
- ruleMetadata_ruleTags :: Lens' RuleMetadata (Maybe (NonEmpty Text))
- ruleMetadata_shortDescription :: Lens' RuleMetadata (Maybe Text)
- data S3BucketRepository = S3BucketRepository' {}
- newS3BucketRepository :: Text -> S3BucketRepository
- s3BucketRepository_details :: Lens' S3BucketRepository (Maybe S3RepositoryDetails)
- s3BucketRepository_name :: Lens' S3BucketRepository Text
- data S3Repository = S3Repository' {
- name :: Text
- bucketName :: Text
- newS3Repository :: Text -> Text -> S3Repository
- s3Repository_name :: Lens' S3Repository Text
- s3Repository_bucketName :: Lens' S3Repository Text
- data S3RepositoryDetails = S3RepositoryDetails' {}
- newS3RepositoryDetails :: S3RepositoryDetails
- s3RepositoryDetails_bucketName :: Lens' S3RepositoryDetails (Maybe Text)
- s3RepositoryDetails_codeArtifacts :: Lens' S3RepositoryDetails (Maybe CodeArtifacts)
- data SourceCodeType = SourceCodeType' {}
- newSourceCodeType :: SourceCodeType
- sourceCodeType_branchDiff :: Lens' SourceCodeType (Maybe BranchDiffSourceCodeType)
- sourceCodeType_commitDiff :: Lens' SourceCodeType (Maybe CommitDiffSourceCodeType)
- sourceCodeType_repositoryHead :: Lens' SourceCodeType (Maybe RepositoryHeadSourceCodeType)
- sourceCodeType_requestMetadata :: Lens' SourceCodeType (Maybe RequestMetadata)
- sourceCodeType_s3BucketRepository :: Lens' SourceCodeType (Maybe S3BucketRepository)
- data ThirdPartySourceRepository = ThirdPartySourceRepository' {}
- newThirdPartySourceRepository :: Text -> Text -> Text -> ThirdPartySourceRepository
- thirdPartySourceRepository_name :: Lens' ThirdPartySourceRepository Text
- thirdPartySourceRepository_connectionArn :: Lens' ThirdPartySourceRepository Text
- thirdPartySourceRepository_owner :: Lens' ThirdPartySourceRepository Text
Service Configuration
defaultService :: Service Source #
API version 2019-09-19 of the Amazon CodeGuru Reviewer SDK configuration.
Errors
_AccessDeniedException :: AsError a => Fold a ServiceError Source #
You do not have sufficient access to perform this action.
_ConflictException :: AsError a => Fold 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.
_InternalServerException :: AsError a => Fold a ServiceError Source #
The server encountered an internal error and is unable to complete the request.
_NotFoundException :: AsError a => Fold a ServiceError Source #
The resource specified in the request was not found.
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
The resource specified in the request was not found.
_ThrottlingException :: AsError a => Fold a ServiceError Source #
The request was denied due to request throttling.
_ValidationException :: AsError a => Fold a ServiceError Source #
The input fails to satisfy the specified constraints.
AnalysisType
newtype AnalysisType Source #
Constructors
| AnalysisType' | |
Fields | |
Bundled Patterns
| pattern AnalysisType_CodeQuality :: AnalysisType | |
| pattern AnalysisType_Security :: AnalysisType |
Instances
ConfigFileState
newtype ConfigFileState Source #
Constructors
| ConfigFileState' | |
Fields | |
Bundled Patterns
| pattern ConfigFileState_Absent :: ConfigFileState | |
| pattern ConfigFileState_Present :: ConfigFileState | |
| pattern ConfigFileState_PresentWithErrors :: ConfigFileState |
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' | |
Fields
| |
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.
branchDiffSourceCodeType_sourceBranchName :: Lens' BranchDiffSourceCodeType Text Source #
The source branch for a diff in an associated repository.
branchDiffSourceCodeType_destinationBranchName :: Lens' BranchDiffSourceCodeType Text Source #
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' | |
Fields
| |
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 GitHub Actions
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.
codeArtifacts_buildArtifactsObjectKey :: Lens' CodeArtifacts (Maybe Text) Source #
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 GitHub Actions in the Amazon CodeGuru Reviewer User Guide.
codeArtifacts_sourceCodeArtifactsObjectKey :: Lens' CodeArtifacts Text Source #
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' | |
Fields
| |
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.
codeCommitRepository_name :: Lens' CodeCommitRepository Text Source #
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' | |
Fields
| |
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:analysisTypes:CodeReview', codeReview_analysisTypes - The types of analysis performed during a repository analysis or a pull
request review. You can specify either Security, CodeQuality, or
both.
$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:codeReviewArn:CodeReview', codeReview_codeReviewArn - The Amazon Resource Name (ARN) of the
CodeReview
object.
$sel:configFileState:CodeReview', codeReview_configFileState - The state of the aws-codeguru-reviewer.yml configuration file that
allows the configuration of the CodeGuru Reviewer analysis. The file
either exists, doesn't exist, or exists with errors at the root
directory of your repository.
$sel:createdTimeStamp:CodeReview', codeReview_createdTimeStamp - The time, in milliseconds since the epoch, when the code review was
created.
$sel:lastUpdatedTimeStamp:CodeReview', codeReview_lastUpdatedTimeStamp - The time, in milliseconds since the epoch, when the code review was last
updated.
$sel:metrics:CodeReview', codeReview_metrics - The statistics from the code review.
$sel:name:CodeReview', codeReview_name - The name of the code review.
$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:providerType:CodeReview', codeReview_providerType - The type of repository that contains the reviewed code (for example,
GitHub or Bitbucket).
$sel:pullRequestId:CodeReview', codeReview_pullRequestId - The pull request ID for the code review.
$sel:repositoryName:CodeReview', codeReview_repositoryName - The name of the repository.
$sel:sourceCodeType:CodeReview', codeReview_sourceCodeType - The type of the source code for the code review.
$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:stateReason:CodeReview', codeReview_stateReason - The reason for the state of the code review.
$sel:type':CodeReview', codeReview_type - The type of code review.
codeReview_analysisTypes :: Lens' CodeReview (Maybe [AnalysisType]) Source #
The types of analysis performed during a repository analysis or a pull
request review. You can specify either Security, CodeQuality, or
both.
codeReview_associationArn :: Lens' CodeReview (Maybe Text) Source #
The Amazon Resource Name (ARN) of the RepositoryAssociation that contains the reviewed source code. You can retrieve associated repository ARNs by calling ListRepositoryAssociations.
codeReview_codeReviewArn :: Lens' CodeReview (Maybe Text) Source #
The Amazon Resource Name (ARN) of the CodeReview object.
codeReview_configFileState :: Lens' CodeReview (Maybe ConfigFileState) Source #
The state of the aws-codeguru-reviewer.yml configuration file that
allows the configuration of the CodeGuru Reviewer analysis. The file
either exists, doesn't exist, or exists with errors at the root
directory of your repository.
codeReview_createdTimeStamp :: Lens' CodeReview (Maybe UTCTime) Source #
The time, in milliseconds since the epoch, when the code review was created.
codeReview_lastUpdatedTimeStamp :: Lens' CodeReview (Maybe UTCTime) Source #
The time, in milliseconds since the epoch, when the code review was last updated.
codeReview_metrics :: Lens' CodeReview (Maybe Metrics) Source #
The statistics from the code review.
codeReview_name :: Lens' CodeReview (Maybe Text) Source #
The name of the code review.
codeReview_owner :: Lens' CodeReview (Maybe Text) Source #
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.
codeReview_providerType :: Lens' CodeReview (Maybe ProviderType) Source #
The type of repository that contains the reviewed code (for example, GitHub or Bitbucket).
codeReview_pullRequestId :: Lens' CodeReview (Maybe Text) Source #
The pull request ID for the code review.
codeReview_repositoryName :: Lens' CodeReview (Maybe Text) Source #
The name of the repository.
codeReview_sourceCodeType :: Lens' CodeReview (Maybe SourceCodeType) Source #
The type of the source code for the code review.
codeReview_state :: Lens' CodeReview (Maybe JobState) Source #
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.
codeReview_stateReason :: Lens' CodeReview (Maybe Text) Source #
The reason for the state of the code review.
codeReview_type :: Lens' CodeReview (Maybe Type) Source #
The type of code review.
CodeReviewSummary
data CodeReviewSummary Source #
Information about the summary of the code review.
See: newCodeReviewSummary smart constructor.
Constructors
| CodeReviewSummary' | |
Fields
| |
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:codeReviewArn:CodeReviewSummary', codeReviewSummary_codeReviewArn - The Amazon Resource Name (ARN) of the
CodeReview
object.
$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.
$sel:metricsSummary:CodeReviewSummary', codeReviewSummary_metricsSummary - The statistics from the code review.
$sel:name:CodeReviewSummary', codeReviewSummary_name - The name of the code review.
$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:providerType:CodeReviewSummary', codeReviewSummary_providerType - The provider type of the repository association.
$sel:pullRequestId:CodeReviewSummary', codeReviewSummary_pullRequestId - The pull request ID for the code review.
$sel:repositoryName:CodeReviewSummary', codeReviewSummary_repositoryName - The name of the repository.
$sel:sourceCodeType:CodeReviewSummary', codeReviewSummary_sourceCodeType - Undocumented member.
$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:type':CodeReviewSummary', codeReviewSummary_type - The type of the code review.
codeReviewSummary_codeReviewArn :: Lens' CodeReviewSummary (Maybe Text) Source #
The Amazon Resource Name (ARN) of the CodeReview object.
codeReviewSummary_createdTimeStamp :: Lens' CodeReviewSummary (Maybe UTCTime) Source #
The time, in milliseconds since the epoch, when the code review was created.
codeReviewSummary_lastUpdatedTimeStamp :: Lens' CodeReviewSummary (Maybe UTCTime) Source #
The time, in milliseconds since the epoch, when the code review was last updated.
codeReviewSummary_metricsSummary :: Lens' CodeReviewSummary (Maybe MetricsSummary) Source #
The statistics from the code review.
codeReviewSummary_name :: Lens' CodeReviewSummary (Maybe Text) Source #
The name of the code review.
codeReviewSummary_owner :: Lens' CodeReviewSummary (Maybe Text) Source #
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.
codeReviewSummary_providerType :: Lens' CodeReviewSummary (Maybe ProviderType) Source #
The provider type of the repository association.
codeReviewSummary_pullRequestId :: Lens' CodeReviewSummary (Maybe Text) Source #
The pull request ID for the code review.
codeReviewSummary_repositoryName :: Lens' CodeReviewSummary (Maybe Text) Source #
The name of the repository.
codeReviewSummary_sourceCodeType :: Lens' CodeReviewSummary (Maybe SourceCodeType) Source #
Undocumented member.
codeReviewSummary_state :: Lens' CodeReviewSummary (Maybe JobState) Source #
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.
codeReviewSummary_type :: Lens' CodeReviewSummary (Maybe Type) Source #
The type of the code review.
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' | |
Fields
| |
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.
codeReviewType_analysisTypes :: Lens' CodeReviewType (Maybe [AnalysisType]) Source #
They types of analysis performed during a repository analysis or a pull
request review. You can specify either Security, CodeQuality, or
both.
codeReviewType_repositoryAnalysis :: Lens' CodeReviewType RepositoryAnalysis Source #
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.
Constructors
| CommitDiffSourceCodeType' | |
Fields
| |
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: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.
$sel:mergeBaseCommit:CommitDiffSourceCodeType', commitDiffSourceCodeType_mergeBaseCommit - The SHA of the merge base of a commit.
$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.
commitDiffSourceCodeType_destinationCommit :: Lens' CommitDiffSourceCodeType (Maybe Text) Source #
The SHA of the destination commit used to generate a commit diff. This field is required for a pull request code review.
commitDiffSourceCodeType_mergeBaseCommit :: Lens' CommitDiffSourceCodeType (Maybe Text) Source #
The SHA of the merge base of a commit.
commitDiffSourceCodeType_sourceCommit :: Lens' CommitDiffSourceCodeType (Maybe Text) Source #
The SHA of the source 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' | |
Instances
| FromJSON EventInfo Source # | |
| ToJSON EventInfo Source # | |
Defined in Amazonka.CodeGuruReviewer.Types.EventInfo | |
| Generic EventInfo Source # | |
| Read EventInfo Source # | |
| Show EventInfo Source # | |
| NFData EventInfo Source # | |
Defined in Amazonka.CodeGuruReviewer.Types.EventInfo | |
| Eq EventInfo Source # | |
| Hashable EventInfo Source # | |
Defined in Amazonka.CodeGuruReviewer.Types.EventInfo | |
| type Rep EventInfo Source # | |
Defined in Amazonka.CodeGuruReviewer.Types.EventInfo type Rep EventInfo = D1 ('MetaData "EventInfo" "Amazonka.CodeGuruReviewer.Types.EventInfo" "amazonka-codeguru-reviewer-2.0-5PMDLaQhmT9HEhVpSUty9z" 'False) (C1 ('MetaCons "EventInfo'" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "state") '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:name:EventInfo', eventInfo_name - The name of the event. The possible names are pull_request,
workflow_dispatch, schedule, and push
$sel:state:EventInfo', eventInfo_state - The state of an event. The state might be open, closed, or another
state.
eventInfo_name :: Lens' EventInfo (Maybe Text) Source #
The name of the event. The possible names are pull_request,
workflow_dispatch, schedule, and push
eventInfo_state :: Lens' EventInfo (Maybe Text) Source #
The state of an event. The state might be open, closed, or another state.
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 repository association.
See: newKMSKeyDetails smart constructor.
Constructors
| KMSKeyDetails' | |
Fields
| |
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
repository association.
kmsKeyDetails_encryptionOption :: Lens' KMSKeyDetails (Maybe EncryptionOption) Source #
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).
kmsKeyDetails_kmsKeyId :: Lens' KMSKeyDetails (Maybe Text) Source #
The ID of the Amazon Web Services KMS key that is associated with a repository association.
Metrics
Information about the statistics from the code review.
See: newMetrics smart constructor.
Constructors
| Metrics' | |
Fields
| |
Instances
| FromJSON Metrics Source # | |
| Generic Metrics Source # | |
| Read Metrics Source # | |
| Show Metrics Source # | |
| NFData Metrics Source # | |
Defined in Amazonka.CodeGuruReviewer.Types.Metrics | |
| Eq Metrics Source # | |
| Hashable Metrics Source # | |
Defined in Amazonka.CodeGuruReviewer.Types.Metrics | |
| type Rep Metrics Source # | |
Defined in Amazonka.CodeGuruReviewer.Types.Metrics type Rep Metrics = D1 ('MetaData "Metrics" "Amazonka.CodeGuruReviewer.Types.Metrics" "amazonka-codeguru-reviewer-2.0-5PMDLaQhmT9HEhVpSUty9z" '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)) :*: S1 ('MetaSel ('Just "suppressedLinesOfCodeCount") '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 - MeteredLinesOfCodeCount 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.
$sel:suppressedLinesOfCodeCount:Metrics', metrics_suppressedLinesOfCodeCount - SuppressedLinesOfCodeCount is the number of lines of code in the
repository where the code review happened that CodeGuru Reviewer did not
analyze. The lines suppressed in the analysis is based on the
excludeFiles variable in the aws-codeguru-reviewer.yml file. This
number does not include non-code lines such as comments and blank lines.
metrics_findingsCount :: Lens' Metrics (Maybe Integer) Source #
Total number of recommendations found in the code review.
metrics_meteredLinesOfCodeCount :: Lens' Metrics (Maybe Integer) Source #
MeteredLinesOfCodeCount 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.
metrics_suppressedLinesOfCodeCount :: Lens' Metrics (Maybe Integer) Source #
SuppressedLinesOfCodeCount is the number of lines of code in the
repository where the code review happened that CodeGuru Reviewer did not
analyze. The lines suppressed in the analysis is based on the
excludeFiles variable in the aws-codeguru-reviewer.yml file. This
number 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' | |
Fields
| |
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.
$sel:suppressedLinesOfCodeCount:MetricsSummary', metricsSummary_suppressedLinesOfCodeCount - Lines of code suppressed in the code review based on the excludeFiles
element in the aws-codeguru-reviewer.yml file. For full repository
analyses, this number includes all lines of code in the files that are
suppressed. For pull requests, this number only includes the changed
lines of code that are suppressed. In both cases, this number does not
include non-code lines such as comments and import statements. For
example, if you initiate a full repository analysis on a repository
containing 5 files, each file with 100 lines of code, and 2 files are
listed as excluded in the aws-codeguru-reviewer.yml file, then
SuppressedLinesOfCodeCount returns 200 (2 * 100) as the total number
of lines of code suppressed. However, if you submit a pull request for
the same repository, then SuppressedLinesOfCodeCount only includes the
lines in the 2 files that changed. If only 1 of the 2 files changed in
the pull request, then SuppressedLinesOfCodeCount returns 100 (1 *
100) as the total number of lines of code suppressed.
metricsSummary_findingsCount :: Lens' MetricsSummary (Maybe Integer) Source #
Total number of recommendations found in the code review.
metricsSummary_meteredLinesOfCodeCount :: Lens' MetricsSummary (Maybe Integer) Source #
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.
metricsSummary_suppressedLinesOfCodeCount :: Lens' MetricsSummary (Maybe Integer) Source #
Lines of code suppressed in the code review based on the excludeFiles
element in the aws-codeguru-reviewer.yml file. For full repository
analyses, this number includes all lines of code in the files that are
suppressed. For pull requests, this number only includes the changed
lines of code that are suppressed. In both cases, this number does not
include non-code lines such as comments and import statements. For
example, if you initiate a full repository analysis on a repository
containing 5 files, each file with 100 lines of code, and 2 files are
listed as excluded in the aws-codeguru-reviewer.yml file, then
SuppressedLinesOfCodeCount returns 200 (2 * 100) as the total number
of lines of code suppressed. However, if you submit a pull request for
the same repository, then SuppressedLinesOfCodeCount only includes the
lines in the 2 files that changed. If only 1 of the 2 files changed in
the pull request, then SuppressedLinesOfCodeCount returns 100 (1 *
100) as the total number of lines of code suppressed.
RecommendationFeedback
data RecommendationFeedback Source #
Information about the recommendation feedback.
See: newRecommendationFeedback smart constructor.
Constructors
| RecommendationFeedback' | |
Fields
| |
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: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.
$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: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.
recommendationFeedback_codeReviewArn :: Lens' RecommendationFeedback (Maybe Text) Source #
The Amazon Resource Name (ARN) of the CodeReview object.
recommendationFeedback_createdTimeStamp :: Lens' RecommendationFeedback (Maybe UTCTime) Source #
The time at which the feedback was created.
recommendationFeedback_lastUpdatedTimeStamp :: Lens' RecommendationFeedback (Maybe UTCTime) Source #
The time at which the feedback was last updated.
recommendationFeedback_reactions :: Lens' RecommendationFeedback (Maybe [Reaction]) Source #
List for storing reactions. Reactions are utf-8 text code for emojis. You can send an empty list to clear off all your feedback.
recommendationFeedback_recommendationId :: Lens' RecommendationFeedback (Maybe Text) Source #
The recommendation ID that can be used to track the provided recommendations. Later on it can be used to collect the feedback.
recommendationFeedback_userId :: Lens' RecommendationFeedback (Maybe Text) Source #
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.
RecommendationFeedbackSummary
data RecommendationFeedbackSummary Source #
Information about recommendation feedback summaries.
See: newRecommendationFeedbackSummary smart constructor.
Constructors
| RecommendationFeedbackSummary' | |
Fields
| |
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:reactions:RecommendationFeedbackSummary', recommendationFeedbackSummary_reactions - List for storing reactions. Reactions are utf-8 text code for emojis.
$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.
recommendationFeedbackSummary_reactions :: Lens' RecommendationFeedbackSummary (Maybe [Reaction]) Source #
List for storing reactions. Reactions are utf-8 text code for emojis.
recommendationFeedbackSummary_recommendationId :: Lens' RecommendationFeedbackSummary (Maybe Text) Source #
The recommendation ID that can be used to track the provided recommendations. Later on it can be used to collect the feedback.
recommendationFeedbackSummary_userId :: Lens' RecommendationFeedbackSummary (Maybe Text) Source #
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.
RecommendationSummary
data RecommendationSummary Source #
Information about recommendations.
See: newRecommendationSummary smart constructor.
Constructors
| RecommendationSummary' | |
Fields
| |
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: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: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:filePath:RecommendationSummary', recommendationSummary_filePath - Name of the file on which a recommendation is provided.
$sel:recommendationCategory:RecommendationSummary', recommendationSummary_recommendationCategory - The type of a recommendation.
$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: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:severity:RecommendationSummary', recommendationSummary_severity - The severity of the issue in the code that generated this
recommendation.
$sel:startLine:RecommendationSummary', recommendationSummary_startLine - Start line from where the recommendation is applicable in the source
commit or source branch.
recommendationSummary_description :: Lens' RecommendationSummary (Maybe Text) Source #
A description of the recommendation generated by CodeGuru Reviewer for the lines of code between the start line and the end line.
recommendationSummary_endLine :: Lens' RecommendationSummary (Maybe Int) Source #
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.
recommendationSummary_filePath :: Lens' RecommendationSummary (Maybe Text) Source #
Name of the file on which a recommendation is provided.
recommendationSummary_recommendationCategory :: Lens' RecommendationSummary (Maybe RecommendationCategory) Source #
The type of a recommendation.
recommendationSummary_recommendationId :: Lens' RecommendationSummary (Maybe Text) Source #
The recommendation ID that can be used to track the provided recommendations. Later on it can be used to collect the feedback.
recommendationSummary_ruleMetadata :: Lens' RecommendationSummary (Maybe 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.
recommendationSummary_severity :: Lens' RecommendationSummary (Maybe Severity) Source #
The severity of the issue in the code that generated this recommendation.
recommendationSummary_startLine :: Lens' RecommendationSummary (Maybe Int) Source #
Start line from where the recommendation is applicable in the source commit or source branch.
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' | |
Fields
| |
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:bitbucket:Repository', repository_bitbucket - Information about a Bitbucket repository.
$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.
repository_bitbucket :: Lens' Repository (Maybe ThirdPartySourceRepository) Source #
Information about a Bitbucket repository.
repository_codeCommit :: Lens' Repository (Maybe CodeCommitRepository) Source #
Information about an Amazon Web Services CodeCommit repository.
repository_gitHubEnterpriseServer :: Lens' Repository (Maybe ThirdPartySourceRepository) Source #
Information about a GitHub Enterprise Server repository.
repository_s3Bucket :: Lens' Repository (Maybe S3Repository) Source #
Undocumented member.
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' | |
Fields
| |
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:
RepositoryAnalysis, repositoryAnalysis_repositoryHead - A
SourceCodeType
that specifies the tip of a branch in an associated repository.
$sel:sourceCodeType:RepositoryAnalysis', repositoryAnalysis_sourceCodeType - Undocumented member.
repositoryAnalysis_repositoryHead :: Lens' RepositoryAnalysis (Maybe RepositoryHeadSourceCodeType) Source #
A SourceCodeType that specifies the tip of a branch in an associated repository.
repositoryAnalysis_sourceCodeType :: Lens' RepositoryAnalysis (Maybe SourceCodeType) Source #
Undocumented member.
RepositoryAssociation
data RepositoryAssociation Source #
Information about a repository association. The
DescribeRepositoryAssociation
operation returns a RepositoryAssociation object.
See: newRepositoryAssociation smart constructor.
Constructors
| RepositoryAssociation' | |
Fields
| |
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: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:createdTimeStamp:RepositoryAssociation', repositoryAssociation_createdTimeStamp - The time, in milliseconds since the epoch, when the repository
association was created.
$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 repository association.
$sel:lastUpdatedTimeStamp:RepositoryAssociation', repositoryAssociation_lastUpdatedTimeStamp - The time, in milliseconds since the epoch, when the repository
association was last updated.
$sel:name:RepositoryAssociation', repositoryAssociation_name - The name of the repository.
$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:providerType:RepositoryAssociation', repositoryAssociation_providerType - The provider type of the repository association.
$sel:s3RepositoryDetails:RepositoryAssociation', repositoryAssociation_s3RepositoryDetails - Undocumented member.
$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 anassociated 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:stateReason:RepositoryAssociation', repositoryAssociation_stateReason - A description of why the repository association is in the current state.
repositoryAssociation_associationArn :: Lens' RepositoryAssociation (Maybe Text) Source #
The Amazon Resource Name (ARN) identifying the repository association.
repositoryAssociation_associationId :: Lens' RepositoryAssociation (Maybe Text) Source #
The ID of the repository association.
repositoryAssociation_connectionArn :: Lens' RepositoryAssociation (Maybe Text) Source #
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.
repositoryAssociation_createdTimeStamp :: Lens' RepositoryAssociation (Maybe UTCTime) Source #
The time, in milliseconds since the epoch, when the repository association was created.
repositoryAssociation_kmsKeyDetails :: Lens' RepositoryAssociation (Maybe KMSKeyDetails) Source #
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 repository association.
repositoryAssociation_lastUpdatedTimeStamp :: Lens' RepositoryAssociation (Maybe UTCTime) Source #
The time, in milliseconds since the epoch, when the repository association was last updated.
repositoryAssociation_name :: Lens' RepositoryAssociation (Maybe Text) Source #
The name of the repository.
repositoryAssociation_owner :: Lens' RepositoryAssociation (Maybe Text) Source #
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.
repositoryAssociation_providerType :: Lens' RepositoryAssociation (Maybe ProviderType) Source #
The provider type of the repository association.
repositoryAssociation_s3RepositoryDetails :: Lens' RepositoryAssociation (Maybe S3RepositoryDetails) Source #
Undocumented member.
repositoryAssociation_state :: Lens' RepositoryAssociation (Maybe RepositoryAssociationState) Source #
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 anassociated 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.
repositoryAssociation_stateReason :: Lens' RepositoryAssociation (Maybe Text) Source #
A description of why the repository association is in the current state.
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' | |
Fields
| |
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: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.
$sel:name:RepositoryAssociationSummary', repositoryAssociationSummary_name - The name 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:providerType:RepositoryAssociationSummary', repositoryAssociationSummary_providerType - The provider type of the repository association.
$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 anassociated 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.
repositoryAssociationSummary_associationArn :: Lens' RepositoryAssociationSummary (Maybe Text) Source #
The Amazon Resource Name (ARN) of the RepositoryAssociation object. You can retrieve this ARN by calling ListRepositoryAssociations.
repositoryAssociationSummary_associationId :: Lens' RepositoryAssociationSummary (Maybe Text) Source #
The repository association ID.
repositoryAssociationSummary_connectionArn :: Lens' RepositoryAssociationSummary (Maybe Text) Source #
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.
repositoryAssociationSummary_lastUpdatedTimeStamp :: Lens' RepositoryAssociationSummary (Maybe UTCTime) Source #
The time, in milliseconds since the epoch, since the repository association was last updated.
repositoryAssociationSummary_name :: Lens' RepositoryAssociationSummary (Maybe Text) Source #
The name of the repository association.
repositoryAssociationSummary_owner :: Lens' RepositoryAssociationSummary (Maybe Text) Source #
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.
repositoryAssociationSummary_providerType :: Lens' RepositoryAssociationSummary (Maybe ProviderType) Source #
The provider type of the repository association.
repositoryAssociationSummary_state :: Lens' RepositoryAssociationSummary (Maybe RepositoryAssociationState) Source #
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 anassociated 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.
RepositoryHeadSourceCodeType
data RepositoryHeadSourceCodeType Source #
A SourceCodeType that specifies the tip of a branch in an associated repository.
See: newRepositoryHeadSourceCodeType smart constructor.
Constructors
| RepositoryHeadSourceCodeType' | |
Fields
| |
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.
repositoryHeadSourceCodeType_branchName :: Lens' RepositoryHeadSourceCodeType Text Source #
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' | |
Fields
| |
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:eventInfo:RequestMetadata', requestMetadata_eventInfo - Information about the event associated with a code review.
$sel:requestId:RequestMetadata', requestMetadata_requestId - The ID of the request. This is required for a pull request code review.
$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.
$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.
requestMetadata_eventInfo :: Lens' RequestMetadata (Maybe EventInfo) Source #
Information about the event associated with a code review.
requestMetadata_requestId :: Lens' RequestMetadata (Maybe Text) Source #
The ID of the request. This is required for a pull request code review.
requestMetadata_requester :: Lens' RequestMetadata (Maybe Text) Source #
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.
requestMetadata_vendorName :: Lens' RequestMetadata (Maybe VendorName) Source #
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.
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' | |
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:ruleId:RuleMetadata', ruleMetadata_ruleId - The ID of the rule.
$sel:ruleName:RuleMetadata', ruleMetadata_ruleName - The name of the rule.
$sel:ruleTags:RuleMetadata', ruleMetadata_ruleTags - Tags that are associated with the rule.
$sel:shortDescription:RuleMetadata', ruleMetadata_shortDescription - A short description of the rule.
ruleMetadata_longDescription :: Lens' RuleMetadata (Maybe Text) Source #
A long description of the rule.
ruleMetadata_ruleId :: Lens' RuleMetadata (Maybe Text) Source #
The ID of the rule.
ruleMetadata_ruleName :: Lens' RuleMetadata (Maybe Text) Source #
The name of the rule.
ruleMetadata_ruleTags :: Lens' RuleMetadata (Maybe (NonEmpty Text)) Source #
Tags that are associated with the rule.
ruleMetadata_shortDescription :: Lens' RuleMetadata (Maybe Text) Source #
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' | |
Fields
| |
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.
s3BucketRepository_details :: Lens' S3BucketRepository (Maybe S3RepositoryDetails) Source #
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.
s3BucketRepository_name :: Lens' S3BucketRepository Text Source #
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' | |
Fields
| |
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-.
s3Repository_name :: Lens' S3Repository Text Source #
The name of the repository in the S3 bucket.
s3Repository_bucketName :: Lens' S3Repository Text Source #
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' | |
Fields
| |
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:bucketName:S3RepositoryDetails', s3RepositoryDetails_bucketName - The name of the S3 bucket used for associating a new S3 repository. It
must begin with codeguru-reviewer-.
$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.
s3RepositoryDetails_bucketName :: Lens' S3RepositoryDetails (Maybe Text) Source #
The name of the S3 bucket used for associating a new S3 repository. It
must begin with codeguru-reviewer-.
s3RepositoryDetails_codeArtifacts :: Lens' S3RepositoryDetails (Maybe CodeArtifacts) Source #
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.
SourceCodeType
data SourceCodeType Source #
Specifies the source code that is analyzed in a code review.
See: newSourceCodeType smart constructor.
Constructors
| SourceCodeType' | |
Fields
| |
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:branchDiff:SourceCodeType', sourceCodeType_branchDiff - A type of
SourceCodeType
that specifies a source branch name and a destination branch name in an
associated repository.
$sel:commitDiff:SourceCodeType', sourceCodeType_commitDiff - A
SourceCodeType
that specifies a commit diff created by a pull request on an associated
repository.
$sel:repositoryHead:SourceCodeType', sourceCodeType_repositoryHead - Undocumented member.
$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: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.
sourceCodeType_branchDiff :: Lens' SourceCodeType (Maybe BranchDiffSourceCodeType) Source #
A type of SourceCodeType that specifies a source branch name and a destination branch name in an associated repository.
sourceCodeType_commitDiff :: Lens' SourceCodeType (Maybe CommitDiffSourceCodeType) Source #
A SourceCodeType that specifies a commit diff created by a pull request on an associated repository.
sourceCodeType_repositoryHead :: Lens' SourceCodeType (Maybe RepositoryHeadSourceCodeType) Source #
Undocumented member.
sourceCodeType_requestMetadata :: Lens' SourceCodeType (Maybe RequestMetadata) Source #
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.
sourceCodeType_s3BucketRepository :: Lens' SourceCodeType (Maybe S3BucketRepository) Source #
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.
ThirdPartySourceRepository
data ThirdPartySourceRepository Source #
Information about a third-party source repository connected to CodeGuru Reviewer.
See: newThirdPartySourceRepository smart constructor.
Constructors
| ThirdPartySourceRepository' | |
Fields
| |
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
thirdPartySourceRepository_name :: Lens' ThirdPartySourceRepository Text Source #
The name of the third party source repository.
thirdPartySourceRepository_connectionArn :: Lens' ThirdPartySourceRepository Text Source #
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.
thirdPartySourceRepository_owner :: Lens' ThirdPartySourceRepository Text Source #
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