RecommendationSummary
Information about recommendations.
Contents
- Description
-
A description of the recommendation generated by CodeGuru Reviewer for the lines of code between the start line and the end line.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 5000.
Required: No
- EndLine
-
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.
Type: Integer
Required: No
- FilePath
-
Name of the file on which a recommendation is provided.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No
- RecommendationCategory
-
The type of a recommendation.
Type: String
Valid Values:
AWSBestPractices | AWSCloudFormationIssues | DuplicateCode | CodeMaintenanceIssues | ConcurrencyIssues | InputValidations | PythonBestPractices | JavaBestPractices | ResourceLeaks | SecurityIssues | CodeInconsistenciesRequired: No
- RecommendationId
-
The recommendation ID that can be used to track the provided recommendations. Later on it can be used to collect the feedback.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Required: No
- RuleMetadata
-
Metadata about a rule. Rule metadata includes an ID, a name, a list of tags, and a short and long description. CodeGuru Reviewer uses rules to analyze code. A rule's recommendation is included in analysis results if code is detected that violates the rule.
Type: RuleMetadata object
Required: No
- Severity
-
The severity of the issue in the code that generated this recommendation.
Type: String
Valid Values:
Info | Low | Medium | High | CriticalRequired: No
- StartLine
-
Start line from where the recommendation is applicable in the source commit or source branch.
Type: Integer
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
