CodeGuruReviewer ¶

Table of Contents

CodeGuruReviewer
- Client
- Paginators

Client ¶

class CodeGuruReviewer.Client¶

A low-level client representing Amazon CodeGuru Reviewer (CodeGuruReviewer):

import boto3

client = boto3.client('codeguru-reviewer')

These are the available methods:

associate_repository()
can_paginate()
describe_code_review()
describe_recommendation_feedback()
describe_repository_association()
disassociate_repository()
generate_presigned_url()
get_paginator()
get_waiter()
list_code_reviews()
list_recommendation_feedback()
list_recommendations()
list_repository_associations()
put_recommendation_feedback()

associate_repository(**kwargs)¶

Associates an AWS CodeCommit repository with Amazon CodeGuru Reviewer. When you associate an AWS CodeCommit repository with Amazon CodeGuru Reviewer, Amazon CodeGuru Reviewer will provide recommendations for each pull request raised within the repository. You can view recommendations in the AWS CodeCommit repository.

You can associate a GitHub repository using the Amazon CodeGuru Reviewer console.

See also: AWS API Documentation

Request Syntax

response = client.associate_repository(
    Repository={
        'CodeCommit': {
            'Name': 'string'
        },
        'Bitbucket': {
            'Name': 'string',
            'ConnectionArn': 'string',
            'Owner': 'string'
        }
    },
    ClientRequestToken='string'
)

Parameters

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.
- Bitbucket (dict) --
  Information about a Bitbucket Cloud repository.
  - Name (string) -- [REQUIRED]
    The name of the third party source repository.
  - ConnectionArn (string) -- [REQUIRED]
    The Amazon Resource Name (ARN) identifying the repository connection.
  - Owner (string) -- [REQUIRED]
    The username of the owner of the repository.
