Skip to content

RuleDetail

Source code in docs_src/capo_guardduty/types/rule_detail.py
class RuleDetail(TypedDict, closed=True):
    rule_id: NotRequired["capo_guardduty.types.rule_id.RuleId"]
    """<p>The unique identifier for the rule.</p>"""
    arn: NotRequired["capo_guardduty.types.detection_rule_arn.DetectionRuleArn"]
    """<p>The Amazon Resource Name (ARN) of the rule.</p>"""
    name: NotRequired["capo_guardduty.types.rule_name.RuleName"]
    """<p>The display name of the rule.</p>"""
    description: NotRequired[
        "capo_guardduty.types.detection_rule_description.DetectionRuleDescription"
    ]
    """<p>A description of what the rule detects.</p>"""
    severity: NotRequired[
        "capo_guardduty.types.detection_rule_severity.DetectionRuleSeverity"
    ]
    """<p>The severity level assigned to findings generated by this rule.</p>"""
    data_source: NotRequired[
        "capo_guardduty.types.detection_rule_data_source.DetectionRuleDataSource"
    ]
    """<p>The data source that the rule analyzes.</p>"""
    tactic: NotRequired["capo_guardduty.types.mitre_tactic.MitreTactic"]
    """<p>The MITRE ATT&amp;CK tactic associated with the rule.</p>"""
    technique: NotRequired["capo_guardduty.types.mitre_technique.MitreTechnique"]
    """<p>The MITRE ATT&amp;CK technique associated with the rule.</p>"""
    service: NotRequired[
        "capo_guardduty.types.detection_rule_service_name.DetectionRuleServiceName"
    ]
    """<p>The Amazon Web Services service associated with the rule.</p>"""
    definition: NotRequired["capo_guardduty.types.rule_definition.RuleDefinition"]
    """<p>The detection logic definition for the rule.</p>"""
    language: NotRequired["capo_guardduty.types.rule_language.RuleLanguage"]
    """<p>The language used for the detection logic expression.</p>"""
    schema: NotRequired["capo_guardduty.types.rule_schema.RuleSchema"]
    """<p>The schema version used by the rule definition.</p>"""
    runtime_monitoring_details: NotRequired[
        "capo_guardduty.types.detection_rule_runtime_monitoring_details.DetectionRuleRuntimeMonitoringDetails"
    ]
    """<p>Runtime Monitoring-specific details for the rule, including the platforms on which the rule can run and the minimum GuardDuty agent version required on each.</p>"""
    created_at: NotRequired["capo_guardduty.types.timestamp.Timestamp"]
    """<p>The timestamp when the rule was created.</p>"""
    updated_at: NotRequired["capo_guardduty.types.timestamp.Timestamp"]
    """<p>The timestamp when the rule was last updated.</p>"""

arn instance-attribute

arn: NotRequired[DetectionRuleArn]

The Amazon Resource Name (ARN) of the rule.

created_at instance-attribute

created_at: NotRequired[Timestamp]

The timestamp when the rule was created.

data_source instance-attribute

data_source: NotRequired[DetectionRuleDataSource]

The data source that the rule analyzes.

definition instance-attribute

definition: NotRequired[RuleDefinition]

The detection logic definition for the rule.

description instance-attribute

description: NotRequired[DetectionRuleDescription]

A description of what the rule detects.

language instance-attribute

language: NotRequired[RuleLanguage]

The language used for the detection logic expression.

name instance-attribute

name: NotRequired[RuleName]

The display name of the rule.

rule_id instance-attribute

rule_id: NotRequired[RuleId]

The unique identifier for the rule.

runtime_monitoring_details instance-attribute

runtime_monitoring_details: NotRequired[DetectionRuleRuntimeMonitoringDetails]

Runtime Monitoring-specific details for the rule, including the platforms on which the rule can run and the minimum GuardDuty agent version required on each.

schema instance-attribute

schema: NotRequired[RuleSchema]

The schema version used by the rule definition.

service instance-attribute

service: NotRequired[DetectionRuleServiceName]

The Amazon Web Services service associated with the rule.

severity instance-attribute

severity: NotRequired[DetectionRuleSeverity]

The severity level assigned to findings generated by this rule.

tactic instance-attribute

tactic: NotRequired[MitreTactic]

The MITRE ATT&CK tactic associated with the rule.

technique instance-attribute

technique: NotRequired[MitreTechnique]

The MITRE ATT&CK technique associated with the rule.

updated_at instance-attribute

updated_at: NotRequired[Timestamp]

The timestamp when the rule was last updated.