| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.WAF.DeleteRuleGroup
Description
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Permanently deletes a RuleGroup. You can't delete a RuleGroup if
it's still used in any WebACL objects or if it still includes any
rules.
If you just want to remove a RuleGroup from a WebACL, use
UpdateWebACL.
To permanently delete a RuleGroup from AWS WAF, perform the following
steps:
- Update the
RuleGroupto remove rules, if any. For more information, see UpdateRuleGroup. - Use GetChangeToken to get the change token that you provide in the
ChangeTokenparameter of aDeleteRuleGrouprequest. - Submit a
DeleteRuleGrouprequest.
Synopsis
- data DeleteRuleGroup = DeleteRuleGroup' {
- ruleGroupId :: Text
- changeToken :: Text
- newDeleteRuleGroup :: Text -> Text -> DeleteRuleGroup
- deleteRuleGroup_ruleGroupId :: Lens' DeleteRuleGroup Text
- deleteRuleGroup_changeToken :: Lens' DeleteRuleGroup Text
- data DeleteRuleGroupResponse = DeleteRuleGroupResponse' {
- changeToken :: Maybe Text
- httpStatus :: Int
- newDeleteRuleGroupResponse :: Int -> DeleteRuleGroupResponse
- deleteRuleGroupResponse_changeToken :: Lens' DeleteRuleGroupResponse (Maybe Text)
- deleteRuleGroupResponse_httpStatus :: Lens' DeleteRuleGroupResponse Int
Creating a Request
data DeleteRuleGroup Source #
See: newDeleteRuleGroup smart constructor.
Constructors
| DeleteRuleGroup' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> DeleteRuleGroup |
Create a value of DeleteRuleGroup with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:ruleGroupId:DeleteRuleGroup', deleteRuleGroup_ruleGroupId - The RuleGroupId of the RuleGroup that you want to delete.
RuleGroupId is returned by CreateRuleGroup and by ListRuleGroups.
$sel:changeToken:DeleteRuleGroup', deleteRuleGroup_changeToken - The value returned by the most recent call to GetChangeToken.
Request Lenses
deleteRuleGroup_ruleGroupId :: Lens' DeleteRuleGroup Text Source #
The RuleGroupId of the RuleGroup that you want to delete.
RuleGroupId is returned by CreateRuleGroup and by ListRuleGroups.
deleteRuleGroup_changeToken :: Lens' DeleteRuleGroup Text Source #
The value returned by the most recent call to GetChangeToken.
Destructuring the Response
data DeleteRuleGroupResponse Source #
See: newDeleteRuleGroupResponse smart constructor.
Constructors
| DeleteRuleGroupResponse' | |
Fields
| |
Instances
newDeleteRuleGroupResponse Source #
Create a value of DeleteRuleGroupResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:changeToken:DeleteRuleGroup', deleteRuleGroupResponse_changeToken - The ChangeToken that you used to submit the DeleteRuleGroup request.
You can also use this value to query the status of the request. For more
information, see GetChangeTokenStatus.
$sel:httpStatus:DeleteRuleGroupResponse', deleteRuleGroupResponse_httpStatus - The response's http status code.
Response Lenses
deleteRuleGroupResponse_changeToken :: Lens' DeleteRuleGroupResponse (Maybe Text) Source #
The ChangeToken that you used to submit the DeleteRuleGroup request.
You can also use this value to query the status of the request. For more
information, see GetChangeTokenStatus.
deleteRuleGroupResponse_httpStatus :: Lens' DeleteRuleGroupResponse Int Source #
The response's http status code.