This section provides documentation for the Amazon CodeGuru Reviewer API operations. CodeGuru Reviewer is a service that uses program analysis and machine learning to detect potential defects that are difficult for developers to find and recommends fixes in your Java and Python code.
By proactively detecting and providing recommendations for addressing code defects and implementing best practices, CodeGuru Reviewer improves the overall quality and maintainability of your code base during the code review stage. For more information about CodeGuru Reviewer, see the Amazon CodeGuru Reviewer User Guide.
To improve the security of your CodeGuru Reviewer API calls, you can establish a private connection between your VPC and CodeGuru Reviewer by creating an interface VPC endpoint. For more information, see CodeGuru Reviewer and interface VPC endpoints (Amazon Web Services PrivateLink) in the Amazon CodeGuru Reviewer User Guide.
' x-logo: url: 'https://twitter.com/awscloud/profile_image?size=original' backgroundColor: '#FFFFFF' termsOfService: 'https://aws.amazon.com/service-terms/' contact: name: Mike Ralphson email: mike.ralphson@gmail.com url: 'https://github.com/mermade/aws2openapi' x-twitter: PermittedSoc license: name: Apache 2.0 License url: 'http://www.apache.org/licenses/' x-providerName: amazonaws.com x-serviceName: codeguru-reviewer x-aws-signingName: codeguru-reviewer x-origin: - contentType: application/json url: 'https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/codeguru-reviewer-2019-09-19.normal.json' converter: url: 'https://github.com/mermade/aws2openapi' version: 1.0.0 x-apisguru-driver: external x-apiClientRegistration: url: 'https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct' x-apisguru-categories: - cloud x-preferred: true externalDocs: description: Amazon Web Services documentation url: 'https://docs.aws.amazon.com/codeguru-reviewer/' 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) x-hasEquivalentPaths: true paths: /associations: post: operationId: AssociateRepository 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 Guide.
Repository 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: '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.
An object that contains:
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).
The ID of the Amazon Web Services KMS key that is associated with a repository association.
AWS_OWNED_CMK) or customer
managed (CUSTOMER_MANAGED_CMK).
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
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: ListRepositoryAssociations
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'
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: '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 is required for CodeGuru Reviewer to securely clone code in your repository.
Failed: The repository failed to associate or disassociate.
Disassociating: CodeGuru Reviewer is removing the repository''s pull request notifications and source code access.
Disassociated: 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 Using tags to control access to associated repositories in the Amazon CodeGuru Reviewer User Guide.
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. '
schema:
type: integer
minimum: 1
maximum: 100
- name: NextToken
in: query
required: false
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.
RepositoryAnalysis. This
type of code review analyzes all code under a specified branch in an associated repository. PullRequest 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: 'The Amazon Resource Name (ARN) of the RepositoryAssociation object. You can retrieve this ARN by calling ListRepositoryAssociations.
A code review can only be created on an associated repository. This is the ARN of the associated repository.
' 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: 'The type of a code review. There are two code review types:
PullRequest - A code review that is automatically triggered by a pull request
on an associated repository.
RepositoryAnalysis - A code review that analyzes all code under a specified branch in an associated repository. The associated
repository is specified using its ARN in CreateCodeReview.
Security, CodeQuality, 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
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'
'/codereviews/{CodeReviewArn}':
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 CodeReview 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
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'
'/feedback/{CodeReviewArn}#RecommendationId':
get:
operationId: DescribeRecommendationFeedback
description: Describes the customer feedback for a CodeGuru Reviewer recommendation.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DescribeRecommendationFeedbackResponse'
examples:
DescribeRecommendationFeedback200Example:
summary: Default DescribeRecommendationFeedback 200 response
x-microcks-default: true
value:
RecommendationFeedback: example-value
'480':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
examples:
DescribeRecommendationFeedback480Example:
summary: Default DescribeRecommendationFeedback 480 response
x-microcks-default: true
value: example-value
'481':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
examples:
DescribeRecommendationFeedback481Example:
summary: Default DescribeRecommendationFeedback 481 response
x-microcks-default: true
value: example-value
'482':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
examples:
DescribeRecommendationFeedback482Example:
summary: Default DescribeRecommendationFeedback 482 response
x-microcks-default: true
value: example-value
'483':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
examples:
DescribeRecommendationFeedback483Example:
summary: Default DescribeRecommendationFeedback 483 response
x-microcks-default: true
value: example-value
'484':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
examples:
DescribeRecommendationFeedback484Example:
summary: Default DescribeRecommendationFeedback 484 response
x-microcks-default: true
value: example-value
parameters:
- name: CodeReviewArn
in: path
required: true
description: 'The Amazon Resource Name (ARN) of the CodeReview object. '
schema:
type: string
pattern: '^arn:aws[^:\s]*:codeguru-reviewer:[^:\s]+:[\d]{12}:[a-z-]+:[\w-]+$'
minLength: 1
maxLength: 1600
- name: RecommendationId
in: query
required: true
description: The recommendation ID that can be used to track the provided recommendations and then to collect the feedback.
schema:
type: string
minLength: 1
maxLength: 64
- name: UserId
in: query
required: false
description: 'Optional parameter to describe the feedback for a given user. If this is not supplied, it defaults to the user making the request.
The UserId is an IAM principal
that can be specified as an Amazon Web Services account ID or an Amazon Resource Name (ARN). For more information, see
Specifying a Principal in the Amazon Web Services Identity and Access Management User Guide.
providerTypes=[GitHub] lists code reviews from GitHub.'
schema:
type: array
items:
$ref: '#/components/schemas/ProviderType'
minItems: 1
maxItems: 3
- name: States
in: query
required: false
description: 'List of states for filtering that needs to be applied before displaying the result. For example, states=[Pending] lists code reviews in the Pending state.
The valid code review states are:
Completed: The code review is complete.
Pending: The code review started and has not completed or failed.
Failed: The code review failed.
Deleting: The code review is being deleted.
nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the
returned token to retrieve the next page. Keep all other arguments unchanged.'
schema:
type: string
minLength: 1
maxLength: 2048
summary: Amazon CodeGuru Reviewer List Code Reviews
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
'/feedback/{CodeReviewArn}/RecommendationFeedback':
get:
operationId: ListRecommendationFeedback
description: 'Returns a list of RecommendationFeedbackSummary objects that contain customer
recommendation feedback for all CodeGuru Reviewer users.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListRecommendationFeedbackResponse'
examples:
ListRecommendationFeedback200Example:
summary: Default ListRecommendationFeedback 200 response
x-microcks-default: true
value:
RecommendationFeedbackSummaries: example-value
NextToken: example-value
'480':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
examples:
ListRecommendationFeedback480Example:
summary: Default ListRecommendationFeedback 480 response
x-microcks-default: true
value: example-value
'481':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
examples:
ListRecommendationFeedback481Example:
summary: Default ListRecommendationFeedback 481 response
x-microcks-default: true
value: example-value
'482':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
examples:
ListRecommendationFeedback482Example:
summary: Default ListRecommendationFeedback 482 response
x-microcks-default: true
value: example-value
'483':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
examples:
ListRecommendationFeedback483Example:
summary: Default ListRecommendationFeedback 483 response
x-microcks-default: true
value: example-value
'484':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
examples:
ListRecommendationFeedback484Example:
summary: Default ListRecommendationFeedback 484 response
x-microcks-default: true
value: example-value
parameters:
- name: NextToken
in: query
required: false
description: 'If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the
returned token to retrieve the next page. Keep all other arguments unchanged.'
schema:
type: string
minLength: 1
maxLength: 2048
- name: MaxResults
in: query
required: false
description: The maximum number of results that are returned per call. The default is 100.
schema:
type: integer
minimum: 1
maximum: 100
- name: CodeReviewArn
in: path
required: true
description: 'The Amazon Resource Name (ARN) of the CodeReview object. '
schema:
type: string
pattern: '^arn:aws[^:\s]*:codeguru-reviewer:[^:\s]+:[\d]{12}:[a-z-]+:[\w-]+$'
minLength: 1
maxLength: 1600
- name: UserIds
in: query
required: false
description: 'An Amazon Web Services user''s account ID or Amazon Resource Name (ARN). Use this ID to query the recommendation feedback for a code review from that user.
The UserId
is an IAM principal that can be specified as an Amazon Web Services account ID or an Amazon Resource Name (ARN). For more information, see
Specifying a Principal in the Amazon Web Services Identity and Access Management User Guide.
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.
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.
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:
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.
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 codeguru-reviewer-. '
description: Information about a repository in an S3 bucket.
TagValue:
type: string
maxLength: 256
KMSKeyId:
type: string
pattern: '[a-zA-Z0-9-]+'
minLength: 1
maxLength: 2048
EncryptionOption:
type: string
enum:
- AWS_OWNED_CMK
- CUSTOMER_MANAGED_CMK
InternalServerException: {}
ValidationException: {}
AccessDeniedException: {}
ConflictException: {}
ThrottlingException: {}
CreateCodeReviewResponse:
type: object
properties:
CodeReview:
$ref: '#/components/schemas/CodeReview'
RepositoryAnalysis:
type: object
properties:
RepositoryHead:
allOf:
- $ref: '#/components/schemas/RepositoryHeadSourceCodeType'
- description: 'A SourceCodeType 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 CreateCodeReview.'
AnalysisTypes:
type: array
items:
$ref: '#/components/schemas/AnalysisType'
ResourceNotFoundException: {}
DescribeCodeReviewResponse:
type: object
properties:
CodeReview:
allOf:
- $ref: '#/components/schemas/CodeReview'
- description: Information about the code review.
DescribeRecommendationFeedbackResponse:
type: object
properties:
RecommendationFeedback:
allOf:
- $ref: '#/components/schemas/RecommendationFeedback'
- description: The recommendation feedback given by the user.
DescribeRepositoryAssociationResponse:
type: object
properties:
RepositoryAssociation:
allOf:
- $ref: '#/components/schemas/RepositoryAssociation'
- description: Information about the repository association.
Tags:
allOf:
- $ref: '#/components/schemas/TagMap'
- 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.
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.
nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using
the returned token to retrieve the next page. Keep all other arguments unchanged.'
UserId:
type: string
minLength: 1
maxLength: 256
RecommendationId:
type: string
minLength: 1
maxLength: 64
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.
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 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. '
RepositoryAssociationState:
type: string
enum:
- Associated
- Associating
- Failed
- Disassociating
- Disassociated
Owner:
type: string
pattern: ^\S(.*\S)?$
minLength: 1
maxLength: 100
ListTagsForResourceResponse:
type: object
properties:
Tags:
allOf:
- $ref: '#/components/schemas/TagMap'
- 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.
Repository object is not used if your source code is in an associated GitHub repository.'
ClientRequestToken:
type: string
pattern: '^[\w-]+$'
minLength: 1
maxLength: 64
TagMap:
type: object
minProperties: 1
maxProperties: 50
additionalProperties:
$ref: '#/components/schemas/TagValue'
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) (AWS_OWNED_CMK) or customer managed
(CUSTOMER_MANAGED_CMK).
description: 'An object that contains:
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).
The ID of the Amazon Web Services KMS key that is associated with a repository association.
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.
A KMSKeyDetails object that contains:
The encryption option for this repository association. It is either owned by Amazon Web Services Key Management
Service (KMS) (AWS_OWNED_CMK) or customer managed (CUSTOMER_MANAGED_CMK).
The ID of the Amazon Web Services KMS key that is associated with this repository association.
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:
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: '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 CodeGuru Reviewer to securely clone code in your repository.
Failed: The repository failed to associate or disassociate.
Disassociating: CodeGuru Reviewer is removing the repository''s pull request notifications and source code access.
Disassociated: 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 Using tags to control access to associated repositories in the Amazon CodeGuru Reviewer User Guide.
A KMSKeyDetails object that contains:
The encryption option for this repository association. It is either owned by Amazon Web Services Key Management
Service (KMS) (AWS_OWNED_CMK) or customer managed (CUSTOMER_MANAGED_CMK).
The ID of the Amazon Web Services KMS key that is associated with this repository association.
RepositoryAssociation object.'
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
AssociationId:
type: string
minLength: 1
maxLength: 64
BranchName:
type: string
minLength: 1
maxLength: 256
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 SourceCodeType that specifies a code diff between a source and destination branch
in an associated repository.'
BuildArtifactsObjectKey:
type: string
pattern: ^\S(.*\S)?$
minLength: 1
maxLength: 1024
SourceCodeArtifactsObjectKey:
type: string
pattern: ^\S(.*\S)?$
minLength: 1
maxLength: 1024
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 Create
code reviews with GitHub Actions in the Amazon CodeGuru Reviewer User Guide.'
description: Code artifacts are source code artifacts and build artifacts used in a repository analysis or a pull request review.
Source code artifacts are source code files in a Git repository that are compressed into a .zip file.
Build artifacts are .jar or .class files that are compressed in a .zip file.
S3RepositoryDetails object. The S3RepositoryDetails 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. S3BucketRepository is required in SourceCodeType
for S3BucketRepository 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 RequestMetadaa 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.
Metrics:
type: object
properties:
MeteredLinesOfCodeCount:
allOf:
- $ref: '#/components/schemas/LinesOfCodeCount'
- description: ' MeteredLinesOfCodeCount 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: ' SuppressedLinesOfCodeCount 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 excludeFiles variable in the aws-codeguru-reviewer.yml 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.
ConfigFileState:
type: string
enum:
- Present
- Absent
- PresentWithErrors
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 CodeReview 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: 'The valid code review states are:
Completed: The code review is complete.
Pending: The code review started and
has not completed or failed.
Failed: The code review failed.
Deleting: The code review is being deleted.
Security, CodeQuality, or both.'
ConfigFileState:
allOf:
- $ref: '#/components/schemas/ConfigFileState'
- description: 'The state of the aws-codeguru-reviewer.yml 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.
CodeReviewName:
type: string
pattern: '[a-zA-Z0-9-_]*'
minLength: 1
maxLength: 100
CodeReviewSummary:
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 CodeReview 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 provider type of the repository association.
State:
allOf:
- $ref: '#/components/schemas/JobState'
- description: 'The state of the code review.
The valid code review states are:
Completed: The code review is complete.
Pending:
The code review started and has not completed or failed.
Failed: The code review failed.
Deleting: The code review is being
deleted.
MeteredLinesOfCodeCount includes the first 5 files (5 * 500 = 2,500 lines), the new file (200 lines)
and the 25 changed lines of code for a total of 2,725 lines of code.'
SuppressedLinesOfCodeCount:
allOf:
- $ref: '#/components/schemas/LinesOfCodeCount'
- description: 'Lines of code suppressed in the code review based on the excludeFiles element in the aws-codeguru-reviewer.yml file. For full repository analyses, this
number includes all lines of code in the files that are suppressed. For pull requests, this number only includes the changed lines of code that are suppressed. In both cases, this number
does not include non-code lines such as comments and import statements. For example, if you initiate a full repository analysis on a repository containing 5 files, each file with 100 lines
of code, and 2 files are listed as excluded in the aws-codeguru-reviewer.yml file, then SuppressedLinesOfCodeCount returns 200 (2 * 100) as the total number of lines
of code suppressed. However, if you submit a pull request for the same repository, then SuppressedLinesOfCodeCount only includes the lines in the 2 files that changed. If only
1 of the 2 files changed in the pull request, then SuppressedLinesOfCodeCount returns 100 (1 * 100) as the total number of lines of code suppressed.'
FindingsCount:
allOf:
- $ref: '#/components/schemas/FindingsCount'
- description: Total number of recommendations found in the code review.
description: Information about metrics summaries.
CodeReviewType:
type: object
required:
- RepositoryAnalysis
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 CreateCodeReview.'
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 Security, CodeQuality, or both.'
description: 'The type of a code review. There are two code review types:
PullRequest - A code review that is automatically triggered by a pull request on an associated
repository.
RepositoryAnalysis - A code review that analyzes all code under a specified branch in an associated repository. The associated repository is specified
using its ARN in CreateCodeReview.
SourceCommit and DestinationCommit fields are required to do a pull request code review.'
ConnectionArn:
type: string
pattern: 'arn:aws(-[\w]+)*:.+:.+:[0-9]{12}:.+'
minLength: 0
maxLength: 256
CreateCodeReviewRequest:
type: object
required:
- Name
- RepositoryAssociationArn
- Type
title: CreateCodeReviewRequest
properties:
Name:
allOf:
- $ref: '#/components/schemas/CodeReviewName'
- description: The name of the code review. The name of each code review in your Amazon Web Services account must be unique.
RepositoryAssociationArn:
allOf:
- $ref: '#/components/schemas/AssociationArn'
- description: 'The Amazon Resource Name (ARN) of the RepositoryAssociation object. You can retrieve this ARN by calling ListRepositoryAssociations.
A code review can only be created on an associated repository. This is the ARN of the associated repository.
' Type: allOf: - $ref: '#/components/schemas/CodeReviewType' - description: 'The type of code review to create. This is specified using a CodeReviewType object. You can create a code review only of typeRepositoryAnalysis.'
ClientRequestToken:
allOf:
- $ref: '#/components/schemas/ClientRequestToken'
- description: Amazon CodeGuru Reviewer uses this value to prevent the accidental creation of duplicate code reviews if there are failures and retries.
DescribeCodeReviewRequest:
type: object
title: DescribeCodeReviewRequest
properties: {}
DescribeRecommendationFeedbackRequest:
type: object
title: DescribeRecommendationFeedbackRequest
properties: {}
RecommendationFeedback:
type: object
properties:
CodeReviewArn:
allOf:
- $ref: '#/components/schemas/Arn'
- description: 'The Amazon Resource Name (ARN) of the CodeReview object. '
RecommendationId:
allOf:
- $ref: '#/components/schemas/RecommendationId'
- description: The recommendation ID that can be used to track the provided recommendations. Later on it can be used to collect the feedback.
Reactions:
allOf:
- $ref: '#/components/schemas/Reactions'
- description: List for storing reactions. Reactions are utf-8 text code for emojis. You can send an empty list to clear off all your feedback.
UserId:
allOf:
- $ref: '#/components/schemas/UserId'
- description: 'The ID of the user that made the API call.
The UserId is an IAM principal that can be specified as an Amazon Web Services account ID or an Amazon Resource
Name (ARN). For more information, see Specifying a Principal
in the Amazon Web Services Identity and Access Management User Guide.
pull_request, workflow_dispatch, schedule, and push '
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.'
FilePath:
type: string
minLength: 1
maxLength: 1024
FindingsCount:
type: integer
JobStates:
type: array
items:
$ref: '#/components/schemas/JobState'
minItems: 1
maxItems: 3
LineNumber:
type: integer
LinesOfCodeCount:
type: integer
ListCodeReviewsMaxResults:
type: integer
minimum: 1
maximum: 100
ProviderTypes:
type: array
items:
$ref: '#/components/schemas/ProviderType'
minItems: 1
maxItems: 3
RepositoryNames:
type: array
items:
$ref: '#/components/schemas/Name'
minItems: 1
maxItems: 100
NextToken:
type: string
minLength: 1
maxLength: 2048
ListCodeReviewsRequest:
type: object
title: ListCodeReviewsRequest
properties: {}
MaxResults:
type: integer
minimum: 1
maximum: 100
UserIds:
type: array
items:
$ref: '#/components/schemas/UserId'
minItems: 1
maxItems: 100
RecommendationIds:
type: array
items:
$ref: '#/components/schemas/RecommendationId'
minItems: 1
maxItems: 100
ListRecommendationFeedbackRequest:
type: object
title: ListRecommendationFeedbackRequest
properties: {}
RecommendationFeedbackSummaries:
type: array
items:
$ref: '#/components/schemas/RecommendationFeedbackSummary'
ListRecommendationsMaxResults:
type: integer
minimum: 1
maximum: 300
ListRecommendationsRequest:
type: object
title: ListRecommendationsRequest
properties: {}
RecommendationSummaries:
type: array
items:
$ref: '#/components/schemas/RecommendationSummary'
RepositoryAssociationStates:
type: array
items:
$ref: '#/components/schemas/RepositoryAssociationState'
minItems: 1
maxItems: 5
Names:
type: array
items:
$ref: '#/components/schemas/Name'
minItems: 1
maxItems: 3
Owners:
type: array
items:
$ref: '#/components/schemas/Owner'
minItems: 1
maxItems: 3
ListRepositoryAssociationsRequest:
type: object
title: ListRepositoryAssociationsRequest
properties: {}
RepositoryAssociationSummaries:
type: array
items:
$ref: '#/components/schemas/RepositoryAssociationSummary'
ListTagsForResourceRequest:
type: object
title: ListTagsForResourceRequest
properties: {}
LongDescription:
type: string
pattern: ^\S(.*\S)?$
minLength: 1
maxLength: 1000
Reactions:
type: array
items:
$ref: '#/components/schemas/Reaction'
minItems: 0
maxItems: 1
PutRecommendationFeedbackRequest:
type: object
required:
- CodeReviewArn
- RecommendationId
- Reactions
title: PutRecommendationFeedbackRequest
properties:
CodeReviewArn:
allOf:
- $ref: '#/components/schemas/Arn'
- description: 'The Amazon Resource Name (ARN) of the CodeReview object. '
RecommendationId:
allOf:
- $ref: '#/components/schemas/RecommendationId'
- description: The recommendation ID that can be used to track the provided recommendations and then to collect the feedback.
Reactions:
allOf:
- $ref: '#/components/schemas/Reactions'
- description: List for storing reactions. Reactions are utf-8 text code for emojis. If you send an empty list it clears all your feedback.
RecommendationCategory:
type: string
enum:
- AWSBestPractices
- AWSCloudFormationIssues
- DuplicateCode
- CodeMaintenanceIssues
- ConcurrencyIssues
- InputValidations
- PythonBestPractices
- JavaBestPractices
- ResourceLeaks
- SecurityIssues
- CodeInconsistencies
RecommendationFeedbackSummary:
type: object
properties:
RecommendationId:
allOf:
- $ref: '#/components/schemas/RecommendationId'
- description: The recommendation ID that can be used to track the provided recommendations. Later on it can be used to collect the feedback.
Reactions:
allOf:
- $ref: '#/components/schemas/Reactions'
- description: List for storing reactions. Reactions are utf-8 text code for emojis.
UserId:
allOf:
- $ref: '#/components/schemas/UserId'
- description: 'The ID of the user that gave the feedback.
The UserId is an IAM principal that can be specified as an Amazon Web Services account ID or an Amazon Resource
Name (ARN). For more information, see Specifying a Principal
in the Amazon Web Services Identity and Access Management User Guide.
RepositoryHeadSourceCodeType specifies the tip of this branch.
description: 'A SourceCodeType that specifies the tip of a branch in an associated repository.'
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 codeguru-reviewer-. '
CodeArtifacts:
allOf:
- $ref: '#/components/schemas/CodeArtifacts'
- description: A CodeArtifacts object. The CodeArtifacts 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 CodeArtifacts 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.
RepositoryAssociationSummary:
type: object
properties:
AssociationArn:
allOf:
- $ref: '#/components/schemas/Arn'
- description: 'The Amazon Resource Name (ARN) of the RepositoryAssociation object. You can
retrieve this ARN by calling ListRepositoryAssociations.'
ConnectionArn:
allOf:
- $ref: '#/components/schemas/ConnectionArn'
- 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:
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: '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 CodeGuru Reviewer to securely clone code in your repository.
Failed: The repository failed to associate or disassociate.
Disassociating: CodeGuru Reviewer is removing the repository''s pull request notifications and source code access.
Disassociated: 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 Using tags to control access to associated repositories in the Amazon CodeGuru Reviewer User Guide.
RepositoryAssociationSummary objects.'
RequestId:
type: string
minLength: 1
maxLength: 64
Requester:
type: string
pattern: ^\S(.*\S)?$
minLength: 1
maxLength: 100
VendorName:
type: string
enum:
- GitHub
- GitLab
- NativeS3
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 Requester is used to capture the author/actor 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 ProviderType is S3Bucket and the CI/CD repository vendor name is GitHub. For
more information, see the definition for ProviderType in RepositoryAssociation.'
description: Metadata that is associated with a code review. This applies to both pull request and repository analysis code reviews.
RuleId:
type: string
pattern: '^\S+\/[a-zA-Z0-9-]+@v\d+\.\d+$'
minLength: 1
maxLength: 64
RuleName:
type: string
pattern: ^\S(.*\S)?$
minLength: 1
maxLength: 100
ShortDescription:
type: string
pattern: ^\S(.*\S)?$
minLength: 1
maxLength: 200
RuleTags:
type: array
items:
$ref: '#/components/schemas/RuleTag'
minItems: 1
maxItems: 20
RuleTag:
type: string
pattern: ^\S(.*\S)?$
minLength: 1
maxLength: 50
S3BucketName:
type: string
pattern: ^\S(.*\S)?$
minLength: 3
maxLength: 63
S3BucketRepository:
type: object
required:
- Name
properties:
Name:
allOf:
- $ref: '#/components/schemas/Name'
- description: The name of the repository when the ProviderType is S3Bucket.
Details:
allOf:
- $ref: '#/components/schemas/S3RepositoryDetails'
- description: An S3RepositoryDetails object that specifies the name of an S3 bucket and a CodeArtifacts object. The CodeArtifacts 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.
TagKeyList:
type: array
items:
$ref: '#/components/schemas/TagKey'
minItems: 1
maxItems: 50
TagResourceRequest:
type: object
required:
- Tags
title: TagResourceRequest
properties:
Tags:
allOf:
- $ref: '#/components/schemas/TagMap'
- 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.