2020/06/30 - Amazon CodeGuru Reviewer - 6 updated api methods
Changes Release GitHub Enterprise Server source provider integration
{'Repository': {'GitHubEnterpriseServer': {'ConnectionArn': 'string',
'Name': 'string',
'Owner': 'string'}}}
Response {'RepositoryAssociation': {'ProviderType': {'GitHubEnterpriseServer'}}}
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
client.associate_repository(
Repository={
'CodeCommit': {
'Name': 'string'
},
'Bitbucket': {
'Name': 'string',
'ConnectionArn': 'string',
'Owner': 'string'
},
'GitHubEnterpriseServer': {
'Name': 'string',
'ConnectionArn': 'string',
'Owner': 'string'
}
},
ClientRequestToken='string'
)
dict
[REQUIRED]
The repository to associate.
CodeCommit (dict) --
Information about an AWS CodeCommit repository.
Name (string) -- [REQUIRED]
The name of the AWS CodeCommit repository. For more information, see repositoryName in the AWS CodeCommit API Reference .
Bitbucket (dict) --
Information about a Bitbucket repository.
Name (string) -- [REQUIRED]
The name of the third party source repository.
ConnectionArn (string) -- [REQUIRED]
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 .
Owner (string) -- [REQUIRED]
The owner of the repository. For a GitHub, GitHub Enterprise, or Bitbucket repository, this is the username for the account that owns the repository.
GitHubEnterpriseServer (dict) --
Information about a GitHub Enterprise Server repository.
Name (string) -- [REQUIRED]
The name of the third party source repository.
ConnectionArn (string) -- [REQUIRED]
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 .
Owner (string) -- [REQUIRED]
The owner of the repository. For a GitHub, GitHub Enterprise, or Bitbucket repository, this is the username for the account that owns the repository.
string
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:
Setting up pull request notifications. This is required for pull requests to trigger a CodeGuru Reviewer review.
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.
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.
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.
{'CodeReview': {'ProviderType': {'GitHubEnterpriseServer'}}}
Returns the metadata associated with the code review along with its status.
See also: AWS API Documentation
Request Syntax
client.describe_code_review(
CodeReviewArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the CodeReview object.
dict
Response Syntax
{
'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
(dict) --
CodeReview (dict) --
Information about the code review.
Name (string) --
The name of the code review.
CodeReviewArn (string) --
The Amazon Resource Name (ARN) of the CodeReview 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 type of repository that contains the reviewed code (for example, GitHub or Bitbucket).
State (string) --
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.
StateReason (string) --
The reason for the state of the code review.
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 code review.
PullRequestId (string) --
The pull request ID for the code review.
SourceCodeType (dict) --
The type of the source code for the code review.
CommitDiff (dict) --
The commit diff for the pull request.
SourceCommit (string) --
The SHA of the source commit.
DestinationCommit (string) --
The SHA of the destination commit.
Metrics (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.
{'RepositoryAssociation': {'ProviderType': {'GitHubEnterpriseServer'}}}
Returns a RepositoryAssociation object that contains information about the requested repository association.
See also: AWS API Documentation
Request Syntax
client.describe_repository_association(
AssociationArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the RepositoryAssociation object. You can retrieve this ARN by calling ListRepositories .
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:
Setting up pull request notifications. This is required for pull requests to trigger a CodeGuru Reviewer review.
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.
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.
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.
{'RepositoryAssociation': {'ProviderType': {'GitHubEnterpriseServer'}}}
Removes the association between Amazon CodeGuru Reviewer and a repository.
See also: AWS API Documentation
Request Syntax
client.disassociate_repository(
AssociationArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the RepositoryAssociation object.
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 disassociated repository.
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:
Setting up pull request notifications. This is required for pull requests to trigger a CodeGuru Reviewer review.
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.
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.
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.
{'ProviderTypes': {'GitHubEnterpriseServer'}}
Response {'CodeReviewSummaries': {'ProviderType': {'GitHubEnterpriseServer'}}}
Lists all the code reviews that the customer has created in the past 90 days.
See also: AWS API Documentation
Request Syntax
client.list_code_reviews(
ProviderTypes=[
'CodeCommit'|'GitHub'|'Bitbucket'|'GitHubEnterpriseServer',
],
States=[
'Completed'|'Pending'|'Failed'|'Deleting',
],
RepositoryNames=[
'string',
],
Type='PullRequest',
MaxResults=123,
NextToken='string'
)
list
List of provider types for filtering that needs to be applied before displaying the result. For example, providerTypes=[GitHub] lists code reviews from GitHub.
(string) --
list
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.
(string) --
list
List of repository names for filtering that needs to be applied before displaying the result.
(string) --
string
[REQUIRED]
The type of code reviews to list in the response.
integer
The maximum number of results that are returned per call. The default is 100.
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.
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 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:
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.
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.
{'ProviderTypes': {'GitHubEnterpriseServer'}}
Response {'RepositoryAssociationSummaries': {'ProviderType': {'GitHubEnterpriseServer'}}}
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.
See also: AWS API Documentation
Request Syntax
client.list_repository_associations(
ProviderTypes=[
'CodeCommit'|'GitHub'|'Bitbucket'|'GitHubEnterpriseServer',
],
States=[
'Associated'|'Associating'|'Failed'|'Disassociating',
],
Names=[
'string',
],
Owners=[
'string',
],
MaxResults=123,
NextToken='string'
)
list
List of provider types to use as a filter.
(string) --
list
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.
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.
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.
(string) --
list
List of repository names to use as a filter.
(string) --
list
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.
(string) --
integer
The maximum number of repository association results returned by ListRepositoryAssociations in paginated output. When this parameter is used, ListRepositoryAssociations only returns maxResults results in a single page with a nextToken response element. The remaining results of the initial request can be seen by sending another ListRepositoryAssociations request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, ListRepositoryAssociations returns up to 100 results and a nextToken value if applicable.
string
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 operation returns a list of RepositoryAssociationSummary objects.
AssociationArn (string) --
The Amazon Resource Name (ARN) of the RepositoryAssociation 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:
Setting up pull request notifications. This is required for pull requests to trigger a CodeGuru Reviewer review.
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.
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.
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.