DeleteRuleGroup
Deletes the specified RuleGroup.
Request Syntax
{
"RuleGroupArn": "string",
"RuleGroupName": "string",
"Type": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- RuleGroupArn
-
The Amazon Resource Name (ARN) of the rule group.
You must specify the ARN or the name, and you can specify both.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
^arn:aws.*Required: No
- RuleGroupName
-
The descriptive name of the rule group. You can't change the name of a rule group after you create it.
You must specify the ARN or the name, and you can specify both.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
^[a-zA-Z0-9-]+$Required: No
- Type
-
Indicates the type of the rule group. Valid values are:
-
STATELESS- Stateless rules, for use in a Classic Network Firewall policy. -
STATEFUL- Stateful rules, for use in a Classic Network Firewall policy. -
FIREWALL- Firewall engine rules, for use in a Next Generation policy. -
IPS- IPS engine rules, for use in a Next Generation policy.
NoteThis setting is required for requests that do not include the
RuleGroupARN.Type: String
Valid Values:
STATELESS | STATEFUL | STATEFUL_DOMAIN | FIREWALL | IPSRequired: No
-
Response Syntax
{
"RuleGroupResponse": {
"AnalysisResults": [
{
"AnalysisDetail": "string",
"IdentifiedRuleIds": [ "string" ],
"IdentifiedType": "string"
}
],
"Capacity": number,
"ConsumedCapacity": number,
"Description": "string",
"EncryptionConfiguration": {
"KeyId": "string",
"Type": "string"
},
"LastModifiedTime": number,
"NumberOfAssociations": number,
"RuleGroupArn": "string",
"RuleGroupId": "string",
"RuleGroupName": "string",
"RuleGroupStatus": "string",
"SnsTopic": "string",
"SourceMetadata": {
"SourceArn": "string",
"SourceUpdateToken": "string"
},
"SummaryConfiguration": {
"RuleOptions": [ "string" ]
},
"Tags": [
{
"Key": "string",
"Value": "string"
}
],
"Type": "string"
}
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- RuleGroupResponse
-
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 DescribeRuleGroup.
Type: RuleGroupResponse object
Errors
For information about the errors that are common to all actions, see Common Error Types.
- InternalServerError
-
Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.
HTTP Status Code: 500
- InvalidOperationException
-
The operation failed because it's not valid. For example, you might have tried to delete a rule group or firewall policy that's in use.
HTTP Status Code: 400
- InvalidRequestException
-
The operation failed because of a problem with your request. Examples include:
-
You specified an unsupported parameter name or value.
-
You tried to update a property with a value that isn't among the available types.
-
Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.
HTTP Status Code: 400
-
- ResourceNotFoundException
-
Unable to locate a resource using the parameters that you provided.
HTTP Status Code: 400
- ThrottlingException
-
Unable to process the request due to throttling limitations.
HTTP Status Code: 400
- UnsupportedOperationException
-
The operation you requested isn't supported by Network Firewall.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: