Table of Contents
CodeGuruReviewer.
Client
¶A low-level client representing Amazon CodeGuru Reviewer (CodeGuruReviewer)
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 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 (AWS PrivateLink) in the Amazon CodeGuru Reviewer User Guide .
client = session.create_client('codeguru-reviewer')
These are the available methods:
associate_repository
(**kwargs)¶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',
Tags={
'string': 'string'
}
)
Repository (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
https://docs.aws.amazon.com/codestar-connections/latest/APIReference/API_Connection.html`__ 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
https://docs.aws.amazon.com/codestar-connections/latest/APIReference/API_Connection.html`__ 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.
ClientRequestToken (string) –
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.
Tags (dict) –
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.
(string) –
(string) –
dict
Response Syntax
{
'RepositoryAssociation': {
'AssociationId': 'string',
'AssociationArn': 'string',
'ConnectionArn': 'string',
'Name': 'string',
'Owner': 'string',
'ProviderType': 'CodeCommit'|'GitHub'|'Bitbucket'|'GitHubEnterpriseServer',
'State': 'Associated'|'Associating'|'Failed'|'Disassociating'|'Disassociated',
'StateReason': 'string',
'LastUpdatedTimeStamp': datetime(2015, 1, 1),
'CreatedTimeStamp': datetime(2015, 1, 1)
},
'Tags': {
'string': 'string'
}
}
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
https://docs.aws.amazon.com/codestar-connections/latest/APIReference/API_Connection.html`__ 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, GitHub Enterprise Server, 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
, 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 an associated 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 .
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.
Tags (dict) –
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.
(string) –
(string) –
Exceptions
can_paginate
(operation_name)¶Check if an operation can be paginated.
operation_name (string) – The operation name. This is the same name
as the method name on the client. For example, if the
method name is create_foo
, and you’d normally invoke the
operation as client.create_foo(**kwargs)
, if the
create_foo
operation can be paginated, you can use the
call client.get_paginator("create_foo")
.
True
if the operation can be paginated,
False
otherwise.
create_code_review
(**kwargs)¶Use to create a code review with a ` CodeReviewType
https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CodeReviewType.html`__ of 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 so cannot be created using this method.
See also: AWS API Documentation
Request Syntax
response = client.create_code_review(
Name='string',
RepositoryAssociationArn='string',
Type={
'RepositoryAnalysis': {
'RepositoryHead': {
'BranchName': 'string'
}
}
},
ClientRequestToken='string'
)
Name (string) –
[REQUIRED]
The name of the code review. The name of each code review in your AWS account must be unique.
RepositoryAssociationArn (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 ` ListRepositoryAssociations
https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_ListRepositoryAssociations.html`__ .
A code review can only be created on an associated repository. This is the ARN of the associated repository.
Type (dict) –
[REQUIRED]
The type of code review to create. This is specified using a ` CodeReviewType
https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CodeReviewType.html`__ object. You can create a code review only of type RepositoryAnalysis
.
RepositoryAnalysis (dict) – [REQUIRED]
A code review that analyzes all code under a specified branch in an associated respository. The assocated repository is specified using its ARN in ` CreateCodeReview
https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CreateCodeReview`__ .
RepositoryHead (dict) – [REQUIRED]
A ` SourceCodeType
https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_SourceCodeType`__ that specifies the tip of a branch in an associated repository.
BranchName (string) – [REQUIRED]
The name of the branch in an associated repository. The RepositoryHeadSourceCodeType
specifies the tip of this branch.
ClientRequestToken (string) –
Amazon CodeGuru Reviewer uses this value to prevent the accidental creation of duplicate code reviews if there are failures and retries.
This field is autopopulated if not provided.
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'|'RepositoryAnalysis',
'PullRequestId': 'string',
'SourceCodeType': {
'CommitDiff': {
'SourceCommit': 'string',
'DestinationCommit': 'string'
},
'RepositoryHead': {
'BranchName': 'string'
}
},
'AssociationArn': 'string',
'Metrics': {
'MeteredLinesOfCodeCount': 123,
'FindingsCount': 123
}
}
}
Response Structure
(dict) –
CodeReview (dict) –
Information about a code review. A code review belongs to the associated repository that contains the reviewed code.
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, GitHub Enterprise Server, 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) –
A ` SourceCodeType
https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_SourceCodeType`__ that specifies a commit diff created by a pull request on an associated repository.
SourceCommit (string) –
The SHA of the source commit used to generate a commit diff.
DestinationCommit (string) –
The SHA of the destination commit used to generate a commit diff.
RepositoryHead (dict) –
A ` SourceCodeType
https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_SourceCodeType`__ that specifies the tip of a branch in an associated repository.
BranchName (string) –
The name of the branch in an associated repository. The RepositoryHeadSourceCodeType
specifies the tip of this branch.
AssociationArn (string) –
The Amazon Resource Name (ARN) of the ` RepositoryAssociation
https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociation.html`__ that contains the reviewed source code. You can retrieve associated repository ARNs by calling ` ListRepositoryAssociations
https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_ListRepositoryAssociations.html`__ .
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.
Exceptions
describe_code_review
(**kwargs)¶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'
)
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
{
'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'|'RepositoryAnalysis',
'PullRequestId': 'string',
'SourceCodeType': {
'CommitDiff': {
'SourceCommit': 'string',
'DestinationCommit': 'string'
},
'RepositoryHead': {
'BranchName': 'string'
}
},
'AssociationArn': '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
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, GitHub Enterprise Server, 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) –
A ` SourceCodeType
https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_SourceCodeType`__ that specifies a commit diff created by a pull request on an associated repository.
SourceCommit (string) –
The SHA of the source commit used to generate a commit diff.
DestinationCommit (string) –
The SHA of the destination commit used to generate a commit diff.
RepositoryHead (dict) –
A ` SourceCodeType
https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_SourceCodeType`__ that specifies the tip of a branch in an associated repository.
BranchName (string) –
The name of the branch in an associated repository. The RepositoryHeadSourceCodeType
specifies the tip of this branch.
AssociationArn (string) –
The Amazon Resource Name (ARN) of the ` RepositoryAssociation
https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociation.html`__ that contains the reviewed source code. You can retrieve associated repository ARNs by calling ` ListRepositoryAssociations
https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_ListRepositoryAssociations.html`__ .
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.
Exceptions
describe_recommendation_feedback
(**kwargs)¶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'
)
CodeReviewArn (string) –
[REQUIRED]
The Amazon Resource Name (ARN) of the ` CodeReview
https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CodeReview.html`__ object.
RecommendationId (string) –
[REQUIRED]
The recommendation ID that can be used to track the provided recommendations and then to collect the feedback.
UserId (string) –
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.
(string) –
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
describe_repository_association
(**kwargs)¶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'
)
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 ` ListRepositoryAssociations
https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_ListRepositoryAssociations.html`__ .
dict
Response Syntax
{
'RepositoryAssociation': {
'AssociationId': 'string',
'AssociationArn': 'string',
'ConnectionArn': 'string',
'Name': 'string',
'Owner': 'string',
'ProviderType': 'CodeCommit'|'GitHub'|'Bitbucket'|'GitHubEnterpriseServer',
'State': 'Associated'|'Associating'|'Failed'|'Disassociating'|'Disassociated',
'StateReason': 'string',
'LastUpdatedTimeStamp': datetime(2015, 1, 1),
'CreatedTimeStamp': datetime(2015, 1, 1)
},
'Tags': {
'string': 'string'
}
}
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
https://docs.aws.amazon.com/codestar-connections/latest/APIReference/API_Connection.html`__ 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, GitHub Enterprise Server, 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
, 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 an associated 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 .
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.
Tags (dict) –
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.
(string) –
(string) –
Exceptions
disassociate_repository
(**kwargs)¶Removes the association between Amazon CodeGuru Reviewer and a repository.
See also: AWS API Documentation
Request Syntax
response = client.disassociate_repository(
AssociationArn='string'
)
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 ` ListRepositoryAssociations
https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_ListRepositoryAssociations.html`__ .
dict
Response Syntax
{
'RepositoryAssociation': {
'AssociationId': 'string',
'AssociationArn': 'string',
'ConnectionArn': 'string',
'Name': 'string',
'Owner': 'string',
'ProviderType': 'CodeCommit'|'GitHub'|'Bitbucket'|'GitHubEnterpriseServer',
'State': 'Associated'|'Associating'|'Failed'|'Disassociating'|'Disassociated',
'StateReason': 'string',
'LastUpdatedTimeStamp': datetime(2015, 1, 1),
'CreatedTimeStamp': datetime(2015, 1, 1)
},
'Tags': {
'string': 'string'
}
}
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
https://docs.aws.amazon.com/codestar-connections/latest/APIReference/API_Connection.html`__ 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, GitHub Enterprise Server, 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
, 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 an associated 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 .
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.
Tags (dict) –
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.
(string) –
(string) –
Exceptions
generate_presigned_url
(ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None)¶Generate a presigned url given a client, its method, and arguments
ClientMethod (string) – The client method to presign for
Params (dict) – The parameters normally passed to
ClientMethod
.
ExpiresIn (int) – The number of seconds the presigned url is valid for. By default it expires in an hour (3600 seconds)
HttpMethod (string) – The http method to use on the generated url. By default, the http method is whatever is used in the method’s model.
The presigned url
get_paginator
(operation_name)¶Create a paginator for an operation.
operation_name (string) – The operation name. This is the same name
as the method name on the client. For example, if the
method name is create_foo
, and you’d normally invoke the
operation as client.create_foo(**kwargs)
, if the
create_foo
operation can be paginated, you can use the
call client.get_paginator("create_foo")
.
OperationNotPageableError – Raised if the operation is not
pageable. You can use the client.can_paginate
method to
check if an operation is pageable.
L{botocore.paginate.Paginator}
A paginator object.
get_waiter
(waiter_name)¶Returns an object that can wait for some condition.
waiter_name (str) – The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
The specified waiter object.
botocore.waiter.Waiter
list_code_reviews
(**kwargs)¶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'|'RepositoryAnalysis',
MaxResults=123,
NextToken='string'
)
ProviderTypes (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) –
States (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) –
RepositoryNames (list) –
List of repository names for filtering that needs to be applied before displaying the result.
(string) –
Type (string) –
[REQUIRED]
The type of code reviews to list in the response.
MaxResults (integer) – The maximum number of results that are returned per call. The default is 100.
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.
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'|'RepositoryAnalysis',
'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, GitHub Enterprise Server, 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.
Exceptions
list_recommendation_feedback
(**kwargs)¶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',
]
)
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.
MaxResults (integer) – The maximum number of results that are returned per call. The default is 100.
CodeReviewArn (string) –
[REQUIRED]
The Amazon Resource Name (ARN) of the ` CodeReview
https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CodeReview.html`__ object.
UserIds (list) –
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 .
(string) –
RecommendationIds (list) –
Used to query the recommendation feedback for a given recommendation.
(string) –
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.
(string) –
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
list_recommendations
(**kwargs)¶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'
)
NextToken (string) – Pagination token.
MaxResults (integer) – The maximum number of results that are returned per call. The default is 100.
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
list_repository_associations
(**kwargs)¶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'|'Disassociated',
],
Names=[
'string',
],
Owners=[
'string',
],
MaxResults=123,
NextToken='string'
)
ProviderTypes (list) –
List of provider types to use as a filter.
(string) –
States (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
, 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 an associated 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 .
(string) –
Names (list) –
List of repository names to use as a filter.
(string) –
Owners (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 and GitHub Enterprise Server, this is name of the account that was used to associate the repository.
(string) –
MaxResults (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.
NextToken (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'|'Disassociated'
},
],
'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. You can retrieve this ARN by calling ` ListRepositoryAssociations
https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_ListRepositoryAssociations.html`__ .
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
https://docs.aws.amazon.com/codestar-connections/latest/APIReference/API_Connection.html`__ 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, GitHub Enterprise Server, 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
, 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 an associated 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 .
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
Returns the list of tags associated with an associated repository resource.
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_resource(
resourceArn='string'
)
resourceArn (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 ` ListRepositoryAssociations
https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_ListRepositoryAssociations.html`__ .
dict
Response Syntax
{
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) –
Tags (dict) –
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.
(string) –
(string) –
Exceptions
put_recommendation_feedback
(**kwargs)¶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',
]
)
CodeReviewArn (string) –
[REQUIRED]
The Amazon Resource Name (ARN) of the ` CodeReview
https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CodeReview.html`__ object.
RecommendationId (string) –
[REQUIRED]
The recommendation ID that can be used to track the provided recommendations and then to collect the feedback.
Reactions (list) –
[REQUIRED]
List for storing reactions. Reactions are utf-8 text code for emojis. If you send an empty list it clears all your feedback.
(string) –
dict
Response Syntax
{}
Response Structure
(dict) –
Exceptions
tag_resource
(**kwargs)¶Adds one or more tags to an associated repository.
See also: AWS API Documentation
Request Syntax
response = client.tag_resource(
resourceArn='string',
Tags={
'string': 'string'
}
)
resourceArn (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 ` ListRepositoryAssociations
https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_ListRepositoryAssociations.html`__ .
Tags (dict) –
[REQUIRED]
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.
(string) –
(string) –
dict
Response Syntax
{}
Response Structure
(dict) –
Exceptions
untag_resource
(**kwargs)¶Removes a tag from an associated repository.
See also: AWS API Documentation
Request Syntax
response = client.untag_resource(
resourceArn='string',
TagKeys=[
'string',
]
)
resourceArn (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 ` ListRepositoryAssociations
https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_ListRepositoryAssociations.html`__ .
TagKeys (list) –
[REQUIRED]
A list of the keys for each tag you want to remove from an associated repository.
(string) –
dict
Response Syntax
{}
Response Structure
(dict) –
Exceptions
Client exceptions are available on a client instance via the exceptions
property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling user guide.
The available client exceptions are:
CodeGuruReviewer.Client.exceptions.
AccessDeniedException
¶You do not have sufficient access to perform this action.
Example
try:
...
except client.exceptions.AccessDeniedException as e:
print(e.response)
response
¶The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'Message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
You do not have sufficient access to perform this action.
Message (string) –
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
CodeGuruReviewer.Client.exceptions.
ConflictException
¶The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.
Example
try:
...
except client.exceptions.ConflictException as e:
print(e.response)
response
¶The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'Message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.
Message (string) –
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
CodeGuruReviewer.Client.exceptions.
InternalServerException
¶The server encountered an internal error and is unable to complete the request.
Example
try:
...
except client.exceptions.InternalServerException as e:
print(e.response)
response
¶The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'Message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
The server encountered an internal error and is unable to complete the request.
Message (string) –
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
CodeGuruReviewer.Client.exceptions.
NotFoundException
¶The resource specified in the request was not found.
Example
try:
...
except client.exceptions.NotFoundException as e:
print(e.response)
response
¶The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'Message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
The resource specified in the request was not found.
Message (string) –
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
CodeGuruReviewer.Client.exceptions.
ResourceNotFoundException
¶The resource specified in the request was not found.
Example
try:
...
except client.exceptions.ResourceNotFoundException as e:
print(e.response)
response
¶The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'Message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
The resource specified in the request was not found.
Message (string) –
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
CodeGuruReviewer.Client.exceptions.
ThrottlingException
¶The request was denied due to request throttling.
Example
try:
...
except client.exceptions.ThrottlingException as e:
print(e.response)
response
¶The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'Message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
The request was denied due to request throttling.
Message (string) –
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
CodeGuruReviewer.Client.exceptions.
ValidationException
¶The input fails to satisfy the specified constraints.
Example
try:
...
except client.exceptions.ValidationException as e:
print(e.response)
response
¶The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'Message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
The input fails to satisfy the specified constraints.
Message (string) –
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The available paginators are:
CodeGuruReviewer.Paginator.
ListRepositoryAssociations
¶paginator = client.get_paginator('list_repository_associations')
paginate
(**kwargs)¶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'|'Disassociated',
],
Names=[
'string',
],
Owners=[
'string',
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
ProviderTypes (list) –
List of provider types to use as a filter.
(string) –
States (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
, 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 an associated 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 .
(string) –
Names (list) –
List of repository names to use as a filter.
(string) –
Owners (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 and GitHub Enterprise Server, this is name of the account that was used to associate the repository.
(string) –
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
MaxItems (integer) –
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.
PageSize (integer) –
The size of each page.
StartingToken (string) –
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'|'Disassociated'
},
],
}
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. You can retrieve this ARN by calling ` ListRepositoryAssociations
https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_ListRepositoryAssociations.html`__ .
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
https://docs.aws.amazon.com/codestar-connections/latest/APIReference/API_Connection.html`__ 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, GitHub Enterprise Server, 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
, 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 an associated 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 .