RuleSummary ¶

class RuleSummary(TypedDict, closed=True):
    identifier: NotRequired["capo_rbin.types.rule_identifier.RuleIdentifier"]
    """<p>The unique ID of the retention rule.</p>"""
    description: NotRequired["capo_rbin.types.description.Description"]
    """<p>The retention rule description.</p>"""
    retention_period: NotRequired["capo_rbin.types.retention_period.RetentionPeriod"]
    """<p>Information about the retention period for which the retention rule is to retain resources.</p>"""
    lock_state: NotRequired["capo_rbin.types.lock_state.LockState"]
    """<p>[Region-level retention rules only] The lock state for the retention rule.</p> <ul> <li> <p> <code>locked</code> - The retention rule is locked and can't be modified or deleted.</p> </li> <li> <p> <code>pending_unlock</code> - The retention rule has been unlocked but it is still within the unlock delay period. The retention rule can be modified or deleted only after the unlock delay period has expired.</p> </li> <li> <p> <code>unlocked</code> - The retention rule is unlocked and it can be modified or deleted by any user with the required permissions.</p> </li> <li> <p> <code>null</code> - The retention rule has never been locked. Once a retention rule has been locked, it can transition between the <code>locked</code> and <code>unlocked</code> states only; it can never transition back to <code>null</code>.</p> </li> </ul>"""
    rule_arn: NotRequired["capo_rbin.types.rule_arn.RuleArn"]
    """<p>The Amazon Resource Name (ARN) of the retention rule.</p>"""