This section provides documentation for the Amazon CodeGuru Reviewer API operations. CodeGuru Reviewer is a service that uses program analysis and machine learning to detect potential defects that are difficult for developers to find and recommends fixes in your Java and Python code.
By proactively detecting and providing recommendations for addressing code defects and implementing best practices, CodeGuru Reviewer improves the overall quality and maintainability of your code base during the code review stage. For more information about CodeGuru Reviewer, see the Amazon CodeGuru Reviewer User Guide.
To improve the security of your CodeGuru Reviewer API calls, you can establish a private connection between your VPC and CodeGuru Reviewer by creating an interface VPC endpoint. For more information, see CodeGuru Reviewer and interface VPC endpoints (Amazon Web Services PrivateLink) in the Amazon CodeGuru Reviewer User Guide.
x-logo: url: https://twitter.com/awscloud/profile_image?size=original backgroundColor: '#FFFFFF' termsOfService: https://aws.amazon.com/service-terms/ contact: name: Mike Ralphson email: mike.ralphson@gmail.com url: https://github.com/mermade/aws2openapi x-twitter: PermittedSoc license: name: Apache 2.0 License url: http://www.apache.org/licenses/ x-providerName: amazonaws.com x-serviceName: codeguru-reviewer x-aws-signingName: codeguru-reviewer x-origin: - contentType: application/json url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/codeguru-reviewer-2019-09-19.normal.json converter: url: https://github.com/mermade/aws2openapi version: 1.0.0 x-apisguru-driver: external x-apiClientRegistration: url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct x-apisguru-categories: - cloud x-preferred: true servers: - url: http://codeguru-reviewer.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The CodeGuruReviewer multi-region endpoint - url: https://codeguru-reviewer.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The CodeGuruReviewer multi-region endpoint - url: http://codeguru-reviewer.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The CodeGuruReviewer endpoint for China (Beijing) and China (Ningxia) - url: https://codeguru-reviewer.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The CodeGuruReviewer endpoint for China (Beijing) and China (Ningxia) security: - hmac: [] tags: - name: Feedback paths: /feedback/{CodeReviewArn}#RecommendationId: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' get: operationId: DescribeRecommendationFeedback description: Describes the customer feedback for a CodeGuru Reviewer recommendation. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeRecommendationFeedbackResponse' examples: DescribeRecommendationFeedback200Example: summary: Default DescribeRecommendationFeedback 200 response x-microcks-default: true value: RecommendationFeedback: example-value '480': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' examples: DescribeRecommendationFeedback480Example: summary: Default DescribeRecommendationFeedback 480 response x-microcks-default: true value: example-value '481': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: DescribeRecommendationFeedback481Example: summary: Default DescribeRecommendationFeedback 481 response x-microcks-default: true value: example-value '482': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' examples: DescribeRecommendationFeedback482Example: summary: Default DescribeRecommendationFeedback 482 response x-microcks-default: true value: example-value '483': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' examples: DescribeRecommendationFeedback483Example: summary: Default DescribeRecommendationFeedback 483 response x-microcks-default: true value: example-value '484': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' examples: DescribeRecommendationFeedback484Example: summary: Default DescribeRecommendationFeedback 484 response x-microcks-default: true value: example-value parameters: - name: CodeReviewArn in: path required: true description: 'The Amazon Resource Name (ARN) of the CodeReview object. ' schema: type: string pattern: ^arn:aws[^:\s]*:codeguru-reviewer:[^:\s]+:[\d]{12}:[a-z-]+:[\w-]+$ minLength: 1 maxLength: 1600 - name: RecommendationId in: query required: true description: The recommendation ID that can be used to track the provided recommendations and then to collect the feedback. schema: type: string minLength: 1 maxLength: 64 - name: UserId in: query required: false description:Optional parameter to describe the feedback for a given user. If this is not supplied, it defaults to the user making the request.
The UserId is an IAM principal that can be specified as an Amazon Web Services account ID or an Amazon Resource Name (ARN). For more information, see Specifying a Principal in the Amazon Web Services Identity and Access Management User Guide.
nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.
schema:
type: string
minLength: 1
maxLength: 2048
- name: MaxResults
in: query
required: false
description: The maximum number of results that are returned per call. The default is 100.
schema:
type: integer
minimum: 1
maximum: 100
- name: CodeReviewArn
in: path
required: true
description: 'The Amazon Resource Name (ARN) of the CodeReview object. '
schema:
type: string
pattern: ^arn:aws[^:\s]*:codeguru-reviewer:[^:\s]+:[\d]{12}:[a-z-]+:[\w-]+$
minLength: 1
maxLength: 1600
- name: UserIds
in: query
required: false
description: An Amazon Web Services user's account ID or Amazon Resource Name (ARN). Use this ID to query the recommendation feedback for a code review from that user.
The UserId is an IAM principal that can be specified as an Amazon Web Services account ID or an Amazon Resource Name (ARN). For more information, see Specifying a Principal in the Amazon Web Services Identity and Access Management User Guide.
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.
nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.
NextToken:
type: string
minLength: 1
maxLength: 2048
TimeStamp:
type: string
format: date-time
PutRecommendationFeedbackResponse:
type: object
properties: {}
Arn:
type: string
pattern: ^arn:aws[^:\s]*:codeguru-reviewer:[^:\s]+:[\d]{12}:[a-z-]+:[\w-]+$
minLength: 1
maxLength: 1600
ThrottlingException: {}
RecommendationId:
type: string
minLength: 1
maxLength: 64
AccessDeniedException: {}
InternalServerException: {}
RecommendationFeedbackSummaries:
type: array
items:
$ref: '#/components/schemas/RecommendationFeedbackSummary'
DescribeRecommendationFeedbackResponse:
type: object
properties:
RecommendationFeedback:
allOf:
- $ref: '#/components/schemas/RecommendationFeedback'
- description: The recommendation feedback given by the user.
Reactions:
type: array
items:
$ref: '#/components/schemas/Reaction'
minItems: 0
maxItems: 1
RecommendationFeedbackSummary:
type: object
properties:
RecommendationId:
allOf:
- $ref: '#/components/schemas/RecommendationId'
- description: The recommendation ID that can be used to track the provided recommendations. Later on it can be used to collect the feedback.
Reactions:
allOf:
- $ref: '#/components/schemas/Reactions'
- description: List for storing reactions. Reactions are utf-8 text code for emojis.
UserId:
allOf:
- $ref: '#/components/schemas/UserId'
- description: 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.