CodeGuruReviewer / Client / list_code_reviews

list_code_reviews#

CodeGuruReviewer.Client.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'|'S3Bucket',
    ],
    States=[
        'Completed'|'Pending'|'Failed'|'Deleting',
    ],
    RepositoryNames=[
        'string',
    ],
    Type='PullRequest'|'RepositoryAnalysis',
    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] 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.

Return type:

dict

Returns:

Response Syntax

{
    'CodeReviewSummaries': [
        {
            'Name': 'string',
            'CodeReviewArn': 'string',
            'RepositoryName': 'string',
            'Owner': 'string',
            'ProviderType': 'CodeCommit'|'GitHub'|'Bitbucket'|'GitHubEnterpriseServer'|'S3Bucket',
            'State': 'Completed'|'Pending'|'Failed'|'Deleting',
            'CreatedTimeStamp': datetime(2015, 1, 1),
            'LastUpdatedTimeStamp': datetime(2015, 1, 1),
            'Type': 'PullRequest'|'RepositoryAnalysis',
            'PullRequestId': 'string',
            'MetricsSummary': {
                'MeteredLinesOfCodeCount': 123,
                'SuppressedLinesOfCodeCount': 123,
                'FindingsCount': 123
            },
            'SourceCodeType': {
                'CommitDiff': {
                    'SourceCommit': 'string',
                    'DestinationCommit': 'string',
                    'MergeBaseCommit': 'string'
                },
                'RepositoryHead': {
                    'BranchName': 'string'
                },
                'BranchDiff': {
                    'SourceBranchName': 'string',
                    'DestinationBranchName': 'string'
                },
                'S3BucketRepository': {
                    'Name': 'string',
                    'Details': {
                        'BucketName': 'string',
                        'CodeArtifacts': {
                            'SourceCodeArtifactsObjectKey': 'string',
                            'BuildArtifactsObjectKey': 'string'
                        }
                    }
                },
                'RequestMetadata': {
                    'RequestId': 'string',
                    'Requester': 'string',
                    'EventInfo': {
                        'Name': 'string',
                        'State': 'string'
                    },
                    'VendorName': 'GitHub'|'GitLab'|'NativeS3'
                }
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • CodeReviewSummaries (list) –

      A list of code reviews that meet the criteria of the request.

      • (dict) –

        Information about the summary of the code review.

        • Name (string) –

          The name of the code review.

        • CodeReviewArn (string) –

          The Amazon Resource Name (ARN) of the CodeReview object.

        • RepositoryName (string) –

          The name of the repository.

        • Owner (string) –

          The owner of the repository. For an Amazon Web Services CodeCommit repository, this is the Amazon Web Services account ID of the account that owns the repository. For a GitHub, GitHub Enterprise Server, or Bitbucket repository, this is the username for the account that owns the repository. For an S3 repository, it can be the username or Amazon Web Services account ID.

        • ProviderType (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.

          • SuppressedLinesOfCodeCount (integer) –

            Lines of code suppressed in the code review based on the excludeFiles element in the aws-codeguru-reviewer.yml file. For full repository analyses, this number includes all lines of code in the files that are suppressed. For pull requests, this number only includes the changed lines of code that are suppressed. In both cases, this number does not include non-code lines such as comments and import statements. For example, if you initiate a full repository analysis on a repository containing 5 files, each file with 100 lines of code, and 2 files are listed as excluded in the aws-codeguru-reviewer.yml file, then SuppressedLinesOfCodeCount returns 200 (2 * 100) as the total number of lines of code suppressed. However, if you submit a pull request for the same repository, then SuppressedLinesOfCodeCount only includes the lines in the 2 files that changed. If only 1 of the 2 files changed in the pull request, then SuppressedLinesOfCodeCount returns 100 (1 * 100) as the total number of lines of code suppressed.

          • FindingsCount (integer) –

            Total number of recommendations found in the code review.

        • SourceCodeType (dict) –

          Specifies the source code that is analyzed in a code review.

          • CommitDiff (dict) –

            A 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. This field is required for a pull request code review.

            • DestinationCommit (string) –

              The SHA of the destination commit used to generate a commit diff. This field is required for a pull request code review.

            • MergeBaseCommit (string) –

              The SHA of the merge base of a commit.

          • RepositoryHead (dict) –

            A 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.

          • BranchDiff (dict) –

            A type of SourceCodeType that specifies a source branch name and a destination branch name in an associated repository.

            • SourceBranchName (string) –

              The source branch for a diff in an associated repository.

            • DestinationBranchName (string) –

              The destination branch for a diff in an associated repository.

          • S3BucketRepository (dict) –

            Information about an associated repository in an S3 bucket that includes its name and an S3RepositoryDetails object. The S3RepositoryDetails object includes the name of an S3 bucket, an S3 key for a source code .zip file, and an S3 key for a build artifacts .zip file. S3BucketRepository is required in SourceCodeType for S3BucketRepository based code reviews.

            • Name (string) –

              The name of the repository when the ProviderType is S3Bucket.

            • Details (dict) –

              An S3RepositoryDetails object that specifies the name of an S3 bucket and a CodeArtifacts object. The CodeArtifacts object includes the S3 object keys for a source code .zip file and for a build artifacts .zip file.

              • BucketName (string) –

                The name of the S3 bucket used for associating a new S3 repository. It must begin with codeguru-reviewer-.

              • CodeArtifacts (dict) –

                A CodeArtifacts object. The CodeArtifacts object includes the S3 object key for a source code .zip file and for a build artifacts .zip file that contains .jar or .class files.

                • SourceCodeArtifactsObjectKey (string) –

                  The S3 object key for a source code .zip file. This is required for all code reviews.

                • BuildArtifactsObjectKey (string) –

                  The S3 object key for a build artifacts .zip file that contains .jar or .class files. This is required for a code review with security analysis. For more information, see Create code reviews with GitHub Actions in the Amazon CodeGuru Reviewer User Guide.

          • RequestMetadata (dict) –

            Metadata that is associated with a code review. This applies to any type of code review supported by CodeGuru Reviewer. The RequestMetadaa field captures any event metadata. For example, it might capture metadata associated with an event trigger, such as a push or a pull request.

            • RequestId (string) –

              The ID of the request. This is required for a pull request code review.

            • Requester (string) –

              An identifier, such as a name or account ID, that is associated with the requester. The Requester is used to capture the author/actor name of the event request.

            • EventInfo (dict) –

              Information about the event associated with a code review.

              • Name (string) –

                The name of the event. The possible names are pull_request, workflow_dispatch, schedule, and push

              • State (string) –

                The state of an event. The state might be open, closed, or another state.

            • VendorName (string) –

              The name of the repository vendor used to upload code to an S3 bucket for a CI/CD code review. For example, if code and artifacts are uploaded to an S3 bucket for a CI/CD code review by GitHub scripts from a GitHub repository, then the repository association’s ProviderType is S3Bucket and the CI/CD repository vendor name is GitHub. For more information, see the definition for ProviderType in RepositoryAssociation.

    • NextToken (string) –

      Pagination token.

Exceptions