# RuleSummary
<a name="API_RuleSummary"></a>

Contains summary information about a custom detection rule.

## Contents
<a name="API_RuleSummary_Contents"></a>

 ** arn **   <a name="guardduty-Type-RuleSummary-arn"></a>
The Amazon Resource Name (ARN) of the rule.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `arn:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:([0-9]*|aws):.+`   
Required: Yes

 ** createdAt **   <a name="guardduty-Type-RuleSummary-createdAt"></a>
The timestamp when the rule was created.  
Type: Timestamp  
Required: Yes

 ** dataSource **   <a name="guardduty-Type-RuleSummary-dataSource"></a>
The data source that the rule analyzes.  
Type: String  
Valid Values: `CloudTrailManagementEvent`   
Required: Yes

 ** description **   <a name="guardduty-Type-RuleSummary-description"></a>
A description of what the rule detects.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: Yes

 ** name **   <a name="guardduty-Type-RuleSummary-name"></a>
The display name of the rule.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: Yes

 ** ruleId **   <a name="guardduty-Type-RuleSummary-ruleId"></a>
The unique identifier for the rule.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[a-z0-9]+(-[a-z0-9]+)*`   
Required: Yes

 ** service **   <a name="guardduty-Type-RuleSummary-service"></a>
The AWS service associated with the rule.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Required: Yes

 ** severity **   <a name="guardduty-Type-RuleSummary-severity"></a>
The severity level assigned to findings generated by this rule.  
Type: String  
Valid Values: `CRITICAL | HIGH | MEDIUM | LOW`   
Required: Yes

 ** tactic **   <a name="guardduty-Type-RuleSummary-tactic"></a>
The MITRE ATT&CK tactic associated with the rule.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: Yes

 ** technique **   <a name="guardduty-Type-RuleSummary-technique"></a>
The MITRE ATT&CK technique associated with the rule.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: Yes

 ** language **   <a name="guardduty-Type-RuleSummary-language"></a>
The language used for the detection logic expression.  
Type: String  
Valid Values: `SQL`   
Required: No

 ** schema **   <a name="guardduty-Type-RuleSummary-schema"></a>
The schema version used by the rule definition.  
Type: String  
Valid Values: `CloudTrail`   
Required: No

 ** updatedAt **   <a name="guardduty-Type-RuleSummary-updatedAt"></a>
The timestamp when the rule was last updated.  
Type: Timestamp  
Required: No

## See Also
<a name="API_RuleSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/guardduty-2017-11-28/RuleSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/guardduty-2017-11-28/RuleSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/guardduty-2017-11-28/RuleSummary)