RuleMetadata - Amazon CodeGuru

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.

Contents

LongDescription

A long description of the rule.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1000.

Pattern: ^\S(.*\S)?$

Required: No

RuleId

The ID of the rule.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: ^\S+\/[a-zA-Z0-9-]+@v\d+\.\d+$

Required: No

RuleName

The name of the rule.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: ^\S(.*\S)?$

Required: No

RuleTags

Tags that are associated with the rule.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 20 items.

Length Constraints: Minimum length of 1. Maximum length of 50.

Pattern: ^\S(.*\S)?$

Required: No

ShortDescription

A short description of the rule.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 200.

Pattern: ^\S(.*\S)?$

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: