openapi: 3.0.0
info:
  version: '2019-09-19'
  x-release: v4
  title: Amazon CodeGuru Reviewer Associations 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: Associations
paths:
  /associations:
    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: AssociateRepository
      description: <p>Use to associate an Amazon Web Services CodeCommit repository or a repository managed by Amazon Web Services CodeStar Connections with Amazon CodeGuru Reviewer. When you associate a repository, CodeGuru Reviewer reviews source code changes in the repository's pull requests and provides automatic recommendations. You can view recommendations using the CodeGuru Reviewer console. For more information, see <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/recommendations.html">Recommendations in Amazon CodeGuru Reviewer</a> in the <i>Amazon CodeGuru Reviewer User Guide.</i> </p> <p>If you associate a CodeCommit or S3 repository, it must be in the same Amazon Web Services Region and Amazon Web Services account where its CodeGuru Reviewer code reviews are configured.</p> <p>Bitbucket and GitHub Enterprise Server repositories are managed by Amazon Web Services CodeStar Connections to connect to CodeGuru Reviewer. For more information, see <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/getting-started-associate-repository.html">Associate a repository</a> in the <i>Amazon CodeGuru Reviewer User Guide.</i> </p> <note> <p>You cannot use the CodeGuru Reviewer SDK or the Amazon Web Services CLI to associate a GitHub repository with Amazon CodeGuru Reviewer. To associate a GitHub repository, use the console. For more information, see <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/getting-started-with-guru.html">Getting started with CodeGuru Reviewer</a> in the <i>CodeGuru Reviewer User Guide.</i> </p> </note>
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AssociateRepositoryResponse'
              examples:
                AssociateRepository200Example:
                  summary: Default AssociateRepository 200 response
                  x-microcks-default: true
                  value:
                    RepositoryAssociation: example-value
                    Tags: example-value
        '480':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
              examples:
                AssociateRepository480Example:
                  summary: Default AssociateRepository 480 response
                  x-microcks-default: true
                  value: example-value
        '481':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
              examples:
                AssociateRepository481Example:
                  summary: Default AssociateRepository 481 response
                  x-microcks-default: true
                  value: example-value
        '482':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
              examples:
                AssociateRepository482Example:
                  summary: Default AssociateRepository 482 response
                  x-microcks-default: true
                  value: example-value
        '483':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
              examples:
                AssociateRepository483Example:
                  summary: Default AssociateRepository 483 response
                  x-microcks-default: true
                  value: example-value
        '484':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
              examples:
                AssociateRepository484Example:
                  summary: Default AssociateRepository 484 response
                  x-microcks-default: true
                  value: example-value
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - Repository
              properties:
                Repository:
                  description: 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 <code>Repository</code> object is not used if your source code is in an associated GitHub repository.
                  type: object
                  properties:
                    CodeCommit:
                      allOf:
                      - $ref: '#/components/schemas/CodeCommitRepository'
                      - description: Information about an Amazon Web Services CodeCommit repository.
                    Bitbucket:
                      allOf:
                      - $ref: '#/components/schemas/ThirdPartySourceRepository'
                      - description: ' Information about a Bitbucket repository. '
                    GitHubEnterpriseServer:
                      allOf:
                      - $ref: '#/components/schemas/ThirdPartySourceRepository'
                      - description: Information about a GitHub Enterprise Server repository.
                    S3Bucket:
                      $ref: '#/components/schemas/S3Repository'
                ClientRequestToken:
                  description: Amazon CodeGuru Reviewer uses this value to prevent the accidental creation of duplicate repository associations if there are failures and retries.
                  type: string
                  pattern: ^[\w-]+$
                  minLength: 1
                  maxLength: 64
                Tags:
                  description: <p>An array of key-value pairs used to tag an associated repository. A tag is a custom attribute label with two parts:</p> <ul> <li> <p>A <i>tag key</i> (for example, <code>CostCenter</code>, <code>Environment</code>, <code>Project</code>, or <code>Secret</code>). Tag keys are case sensitive.</p> </li> <li> <p>An optional field known as a <i>tag value</i> (for example, <code>111122223333</code>, <code>Production</code>, or a team name). Omitting the tag value is the same as using an empty string. Like tag keys, tag values are case sensitive.</p> </li> </ul>
                  type: object
                  minProperties: 1
                  maxProperties: 50
                  additionalProperties:
                    $ref: '#/components/schemas/TagValue'
                KMSKeyDetails:
                  description: <p>An object that contains:</p> <ul> <li> <p>The encryption option for a repository association. It is either owned by Amazon Web Services Key Management Service (KMS) (<code>AWS_OWNED_CMK</code>) or customer managed (<code>CUSTOMER_MANAGED_CMK</code>).</p> </li> <li> <p>The ID of the Amazon Web Services KMS key that is associated with a repository association.</p> </li> </ul>
                  type: object
                  properties:
                    KMSKeyId:
                      allOf:
                      - $ref: '#/components/schemas/KMSKeyId'
                      - description: The ID of the Amazon Web Services KMS key that is associated with a repository association.
                    EncryptionOption:
                      allOf:
                      - $ref: '#/components/schemas/EncryptionOption'
                      - description: The encryption option for a repository association. It is either owned by Amazon Web Services Key Management Service (KMS) (<code>AWS_OWNED_CMK</code>) or customer managed (<code>CUSTOMER_MANAGED_CMK</code>).
            examples:
              AssociateRepositoryRequestExample:
                summary: Default AssociateRepository request
                x-microcks-default: true
                value:
                  Repository:
                    CodeCommit: example-value
                    Bitbucket: example-value
                    GitHubEnterpriseServer: example-value
                    S3Bucket:
                      Name: example-resource
                      BucketName: example-resource
                  ClientRequestToken: example-value
                  Tags: {}
                  KMSKeyDetails:
                    KMSKeyId: '500123'
                    EncryptionOption: example-value
      summary: Amazon CodeGuru Reviewer Associate Repository
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Associations
    get:
      operationId: ListRepositoryAssociations
      description: Returns a list of <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociationSummary.html">RepositoryAssociationSummary</a> objects that contain summary information about a repository association. You can filter the returned list by <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociationSummary.html#reviewer-Type-RepositoryAssociationSummary-ProviderType">ProviderType</a>, <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociationSummary.html#reviewer-Type-RepositoryAssociationSummary-Name">Name</a>, <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociationSummary.html#reviewer-Type-RepositoryAssociationSummary-State">State</a>, and <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociationSummary.html#reviewer-Type-RepositoryAssociationSummary-Owner">Owner</a>.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListRepositoryAssociationsResponse'
              examples:
                ListRepositoryAssociations200Example:
                  summary: Default ListRepositoryAssociations 200 response
                  x-microcks-default: true
                  value:
                    RepositoryAssociationSummaries: example-value
                    NextToken: example-value
        '480':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
              examples:
                ListRepositoryAssociations480Example:
                  summary: Default ListRepositoryAssociations 480 response
                  x-microcks-default: true
                  value: example-value
        '481':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
              examples:
                ListRepositoryAssociations481Example:
                  summary: Default ListRepositoryAssociations 481 response
                  x-microcks-default: true
                  value: example-value
        '482':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
              examples:
                ListRepositoryAssociations482Example:
                  summary: Default ListRepositoryAssociations 482 response
                  x-microcks-default: true
                  value: example-value
      parameters:
      - name: ProviderType
        in: query
        required: false
        description: List of provider types to use as a filter.
        schema:
          type: array
          items:
            $ref: '#/components/schemas/ProviderType'
          minItems: 1
          maxItems: 3
      - name: State
        in: query
        required: false
        description: '<p>List of repository association states to use as a filter.</p> <p>The valid repository association states are:</p> <ul> <li> <p> <b>Associated</b>: The repository association is complete.</p> </li> <li> <p> <b>Associating</b>: CodeGuru Reviewer is:</p> <ul> <li> <p>Setting up pull request notifications. This is required for pull requests to trigger a CodeGuru Reviewer review.</p> <note> <p>If your repository <code>ProviderType</code> is <code>GitHub</code>, <code>GitHub Enterprise Server</code>, or <code>Bitbucket</code>, 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.</p> </note> </li> <li> <p>Setting up source code access. This is required for CodeGuru Reviewer to securely clone code in your repository.</p> </li> </ul> </li> <li> <p> <b>Failed</b>: The repository failed to associate or disassociate.</p> </li> <li> <p> <b>Disassociating</b>: CodeGuru Reviewer is removing the repository''s pull request notifications and source code access.</p> </li> <li> <p> <b>Disassociated</b>: 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 <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/auth-and-access-control-using-tags.html">Using tags to control access to associated repositories</a> in the <i>Amazon CodeGuru Reviewer User Guide</i>.</p> </li> </ul>'
        schema:
          type: array
          items:
            $ref: '#/components/schemas/RepositoryAssociationState'
          minItems: 1
          maxItems: 5
      - name: Name
        in: query
        required: false
        description: List of repository names to use as a filter.
        schema:
          type: array
          items:
            $ref: '#/components/schemas/Name'
          minItems: 1
          maxItems: 3
      - name: Owner
        in: query
        required: false
        description: 'List of owners to use as a filter. For Amazon Web Services CodeCommit, it is the name of the CodeCommit account that was used to associate the repository. For other repository source providers, such as Bitbucket and GitHub Enterprise Server, this is name of the account that was used to associate the repository. '
        schema:
          type: array
          items:
            $ref: '#/components/schemas/Owner'
          minItems: 1
          maxItems: 3
      - name: MaxResults
        in: query
        required: false
        description: 'The maximum number of repository association results returned by <code>ListRepositoryAssociations</code> in paginated output. When this parameter is used, <code>ListRepositoryAssociations</code> only returns <code>maxResults</code> results in a single page with a <code>nextToken</code> response element. The remaining results of the initial request can be seen by sending another <code>ListRepositoryAssociations</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 100. If this parameter is not used, <code>ListRepositoryAssociations</code> returns up to 100 results and a <code>nextToken</code> value if applicable. '
        schema:
          type: integer
          minimum: 1
          maximum: 100
      - name: NextToken
        in: query
        required: false
        description: <p>The <code>nextToken</code> value returned from a previous paginated <code>ListRepositoryAssociations</code> request where <code>maxResults</code> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <code>nextToken</code> value. </p> <note> <p>Treat this token as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.</p> </note>
        schema:
          type: string
          minLength: 1
          maxLength: 2048
      summary: Amazon CodeGuru Reviewer List Repository Associations
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Associations
  /associations/{AssociationArn}:
    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: DescribeRepositoryAssociation
      description: Returns a <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociation.html">RepositoryAssociation</a> object that contains information about the requested repository association.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeRepositoryAssociationResponse'
              examples:
                DescribeRepositoryAssociation200Example:
                  summary: Default DescribeRepositoryAssociation 200 response
                  x-microcks-default: true
                  value:
                    RepositoryAssociation: example-value
                    Tags: example-value
        '480':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundException'
              examples:
                DescribeRepositoryAssociation480Example:
                  summary: Default DescribeRepositoryAssociation 480 response
                  x-microcks-default: true
                  value: example-value
        '481':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
              examples:
                DescribeRepositoryAssociation481Example:
                  summary: Default DescribeRepositoryAssociation 481 response
                  x-microcks-default: true
                  value: example-value
        '482':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
              examples:
                DescribeRepositoryAssociation482Example:
                  summary: Default DescribeRepositoryAssociation 482 response
                  x-microcks-default: true
                  value: example-value
        '483':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
              examples:
                DescribeRepositoryAssociation483Example:
                  summary: Default DescribeRepositoryAssociation 483 response
                  x-microcks-default: true
                  value: example-value
        '484':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
              examples:
                DescribeRepositoryAssociation484Example:
                  summary: Default DescribeRepositoryAssociation 484 response
                  x-microcks-default: true
                  value: example-value
      parameters:
      - name: AssociationArn
        in: path
        required: true
        description: 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>.
        schema:
          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
      summary: Amazon CodeGuru Reviewer Describe Repository Association
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Associations
    delete:
      operationId: DisassociateRepository
      description: Removes the association between Amazon CodeGuru Reviewer and a repository.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DisassociateRepositoryResponse'
              examples:
                DisassociateRepository200Example:
                  summary: Default DisassociateRepository 200 response
                  x-microcks-default: true
                  value:
                    RepositoryAssociation: example-value
                    Tags: example-value
        '480':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundException'
              examples:
                DisassociateRepository480Example:
                  summary: Default DisassociateRepository 480 response
                  x-microcks-default: true
                  value: example-value
        '481':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
              examples:
                DisassociateRepository481Example:
                  summary: Default DisassociateRepository 481 response
                  x-microcks-default: true
                  value: example-value
        '482':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
              examples:
                DisassociateRepository482Example:
                  summary: Default DisassociateRepository 482 response
                  x-microcks-default: true
                  value: example-value
        '483':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
              examples:
                DisassociateRepository483Example:
                  summary: Default DisassociateRepository 483 response
                  x-microcks-default: true
                  value: example-value
        '484':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
              examples:
                DisassociateRepository484Example:
                  summary: Default DisassociateRepository 484 response
                  x-microcks-default: true
                  value: example-value
        '485':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
              examples:
                DisassociateRepository485Example:
                  summary: Default DisassociateRepository 485 response
                  x-microcks-default: true
                  value: example-value
      parameters:
      - name: AssociationArn
        in: path
        required: true
        description: 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>.
        schema:
          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
      summary: Amazon CodeGuru Reviewer Disassociate Repository
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Associations
components:
  schemas:
    ConflictException: {}
    ProviderType:
      type: string
      enum:
      - CodeCommit
      - GitHub
      - Bitbucket
      - GitHubEnterpriseServer
      - S3Bucket
    ListRepositoryAssociationsResponse:
      type: object
      properties:
        RepositoryAssociationSummaries:
          allOf:
          - $ref: '#/components/schemas/RepositoryAssociationSummaries'
          - description: A list of repository associations that meet the criteria of the request.
        NextToken:
          allOf:
          - $ref: '#/components/schemas/NextToken'
          - description: 'The <code>nextToken</code> value to include in a future <code>ListRecommendations</code> request. When the results of a <code>ListRecommendations</code> request exceed <code>maxResults</code>, this value can be used to retrieve the next page of results. This value is <code>null</code> when there are no more results to return. '
    CodeCommitRepository:
      type: object
      required:
      - Name
      properties:
        Name:
          allOf:
          - $ref: '#/components/schemas/Name'
          - description: The name of the Amazon Web Services CodeCommit repository. For more information, see <a href="https://docs.aws.amazon.com/codecommit/latest/APIReference/API_GetRepository.html#CodeCommit-GetRepository-request-repositoryName">repositoryName</a> in the <i>Amazon Web Services CodeCommit API Reference</i>.
      description: 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.
    ValidationException: {}
    DisassociateRepositoryResponse:
      type: object
      properties:
        RepositoryAssociation:
          allOf:
          - $ref: '#/components/schemas/RepositoryAssociation'
          - description: Information about the disassociated repository.
        Tags:
          allOf:
          - $ref: '#/components/schemas/TagMap'
          - description: <p>An array of key-value pairs used to tag an associated repository. A tag is a custom attribute label with two parts:</p> <ul> <li> <p>A <i>tag key</i> (for example, <code>CostCenter</code>, <code>Environment</code>, <code>Project</code>, or <code>Secret</code>). Tag keys are case sensitive.</p> </li> <li> <p>An optional field known as a <i>tag value</i> (for example, <code>111122223333</code>, <code>Production</code>, or a team name). Omitting the tag value is the same as using an empty string. Like tag keys, tag values are case sensitive.</p> </li> </ul>
    ConnectionArn:
      type: string
      pattern: arn:aws(-[\w]+)*:.+:.+:[0-9]{12}:.+
      minLength: 0
      maxLength: 256
    BuildArtifactsObjectKey:
      type: string
      pattern: ^\S(.*\S)?$
      minLength: 1
      maxLength: 1024
    Name:
      type: string
      pattern: ^\S[\w.-]*$
      minLength: 1
      maxLength: 100
    Owner:
      type: string
      pattern: ^\S(.*\S)?$
      minLength: 1
      maxLength: 100
    StateReason:
      type: string
      minLength: 0
      maxLength: 256
    RepositoryAssociationState:
      type: string
      enum:
      - Associated
      - Associating
      - Failed
      - Disassociating
      - Disassociated
    KMSKeyDetails:
      type: object
      properties:
        KMSKeyId:
          allOf:
          - $ref: '#/components/schemas/KMSKeyId'
          - description: The ID of the Amazon Web Services KMS key that is associated with a repository association.
        EncryptionOption:
          allOf:
          - $ref: '#/components/schemas/EncryptionOption'
          - description: The encryption option for a repository association. It is either owned by Amazon Web Services Key Management Service (KMS) (<code>AWS_OWNED_CMK</code>) or customer managed (<code>CUSTOMER_MANAGED_CMK</code>).
      description: <p>An object that contains:</p> <ul> <li> <p>The encryption option for a repository association. It is either owned by Amazon Web Services Key Management Service (KMS) (<code>AWS_OWNED_CMK</code>) or customer managed (<code>CUSTOMER_MANAGED_CMK</code>).</p> </li> <li> <p>The ID of the Amazon Web Services KMS key that is associated with a repository association.</p> </li> </ul>
    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.
    AssociateRepositoryResponse:
      type: object
      properties:
        RepositoryAssociation:
          allOf:
          - $ref: '#/components/schemas/RepositoryAssociation'
          - description: Information about the repository association.
        Tags:
          allOf:
          - $ref: '#/components/schemas/TagMap'
          - description: <p>An array of key-value pairs used to tag an associated repository. A tag is a custom attribute label with two parts:</p> <ul> <li> <p>A <i>tag key</i> (for example, <code>CostCenter</code>, <code>Environment</code>, <code>Project</code>, or <code>Secret</code>). Tag keys are case sensitive.</p> </li> <li> <p>An optional field known as a <i>tag value</i> (for example, <code>111122223333</code>, <code>Production</code>, or a team name). Omitting the tag value is the same as using an empty string. Like tag keys, tag values are case sensitive.</p> </li> </ul>
    KMSKeyId:
      type: string
      pattern: '[a-zA-Z0-9-]+'
      minLength: 1
      maxLength: 2048
    EncryptionOption:
      type: string
      enum:
      - AWS_OWNED_CMK
      - CUSTOMER_MANAGED_CMK
    S3BucketName:
      type: string
      pattern: ^\S(.*\S)?$
      minLength: 3
      maxLength: 63
    NotFoundException: {}
    RepositoryAssociationSummaries:
      type: array
      items:
        $ref: '#/components/schemas/RepositoryAssociationSummary'
    AssociationId:
      type: string
      minLength: 1
      maxLength: 64
    NextToken:
      type: string
      minLength: 1
      maxLength: 2048
    TimeStamp:
      type: string
      format: date-time
    SourceCodeArtifactsObjectKey:
      type: string
      pattern: ^\S(.*\S)?$
      minLength: 1
      maxLength: 1024
    Arn:
      type: string
      pattern: ^arn:aws[^:\s]*:codeguru-reviewer:[^:\s]+:[\d]{12}:[a-z-]+:[\w-]+$
      minLength: 1
      maxLength: 1600
    RepositoryAssociationSummary:
      type: object
      properties:
        AssociationArn:
          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_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>.
        ConnectionArn:
          allOf:
          - $ref: '#/components/schemas/ConnectionArn'
          - description: The Amazon Resource Name (ARN) of an Amazon Web Services CodeStar Connections connection. Its format is <code>arn:aws:codestar-connections:region-id:aws-account_id:connection/connection-id</code>. For more information, see <a href="https://docs.aws.amazon.com/codestar-connections/latest/APIReference/API_Connection.html">Connection</a> in the <i>Amazon Web Services CodeStar Connections API Reference</i>.
        LastUpdatedTimeStamp:
          allOf:
          - $ref: '#/components/schemas/TimeStamp'
          - description: The time, in milliseconds since the epoch, since the repository association was last updated.
        AssociationId:
          allOf:
          - $ref: '#/components/schemas/AssociationId'
          - description: The repository association ID.
        Name:
          allOf:
          - $ref: '#/components/schemas/Name'
          - description: The name of the repository association.
        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 provider type of the repository association.
        State:
          allOf:
          - $ref: '#/components/schemas/RepositoryAssociationState'
          - description: '<p>The state of the repository association.</p> <p>The valid repository association states are:</p> <ul> <li> <p> <b>Associated</b>: The repository association is complete.</p> </li> <li> <p> <b>Associating</b>: CodeGuru Reviewer is:</p> <ul> <li> <p>Setting up pull request notifications. This is required for pull requests to trigger a CodeGuru Reviewer review.</p> <note> <p>If your repository <code>ProviderType</code> is <code>GitHub</code>, <code>GitHub Enterprise Server</code>, or <code>Bitbucket</code>, 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.</p> </note> </li> <li> <p>Setting up source code access. This is required for CodeGuru Reviewer to securely clone code in your repository.</p> </li> </ul> </li> <li> <p> <b>Failed</b>: The repository failed to associate or disassociate.</p> </li> <li> <p> <b>Disassociating</b>: CodeGuru Reviewer is removing the repository''s pull request notifications and source code access.</p> </li> <li> <p> <b>Disassociated</b>: 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 <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/auth-and-access-control-using-tags.html">Using tags to control access to associated repositories</a> in the <i>Amazon CodeGuru Reviewer User Guide</i>.</p> </li> </ul>'
      description: Summary information about a repository association. The <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_ListRepositoryAssociations.html">ListRepositoryAssociations</a> operation returns a list of <code>RepositoryAssociationSummary</code> objects.
    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>
    S3Repository:
      type: object
      required:
      - Name
      - BucketName
      properties:
        Name:
          allOf:
          - $ref: '#/components/schemas/Name'
          - description: The name of the repository in the S3 bucket.
        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>. '
      description: Information about a repository in an S3 bucket.
    TagMap:
      type: object
      minProperties: 1
      maxProperties: 50
      additionalProperties:
        $ref: '#/components/schemas/TagValue'
    DescribeRepositoryAssociationResponse:
      type: object
      properties:
        RepositoryAssociation:
          allOf:
          - $ref: '#/components/schemas/RepositoryAssociation'
          - description: Information about the repository association.
        Tags:
          allOf:
          - $ref: '#/components/schemas/TagMap'
          - description: <p>An array of key-value pairs used to tag an associated repository. A tag is a custom attribute label with two parts:</p> <ul> <li> <p>A <i>tag key</i> (for example, <code>CostCenter</code>, <code>Environment</code>, <code>Project</code>, or <code>Secret</code>). Tag keys are case sensitive.</p> </li> <li> <p>An optional field known as a <i>tag value</i> (for example, <code>111122223333</code>, <code>Production</code>, or a team name). Omitting the tag value is the same as using an empty string. Like tag keys, tag values are case sensitive.</p> </li> </ul>
    RepositoryAssociation:
      type: object
      properties:
        AssociationId:
          allOf:
          - $ref: '#/components/schemas/AssociationId'
          - description: The ID of the repository association.
        AssociationArn:
          allOf:
          - $ref: '#/components/schemas/Arn'
          - description: The Amazon Resource Name (ARN) identifying the repository association.
        ConnectionArn:
          allOf:
          - $ref: '#/components/schemas/ConnectionArn'
          - description: The Amazon Resource Name (ARN) of an Amazon Web Services CodeStar Connections connection. Its format is <code>arn:aws:codestar-connections:region-id:aws-account_id:connection/connection-id</code>. For more information, see <a href="https://docs.aws.amazon.com/codestar-connections/latest/APIReference/API_Connection.html">Connection</a> in the <i>Amazon Web Services CodeStar Connections API Reference</i>.
        Name:
          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 provider type of the repository association.
        State:
          allOf:
          - $ref: '#/components/schemas/RepositoryAssociationState'
          - description: '<p>The state of the repository association.</p> <p>The valid repository association states are:</p> <ul> <li> <p> <b>Associated</b>: The repository association is complete.</p> </li> <li> <p> <b>Associating</b>: CodeGuru Reviewer is:</p> <ul> <li> <p>Setting up pull request notifications. This is required for pull requests to trigger a CodeGuru Reviewer review.</p> <note> <p>If your repository <code>ProviderType</code> is <code>GitHub</code>, <code>GitHub Enterprise Server</code>, or <code>Bitbucket</code>, 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.</p> </note> </li> <li> <p>Setting up source code access. This is required for CodeGuru Reviewer to securely clone code in your repository.</p> </li> </ul> </li> <li> <p> <b>Failed</b>: The repository failed to associate or disassociate.</p> </li> <li> <p> <b>Disassociating</b>: CodeGuru Reviewer is removing the repository''s pull request notifications and source code access.</p> </li> <li> <p> <b>Disassociated</b>: 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 <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/auth-and-access-control-using-tags.html">Using tags to control access to associated repositories</a> in the <i>Amazon CodeGuru Reviewer User Guide</i>.</p> </li> </ul>'
        StateReason:
          allOf:
          - $ref: '#/components/schemas/StateReason'
          - description: A description of why the repository association is in the current state.
        LastUpdatedTimeStamp:
          allOf:
          - $ref: '#/components/schemas/TimeStamp'
          - description: The time, in milliseconds since the epoch, when the repository association was last updated.
        CreatedTimeStamp:
          allOf:
          - $ref: '#/components/schemas/TimeStamp'
          - description: The time, in milliseconds since the epoch, when the repository association was created.
        KMSKeyDetails:
          allOf:
          - $ref: '#/components/schemas/KMSKeyDetails'
          - description: <p>A <code>KMSKeyDetails</code> object that contains:</p> <ul> <li> <p>The encryption option for this repository association. It is either owned by Amazon Web Services Key Management Service (KMS) (<code>AWS_OWNED_CMK</code>) or customer managed (<code>CUSTOMER_MANAGED_CMK</code>).</p> </li> <li> <p>The ID of the Amazon Web Services KMS key that is associated with this repository association.</p> </li> </ul>
        S3RepositoryDetails:
          $ref: '#/components/schemas/S3RepositoryDetails'
      description: Information about a repository association. The <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_DescribeRepositoryAssociation.html">DescribeRepositoryAssociation</a> operation returns a <code>RepositoryAssociation</code> object.
    AccessDeniedException: {}
    TagValue:
      type: string
      maxLength: 256
    InternalServerException: {}
    ThirdPartySourceRepository:
      type: object
      required:
      - Name
      - ConnectionArn
      - Owner
      properties:
        Name:
          allOf:
          - $ref: '#/components/schemas/Name'
          - description: The name of the third party source repository.
        ConnectionArn:
          allOf:
          - $ref: '#/components/schemas/ConnectionArn'
          - description: The Amazon Resource Name (ARN) of an Amazon Web Services CodeStar Connections connection. Its format is <code>arn:aws:codestar-connections:region-id:aws-account_id:connection/connection-id</code>. For more information, see <a href="https://docs.aws.amazon.com/codestar-connections/latest/APIReference/API_Connection.html">Connection</a> in the <i>Amazon Web Services CodeStar Connections API Reference</i>.
        Owner:
          allOf:
          - $ref: '#/components/schemas/Owner'
          - description: '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 '
      description: Information about a third-party source repository connected to CodeGuru Reviewer.
  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