Amazon Network Firewall · JSON Structure

Openapi Describe Firewall Policy Response Structure

DescribeFirewallPolicyResponse schema from Amazon Network Firewall

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

DescribeFirewallPolicyResponse 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 FirewallPolicyResponse FirewallPolicy

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-firewall-policy-response-structure.json",
  "name": "DescribeFirewallPolicyResponse",
  "description": "DescribeFirewallPolicyResponse 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 firewall policy. The token marks the state of the policy resource at the time of the request. </p> <p>To make changes to the policy, you provide the token in your request. Network Firewall uses the token to ensure that the policy 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 firewall policy again to get a current copy of it with current token. Reapply your changes as needed, then try the operation again using the new token. </p>"
        }
      ]
    },
    "FirewallPolicyResponse": {
      "allOf": [
        {
          "$ref": "#/components/schemas/FirewallPolicyResponse"
        },
        {
          "description": "The high-level properties of a firewall policy. This, along with the <a>FirewallPolicy</a>, define the policy. You can retrieve all objects for a firewall policy by calling <a>DescribeFirewallPolicy</a>. "
        }
      ]
    },
    "FirewallPolicy": {
      "allOf": [
        {
          "$ref": "#/components/schemas/FirewallPolicy"
        },
        {
          "description": "The policy for the specified firewall policy. "
        }
      ]
    }
  },
  "required": [
    "UpdateToken",
    "FirewallPolicyResponse"
  ]
}