How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Amazon CodeGuru Reviewer Codereviews API

The Codereviews API from Amazon CodeGuru Reviewer — 3 operation(s) for codereviews.

Amazon CodeGuru Reviewer Codereviews API is one of 5 APIs that Amazon CodeGuru Reviewer publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Codereviews. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 3 operations across 3 paths, and defines 62 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against 4 base URLs: http://codeguru-reviewer.{region}.amazonaws.com, https://codeguru-reviewer.{region}.amazonaws.com, http://codeguru-reviewer.{region}.amazonaws.com.cn, https://codeguru-reviewer.{region}.amazonaws.com.cn.

3 operations 3 paths 62 schemas 2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://codeguru-reviewer.us-east-1.amazonaws.com
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

Amazon CodeGuru Reviewer Codereviews API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (hmac). By default, every request must be authenticated.

  • hmac — Amazon Signature authorization v4

Paths & Operations 3

Across 3 paths, the API surfaces 3 operations — 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Codereviews 3
POST
/codereviews
Amazon CodeGuru Reviewer Create Code Review
CreateCodeReview 7 params body → 200480481482483484485
GET
/codereviews/{CodeReviewArn}
Amazon CodeGuru Reviewer Describe Code Review
DescribeCodeReview 8 params → 200480481482483484
GET
/codereviews/{CodeReviewArn}/Recommendations
Amazon CodeGuru Reviewer List Recommendations
ListRecommendations 10 params → 200480481482483484

Schemas 62

The contract defines 62 schemas that model the data the API accepts and returns. The most detailed are CodeReview (16 properties), RecommendationSummary (8 properties), SourceCodeType (5 properties), RuleMetadata (5 properties). Each schema is shown below with its type and property counts.

FilePath
string
Metrics
object
Information about the statistics from the code review.
3 properties
ValidationException
CommitId
string
RuleName
string
RepositoryAnalysis
object
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 c…
2 properties
TimeStamp
string
S3BucketRepository
object
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 con…
2 properties 1 required
EventName
string
DescribeCodeReviewResponse
object
1 property
CreateCodeReviewResponse
object
1 property
RecommendationSummaries
array
Owner
string
SourceCodeArtifactsObjectKey
string
BranchName
string
RepositoryHeadSourceCodeType
object
A SourceCodeType that specifies the tip of a branch in an associated repository.
1 property 1 required
ListRecommendationsResponse
object
2 properties
AnalysisTypes
array
Arn
string
RuleTags
array
CodeReview
object
Information about a code review. A code review belongs to the associated repository that contains the reviewed code.
16 properties
BranchDiffSourceCodeType
object
A type of SourceCodeType that specifies a code diff between a source and destination branch in an associated repository.
2 properties 2 required
S3BucketName
string
Type
string
StateReason
string
RecommendationId
string
FindingsCount
integer
SourceCodeType
object
Specifies the source code that is analyzed in a code review.
5 properties
RequestMetadata
object
Metadata that is associated with a code review. This applies to both pull request and repository analysis code reviews.
4 properties
PullRequestId
string
InternalServerException
ConflictException
AssociationArn
string
LineNumber
integer
RuleMetadata
object
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…
5 properties
CommitDiffSourceCodeType
object
A type of SourceCodeType that specifies the commit diff for a pull request on an associated repository. The SourceCommit and DestinationCommit fields are requi…
3 properties
ConfigFileState
string
Severity
string
ProviderType
string
Text
string
EventInfo
object
Information about an event. The event might be a push, pull request, scheduled request, or another type of event.
2 properties
VendorName
string
AccessDeniedException
ThrottlingException
S3RepositoryDetails
object
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…
2 properties
LinesOfCodeCount
integer
LongDescription
string
RecommendationCategory
string
AnalysisType
string
ShortDescription
string
JobState
string
ResourceNotFoundException
RuleTag
string
CodeArtifacts
object
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 file…
2 properties 1 required
RecommendationSummary
object
Information about recommendations.
8 properties
Requester
string
RequestId
string
NextToken
string
Name
string
BuildArtifactsObjectKey
string
EventState
string
RuleId
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

amazon-codeguru-reviewer-codereviews-api-openapi.yml Raw ↑

Other APIs Amazon CodeGuru Reviewer publishes across the network.

Amazon CodeGuru Reviewer Associations API
Amazon CodeGuru Reviewer Codereviews#Type API
Amazon CodeGuru Reviewer Feedback API
Amazon CodeGuru Reviewer Tags API
Where this information came from

This is an independent, third-party profile of Amazon CodeGuru Reviewer Codereviews API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.