--- title: Getting Started with Datadog description: Datadog, the leading service for cloud-scale monitoring. breadcrumbs: Docs > Infrastructure > Datadog Resource Catalog --- # aws_codeguru_reviewer_codereview{% #aws_codeguru_reviewer_codereview %} ## `account_id`{% #account_id %} **Type**: `STRING` ## `code_review_arn`{% #code_review_arn %} **Type**: `STRING`**Provider name**: `CodeReviewArn`**Description**: The Amazon Resource Name (ARN) of the [CodeReview](https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CodeReview.html) object. ## `created_time_stamp`{% #created_time_stamp %} **Type**: `TIMESTAMP`**Provider name**: `CreatedTimeStamp`**Description**: The time, in milliseconds since the epoch, when the code review was created. ## `last_updated_time_stamp`{% #last_updated_time_stamp %} **Type**: `TIMESTAMP`**Provider name**: `LastUpdatedTimeStamp`**Description**: The time, in milliseconds since the epoch, when the code review was last updated. ## `metrics_summary`{% #metrics_summary %} **Type**: `STRUCT`**Provider name**: `MetricsSummary`**Description**: The statistics from the code review. - `findings_count`**Type**: `INT64`**Provider name**: `FindingsCount`**Description**: Total number of recommendations found in the code review. - `metered_lines_of_code_count`**Type**: `INT64`**Provider name**: `MeteredLinesOfCodeCount`**Description**: 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. - `suppressed_lines_of_code_count`**Type**: `INT64`**Provider name**: `SuppressedLinesOfCodeCount`**Description**: 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. ## `name`{% #name %} **Type**: `STRING`**Provider name**: `Name`**Description**: The name of the code review. ## `owner`{% #owner %} **Type**: `STRING`**Provider name**: `Owner`**Description**: 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. ## `provider_type`{% #provider_type %} **Type**: `STRING`**Provider name**: `ProviderType`**Description**: The provider type of the repository association. ## `pull_request_id`{% #pull_request_id %} **Type**: `STRING`**Provider name**: `PullRequestId`**Description**: The pull request ID for the code review. ## `repository_name`{% #repository_name %} **Type**: `STRING`**Provider name**: `RepositoryName`**Description**: The name of the repository. ## `source_code_type`{% #source_code_type %} **Type**: `STRUCT`**Provider name**: `SourceCodeType` - `branch_diff`**Type**: `STRUCT`**Provider name**: `BranchDiff`**Description**: A type of [SourceCodeType](https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_SourceCodeType) that specifies a source branch name and a destination branch name in an associated repository. - `destination_branch_name`**Type**: `STRING`**Provider name**: `DestinationBranchName`**Description**: The destination branch for a diff in an associated repository. - `source_branch_name`**Type**: `STRING`**Provider name**: `SourceBranchName`**Description**: The source branch for a diff in an associated repository. - `commit_diff`**Type**: `STRUCT`**Provider name**: `CommitDiff`**Description**: 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. - `destination_commit`**Type**: `STRING`**Provider name**: `DestinationCommit`**Description**: The SHA of the destination commit used to generate a commit diff. This field is required for a pull request code review. - `merge_base_commit`**Type**: `STRING`**Provider name**: `MergeBaseCommit`**Description**: The SHA of the merge base of a commit. - `source_commit`**Type**: `STRING`**Provider name**: `SourceCommit`**Description**: The SHA of the source commit used to generate a commit diff. This field is required for a pull request code review. - `repository_head`**Type**: `STRUCT`**Provider name**: `RepositoryHead` - `branch_name`**Type**: `STRING`**Provider name**: `BranchName`**Description**: The name of the branch in an associated repository. The `RepositoryHeadSourceCodeType` specifies the tip of this branch. - `request_metadata`**Type**: `STRUCT`**Provider name**: `RequestMetadata`**Description**: 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. - `event_info`**Type**: `STRUCT`**Provider name**: `EventInfo`**Description**: Information about the event associated with a code review. - `name`**Type**: `STRING`**Provider name**: `Name`**Description**: The name of the event. The possible names are `pull_request`, `workflow_dispatch`, `schedule`, and `push` - `state`**Type**: `STRING`**Provider name**: `State`**Description**: The state of an event. The state might be open, closed, or another state. - `request_id`**Type**: `STRING`**Provider name**: `RequestId`**Description**: The ID of the request. This is required for a pull request code review. - `requester`**Type**: `STRING`**Provider name**: `Requester`**Description**: 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. - `vendor_name`**Type**: `STRING`**Provider name**: `VendorName`**Description**: 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](https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociation.html). - `s3_bucket_repository`**Type**: `STRUCT`**Provider name**: `S3BucketRepository`**Description**: 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](https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_SourceCodeType) for `S3BucketRepository` based code reviews. - `details`**Type**: `STRUCT`**Provider name**: `Details`**Description**: 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. - `bucket_name`**Type**: `STRING`**Provider name**: `BucketName`**Description**: The name of the S3 bucket used for associating a new S3 repository. It must begin with `codeguru-reviewer-`. - `code_artifacts`**Type**: `STRUCT`**Provider name**: `CodeArtifacts`**Description**: 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. - `build_artifacts_object_key`**Type**: `STRING`**Provider name**: `BuildArtifactsObjectKey`**Description**: 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](https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/working-with-cicd.html) in the Amazon CodeGuru Reviewer User Guide. - `source_code_artifacts_object_key`**Type**: `STRING`**Provider name**: `SourceCodeArtifactsObjectKey`**Description**: The S3 object key for a source code .zip file. This is required for all code reviews. - `name`**Type**: `STRING`**Provider name**: `Name`**Description**: The name of the repository when the `ProviderType` is `S3Bucket`. ## `state`{% #state %} **Type**: `STRING`**Provider name**: `State`**Description**: 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. ## `tags`{% #tags %} **Type**: `UNORDERED_LIST_STRING` ## `type`{% #type %} **Type**: `STRING`**Provider name**: `Type`**Description**: The type of the code review.