ListRuleGroupsRequest

ListRuleGroupsRequest schema from Amazon Network Firewall

FirewallIntrusion DetectionNetwork SecurityVPC

Properties

Name Type Description
NextToken object
MaxResults object
Scope object
ManagedType object
Type object
View JSON Schema on GitHub

JSON Schema

openapi-list-rule-groups-request-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-network-firewall/refs/heads/main/json-schema/openapi-list-rule-groups-request-schema.json",
  "title": "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."
        }
      ]
    }
  }
}