Amazon Network Firewall · JSON Structure

Openapi Update Rule Group Response Structure

UpdateRuleGroupResponse schema from Amazon Network Firewall

Type: object Properties: 2 Required: 2
FirewallIntrusion DetectionNetwork SecurityVPC

UpdateRuleGroupResponse is a JSON Structure definition published by Amazon Network Firewall, describing 2 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

UpdateToken RuleGroupResponse

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-network-firewall/refs/heads/main/json-structure/openapi-update-rule-group-response-structure.json",
  "name": "UpdateRuleGroupResponse",
  "description": "UpdateRuleGroupResponse schema from Amazon Network Firewall",
  "type": "object",
  "properties": {
    "UpdateToken": {
      "allOf": [
        {
          "$ref": "#/components/schemas/UpdateToken"
        },
        {
          "description": "<p>A token used for optimistic locking. Network Firewall returns a token to your requests that access the rule group. The token marks the state of the rule group resource at the time of the request. </p> <p>To make changes to the rule group, you provide the token in your request. Network Firewall uses the token to ensure that the rule group hasn't changed since you last retrieved it. If it has changed, the operation fails with an <code>InvalidTokenException</code>. If this happens, retrieve the rule group again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token. </p>"
        }
      ]
    },
    "RuleGroupResponse": {
      "allOf": [
        {
          "$ref": "#/components/schemas/RuleGroupResponse"
        },
        {
          "description": "The high-level properties of a rule group. This, along with the <a>RuleGroup</a>, define the rule group. You can retrieve all objects for a rule group by calling <a>DescribeRuleGroup</a>. "
        }
      ]
    }
  },
  "required": [
    "UpdateToken",
    "RuleGroupResponse"
  ]
}