Skip to content

DetectionRuleOrgConfiguration

Source code in docs_src/capo_guardduty/types/detection_rule_org_configuration.py
class DetectionRuleOrgConfiguration(TypedDict, closed=True):
    rule_id: NotRequired["capo_guardduty.types.rule_id.RuleId"]
    """<p>The unique identifier for the custom detection rule.</p>"""
    mode: NotRequired["capo_guardduty.types.association_mode.AssociationMode"]
    """<p>The execution mode of the organization configuration. Valid values: <code>LIVE</code> | <code>DRY_RUN</code>.</p>"""
    status: NotRequired[
        "capo_guardduty.types.detection_rule_configuration_status.DetectionRuleConfigurationStatus"
    ]
    """<p>The configuration status. Valid values: <code>ACTIVE</code> | <code>PROCESSING</code> | <code>FAILED</code>.</p>"""
    status_reason: NotRequired["capo_guardduty.types.string.String"]
    """<p>The reason for the current configuration status.</p>"""
    include_account_ids: NotRequired[
        "capo_guardduty.types.detection_rule_account_ids.DetectionRuleAccountIds"
    ]
    """<p>A list of member account IDs included in the organization configuration. Mutually exclusive with <code>ExcludeAccountIds</code>.</p>"""
    exclude_account_ids: NotRequired[
        "capo_guardduty.types.detection_rule_account_ids.DetectionRuleAccountIds"
    ]
    """<p>A list of member account IDs excluded from the organization configuration. Mutually exclusive with <code>IncludeAccountIds</code>.</p>"""
    created_at: NotRequired["capo_guardduty.types.timestamp.Timestamp"]
    """<p>The timestamp when the organization configuration was created.</p>"""
    updated_at: NotRequired["capo_guardduty.types.timestamp.Timestamp"]
    """<p>The timestamp when the organization configuration was last updated.</p>"""
    expires_at: NotRequired["capo_guardduty.types.timestamp.Timestamp"]
    """<p>The timestamp when the organization configuration expires.</p>"""

created_at instance-attribute

created_at: NotRequired[Timestamp]

The timestamp when the organization configuration was created.

exclude_account_ids instance-attribute

exclude_account_ids: NotRequired[DetectionRuleAccountIds]

A list of member account IDs excluded from the organization configuration. Mutually exclusive with IncludeAccountIds.

expires_at instance-attribute

expires_at: NotRequired[Timestamp]

The timestamp when the organization configuration expires.

include_account_ids instance-attribute

include_account_ids: NotRequired[DetectionRuleAccountIds]

A list of member account IDs included in the organization configuration. Mutually exclusive with ExcludeAccountIds.

mode instance-attribute

mode: NotRequired[AssociationMode]

The execution mode of the organization configuration. Valid values: LIVE | DRY_RUN.

rule_id instance-attribute

rule_id: NotRequired[RuleId]

The unique identifier for the custom detection rule.

status instance-attribute

status: NotRequired[DetectionRuleConfigurationStatus]

The configuration status. Valid values: ACTIVE | PROCESSING | FAILED.

status_reason instance-attribute

status_reason: NotRequired[String]

The reason for the current configuration status.

updated_at instance-attribute

updated_at: NotRequired[Timestamp]

The timestamp when the organization configuration was last updated.