Amazon Network Firewall · JSON Structure

Openapi List Rule Groups Request Structure

ListRuleGroupsRequest schema from Amazon Network Firewall

Type: object Properties: 5
FirewallIntrusion DetectionNetwork SecurityVPC

ListRuleGroupsRequest is a JSON Structure definition published by Amazon Network Firewall, describing 5 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

NextToken MaxResults Scope ManagedType Type

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-list-rule-groups-request-structure.json",
  "name": "ListRuleGroupsRequest",
  "description": "ListRuleGroupsRequest schema from Amazon Network Firewall",
  "type": "object",
  "properties": {
    "NextToken": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PaginationToken"
        },
        {
          "description": "When you request a list of objects with a <code>MaxResults</code> setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a <code>NextToken</code> value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request."
        }
      ]
    },
    "MaxResults": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PaginationMaxResults"
        },
        {
          "description": "The maximum number of objects that you want Network Firewall to return for this request. If more objects are available, in the response, Network Firewall provides a <code>NextToken</code> value that you can use in a subsequent call to get the next batch of objects."
        }
      ]
    },
    "Scope": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ResourceManagedStatus"
        },
        {
          "description": "The scope of the request. The default setting of <code>ACCOUNT</code> or a setting of <code>NULL</code> returns all of the rule groups in your account. A setting of <code>MANAGED</code> returns all available managed rule groups."
        }
      ]
    },
    "ManagedType": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ResourceManagedType"
        },
        {
          "description": "Indicates the general category of the Amazon Web Services managed rule group."
        }
      ]
    },
    "Type": {
      "allOf": [
        {
          "$ref": "#/components/schemas/RuleGroupType"
        },
        {
          "description": "Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains stateless rules. If it is stateful, it contains stateful rules."
        }
      ]
    }
  }
}