Amazon Network Firewall · JSON Structure

Openapi Describe Rule Group Response Structure

DescribeRuleGroupResponse schema from Amazon Network Firewall

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

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

Properties

UpdateToken RuleGroup 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-describe-rule-group-response-structure.json",
  "name": "DescribeRuleGroupResponse",
  "description": "DescribeRuleGroupResponse 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>"
        }
      ]
    },
    "RuleGroup": {
      "allOf": [
        {
          "$ref": "#/components/schemas/RuleGroup"
        },
        {
          "description": "<p>The object that defines the rules in a rule group. This, along with <a>RuleGroupResponse</a>, define the rule group. You can retrieve all objects for a rule group by calling <a>DescribeRuleGroup</a>. </p> <p>Network Firewall uses a rule group to inspect and control network traffic. You define stateless rule groups to inspect individual packets and you define stateful rule groups to inspect packets in the context of their traffic flow. </p> <p>To use a rule group, you include it by reference in an Network Firewall firewall policy, then you use the policy in a firewall. You can reference a rule group from more than one firewall policy, and you can use a firewall policy in more than one firewall. </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"
  ]
}