openapi: 3.0.0
info:
  version: '2019-09-19'
  x-release: v4
  title: Amazon CodeGuru Reviewer Associations Codereviews API
  description: <p>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.</p> <p>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 <i> <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/welcome.html">Amazon CodeGuru Reviewer User Guide</a>.</i> </p> <p>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 <i>interface VPC endpoint</i>. For more information, see <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/vpc-interface-endpoints.html">CodeGuru Reviewer and interface VPC endpoints (Amazon Web Services PrivateLink)</a> in the <i>Amazon CodeGuru Reviewer User Guide</i>.</p>
  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: Codereviews
paths:
  /codereviews:
    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'
    post:
      operationId: CreateCodeReview
      description: Use to create a code review with a <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CodeReviewType.html">CodeReviewType</a> of <code>RepositoryAnalysis</code>. This type of code review analyzes all code under a specified branch in an associated repository. <code>PullRequest</code> code reviews are automatically triggered by a pull request.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateCodeReviewResponse'
              examples:
                CreateCodeReview200Example:
                  summary: Default CreateCodeReview 200 response
                  x-microcks-default: true
                  value:
                    CodeReview:
                      Name: example-resource
                      CodeReviewArn: arn:aws:service:us-east-1:123456789012:resource/example
                      RepositoryName: example-resource
                      Owner: '123456789012'
                      ProviderType: '500123'
                      State: example-value
                      StateReason: example-value
                      CreatedTimeStamp: example-value
        '480':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
              examples:
                CreateCodeReview480Example:
                  summary: Default CreateCodeReview 480 response
                  x-microcks-default: true
                  value: example-value
        '481':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
              examples:
                CreateCodeReview481Example:
                  summary: Default CreateCodeReview 481 response
                  x-microcks-default: true
                  value: example-value
        '482':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
              examples:
                CreateCodeReview482Example:
                  summary: Default CreateCodeReview 482 response
                  x-microcks-default: true
                  value: example-value
        '483':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
              examples:
                CreateCodeReview483Example:
                  summary: Default CreateCodeReview 483 response
                  x-microcks-default: true
                  value: example-value
        '484':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
              examples:
                CreateCodeReview484Example:
                  summary: Default CreateCodeReview 484 response
                  x-microcks-default: true
                  value: example-value
        '485':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
              examples:
                CreateCodeReview485Example:
                  summary: Default CreateCodeReview 485 response
                  x-microcks-default: true
                  value: example-value
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - Name
              - RepositoryAssociationArn
              - Type
              properties:
                Name:
                  description: The name of the code review. The name of each code review in your Amazon Web Services account must be unique.
                  type: string
                  pattern: '[a-zA-Z0-9-_]*'
                  minLength: 1
                  maxLength: 100
                RepositoryAssociationArn:
                  description: <p>The Amazon Resource Name (ARN) of the <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociation.html">RepositoryAssociation</a> object. You can retrieve this ARN by calling <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_ListRepositoryAssociations.html">ListRepositoryAssociations</a>.</p> <p>A code review can only be created on an associated repository. This is the ARN of the associated repository.</p>
                  type: string
                  pattern: ^arn:aws[^:\s]*:codeguru-reviewer:[^:\s]+:[\d]{12}:association:[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
                  minLength: 1
                  maxLength: 1600
                Type:
                  description: <p>The type of a code review. There are two code review types:</p> <ul> <li> <p> <code>PullRequest</code> - A code review that is automatically triggered by a pull request on an associated repository.</p> </li> <li> <p> <code>RepositoryAnalysis</code> - A code review that analyzes all code under a specified branch in an associated repository. The associated repository is specified using its ARN in <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CreateCodeReview">CreateCodeReview</a>.</p> </li> </ul>
                  type: object
                  properties:
                    RepositoryAnalysis:
                      allOf:
                      - $ref: '#/components/schemas/RepositoryAnalysis'
                      - description: A code review that analyzes all code under a specified branch in an associated repository. The associated repository is specified using its ARN in <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CreateCodeReview">CreateCodeReview</a>.
                    AnalysisTypes:
                      allOf:
                      - $ref: '#/components/schemas/AnalysisTypes'
                      - description: They types of analysis performed during a repository analysis or a pull request review. You can specify either <code>Security</code>, <code>CodeQuality</code>, or both.
                ClientRequestToken:
                  description: Amazon CodeGuru Reviewer uses this value to prevent the accidental creation of duplicate code reviews if there are failures and retries.
                  type: string
                  pattern: ^[\w-]+$
                  minLength: 1
                  maxLength: 64
            examples:
              CreateCodeReviewRequestExample:
                summary: Default CreateCodeReview request
                x-microcks-default: true
                value:
                  Name: example-resource
                  RepositoryAssociationArn: arn:aws:service:us-east-1:123456789012:resource/example
                  Type:
                    RepositoryAnalysis: example-value
                    AnalysisTypes: STANDARD
                  ClientRequestToken: example-value
      summary: Amazon CodeGuru Reviewer Create Code Review
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Codereviews
  /codereviews/{CodeReviewArn}:
    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: DescribeCodeReview
      description: Returns the metadata associated with the code review along with its status.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeCodeReviewResponse'
              examples:
                DescribeCodeReview200Example:
                  summary: Default DescribeCodeReview 200 response
                  x-microcks-default: true
                  value:
                    CodeReview: example-value
        '480':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
              examples:
                DescribeCodeReview480Example:
                  summary: Default DescribeCodeReview 480 response
                  x-microcks-default: true
                  value: example-value
        '481':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
              examples:
                DescribeCodeReview481Example:
                  summary: Default DescribeCodeReview 481 response
                  x-microcks-default: true
                  value: example-value
        '482':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
              examples:
                DescribeCodeReview482Example:
                  summary: Default DescribeCodeReview 482 response
                  x-microcks-default: true
                  value: example-value
        '483':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
              examples:
                DescribeCodeReview483Example:
                  summary: Default DescribeCodeReview 483 response
                  x-microcks-default: true
                  value: example-value
        '484':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
              examples:
                DescribeCodeReview484Example:
                  summary: Default DescribeCodeReview 484 response
                  x-microcks-default: true
                  value: example-value
      parameters:
      - name: CodeReviewArn
        in: path
        required: true
        description: 'The Amazon Resource Name (ARN) of the <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CodeReview.html">CodeReview</a> object. '
        schema:
          type: string
          pattern: ^arn:aws[^:\s]*:codeguru-reviewer:[^:\s]+:[\d]{12}:[a-z-]+:[\w-]+$
          minLength: 1
          maxLength: 1600
      summary: Amazon CodeGuru Reviewer Describe Code Review
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Codereviews
  /codereviews/{CodeReviewArn}/Recommendations:
    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: ListRecommendations
      description: Returns the list of all recommendations for a completed code review.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListRecommendationsResponse'
              examples:
                ListRecommendations200Example:
                  summary: Default ListRecommendations 200 response
                  x-microcks-default: true
                  value:
                    RecommendationSummaries: example-value
                    NextToken: example-value
        '480':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
              examples:
                ListRecommendations480Example:
                  summary: Default ListRecommendations 480 response
                  x-microcks-default: true
                  value: example-value
        '481':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
              examples:
                ListRecommendations481Example:
                  summary: Default ListRecommendations 481 response
                  x-microcks-default: true
                  value: example-value
        '482':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
              examples:
                ListRecommendations482Example:
                  summary: Default ListRecommendations 482 response
                  x-microcks-default: true
                  value: example-value
        '483':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
              examples:
                ListRecommendations483Example:
                  summary: Default ListRecommendations 483 response
                  x-microcks-default: true
                  value: example-value
        '484':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
              examples:
                ListRecommendations484Example:
                  summary: Default ListRecommendations 484 response
                  x-microcks-default: true
                  value: example-value
      parameters:
      - name: NextToken
        in: query
        required: false
        description: Pagination token.
        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: 300
      - name: CodeReviewArn
        in: path
        required: true
        description: 'The Amazon Resource Name (ARN) of the <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CodeReview.html">CodeReview</a> object. '
        schema:
          type: string
          pattern: ^arn:aws[^:\s]*:codeguru-reviewer:[^:\s]+:[\d]{12}:[a-z-]+:[\w-]+$
          minLength: 1
          maxLength: 1600
      summary: Amazon CodeGuru Reviewer List Recommendations
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Codereviews
components:
  schemas:
    Type:
      type: string
      enum:
      - PullRequest
      - RepositoryAnalysis
    RequestMetadata:
      type: object
      properties:
        RequestId:
          allOf:
          - $ref: '#/components/schemas/RequestId'
          - description: The ID of the request. This is required for a pull request code review.
        Requester:
          allOf:
          - $ref: '#/components/schemas/Requester'
          - description: An identifier, such as a name or account ID, that is associated with the requester. The <code>Requester</code> is used to capture the <code>author/actor</code> name of the event request.
        EventInfo:
          allOf:
          - $ref: '#/components/schemas/EventInfo'
          - description: Information about the event associated with a code review.
        VendorName:
          allOf:
          - $ref: '#/components/schemas/VendorName'
          - description: 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 <code>ProviderType</code> is <code>S3Bucket</code> and the CI/CD repository vendor name is GitHub. For more information, see the definition for <code>ProviderType</code> in <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociation.html">RepositoryAssociation</a>.
      description: Metadata that is associated with a code review. This applies to both pull request and repository analysis code reviews.
    ConflictException: {}
    RuleMetadata:
      type: object
      properties:
        RuleId:
          allOf:
          - $ref: '#/components/schemas/RuleId'
          - description: The ID of the rule.
        RuleName:
          allOf:
          - $ref: '#/components/schemas/RuleName'
          - description: The name of the rule.
        ShortDescription:
          allOf:
          - $ref: '#/components/schemas/ShortDescription'
          - description: A short description of the rule.
        LongDescription:
          allOf:
          - $ref: '#/components/schemas/LongDescription'
          - description: A long description of the rule.
        RuleTags:
          allOf:
          - $ref: '#/components/schemas/RuleTags'
          - description: Tags that are associated with the rule.
      description: 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.
    LinesOfCodeCount:
      type: integer
    ProviderType:
      type: string
      enum:
      - CodeCommit
      - GitHub
      - Bitbucket
      - GitHubEnterpriseServer
      - S3Bucket
    PullRequestId:
      type: string
      minLength: 1
      maxLength: 64
    RecommendationCategory:
      type: string
      enum:
      - AWSBestPractices
      - AWSCloudFormationIssues
      - DuplicateCode
      - CodeMaintenanceIssues
      - ConcurrencyIssues
      - InputValidations
      - PythonBestPractices
      - JavaBestPractices
      - ResourceLeaks
      - SecurityIssues
      - CodeInconsistencies
    LineNumber:
      type: integer
    RecommendationSummary:
      type: object
      properties:
        FilePath:
          allOf:
          - $ref: '#/components/schemas/FilePath'
          - description: Name of the file on which a recommendation is provided.
        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.
        StartLine:
          allOf:
          - $ref: '#/components/schemas/LineNumber'
          - description: Start line from where the recommendation is applicable in the source commit or source branch.
        EndLine:
          allOf:
          - $ref: '#/components/schemas/LineNumber'
          - description: 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.
        Description:
          allOf:
          - $ref: '#/components/schemas/Text'
          - description: A description of the recommendation generated by CodeGuru Reviewer for the lines of code between the start line and the end line.
        RecommendationCategory:
          allOf:
          - $ref: '#/components/schemas/RecommendationCategory'
          - description: The type of a recommendation.
        RuleMetadata:
          allOf:
          - $ref: '#/components/schemas/RuleMetadata'
          - description: 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.
        Severity:
          allOf:
          - $ref: '#/components/schemas/Severity'
          - description: The severity of the issue in the code that generated this recommendation.
      description: Information about recommendations.
    DescribeCodeReviewResponse:
      type: object
      properties:
        CodeReview:
          allOf:
          - $ref: '#/components/schemas/CodeReview'
          - description: Information about the code review.
    EventInfo:
      type: object
      properties:
        Name:
          allOf:
          - $ref: '#/components/schemas/EventName'
          - description: 'The name of the event. The possible names are <code>pull_request</code>, <code>workflow_dispatch</code>, <code>schedule</code>, and <code>push</code> '
        State:
          allOf:
          - $ref: '#/components/schemas/EventState'
          - description: The state of an event. The state might be open, closed, or another state.
      description: Information about an event. The event might be a push, pull request, scheduled request, or another type of event.
    Requester:
      type: string
      pattern: ^\S(.*\S)?$
      minLength: 1
      maxLength: 100
    CreateCodeReviewResponse:
      type: object
      properties:
        CodeReview:
          $ref: '#/components/schemas/CodeReview'
    ValidationException: {}
    ResourceNotFoundException: {}
    SourceCodeType:
      type: object
      properties:
        CommitDiff:
          allOf:
          - $ref: '#/components/schemas/CommitDiffSourceCodeType'
          - description: A <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_SourceCodeType">SourceCodeType</a> that specifies a commit diff created by a pull request on an associated repository.
        RepositoryHead:
          $ref: '#/components/schemas/RepositoryHeadSourceCodeType'
        BranchDiff:
          allOf:
          - $ref: '#/components/schemas/BranchDiffSourceCodeType'
          - description: A type of <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_SourceCodeType">SourceCodeType</a> that specifies a source branch name and a destination branch name in an associated repository.
        S3BucketRepository:
          allOf:
          - $ref: '#/components/schemas/S3BucketRepository'
          - description: Information about an associated repository in an S3 bucket that includes its name and an <code>S3RepositoryDetails</code> object. The <code>S3RepositoryDetails</code> 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. <code>S3BucketRepository</code> is required in <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_SourceCodeType">SourceCodeType</a> for <code>S3BucketRepository</code> based code reviews.
        RequestMetadata:
          allOf:
          - $ref: '#/components/schemas/RequestMetadata'
          - description: Metadata that is associated with a code review. This applies to any type of code review supported by CodeGuru Reviewer. The <code>RequestMetadaa</code> field captures any event metadata. For example, it might capture metadata associated with an event trigger, such as a push or a pull request.
      description: Specifies the source code that is analyzed in a code review.
    ConfigFileState:
      type: string
      enum:
      - Present
      - Absent
      - PresentWithErrors
    FilePath:
      type: string
      minLength: 1
      maxLength: 1024
    BuildArtifactsObjectKey:
      type: string
      pattern: ^\S(.*\S)?$
      minLength: 1
      maxLength: 1024
    VendorName:
      type: string
      enum:
      - GitHub
      - GitLab
      - NativeS3
    Name:
      type: string
      pattern: ^\S[\w.-]*$
      minLength: 1
      maxLength: 100
    CommitDiffSourceCodeType:
      type: object
      properties:
        SourceCommit:
          allOf:
          - $ref: '#/components/schemas/CommitId'
          - description: The SHA of the source commit used to generate a commit diff. This field is required for a pull request code review.
        DestinationCommit:
          allOf:
          - $ref: '#/components/schemas/CommitId'
          - description: The SHA of the destination commit used to generate a commit diff. This field is required for a pull request code review.
        MergeBaseCommit:
          allOf:
          - $ref: '#/components/schemas/CommitId'
          - description: The SHA of the merge base of a commit.
      description: A type of <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_SourceCodeType">SourceCodeType</a> that specifies the commit diff for a pull request on an associated repository. The <code>SourceCommit</code> and <code>DestinationCommit</code> fields are required to do a pull request code review.
    AnalysisType:
      type: string
      enum:
      - Security
      - CodeQuality
    Metrics:
      type: object
      properties:
        MeteredLinesOfCodeCount:
          allOf:
          - $ref: '#/components/schemas/LinesOfCodeCount'
          - description: ' <code>MeteredLinesOfCodeCount</code> 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.'
        SuppressedLinesOfCodeCount:
          allOf:
          - $ref: '#/components/schemas/LinesOfCodeCount'
          - description: ' <code>SuppressedLinesOfCodeCount</code> 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 <code>excludeFiles</code> variable in the <code>aws-codeguru-reviewer.yml</code> file. This number does not include non-code lines such as comments and blank lines. '
        FindingsCount:
          allOf:
          - $ref: '#/components/schemas/FindingsCount'
          - description: Total number of recommendations found in the code review.
      description: Information about the statistics from the code review.
    RepositoryAnalysis:
      type: object
      properties:
        RepositoryHead:
          allOf:
          - $ref: '#/components/schemas/RepositoryHeadSourceCodeType'
          - description: A <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_SourceCodeType">SourceCodeType</a> that specifies the tip of a branch in an associated repository.
        SourceCodeType:
          $ref: '#/components/schemas/SourceCodeType'
      description: 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 <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CreateCodeReview">CreateCodeReview</a>.
    BranchDiffSourceCodeType:
      type: object
      required:
      - SourceBranchName
      - DestinationBranchName
      properties:
        SourceBranchName:
          allOf:
          - $ref: '#/components/schemas/BranchName'
          - description: The source branch for a diff in an associated repository.
        DestinationBranchName:
          allOf:
          - $ref: '#/components/schemas/BranchName'
          - description: The destination branch for a diff in an associated repository.
      description: A type of <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_SourceCodeType">SourceCodeType</a> that specifies a code diff between a source and destination branch in an associated repository.
    AnalysisTypes:
      type: array
      items:
        $ref: '#/components/schemas/AnalysisType'
    Owner:
      type: string
      pattern: ^\S(.*\S)?$
      minLength: 1
      maxLength: 100
    StateReason:
      type: string
      minLength: 0
      maxLength: 256
    CommitId:
      type: string
      minLength: 6
      maxLength: 64
    S3RepositoryDetails:
      type: object
      properties:
        BucketName:
          allOf:
          - $ref: '#/components/schemas/S3BucketName'
          - description: 'The name of the S3 bucket used for associating a new S3 repository. It must begin with <code>codeguru-reviewer-</code>. '
        CodeArtifacts:
          allOf:
          - $ref: '#/components/schemas/CodeArtifacts'
          - description: A <code>CodeArtifacts</code> object. The <code>CodeArtifacts</code> 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.
      description: Specifies the name of an S3 bucket and a <code>CodeArtifacts</code> 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.
    BranchName:
      type: string
      minLength: 1
      maxLength: 256
    RepositoryHeadSourceCodeType:
      type: object
      required:
      - BranchName
      properties:
        BranchName:
          allOf:
          - $ref: '#/components/schemas/BranchName'
          - description: The name of the branch in an associated repository. The <code>RepositoryHeadSourceCodeType</code> specifies the tip of this branch.
      description: A <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_SourceCodeType">SourceCodeType</a> that specifies the tip of a branch in an associated repository.
    Text:
      type: string
      minLength: 1
      maxLength: 5000
    S3BucketName:
      type: string
      pattern: ^\S(.*\S)?$
      minLength: 3
      maxLength: 63
    RuleTags:
      type: array
      items:
        $ref: '#/components/schemas/RuleTag'
      minItems: 1
      maxItems: 20
    RequestId:
      type: string
      minLength: 1
      maxLength: 64
    LongDescription:
      type: string
      pattern: ^\S(.*\S)?$
      minLength: 1
      maxLength: 1000
    NextToken:
      type: string
      minLength: 1
      maxLength: 2048
    S3BucketRepository:
      type: object
      required:
      - Name
      properties:
        Name:
          allOf:
          - $ref: '#/components/schemas/Name'
          - description: The name of the repository when the <code>ProviderType</code> is <code>S3Bucket</code>.
        Details:
          allOf:
          - $ref: '#/components/schemas/S3RepositoryDetails'
          - description: An <code>S3RepositoryDetails</code> object that specifies the name of an S3 bucket and a <code>CodeArtifacts</code> object. The <code>CodeArtifacts</code> object includes the S3 object keys for a source code .zip file and for a build artifacts .zip file.
      description: 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.
    EventName:
      type: string
      pattern: ^[ \-A-Z_a-z]+$
      minLength: 1
      maxLength: 32
    SourceCodeArtifactsObjectKey:
      type: string
      pattern: ^\S(.*\S)?$
      minLength: 1
      maxLength: 1024
    TimeStamp:
      type: string
      format: date-time
    RuleId:
      type: string
      pattern: ^\S+\/[a-zA-Z0-9-]+@v\d+\.\d+$
      minLength: 1
      maxLength: 64
    Severity:
      type: string
      enum:
      - Info
      - Low
      - Medium
      - High
      - Critical
    Arn:
      type: string
      pattern: ^arn:aws[^:\s]*:codeguru-reviewer:[^:\s]+:[\d]{12}:[a-z-]+:[\w-]+$
      minLength: 1
      maxLength: 1600
    RuleTag:
      type: string
      pattern: ^\S(.*\S)?$
      minLength: 1
      maxLength: 50
    EventState:
      type: string
      pattern: ^[ \-A-Z_a-z]+$
      minLength: 1
      maxLength: 32
    ThrottlingException: {}
    CodeArtifacts:
      type: object
      required:
      - SourceCodeArtifactsObjectKey
      properties:
        SourceCodeArtifactsObjectKey:
          allOf:
          - $ref: '#/components/schemas/SourceCodeArtifactsObjectKey'
          - description: The S3 object key for a source code .zip file. This is required for all code reviews.
        BuildArtifactsObjectKey:
          allOf:
          - $ref: '#/components/schemas/BuildArtifactsObjectKey'
          - description: 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 <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/working-with-cicd.html">Create code reviews with GitHub Actions</a> in the <i>Amazon CodeGuru Reviewer User Guide</i>.
      description: <p>Code artifacts are source code artifacts and build artifacts used in a repository analysis or a pull request review.</p> <ul> <li> <p>Source code artifacts are source code files in a Git repository that are compressed into a .zip file.</p> </li> <li> <p>Build artifacts are .jar or .class files that are compressed in a .zip file.</p> </li> </ul>
    RecommendationId:
      type: string
      minLength: 1
      maxLength: 64
    RuleName:
      type: string
      pattern: ^\S(.*\S)?$
      minLength: 1
      maxLength: 100
    JobState:
      type: string
      enum:
      - Completed
      - Pending
      - Failed
      - Deleting
    AssociationArn:
      type: string
      pattern: ^arn:aws[^:\s]*:codeguru-reviewer:[^:\s]+:[\d]{12}:association:[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
      minLength: 1
      maxLength: 1600
    AccessDeniedException: {}
    FindingsCount:
      type: integer
    RecommendationSummaries:
      type: array
      items:
        $ref: '#/components/schemas/RecommendationSummary'
    InternalServerException: {}
    ListRecommendationsResponse:
      type: object
      properties:
        RecommendationSummaries:
          allOf:
          - $ref: '#/components/schemas/RecommendationSummaries'
          - description: List of recommendations for the requested code review.
        NextToken:
          allOf:
          - $ref: '#/components/schemas/NextToken'
          - description: Pagination token.
    CodeReview:
      type: object
      properties:
        Name:
          allOf:
          - $ref: '#/components/schemas/Name'
          - description: The name of the code review.
        CodeReviewArn:
          allOf:
          - $ref: '#/components/schemas/Arn'
          - description: 'The Amazon Resource Name (ARN) of the <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CodeReview.html">CodeReview</a> object. '
        RepositoryName:
          allOf:
          - $ref: '#/components/schemas/Name'
          - description: The name of the repository.
        Owner:
          allOf:
          - $ref: '#/components/schemas/Owner'
          - description: 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.
        ProviderType:
          allOf:
          - $ref: '#/components/schemas/ProviderType'
          - description: The type of repository that contains the reviewed code (for example, GitHub or Bitbucket).
        State:
          allOf:
          - $ref: '#/components/schemas/JobState'
          - description: '<p>The valid code review states are:</p> <ul> <li> <p> <code>Completed</code>: The code review is complete.</p> </li> <li> <p> <code>Pending</code>: The code review started and has not completed or failed.</p> </li> <li> <p> <code>Failed</code>: The code review failed.</p> </li> <li> <p> <code>Deleting</code>: The code review is being deleted.</p> </li> </ul>'
        StateReason:
          allOf:
          - $ref: '#/components/schemas/StateReason'
          - description: The reason for the state of the code review.
        CreatedTimeStamp:
          allOf:
          - $ref: '#/components/schemas/TimeStamp'
          - description: The time, in milliseconds since the epoch, when the code review was created.
        LastUpdatedTimeStamp:
          allOf:
          - $ref: '#/components/schemas/TimeStamp'
          - description: The time, in milliseconds since the epoch, when the code review was last updated.
        Type:
          allOf:
          - $ref: '#/components/schemas/Type'
          - description: The type of code review.
        PullRequestId:
          allOf:
          - $ref: '#/components/schemas/PullRequestId'
          - description: The pull request ID for the code review.
        SourceCodeType:
          allOf:
          - $ref: '#/components/schemas/SourceCodeType'
          - description: The type of the source code for the code review.
        AssociationArn:
          allOf:
          - $ref: '#/components/schemas/AssociationArn'
          - description: The Amazon Resource Name (ARN) of the <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociation.html">RepositoryAssociation</a> that contains the reviewed source code. You can retrieve associated repository ARNs by calling <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_ListRepositoryAssociations.html">ListRepositoryAssociations</a>.
        Metrics:
          allOf:
          - $ref: '#/components/schemas/Metrics'
          - description: The statistics from the code review.
        AnalysisTypes:
          allOf:
          - $ref: '#/components/schemas/AnalysisTypes'
          - description: The types of analysis performed during a repository analysis or a pull request review. You can specify either <code>Security</code>, <code>CodeQuality</code>, or both.
        ConfigFileState:
          allOf:
          - $ref: '#/components/schemas/ConfigFileState'
          - description: The state of the <code>aws-codeguru-reviewer.yml</code> 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.
      description: Information about a code review. A code review belongs to the associated repository that contains the reviewed code.
    ShortDescription:
      type: string
      pattern: ^\S(.*\S)?$
      minLength: 1
      maxLength: 200
  parameters:
    X-Amz-Date:
      name: X-Amz-Date
      in: header
      schema:
        type: string
      required: false
    X-Amz-SignedHeaders:
      name: X-Amz-SignedHeaders
      in: header
      schema:
        type: string
      required: false
    X-Amz-Credential:
      name: X-Amz-Credential
      in: header
      schema:
        type: string
      required: false
    X-Amz-Content-Sha256:
      name: X-Amz-Content-Sha256
      in: header
      schema:
        type: string
      required: false
    X-Amz-Algorithm:
      name: X-Amz-Algorithm
      in: header
      schema:
        type: string
      required: false
    X-Amz-Signature:
      name: X-Amz-Signature
      in: header
      schema:
        type: string
      required: false
    X-Amz-Security-Token:
      name: X-Amz-Security-Token
      in: header
      schema:
        type: string
      required: false
  securitySchemes:
    hmac:
      type: apiKey
      name: Authorization
      in: header
      description: Amazon Signature authorization v4
      x-amazon-apigateway-authtype: awsSigv4
externalDocs:
  description: Amazon Web Services documentation
  url: https://docs.aws.amazon.com/codeguru-reviewer/
x-hasEquivalentPaths: true