aws_sdk_waf/client/
update_rate_based_rule.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`UpdateRateBasedRule`](crate::operation::update_rate_based_rule::builders::UpdateRateBasedRuleFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`rule_id(impl Into<String>)`](crate::operation::update_rate_based_rule::builders::UpdateRateBasedRuleFluentBuilder::rule_id) / [`set_rule_id(Option<String>)`](crate::operation::update_rate_based_rule::builders::UpdateRateBasedRuleFluentBuilder::set_rule_id):<br>required: **true**<br><p>The <code>RuleId</code> of the <code>RateBasedRule</code> that you want to update. <code>RuleId</code> is returned by <code>CreateRateBasedRule</code> and by <code>ListRateBasedRules</code>.</p><br>
    ///   - [`change_token(impl Into<String>)`](crate::operation::update_rate_based_rule::builders::UpdateRateBasedRuleFluentBuilder::change_token) / [`set_change_token(Option<String>)`](crate::operation::update_rate_based_rule::builders::UpdateRateBasedRuleFluentBuilder::set_change_token):<br>required: **true**<br><p>The value returned by the most recent call to <code>GetChangeToken</code>.</p><br>
    ///   - [`updates(RuleUpdate)`](crate::operation::update_rate_based_rule::builders::UpdateRateBasedRuleFluentBuilder::updates) / [`set_updates(Option<Vec::<RuleUpdate>>)`](crate::operation::update_rate_based_rule::builders::UpdateRateBasedRuleFluentBuilder::set_updates):<br>required: **true**<br><p>An array of <code>RuleUpdate</code> objects that you want to insert into or delete from a <code>RateBasedRule</code>.</p><br>
    ///   - [`rate_limit(i64)`](crate::operation::update_rate_based_rule::builders::UpdateRateBasedRuleFluentBuilder::rate_limit) / [`set_rate_limit(Option<i64>)`](crate::operation::update_rate_based_rule::builders::UpdateRateBasedRuleFluentBuilder::set_rate_limit):<br>required: **true**<br><p>The maximum number of requests, which have an identical value in the field specified by the <code>RateKey</code>, allowed in a five-minute period. If the number of requests exceeds the <code>RateLimit</code> and the other predicates specified in the rule are also met, AWS WAF triggers the action that is specified for this rule.</p><br>
    /// - On success, responds with [`UpdateRateBasedRuleOutput`](crate::operation::update_rate_based_rule::UpdateRateBasedRuleOutput) with field(s):
    ///   - [`change_token(Option<String>)`](crate::operation::update_rate_based_rule::UpdateRateBasedRuleOutput::change_token): <p>The <code>ChangeToken</code> that you used to submit the <code>UpdateRateBasedRule</code> request. You can also use this value to query the status of the request. For more information, see <code>GetChangeTokenStatus</code>.</p>
    /// - On failure, responds with [`SdkError<UpdateRateBasedRuleError>`](crate::operation::update_rate_based_rule::UpdateRateBasedRuleError)
    pub fn update_rate_based_rule(&self) -> crate::operation::update_rate_based_rule::builders::UpdateRateBasedRuleFluentBuilder {
        crate::operation::update_rate_based_rule::builders::UpdateRateBasedRuleFluentBuilder::new(self.handle.clone())
    }
}