Module types

Data structures used by operation inputs/outputs.

Modules

builders

Builders

error

Error types that Amazon CodeGuru Reviewer can respond with.

Structs

BranchDiffSourceCodeType

A type of SourceCodeType that specifies a code diff between a source and destination branch in an associated repository.

CodeArtifacts

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.

CodeCommitRepository

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.

CodeReview

Information about a code review. A code review belongs to the associated repository that contains the reviewed code.

CodeReviewSummary

Information about the summary of the code review.

CodeReviewType

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.

CommitDiffSourceCodeType

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.

EventInfo

Information about an event. The event might be a push, pull request, scheduled request, or another type of event.

KmsKeyDetails

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.

Metrics

Information about the statistics from the code review.

MetricsSummary

Information about metrics summaries.

RecommendationFeedback

Information about the recommendation feedback.

RecommendationFeedbackSummary

Information about recommendation feedback summaries.

RecommendationSummary

Information about recommendations.

Repository

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.

RepositoryAnalysis

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.

RepositoryAssociation

Information about a repository association. The DescribeRepositoryAssociation operation returns a RepositoryAssociation object.

RepositoryAssociationSummary

Summary information about a repository association. The ListRepositoryAssociations operation returns a list of RepositoryAssociationSummary objects.

RepositoryHeadSourceCodeType

A SourceCodeType that specifies the tip of a branch in an associated repository.

RequestMetadata

Metadata that is associated with a code review. This applies to both pull request and repository analysis code reviews.

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.

S3BucketRepository

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.

S3Repository

Information about a repository in an S3 bucket.

S3RepositoryDetails

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.

SourceCodeType

Specifies the source code that is analyzed in a code review.

ThirdPartySourceRepository

Information about a third-party source repository connected to CodeGuru Reviewer.

Enums

AnalysisType

When writing a match expression against AnalysisType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

ConfigFileState

When writing a match expression against ConfigFileState, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

EncryptionOption

When writing a match expression against EncryptionOption, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

JobState

When writing a match expression against JobState, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

ProviderType

When writing a match expression against ProviderType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

Reaction

When writing a match expression against Reaction, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

RecommendationCategory

When writing a match expression against RecommendationCategory, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

RepositoryAssociationState

When writing a match expression against RepositoryAssociationState, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

Severity

When writing a match expression against Severity, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

Type

When writing a match expression against Type, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

VendorName

When writing a match expression against VendorName, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.