aws_sdk_wafv2/client/get_rate_based_statement_managed_keys.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 [`GetRateBasedStatementManagedKeys`](crate::operation::get_rate_based_statement_managed_keys::builders::GetRateBasedStatementManagedKeysFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`scope(Scope)`](crate::operation::get_rate_based_statement_managed_keys::builders::GetRateBasedStatementManagedKeysFluentBuilder::scope) / [`set_scope(Option<Scope>)`](crate::operation::get_rate_based_statement_managed_keys::builders::GetRateBasedStatementManagedKeysFluentBuilder::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 /// - [`web_acl_name(impl Into<String>)`](crate::operation::get_rate_based_statement_managed_keys::builders::GetRateBasedStatementManagedKeysFluentBuilder::web_acl_name) / [`set_web_acl_name(Option<String>)`](crate::operation::get_rate_based_statement_managed_keys::builders::GetRateBasedStatementManagedKeysFluentBuilder::set_web_acl_name):<br>required: **true**<br><p>The name of the web ACL. You cannot change the name of a web ACL after you create it.</p><br>
8 /// - [`web_acl_id(impl Into<String>)`](crate::operation::get_rate_based_statement_managed_keys::builders::GetRateBasedStatementManagedKeysFluentBuilder::web_acl_id) / [`set_web_acl_id(Option<String>)`](crate::operation::get_rate_based_statement_managed_keys::builders::GetRateBasedStatementManagedKeysFluentBuilder::set_web_acl_id):<br>required: **true**<br><p>The unique identifier for the web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.</p><br>
9 /// - [`rule_group_rule_name(impl Into<String>)`](crate::operation::get_rate_based_statement_managed_keys::builders::GetRateBasedStatementManagedKeysFluentBuilder::rule_group_rule_name) / [`set_rule_group_rule_name(Option<String>)`](crate::operation::get_rate_based_statement_managed_keys::builders::GetRateBasedStatementManagedKeysFluentBuilder::set_rule_group_rule_name):<br>required: **false**<br><p>The name of the rule group reference statement in your web ACL. This is required only when you have the rate-based rule nested inside a rule group.</p><br>
10 /// - [`rule_name(impl Into<String>)`](crate::operation::get_rate_based_statement_managed_keys::builders::GetRateBasedStatementManagedKeysFluentBuilder::rule_name) / [`set_rule_name(Option<String>)`](crate::operation::get_rate_based_statement_managed_keys::builders::GetRateBasedStatementManagedKeysFluentBuilder::set_rule_name):<br>required: **true**<br><p>The name of the rate-based rule to get the keys for. If you have the rule defined inside a rule group that you're using in your web ACL, also provide the name of the rule group reference statement in the request parameter <code>RuleGroupRuleName</code>.</p><br>
11 /// - On success, responds with [`GetRateBasedStatementManagedKeysOutput`](crate::operation::get_rate_based_statement_managed_keys::GetRateBasedStatementManagedKeysOutput) with field(s):
12 /// - [`managed_keys_ipv4(Option<RateBasedStatementManagedKeysIpSet>)`](crate::operation::get_rate_based_statement_managed_keys::GetRateBasedStatementManagedKeysOutput::managed_keys_ipv4): <p>The keys that are of Internet Protocol version 4 (IPv4).</p>
13 /// - [`managed_keys_ipv6(Option<RateBasedStatementManagedKeysIpSet>)`](crate::operation::get_rate_based_statement_managed_keys::GetRateBasedStatementManagedKeysOutput::managed_keys_ipv6): <p>The keys that are of Internet Protocol version 6 (IPv6).</p>
14 /// - On failure, responds with [`SdkError<GetRateBasedStatementManagedKeysError>`](crate::operation::get_rate_based_statement_managed_keys::GetRateBasedStatementManagedKeysError)
15 pub fn get_rate_based_statement_managed_keys(
16 &self,
17 ) -> crate::operation::get_rate_based_statement_managed_keys::builders::GetRateBasedStatementManagedKeysFluentBuilder {
18 crate::operation::get_rate_based_statement_managed_keys::builders::GetRateBasedStatementManagedKeysFluentBuilder::new(self.handle.clone())
19 }
20}