Every API here is available over the APIs.io API and to AI agents over MCP.
openapi: 3.1.0
info:
title: Amazon CodeGuru Reviewer Associations API
version: '2019-09-19'
description: Generated from AWS's published Smithy model for Amazon CodeGuru Reviewer. 4 operation(s).
contact:
name: Amazon Web Services
url: https://aws.amazon.com/contact-us/
license:
name: Apache 2.0
identifier: Apache-2.0
url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://codeguru-reviewer.{region}.amazonaws.com
variables:
region:
default: us-east-1
security:
- sigv4: []
paths:
/associations:
post:
operationId: AssociateRepository
summary: Associate Repository
description: 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 Recommendations in Amazon CodeGuru Reviewer in the
Amazon CodeGuru Reviewer User Guide. 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. Bitbucket
and GitHub Enterprise Server repositories are managed by Amazon Web Services CodeStar Connections to connect to CodeGuru
Reviewer. For more information, see Associate a repository in the Amazon CodeGuru Reviewer User Guide. 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 Getting started with CodeGuru
Reviewer in the CodeGuru Reviewer User Gui
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/AssociateRepositoryResponse'
'403':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'409':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'500':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'429':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'400':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AssociateRepositoryRequest'
tags:
- Associations
get:
operationId: ListRepositoryAssociations
summary: List Repository Associations
description: Returns a list of RepositoryAssociationSummary objects that contain summary information about a repository
association. You can filter the returned list by ProviderType, Name, State, and Owner.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListRepositoryAssociationsResponse'
'500':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'429':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'400':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ListRepositoryAssociationsRequest'
tags:
- Associations
/associations/{AssociationArn}:
get:
operationId: DescribeRepositoryAssociation
summary: Describe Repository Association
description: Returns a RepositoryAssociation object that contains information about the requested repository association.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DescribeRepositoryAssociationResponse'
'403':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'500':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'404':
description: NotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundException'
'429':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'400':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DescribeRepositoryAssociationRequest'
tags:
- Associations
delete:
operationId: DisassociateRepository
summary: Disassociate Repository
description: Removes the association between Amazon CodeGuru Reviewer and a repository.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DisassociateRepositoryResponse'
'403':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'409':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'500':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'404':
description: NotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundException'
'429':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'400':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DisassociateRepositoryRequest'
tags:
- Associations
components:
securitySchemes:
sigv4:
type: apiKey
in: header
name: Authorization
description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical
request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
x-aws-sigv4:
signingName: codeguru-reviewer
schemas:
AccessDeniedException:
type: object
properties:
Message:
type: string
AssociateRepositoryRequest:
type: object
properties:
Repository:
$ref: '#/components/schemas/Repository'
ClientRequestToken:
type: string
description: Amazon CodeGuru Reviewer uses this value to prevent the accidental creation of duplicate repository
associations if there are failures and retries.
Tags:
type: object
additionalProperties:
type: string
description: 'An array of key-value pairs used to tag an associated repository. A tag is a custom attribute label
with two parts: A tag key (for example, CostCenter, Environment, Project, or Secret). Tag keys are case sensitive.
An optional field known as a tag value (for example, 111122223333, Production, or a team name). Omitting the tag
value is the same as using an empty string. Like tag keys, tag values are case sensitive.'
KMSKeyDetails:
$ref: '#/components/schemas/KMSKeyDetails'
required:
- Repository
AssociateRepositoryResponse:
type: object
properties:
RepositoryAssociation:
$ref: '#/components/schemas/RepositoryAssociation'
Tags:
type: object
additionalProperties:
type: string
description: 'An array of key-value pairs used to tag an associated repository. A tag is a custom attribute label
with two parts: A tag key (for example, CostCenter, Environment, Project, or Secret). Tag keys are case sensitive.
An optional field known as a tag value (for example, 111122223333, Production, or a team name). Omitting the tag
value is the same as using an empty string. Like tag keys, tag values are case sensitive.'
CodeArtifacts:
type: object
properties:
SourceCodeArtifactsObjectKey:
type: string
description: The S3 object key for a source code .zip file. This is required for all code reviews.
BuildArtifactsObjectKey:
type: string
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 Create code reviews with GitHub Actions in
the Amazon CodeGuru Reviewer User Guide.
required:
- SourceCodeArtifactsObjectKey
CodeCommitRepository:
type: object
properties:
Name:
type: string
description: The name of the Amazon Web Services CodeCommit repository. For more information, see repositoryName
in the Amazon Web Services CodeCommit API Reference.
required:
- Name
ConflictException:
type: object
properties:
Message:
type: string
DescribeRepositoryAssociationRequest:
type: object
properties:
AssociationArn:
type: string
description: The Amazon Resource Name (ARN) of the RepositoryAssociation object. You can retrieve this ARN by calling
ListRepositoryAssociations.
required:
- AssociationArn
DescribeRepositoryAssociationResponse:
type: object
properties:
RepositoryAssociation:
$ref: '#/components/schemas/RepositoryAssociation'
Tags:
type: object
additionalProperties:
type: string
description: 'An array of key-value pairs used to tag an associated repository. A tag is a custom attribute label
with two parts: A tag key (for example, CostCenter, Environment, Project, or Secret). Tag keys are case sensitive.
An optional field known as a tag value (for example, 111122223333, Production, or a team name). Omitting the tag
value is the same as using an empty string. Like tag keys, tag values are case sensitive.'
DisassociateRepositoryRequest:
type: object
properties:
AssociationArn:
type: string
description: The Amazon Resource Name (ARN) of the RepositoryAssociation object. You can retrieve this ARN by calling
ListRepositoryAssociations.
required:
- AssociationArn
DisassociateRepositoryResponse:
type: object
properties:
RepositoryAssociation:
$ref: '#/components/schemas/RepositoryAssociation'
Tags:
type: object
additionalProperties:
type: string
description: 'An array of key-value pairs used to tag an associated repository. A tag is a custom attribute label
with two parts: A tag key (for example, CostCenter, Environment, Project, or Secret). Tag keys are case sensitive.
An optional field known as a tag value (for example, 111122223333, Production, or a team name). Omitting the tag
value is the same as using an empty string. Like tag keys, tag values are case sensitive.'
InternalServerException:
type: object
properties:
Message:
type: string
KMSKeyDetails:
type: object
properties:
KMSKeyId:
type: string
description: The ID of the Amazon Web Services KMS key that is associated with a repository association.
EncryptionOption:
type: string
enum:
- AWS_OWNED_CMK
- CUSTOMER_MANAGED_CMK
description: The encryption option for a repository association. It is either owned by Amazon Web Services Key Management
Service (KMS) (AWS_OWNED_CMK) or customer managed (CUSTOMER_MANAGED_CMK).
ListRepositoryAssociationsRequest:
type: object
properties:
ProviderTypes:
type: array
items:
type: string
enum:
- CodeCommit
- GitHub
- Bitbucket
- GitHubEnterpriseServer
- S3Bucket
description: List of provider types to use as a filter.
States:
type: array
items:
type: string
enum:
- Associated
- Associating
- Failed
- Disassociating
- Disassociated
description: 'List of repository association states to use as a filter. The valid repository association states
are: Associated: The repository association is complete. Associating: CodeGuru Reviewer is: Setting up pull request
notifications. This is required for pull requests to trigger a CodeGuru Reviewer review. If your repository ProviderType
is GitHub, GitHub Enterprise Server, or Bitbucket, 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.
Setting up source code access. This '
Names:
type: array
items:
type: string
description: List of repository names to use as a filter.
Owners:
type: array
items:
type: string
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.
MaxResults:
type: integer
description: The maximum number of repository association results returned by ListRepositoryAssociations in paginated
output. When this parameter is used, ListRepositoryAssociations only returns maxResults results in a single page
with a nextToken response element. The remaining results of the initial request can be seen by sending another
ListRepositoryAssociations request with the returned nextToken value. This value can be between 1 and 100. If
this parameter is not used, ListRepositoryAssociations returns up to 100 results and a nextToken value if applicable.
NextToken:
type: string
description: The nextToken value returned from a previous paginated ListRepositoryAssociations request where maxResults
was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous
results that returned the nextToken value. 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.
ListRepositoryAssociationsResponse:
type: object
properties:
RepositoryAssociationSummaries:
type: array
items:
$ref: '#/components/schemas/RepositoryAssociationSummary'
description: A list of repository associations that meet the criteria of the request.
NextToken:
type: string
description: The nextToken value to include in a future ListRecommendations request. When the results of a ListRecommendations
request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when
there are no more results to return.
NotFoundException:
type: object
properties:
Message:
type: string
Repository:
type: object
properties:
CodeCommit:
$ref: '#/components/schemas/CodeCommitRepository'
Bitbucket:
$ref: '#/components/schemas/ThirdPartySourceRepository'
GitHubEnterpriseServer:
$ref: '#/components/schemas/ThirdPartySourceRepository'
S3Bucket:
$ref: '#/components/schemas/S3Repository'
RepositoryAssociation:
type: object
properties:
AssociationId:
type: string
description: The ID of the repository association.
AssociationArn:
type: string
description: The Amazon Resource Name (ARN) identifying the repository association.
ConnectionArn:
type: string
description: The Amazon Resource Name (ARN) of an Amazon Web Services CodeStar Connections connection. Its format
is arn:aws:codestar-connections:region-id:aws-account_id:connection/connection-id. For more information, see Connection
in the Amazon Web Services CodeStar Connections API Reference.
Name:
type: string
description: The name of the repository.
Owner:
type: string
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:
type: string
enum:
- CodeCommit
- GitHub
- Bitbucket
- GitHubEnterpriseServer
- S3Bucket
description: The provider type of the repository association.
State:
type: string
enum:
- Associated
- Associating
- Failed
- Disassociating
- Disassociated
description: 'The state of the repository association. The valid repository association states are: Associated:
The repository association is complete. Associating: CodeGuru Reviewer is: Setting up pull request notifications.
This is required for pull requests to trigger a CodeGuru Reviewer review. If your repository ProviderType is GitHub,
GitHub Enterprise Server, or Bitbucket, 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. Setting
up source code access. This is required for C'
StateReason:
type: string
description: A description of why the repository association is in the current state.
LastUpdatedTimeStamp:
type: string
format: date-time
description: The time, in milliseconds since the epoch, when the repository association was last updated.
CreatedTimeStamp:
type: string
format: date-time
description: The time, in milliseconds since the epoch, when the repository association was created.
KMSKeyDetails:
$ref: '#/components/schemas/KMSKeyDetails'
S3RepositoryDetails:
$ref: '#/components/schemas/S3RepositoryDetails'
RepositoryAssociationSummary:
type: object
properties:
AssociationArn:
type: string
description: The Amazon Resource Name (ARN) of the RepositoryAssociation object. You can retrieve this ARN by calling
ListRepositoryAssociations.
ConnectionArn:
type: string
description: The Amazon Resource Name (ARN) of an Amazon Web Services CodeStar Connections connection. Its format
is arn:aws:codestar-connections:region-id:aws-account_id:connection/connection-id. For more information, see Connection
in the Amazon Web Services CodeStar Connections API Reference.
LastUpdatedTimeStamp:
type: string
format: date-time
description: The time, in milliseconds since the epoch, since the repository association was last updated.
AssociationId:
type: string
description: The repository association ID.
Name:
type: string
description: The name of the repository association.
Owner:
type: string
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:
type: string
enum:
- CodeCommit
- GitHub
- Bitbucket
- GitHubEnterpriseServer
- S3Bucket
description: The provider type of the repository association.
State:
type: string
enum:
- Associated
- Associating
- Failed
- Disassociating
- Disassociated
description: 'The state of the repository association. The valid repository association states are: Associated:
The repository association is complete. Associating: CodeGuru Reviewer is: Setting up pull request notifications.
This is required for pull requests to trigger a CodeGuru Reviewer review. If your repository ProviderType is GitHub,
GitHub Enterprise Server, or Bitbucket, 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. Setting
up source code access. This is required for C'
S3Repository:
type: object
properties:
Name:
type: string
description: The name of the repository in the S3 bucket.
BucketName:
type: string
description: The name of the S3 bucket used for associating a new S3 repository. It must begin with codeguru-reviewer-.
required:
- Name
- BucketName
S3RepositoryDetails:
type: object
properties:
BucketName:
type: string
description: The name of the S3 bucket used for associating a new S3 repository. It must begin with codeguru-reviewer-.
CodeArtifacts:
$ref: '#/components/schemas/CodeArtifacts'
ThirdPartySourceRepository:
type: object
properties:
Name:
type: string
description: The name of the third party source repository.
ConnectionArn:
type: string
description: The Amazon Resource Name (ARN) of an Amazon Web Services CodeStar Connections connection. Its format
is arn:aws:codestar-connections:region-id:aws-account_id:connection/connection-id. For more information, see Connection
in the Amazon Web Services CodeStar Connections API Reference.
Owner:
type: string
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
required:
- Name
- ConnectionArn
- Owner
ThrottlingException:
type: object
properties:
Message:
type: string
ValidationException:
type: object
properties:
Message:
type: string
x-provenance:
method: harvested
publisher: Amazon Web Services
source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/codeguru-reviewer/service/2019-09-19/codeguru-reviewer-2019-09-19.json
note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)