How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Amazon Network Firewall #X Amz Target=NetworkFirewall 20201112.UpdateRuleGroup API

The #X Amz Target=NetworkFirewall 20201112.UpdateRuleGroup API from Amazon Network Firewall — 1 operation(s) for #x amz target=networkfirewall 20201112.updaterulegroup.

Amazon Network Firewall #X Amz Target=NetworkFirewall 20201112.UpdateRuleGroup API is one of 36 APIs that Amazon Network Firewall publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include #X Amz Target=NetworkFirewall 20201112.UpdateRuleGroup. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, and pricing.

This API exposes 1 operation across 1 path, and defines 89 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against 4 base URLs: http://network-firewall.{region}.amazonaws.com, https://network-firewall.{region}.amazonaws.com, http://network-firewall.{region}.amazonaws.com.cn, https://network-firewall.{region}.amazonaws.com.cn.

1 operations 1 paths 89 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://network-firewall.amazonaws.com
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

Amazon Network Firewall #X Amz Target=NetworkFirewall 20201112.UpdateRuleGroup API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (hmac). By default, every request must be authenticated.

  • hmac — Amazon Signature authorization v4

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.

#X Amz Target=NetworkFirewall 20201112.UpdateRuleGroup 1
POST
/#X-Amz-Target=NetworkFirewall_20201112.UpdateRuleGroup
Amazon Network Firewall Update Rule Group
UpdateRuleGroup 8 params body → 200480481482483484

Schemas 89

The contract defines 89 schemas that model the data the API accepts and returns. The most detailed are RuleGroupResponse (14 properties), UpdateRuleGroupRequest (10 properties), Header (6 properties), MatchAttributes (6 properties). Each schema is shown below with its type and property counts.

