aws_sdk_wafv2/client/list_available_managed_rule_groups.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3 /// Constructs a fluent builder for the [`ListAvailableManagedRuleGroups`](crate::operation::list_available_managed_rule_groups::builders::ListAvailableManagedRuleGroupsFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`scope(Scope)`](crate::operation::list_available_managed_rule_groups::builders::ListAvailableManagedRuleGroupsFluentBuilder::scope) / [`set_scope(Option<Scope>)`](crate::operation::list_available_managed_rule_groups::builders::ListAvailableManagedRuleGroupsFluentBuilder::set_scope):<br>required: **true**<br><p>Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. For an Amplify application, use <code>CLOUDFRONT</code>.</p> <p>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:</p> <ul> <li> <p>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>.</p></li> <li> <p>API and SDKs - For all calls, use the Region endpoint us-east-1.</p></li> </ul><br>
7 /// - [`next_marker(impl Into<String>)`](crate::operation::list_available_managed_rule_groups::builders::ListAvailableManagedRuleGroupsFluentBuilder::next_marker) / [`set_next_marker(Option<String>)`](crate::operation::list_available_managed_rule_groups::builders::ListAvailableManagedRuleGroupsFluentBuilder::set_next_marker):<br>required: **false**<br><p>When you request a list of objects with a <code>Limit</code> setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a <code>NextMarker</code> value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.</p><br>
8 /// - [`limit(i32)`](crate::operation::list_available_managed_rule_groups::builders::ListAvailableManagedRuleGroupsFluentBuilder::limit) / [`set_limit(Option<i32>)`](crate::operation::list_available_managed_rule_groups::builders::ListAvailableManagedRuleGroupsFluentBuilder::set_limit):<br>required: **false**<br><p>The maximum number of objects that you want WAF to return for this request. If more objects are available, in the response, WAF provides a <code>NextMarker</code> value that you can use in a subsequent call to get the next batch of objects.</p><br>
9 /// - On success, responds with [`ListAvailableManagedRuleGroupsOutput`](crate::operation::list_available_managed_rule_groups::ListAvailableManagedRuleGroupsOutput) with field(s):
10 /// - [`next_marker(Option<String>)`](crate::operation::list_available_managed_rule_groups::ListAvailableManagedRuleGroupsOutput::next_marker): <p>When you request a list of objects with a <code>Limit</code> setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a <code>NextMarker</code> value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.</p>
11 /// - [`managed_rule_groups(Option<Vec::<ManagedRuleGroupSummary>>)`](crate::operation::list_available_managed_rule_groups::ListAvailableManagedRuleGroupsOutput::managed_rule_groups): <p>Array of managed rule groups that you can use. If you specified a <code>Limit</code> in your request, this might not be the full list.</p>
12 /// - On failure, responds with [`SdkError<ListAvailableManagedRuleGroupsError>`](crate::operation::list_available_managed_rule_groups::ListAvailableManagedRuleGroupsError)
13 pub fn list_available_managed_rule_groups(
14 &self,
15 ) -> crate::operation::list_available_managed_rule_groups::builders::ListAvailableManagedRuleGroupsFluentBuilder {
16 crate::operation::list_available_managed_rule_groups::builders::ListAvailableManagedRuleGroupsFluentBuilder::new(self.handle.clone())
17 }
18}