aws_sdk_waf/client/
list_rule_groups.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`ListRuleGroups`](crate::operation::list_rule_groups::builders::ListRuleGroupsFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`next_marker(impl Into<String>)`](crate::operation::list_rule_groups::builders::ListRuleGroupsFluentBuilder::next_marker) / [`set_next_marker(Option<String>)`](crate::operation::list_rule_groups::builders::ListRuleGroupsFluentBuilder::set_next_marker):<br>required: **false**<br><p>If you specify a value for <code>Limit</code> and you have more <code>RuleGroups</code> than the value of <code>Limit</code>, AWS WAF returns a <code>NextMarker</code> value in the response that allows you to list another group of <code>RuleGroups</code>. For the second and subsequent <code>ListRuleGroups</code> requests, specify the value of <code>NextMarker</code> from the previous response to get information about another batch of <code>RuleGroups</code>.</p><br>
    ///   - [`limit(i32)`](crate::operation::list_rule_groups::builders::ListRuleGroupsFluentBuilder::limit) / [`set_limit(Option<i32>)`](crate::operation::list_rule_groups::builders::ListRuleGroupsFluentBuilder::set_limit):<br>required: **false**<br><p>Specifies the number of <code>RuleGroups</code> that you want AWS WAF to return for this request. If you have more <code>RuleGroups</code> than the number that you specify for <code>Limit</code>, the response includes a <code>NextMarker</code> value that you can use to get another batch of <code>RuleGroups</code>.</p><br>
    /// - On success, responds with [`ListRuleGroupsOutput`](crate::operation::list_rule_groups::ListRuleGroupsOutput) with field(s):
    ///   - [`next_marker(Option<String>)`](crate::operation::list_rule_groups::ListRuleGroupsOutput::next_marker): <p>If you have more <code>RuleGroups</code> than the number that you specified for <code>Limit</code> in the request, the response includes a <code>NextMarker</code> value. To list more <code>RuleGroups</code>, submit another <code>ListRuleGroups</code> request, and specify the <code>NextMarker</code> value from the response in the <code>NextMarker</code> value in the next request.</p>
    ///   - [`rule_groups(Option<Vec::<RuleGroupSummary>>)`](crate::operation::list_rule_groups::ListRuleGroupsOutput::rule_groups): <p>An array of <code>RuleGroup</code> objects.</p>
    /// - On failure, responds with [`SdkError<ListRuleGroupsError>`](crate::operation::list_rule_groups::ListRuleGroupsError)
    pub fn list_rule_groups(&self) -> crate::operation::list_rule_groups::builders::ListRuleGroupsFluentBuilder {
        crate::operation::list_rule_groups::builders::ListRuleGroupsFluentBuilder::new(self.handle.clone())
    }
}