libZSservicesZSamazonka-wafZSamazonka-waf
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.WAF.DeleteRateBasedRule

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 RateBasedRule. You can't delete a rule if it's still used in any WebACL objects or if it still includes any predicates, such as ByteMatchSet objects.

If you just want to remove a rule from a WebACL, use UpdateWebACL.

To permanently delete a RateBasedRule from AWS WAF, perform the following steps:

  1. Update the RateBasedRule to remove predicates, if any. For more information, see UpdateRateBasedRule.
  2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteRateBasedRule request.
  3. Submit a DeleteRateBasedRule request.
Synopsis

Creating a Request

data DeleteRateBasedRule Source #

See: newDeleteRateBasedRule smart constructor.

Constructors

DeleteRateBasedRule' 

Fields

  • ruleId :: Text

    The RuleId of the RateBasedRule that you want to delete. RuleId is returned by CreateRateBasedRule and by ListRateBasedRules.

  • changeToken :: Text

    The value returned by the most recent call to GetChangeToken.

Instances

Instances details
Eq DeleteRateBasedRule Source # 
Instance details

Defined in Amazonka.WAF.DeleteRateBasedRule

Methods

(==) :: DeleteRateBasedRule -> DeleteRateBasedRule -> Bool #

(/=) :: DeleteRateBasedRule -> DeleteRateBasedRule -> Bool #

Read DeleteRateBasedRule Source # 
Instance details

Defined in Amazonka.WAF.DeleteRateBasedRule

Methods

readsPrec :: Int -> ReadS DeleteRateBasedRule #

readList :: ReadS [DeleteRateBasedRule] #

readPrec :: ReadPrec DeleteRateBasedRule #

readListPrec :: ReadPrec [DeleteRateBasedRule] #

Show DeleteRateBasedRule Source # 
Instance details

Defined in Amazonka.WAF.DeleteRateBasedRule

Methods

showsPrec :: Int -> DeleteRateBasedRule -> ShowS #

show :: DeleteRateBasedRule -> String #

showList :: [DeleteRateBasedRule] -> ShowS #

Generic DeleteRateBasedRule Source # 
Instance details

Defined in Amazonka.WAF.DeleteRateBasedRule

Associated Types

type Rep DeleteRateBasedRule :: Type -> Type #

Methods

from :: DeleteRateBasedRule -> Rep DeleteRateBasedRule x #

to :: Rep DeleteRateBasedRule x -> DeleteRateBasedRule #

NFData DeleteRateBasedRule Source # 
Instance details

Defined in Amazonka.WAF.DeleteRateBasedRule

Methods

rnf :: DeleteRateBasedRule -> () #

Hashable DeleteRateBasedRule Source # 
Instance details

Defined in Amazonka.WAF.DeleteRateBasedRule

Methods

hashWithSalt :: Int -> DeleteRateBasedRule -> Int #

hash :: DeleteRateBasedRule -> Int #

ToJSON DeleteRateBasedRule Source # 
Instance details

Defined in Amazonka.WAF.DeleteRateBasedRule

Methods

toJSON :: DeleteRateBasedRule -> Value #

toEncoding :: DeleteRateBasedRule -> Encoding #

toJSONList :: [DeleteRateBasedRule] -> Value #

toEncodingList :: [DeleteRateBasedRule] -> Encoding #

AWSRequest DeleteRateBasedRule Source # 
Instance details

Defined in Amazonka.WAF.DeleteRateBasedRule

Associated Types

type AWSResponse DeleteRateBasedRule #

Methods

request :: DeleteRateBasedRule -> Request DeleteRateBasedRule #

response :: MonadResource m => Logger -> Service -> Proxy DeleteRateBasedRule -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DeleteRateBasedRule))) #

ToHeaders DeleteRateBasedRule Source # 
Instance details

Defined in Amazonka.WAF.DeleteRateBasedRule

Methods

toHeaders :: DeleteRateBasedRule -> [Header] #

ToPath DeleteRateBasedRule Source # 
Instance details

Defined in Amazonka.WAF.DeleteRateBasedRule

Methods

toPath :: DeleteRateBasedRule -> ByteString #

ToQuery DeleteRateBasedRule Source # 
Instance details

Defined in Amazonka.WAF.DeleteRateBasedRule

Methods

toQuery :: DeleteRateBasedRule -> QueryString #

type Rep DeleteRateBasedRule Source # 
Instance details

Defined in Amazonka.WAF.DeleteRateBasedRule

