Struct aws_sdk_wafv2::Client
source · pub struct Client { /* private fields */ }Expand description
Client for AWS WAFV2
Client for invoking operations on AWS WAFV2. Each operation on AWS WAFV2 is a method on this
this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.
Constructing a Client
A Config is required to construct a client. For most use cases, the aws-config
crate should be used to automatically resolve this config using
aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared
across multiple different AWS SDK clients. This config resolution process can be customized
by calling aws_config::from_env() instead, which returns a ConfigLoader that uses
the builder pattern to customize the default config.
In the simplest case, creating a client looks as follows:
let config = aws_config::load_from_env().await;
let client = aws_sdk_wafv2::Client::new(&config);Occasionally, SDKs may have additional service-specific that can be set on the Config that
is absent from SdkConfig, or slightly different settings for a specific client may be desired.
The Config struct implements From<&SdkConfig>, so setting these specific settings can be
done as follows:
let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_wafv2::config::Builder::from(&sdk_config)
.some_service_specific_setting("value")
.build();See the aws-config docs and Config for more information on customizing configuration.
Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.
Using the Client
A client has a function for every operation that can be performed by the service.
For example, the AssociateWebACL operation has
a Client::associate_web_acl, function which returns a builder for that operation.
The fluent builder ultimately has a send() function that returns an async future that
returns a result, as illustrated below:
let result = client.associate_web_acl()
.web_acl_arn("example")
.send()
.await;The underlying HTTP requests that get made by this can be modified with the customize_operation
function on the fluent builder. See the customize module for more
information.
Implementations§
source§impl Client
impl Client
sourcepub fn associate_web_acl(&self) -> AssociateWebACLFluentBuilder
pub fn associate_web_acl(&self) -> AssociateWebACLFluentBuilder
Constructs a fluent builder for the AssociateWebACL operation.
- The fluent builder is configurable:
web_acl_arn(impl Into<String>)/set_web_acl_arn(Option<String>):
required: trueThe Amazon Resource Name (ARN) of the web ACL that you want to associate with the resource.
resource_arn(impl Into<String>)/set_resource_arn(Option<String>):
required: trueThe Amazon Resource Name (ARN) of the resource to associate with the web ACL.
The ARN must be in one of the following formats:
-
For an Application Load Balancer:
arn:partition:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id -
For an Amazon API Gateway REST API:
arn:partition:apigateway:region::/restapis/api-id/stages/stage-name -
For an AppSync GraphQL API:
arn:partition:appsync:region:account-id:apis/GraphQLApiId -
For an Amazon Cognito user pool:
arn:partition:cognito-idp:region:account-id:userpool/user-pool-id -
For an App Runner service:
arn:partition:apprunner:region:account-id:service/apprunner-service-name/apprunner-service-id -
For an Amazon Web Services Verified Access instance:
arn:partition:ec2:region:account-id:verified-access-instance/instance-id
-
- On success, responds with
AssociateWebAclOutput - On failure, responds with
SdkError<AssociateWebACLError>
source§impl Client
impl Client
sourcepub fn check_capacity(&self) -> CheckCapacityFluentBuilder
pub fn check_capacity(&self) -> CheckCapacityFluentBuilder
Constructs a fluent builder for the CheckCapacity operation.
- The fluent builder is configurable:
scope(Scope)/set_scope(Option<Scope>):
required: trueSpecifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
-
CLI - Specify the Region when you use the CloudFront scope:
–scope=CLOUDFRONT –region=us-east-1. -
API and SDKs - For all calls, use the Region endpoint us-east-1.
-
rules(Rule)/set_rules(Option<Vec::<Rule>>):
required: trueAn array of
Rulethat you’re configuring to use in a rule group or web ACL.
- On success, responds with
CheckCapacityOutputwith field(s):capacity(i64):The capacity required by the rules and scope.
- On failure, responds with
SdkError<CheckCapacityError>
source§impl Client
impl Client
sourcepub fn create_api_key(&self) -> CreateAPIKeyFluentBuilder
pub fn create_api_key(&self) -> CreateAPIKeyFluentBuilder
Constructs a fluent builder for the CreateAPIKey operation.
- The fluent builder is configurable:
scope(Scope)/set_scope(Option<Scope>):
required: trueSpecifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
-
CLI - Specify the Region when you use the CloudFront scope:
–scope=CLOUDFRONT –region=us-east-1. -
API and SDKs - For all calls, use the Region endpoint us-east-1.
-
token_domains(impl Into<String>)/set_token_domains(Option<Vec::<String>>):
required: trueThe client application domains that you want to use this API key for.
Example JSON:
“TokenDomains”: [“abc.com”, “store.abc.com”]Public suffixes aren’t allowed. For example, you can’t use
usa.govorco.ukas token domains.
- On success, responds with
CreateApiKeyOutputwith field(s):api_key(Option<String>):The generated, encrypted API key. You can copy this for use in your JavaScript CAPTCHA integration.
- On failure, responds with
SdkError<CreateAPIKeyError>
source§impl Client
impl Client
sourcepub fn create_ip_set(&self) -> CreateIPSetFluentBuilder
pub fn create_ip_set(&self) -> CreateIPSetFluentBuilder
Constructs a fluent builder for the CreateIPSet operation.
- The fluent builder is configurable:
name(impl Into<String>)/set_name(Option<String>):
required: trueThe name of the IP set. You cannot change the name of an
IPSetafter you create it.scope(Scope)/set_scope(Option<Scope>):
required: trueSpecifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
-
CLI - Specify the Region when you use the CloudFront scope:
–scope=CLOUDFRONT –region=us-east-1. -
API and SDKs - For all calls, use the Region endpoint us-east-1.
-
description(impl Into<String>)/set_description(Option<String>):
required: falseA description of the IP set that helps with identification.
ip_address_version(IpAddressVersion)/set_ip_address_version(Option<IpAddressVersion>):
required: trueThe version of the IP addresses, either
IPV4orIPV6.addresses(impl Into<String>)/set_addresses(Option<Vec::<String>>):
required: trueContains an array of strings that specifies zero or more IP addresses or blocks of IP addresses that you want WAF to inspect for in incoming requests. All addresses must be specified using Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for
/0.Example address strings:
-
For requests that originated from the IP address 192.0.2.44, specify
192.0.2.44/32. -
For requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify
192.0.2.0/24. -
For requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify
1111:0000:0000:0000:0000:0000:0000:0111/128. -
For requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify
1111:0000:0000:0000:0000:0000:0000:0000/64.
For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
Example JSON
Addressesspecifications:-
Empty array:
“Addresses”: [] -
Array with one address:
“Addresses”: [“192.0.2.44/32”] -
Array with three addresses:
“Addresses”: [“192.0.2.44/32”, “192.0.2.0/24”, “192.0.0.0/16”] -
INVALID specification:
“Addresses”: [“”]INVALID
-
tags(Tag)/set_tags(Option<Vec::<Tag>>):
required: falseAn array of key:value pairs to associate with the resource.
- On success, responds with
CreateIpSetOutputwith field(s):summary(Option<IpSetSummary>):High-level information about an
IPSet, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage anIPSet, and the ARN, that you provide to theIPSetReferenceStatementto use the address set in aRule.
- On failure, responds with
SdkError<CreateIPSetError>
source§impl Client
impl Client
sourcepub fn create_regex_pattern_set(&self) -> CreateRegexPatternSetFluentBuilder
pub fn create_regex_pattern_set(&self) -> CreateRegexPatternSetFluentBuilder
Constructs a fluent builder for the CreateRegexPatternSet operation.
- The fluent builder is configurable:
name(impl Into<String>)/set_name(Option<String>):
required: trueThe name of the set. You cannot change the name after you create the set.
scope(Scope)/set_scope(Option<Scope>):
required: trueSpecifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
-
CLI - Specify the Region when you use the CloudFront scope:
–scope=CLOUDFRONT –region=us-east-1. -
API and SDKs - For all calls, use the Region endpoint us-east-1.
-
description(impl Into<String>)/set_description(Option<String>):
required: falseA description of the set that helps with identification.
regular_expression_list(Regex)/set_regular_expression_list(Option<Vec::<Regex>>):
required: trueArray of regular expression strings.
tags(Tag)/set_tags(Option<Vec::<Tag>>):
required: falseAn array of key:value pairs to associate with the resource.
- On success, responds with
CreateRegexPatternSetOutputwith field(s):summary(Option<RegexPatternSetSummary>):High-level information about a
RegexPatternSet, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage aRegexPatternSet, and the ARN, that you provide to theRegexPatternSetReferenceStatementto use the pattern set in aRule.
- On failure, responds with
SdkError<CreateRegexPatternSetError>
source§impl Client
impl Client
sourcepub fn create_rule_group(&self) -> CreateRuleGroupFluentBuilder
pub fn create_rule_group(&self) -> CreateRuleGroupFluentBuilder
Constructs a fluent builder for the CreateRuleGroup operation.
- The fluent builder is configurable:
name(impl Into<String>)/set_name(Option<String>):
required: trueThe name of the rule group. You cannot change the name of a rule group after you create it.
scope(Scope)/set_scope(Option<Scope>):
required: trueSpecifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
-
CLI - Specify the Region when you use the CloudFront scope:
–scope=CLOUDFRONT –region=us-east-1. -
API and SDKs - For all calls, use the Region endpoint us-east-1.
-
capacity(i64)/set_capacity(Option<i64>):
required: trueThe web ACL capacity units (WCUs) required for this rule group.
When you create your own rule group, you define this, and you cannot change it after creation. When you add or modify the rules in a rule group, WAF enforces this limit. You can check the capacity for a set of rules using
CheckCapacity.WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. For more information, see WAF web ACL capacity units (WCU) in the WAF Developer Guide.
description(impl Into<String>)/set_description(Option<String>):
required: falseA description of the rule group that helps with identification.
rules(Rule)/set_rules(Option<Vec::<Rule>>):
required: falseThe
Rulestatements used to identify the web requests that you want to manage. Each rule includes one top-level statement that WAF uses to identify matching web requests, and parameters that govern how WAF handles them.visibility_config(VisibilityConfig)/set_visibility_config(Option<VisibilityConfig>):
required: trueDefines and enables Amazon CloudWatch metrics and web request sample collection.
tags(Tag)/set_tags(Option<Vec::<Tag>>):
required: falseAn array of key:value pairs to associate with the resource.
custom_response_bodies(impl Into<String>, CustomResponseBody)/set_custom_response_bodies(Option<HashMap::<String, CustomResponseBody>>):
required: falseA map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the rule group, and then use them in the rules that you define in the rule group.
For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.
For information about the limits on count and size for custom request and response settings, see WAF quotas in the WAF Developer Guide.
- On success, responds with
CreateRuleGroupOutputwith field(s):summary(Option<RuleGroupSummary>):High-level information about a
RuleGroup, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage aRuleGroup, and the ARN, that you provide to theRuleGroupReferenceStatementto use the rule group in aRule.
- On failure, responds with
SdkError<CreateRuleGroupError>
source§impl Client
impl Client
sourcepub fn create_web_acl(&self) -> CreateWebACLFluentBuilder
pub fn create_web_acl(&self) -> CreateWebACLFluentBuilder
Constructs a fluent builder for the CreateWebACL operation.
- The fluent builder is configurable:
name(impl Into<String>)/set_name(Option<String>):
required: trueThe name of the web ACL. You cannot change the name of a web ACL after you create it.
scope(Scope)/set_scope(Option<Scope>):
required: trueSpecifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
-
CLI - Specify the Region when you use the CloudFront scope:
–scope=CLOUDFRONT –region=us-east-1. -
API and SDKs - For all calls, use the Region endpoint us-east-1.
-
default_action(DefaultAction)/set_default_action(Option<DefaultAction>):
required: trueThe action to perform if none of the
Rulescontained in theWebACLmatch.description(impl Into<String>)/set_description(Option<String>):
required: falseA description of the web ACL that helps with identification.
rules(Rule)/set_rules(Option<Vec::<Rule>>):
required: falseThe
Rulestatements used to identify the web requests that you want to manage. Each rule includes one top-level statement that WAF uses to identify matching web requests, and parameters that govern how WAF handles them.visibility_config(VisibilityConfig)/set_visibility_config(Option<VisibilityConfig>):
required: trueDefines and enables Amazon CloudWatch metrics and web request sample collection.
tags(Tag)/set_tags(Option<Vec::<Tag>>):
required: falseAn array of key:value pairs to associate with the resource.
custom_response_bodies(impl Into<String>, CustomResponseBody)/set_custom_response_bodies(Option<HashMap::<String, CustomResponseBody>>):
required: falseA map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the web ACL, and then use them in the rules and default actions that you define in the web ACL.
For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.
For information about the limits on count and size for custom request and response settings, see WAF quotas in the WAF Developer Guide.
captcha_config(CaptchaConfig)/set_captcha_config(Option<CaptchaConfig>):
required: falseSpecifies how WAF should handle
CAPTCHAevaluations for rules that don’t have their ownCaptchaConfigsettings. If you don’t specify this, WAF uses its default settings forCaptchaConfig.challenge_config(ChallengeConfig)/set_challenge_config(Option<ChallengeConfig>):
required: falseSpecifies how WAF should handle challenge evaluations for rules that don’t have their own
ChallengeConfigsettings. If you don’t specify this, WAF uses its default settings forChallengeConfig.token_domains(impl Into<String>)/set_token_domains(Option<Vec::<String>>):
required: falseSpecifies the domains that WAF should accept in a web request token. This enables the use of tokens across multiple protected websites. When WAF provides a token, it uses the domain of the Amazon Web Services resource that the web ACL is protecting. If you don’t specify a list of token domains, WAF accepts tokens only for the domain of the protected resource. With a token domain list, WAF accepts the resource’s host domain plus all domains in the token domain list, including their prefixed subdomains.
Example JSON:
“TokenDomains”: { “mywebsite.com”, “myotherwebsite.com” }Public suffixes aren’t allowed. For example, you can’t use
usa.govorco.ukas token domains.association_config(AssociationConfig)/set_association_config(Option<AssociationConfig>):
required: falseSpecifies custom configurations for the associations between the web ACL and protected resources.
Use this to customize the maximum size of the request body that your protected CloudFront distributions forward to WAF for inspection. The default is 16 KB (16,384 bytes).
You are charged additional fees when your protected resources forward body sizes that are larger than the default. For more information, see WAF Pricing.
- On success, responds with
CreateWebAclOutputwith field(s):summary(Option<WebAclSummary>):High-level information about a
WebACL, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage aWebACL, and the ARN, that you provide to operations likeAssociateWebACL.
- On failure, responds with
SdkError<CreateWebACLError>
source§impl Client
impl Client
sourcepub fn delete_firewall_manager_rule_groups(
&self
) -> DeleteFirewallManagerRuleGroupsFluentBuilder
pub fn delete_firewall_manager_rule_groups( &self ) -> DeleteFirewallManagerRuleGroupsFluentBuilder
Constructs a fluent builder for the DeleteFirewallManagerRuleGroups operation.
- The fluent builder is configurable:
web_acl_arn(impl Into<String>)/set_web_acl_arn(Option<String>):
required: trueThe Amazon Resource Name (ARN) of the web ACL.
web_acl_lock_token(impl Into<String>)/set_web_acl_lock_token(Option<String>):
required: trueA token used for optimistic locking. WAF returns a token to your
getandlistrequests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations likeupdateanddelete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with aWAFOptimisticLockException. If this happens, perform anotherget, and use the new token returned by that operation.
- On success, responds with
DeleteFirewallManagerRuleGroupsOutputwith field(s):next_web_acl_lock_token(Option<String>):A token used for optimistic locking. WAF returns a token to your
getandlistrequests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations likeupdateanddelete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with aWAFOptimisticLockException. If this happens, perform anotherget, and use the new token returned by that operation.
- On failure, responds with
SdkError<DeleteFirewallManagerRuleGroupsError>
source§impl Client
impl Client
sourcepub fn delete_ip_set(&self) -> DeleteIPSetFluentBuilder
pub fn delete_ip_set(&self) -> DeleteIPSetFluentBuilder
Constructs a fluent builder for the DeleteIPSet operation.
- The fluent builder is configurable:
name(impl Into<String>)/set_name(Option<String>):
required: trueThe name of the IP set. You cannot change the name of an
IPSetafter you create it.scope(Scope)/set_scope(Option<Scope>):
required: trueSpecifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
-
CLI - Specify the Region when you use the CloudFront scope:
–scope=CLOUDFRONT –region=us-east-1. -
API and SDKs - For all calls, use the Region endpoint us-east-1.
-
id(impl Into<String>)/set_id(Option<String>):
required: trueA unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
lock_token(impl Into<String>)/set_lock_token(Option<String>):
required: trueA token used for optimistic locking. WAF returns a token to your
getandlistrequests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations likeupdateanddelete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with aWAFOptimisticLockException. If this happens, perform anotherget, and use the new token returned by that operation.
- On success, responds with
DeleteIpSetOutput - On failure, responds with
SdkError<DeleteIPSetError>
source§impl Client
impl Client
sourcepub fn delete_logging_configuration(
&self
) -> DeleteLoggingConfigurationFluentBuilder
pub fn delete_logging_configuration( &self ) -> DeleteLoggingConfigurationFluentBuilder
Constructs a fluent builder for the DeleteLoggingConfiguration operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)/set_resource_arn(Option<String>):
required: trueThe Amazon Resource Name (ARN) of the web ACL from which you want to delete the
LoggingConfiguration.
- On success, responds with
DeleteLoggingConfigurationOutput - On failure, responds with
SdkError<DeleteLoggingConfigurationError>
source§impl Client
impl Client
sourcepub fn delete_permission_policy(&self) -> DeletePermissionPolicyFluentBuilder
pub fn delete_permission_policy(&self) -> DeletePermissionPolicyFluentBuilder
Constructs a fluent builder for the DeletePermissionPolicy operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)/set_resource_arn(Option<String>):
required: trueThe Amazon Resource Name (ARN) of the rule group from which you want to delete the policy.
You must be the owner of the rule group to perform this operation.
- On success, responds with
DeletePermissionPolicyOutput - On failure, responds with
SdkError<DeletePermissionPolicyError>
source§impl Client
impl Client
sourcepub fn delete_regex_pattern_set(&self) -> DeleteRegexPatternSetFluentBuilder
pub fn delete_regex_pattern_set(&self) -> DeleteRegexPatternSetFluentBuilder
Constructs a fluent builder for the DeleteRegexPatternSet operation.
- The fluent builder is configurable:
name(impl Into<String>)/set_name(Option<String>):
required: trueThe name of the set. You cannot change the name after you create the set.
scope(Scope)/set_scope(Option<Scope>):
required: trueSpecifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
-
CLI - Specify the Region when you use the CloudFront scope:
–scope=CLOUDFRONT –region=us-east-1. -
API and SDKs - For all calls, use the Region endpoint us-east-1.
-
id(impl Into<String>)/set_id(Option<String>):
required: trueA unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
lock_token(impl Into<String>)/set_lock_token(Option<String>):
required: trueA token used for optimistic locking. WAF returns a token to your
getandlistrequests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations likeupdateanddelete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with aWAFOptimisticLockException. If this happens, perform anotherget, and use the new token returned by that operation.
- On success, responds with
DeleteRegexPatternSetOutput - On failure, responds with
SdkError<DeleteRegexPatternSetError>
source§impl Client
impl Client
sourcepub fn delete_rule_group(&self) -> DeleteRuleGroupFluentBuilder
pub fn delete_rule_group(&self) -> DeleteRuleGroupFluentBuilder
Constructs a fluent builder for the DeleteRuleGroup operation.
- The fluent builder is configurable:
name(impl Into<String>)/set_name(Option<String>):
required: trueThe name of the rule group. You cannot change the name of a rule group after you create it.
scope(Scope)/set_scope(Option<Scope>):
required: trueSpecifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
-
CLI - Specify the Region when you use the CloudFront scope:
–scope=CLOUDFRONT –region=us-east-1. -
API and SDKs - For all calls, use the Region endpoint us-east-1.
-
id(impl Into<String>)/set_id(Option<String>):
required: trueA unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
lock_token(impl Into<String>)/set_lock_token(Option<String>):
required: trueA token used for optimistic locking. WAF returns a token to your
getandlistrequests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations likeupdateanddelete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with aWAFOptimisticLockException. If this happens, perform anotherget, and use the new token returned by that operation.
- On success, responds with
DeleteRuleGroupOutput - On failure, responds with
SdkError<DeleteRuleGroupError>
source§impl Client
impl Client
sourcepub fn delete_web_acl(&self) -> DeleteWebACLFluentBuilder
pub fn delete_web_acl(&self) -> DeleteWebACLFluentBuilder
Constructs a fluent builder for the DeleteWebACL operation.
- The fluent builder is configurable:
name(impl Into<String>)/set_name(Option<String>):
required: trueThe name of the web ACL. You cannot change the name of a web ACL after you create it.
scope(Scope)/set_scope(Option<Scope>):
required: trueSpecifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
-
CLI - Specify the Region when you use the CloudFront scope:
–scope=CLOUDFRONT –region=us-east-1. -
API and SDKs - For all calls, use the Region endpoint us-east-1.
-
id(impl Into<String>)/set_id(Option<String>):
required: trueThe 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.
lock_token(impl Into<String>)/set_lock_token(Option<String>):
required: trueA token used for optimistic locking. WAF returns a token to your
getandlistrequests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations likeupdateanddelete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with aWAFOptimisticLockException. If this happens, perform anotherget, and use the new token returned by that operation.
- On success, responds with
DeleteWebAclOutput - On failure, responds with
SdkError<DeleteWebACLError>
source§impl Client
impl Client
sourcepub fn describe_all_managed_products(
&self
) -> DescribeAllManagedProductsFluentBuilder
pub fn describe_all_managed_products( &self ) -> DescribeAllManagedProductsFluentBuilder
Constructs a fluent builder for the DescribeAllManagedProducts operation.
- The fluent builder is configurable:
scope(Scope)/set_scope(Option<Scope>):
required: trueSpecifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
-
CLI - Specify the Region when you use the CloudFront scope:
–scope=CLOUDFRONT –region=us-east-1. -
API and SDKs - For all calls, use the Region endpoint us-east-1.
-
- On success, responds with
DescribeAllManagedProductsOutputwith field(s):managed_products(Option<Vec::<ManagedProductDescriptor>>):High-level information for the Amazon Web Services Managed Rules rule groups and Amazon Web Services Marketplace managed rule groups.
- On failure, responds with
SdkError<DescribeAllManagedProductsError>
source§impl Client
impl Client
sourcepub fn describe_managed_products_by_vendor(
&self
) -> DescribeManagedProductsByVendorFluentBuilder
pub fn describe_managed_products_by_vendor( &self ) -> DescribeManagedProductsByVendorFluentBuilder
Constructs a fluent builder for the DescribeManagedProductsByVendor operation.
- The fluent builder is configurable:
vendor_name(impl Into<String>)/set_vendor_name(Option<String>):
required: trueThe name of the managed rule group vendor. You use this, along with the rule group name, to identify a rule group.
scope(Scope)/set_scope(Option<Scope>):
required: trueSpecifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
-
CLI - Specify the Region when you use the CloudFront scope:
–scope=CLOUDFRONT –region=us-east-1. -
API and SDKs - For all calls, use the Region endpoint us-east-1.
-
- On success, responds with
DescribeManagedProductsByVendorOutputwith field(s):managed_products(Option<Vec::<ManagedProductDescriptor>>):High-level information for the managed rule groups owned by the specified vendor.
- On failure, responds with
SdkError<DescribeManagedProductsByVendorError>
source§impl Client
impl Client
sourcepub fn describe_managed_rule_group(
&self
) -> DescribeManagedRuleGroupFluentBuilder
pub fn describe_managed_rule_group( &self ) -> DescribeManagedRuleGroupFluentBuilder
Constructs a fluent builder for the DescribeManagedRuleGroup operation.
- The fluent builder is configurable:
vendor_name(impl Into<String>)/set_vendor_name(Option<String>):
required: trueThe name of the managed rule group vendor. You use this, along with the rule group name, to identify a rule group.
name(impl Into<String>)/set_name(Option<String>):
required: trueThe name of the managed rule group. You use this, along with the vendor name, to identify the rule group.
scope(Scope)/set_scope(Option<Scope>):
required: trueSpecifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
-
CLI - Specify the Region when you use the CloudFront scope:
–scope=CLOUDFRONT –region=us-east-1. -
API and SDKs - For all calls, use the Region endpoint us-east-1.
-
version_name(impl Into<String>)/set_version_name(Option<String>):
required: falseThe version of the rule group. You can only use a version that is not scheduled for expiration. If you don’t provide this, WAF uses the vendor’s default version.
- On success, responds with
DescribeManagedRuleGroupOutputwith field(s):version_name(Option<String>):The managed rule group’s version.
sns_topic_arn(Option<String>):The Amazon resource name (ARN) of the Amazon Simple Notification Service SNS topic that’s used to provide notification of changes to the managed rule group. You can subscribe to the SNS topic to receive notifications when the managed rule group is modified, such as for new versions and for version expiration. For more information, see the Amazon Simple Notification Service Developer Guide.
capacity(Option<i64>):The web ACL capacity units (WCUs) required for this rule group.
WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. For more information, see WAF web ACL capacity units (WCU) in the WAF Developer Guide.
rules(Option<Vec::<RuleSummary>>):label_namespace(Option<String>):The label namespace prefix for this rule group. All labels added by rules in this rule group have this prefix.
-
The syntax for the label namespace prefix for a managed rule group is the following:
awswaf:managed::: -
When a rule with a label matches a web request, WAF adds the fully qualified label to the request. A fully qualified label is made up of the label namespace from the rule group or web ACL where the rule is defined and the label from the rule, separated by a colon:
-
available_labels(Option<Vec::<LabelSummary>>):The labels that one or more rules in this rule group add to matching web requests. These labels are defined in the
RuleLabelsfor aRule.consumed_labels(Option<Vec::<LabelSummary>>):The labels that one or more rules in this rule group match against in label match statements. These labels are defined in a
LabelMatchStatementspecification, in theStatementdefinition of a rule.
- On failure, responds with
SdkError<DescribeManagedRuleGroupError>
source§impl Client
impl Client
sourcepub fn disassociate_web_acl(&self) -> DisassociateWebACLFluentBuilder
pub fn disassociate_web_acl(&self) -> DisassociateWebACLFluentBuilder
Constructs a fluent builder for the DisassociateWebACL operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)/set_resource_arn(Option<String>):
required: trueThe Amazon Resource Name (ARN) of the resource to disassociate from the web ACL.
The ARN must be in one of the following formats:
-
For an Application Load Balancer:
arn:partition:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id -
For an Amazon API Gateway REST API:
arn:partition:apigateway:region::/restapis/api-id/stages/stage-name -
For an AppSync GraphQL API:
arn:partition:appsync:region:account-id:apis/GraphQLApiId -
For an Amazon Cognito user pool:
arn:partition:cognito-idp:region:account-id:userpool/user-pool-id -
For an App Runner service:
arn:partition:apprunner:region:account-id:service/apprunner-service-name/apprunner-service-id -
For an Amazon Web Services Verified Access instance:
arn:partition:ec2:region:account-id:verified-access-instance/instance-id
-
- On success, responds with
DisassociateWebAclOutput - On failure, responds with
SdkError<DisassociateWebACLError>
source§impl Client
impl Client
sourcepub fn generate_mobile_sdk_release_url(
&self
) -> GenerateMobileSdkReleaseUrlFluentBuilder
pub fn generate_mobile_sdk_release_url( &self ) -> GenerateMobileSdkReleaseUrlFluentBuilder
Constructs a fluent builder for the GenerateMobileSdkReleaseUrl operation.
- The fluent builder is configurable:
platform(Platform)/set_platform(Option<Platform>):
required: trueThe device platform.
release_version(impl Into<String>)/set_release_version(Option<String>):
required: trueThe release version. For the latest available version, specify
LATEST.
- On success, responds with
GenerateMobileSdkReleaseUrlOutputwith field(s):url(Option<String>):The presigned download URL for the specified SDK release.
- On failure, responds with
SdkError<GenerateMobileSdkReleaseUrlError>
source§impl Client
impl Client
sourcepub fn get_decrypted_api_key(&self) -> GetDecryptedAPIKeyFluentBuilder
pub fn get_decrypted_api_key(&self) -> GetDecryptedAPIKeyFluentBuilder
Constructs a fluent builder for the GetDecryptedAPIKey operation.
- The fluent builder is configurable:
scope(Scope)/set_scope(Option<Scope>):
required: trueSpecifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
-
CLI - Specify the Region when you use the CloudFront scope:
–scope=CLOUDFRONT –region=us-east-1. -
API and SDKs - For all calls, use the Region endpoint us-east-1.
-
api_key(impl Into<String>)/set_api_key(Option<String>):
required: trueThe encrypted API key.
- On success, responds with
GetDecryptedApiKeyOutputwith field(s):token_domains(Option<Vec::<String>>):The token domains that are defined in this API key.
creation_timestamp(Option<DateTime>):The date and time that the key was created.
- On failure, responds with
SdkError<GetDecryptedAPIKeyError>
source§impl Client
impl Client
sourcepub fn get_ip_set(&self) -> GetIPSetFluentBuilder
pub fn get_ip_set(&self) -> GetIPSetFluentBuilder
Constructs a fluent builder for the GetIPSet operation.
- The fluent builder is configurable:
name(impl Into<String>)/set_name(Option<String>):
required: trueThe name of the IP set. You cannot change the name of an
IPSetafter you create it.scope(Scope)/set_scope(Option<Scope>):
required: trueSpecifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
-
CLI - Specify the Region when you use the CloudFront scope:
–scope=CLOUDFRONT –region=us-east-1. -
API and SDKs - For all calls, use the Region endpoint us-east-1.
-
id(impl Into<String>)/set_id(Option<String>):
required: trueA unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
- On success, responds with
GetIpSetOutputwith field(s):ip_set(Option<IpSet>):lock_token(Option<String>):A token used for optimistic locking. WAF returns a token to your
getandlistrequests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations likeupdateanddelete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with aWAFOptimisticLockException. If this happens, perform anotherget, and use the new token returned by that operation.
- On failure, responds with
SdkError<GetIPSetError>
source§impl Client
impl Client
sourcepub fn get_logging_configuration(&self) -> GetLoggingConfigurationFluentBuilder
pub fn get_logging_configuration(&self) -> GetLoggingConfigurationFluentBuilder
Constructs a fluent builder for the GetLoggingConfiguration operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)/set_resource_arn(Option<String>):
required: trueThe Amazon Resource Name (ARN) of the web ACL for which you want to get the
LoggingConfiguration.
- On success, responds with
GetLoggingConfigurationOutputwith field(s):logging_configuration(Option<LoggingConfiguration>):The
LoggingConfigurationfor the specified web ACL.
- On failure, responds with
SdkError<GetLoggingConfigurationError>
source§impl Client
impl Client
sourcepub fn get_managed_rule_set(&self) -> GetManagedRuleSetFluentBuilder
pub fn get_managed_rule_set(&self) -> GetManagedRuleSetFluentBuilder
Constructs a fluent builder for the GetManagedRuleSet operation.
- The fluent builder is configurable:
name(impl Into<String>)/set_name(Option<String>):
required: trueThe name of the managed rule set. You use this, along with the rule set ID, to identify the rule set.
This name is assigned to the corresponding managed rule group, which your customers can access and use.
scope(Scope)/set_scope(Option<Scope>):
required: trueSpecifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
-
CLI - Specify the Region when you use the CloudFront scope:
–scope=CLOUDFRONT –region=us-east-1. -
API and SDKs - For all calls, use the Region endpoint us-east-1.
-
id(impl Into<String>)/set_id(Option<String>):
required: trueA unique identifier for the managed rule set. The ID is returned in the responses to commands like
list. You provide it to operations likegetandupdate.
- On success, responds with
GetManagedRuleSetOutputwith field(s):managed_rule_set(Option<ManagedRuleSet>):The managed rule set that you requested.
lock_token(Option<String>):A token used for optimistic locking. WAF returns a token to your
getandlistrequests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations likeupdateanddelete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with aWAFOptimisticLockException. If this happens, perform anotherget, and use the new token returned by that operation.
- On failure, responds with
SdkError<GetManagedRuleSetError>
source§impl Client
impl Client
sourcepub fn get_mobile_sdk_release(&self) -> GetMobileSdkReleaseFluentBuilder
pub fn get_mobile_sdk_release(&self) -> GetMobileSdkReleaseFluentBuilder
Constructs a fluent builder for the GetMobileSdkRelease operation.
- The fluent builder is configurable:
platform(Platform)/set_platform(Option<Platform>):
required: trueThe device platform.
release_version(impl Into<String>)/set_release_version(Option<String>):
required: trueThe release version. For the latest available version, specify
LATEST.
- On success, responds with
GetMobileSdkReleaseOutputwith field(s):mobile_sdk_release(Option<MobileSdkRelease>):Information for a specified SDK release, including release notes and tags.
- On failure, responds with
SdkError<GetMobileSdkReleaseError>
source§impl Client
impl Client
sourcepub fn get_permission_policy(&self) -> GetPermissionPolicyFluentBuilder
pub fn get_permission_policy(&self) -> GetPermissionPolicyFluentBuilder
Constructs a fluent builder for the GetPermissionPolicy operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)/set_resource_arn(Option<String>):
required: trueThe Amazon Resource Name (ARN) of the rule group for which you want to get the policy.
- On success, responds with
GetPermissionPolicyOutputwith field(s):policy(Option<String>):The IAM policy that is attached to the specified rule group.
- On failure, responds with
SdkError<GetPermissionPolicyError>
source§impl Client
impl Client
sourcepub fn get_rate_based_statement_managed_keys(
&self
) -> GetRateBasedStatementManagedKeysFluentBuilder
pub fn get_rate_based_statement_managed_keys( &self ) -> GetRateBasedStatementManagedKeysFluentBuilder
Constructs a fluent builder for the GetRateBasedStatementManagedKeys operation.
- The fluent builder is configurable:
scope(Scope)/set_scope(Option<Scope>):
required: trueSpecifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
-
CLI - Specify the Region when you use the CloudFront scope:
–scope=CLOUDFRONT –region=us-east-1. -
API and SDKs - For all calls, use the Region endpoint us-east-1.
-
web_acl_name(impl Into<String>)/set_web_acl_name(Option<String>):
required: trueThe name of the web ACL. You cannot change the name of a web ACL after you create it.
web_acl_id(impl Into<String>)/set_web_acl_id(Option<String>):
required: trueThe 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.
rule_group_rule_name(impl Into<String>)/set_rule_group_rule_name(Option<String>):
required: falseThe 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.
rule_name(impl Into<String>)/set_rule_name(Option<String>):
required: trueThe 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
RuleGroupRuleName.
- On success, responds with
GetRateBasedStatementManagedKeysOutputwith field(s):managed_keys_ipv4(Option<RateBasedStatementManagedKeysIpSet>):The keys that are of Internet Protocol version 4 (IPv4).
managed_keys_ipv6(Option<RateBasedStatementManagedKeysIpSet>):The keys that are of Internet Protocol version 6 (IPv6).
- On failure, responds with
SdkError<GetRateBasedStatementManagedKeysError>
source§impl Client
impl Client
sourcepub fn get_regex_pattern_set(&self) -> GetRegexPatternSetFluentBuilder
pub fn get_regex_pattern_set(&self) -> GetRegexPatternSetFluentBuilder
Constructs a fluent builder for the GetRegexPatternSet operation.
- The fluent builder is configurable:
name(impl Into<String>)/set_name(Option<String>):
required: trueThe name of the set. You cannot change the name after you create the set.
scope(Scope)/set_scope(Option<Scope>):
required: trueSpecifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
-
CLI - Specify the Region when you use the CloudFront scope:
–scope=CLOUDFRONT –region=us-east-1. -
API and SDKs - For all calls, use the Region endpoint us-east-1.
-
id(impl Into<String>)/set_id(Option<String>):
required: trueA unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
- On success, responds with
GetRegexPatternSetOutputwith field(s):regex_pattern_set(Option<RegexPatternSet>):lock_token(Option<String>):A token used for optimistic locking. WAF returns a token to your
getandlistrequests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations likeupdateanddelete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with aWAFOptimisticLockException. If this happens, perform anotherget, and use the new token returned by that operation.
- On failure, responds with
SdkError<GetRegexPatternSetError>
source§impl Client
impl Client
sourcepub fn get_rule_group(&self) -> GetRuleGroupFluentBuilder
pub fn get_rule_group(&self) -> GetRuleGroupFluentBuilder
Constructs a fluent builder for the GetRuleGroup operation.
- The fluent builder is configurable:
name(impl Into<String>)/set_name(Option<String>):
required: falseThe name of the rule group. You cannot change the name of a rule group after you create it.
scope(Scope)/set_scope(Option<Scope>):
required: falseSpecifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
-
CLI - Specify the Region when you use the CloudFront scope:
–scope=CLOUDFRONT –region=us-east-1. -
API and SDKs - For all calls, use the Region endpoint us-east-1.
-
id(impl Into<String>)/set_id(Option<String>):
required: falseA unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
arn(impl Into<String>)/set_arn(Option<String>):
required: falseThe Amazon Resource Name (ARN) of the entity.
- On success, responds with
GetRuleGroupOutputwith field(s):rule_group(Option<RuleGroup>):lock_token(Option<String>):A token used for optimistic locking. WAF returns a token to your
getandlistrequests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations likeupdateanddelete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with aWAFOptimisticLockException. If this happens, perform anotherget, and use the new token returned by that operation.
- On failure, responds with
SdkError<GetRuleGroupError>
source§impl Client
impl Client
sourcepub fn get_sampled_requests(&self) -> GetSampledRequestsFluentBuilder
pub fn get_sampled_requests(&self) -> GetSampledRequestsFluentBuilder
Constructs a fluent builder for the GetSampledRequests operation.
- The fluent builder is configurable:
web_acl_arn(impl Into<String>)/set_web_acl_arn(Option<String>):
required: trueThe Amazon resource name (ARN) of the
WebACLfor which you want a sample of requests.rule_metric_name(impl Into<String>)/set_rule_metric_name(Option<String>):
required: trueThe metric name assigned to the
RuleorRuleGroupdimension for which you want a sample of requests.scope(Scope)/set_scope(Option<Scope>):
required: trueSpecifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
-
CLI - Specify the Region when you use the CloudFront scope:
–scope=CLOUDFRONT –region=us-east-1. -
API and SDKs - For all calls, use the Region endpoint us-east-1.
-
time_window(TimeWindow)/set_time_window(Option<TimeWindow>):
required: trueThe start date and time and the end date and time of the range for which you want
GetSampledRequeststo return a sample of requests. You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special designator,Z. For example,“2016-09-27T14:50Z”. You can specify any time range in the previous three hours. If you specify a start time that’s earlier than three hours ago, WAF sets it to three hours ago.max_items(i64)/set_max_items(Option<i64>):
required: trueThe number of requests that you want WAF to return from among the first 5,000 requests that your Amazon Web Services resource received during the time range. If your resource received fewer requests than the value of
MaxItems,GetSampledRequestsreturns information about all of them.
- On success, responds with
GetSampledRequestsOutputwith field(s):sampled_requests(Option<Vec::<SampledHttpRequest>>):A complex type that contains detailed information about each of the requests in the sample.
population_size(i64):The total number of requests from which
GetSampledRequestsgot a sample ofMaxItemsrequests. IfPopulationSizeis less thanMaxItems, the sample includes every request that your Amazon Web Services resource received during the specified time range.time_window(Option<TimeWindow>):Usually,
TimeWindowis the time range that you specified in theGetSampledRequestsrequest. However, if your Amazon Web Services resource received more than 5,000 requests during the time range that you specified in the request,GetSampledRequestsreturns the time range for the first 5,000 requests. Times are in Coordinated Universal Time (UTC) format.
- On failure, responds with
SdkError<GetSampledRequestsError>
source§impl Client
impl Client
sourcepub fn get_web_acl(&self) -> GetWebACLFluentBuilder
pub fn get_web_acl(&self) -> GetWebACLFluentBuilder
Constructs a fluent builder for the GetWebACL operation.
- The fluent builder is configurable:
name(impl Into<String>)/set_name(Option<String>):
required: trueThe name of the web ACL. You cannot change the name of a web ACL after you create it.
scope(Scope)/set_scope(Option<Scope>):
required: trueSpecifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
-
CLI - Specify the Region when you use the CloudFront scope:
–scope=CLOUDFRONT –region=us-east-1. -
API and SDKs - For all calls, use the Region endpoint us-east-1.
-
id(impl Into<String>)/set_id(Option<String>):
required: trueThe 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.
- On success, responds with
GetWebAclOutputwith field(s):web_acl(Option<WebAcl>):The web ACL specification. You can modify the settings in this web ACL and use it to update this web ACL or create a new one.
lock_token(Option<String>):A token used for optimistic locking. WAF returns a token to your
getandlistrequests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations likeupdateanddelete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with aWAFOptimisticLockException. If this happens, perform anotherget, and use the new token returned by that operation.application_integration_url(Option<String>):The URL to use in SDK integrations with Amazon Web Services managed rule groups. For example, you can use the integration SDKs with the account takeover prevention managed rule group
AWSManagedRulesATPRuleSetand the account creation fraud prevention managed rule groupAWSManagedRulesACFPRuleSet. This is only populated if you are using a rule group in your web ACL that integrates with your applications in this way. For more information, see WAF client application integration in the WAF Developer Guide.
- On failure, responds with
SdkError<GetWebACLError>
source§impl Client
impl Client
sourcepub fn get_web_acl_for_resource(&self) -> GetWebACLForResourceFluentBuilder
pub fn get_web_acl_for_resource(&self) -> GetWebACLForResourceFluentBuilder
Constructs a fluent builder for the GetWebACLForResource operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)/set_resource_arn(Option<String>):
required: trueThe Amazon Resource Name (ARN) of the resource whose web ACL you want to retrieve.
The ARN must be in one of the following formats:
-
For an Application Load Balancer:
arn:partition:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id -
For an Amazon API Gateway REST API:
arn:partition:apigateway:region::/restapis/api-id/stages/stage-name -
For an AppSync GraphQL API:
arn:partition:appsync:region:account-id:apis/GraphQLApiId -
For an Amazon Cognito user pool:
arn:partition:cognito-idp:region:account-id:userpool/user-pool-id -
For an App Runner service:
arn:partition:apprunner:region:account-id:service/apprunner-service-name/apprunner-service-id -
For an Amazon Web Services Verified Access instance:
arn:partition:ec2:region:account-id:verified-access-instance/instance-id
-
- On success, responds with
GetWebAclForResourceOutputwith field(s):web_acl(Option<WebAcl>):The web ACL that is associated with the resource. If there is no associated resource, WAF returns a null web ACL.
- On failure, responds with
SdkError<GetWebACLForResourceError>
source§impl Client
impl Client
sourcepub fn list_api_keys(&self) -> ListAPIKeysFluentBuilder
pub fn list_api_keys(&self) -> ListAPIKeysFluentBuilder
Constructs a fluent builder for the ListAPIKeys operation.
- The fluent builder is configurable:
scope(Scope)/set_scope(Option<Scope>):
required: trueSpecifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
-
CLI - Specify the Region when you use the CloudFront scope:
–scope=CLOUDFRONT –region=us-east-1. -
API and SDKs - For all calls, use the Region endpoint us-east-1.
-
next_marker(impl Into<String>)/set_next_marker(Option<String>):
required: falseWhen you request a list of objects with a
Limitsetting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns aNextMarkervalue in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.limit(i32)/set_limit(Option<i32>):
required: falseThe maximum number of objects that you want WAF to return for this request. If more objects are available, in the response, WAF provides a
NextMarkervalue that you can use in a subsequent call to get the next batch of objects.
- On success, responds with
ListApiKeysOutputwith field(s):next_marker(Option<String>):When you request a list of objects with a
Limitsetting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns aNextMarkervalue in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.api_key_summaries(Option<Vec::<ApiKeySummary>>):The array of key summaries. If you specified a
Limitin your request, this might not be the full list.application_integration_url(Option<String>):The CAPTCHA application integration URL, for use in your JavaScript implementation.
- On failure, responds with
SdkError<ListAPIKeysError>
source§impl Client
impl Client
sourcepub fn list_available_managed_rule_group_versions(
&self
) -> ListAvailableManagedRuleGroupVersionsFluentBuilder
pub fn list_available_managed_rule_group_versions( &self ) -> ListAvailableManagedRuleGroupVersionsFluentBuilder
Constructs a fluent builder for the ListAvailableManagedRuleGroupVersions operation.
- The fluent builder is configurable:
vendor_name(impl Into<String>)/set_vendor_name(Option<String>):
required: trueThe name of the managed rule group vendor. You use this, along with the rule group name, to identify a rule group.
name(impl Into<String>)/set_name(Option<String>):
required: trueThe name of the managed rule group. You use this, along with the vendor name, to identify the rule group.
scope(Scope)/set_scope(Option<Scope>):
required: trueSpecifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
-
CLI - Specify the Region when you use the CloudFront scope:
–scope=CLOUDFRONT –region=us-east-1. -
API and SDKs - For all calls, use the Region endpoint us-east-1.
-
next_marker(impl Into<String>)/set_next_marker(Option<String>):
required: falseWhen you request a list of objects with a
Limitsetting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns aNextMarkervalue in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.limit(i32)/set_limit(Option<i32>):
required: falseThe maximum number of objects that you want WAF to return for this request. If more objects are available, in the response, WAF provides a
NextMarkervalue that you can use in a subsequent call to get the next batch of objects.
- On success, responds with
ListAvailableManagedRuleGroupVersionsOutputwith field(s):next_marker(Option<String>):When you request a list of objects with a
Limitsetting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns aNextMarkervalue in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.versions(Option<Vec::<ManagedRuleGroupVersion>>):The versions that are currently available for the specified managed rule group. If you specified a
Limitin your request, this might not be the full list.current_default_version(Option<String>):The name of the version that’s currently set as the default.
- On failure, responds with
SdkError<ListAvailableManagedRuleGroupVersionsError>
source§impl Client
impl Client
sourcepub fn list_available_managed_rule_groups(
&self
) -> ListAvailableManagedRuleGroupsFluentBuilder
pub fn list_available_managed_rule_groups( &self ) -> ListAvailableManagedRuleGroupsFluentBuilder
Constructs a fluent builder for the ListAvailableManagedRuleGroups operation.
- The fluent builder is configurable:
scope(Scope)/set_scope(Option<Scope>):
required: trueSpecifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
-
CLI - Specify the Region when you use the CloudFront scope:
–scope=CLOUDFRONT –region=us-east-1. -
API and SDKs - For all calls, use the Region endpoint us-east-1.
-
next_marker(impl Into<String>)/set_next_marker(Option<String>):
required: falseWhen you request a list of objects with a
Limitsetting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns aNextMarkervalue in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.limit(i32)/set_limit(Option<i32>):
required: falseThe maximum number of objects that you want WAF to return for this request. If more objects are available, in the response, WAF provides a
NextMarkervalue that you can use in a subsequent call to get the next batch of objects.
- On success, responds with
ListAvailableManagedRuleGroupsOutputwith field(s):next_marker(Option<String>):When you request a list of objects with a
Limitsetting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns aNextMarkervalue in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.managed_rule_groups(Option<Vec::<ManagedRuleGroupSummary>>):Array of managed rule groups that you can use. If you specified a
Limitin your request, this might not be the full list.
- On failure, responds with
SdkError<ListAvailableManagedRuleGroupsError>
source§impl Client
impl Client
sourcepub fn list_ip_sets(&self) -> ListIPSetsFluentBuilder
pub fn list_ip_sets(&self) -> ListIPSetsFluentBuilder
Constructs a fluent builder for the ListIPSets operation.
- The fluent builder is configurable:
scope(Scope)/set_scope(Option<Scope>):
required: trueSpecifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
-
CLI - Specify the Region when you use the CloudFront scope:
–scope=CLOUDFRONT –region=us-east-1. -
API and SDKs - For all calls, use the Region endpoint us-east-1.
-
next_marker(impl Into<String>)/set_next_marker(Option<String>):
required: falseWhen you request a list of objects with a
Limitsetting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns aNextMarkervalue in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.limit(i32)/set_limit(Option<i32>):
required: falseThe maximum number of objects that you want WAF to return for this request. If more objects are available, in the response, WAF provides a
NextMarkervalue that you can use in a subsequent call to get the next batch of objects.
- On success, responds with
ListIpSetsOutputwith field(s):next_marker(Option<String>):When you request a list of objects with a
Limitsetting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns aNextMarkervalue in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.ip_sets(Option<Vec::<IpSetSummary>>):Array of IPSets. If you specified a
Limitin your request, this might not be the full list.
- On failure, responds with
SdkError<ListIPSetsError>
source§impl Client
impl Client
sourcepub fn list_logging_configurations(
&self
) -> ListLoggingConfigurationsFluentBuilder
pub fn list_logging_configurations( &self ) -> ListLoggingConfigurationsFluentBuilder
Constructs a fluent builder for the ListLoggingConfigurations operation.
- The fluent builder is configurable:
scope(Scope)/set_scope(Option<Scope>):
required: trueSpecifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
-
CLI - Specify the Region when you use the CloudFront scope:
–scope=CLOUDFRONT –region=us-east-1. -
API and SDKs - For all calls, use the Region endpoint us-east-1.
-
next_marker(impl Into<String>)/set_next_marker(Option<String>):
required: falseWhen you request a list of objects with a
Limitsetting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns aNextMarkervalue in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.limit(i32)/set_limit(Option<i32>):
required: falseThe maximum number of objects that you want WAF to return for this request. If more objects are available, in the response, WAF provides a
NextMarkervalue that you can use in a subsequent call to get the next batch of objects.
- On success, responds with
ListLoggingConfigurationsOutputwith field(s):logging_configurations(Option<Vec::<LoggingConfiguration>>):Array of logging configurations. If you specified a
Limitin your request, this might not be the full list.next_marker(Option<String>):When you request a list of objects with a
Limitsetting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns aNextMarkervalue in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
- On failure, responds with
SdkError<ListLoggingConfigurationsError>
source§impl Client
impl Client
sourcepub fn list_managed_rule_sets(&self) -> ListManagedRuleSetsFluentBuilder
pub fn list_managed_rule_sets(&self) -> ListManagedRuleSetsFluentBuilder
Constructs a fluent builder for the ListManagedRuleSets operation.
- The fluent builder is configurable:
scope(Scope)/set_scope(Option<Scope>):
required: trueSpecifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
-
CLI - Specify the Region when you use the CloudFront scope:
–scope=CLOUDFRONT –region=us-east-1. -
API and SDKs - For all calls, use the Region endpoint us-east-1.
-
next_marker(impl Into<String>)/set_next_marker(Option<String>):
required: falseWhen you request a list of objects with a
Limitsetting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns aNextMarkervalue in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.limit(i32)/set_limit(Option<i32>):
required: falseThe maximum number of objects that you want WAF to return for this request. If more objects are available, in the response, WAF provides a
NextMarkervalue that you can use in a subsequent call to get the next batch of objects.
- On success, responds with
ListManagedRuleSetsOutputwith field(s):next_marker(Option<String>):When you request a list of objects with a
Limitsetting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns aNextMarkervalue in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.managed_rule_sets(Option<Vec::<ManagedRuleSetSummary>>):Your managed rule sets. If you specified a
Limitin your request, this might not be the full list.
- On failure, responds with
SdkError<ListManagedRuleSetsError>
source§impl Client
impl Client
sourcepub fn list_mobile_sdk_releases(&self) -> ListMobileSdkReleasesFluentBuilder
pub fn list_mobile_sdk_releases(&self) -> ListMobileSdkReleasesFluentBuilder
Constructs a fluent builder for the ListMobileSdkReleases operation.
- The fluent builder is configurable:
platform(Platform)/set_platform(Option<Platform>):
required: trueThe device platform to retrieve the list for.
next_marker(impl Into<String>)/set_next_marker(Option<String>):
required: falseWhen you request a list of objects with a
Limitsetting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns aNextMarkervalue in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.limit(i32)/set_limit(Option<i32>):
required: falseThe maximum number of objects that you want WAF to return for this request. If more objects are available, in the response, WAF provides a
NextMarkervalue that you can use in a subsequent call to get the next batch of objects.
- On success, responds with
ListMobileSdkReleasesOutputwith field(s):release_summaries(Option<Vec::<ReleaseSummary>>):The high level information for the available SDK releases. If you specified a
Limitin your request, this might not be the full list.next_marker(Option<String>):When you request a list of objects with a
Limitsetting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns aNextMarkervalue in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
- On failure, responds with
SdkError<ListMobileSdkReleasesError>
source§impl Client
impl Client
sourcepub fn list_regex_pattern_sets(&self) -> ListRegexPatternSetsFluentBuilder
pub fn list_regex_pattern_sets(&self) -> ListRegexPatternSetsFluentBuilder
Constructs a fluent builder for the ListRegexPatternSets operation.
- The fluent builder is configurable:
scope(Scope)/set_scope(Option<Scope>):
required: trueSpecifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
-
CLI - Specify the Region when you use the CloudFront scope:
–scope=CLOUDFRONT –region=us-east-1. -
API and SDKs - For all calls, use the Region endpoint us-east-1.
-
next_marker(impl Into<String>)/set_next_marker(Option<String>):
required: falseWhen you request a list of objects with a
Limitsetting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns aNextMarkervalue in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.limit(i32)/set_limit(Option<i32>):
required: falseThe maximum number of objects that you want WAF to return for this request. If more objects are available, in the response, WAF provides a
NextMarkervalue that you can use in a subsequent call to get the next batch of objects.
- On success, responds with
ListRegexPatternSetsOutputwith field(s):next_marker(Option<String>):When you request a list of objects with a
Limitsetting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns aNextMarkervalue in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.regex_pattern_sets(Option<Vec::<RegexPatternSetSummary>>):Array of regex pattern sets. If you specified a
Limitin your request, this might not be the full list.
- On failure, responds with
SdkError<ListRegexPatternSetsError>
source§impl Client
impl Client
sourcepub fn list_resources_for_web_acl(&self) -> ListResourcesForWebACLFluentBuilder
pub fn list_resources_for_web_acl(&self) -> ListResourcesForWebACLFluentBuilder
Constructs a fluent builder for the ListResourcesForWebACL operation.
- The fluent builder is configurable:
web_acl_arn(impl Into<String>)/set_web_acl_arn(Option<String>):
required: trueThe Amazon Resource Name (ARN) of the web ACL.
resource_type(ResourceType)/set_resource_type(Option<ResourceType>):
required: falseUsed for web ACLs that are scoped for regional applications. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
If you don’t provide a resource type, the call uses the resource type
APPLICATION_LOAD_BALANCER.Default:
APPLICATION_LOAD_BALANCER
- On success, responds with
ListResourcesForWebAclOutputwith field(s):resource_arns(Option<Vec::<String>>):The array of Amazon Resource Names (ARNs) of the associated resources.
- On failure, responds with
SdkError<ListResourcesForWebACLError>
source§impl Client
impl Client
sourcepub fn list_rule_groups(&self) -> ListRuleGroupsFluentBuilder
pub fn list_rule_groups(&self) -> ListRuleGroupsFluentBuilder
Constructs a fluent builder for the ListRuleGroups operation.
- The fluent builder is configurable:
scope(Scope)/set_scope(Option<Scope>):
required: trueSpecifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
-
CLI - Specify the Region when you use the CloudFront scope:
–scope=CLOUDFRONT –region=us-east-1. -
API and SDKs - For all calls, use the Region endpoint us-east-1.
-
next_marker(impl Into<String>)/set_next_marker(Option<String>):
required: falseWhen you request a list of objects with a
Limitsetting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns aNextMarkervalue in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.limit(i32)/set_limit(Option<i32>):
required: falseThe maximum number of objects that you want WAF to return for this request. If more objects are available, in the response, WAF provides a
NextMarkervalue that you can use in a subsequent call to get the next batch of objects.
- On success, responds with
ListRuleGroupsOutputwith field(s):next_marker(Option<String>):When you request a list of objects with a
Limitsetting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns aNextMarkervalue in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.rule_groups(Option<Vec::<RuleGroupSummary>>):Array of rule groups. If you specified a
Limitin your request, this might not be the full list.
- On failure, responds with
SdkError<ListRuleGroupsError>
source§impl Client
impl Client
Constructs a fluent builder for the ListTagsForResource operation.
- The fluent builder is configurable:
next_marker(impl Into<String>)/set_next_marker(Option<String>):
required: falseWhen you request a list of objects with a
Limitsetting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns aNextMarkervalue in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.limit(i32)/set_limit(Option<i32>):
required: falseThe maximum number of objects that you want WAF to return for this request. If more objects are available, in the response, WAF provides a
NextMarkervalue that you can use in a subsequent call to get the next batch of objects.resource_arn(impl Into<String>)/set_resource_arn(Option<String>):
required: trueThe Amazon Resource Name (ARN) of the resource.
- On success, responds with
ListTagsForResourceOutputwith field(s):next_marker(Option<String>):When you request a list of objects with a
Limitsetting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns aNextMarkervalue in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.tag_info_for_resource(Option<TagInfoForResource>):The collection of tagging definitions for the resource. If you specified a
Limitin your request, this might not be the full list.
- On failure, responds with
SdkError<ListTagsForResourceError>
source§impl Client
impl Client
sourcepub fn list_web_acls(&self) -> ListWebACLsFluentBuilder
pub fn list_web_acls(&self) -> ListWebACLsFluentBuilder
Constructs a fluent builder for the ListWebACLs operation.
- The fluent builder is configurable:
scope(Scope)/set_scope(Option<Scope>):
required: trueSpecifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
-
CLI - Specify the Region when you use the CloudFront scope:
–scope=CLOUDFRONT –region=us-east-1. -
API and SDKs - For all calls, use the Region endpoint us-east-1.
-
next_marker(impl Into<String>)/set_next_marker(Option<String>):
required: falseWhen you request a list of objects with a
Limitsetting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns aNextMarkervalue in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.limit(i32)/set_limit(Option<i32>):
required: falseThe maximum number of objects that you want WAF to return for this request. If more objects are available, in the response, WAF provides a
NextMarkervalue that you can use in a subsequent call to get the next batch of objects.
- On success, responds with
ListWebAcLsOutputwith field(s):next_marker(Option<String>):When you request a list of objects with a
Limitsetting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns aNextMarkervalue in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.web_acls(Option<Vec::<WebAclSummary>>):Array of web ACLs. If you specified a
Limitin your request, this might not be the full list.
- On failure, responds with
SdkError<ListWebACLsError>
source§impl Client
impl Client
sourcepub fn put_logging_configuration(&self) -> PutLoggingConfigurationFluentBuilder
pub fn put_logging_configuration(&self) -> PutLoggingConfigurationFluentBuilder
Constructs a fluent builder for the PutLoggingConfiguration operation.
- The fluent builder is configurable:
- On success, responds with
PutLoggingConfigurationOutputwith field(s): - On failure, responds with
SdkError<PutLoggingConfigurationError>
source§impl Client
impl Client
sourcepub fn put_managed_rule_set_versions(
&self
) -> PutManagedRuleSetVersionsFluentBuilder
pub fn put_managed_rule_set_versions( &self ) -> PutManagedRuleSetVersionsFluentBuilder
Constructs a fluent builder for the PutManagedRuleSetVersions operation.
- The fluent builder is configurable:
name(impl Into<String>)/set_name(Option<String>):
required: trueThe name of the managed rule set. You use this, along with the rule set ID, to identify the rule set.
This name is assigned to the corresponding managed rule group, which your customers can access and use.
scope(Scope)/set_scope(Option<Scope>):
required: trueSpecifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
-
CLI - Specify the Region when you use the CloudFront scope:
–scope=CLOUDFRONT –region=us-east-1. -
API and SDKs - For all calls, use the Region endpoint us-east-1.
-
id(impl Into<String>)/set_id(Option<String>):
required: trueA unique identifier for the managed rule set. The ID is returned in the responses to commands like
list. You provide it to operations likegetandupdate.lock_token(impl Into<String>)/set_lock_token(Option<String>):
required: trueA token used for optimistic locking. WAF returns a token to your
getandlistrequests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations likeupdateanddelete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with aWAFOptimisticLockException. If this happens, perform anotherget, and use the new token returned by that operation.recommended_version(impl Into<String>)/set_recommended_version(Option<String>):
required: falseThe version of the named managed rule group that you’d like your customers to choose, from among your version offerings.
versions_to_publish(impl Into<String>, VersionToPublish)/set_versions_to_publish(Option<HashMap::<String, VersionToPublish>>):
required: falseThe versions of the named managed rule group that you want to offer to your customers.
- On success, responds with
PutManagedRuleSetVersionsOutputwith field(s):next_lock_token(Option<String>):A token used for optimistic locking. WAF returns a token to your
getandlistrequests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations likeupdateanddelete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with aWAFOptimisticLockException. If this happens, perform anotherget, and use the new token returned by that operation.
- On failure, responds with
SdkError<PutManagedRuleSetVersionsError>
source§impl Client
impl Client
sourcepub fn put_permission_policy(&self) -> PutPermissionPolicyFluentBuilder
pub fn put_permission_policy(&self) -> PutPermissionPolicyFluentBuilder
Constructs a fluent builder for the PutPermissionPolicy operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)/set_resource_arn(Option<String>):
required: trueThe Amazon Resource Name (ARN) of the
RuleGroupto which you want to attach the policy.policy(impl Into<String>)/set_policy(Option<String>):
required: trueThe policy to attach to the specified rule group.
The policy specifications must conform to the following:
-
The policy must be composed using IAM Policy version 2012-10-17.
-
The policy must include specifications for
Effect,Action, andPrincipal. -
Effectmust specifyAllow. -
Actionmust specifywafv2:CreateWebACL,wafv2:UpdateWebACL, andwafv2:PutFirewallManagerRuleGroupsand may optionally specifywafv2:GetRuleGroup. WAF rejects any extra actions or wildcard actions in the policy. -
The policy must not include a
Resourceparameter.
For more information, see IAM Policies.
-
- On success, responds with
PutPermissionPolicyOutput - On failure, responds with
SdkError<PutPermissionPolicyError>
source§impl Client
impl Client
sourcepub fn tag_resource(&self) -> TagResourceFluentBuilder
pub fn tag_resource(&self) -> TagResourceFluentBuilder
Constructs a fluent builder for the TagResource operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)/set_resource_arn(Option<String>):
required: trueThe Amazon Resource Name (ARN) of the resource.
tags(Tag)/set_tags(Option<Vec::<Tag>>):
required: trueAn array of key:value pairs to associate with the resource.
- On success, responds with
TagResourceOutput - On failure, responds with
SdkError<TagResourceError>
source§impl Client
impl Client
sourcepub fn untag_resource(&self) -> UntagResourceFluentBuilder
pub fn untag_resource(&self) -> UntagResourceFluentBuilder
Constructs a fluent builder for the UntagResource operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)/set_resource_arn(Option<String>):
required: trueThe Amazon Resource Name (ARN) of the resource.
tag_keys(impl Into<String>)/set_tag_keys(Option<Vec::<String>>):
required: trueAn array of keys identifying the tags to disassociate from the resource.
- On success, responds with
UntagResourceOutput - On failure, responds with
SdkError<UntagResourceError>
source§impl Client
impl Client
sourcepub fn update_ip_set(&self) -> UpdateIPSetFluentBuilder
pub fn update_ip_set(&self) -> UpdateIPSetFluentBuilder
Constructs a fluent builder for the UpdateIPSet operation.
- The fluent builder is configurable:
name(impl Into<String>)/set_name(Option<String>):
required: trueThe name of the IP set. You cannot change the name of an
IPSetafter you create it.scope(Scope)/set_scope(Option<Scope>):
required: trueSpecifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
-
CLI - Specify the Region when you use the CloudFront scope:
–scope=CLOUDFRONT –region=us-east-1. -
API and SDKs - For all calls, use the Region endpoint us-east-1.
-
id(impl Into<String>)/set_id(Option<String>):
required: trueA unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
description(impl Into<String>)/set_description(Option<String>):
required: falseA description of the IP set that helps with identification.
addresses(impl Into<String>)/set_addresses(Option<Vec::<String>>):
required: trueContains an array of strings that specifies zero or more IP addresses or blocks of IP addresses that you want WAF to inspect for in incoming requests. All addresses must be specified using Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for
/0.Example address strings:
-
For requests that originated from the IP address 192.0.2.44, specify
192.0.2.44/32. -
For requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify
192.0.2.0/24. -
For requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify
1111:0000:0000:0000:0000:0000:0000:0111/128. -
For requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify
1111:0000:0000:0000:0000:0000:0000:0000/64.
For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
Example JSON
Addressesspecifications:-
Empty array:
“Addresses”: [] -
Array with one address:
“Addresses”: [“192.0.2.44/32”] -
Array with three addresses:
“Addresses”: [“192.0.2.44/32”, “192.0.2.0/24”, “192.0.0.0/16”] -
INVALID specification:
“Addresses”: [“”]INVALID
-
lock_token(impl Into<String>)/set_lock_token(Option<String>):
required: trueA token used for optimistic locking. WAF returns a token to your
getandlistrequests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations likeupdateanddelete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with aWAFOptimisticLockException. If this happens, perform anotherget, and use the new token returned by that operation.
- On success, responds with
UpdateIpSetOutputwith field(s):next_lock_token(Option<String>):A token used for optimistic locking. WAF returns this token to your
updaterequests. You useNextLockTokenin the same manner as you useLockToken.
- On failure, responds with
SdkError<UpdateIPSetError>
source§impl Client
impl Client
sourcepub fn update_managed_rule_set_version_expiry_date(
&self
) -> UpdateManagedRuleSetVersionExpiryDateFluentBuilder
pub fn update_managed_rule_set_version_expiry_date( &self ) -> UpdateManagedRuleSetVersionExpiryDateFluentBuilder
Constructs a fluent builder for the UpdateManagedRuleSetVersionExpiryDate operation.
- The fluent builder is configurable:
name(impl Into<String>)/set_name(Option<String>):
required: trueThe name of the managed rule set. You use this, along with the rule set ID, to identify the rule set.
This name is assigned to the corresponding managed rule group, which your customers can access and use.
scope(Scope)/set_scope(Option<Scope>):
required: trueSpecifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
-
CLI - Specify the Region when you use the CloudFront scope:
–scope=CLOUDFRONT –region=us-east-1. -
API and SDKs - For all calls, use the Region endpoint us-east-1.
-
id(impl Into<String>)/set_id(Option<String>):
required: trueA unique identifier for the managed rule set. The ID is returned in the responses to commands like
list. You provide it to operations likegetandupdate.lock_token(impl Into<String>)/set_lock_token(Option<String>):
required: trueA token used for optimistic locking. WAF returns a token to your
getandlistrequests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations likeupdateanddelete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with aWAFOptimisticLockException. If this happens, perform anotherget, and use the new token returned by that operation.version_to_expire(impl Into<String>)/set_version_to_expire(Option<String>):
required: trueThe version that you want to remove from your list of offerings for the named managed rule group.
expiry_timestamp(DateTime)/set_expiry_timestamp(Option<DateTime>):
required: trueThe time that you want the version to expire.
Times are in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, “2016-09-27T14:50Z”.
- On success, responds with
UpdateManagedRuleSetVersionExpiryDateOutputwith field(s):expiring_version(Option<String>):The version that is set to expire.
expiry_timestamp(Option<DateTime>):The time that the version will expire.
Times are in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, “2016-09-27T14:50Z”.
next_lock_token(Option<String>):A token used for optimistic locking. WAF returns a token to your
getandlistrequests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations likeupdateanddelete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with aWAFOptimisticLockException. If this happens, perform anotherget, and use the new token returned by that operation.
- On failure, responds with
SdkError<UpdateManagedRuleSetVersionExpiryDateError>
source§impl Client
impl Client
sourcepub fn update_regex_pattern_set(&self) -> UpdateRegexPatternSetFluentBuilder
pub fn update_regex_pattern_set(&self) -> UpdateRegexPatternSetFluentBuilder
Constructs a fluent builder for the UpdateRegexPatternSet operation.
- The fluent builder is configurable:
name(impl Into<String>)/set_name(Option<String>):
required: trueThe name of the set. You cannot change the name after you create the set.
scope(Scope)/set_scope(Option<Scope>):
required: trueSpecifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
-
CLI - Specify the Region when you use the CloudFront scope:
–scope=CLOUDFRONT –region=us-east-1. -
API and SDKs - For all calls, use the Region endpoint us-east-1.
-
id(impl Into<String>)/set_id(Option<String>):
required: trueA unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
description(impl Into<String>)/set_description(Option<String>):
required: falseA description of the set that helps with identification.
regular_expression_list(Regex)/set_regular_expression_list(Option<Vec::<Regex>>):
required: truelock_token(impl Into<String>)/set_lock_token(Option<String>):
required: trueA token used for optimistic locking. WAF returns a token to your
getandlistrequests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations likeupdateanddelete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with aWAFOptimisticLockException. If this happens, perform anotherget, and use the new token returned by that operation.
- On success, responds with
UpdateRegexPatternSetOutputwith field(s):next_lock_token(Option<String>):A token used for optimistic locking. WAF returns this token to your
updaterequests. You useNextLockTokenin the same manner as you useLockToken.
- On failure, responds with
SdkError<UpdateRegexPatternSetError>
source§impl Client
impl Client
sourcepub fn update_rule_group(&self) -> UpdateRuleGroupFluentBuilder
pub fn update_rule_group(&self) -> UpdateRuleGroupFluentBuilder
Constructs a fluent builder for the UpdateRuleGroup operation.
- The fluent builder is configurable:
name(impl Into<String>)/set_name(Option<String>):
required: trueThe name of the rule group. You cannot change the name of a rule group after you create it.
scope(Scope)/set_scope(Option<Scope>):
required: trueSpecifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
-
CLI - Specify the Region when you use the CloudFront scope:
–scope=CLOUDFRONT –region=us-east-1. -
API and SDKs - For all calls, use the Region endpoint us-east-1.
-
id(impl Into<String>)/set_id(Option<String>):
required: trueA unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
description(impl Into<String>)/set_description(Option<String>):
required: falseA description of the rule group that helps with identification.
rules(Rule)/set_rules(Option<Vec::<Rule>>):
required: falseThe
Rulestatements used to identify the web requests that you want to manage. Each rule includes one top-level statement that WAF uses to identify matching web requests, and parameters that govern how WAF handles them.visibility_config(VisibilityConfig)/set_visibility_config(Option<VisibilityConfig>):
required: trueDefines and enables Amazon CloudWatch metrics and web request sample collection.
lock_token(impl Into<String>)/set_lock_token(Option<String>):
required: trueA token used for optimistic locking. WAF returns a token to your
getandlistrequests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations likeupdateanddelete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with aWAFOptimisticLockException. If this happens, perform anotherget, and use the new token returned by that operation.custom_response_bodies(impl Into<String>, CustomResponseBody)/set_custom_response_bodies(Option<HashMap::<String, CustomResponseBody>>):
required: falseA map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the rule group, and then use them in the rules that you define in the rule group.
For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.
For information about the limits on count and size for custom request and response settings, see WAF quotas in the WAF Developer Guide.
- On success, responds with
UpdateRuleGroupOutputwith field(s):next_lock_token(Option<String>):A token used for optimistic locking. WAF returns this token to your
updaterequests. You useNextLockTokenin the same manner as you useLockToken.
- On failure, responds with
SdkError<UpdateRuleGroupError>
source§impl Client
impl Client
sourcepub fn update_web_acl(&self) -> UpdateWebACLFluentBuilder
pub fn update_web_acl(&self) -> UpdateWebACLFluentBuilder
Constructs a fluent builder for the UpdateWebACL operation.
- The fluent builder is configurable:
name(impl Into<String>)/set_name(Option<String>):
required: trueThe name of the web ACL. You cannot change the name of a web ACL after you create it.
scope(Scope)/set_scope(Option<Scope>):
required: trueSpecifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
-
CLI - Specify the Region when you use the CloudFront scope:
–scope=CLOUDFRONT –region=us-east-1. -
API and SDKs - For all calls, use the Region endpoint us-east-1.
-
id(impl Into<String>)/set_id(Option<String>):
required: trueThe 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.
default_action(DefaultAction)/set_default_action(Option<DefaultAction>):
required: trueThe action to perform if none of the
Rulescontained in theWebACLmatch.description(impl Into<String>)/set_description(Option<String>):
required: falseA description of the web ACL that helps with identification.
rules(Rule)/set_rules(Option<Vec::<Rule>>):
required: falseThe
Rulestatements used to identify the web requests that you want to manage. Each rule includes one top-level statement that WAF uses to identify matching web requests, and parameters that govern how WAF handles them.visibility_config(VisibilityConfig)/set_visibility_config(Option<VisibilityConfig>):
required: trueDefines and enables Amazon CloudWatch metrics and web request sample collection.
lock_token(impl Into<String>)/set_lock_token(Option<String>):
required: trueA token used for optimistic locking. WAF returns a token to your
getandlistrequests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations likeupdateanddelete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with aWAFOptimisticLockException. If this happens, perform anotherget, and use the new token returned by that operation.custom_response_bodies(impl Into<String>, CustomResponseBody)/set_custom_response_bodies(Option<HashMap::<String, CustomResponseBody>>):
required: falseA map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the web ACL, and then use them in the rules and default actions that you define in the web ACL.
For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.
For information about the limits on count and size for custom request and response settings, see WAF quotas in the WAF Developer Guide.
captcha_config(CaptchaConfig)/set_captcha_config(Option<CaptchaConfig>):
required: falseSpecifies how WAF should handle
CAPTCHAevaluations for rules that don’t have their ownCaptchaConfigsettings. If you don’t specify this, WAF uses its default settings forCaptchaConfig.challenge_config(ChallengeConfig)/set_challenge_config(Option<ChallengeConfig>):
required: falseSpecifies how WAF should handle challenge evaluations for rules that don’t have their own
ChallengeConfigsettings. If you don’t specify this, WAF uses its default settings forChallengeConfig.token_domains(impl Into<String>)/set_token_domains(Option<Vec::<String>>):
required: falseSpecifies the domains that WAF should accept in a web request token. This enables the use of tokens across multiple protected websites. When WAF provides a token, it uses the domain of the Amazon Web Services resource that the web ACL is protecting. If you don’t specify a list of token domains, WAF accepts tokens only for the domain of the protected resource. With a token domain list, WAF accepts the resource’s host domain plus all domains in the token domain list, including their prefixed subdomains.
Example JSON:
“TokenDomains”: { “mywebsite.com”, “myotherwebsite.com” }Public suffixes aren’t allowed. For example, you can’t use
usa.govorco.ukas token domains.association_config(AssociationConfig)/set_association_config(Option<AssociationConfig>):
required: falseSpecifies custom configurations for the associations between the web ACL and protected resources.
Use this to customize the maximum size of the request body that your protected CloudFront distributions forward to WAF for inspection. The default is 16 KB (16,384 bytes).
You are charged additional fees when your protected resources forward body sizes that are larger than the default. For more information, see WAF Pricing.
- On success, responds with
UpdateWebAclOutputwith field(s):next_lock_token(Option<String>):A token used for optimistic locking. WAF returns this token to your
updaterequests. You useNextLockTokenin the same manner as you useLockToken.
- On failure, responds with
SdkError<UpdateWebACLError>
source§impl Client
impl Client
sourcepub fn from_conf(conf: Config) -> Self
pub fn from_conf(conf: Config) -> Self
Creates a new client from the service Config.
Panics
This method will panic in the following cases:
- Retries or timeouts are enabled without a
sleep_implconfigured. - Identity caching is enabled without a
sleep_implandtime_sourceconfigured. - No
behavior_versionis provided.
The panic message for each of these will have instructions on how to resolve them.
source§impl Client
impl Client
sourcepub fn new(sdk_config: &SdkConfig) -> Self
pub fn new(sdk_config: &SdkConfig) -> Self
Creates a new client from an SDK Config.
Panics
- This method will panic if the
sdk_configis missing an async sleep implementation. If you experience this panic, set thesleep_implon the Config passed into this function to fix it. - This method will panic if the
sdk_configis missing an HTTP connector. If you experience this panic, set thehttp_connectoron the Config passed into this function to fix it. - This method will panic if no
BehaviorVersionis provided. If you experience this panic, setbehavior_versionon the Config or enable thebehavior-version-latestCargo feature.