Skip to content

GetRuleGroupResponse

Source code in docs_src/capo_wafv2/types/get_rule_group_response.py 
12
13
14
15
16
class GetRuleGroupResponse(TypedDict, closed=True):
    rule_group: NotRequired["capo_wafv2.types.rule_group.RuleGroup"]
    """<p></p>"""
    lock_token: NotRequired["capo_wafv2.types.lock_token.LockToken"]
    """<p>A token used for optimistic locking. WAF returns a token to your <code>get</code> and <code>list</code> requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like <code>update</code> and <code>delete</code>. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a <code>WAFOptimisticLockException</code>. If this happens, perform another <code>get</code>, and use the new token returned by that operation. </p>"""

lock_token instance-attribute 

lock_token: NotRequired[LockToken]

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

rule_group instance-attribute 

rule_group: NotRequired[RuleGroup]