Table of Contents
A low-level client representing Amazon CodeGuru Reviewer (CodeGuruReviewer):
import boto3
client = boto3.client('codeguru-reviewer')
These are the available methods:
Use to associate an AWS CodeCommit repository or a repostory managed by AWS 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 repository, it must be in the same AWS Region and AWS account where its CodeGuru Reviewer code reviews are configured.
Bitbucket and GitHub Enterprise Server repositories are managed by AWS CodeStar Connections to connect to CodeGuru Reviewer. For more information, see Connect to a repository source provider in the Amazon CodeGuru Reviewer User Guide.
Note
You cannot use the CodeGuru Reviewer SDK or the AWS 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.
See also: AWS API Documentation
Request Syntax
response = client.associate_repository(
Repository={
'CodeCommit': {
'Name': 'string'
},
'Bitbucket': {
'Name': 'string',
'ConnectionArn': 'string',
'Owner': 'string'
},
'GitHubEnterpriseServer': {
'Name': 'string',
'ConnectionArn': 'string',
'Owner': 'string'
}
},
ClientRequestToken='string'
)
[REQUIRED]
The repository to associate.
Information about an AWS CodeCommit repository.
The name of the AWS CodeCommit repository. For more information, see repositoryName in the AWS CodeCommit API Reference .
Information about a Bitbucket repository.
The name of the third party source repository.
The Amazon Resource Name (ARN) of an AWS 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 AWS CodeStar Connections API Reference .
The owner of the repository. For a GitHub, GitHub Enterprise, or Bitbucket repository, this is the username for the account that owns the repository.
Information about a GitHub Enterprise Server repository.
The name of the third party source repository.
The Amazon Resource Name (ARN) of an AWS 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 AWS CodeStar Connections API Reference .
The owner of the repository. For a GitHub, GitHub Enterprise, or Bitbucket repository, this is the username for the account that owns the repository.
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
To add a new repository association, this parameter specifies a unique identifier for the new repository association that helps ensure idempotency.
If you use the AWS CLI or one of the AWS SDKs to call this operation, you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, you must generate a ClientRequestToken yourself for new versions and include that value in the request.
You typically interact with this value if you implement your own retry logic and want to ensure that a given repository association is not created twice. We recommend that you generate a UUID-type value to ensure uniqueness within the specified repository association.
Amazon CodeGuru Reviewer uses this value to prevent the accidental creation of duplicate repository associations if there are failures and retries.
This field is autopopulated if not provided.
dict
Response Syntax
{
'RepositoryAssociation': {
'AssociationId': 'string',
'AssociationArn': 'string',
'ConnectionArn': 'string',
'Name': 'string',
'Owner': 'string',
'ProviderType': 'CodeCommit'|'GitHub'|'Bitbucket'|'GitHubEnterpriseServer',
'State': 'Associated'|'Associating'|'Failed'|'Disassociating',
'StateReason': 'string',
'LastUpdatedTimeStamp': datetime(2015, 1, 1),
'CreatedTimeStamp': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
RepositoryAssociation (dict) --
Information about the repository association.
AssociationId (string) --
The ID of the repository association.
AssociationArn (string) --
The Amazon Resource Name (ARN) identifying the repository association.
ConnectionArn (string) --
The Amazon Resource Name (ARN) of an AWS 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 AWS CodeStar Connections API Reference .
Name (string) --
The name of the repository.
Owner (string) --
The owner of the repository. For an AWS CodeCommit repository, this is the AWS account ID of the account that owns the repository. For a GitHub or Bitbucket repository, this is the username for the account that owns the repository.
ProviderType (string) --
The provider type of the repository association.
State (string) --
The state of the repository association.
The valid repository association states are:
Associated : The repository association is complete.
Associating : CodeGuru Reviewer is:
Note
If your repository ProviderType is GitHub 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.
Failed : The repository failed to associate or disassociate.
Disassociating : CodeGuru Reviewer is removing the repository's pull request notifications and source code access.
StateReason (string) --
A description of why the repository association is in the current state.
LastUpdatedTimeStamp (datetime) --
The time, in milliseconds since the epoch, when the repository association was last updated.
CreatedTimeStamp (datetime) --
The time, in milliseconds since the epoch, when the repository association was created.
Exceptions
Check if an operation can be paginated.
Returns the metadata associated with the code review along with its status.
See also: AWS API Documentation
Request Syntax
response = client.describe_code_review(
CodeReviewArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the ` CodeReview https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CodeReview.html`__ object.
{
'CodeReview': {
'Name': 'string',
'CodeReviewArn': 'string',
'RepositoryName': 'string',
'Owner': 'string',
'ProviderType': 'CodeCommit'|'GitHub'|'Bitbucket'|'GitHubEnterpriseServer',
'State': 'Completed'|'Pending'|'Failed'|'Deleting',
'StateReason': 'string',
'CreatedTimeStamp': datetime(2015, 1, 1),
'LastUpdatedTimeStamp': datetime(2015, 1, 1),
'Type': 'PullRequest',
'PullRequestId': 'string',
'SourceCodeType': {
'CommitDiff': {
'SourceCommit': 'string',
'DestinationCommit': 'string'
}
},
'Metrics': {
'MeteredLinesOfCodeCount': 123,
'FindingsCount': 123
}
}
}
Response Structure
Information about the code review.
The name of the code review.
The Amazon Resource Name (ARN) of the ` CodeReview https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CodeReview.html`__ object.
The name of the repository.
The owner of the repository. For an AWS CodeCommit repository, this is the AWS account ID of the account that owns the repository. For a GitHub or Bitbucket repository, this is the username for the account that owns the repository.
The type of repository that contains the reviewed code (for example, GitHub or Bitbucket).
The valid code review states are:
The reason for the state of the code review.
The time, in milliseconds since the epoch, when the code review was created.
The time, in milliseconds since the epoch, when the code review was last updated.
The type of code review.
The pull request ID for the code review.
The type of the source code for the code review.
The commit diff for the pull request.
The SHA of the source commit.
The SHA of the destination commit.
The statistics from the code review.
Lines of code metered in the code review. For the initial code review pull request and all subsequent revisions, this includes all lines of code in the files added to the pull request. In subsequent revisions, for files that already existed in the pull request, this includes only the changed lines of code. In both cases, this does not include non-code lines such as comments and import statements. For example, if you submit a pull request containing 5 files, each with 500 lines of code, and in a subsequent revision you added a new file with 200 lines of code, and also modified a total of 25 lines across the initial 5 files, 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.
Total number of recommendations found in the code review.
Exceptions
Describes the customer feedback for a CodeGuru Reviewer recommendation.
See also: AWS API Documentation
Request Syntax
response = client.describe_recommendation_feedback(
CodeReviewArn='string',
RecommendationId='string',
UserId='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the ` CodeReview https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CodeReview.html`__ object.
[REQUIRED]
The recommendation ID that can be used to track the provided recommendations and then to collect the feedback.
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 AWS account ID or an Amazon Resource Name (ARN). For more information, see Specifying a Principal in the AWS Identity and Access Management User Guide .
dict
Response Syntax
{
'RecommendationFeedback': {
'CodeReviewArn': 'string',
'RecommendationId': 'string',
'Reactions': [
'ThumbsUp'|'ThumbsDown',
],
'UserId': 'string',
'CreatedTimeStamp': datetime(2015, 1, 1),
'LastUpdatedTimeStamp': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
RecommendationFeedback (dict) --
The recommendation feedback given by the user.
CodeReviewArn (string) --
The Amazon Resource Name (ARN) of the ` CodeReview https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CodeReview.html`__ object.
RecommendationId (string) --
The recommendation ID that can be used to track the provided recommendations. Later on it can be used to collect the feedback.
Reactions (list) --
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 (string) --
The ID of the user that made the API call.
The UserId is an IAM principal that can be specified as an AWS account ID or an Amazon Resource Name (ARN). For more information, see Specifying a Principal in the AWS Identity and Access Management User Guide .
CreatedTimeStamp (datetime) --
The time at which the feedback was created.
LastUpdatedTimeStamp (datetime) --
The time at which the feedback was last updated.
Exceptions
Returns a ` RepositoryAssociation https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociation.html`__ object that contains information about the requested repository association.
See also: AWS API Documentation
Request Syntax
response = client.describe_repository_association(
AssociationArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the ` RepositoryAssociation https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociation.html`__ object. You can retrieve this ARN by calling ListRepositories .
{
'RepositoryAssociation': {
'AssociationId': 'string',
'AssociationArn': 'string',
'ConnectionArn': 'string',
'Name': 'string',
'Owner': 'string',
'ProviderType': 'CodeCommit'|'GitHub'|'Bitbucket'|'GitHubEnterpriseServer',
'State': 'Associated'|'Associating'|'Failed'|'Disassociating',
'StateReason': 'string',
'LastUpdatedTimeStamp': datetime(2015, 1, 1),
'CreatedTimeStamp': datetime(2015, 1, 1)
}
}
Response Structure
Information about the repository association.
The ID of the repository association.
The Amazon Resource Name (ARN) identifying the repository association.
The Amazon Resource Name (ARN) of an AWS 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 AWS CodeStar Connections API Reference .
The name of the repository.
The owner of the repository. For an AWS CodeCommit repository, this is the AWS account ID of the account that owns the repository. For a GitHub or Bitbucket repository, this is the username for the account that owns the repository.
The provider type of the repository association.
The state of the repository association.
The valid repository association states are:
Note
If your repository ProviderType is GitHub 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.
A description of why the repository association is in the current state.
The time, in milliseconds since the epoch, when the repository association was last updated.
The time, in milliseconds since the epoch, when the repository association was created.
Exceptions
Removes the association between Amazon CodeGuru Reviewer and a repository.
See also: AWS API Documentation
Request Syntax
response = client.disassociate_repository(
AssociationArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the ` RepositoryAssociation https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociation.html`__ object.
{
'RepositoryAssociation': {
'AssociationId': 'string',
'AssociationArn': 'string',
'ConnectionArn': 'string',
'Name': 'string',
'Owner': 'string',
'ProviderType': 'CodeCommit'|'GitHub'|'Bitbucket'|'GitHubEnterpriseServer',
'State': 'Associated'|'Associating'|'Failed'|'Disassociating',
'StateReason': 'string',
'LastUpdatedTimeStamp': datetime(2015, 1, 1),
'CreatedTimeStamp': datetime(2015, 1, 1)
}
}
Response Structure
Information about the disassociated repository.
The ID of the repository association.
The Amazon Resource Name (ARN) identifying the repository association.
The Amazon Resource Name (ARN) of an AWS 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 AWS CodeStar Connections API Reference .
The name of the repository.
The owner of the repository. For an AWS CodeCommit repository, this is the AWS account ID of the account that owns the repository. For a GitHub or Bitbucket repository, this is the username for the account that owns the repository.
The provider type of the repository association.
The state of the repository association.
The valid repository association states are:
Note
If your repository ProviderType is GitHub 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.
A description of why the repository association is in the current state.
The time, in milliseconds since the epoch, when the repository association was last updated.
The time, in milliseconds since the epoch, when the repository association was created.
Exceptions
Generate a presigned url given a client, its method, and arguments
The presigned url
Create a paginator for an operation.
Returns an object that can wait for some condition.
Lists all the code reviews that the customer has created in the past 90 days.
See also: AWS API Documentation
Request Syntax
response = client.list_code_reviews(
ProviderTypes=[
'CodeCommit'|'GitHub'|'Bitbucket'|'GitHubEnterpriseServer',
],
States=[
'Completed'|'Pending'|'Failed'|'Deleting',
],
RepositoryNames=[
'string',
],
Type='PullRequest',
MaxResults=123,
NextToken='string'
)
List of provider types for filtering that needs to be applied before displaying the result. For example, providerTypes=[GitHub] lists code reviews from GitHub.
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:
List of repository names for filtering that needs to be applied before displaying the result.
[REQUIRED]
The type of code reviews to list in the response.
dict
Response Syntax
{
'CodeReviewSummaries': [
{
'Name': 'string',
'CodeReviewArn': 'string',
'RepositoryName': 'string',
'Owner': 'string',
'ProviderType': 'CodeCommit'|'GitHub'|'Bitbucket'|'GitHubEnterpriseServer',
'State': 'Completed'|'Pending'|'Failed'|'Deleting',
'CreatedTimeStamp': datetime(2015, 1, 1),
'LastUpdatedTimeStamp': datetime(2015, 1, 1),
'Type': 'PullRequest',
'PullRequestId': 'string',
'MetricsSummary': {
'MeteredLinesOfCodeCount': 123,
'FindingsCount': 123
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
CodeReviewSummaries (list) --
A list of code reviews that meet the criteria of the request.
(dict) --
Information about the summary of the code review.
Name (string) --
The name of the code review.
CodeReviewArn (string) --
The Amazon Resource Name (ARN) of the ` CodeReview https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CodeReview.html`__ object.
RepositoryName (string) --
The name of the repository.
Owner (string) --
The owner of the repository. For an AWS CodeCommit repository, this is the AWS account ID of the account that owns the repository. For a GitHub or Bitbucket repository, this is the username for the account that owns the repository.
ProviderType (string) --
The provider type of the repository association.
State (string) --
The state of the code review.
The valid code review states are:
CreatedTimeStamp (datetime) --
The time, in milliseconds since the epoch, when the code review was created.
LastUpdatedTimeStamp (datetime) --
The time, in milliseconds since the epoch, when the code review was last updated.
Type (string) --
The type of the code review.
PullRequestId (string) --
The pull request ID for the code review.
MetricsSummary (dict) --
The statistics from the code review.
MeteredLinesOfCodeCount (integer) --
Lines of code metered in the code review. For the initial code review pull request and all subsequent revisions, this includes all lines of code in the files added to the pull request. In subsequent revisions, for files that already existed in the pull request, this includes only the changed lines of code. In both cases, this does not include non-code lines such as comments and import statements. For example, if you submit a pull request containing 5 files, each with 500 lines of code, and in a subsequent revision you added a new file with 200 lines of code, and also modified a total of 25 lines across the initial 5 files, 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.
FindingsCount (integer) --
Total number of recommendations found in the code review.
NextToken (string) --
Pagination token.
Exceptions
Returns a list of ` RecommendationFeedbackSummary https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RecommendationFeedbackSummary.html`__ objects that contain customer recommendation feedback for all CodeGuru Reviewer users.
See also: AWS API Documentation
Request Syntax
response = client.list_recommendation_feedback(
NextToken='string',
MaxResults=123,
CodeReviewArn='string',
UserIds=[
'string',
],
RecommendationIds=[
'string',
]
)
[REQUIRED]
The Amazon Resource Name (ARN) of the ` CodeReview https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CodeReview.html`__ object.
An AWS 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 AWS account ID or an Amazon Resource Name (ARN). For more information, see Specifying a Principal in the AWS Identity and Access Management User Guide .
Used to query the recommendation feedback for a given recommendation.
dict
Response Syntax
{
'RecommendationFeedbackSummaries': [
{
'RecommendationId': 'string',
'Reactions': [
'ThumbsUp'|'ThumbsDown',
],
'UserId': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
RecommendationFeedbackSummaries (list) --
Recommendation feedback summaries corresponding to the code review ARN.
(dict) --
Information about recommendation feedback summaries.
RecommendationId (string) --
The recommendation ID that can be used to track the provided recommendations. Later on it can be used to collect the feedback.
Reactions (list) --
List for storing reactions. Reactions are utf-8 text code for emojis.
UserId (string) --
The ID of the user that gave the feedback.
The UserId is an IAM principal that can be specified as an AWS account ID or an Amazon Resource Name (ARN). For more information, see Specifying a Principal in the AWS Identity and Access Management User Guide .
NextToken (string) --
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.
Exceptions
Returns the list of all recommendations for a completed code review.
See also: AWS API Documentation
Request Syntax
response = client.list_recommendations(
NextToken='string',
MaxResults=123,
CodeReviewArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the ` CodeReview https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CodeReview.html`__ object.
dict
Response Syntax
{
'RecommendationSummaries': [
{
'FilePath': 'string',
'RecommendationId': 'string',
'StartLine': 123,
'EndLine': 123,
'Description': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
RecommendationSummaries (list) --
List of recommendations for the requested code review.
(dict) --
Information about recommendations.
FilePath (string) --
Name of the file on which a recommendation is provided.
RecommendationId (string) --
The recommendation ID that can be used to track the provided recommendations. Later on it can be used to collect the feedback.
StartLine (integer) --
Start line from where the recommendation is applicable in the source commit or source branch.
EndLine (integer) --
Last line where the recommendation is applicable in the source commit or source branch. For a single line comment the start line and end line values are the same.
Description (string) --
A description of the recommendation generated by CodeGuru Reviewer for the lines of code between the start line and the end line.
NextToken (string) --
Pagination token.
Exceptions
Returns a list of ` RepositoryAssociationSummary https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociationSummary.html`__ objects that contain summary information about a repository association. You can filter the returned list by ` ProviderType https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociationSummary.html#reviewer-Type-RepositoryAssociationSummary-ProviderType`__ , ` Name https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociationSummary.html#reviewer-Type-RepositoryAssociationSummary-Name`__ , ` State https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociationSummary.html#reviewer-Type-RepositoryAssociationSummary-State`__ , and ` Owner https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociationSummary.html#reviewer-Type-RepositoryAssociationSummary-Owner`__ .
See also: AWS API Documentation
Request Syntax
response = client.list_repository_associations(
ProviderTypes=[
'CodeCommit'|'GitHub'|'Bitbucket'|'GitHubEnterpriseServer',
],
States=[
'Associated'|'Associating'|'Failed'|'Disassociating',
],
Names=[
'string',
],
Owners=[
'string',
],
MaxResults=123,
NextToken='string'
)
List of provider types to use as a filter.
List of repository association states to use as a filter.
The valid repository association states are:
Note
If your repository ProviderType is GitHub 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.
List of repository names to use as a filter.
List of owners to use as a filter. For AWS CodeCommit, it is the name of the CodeCommit account that was used to associate the repository. For other repository source providers, such as Bitbucket, this is name of the account that was used to associate the repository.
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.
Note
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.
dict
Response Syntax
{
'RepositoryAssociationSummaries': [
{
'AssociationArn': 'string',
'ConnectionArn': 'string',
'LastUpdatedTimeStamp': datetime(2015, 1, 1),
'AssociationId': 'string',
'Name': 'string',
'Owner': 'string',
'ProviderType': 'CodeCommit'|'GitHub'|'Bitbucket'|'GitHubEnterpriseServer',
'State': 'Associated'|'Associating'|'Failed'|'Disassociating'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
RepositoryAssociationSummaries (list) --
A list of repository associations that meet the criteria of the request.
(dict) --
Summary information about a repository association. The ` ListRepositoryAssociations https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_ListRepositoryAssociations.html`__ operation returns a list of RepositoryAssociationSummary objects.
AssociationArn (string) --
The Amazon Resource Name (ARN) of the ` RepositoryAssociation https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociation.html`__ object.
ConnectionArn (string) --
The Amazon Resource Name (ARN) of an AWS 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 AWS CodeStar Connections API Reference .
LastUpdatedTimeStamp (datetime) --
The time, in milliseconds since the epoch, since the repository association was last updated.
AssociationId (string) --
The repository association ID.
Name (string) --
The name of the repository association.
Owner (string) --
The owner of the repository. For an AWS CodeCommit repository, this is the AWS account ID of the account that owns the repository. For a GitHub or Bitbucket repository, this is the username for the account that owns the repository.
ProviderType (string) --
The provider type of the repository association.
State (string) --
The state of the repository association.
The valid repository association states are:
Associated : The repository association is complete.
Associating : CodeGuru Reviewer is:
Note
If your repository ProviderType is GitHub 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.
Failed : The repository failed to associate or disassociate.
Disassociating : CodeGuru Reviewer is removing the repository's pull request notifications and source code access.
NextToken (string) --
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.
Exceptions
Stores customer feedback for a CodeGuru Reviewer recommendation. When this API is called again with different reactions the previous feedback is overwritten.
See also: AWS API Documentation
Request Syntax
response = client.put_recommendation_feedback(
CodeReviewArn='string',
RecommendationId='string',
Reactions=[
'ThumbsUp'|'ThumbsDown',
]
)
[REQUIRED]
The Amazon Resource Name (ARN) of the ` CodeReview https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CodeReview.html`__ object.
[REQUIRED]
The recommendation ID that can be used to track the provided recommendations and then to collect the feedback.
[REQUIRED]
List for storing reactions. Reactions are utf-8 text code for emojis. If you send an empty list it clears all your feedback.
dict
Response Syntax
{}
Response Structure
Exceptions
The available paginators are:
paginator = client.get_paginator('list_repository_associations')
Creates an iterator that will paginate through responses from CodeGuruReviewer.Client.list_repository_associations().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
ProviderTypes=[
'CodeCommit'|'GitHub'|'Bitbucket'|'GitHubEnterpriseServer',
],
States=[
'Associated'|'Associating'|'Failed'|'Disassociating',
],
Names=[
'string',
],
Owners=[
'string',
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
List of provider types to use as a filter.
List of repository association states to use as a filter.
The valid repository association states are:
Note
If your repository ProviderType is GitHub 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.
List of repository names to use as a filter.
List of owners to use as a filter. For AWS CodeCommit, it is the name of the CodeCommit account that was used to associate the repository. For other repository source providers, such as Bitbucket, this is name of the account that was used to associate the repository.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'RepositoryAssociationSummaries': [
{
'AssociationArn': 'string',
'ConnectionArn': 'string',
'LastUpdatedTimeStamp': datetime(2015, 1, 1),
'AssociationId': 'string',
'Name': 'string',
'Owner': 'string',
'ProviderType': 'CodeCommit'|'GitHub'|'Bitbucket'|'GitHubEnterpriseServer',
'State': 'Associated'|'Associating'|'Failed'|'Disassociating'
},
],
}
Response Structure
(dict) --
RepositoryAssociationSummaries (list) --
A list of repository associations that meet the criteria of the request.
(dict) --
Summary information about a repository association. The ` ListRepositoryAssociations https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_ListRepositoryAssociations.html`__ operation returns a list of RepositoryAssociationSummary objects.
AssociationArn (string) --
The Amazon Resource Name (ARN) of the ` RepositoryAssociation https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociation.html`__ object.
ConnectionArn (string) --
The Amazon Resource Name (ARN) of an AWS 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 AWS CodeStar Connections API Reference .
LastUpdatedTimeStamp (datetime) --
The time, in milliseconds since the epoch, since the repository association was last updated.
AssociationId (string) --
The repository association ID.
Name (string) --
The name of the repository association.
Owner (string) --
The owner of the repository. For an AWS CodeCommit repository, this is the AWS account ID of the account that owns the repository. For a GitHub or Bitbucket repository, this is the username for the account that owns the repository.
ProviderType (string) --
The provider type of the repository association.
State (string) --
The state of the repository association.
The valid repository association states are:
Associated : The repository association is complete.
Associating : CodeGuru Reviewer is:
Note
If your repository ProviderType is GitHub 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.
Failed : The repository failed to associate or disassociate.
Disassociating : CodeGuru Reviewer is removing the repository's pull request notifications and source code access.