type Rep DeleteRateBasedRule = D1 ('MetaData "DeleteRateBasedRule" "Amazonka.WAF.DeleteRateBasedRule" "libZSservicesZSamazonka-wafZSamazonka-waf" 'False) (C1 ('MetaCons "DeleteRateBasedRule'" 'PrefixI 'True) (S1 ('MetaSel ('Just "ruleId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "changeToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DeleteRateBasedRule Source # 
Instance details

Defined in Amazonka.WAF.DeleteRateBasedRule

type AWSResponse DeleteRateBasedRule = DeleteRateBasedRuleResponse

newDeleteRateBasedRule Source #

Arguments

:: Text

$sel:ruleId:DeleteRateBasedRule'

-> Text

$sel:changeToken:DeleteRateBasedRule'

-> DeleteRateBasedRule 

Create a value of DeleteRateBasedRule 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:ruleId:DeleteRateBasedRule', deleteRateBasedRule_ruleId - The RuleId of the RateBasedRule that you want to delete. RuleId is returned by CreateRateBasedRule and by ListRateBasedRules.

$sel:changeToken:DeleteRateBasedRule', deleteRateBasedRule_changeToken - The value returned by the most recent call to GetChangeToken.

Request Lenses

deleteRateBasedRule_ruleId :: Lens' DeleteRateBasedRule Text Source #

The RuleId of the RateBasedRule that you want to delete. RuleId is returned by CreateRateBasedRule and by ListRateBasedRules.

deleteRateBasedRule_changeToken :: Lens' DeleteRateBasedRule Text Source #

The value returned by the most recent call to GetChangeToken.

Destructuring the Response

data DeleteRateBasedRuleResponse Source #

See: newDeleteRateBasedRuleResponse smart constructor.

Constructors

DeleteRateBasedRuleResponse' 

Fields

  • changeToken :: Maybe Text

    The ChangeToken that you used to submit the DeleteRateBasedRule request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq DeleteRateBasedRuleResponse Source # 
Instance details

Defined in Amazonka.WAF.DeleteRateBasedRule

Methods

(==) :: DeleteRateBasedRuleResponse -> DeleteRateBasedRuleResponse -> Bool #

(/=) :: DeleteRateBasedRuleResponse -> DeleteRateBasedRuleResponse -> Bool #

Read DeleteRateBasedRuleResponse Source # 
Instance details

Defined in Amazonka.WAF.DeleteRateBasedRule

Methods

readsPrec :: Int -> ReadS DeleteRateBasedRuleResponse #

readList :: ReadS [DeleteRateBasedRuleResponse] #

readPrec :: ReadPrec DeleteRateBasedRuleResponse #

readListPrec :: ReadPrec [DeleteRateBasedRuleResponse] #

Show DeleteRateBasedRuleResponse Source # 
Instance details

Defined in Amazonka.WAF.DeleteRateBasedRule

Methods

showsPrec :: Int -> DeleteRateBasedRuleResponse -> ShowS #

show :: DeleteRateBasedRuleResponse -> String #

showList :: [DeleteRateBasedRuleResponse] -> ShowS #

Generic DeleteRateBasedRuleResponse Source # 
Instance details

Defined in Amazonka.WAF.DeleteRateBasedRule

Associated Types

type Rep DeleteRateBasedRuleResponse :: Type -> Type #

Methods

from :: DeleteRateBasedRuleResponse -> Rep DeleteRateBasedRuleResponse x #

to :: Rep DeleteRateBasedRuleResponse x -> DeleteRateBasedRuleResponse #

NFData DeleteRateBasedRuleResponse Source # 
Instance details

Defined in Amazonka.WAF.DeleteRateBasedRule

Methods

rnf :: DeleteRateBasedRuleResponse -> () #

type Rep DeleteRateBasedRuleResponse Source # 
Instance details

Defined in Amazonka.WAF.DeleteRateBasedRule

type Rep DeleteRateBasedRuleResponse = D1 ('MetaData "DeleteRateBasedRuleResponse" "Amazonka.WAF.DeleteRateBasedRule" "libZSservicesZSamazonka-wafZSamazonka-waf" 'False) (C1 ('MetaCons "DeleteRateBasedRuleResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "changeToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDeleteRateBasedRuleResponse Source #

Arguments

:: Int

$sel:httpStatus:DeleteRateBasedRuleResponse'

-> DeleteRateBasedRuleResponse 

Create a value of DeleteRateBasedRuleResponse 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:DeleteRateBasedRule', deleteRateBasedRuleResponse_changeToken - The ChangeToken that you used to submit the DeleteRateBasedRule request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

$sel:httpStatus:DeleteRateBasedRuleResponse', deleteRateBasedRuleResponse_httpStatus - The response's http status code.

Response Lenses

deleteRateBasedRuleResponse_changeToken :: Lens' DeleteRateBasedRuleResponse (Maybe Text) Source #

The ChangeToken that you used to submit the DeleteRateBasedRule request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

deleteRateBasedRuleResponse_httpStatus :: Lens' DeleteRateBasedRuleResponse Int Source #

The response's http status code.