Boolean
boolean
StatefulRuleProtocol
string
StatelessActions
array
PortRanges
array
CustomAction
object
An optional, non-standard action to use for stateless packet handling. You can define this in addition to the standard action that you must specify. You define…
2 properties 2 required
IPSet
object
A list of IP addresses and address ranges, in CIDR notation. This is part of a RuleVariables .
1 property 1 required
GeneratedRulesType
string
ProtocolNumbers
array
RuleOption
object
Additional settings for a stateful rule. This is part of the StatefulRule configuration.
2 properties 1 required
StatefulAction
string
Description
string
ResourceArn
string
RuleOrder
string
Dimensions
array
UpdateRuleGroupResponse
object
2 properties 2 required
SourceMetadata
object
High-level information about the managed rule group that your own rule group is copied from. You can use the the metadata to track version updates made to the…
2 properties
InternalServerError
PortRange
object
A single port range specification. This is used for source and destination port ranges in the stateless rule MatchAttributes , SourcePorts , and DestinationPor…
2 properties 2 required
TagList
array
CollectionMember_String
string
Header
object
The basic rule criteria for Network Firewall to use to inspect packet headers in stateful traffic flow inspection. Traffic flows that match the criteria are a…
6 properties 6 required
ResourceId
string
Source
string
ThrottlingException
UpdateRuleGroupRequest
object
10 properties 1 required
ResourceStatus
string
RuleGroupResponse
object
The high-level properties of a rule group. This, along with the RuleGroup , define the rule group. You can retrieve all objects for a rule group by calling Des…
14 properties 3 required
VariableDefinitionList
array
StatelessRule
object
A single stateless rule. This is used in StatelessRulesAndCustomActions .
2 properties 2 required
Tag
object
A key:value pair associated with an Amazon Web Services resource. The key:value pair can be anything you define. Typically, the tag key represents a category (…
2 properties 2 required
RulesString
string
RuleOptions
array
PortSet
object
A set of port ranges for use in the rules in a rule group.
1 property
Flags
array
Port
string
Settings
array
Address
object
A single IP address specification. This is used in the MatchAttributes source and destination specifications.
1 property 1 required
ReferenceSets
object
Contains a set of IP set references.
1 property
RuleGroup
object
The object that defines the rules in a rule group. This, along with RuleGroupResponse , define the rule group. You can retrieve all objects for a rule group by…
4 properties 1 required
TCPFlags
array
IPSetReference
object
Configures one or more IP set references for a Suricata-compatible rule group. This is used in CreateRuleGroup or UpdateRuleGroup . An IP set reference is a ru…
1 property
CustomActions
array
ActionName
string
StatefulRule
object
A single Suricata rules specification, for use in a stateful rule group. Use this option to specify a simple Suricata rule with protocol, source and destinatio…
3 properties 3 required
ResourceName
string
RuleDefinition
object
The inspection criteria and action for a single stateless rule. Network Firewall inspects each packet for the specified matching criteria. When a packet matche…
2 properties 2 required
VariableDefinition
string
RulesSourceList
object
Stateful inspection criteria for a domain list rule group. For HTTPS traffic, domain filtering is SNI-based. It uses the server name indicator extension of the…
3 properties 3 required
RuleTargets
array
TCPFlagField
object
TCP flags and masks to inspect packets for, used in stateless rules MatchAttributes settings.
2 properties 1 required
InvalidRequestException
EncryptionConfiguration
object
A complex type that contains optional Amazon Web Services Key Management Service (KMS) encryption settings for your Network Firewall resources. Your data is en…
2 properties 1 required
ProtocolNumber
integer
Addresses
array
ResourceNotFoundException
IPSets
object
StatefulRules
array
ActionDefinition
object
A custom action to use in stateless rule actions settings. This is used in CustomAction .
1 property
TCPFlag
string
TargetType
string
AddressDefinition
string
InvalidTokenException
RulesSource
object
The stateless or stateful rules definitions for use in a single rule group. Each rule group requires a single RulesSource . You can use an instance of this for…
4 properties
StatelessRules
array
DimensionValue
string
Dimension
object
The value to use in an Amazon CloudWatch custom metric dimension. This is used in the PublishMetrics CustomAction . A CloudWatch custom metric dimension is a n…
1 property 1 required
PublishMetricAction
object
Stateless inspection criteria that publishes the specified metrics to Amazon CloudWatch for the matching packet. This setting defines a CloudWatch dimension va…
1 property 1 required
MatchAttributes
object
Criteria for Network Firewall to use to inspect an individual packet in stateless rule inspection. Each match attributes set can include one or more items such…
6 properties
Keyword
string
PortSets
object
StatelessRulesAndCustomActions
object
Stateless inspection criteria. Each stateless rule group uses exactly one of these data types to define its stateless rules.
2 properties 1 required
Setting
string
RuleGroupType
string
RuleVariables
object
Settings that are available for use in the rules in the RuleGroup where this is defined.
2 properties
Destination
string
IPSetReferenceMap
object
KeyId
string
LastUpdateTime
string
Priority
integer
StatefulRuleDirection
string
UpdateToken
string
TargetTypes
array
NumberOfAssociations
integer
RuleCapacity
integer
EncryptionType
string
PortRangeBound
integer
TagValue
string
StatefulRuleOptions
object
Additional options governing how Network Firewall handles the rule group. You can only use these for stateful rule groups.
1 property
TagKey
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

amazon-network-firewall-x-amz-target-networkfirewall-20201112-updaterulegroup-api-openapi.yml Raw ↑

Other APIs Amazon Network Firewall publishes across the network.

Amazon Network Firewall #X Amz Target=NetworkFirewall 20201112.AssociateFirewallPolicy API
Amazon Network Firewall #X Amz Target=NetworkFirewall 20201112.AssociateSubnets API
Amazon Network Firewall #X Amz Target=NetworkFirewall 20201112.CreateFirewall API
Amazon Network Firewall #X Amz Target=NetworkFirewall 20201112.CreateFirewallPolicy API
Amazon Network Firewall #X Amz Target=NetworkFirewall 20201112.CreateRuleGroup API
Amazon Network Firewall #X Amz Target=NetworkFirewall 20201112.CreateTLSInspectionConfiguration API
Amazon Network Firewall #X Amz Target=NetworkFirewall 20201112.DeleteFirewall API
Amazon Network Firewall #X Amz Target=NetworkFirewall 20201112.DeleteFirewallPolicy API
Amazon Network Firewall #X Amz Target=NetworkFirewall 20201112.DeleteResourcePolicy API
Amazon Network Firewall #X Amz Target=NetworkFirewall 20201112.DeleteRuleGroup API
Amazon Network Firewall #X Amz Target=NetworkFirewall 20201112.DeleteTLSInspectionConfiguration API
Amazon Network Firewall #X Amz Target=NetworkFirewall 20201112.DescribeFirewall API
Where this information came from

This is an independent, third-party profile of Amazon Network Firewall #X Amz Target=NetworkFirewall 20201112.UpdateRuleGroup API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.