ClientRequestToken (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.

Return type

dict

Returns

Response Syntax

{
    'RepositoryAssociation': {
        'AssociationId': 'string',
        'AssociationArn': 'string',
        'ConnectionArn': 'string',
        'Name': 'string',
        'Owner': 'string',
        'ProviderType': 'CodeCommit'|'GitHub'|'Bitbucket',
        '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) identifying the repository connection.
  - Name (string) --
    
    The name of the repository.
  - Owner (string) --
    
    The owner of the repository.
  - ProviderType (string) --
    
    The provider type of the repository association.
  - State (string) --
    
    The state of the repository association.
  - 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

CodeGuruReviewer.Client.exceptions.InternalServerException
CodeGuruReviewer.Client.exceptions.ValidationException
CodeGuruReviewer.Client.exceptions.AccessDeniedException
CodeGuruReviewer.Client.exceptions.ConflictException
CodeGuruReviewer.Client.exceptions.ThrottlingException

can_paginate(operation_name)¶

Check if an operation can be paginated.

Parameters: 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").
Returns: True if the operation can be paginated, False otherwise.

describe_code_review(**kwargs)¶

Returns the metadaata associated with the code review along with its status.

See also: AWS API Documentation

Request Syntax

response = client.describe_code_review(
    CodeReviewArn='string'
)

Parameters

CodeReviewArn (string) --

[REQUIRED]

The Amazon Resource Name (ARN) of the code review to describe.

Return type

dict

Returns

Response Syntax

{
    'CodeReview': {
        'Name': 'string',
        'CodeReviewArn': 'string',
        'RepositoryName': 'string',
        'Owner': 'string',
        'ProviderType': 'CodeCommit'|'GitHub'|'Bitbucket',
        '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 code review to describe.
  - RepositoryName (string) --
    The name of the repository.
  - Owner (string) --
    The owner of the repository.
  - ProviderType (string) --
    The provider type of the repository association.
  - State (string) --
    The state of the code review.
  - 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) --
        Source Commit SHA.
      - DestinationCommit (string) --
        Destination Commit SHA
  - Metrics (dict) --
    The statistics from the code review.
    - MeteredLinesOfCodeCount (integer) --
      Lines of code metered in the code review.
    - FindingsCount (integer) --
      Total number of recommendations found in the code review.

Exceptions

CodeGuruReviewer.Client.exceptions.ResourceNotFoundException
CodeGuruReviewer.Client.exceptions.InternalServerException
CodeGuruReviewer.Client.exceptions.ValidationException
CodeGuruReviewer.Client.exceptions.AccessDeniedException
CodeGuruReviewer.Client.exceptions.ThrottlingException

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'
)

Parameters

CodeReviewArn (string) --
[REQUIRED]

The Amazon Resource Name (ARN) that identifies the code review.
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.

Return type

dict

Returns

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) that identifies the code review.
  - 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 user principal that made the API call.
  - CreatedTimeStamp (datetime) --
    
    The time at which the feedback was created.
  - LastUpdatedTimeStamp (datetime) --
    
    The time at which the feedback was last updated.

Exceptions

CodeGuruReviewer.Client.exceptions.ResourceNotFoundException
CodeGuruReviewer.Client.exceptions.InternalServerException
CodeGuruReviewer.Client.exceptions.ValidationException
CodeGuruReviewer.Client.exceptions.AccessDeniedException
CodeGuruReviewer.Client.exceptions.ThrottlingException

describe_repository_association(**kwargs)¶

Describes a repository association.

See also: AWS API Documentation

Request Syntax

response = client.describe_repository_association(
    AssociationArn='string'
)

Parameters

AssociationArn (string) --

[REQUIRED]

The Amazon Resource Name (ARN) identifying the association. You can retrieve this ARN by calling ListRepositories .

Return type

dict

Returns

Response Syntax

{
    'RepositoryAssociation': {
        'AssociationId': 'string',
        'AssociationArn': 'string',
        'ConnectionArn': 'string',
        'Name': 'string',
        'Owner': 'string',
        'ProviderType': 'CodeCommit'|'GitHub'|'Bitbucket',
        '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) identifying the repository connection.
  - Name (string) --
    The name of the repository.
  - Owner (string) --
    The owner of the repository.
  - ProviderType (string) --
    The provider type of the repository association.
  - State (string) --
    The state of the repository association.
  - 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

CodeGuruReviewer.Client.exceptions.NotFoundException
CodeGuruReviewer.Client.exceptions.InternalServerException
CodeGuruReviewer.Client.exceptions.ValidationException
CodeGuruReviewer.Client.exceptions.AccessDeniedException
CodeGuruReviewer.Client.exceptions.ThrottlingException

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'
)

Parameters

AssociationArn (string) --

[REQUIRED]

The Amazon Resource Name (ARN) identifying the association.

Return type

dict

Returns

Response Syntax

{
    'RepositoryAssociation': {
        'AssociationId': 'string',
        'AssociationArn': 'string',
        'ConnectionArn': 'string',
        'Name': 'string',
        'Owner': 'string',
        'ProviderType': 'CodeCommit'|'GitHub'|'Bitbucket',
        '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) identifying the repository connection.
  - Name (string) --
    The name of the repository.
  - Owner (string) --
    The owner of the repository.
  - ProviderType (string) --
    The provider type of the repository association.
  - State (string) --
    The state of the repository association.
  - 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

CodeGuruReviewer.Client.exceptions.NotFoundException
CodeGuruReviewer.Client.exceptions.InternalServerException
CodeGuruReviewer.Client.exceptions.ValidationException
CodeGuruReviewer.Client.exceptions.AccessDeniedException
CodeGuruReviewer.Client.exceptions.ConflictException
CodeGuruReviewer.Client.exceptions.ThrottlingException

generate_presigned_url(ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None)¶

Generate a presigned url given a client, its method, and arguments

Parameters

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.

Returns

The presigned url

get_paginator(operation_name)¶

Create a paginator for an operation.

Parameters: 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").
Raises OperationNotPageableError: Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type: L{botocore.paginate.Paginator}
Returns: A paginator object.

get_waiter(waiter_name)¶

Returns an object that can wait for some condition.

Parameters: waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
Returns: The specified waiter object.
Return type: 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',
    ],
    States=[
        'Completed'|'Pending'|'Failed'|'Deleting',
    ],
    RepositoryNames=[
        'string',
    ],
    Type='PullRequest',
    MaxResults=123,
    NextToken='string'
)

Parameters

ProviderTypes (list) --
List of provider types for filtering that needs to be applied before displaying the result. For example, "providerTypes=[GitHub]" will list 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]" will list code reviews in the Pending state.
- (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.

Return type

dict

Returns

Response Syntax

{
    'CodeReviewSummaries': [
        {
            'Name': 'string',
            'CodeReviewArn': 'string',
            'RepositoryName': 'string',
            'Owner': 'string',
            'ProviderType': 'CodeCommit'|'GitHub'|'Bitbucket',
            '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 code review to describe.
    - RepositoryName (string) --
      
      The name of the repository.
    - Owner (string) --
      
      The owner of the repository.
    - ProviderType (string) --
      
      The provider type of the repository association.
    - State (string) --
      
      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 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.
      - FindingsCount (integer) --
        
        Total number of recommendations found in the code review.
- NextToken (string) --
  
  Pagination token.

Exceptions

CodeGuruReviewer.Client.exceptions.InternalServerException
CodeGuruReviewer.Client.exceptions.ValidationException
CodeGuruReviewer.Client.exceptions.ThrottlingException
CodeGuruReviewer.Client.exceptions.AccessDeniedException

list_recommendation_feedback(**kwargs)¶

Lists the customer feedback for a CodeGuru Reviewer recommendation for all users. This API will be used from the console to extract the previously given feedback by the user to pre-populate the feedback emojis for all recommendations.

See also: AWS API Documentation

Request Syntax

response = client.list_recommendation_feedback(
    NextToken='string',
    MaxResults=123,
    CodeReviewArn='string',
    UserIds=[
        'string',
    ],
    RecommendationIds=[
        'string',
    ]
)

Parameters

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) that identifies the code review.
UserIds (list) --
Filter on userIds that need to be applied before displaying the result. This can be used to query all the recommendation feedback for a code review from a given user.
- (string) --
RecommendationIds (list) --
Filter on recommendationIds that need to be applied before displaying the result. This can be used to query all the recommendation feedback for a given recommendation.
- (string) --

Return type

dict

Returns

Response Syntax

{
    'RecommendationFeedbackSummaries': [
        {
            'RecommendationId': 'string',
            'Reactions': [
                'ThumbsUp'|'ThumbsDown',
            ],
            'UserId': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- RecommendationFeedbackSummaries (list) --
  
  Recommendation feedback summaries corresponding to the code reivew 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 identifier for the user that gave the feedback.
- 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

CodeGuruReviewer.Client.exceptions.ResourceNotFoundException
CodeGuruReviewer.Client.exceptions.InternalServerException
CodeGuruReviewer.Client.exceptions.ValidationException
CodeGuruReviewer.Client.exceptions.AccessDeniedException
CodeGuruReviewer.Client.exceptions.ThrottlingException

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'
)

Parameters

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 code review to describe.

Return type

dict

Returns

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 will be 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

CodeGuruReviewer.Client.exceptions.ResourceNotFoundException
CodeGuruReviewer.Client.exceptions.InternalServerException
CodeGuruReviewer.Client.exceptions.ValidationException
CodeGuruReviewer.Client.exceptions.AccessDeniedException
CodeGuruReviewer.Client.exceptions.ThrottlingException

list_repository_associations(**kwargs)¶

Lists repository associations. You can optionally filter on one or more of the following recommendation properties: provider types, states, names, and owners.

See also: AWS API Documentation

Request Syntax

response = client.list_repository_associations(
    ProviderTypes=[
        'CodeCommit'|'GitHub'|'Bitbucket',
    ],
    States=[
        'Associated'|'Associating'|'Failed'|'Disassociating',
    ],
    Names=[
        'string',
    ],
    Owners=[
        'string',
    ],
    MaxResults=123,
    NextToken='string'
)

Parameters

ProviderTypes (list) --
List of provider types to use as a filter.
- (string) --
States (list) --
List of states to use as a filter.
- (string) --
Names (list) --
List of repository names to use as a filter.
- (string) --
Owners (list) --
List of owners to use as a filter. For GitHub, this is name of the GitHub account that was used to associate the repository. For AWS CodeCommit, it is the name of the CodeCommit 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 25. If this parameter is not used, ListRepositoryAssociations returns up to 25 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.

Return type

dict

Returns

Response Syntax

{
    'RepositoryAssociationSummaries': [
        {
            'AssociationArn': 'string',
            'ConnectionArn': 'string',
            'LastUpdatedTimeStamp': datetime(2015, 1, 1),
            'AssociationId': 'string',
            'Name': 'string',
            'Owner': 'string',
            'ProviderType': 'CodeCommit'|'GitHub'|'Bitbucket',
            '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) --
    
    Information about a repository association.
    - AssociationArn (string) --
      
      The Amazon Resource Name (ARN) identifying the repository association.
    - ConnectionArn (string) --
      
      The Amazon Resource Name (ARN) identifying the repository connection.
    - 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 association.
    - ProviderType (string) --
      
      The provider type of the repository association.
    - State (string) --
      
      The state of the repository association.
      
      Associated
      
      Amazon CodeGuru Reviewer is associated with the repository.
      
      Associating
      
      The association is in progress.
      
      Failed
      
      The association failed.
      
      Disassociating
      
      Amazon CodeGuru Reviewer is in the process of disassociating with the repository.
- 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

CodeGuruReviewer.Client.exceptions.InternalServerException
CodeGuruReviewer.Client.exceptions.ValidationException
CodeGuruReviewer.Client.exceptions.ThrottlingException

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',
    ]
)

Parameters

CodeReviewArn (string) --
[REQUIRED]

The Amazon Resource Name (ARN) that identifies the code review.
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) --

Return type

dict

Returns

Response Syntax

{}

Response Structure

(dict) --

Exceptions

CodeGuruReviewer.Client.exceptions.ResourceNotFoundException
CodeGuruReviewer.Client.exceptions.InternalServerException
CodeGuruReviewer.Client.exceptions.ValidationException
CodeGuruReviewer.Client.exceptions.AccessDeniedException
CodeGuruReviewer.Client.exceptions.ThrottlingException

Paginators ¶

The available paginators are:

CodeGuruReviewer.Paginator.ListRepositoryAssociations

class 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',
    ],
    States=[
        'Associated'|'Associating'|'Failed'|'Disassociating',
    ],
    Names=[
        'string',
    ],
    Owners=[
        'string',
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters

ProviderTypes (list) --
List of provider types to use as a filter.
- (string) --
States (list) --
List of states to use as a filter.
- (string) --
Names (list) --
List of repository names to use as a filter.
- (string) --
Owners (list) --
List of owners to use as a filter. For GitHub, this is name of the GitHub account that was used to associate the repository. For AWS CodeCommit, it is the name of the CodeCommit 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.

Return type

dict

Returns

Response Syntax

{
    'RepositoryAssociationSummaries': [
        {
            'AssociationArn': 'string',
            'ConnectionArn': 'string',
            'LastUpdatedTimeStamp': datetime(2015, 1, 1),
            'AssociationId': 'string',
            'Name': 'string',
            'Owner': 'string',
            'ProviderType': 'CodeCommit'|'GitHub'|'Bitbucket',
            'State': 'Associated'|'Associating'|'Failed'|'Disassociating'
        },
    ],

}

Response Structure

(dict) --
- RepositoryAssociationSummaries (list) --
  
  A list of repository associations that meet the criteria of the request.
  - (dict) --
    
    Information about a repository association.
    - AssociationArn (string) --
      
      The Amazon Resource Name (ARN) identifying the repository association.
    - ConnectionArn (string) --
      
      The Amazon Resource Name (ARN) identifying the repository connection.
    - 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 association.
    - ProviderType (string) --
      
      The provider type of the repository association.
    - State (string) --
      
      The state of the repository association.
      
      Associated
      
      Amazon CodeGuru Reviewer is associated with the repository.
      
      Associating
      
      The association is in progress.
      
      Failed
      
      The association failed.
      
      Disassociating
      
      Amazon CodeGuru Reviewer is in the process of disassociating with the repository.

Navigation

Table Of Contents

CodeGuruReviewer¶

Client¶

Paginators¶

Navigation

CodeGuruReviewer ¶

Client ¶

Paginators ¶