Struct Client

pub struct Client { /* private fields */ }

Client for AWS WAF

Client for invoking operations on AWS WAF. Each operation on AWS WAF 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_waf::Client::new(&config);

Occasionally, SDKs may have additional service-specific values that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Builder 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_waf::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 CreateByteMatchSet operation has a Client::create_byte_match_set, 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.create_byte_match_set()
    .name("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

impl Client

pub fn create_byte_match_set(&self) -> CreateByteMatchSetFluentBuilder

Constructs a fluent builder for the CreateByteMatchSet operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    A friendly name or description of the ByteMatchSet. You can’t change Name after you create a ByteMatchSet.

    
    
  • change_token(impl Into<String>) / set_change_token(Option<String>):
    required: true
    

    The value returned by the most recent call to GetChangeToken.

    
    
• On success, responds with CreateByteMatchSetOutput with field(s):
  • byte_match_set(Option<ByteMatchSet>):

    A ByteMatchSet that contains no ByteMatchTuple objects.

  • change_token(Option<String>):

    The ChangeToken that you used to submit the CreateByteMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

• On failure, responds with SdkError<CreateByteMatchSetError>

impl Client

pub fn create_geo_match_set(&self) -> CreateGeoMatchSetFluentBuilder

Constructs a fluent builder for the CreateGeoMatchSet operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    A friendly name or description of the GeoMatchSet. You can’t change Name after you create the GeoMatchSet.

    
    
  • change_token(impl Into<String>) / set_change_token(Option<String>):
    required: true
    

    The value returned by the most recent call to GetChangeToken.

    
    
• On success, responds with CreateGeoMatchSetOutput with field(s):
  • geo_match_set(Option<GeoMatchSet>):

    The GeoMatchSet returned in the CreateGeoMatchSet response. The GeoMatchSet contains no GeoMatchConstraints.

  • change_token(Option<String>):

    The ChangeToken that you used to submit the CreateGeoMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

• On failure, responds with SdkError<CreateGeoMatchSetError>

impl Client

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: true
    

    A friendly name or description of the IPSet. You can’t change Name after you create the IPSet.

    
    
  • change_token(impl Into<String>) / set_change_token(Option<String>):
    required: true
    

    The value returned by the most recent call to GetChangeToken.

    
    
• On success, responds with CreateIpSetOutput with field(s):
  • ip_set(Option<IpSet>):

    The IPSet returned in the CreateIPSet response.

  • change_token(Option<String>):

    The ChangeToken that you used to submit the CreateIPSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

• On failure, responds with SdkError<CreateIPSetError>

impl Client

pub fn create_rate_based_rule(&self) -> CreateRateBasedRuleFluentBuilder

Constructs a fluent builder for the CreateRateBasedRule operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    A friendly name or description of the RateBasedRule. You can’t change the name of a RateBasedRule after you create it.

    
    
  • metric_name(impl Into<String>) / set_metric_name(Option<String>):
    required: true
    

    A friendly name or description for the metrics for this RateBasedRule. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can’t contain whitespace or metric names reserved for AWS WAF, including “All” and “Default_Action.” You can’t change the name of the metric after you create the RateBasedRule.

    
    
  • rate_key(RateKey) / set_rate_key(Option<RateKey>):
    required: true
    

    The field that AWS WAF uses to determine if requests are likely arriving from a single source and thus subject to rate monitoring. The only valid value for RateKey is IP. IP indicates that requests that arrive from the same IP address are subject to the RateLimit that is specified in the RateBasedRule.

    
    
  • rate_limit(i64) / set_rate_limit(Option<i64>):
    required: true
    

    The maximum number of requests, which have an identical value in the field that is specified by RateKey, allowed in a five-minute period. If the number of requests exceeds the RateLimit and the other predicates specified in the rule are also met, AWS WAF triggers the action that is specified for this rule.

    
    
  • change_token(impl Into<String>) / set_change_token(Option<String>):
    required: true
    

    The ChangeToken that you used to submit the CreateRateBasedRule request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    
    
    
• On success, responds with CreateRateBasedRuleOutput with field(s):
  • rule(Option<RateBasedRule>):

    The RateBasedRule that is returned in the CreateRateBasedRule response.

  • change_token(Option<String>):

    The ChangeToken that you used to submit the CreateRateBasedRule request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

• On failure, responds with SdkError<CreateRateBasedRuleError>

impl Client

pub fn create_regex_match_set(&self) -> CreateRegexMatchSetFluentBuilder

Constructs a fluent builder for the CreateRegexMatchSet operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    A friendly name or description of the RegexMatchSet. You can’t change Name after you create a RegexMatchSet.

    
    
  • change_token(impl Into<String>) / set_change_token(Option<String>):
    required: true
    

    The value returned by the most recent call to GetChangeToken.

    
    
• On success, responds with CreateRegexMatchSetOutput with field(s):
  • regex_match_set(Option<RegexMatchSet>):

    A RegexMatchSet that contains no RegexMatchTuple objects.

  • change_token(Option<String>):

    The ChangeToken that you used to submit the CreateRegexMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

• On failure, responds with SdkError<CreateRegexMatchSetError>

impl Client

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: true
    

    A friendly name or description of the RegexPatternSet. You can’t change Name after you create a RegexPatternSet.

    
    
  • change_token(impl Into<String>) / set_change_token(Option<String>):
    required: true
    

    The value returned by the most recent call to GetChangeToken.

    
    
• On success, responds with CreateRegexPatternSetOutput with field(s):
  • regex_pattern_set(Option<RegexPatternSet>):

    A RegexPatternSet that contains no objects.

  • change_token(Option<String>):

    The ChangeToken that you used to submit the CreateRegexPatternSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

• On failure, responds with SdkError<CreateRegexPatternSetError>

impl Client

pub fn create_rule(&self) -> CreateRuleFluentBuilder

Constructs a fluent builder for the CreateRule operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    A friendly name or description of the Rule. You can’t change the name of a Rule after you create it.

    
    
  • metric_name(impl Into<String>) / set_metric_name(Option<String>):
    required: true
    

    A friendly name or description for the metrics for this Rule. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can’t contain whitespace or metric names reserved for AWS WAF, including “All” and “Default_Action.” You can’t change the name of the metric after you create the Rule.

    
    
  • change_token(impl Into<String>) / set_change_token(Option<String>):
    required: true
    

    The value returned by the most recent call to GetChangeToken.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    
    
    
• On success, responds with CreateRuleOutput with field(s):
  • rule(Option<Rule>):

    The Rule returned in the CreateRule response.

  • change_token(Option<String>):

    The ChangeToken that you used to submit the CreateRule request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

• On failure, responds with SdkError<CreateRuleError>

impl Client

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: true
    

    A friendly name or description of the RuleGroup. You can’t change Name after you create a RuleGroup.

    
    
  • metric_name(impl Into<String>) / set_metric_name(Option<String>):
    required: true
    

    A friendly name or description for the metrics for this RuleGroup. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can’t contain whitespace or metric names reserved for AWS WAF, including “All” and “Default_Action.” You can’t change the name of the metric after you create the RuleGroup.

    
    
  • change_token(impl Into<String>) / set_change_token(Option<String>):
    required: true
    

    The value returned by the most recent call to GetChangeToken.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    
    
    
• On success, responds with CreateRuleGroupOutput with field(s):
  • rule_group(Option<RuleGroup>):

    An empty RuleGroup.

  • change_token(Option<String>):

    The ChangeToken that you used to submit the CreateRuleGroup request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

• On failure, responds with SdkError<CreateRuleGroupError>

impl Client

pub fn create_size_constraint_set(&self) -> CreateSizeConstraintSetFluentBuilder

Constructs a fluent builder for the CreateSizeConstraintSet operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    A friendly name or description of the SizeConstraintSet. You can’t change Name after you create a SizeConstraintSet.

    
    
  • change_token(impl Into<String>) / set_change_token(Option<String>):
    required: true
    

    The value returned by the most recent call to GetChangeToken.

    
    
• On success, responds with CreateSizeConstraintSetOutput with field(s):
  • size_constraint_set(Option<SizeConstraintSet>):

    A SizeConstraintSet that contains no SizeConstraint objects.

  • change_token(Option<String>):

    The ChangeToken that you used to submit the CreateSizeConstraintSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

• On failure, responds with SdkError<CreateSizeConstraintSetError>

impl Client

pub fn create_sql_injection_match_set( &self, ) -> CreateSqlInjectionMatchSetFluentBuilder

Constructs a fluent builder for the CreateSqlInjectionMatchSet operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    A friendly name or description for the SqlInjectionMatchSet that you’re creating. You can’t change Name after you create the SqlInjectionMatchSet.

    
    
  • change_token(impl Into<String>) / set_change_token(Option<String>):
    required: true
    

    The value returned by the most recent call to GetChangeToken.

    
    
• On success, responds with CreateSqlInjectionMatchSetOutput with field(s):
  • sql_injection_match_set(Option<SqlInjectionMatchSet>):

    A SqlInjectionMatchSet.

  • change_token(Option<String>):

    The ChangeToken that you used to submit the CreateSqlInjectionMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

• On failure, responds with SdkError<CreateSqlInjectionMatchSetError>

impl Client

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: true
    

    A friendly name or description of the WebACL. You can’t change Name after you create the WebACL.

    
    
  • metric_name(impl Into<String>) / set_metric_name(Option<String>):
    required: true
    

    A friendly name or description for the metrics for this WebACL.The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can’t contain whitespace or metric names reserved for AWS WAF, including “All” and “Default_Action.” You can’t change MetricName after you create the WebACL.

    
    
  • default_action(WafAction) / set_default_action(Option<WafAction>):
    required: true
    

    The action that you want AWS WAF to take when a request doesn’t match the criteria specified in any of the Rule objects that are associated with the WebACL.

    
    
  • change_token(impl Into<String>) / set_change_token(Option<String>):
    required: true
    

    The value returned by the most recent call to GetChangeToken.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    
    
    
• On success, responds with CreateWebAclOutput with field(s):
  • web_acl(Option<WebAcl>):

    The WebACL returned in the CreateWebACL response.

  • change_token(Option<String>):

    The ChangeToken that you used to submit the CreateWebACL request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

• On failure, responds with SdkError<CreateWebACLError>

impl Client

pub fn create_web_acl_migration_stack( &self, ) -> CreateWebACLMigrationStackFluentBuilder

Constructs a fluent builder for the CreateWebACLMigrationStack operation.

• The fluent builder is configurable:
  • web_acl_id(impl Into<String>) / set_web_acl_id(Option<String>):
    required: true
    

    The UUID of the WAF Classic web ACL that you want to migrate to WAF v2.

    
    
  • s3_bucket_name(impl Into<String>) / set_s3_bucket_name(Option<String>):
    required: true
    

    The name of the Amazon S3 bucket to store the CloudFormation template in. The S3 bucket must be configured as follows for the migration:

    • The bucket name must start with aws-waf-migration-. For example, aws-waf-migration-my-web-acl.

    • The bucket must be in the Region where you are deploying the template. For example, for a web ACL in us-west-2, you must use an Amazon S3 bucket in us-west-2 and you must deploy the template stack to us-west-2.

    • The bucket policies must permit the migration process to write data. For listings of the bucket policies, see the Examples section.

    
    
  • ignore_unsupported_type(bool) / set_ignore_unsupported_type(Option<bool>):
    required: true
    

    Indicates whether to exclude entities that can’t be migrated or to stop the migration. Set this to true to ignore unsupported entities in the web ACL during the migration. Otherwise, if AWS WAF encounters unsupported entities, it stops the process and throws an exception.

    
    
• On success, responds with CreateWebAclMigrationStackOutput with field(s):
  • s3_object_url(String):

    The URL of the template created in Amazon S3.

• On failure, responds with SdkError<CreateWebACLMigrationStackError>

impl Client

pub fn create_xss_match_set(&self) -> CreateXssMatchSetFluentBuilder

Constructs a fluent builder for the CreateXssMatchSet operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    A friendly name or description for the XssMatchSet that you’re creating. You can’t change Name after you create the XssMatchSet.

    
    
  • change_token(impl Into<String>) / set_change_token(Option<String>):
    required: true
    

    The value returned by the most recent call to GetChangeToken.

    
    
• On success, responds with CreateXssMatchSetOutput with field(s):
  • xss_match_set(Option<XssMatchSet>):

    An XssMatchSet.

  • change_token(Option<String>):

    The ChangeToken that you used to submit the CreateXssMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

• On failure, responds with SdkError<CreateXssMatchSetError>

impl Client

pub fn delete_byte_match_set(&self) -> DeleteByteMatchSetFluentBuilder

Constructs a fluent builder for the DeleteByteMatchSet operation.

• The fluent builder is configurable:
  • byte_match_set_id(impl Into<String>) / set_byte_match_set_id(Option<String>):
    required: true
    

    The ByteMatchSetId of the ByteMatchSet that you want to delete. ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets.

    
    
  • change_token(impl Into<String>) / set_change_token(Option<String>):
    required: true
    

    The value returned by the most recent call to GetChangeToken.

    
    
• On success, responds with DeleteByteMatchSetOutput with field(s):
  • change_token(Option<String>):

    The ChangeToken that you used to submit the DeleteByteMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

• On failure, responds with SdkError<DeleteByteMatchSetError>

impl Client

pub fn delete_geo_match_set(&self) -> DeleteGeoMatchSetFluentBuilder

Constructs a fluent builder for the DeleteGeoMatchSet operation.

• The fluent builder is configurable:
  • geo_match_set_id(impl Into<String>) / set_geo_match_set_id(Option<String>):
    required: true
    

    The GeoMatchSetID of the GeoMatchSet that you want to delete. GeoMatchSetId is returned by CreateGeoMatchSet and by ListGeoMatchSets.

    
    
  • change_token(impl Into<String>) / set_change_token(Option<String>):
    required: true
    

    The value returned by the most recent call to GetChangeToken.

    
    
• On success, responds with DeleteGeoMatchSetOutput with field(s):
  • change_token(Option<String>):

    The ChangeToken that you used to submit the DeleteGeoMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

• On failure, responds with SdkError<DeleteGeoMatchSetError>

impl Client

pub fn delete_ip_set(&self) -> DeleteIPSetFluentBuilder

Constructs a fluent builder for the DeleteIPSet operation.

• The fluent builder is configurable:
  • ip_set_id(impl Into<String>) / set_ip_set_id(Option<String>):
    required: true
    

    The IPSetId of the IPSet that you want to delete. IPSetId is returned by CreateIPSet and by ListIPSets.

    
    
  • change_token(impl Into<String>) / set_change_token(Option<String>):
    required: true
    

    The value returned by the most recent call to GetChangeToken.

    
    
• On success, responds with DeleteIpSetOutput with field(s):
  • change_token(Option<String>):

    The ChangeToken that you used to submit the DeleteIPSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

• On failure, responds with SdkError<DeleteIPSetError>

impl Client

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: true
    

    The 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>

impl Client

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: true
    

    The Amazon Resource Name (ARN) of the RuleGroup from which you want to delete the policy.

    The user making the request must be the owner of the RuleGroup.

    
    
• On success, responds with DeletePermissionPolicyOutput
• On failure, responds with SdkError<DeletePermissionPolicyError>

impl Client

pub fn delete_rate_based_rule(&self) -> DeleteRateBasedRuleFluentBuilder

Constructs a fluent builder for the DeleteRateBasedRule operation.

• The fluent builder is configurable:
  • rule_id(impl Into<String>) / set_rule_id(Option<String>):
    required: true
    

    The RuleId of the RateBasedRule that you want to delete. RuleId is returned by CreateRateBasedRule and by ListRateBasedRules.

    
    
  • change_token(impl Into<String>) / set_change_token(Option<String>):
    required: true
    

    The value returned by the most recent call to GetChangeToken.

    
    
• On success, responds with DeleteRateBasedRuleOutput with field(s):
  • change_token(Option<String>):

    The ChangeToken that you used to submit the DeleteRateBasedRule request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

• On failure, responds with SdkError<DeleteRateBasedRuleError>

impl Client

pub fn delete_regex_match_set(&self) -> DeleteRegexMatchSetFluentBuilder

Constructs a fluent builder for the DeleteRegexMatchSet operation.

• The fluent builder is configurable:
  • regex_match_set_id(impl Into<String>) / set_regex_match_set_id(Option<String>):
    required: true
    

    The RegexMatchSetId of the RegexMatchSet that you want to delete. RegexMatchSetId is returned by CreateRegexMatchSet and by ListRegexMatchSets.

    
    
  • change_token(impl Into<String>) / set_change_token(Option<String>):
    required: true
    

    The value returned by the most recent call to GetChangeToken.

    
    
• On success, responds with DeleteRegexMatchSetOutput with field(s):
  • change_token(Option<String>):

    The ChangeToken that you used to submit the DeleteRegexMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

• On failure, responds with SdkError<DeleteRegexMatchSetError>

impl Client

pub fn delete_regex_pattern_set(&self) -> DeleteRegexPatternSetFluentBuilder

Constructs a fluent builder for the DeleteRegexPatternSet operation.

• The fluent builder is configurable:
  • regex_pattern_set_id(impl Into<String>) / set_regex_pattern_set_id(Option<String>):
    required: true
    

    The RegexPatternSetId of the RegexPatternSet that you want to delete. RegexPatternSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets.

    
    
  • change_token(impl Into<String>) / set_change_token(Option<String>):
    required: true
    

    The value returned by the most recent call to GetChangeToken.

    
    
• On success, responds with DeleteRegexPatternSetOutput with field(s):
  • change_token(Option<String>):

    The ChangeToken that you used to submit the DeleteRegexPatternSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

• On failure, responds with SdkError<DeleteRegexPatternSetError>

impl Client

pub fn delete_rule(&self) -> DeleteRuleFluentBuilder

Constructs a fluent builder for the DeleteRule operation.

• The fluent builder is configurable:
  • rule_id(impl Into<String>) / set_rule_id(Option<String>):
    required: true
    

    The RuleId of the Rule that you want to delete. RuleId is returned by CreateRule and by ListRules.

    
    
  • change_token(impl Into<String>) / set_change_token(Option<String>):
    required: true
    

    The value returned by the most recent call to GetChangeToken.

    
    
• On success, responds with DeleteRuleOutput with field(s):
  • change_token(Option<String>):

    The ChangeToken that you used to submit the DeleteRule request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

• On failure, responds with SdkError<DeleteRuleError>

impl Client

pub fn delete_rule_group(&self) -> DeleteRuleGroupFluentBuilder

Constructs a fluent builder for the DeleteRuleGroup operation.

• The fluent builder is configurable:
  • rule_group_id(impl Into<String>) / set_rule_group_id(Option<String>):
    required: true
    

    The RuleGroupId of the RuleGroup that you want to delete. RuleGroupId is returned by CreateRuleGroup and by ListRuleGroups.

    
    
  • change_token(impl Into<String>) / set_change_token(Option<String>):
    required: true
    

    The value returned by the most recent call to GetChangeToken.

    
    
• On success, responds with DeleteRuleGroupOutput with field(s):
  • change_token(Option<String>):

    The ChangeToken that you used to submit the DeleteRuleGroup request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

• On failure, responds with SdkError<DeleteRuleGroupError>

impl Client

pub fn delete_size_constraint_set(&self) -> DeleteSizeConstraintSetFluentBuilder

Constructs a fluent builder for the DeleteSizeConstraintSet operation.

• The fluent builder is configurable:
  • size_constraint_set_id(impl Into<String>) / set_size_constraint_set_id(Option<String>):
    required: true
    

    The SizeConstraintSetId of the SizeConstraintSet that you want to delete. SizeConstraintSetId is returned by CreateSizeConstraintSet and by ListSizeConstraintSets.

    
    
  • change_token(impl Into<String>) / set_change_token(Option<String>):
    required: true
    

    The value returned by the most recent call to GetChangeToken.

    
    
• On success, responds with DeleteSizeConstraintSetOutput with field(s):
  • change_token(Option<String>):

    The ChangeToken that you used to submit the DeleteSizeConstraintSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

• On failure, responds with SdkError<DeleteSizeConstraintSetError>

impl Client

pub fn delete_sql_injection_match_set( &self, ) -> DeleteSqlInjectionMatchSetFluentBuilder

Constructs a fluent builder for the DeleteSqlInjectionMatchSet operation.

• The fluent builder is configurable:
  • sql_injection_match_set_id(impl Into<String>) / set_sql_injection_match_set_id(Option<String>):
    required: true
    

    The SqlInjectionMatchSetId of the SqlInjectionMatchSet that you want to delete. SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by ListSqlInjectionMatchSets.

    
    
  • change_token(impl Into<String>) / set_change_token(Option<String>):
    required: true
    

    The value returned by the most recent call to GetChangeToken.

    
    
• On success, responds with DeleteSqlInjectionMatchSetOutput with field(s):
  • change_token(Option<String>):

    The ChangeToken that you used to submit the DeleteSqlInjectionMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

• On failure, responds with SdkError<DeleteSqlInjectionMatchSetError>

impl Client

pub fn delete_web_acl(&self) -> DeleteWebACLFluentBuilder

Constructs a fluent builder for the DeleteWebACL operation.

• The fluent builder is configurable:
  • web_acl_id(impl Into<String>) / set_web_acl_id(Option<String>):
    required: true
    

    The WebACLId of the WebACL that you want to delete. WebACLId is returned by CreateWebACL and by ListWebACLs.

    
    
  • change_token(impl Into<String>) / set_change_token(Option<String>):
    required: true
    

    The value returned by the most recent call to GetChangeToken.

    
    
• On success, responds with DeleteWebAclOutput with field(s):
  • change_token(Option<String>):

    The ChangeToken that you used to submit the DeleteWebACL request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

• On failure, responds with SdkError<DeleteWebACLError>

impl Client

pub fn delete_xss_match_set(&self) -> DeleteXssMatchSetFluentBuilder

Constructs a fluent builder for the DeleteXssMatchSet operation.

• The fluent builder is configurable:
  • xss_match_set_id(impl Into<String>) / set_xss_match_set_id(Option<String>):
    required: true
    

    The XssMatchSetId of the XssMatchSet that you want to delete. XssMatchSetId is returned by CreateXssMatchSet and by ListXssMatchSets.

    
    
  • change_token(impl Into<String>) / set_change_token(Option<String>):
    required: true
    

    The value returned by the most recent call to GetChangeToken.

    
    
• On success, responds with DeleteXssMatchSetOutput with field(s):
  • change_token(Option<String>):

    The ChangeToken that you used to submit the DeleteXssMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

• On failure, responds with SdkError<DeleteXssMatchSetError>

impl Client

pub fn get_byte_match_set(&self) -> GetByteMatchSetFluentBuilder

Constructs a fluent builder for the GetByteMatchSet operation.

• The fluent builder is configurable:
  • byte_match_set_id(impl Into<String>) / set_byte_match_set_id(Option<String>):
    required: true
    

    The ByteMatchSetId of the ByteMatchSet that you want to get. ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets.

    
    
• On success, responds with GetByteMatchSetOutput with field(s):
  • byte_match_set(Option<ByteMatchSet>):

    Information about the ByteMatchSet that you specified in the GetByteMatchSet request. For more information, see the following topics:

    • ByteMatchSet: Contains ByteMatchSetId, ByteMatchTuples, and Name

    • ByteMatchTuples: Contains an array of ByteMatchTuple objects. Each ByteMatchTuple object contains FieldToMatch, PositionalConstraint, TargetString, and TextTransformation

    • FieldToMatch: Contains Data and Type

• On failure, responds with SdkError<GetByteMatchSetError>

impl Client

pub fn get_change_token(&self) -> GetChangeTokenFluentBuilder

Constructs a fluent builder for the GetChangeToken operation.

• The fluent builder takes no input, just send it.
• On success, responds with GetChangeTokenOutput with field(s):
  • change_token(Option<String>):

    The ChangeToken that you used in the request. Use this value in a GetChangeTokenStatus request to get the current status of the request.

• On failure, responds with SdkError<GetChangeTokenError>

impl Client

pub fn get_change_token_status(&self) -> GetChangeTokenStatusFluentBuilder

Constructs a fluent builder for the GetChangeTokenStatus operation.

• The fluent builder is configurable:
  • change_token(impl Into<String>) / set_change_token(Option<String>):
    required: true
    

    The change token for which you want to get the status. This change token was previously returned in the GetChangeToken response.

    
    
• On success, responds with GetChangeTokenStatusOutput with field(s):
  • change_token_status(Option<ChangeTokenStatus>):

    The status of the change token.

• On failure, responds with SdkError<GetChangeTokenStatusError>

impl Client

pub fn get_geo_match_set(&self) -> GetGeoMatchSetFluentBuilder

Constructs a fluent builder for the GetGeoMatchSet operation.

• The fluent builder is configurable:
  • geo_match_set_id(impl Into<String>) / set_geo_match_set_id(Option<String>):
    required: true
    

    The GeoMatchSetId of the GeoMatchSet that you want to get. GeoMatchSetId is returned by CreateGeoMatchSet and by ListGeoMatchSets.

    
    
• On success, responds with GetGeoMatchSetOutput with field(s):
  • geo_match_set(Option<GeoMatchSet>):

    Information about the GeoMatchSet that you specified in the GetGeoMatchSet request. This includes the Type, which for a GeoMatchContraint is always Country, as well as the Value, which is the identifier for a specific country.

• On failure, responds with SdkError<GetGeoMatchSetError>

impl Client

pub fn get_ip_set(&self) -> GetIPSetFluentBuilder

Constructs a fluent builder for the GetIPSet operation.

• The fluent builder is configurable:
  • ip_set_id(impl Into<String>) / set_ip_set_id(Option<String>):
    required: true
    

    The IPSetId of the IPSet that you want to get. IPSetId is returned by CreateIPSet and by ListIPSets.

    
    
• On success, responds with GetIpSetOutput with field(s):
  • ip_set(Option<IpSet>):

    Information about the IPSet that you specified in the GetIPSet request. For more information, see the following topics:

    • IPSet: Contains IPSetDescriptors, IPSetId, and Name

    • IPSetDescriptors: Contains an array of IPSetDescriptor objects. Each IPSetDescriptor object contains Type and Value

• On failure, responds with SdkError<GetIPSetError>

impl Client

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: true
    

    The Amazon Resource Name (ARN) of the web ACL for which you want to get the LoggingConfiguration.

    
    
• On success, responds with GetLoggingConfigurationOutput with field(s):
  • logging_configuration(Option<LoggingConfiguration>):

    The LoggingConfiguration for the specified web ACL.

• On failure, responds with SdkError<GetLoggingConfigurationError>

impl Client

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: true
    

    The Amazon Resource Name (ARN) of the RuleGroup for which you want to get the policy.

    
    
• On success, responds with GetPermissionPolicyOutput with field(s):
  • policy(Option<String>):

    The IAM policy attached to the specified RuleGroup.

• On failure, responds with SdkError<GetPermissionPolicyError>

impl Client

pub fn get_rate_based_rule(&self) -> GetRateBasedRuleFluentBuilder

Constructs a fluent builder for the GetRateBasedRule operation.

• The fluent builder is configurable:
  • rule_id(impl Into<String>) / set_rule_id(Option<String>):
    required: true
    

    The RuleId of the RateBasedRule that you want to get. RuleId is returned by CreateRateBasedRule and by ListRateBasedRules.

    
    
• On success, responds with GetRateBasedRuleOutput with field(s):
  • rule(Option<RateBasedRule>):

    Information about the RateBasedRule that you specified in the GetRateBasedRule request.

• On failure, responds with SdkError<GetRateBasedRuleError>

impl Client

pub fn get_rate_based_rule_managed_keys( &self, ) -> GetRateBasedRuleManagedKeysFluentBuilder

Constructs a fluent builder for the GetRateBasedRuleManagedKeys operation.

• The fluent builder is configurable:
  • rule_id(impl Into<String>) / set_rule_id(Option<String>):
    required: true
    

    The RuleId of the RateBasedRule for which you want to get a list of ManagedKeys. RuleId is returned by CreateRateBasedRule and by ListRateBasedRules.

    
    
  • next_marker(impl Into<String>) / set_next_marker(Option<String>):
    required: false
    

    A null value and not currently used. Do not include this in your request.

    
    
• On success, responds with GetRateBasedRuleManagedKeysOutput with field(s):
  • managed_keys(Option<Vec::<String>>):

    An array of IP addresses that currently are blocked by the specified RateBasedRule.

  • next_marker(Option<String>):

    A null value and not currently used.

• On failure, responds with SdkError<GetRateBasedRuleManagedKeysError>

impl Client

pub fn get_regex_match_set(&self) -> GetRegexMatchSetFluentBuilder

Constructs a fluent builder for the GetRegexMatchSet operation.

• The fluent builder is configurable:
  • regex_match_set_id(impl Into<String>) / set_regex_match_set_id(Option<String>):
    required: true
    

    The RegexMatchSetId of the RegexMatchSet that you want to get. RegexMatchSetId is returned by CreateRegexMatchSet and by ListRegexMatchSets.

    
    
• On success, responds with GetRegexMatchSetOutput with field(s):
  • regex_match_set(Option<RegexMatchSet>):

    Information about the RegexMatchSet that you specified in the GetRegexMatchSet request. For more information, see RegexMatchTuple.

• On failure, responds with SdkError<GetRegexMatchSetError>

impl Client

pub fn get_regex_pattern_set(&self) -> GetRegexPatternSetFluentBuilder

Constructs a fluent builder for the GetRegexPatternSet operation.

• The fluent builder is configurable:
  • regex_pattern_set_id(impl Into<String>) / set_regex_pattern_set_id(Option<String>):
    required: true
    

    The RegexPatternSetId of the RegexPatternSet that you want to get. RegexPatternSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets.

    
    
• On success, responds with GetRegexPatternSetOutput with field(s):
  • regex_pattern_set(Option<RegexPatternSet>):

    Information about the RegexPatternSet that you specified in the GetRegexPatternSet request, including the identifier of the pattern set and the regular expression patterns you want AWS WAF to search for.

• On failure, responds with SdkError<GetRegexPatternSetError>

impl Client

pub fn get_rule(&self) -> GetRuleFluentBuilder

Constructs a fluent builder for the GetRule operation.

• The fluent builder is configurable:
  • rule_id(impl Into<String>) / set_rule_id(Option<String>):
    required: true
    

    The RuleId of the Rule that you want to get. RuleId is returned by CreateRule and by ListRules.

    
    
• On success, responds with GetRuleOutput with field(s):
  • rule(Option<Rule>):

    Information about the Rule that you specified in the GetRule request. For more information, see the following topics:

    • Rule: Contains MetricName, Name, an array of Predicate objects, and RuleId

    • Predicate: Each Predicate object contains DataId, Negated, and Type

• On failure, responds with SdkError<GetRuleError>

impl Client

pub fn get_rule_group(&self) -> GetRuleGroupFluentBuilder

Constructs a fluent builder for the GetRuleGroup operation.

• The fluent builder is configurable:
  • rule_group_id(impl Into<String>) / set_rule_group_id(Option<String>):
    required: true
    

    The RuleGroupId of the RuleGroup that you want to get. RuleGroupId is returned by CreateRuleGroup and by ListRuleGroups.

    
    
• On success, responds with GetRuleGroupOutput with field(s):
  • rule_group(Option<RuleGroup>):

    Information about the RuleGroup that you specified in the GetRuleGroup request.

• On failure, responds with SdkError<GetRuleGroupError>

impl Client

pub fn get_sampled_requests(&self) -> GetSampledRequestsFluentBuilder

Constructs a fluent builder for the GetSampledRequests operation.

• The fluent builder is configurable:
  • web_acl_id(impl Into<String>) / set_web_acl_id(Option<String>):
    required: true
    

    The WebACLId of the WebACL for which you want GetSampledRequests to return a sample of requests.

    
    
  • rule_id(impl Into<String>) / set_rule_id(Option<String>):
    required: true
    

    RuleId is one of three values:

    • The RuleId of the Rule or the RuleGroupId of the RuleGroup for which you want GetSampledRequests to return a sample of requests.

    • Default_Action, which causes GetSampledRequests to return a sample of the requests that didn’t match any of the rules in the specified WebACL.

    
    
  • time_window(TimeWindow) / set_time_window(Option<TimeWindow>):
    required: true
    

    The start date and time and the end date and time of the range for which you want GetSampledRequests to 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.

    
    
  • max_items(i64) / set_max_items(Option<i64>):
    required: true
    

    The number of requests that you want AWS WAF to return from among the first 5,000 requests that your AWS resource received during the time range. If your resource received fewer requests than the value of MaxItems, GetSampledRequests returns information about all of them.

    
    
• On success, responds with GetSampledRequestsOutput with 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 GetSampledRequests got a sample of MaxItems requests. If PopulationSize is less than MaxItems, the sample includes every request that your AWS resource received during the specified time range.

  • time_window(Option<TimeWindow>):

    Usually, TimeWindow is the time range that you specified in the GetSampledRequests request. However, if your AWS resource received more than 5,000 requests during the time range that you specified in the request, GetSampledRequests returns the time range for the first 5,000 requests. Times are in Coordinated Universal Time (UTC) format.

• On failure, responds with SdkError<GetSampledRequestsError>

impl Client

pub fn get_size_constraint_set(&self) -> GetSizeConstraintSetFluentBuilder

Constructs a fluent builder for the GetSizeConstraintSet operation.

• The fluent builder is configurable:
  • size_constraint_set_id(impl Into<String>) / set_size_constraint_set_id(Option<String>):
    required: true
    

    The SizeConstraintSetId of the SizeConstraintSet that you want to get. SizeConstraintSetId is returned by CreateSizeConstraintSet and by ListSizeConstraintSets.

    
    
• On success, responds with GetSizeConstraintSetOutput with field(s):
  • size_constraint_set(Option<SizeConstraintSet>):

    Information about the SizeConstraintSet that you specified in the GetSizeConstraintSet request. For more information, see the following topics:

    • SizeConstraintSet: Contains SizeConstraintSetId, SizeConstraints, and Name

    • SizeConstraints: Contains an array of SizeConstraint objects. Each SizeConstraint object contains FieldToMatch, TextTransformation, ComparisonOperator, and Size

    • FieldToMatch: Contains Data and Type

• On failure, responds with SdkError<GetSizeConstraintSetError>

impl Client

pub fn get_sql_injection_match_set( &self, ) -> GetSqlInjectionMatchSetFluentBuilder

Constructs a fluent builder for the GetSqlInjectionMatchSet operation.

• The fluent builder is configurable:
  • sql_injection_match_set_id(impl Into<String>) / set_sql_injection_match_set_id(Option<String>):
    required: true
    

    The SqlInjectionMatchSetId of the SqlInjectionMatchSet that you want to get. SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by ListSqlInjectionMatchSets.

    
    
• On success, responds with GetSqlInjectionMatchSetOutput with field(s):
  • sql_injection_match_set(Option<SqlInjectionMatchSet>):

    Information about the SqlInjectionMatchSet that you specified in the GetSqlInjectionMatchSet request. For more information, see the following topics:

    • SqlInjectionMatchSet: Contains Name, SqlInjectionMatchSetId, and an array of SqlInjectionMatchTuple objects

    • SqlInjectionMatchTuple: Each SqlInjectionMatchTuple object contains FieldToMatch and TextTransformation

    • FieldToMatch: Contains Data and Type

• On failure, responds with SdkError<GetSqlInjectionMatchSetError>

impl Client

pub fn get_web_acl(&self) -> GetWebACLFluentBuilder

Constructs a fluent builder for the GetWebACL operation.

• The fluent builder is configurable:
  • web_acl_id(impl Into<String>) / set_web_acl_id(Option<String>):
    required: true
    

    The WebACLId of the WebACL that you want to get. WebACLId is returned by CreateWebACL and by ListWebACLs.

    
    
• On success, responds with GetWebAclOutput with field(s):
  • web_acl(Option<WebAcl>):

    Information about the WebACL that you specified in the GetWebACL request. For more information, see the following topics:

    • WebACL: Contains DefaultAction, MetricName, Name, an array of Rule objects, and WebACLId

    • DefaultAction (Data type is WafAction): Contains Type

    • Rules: Contains an array of ActivatedRule objects, which contain Action, Priority, and RuleId

    • Action: Contains Type

• On failure, responds with SdkError<GetWebACLError>

impl Client

pub fn get_xss_match_set(&self) -> GetXssMatchSetFluentBuilder

Constructs a fluent builder for the GetXssMatchSet operation.

• The fluent builder is configurable:
  • xss_match_set_id(impl Into<String>) / set_xss_match_set_id(Option<String>):
    required: true
    

    The XssMatchSetId of the XssMatchSet that you want to get. XssMatchSetId is returned by CreateXssMatchSet and by ListXssMatchSets.

    
    
• On success, responds with GetXssMatchSetOutput with field(s):
  • xss_match_set(Option<XssMatchSet>):

    Information about the XssMatchSet that you specified in the GetXssMatchSet request. For more information, see the following topics:

    • XssMatchSet: Contains Name, XssMatchSetId, and an array of XssMatchTuple objects

    • XssMatchTuple: Each XssMatchTuple object contains FieldToMatch and TextTransformation

    • FieldToMatch: Contains Data and Type

• On failure, responds with SdkError<GetXssMatchSetError>

impl Client

pub fn list_activated_rules_in_rule_group( &self, ) -> ListActivatedRulesInRuleGroupFluentBuilder

Constructs a fluent builder for the ListActivatedRulesInRuleGroup operation.

• The fluent builder is configurable:
  • rule_group_id(impl Into<String>) / set_rule_group_id(Option<String>):
    required: false
    

    The RuleGroupId of the RuleGroup for which you want to get a list of ActivatedRule objects.

    
    
  • next_marker(impl Into<String>) / set_next_marker(Option<String>):
    required: false
    

    If you specify a value for Limit and you have more ActivatedRules than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of ActivatedRules. For the second and subsequent ListActivatedRulesInRuleGroup requests, specify the value of NextMarker from the previous response to get information about another batch of ActivatedRules.

    
    
  • limit(i32) / set_limit(Option<i32>):
    required: false
    

    Specifies the number of ActivatedRules that you want AWS WAF to return for this request. If you have more ActivatedRules than the number that you specify for Limit, the response includes a NextMarker value that you can use to get another batch of ActivatedRules.

    
    
• On success, responds with ListActivatedRulesInRuleGroupOutput with field(s):
  • next_marker(Option<String>):

    If you have more ActivatedRules than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more ActivatedRules, submit another ListActivatedRulesInRuleGroup request, and specify the NextMarker value from the response in the NextMarker value in the next request.

  • activated_rules(Option<Vec::<ActivatedRule>>):

    An array of ActivatedRules objects.

• On failure, responds with SdkError<ListActivatedRulesInRuleGroupError>

impl Client

pub fn list_byte_match_sets(&self) -> ListByteMatchSetsFluentBuilder

Constructs a fluent builder for the ListByteMatchSets operation.

• The fluent builder is configurable:
  • next_marker(impl Into<String>) / set_next_marker(Option<String>):
    required: false
    

    If you specify a value for Limit and you have more ByteMatchSets than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of ByteMatchSets. For the second and subsequent ListByteMatchSets requests, specify the value of NextMarker from the previous response to get information about another batch of ByteMatchSets.

    
    
  • limit(i32) / set_limit(Option<i32>):
    required: false
    

    Specifies the number of ByteMatchSet objects that you want AWS WAF to return for this request. If you have more ByteMatchSets objects than the number you specify for Limit, the response includes a NextMarker value that you can use to get another batch of ByteMatchSet objects.

    
    
• On success, responds with ListByteMatchSetsOutput with field(s):
  • next_marker(Option<String>):

    If you have more ByteMatchSet objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more ByteMatchSet objects, submit another ListByteMatchSets request, and specify the NextMarker value from the response in the NextMarker value in the next request.

  • byte_match_sets(Option<Vec::<ByteMatchSetSummary>>):

    An array of ByteMatchSetSummary objects.

• On failure, responds with SdkError<ListByteMatchSetsError>

impl Client

pub fn list_geo_match_sets(&self) -> ListGeoMatchSetsFluentBuilder

Constructs a fluent builder for the ListGeoMatchSets operation.

• The fluent builder is configurable:
  • next_marker(impl Into<String>) / set_next_marker(Option<String>):
    required: false
    

    If you specify a value for Limit and you have more GeoMatchSets than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of GeoMatchSet objects. For the second and subsequent ListGeoMatchSets requests, specify the value of NextMarker from the previous response to get information about another batch of GeoMatchSet objects.

    
    
  • limit(i32) / set_limit(Option<i32>):
    required: false
    

    Specifies the number of GeoMatchSet objects that you want AWS WAF to return for this request. If you have more GeoMatchSet objects than the number you specify for Limit, the response includes a NextMarker value that you can use to get another batch of GeoMatchSet objects.

    
    
• On success, responds with ListGeoMatchSetsOutput with field(s):
  • next_marker(Option<String>):

    If you have more GeoMatchSet objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more GeoMatchSet objects, submit another ListGeoMatchSets request, and specify the NextMarker value from the response in the NextMarker value in the next request.

  • geo_match_sets(Option<Vec::<GeoMatchSetSummary>>):

    An array of GeoMatchSetSummary objects.

• On failure, responds with SdkError<ListGeoMatchSetsError>

impl Client

pub fn list_ip_sets(&self) -> ListIPSetsFluentBuilder

Constructs a fluent builder for the ListIPSets operation.

• The fluent builder is configurable:
  • next_marker(impl Into<String>) / set_next_marker(Option<String>):
    required: false
    

    AWS WAF returns a NextMarker value in the response that allows you to list another group of IPSets. For the second and subsequent ListIPSets requests, specify the value of NextMarker from the previous response to get information about another batch of IPSets.

    
    
  • limit(i32) / set_limit(Option<i32>):
    required: false
    

    Specifies the number of IPSet objects that you want AWS WAF to return for this request. If you have more IPSet objects than the number you specify for Limit, the response includes a NextMarker value that you can use to get another batch of IPSet objects.

    
    
• On success, responds with ListIpSetsOutput with field(s):
  • next_marker(Option<String>):

    To list more IPSet objects, submit another ListIPSets request, and in the next request use the NextMarker response value as the NextMarker value.

  • ip_sets(Option<Vec::<IpSetSummary>>):

    An array of IPSetSummary objects.

• On failure, responds with SdkError<ListIPSetsError>

impl Client

pub fn list_logging_configurations( &self, ) -> ListLoggingConfigurationsFluentBuilder

Constructs a fluent builder for the ListLoggingConfigurations operation.

• The fluent builder is configurable:
  • next_marker(impl Into<String>) / set_next_marker(Option<String>):
    required: false
    

    If you specify a value for Limit and you have more LoggingConfigurations than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of LoggingConfigurations. For the second and subsequent ListLoggingConfigurations requests, specify the value of NextMarker from the previous response to get information about another batch of ListLoggingConfigurations.

    
    
  • limit(i32) / set_limit(Option<i32>):
    required: false
    

    Specifies the number of LoggingConfigurations that you want AWS WAF to return for this request. If you have more LoggingConfigurations than the number that you specify for Limit, the response includes a NextMarker value that you can use to get another batch of LoggingConfigurations.

    
    
• On success, responds with ListLoggingConfigurationsOutput with field(s):
  • logging_configurations(Option<Vec::<LoggingConfiguration>>):

    An array of LoggingConfiguration objects.

  • next_marker(Option<String>):

    If you have more LoggingConfigurations than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more LoggingConfigurations, submit another ListLoggingConfigurations request, and specify the NextMarker value from the response in the NextMarker value in the next request.

• On failure, responds with SdkError<ListLoggingConfigurationsError>

impl Client

pub fn list_rate_based_rules(&self) -> ListRateBasedRulesFluentBuilder

Constructs a fluent builder for the ListRateBasedRules operation.

• The fluent builder is configurable:
  • next_marker(impl Into<String>) / set_next_marker(Option<String>):
    required: false
    

    If you specify a value for Limit and you have more Rules than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of Rules. For the second and subsequent ListRateBasedRules requests, specify the value of NextMarker from the previous response to get information about another batch of Rules.

    
    
  • limit(i32) / set_limit(Option<i32>):
    required: false
    

    Specifies the number of Rules that you want AWS WAF to return for this request. If you have more Rules than the number that you specify for Limit, the response includes a NextMarker value that you can use to get another batch of Rules.

    
    
• On success, responds with ListRateBasedRulesOutput with field(s):
  • next_marker(Option<String>):

    If you have more Rules than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more Rules, submit another ListRateBasedRules request, and specify the NextMarker value from the response in the NextMarker value in the next request.

  • rules(Option<Vec::<RuleSummary>>):

    An array of RuleSummary objects.

• On failure, responds with SdkError<ListRateBasedRulesError>

impl Client

pub fn list_regex_match_sets(&self) -> ListRegexMatchSetsFluentBuilder

Constructs a fluent builder for the ListRegexMatchSets operation.

• The fluent builder is configurable:
  • next_marker(impl Into<String>) / set_next_marker(Option<String>):
    required: false
    

    If you specify a value for Limit and you have more RegexMatchSet objects than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of ByteMatchSets. For the second and subsequent ListRegexMatchSets requests, specify the value of NextMarker from the previous response to get information about another batch of RegexMatchSet objects.

    
    
  • limit(i32) / set_limit(Option<i32>):
    required: false
    

    Specifies the number of RegexMatchSet objects that you want AWS WAF to return for this request. If you have more RegexMatchSet objects than the number you specify for Limit, the response includes a NextMarker value that you can use to get another batch of RegexMatchSet objects.

    
    
• On success, responds with ListRegexMatchSetsOutput with field(s):
  • next_marker(Option<String>):

    If you have more RegexMatchSet objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more RegexMatchSet objects, submit another ListRegexMatchSets request, and specify the NextMarker value from the response in the NextMarker value in the next request.

  • regex_match_sets(Option<Vec::<RegexMatchSetSummary>>):

    An array of RegexMatchSetSummary objects.

• On failure, responds with SdkError<ListRegexMatchSetsError>

impl Client

pub fn list_regex_pattern_sets(&self) -> ListRegexPatternSetsFluentBuilder

Constructs a fluent builder for the ListRegexPatternSets operation.

• The fluent builder is configurable:
  • next_marker(impl Into<String>) / set_next_marker(Option<String>):
    required: false
    

    If you specify a value for Limit and you have more RegexPatternSet objects than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of RegexPatternSet objects. For the second and subsequent ListRegexPatternSets requests, specify the value of NextMarker from the previous response to get information about another batch of RegexPatternSet objects.

    
    
  • limit(i32) / set_limit(Option<i32>):
    required: false
    

    Specifies the number of RegexPatternSet objects that you want AWS WAF to return for this request. If you have more RegexPatternSet objects than the number you specify for Limit, the response includes a NextMarker value that you can use to get another batch of RegexPatternSet objects.

    
    
• On success, responds with ListRegexPatternSetsOutput with field(s):
  • next_marker(Option<String>):

    If you have more RegexPatternSet objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more RegexPatternSet objects, submit another ListRegexPatternSets request, and specify the NextMarker value from the response in the NextMarker value in the next request.

  • regex_pattern_sets(Option<Vec::<RegexPatternSetSummary>>):

    An array of RegexPatternSetSummary objects.

• On failure, responds with SdkError<ListRegexPatternSetsError>

impl Client

pub fn list_rule_groups(&self) -> ListRuleGroupsFluentBuilder

Constructs a fluent builder for the ListRuleGroups operation.

• The fluent builder is configurable:
  • next_marker(impl Into<String>) / set_next_marker(Option<String>):
    required: false
    

    If you specify a value for Limit and you have more RuleGroups than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of RuleGroups. For the second and subsequent ListRuleGroups requests, specify the value of NextMarker from the previous response to get information about another batch of RuleGroups.

    
    
  • limit(i32) / set_limit(Option<i32>):
    required: false
    

    Specifies the number of RuleGroups that you want AWS WAF to return for this request. If you have more RuleGroups than the number that you specify for Limit, the response includes a NextMarker value that you can use to get another batch of RuleGroups.

    
    
• On success, responds with ListRuleGroupsOutput with field(s):
  • next_marker(Option<String>):

    If you have more RuleGroups than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more RuleGroups, submit another ListRuleGroups request, and specify the NextMarker value from the response in the NextMarker value in the next request.

  • rule_groups(Option<Vec::<RuleGroupSummary>>):

    An array of RuleGroup objects.

• On failure, responds with SdkError<ListRuleGroupsError>

impl Client

pub fn list_rules(&self) -> ListRulesFluentBuilder

Constructs a fluent builder for the ListRules operation.

• The fluent builder is configurable:
  • next_marker(impl Into<String>) / set_next_marker(Option<String>):
    required: false
    

    If you specify a value for Limit and you have more Rules than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of Rules. For the second and subsequent ListRules requests, specify the value of NextMarker from the previous response to get information about another batch of Rules.

    
    
  • limit(i32) / set_limit(Option<i32>):
    required: false
    

    Specifies the number of Rules that you want AWS WAF to return for this request. If you have more Rules than the number that you specify for Limit, the response includes a NextMarker value that you can use to get another batch of Rules.

    
    
• On success, responds with ListRulesOutput with field(s):
  • next_marker(Option<String>):

    If you have more Rules than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more Rules, submit another ListRules request, and specify the NextMarker value from the response in the NextMarker value in the next request.

  • rules(Option<Vec::<RuleSummary>>):

    An array of RuleSummary objects.

• On failure, responds with SdkError<ListRulesError>

impl Client

pub fn list_size_constraint_sets(&self) -> ListSizeConstraintSetsFluentBuilder

Constructs a fluent builder for the ListSizeConstraintSets operation.

• The fluent builder is configurable:
  • next_marker(impl Into<String>) / set_next_marker(Option<String>):
    required: false
    

    If you specify a value for Limit and you have more SizeConstraintSets than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of SizeConstraintSets. For the second and subsequent ListSizeConstraintSets requests, specify the value of NextMarker from the previous response to get information about another batch of SizeConstraintSets.

    
    
  • limit(i32) / set_limit(Option<i32>):
    required: false
    

    Specifies the number of SizeConstraintSet objects that you want AWS WAF to return for this request. If you have more SizeConstraintSets objects than the number you specify for Limit, the response includes a NextMarker value that you can use to get another batch of SizeConstraintSet objects.

    
    
• On success, responds with ListSizeConstraintSetsOutput with field(s):
  • next_marker(Option<String>):

    If you have more SizeConstraintSet objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more SizeConstraintSet objects, submit another ListSizeConstraintSets request, and specify the NextMarker value from the response in the NextMarker value in the next request.

  • size_constraint_sets(Option<Vec::<SizeConstraintSetSummary>>):

    An array of SizeConstraintSetSummary objects.

• On failure, responds with SdkError<ListSizeConstraintSetsError>

impl Client

pub fn list_sql_injection_match_sets( &self, ) -> ListSqlInjectionMatchSetsFluentBuilder

Constructs a fluent builder for the ListSqlInjectionMatchSets operation.

• The fluent builder is configurable:
  • next_marker(impl Into<String>) / set_next_marker(Option<String>):
    required: false
    

    If you specify a value for Limit and you have more SqlInjectionMatchSet objects than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of SqlInjectionMatchSets. For the second and subsequent ListSqlInjectionMatchSets requests, specify the value of NextMarker from the previous response to get information about another batch of SqlInjectionMatchSets.

    
    
  • limit(i32) / set_limit(Option<i32>):
    required: false
    

    Specifies the number of SqlInjectionMatchSet objects that you want AWS WAF to return for this request. If you have more SqlInjectionMatchSet objects than the number you specify for Limit, the response includes a NextMarker value that you can use to get another batch of Rules.

    
    
• On success, responds with ListSqlInjectionMatchSetsOutput with field(s):
  • next_marker(Option<String>):

    If you have more SqlInjectionMatchSet objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more SqlInjectionMatchSet objects, submit another ListSqlInjectionMatchSets request, and specify the NextMarker value from the response in the NextMarker value in the next request.

  • sql_injection_match_sets(Option<Vec::<SqlInjectionMatchSetSummary>>):

    An array of SqlInjectionMatchSetSummary objects.

• On failure, responds with SdkError<ListSqlInjectionMatchSetsError>

impl Client

pub fn list_subscribed_rule_groups( &self, ) -> ListSubscribedRuleGroupsFluentBuilder

Constructs a fluent builder for the ListSubscribedRuleGroups operation.

• The fluent builder is configurable:
  • next_marker(impl Into<String>) / set_next_marker(Option<String>):
    required: false
    

    If you specify a value for Limit and you have more ByteMatchSetssubscribed rule groups than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of subscribed rule groups. For the second and subsequent ListSubscribedRuleGroupsRequest requests, specify the value of NextMarker from the previous response to get information about another batch of subscribed rule groups.

    
    
  • limit(i32) / set_limit(Option<i32>):
    required: false
    

    Specifies the number of subscribed rule groups that you want AWS WAF to return for this request. If you have more objects than the number you specify for Limit, the response includes a NextMarker value that you can use to get another batch of objects.

    
    
• On success, responds with ListSubscribedRuleGroupsOutput with field(s):
  • next_marker(Option<String>):

    If you have more objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more objects, submit another ListSubscribedRuleGroups request, and specify the NextMarker value from the response in the NextMarker value in the next request.

  • rule_groups(Option<Vec::<SubscribedRuleGroupSummary>>):

    An array of RuleGroup objects.

• On failure, responds with SdkError<ListSubscribedRuleGroupsError>

impl Client

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

Constructs a fluent builder for the ListTagsForResource operation.

• The fluent builder is configurable:
  • next_marker(impl Into<String>) / set_next_marker(Option<String>):
    required: false
    
    
    
  • limit(i32) / set_limit(Option<i32>):
    required: false
    
    
    
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    
    
    
• On success, responds with ListTagsForResourceOutput with field(s):
  • next_marker(Option<String>):

  • tag_info_for_resource(Option<TagInfoForResource>):

• On failure, responds with SdkError<ListTagsForResourceError>

impl Client

pub fn list_web_acls(&self) -> ListWebACLsFluentBuilder

Constructs a fluent builder for the ListWebACLs operation.

• The fluent builder is configurable:
  • next_marker(impl Into<String>) / set_next_marker(Option<String>):
    required: false
    

    If you specify a value for Limit and you have more WebACL objects than the number that you specify for Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of WebACL objects. For the second and subsequent ListWebACLs requests, specify the value of NextMarker from the previous response to get information about another batch of WebACL objects.

    
    
  • limit(i32) / set_limit(Option<i32>):
    required: false
    

    Specifies the number of WebACL objects that you want AWS WAF to return for this request. If you have more WebACL objects than the number that you specify for Limit, the response includes a NextMarker value that you can use to get another batch of WebACL objects.

    
    
• On success, responds with ListWebAcLsOutput with field(s):
  • next_marker(Option<String>):

    If you have more WebACL objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more WebACL objects, submit another ListWebACLs request, and specify the NextMarker value from the response in the NextMarker value in the next request.

  • web_acls(Option<Vec::<WebAclSummary>>):

    An array of WebACLSummary objects.

• On failure, responds with SdkError<ListWebACLsError>

impl Client

pub fn list_xss_match_sets(&self) -> ListXssMatchSetsFluentBuilder

Constructs a fluent builder for the ListXssMatchSets operation.

• The fluent builder is configurable:
  • next_marker(impl Into<String>) / set_next_marker(Option<String>):
    required: false
    

    If you specify a value for Limit and you have more XssMatchSet objects than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of XssMatchSets. For the second and subsequent ListXssMatchSets requests, specify the value of NextMarker from the previous response to get information about another batch of XssMatchSets.

    
    
  • limit(i32) / set_limit(Option<i32>):
    required: false
    

    Specifies the number of XssMatchSet objects that you want AWS WAF to return for this request. If you have more XssMatchSet objects than the number you specify for Limit, the response includes a NextMarker value that you can use to get another batch of Rules.

    
    
• On success, responds with ListXssMatchSetsOutput with field(s):
  • next_marker(Option<String>):

    If you have more XssMatchSet objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more XssMatchSet objects, submit another ListXssMatchSets request, and specify the NextMarker value from the response in the NextMarker value in the next request.

  • xss_match_sets(Option<Vec::<XssMatchSetSummary>>):

    An array of XssMatchSetSummary objects.

• On failure, responds with SdkError<ListXssMatchSetsError>

impl Client

pub fn put_logging_configuration(&self) -> PutLoggingConfigurationFluentBuilder

Constructs a fluent builder for the PutLoggingConfiguration operation.

• The fluent builder is configurable:
  • logging_configuration(LoggingConfiguration) / set_logging_configuration(Option<LoggingConfiguration>):
    required: true
    

    The Amazon Kinesis Data Firehose that contains the inspected traffic information, the redacted fields details, and the Amazon Resource Name (ARN) of the web ACL to monitor.

    When specifying Type in RedactedFields, you must use one of the following values: URI, QUERY_STRING, HEADER, or METHOD.

    
    
• On success, responds with PutLoggingConfigurationOutput with field(s):
  • logging_configuration(Option<LoggingConfiguration>):

    The LoggingConfiguration that you submitted in the request.

• On failure, responds with SdkError<PutLoggingConfigurationError>

impl Client

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: true
    

    The Amazon Resource Name (ARN) of the RuleGroup to which you want to attach the policy.

    
    
  • policy(impl Into<String>) / set_policy(Option<String>):
    required: true
    

    The policy to attach to the specified RuleGroup.

    
    
• On success, responds with PutPermissionPolicyOutput
• On failure, responds with SdkError<PutPermissionPolicyError>

impl Client

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: true
    
    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: true
    
    
    
• On success, responds with TagResourceOutput
• On failure, responds with SdkError<TagResourceError>

impl Client

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: true
    
    
    
  • tag_keys(impl Into<String>) / set_tag_keys(Option<Vec::<String>>):
    required: true
    
    
    
• On success, responds with UntagResourceOutput
• On failure, responds with SdkError<UntagResourceError>

impl Client

pub fn update_byte_match_set(&self) -> UpdateByteMatchSetFluentBuilder

Constructs a fluent builder for the UpdateByteMatchSet operation.

• The fluent builder is configurable:
  • byte_match_set_id(impl Into<String>) / set_byte_match_set_id(Option<String>):
    required: true
    

    The ByteMatchSetId of the ByteMatchSet that you want to update. ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets.

    
    
  • change_token(impl Into<String>) / set_change_token(Option<String>):
    required: true
    

    The value returned by the most recent call to GetChangeToken.

    
    
  • updates(ByteMatchSetUpdate) / set_updates(Option<Vec::<ByteMatchSetUpdate>>):
    required: true
    

    An array of ByteMatchSetUpdate objects that you want to insert into or delete from a ByteMatchSet. For more information, see the applicable data types:

    • ByteMatchSetUpdate: Contains Action and ByteMatchTuple

    • ByteMatchTuple: Contains FieldToMatch, PositionalConstraint, TargetString, and TextTransformation

    • FieldToMatch: Contains Data and Type

    
    
• On success, responds with UpdateByteMatchSetOutput with field(s):
  • change_token(Option<String>):

    The ChangeToken that you used to submit the UpdateByteMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

• On failure, responds with SdkError<UpdateByteMatchSetError>

impl Client

pub fn update_geo_match_set(&self) -> UpdateGeoMatchSetFluentBuilder

Constructs a fluent builder for the UpdateGeoMatchSet operation.

• The fluent builder is configurable:
  • geo_match_set_id(impl Into<String>) / set_geo_match_set_id(Option<String>):
    required: true
    

    The GeoMatchSetId of the GeoMatchSet that you want to update. GeoMatchSetId is returned by CreateGeoMatchSet and by ListGeoMatchSets.

    
    
  • change_token(impl Into<String>) / set_change_token(Option<String>):
    required: true
    

    The value returned by the most recent call to GetChangeToken.

    
    
  • updates(GeoMatchSetUpdate) / set_updates(Option<Vec::<GeoMatchSetUpdate>>):
    required: true
    

    An array of GeoMatchSetUpdate objects that you want to insert into or delete from an GeoMatchSet. For more information, see the applicable data types:

    • GeoMatchSetUpdate: Contains Action and GeoMatchConstraint

    • GeoMatchConstraint: Contains Type and Value

      You can have only one Type and Value per GeoMatchConstraint. To add multiple countries, include multiple GeoMatchSetUpdate objects in your request.

    
    
• On success, responds with UpdateGeoMatchSetOutput with field(s):
  • change_token(Option<String>):

    The ChangeToken that you used to submit the UpdateGeoMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

• On failure, responds with SdkError<UpdateGeoMatchSetError>

impl Client

pub fn update_ip_set(&self) -> UpdateIPSetFluentBuilder

Constructs a fluent builder for the UpdateIPSet operation.

• The fluent builder is configurable:
  • ip_set_id(impl Into<String>) / set_ip_set_id(Option<String>):
    required: true
    

    The IPSetId of the IPSet that you want to update. IPSetId is returned by CreateIPSet and by ListIPSets.

    
    
  • change_token(impl Into<String>) / set_change_token(Option<String>):
    required: true
    

    The value returned by the most recent call to GetChangeToken.

    
    
  • updates(IpSetUpdate) / set_updates(Option<Vec::<IpSetUpdate>>):
    required: true
    

    An array of IPSetUpdate objects that you want to insert into or delete from an IPSet. For more information, see the applicable data types:

    • IPSetUpdate: Contains Action and IPSetDescriptor

    • IPSetDescriptor: Contains Type and Value

    You can insert a maximum of 1000 addresses in a single request.

    
    
• On success, responds with UpdateIpSetOutput with field(s):
  • change_token(Option<String>):

    The ChangeToken that you used to submit the UpdateIPSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

• On failure, responds with SdkError<UpdateIPSetError>

impl Client

pub fn update_rate_based_rule(&self) -> UpdateRateBasedRuleFluentBuilder

Constructs a fluent builder for the UpdateRateBasedRule operation.

• The fluent builder is configurable:
  • rule_id(impl Into<String>) / set_rule_id(Option<String>):
    required: true
    

    The RuleId of the RateBasedRule that you want to update. RuleId is returned by CreateRateBasedRule and by ListRateBasedRules.

    
    
  • change_token(impl Into<String>) / set_change_token(Option<String>):
    required: true
    

    The value returned by the most recent call to GetChangeToken.

    
    
  • updates(RuleUpdate) / set_updates(Option<Vec::<RuleUpdate>>):
    required: true
    

    An array of RuleUpdate objects that you want to insert into or delete from a RateBasedRule.

    
    
  • rate_limit(i64) / set_rate_limit(Option<i64>):
    required: true
    

    The maximum number of requests, which have an identical value in the field specified by the RateKey, allowed in a five-minute period. If the number of requests exceeds the RateLimit and the other predicates specified in the rule are also met, AWS WAF triggers the action that is specified for this rule.

    
    
• On success, responds with UpdateRateBasedRuleOutput with field(s):
  • change_token(Option<String>):

    The ChangeToken that you used to submit the UpdateRateBasedRule request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

• On failure, responds with SdkError<UpdateRateBasedRuleError>

impl Client

pub fn update_regex_match_set(&self) -> UpdateRegexMatchSetFluentBuilder

Constructs a fluent builder for the UpdateRegexMatchSet operation.

• The fluent builder is configurable:
  • regex_match_set_id(impl Into<String>) / set_regex_match_set_id(Option<String>):
    required: true
    

    The RegexMatchSetId of the RegexMatchSet that you want to update. RegexMatchSetId is returned by CreateRegexMatchSet and by ListRegexMatchSets.

    
    
  • updates(RegexMatchSetUpdate) / set_updates(Option<Vec::<RegexMatchSetUpdate>>):
    required: true
    

    An array of RegexMatchSetUpdate objects that you want to insert into or delete from a RegexMatchSet. For more information, see RegexMatchTuple.

    
    
  • change_token(impl Into<String>) / set_change_token(Option<String>):
    required: true
    

    The value returned by the most recent call to GetChangeToken.

    
    
• On success, responds with UpdateRegexMatchSetOutput with field(s):
  • change_token(Option<String>):

    The ChangeToken that you used to submit the UpdateRegexMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

• On failure, responds with SdkError<UpdateRegexMatchSetError>

impl Client

pub fn update_regex_pattern_set(&self) -> UpdateRegexPatternSetFluentBuilder

Constructs a fluent builder for the UpdateRegexPatternSet operation.

• The fluent builder is configurable:
  • regex_pattern_set_id(impl Into<String>) / set_regex_pattern_set_id(Option<String>):
    required: true
    

    The RegexPatternSetId of the RegexPatternSet that you want to update. RegexPatternSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets.

    
    
  • updates(RegexPatternSetUpdate) / set_updates(Option<Vec::<RegexPatternSetUpdate>>):
    required: true
    

    An array of RegexPatternSetUpdate objects that you want to insert into or delete from a RegexPatternSet.

    
    
  • change_token(impl Into<String>) / set_change_token(Option<String>):
    required: true
    

    The value returned by the most recent call to GetChangeToken.

    
    
• On success, responds with UpdateRegexPatternSetOutput with field(s):
  • change_token(Option<String>):

    The ChangeToken that you used to submit the UpdateRegexPatternSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

• On failure, responds with SdkError<UpdateRegexPatternSetError>

impl Client

pub fn update_rule(&self) -> UpdateRuleFluentBuilder

Constructs a fluent builder for the UpdateRule operation.

• The fluent builder is configurable:
  • rule_id(impl Into<String>) / set_rule_id(Option<String>):
    required: true
    

    The RuleId of the Rule that you want to update. RuleId is returned by CreateRule and by ListRules.

    
    
  • change_token(impl Into<String>) / set_change_token(Option<String>):
    required: true
    

    The value returned by the most recent call to GetChangeToken.

    
    
  • updates(RuleUpdate) / set_updates(Option<Vec::<RuleUpdate>>):
    required: true
    

    An array of RuleUpdate objects that you want to insert into or delete from a Rule. For more information, see the applicable data types:

    • RuleUpdate: Contains Action and Predicate

    • Predicate: Contains DataId, Negated, and Type

    • FieldToMatch: Contains Data and Type

    
    
• On success, responds with UpdateRuleOutput with field(s):
  • change_token(Option<String>):

    The ChangeToken that you used to submit the UpdateRule request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

• On failure, responds with SdkError<UpdateRuleError>

impl Client

pub fn update_rule_group(&self) -> UpdateRuleGroupFluentBuilder

Constructs a fluent builder for the UpdateRuleGroup operation.

• The fluent builder is configurable:
  • rule_group_id(impl Into<String>) / set_rule_group_id(Option<String>):
    required: true
    

    The RuleGroupId of the RuleGroup that you want to update. RuleGroupId is returned by CreateRuleGroup and by ListRuleGroups.

    
    
  • updates(RuleGroupUpdate) / set_updates(Option<Vec::<RuleGroupUpdate>>):
    required: true
    

    An array of RuleGroupUpdate objects that you want to insert into or delete from a RuleGroup.

    You can only insert REGULAR rules into a rule group.

    ActivatedRule|OverrideAction applies only when updating or adding a RuleGroup to a WebACL. In this case you do not use ActivatedRule|Action. For all other update requests, ActivatedRule|Action is used instead of ActivatedRule|OverrideAction.

    
    
  • change_token(impl Into<String>) / set_change_token(Option<String>):
    required: true
    

    The value returned by the most recent call to GetChangeToken.

    
    
• On success, responds with UpdateRuleGroupOutput with field(s):
  • change_token(Option<String>):

    The ChangeToken that you used to submit the UpdateRuleGroup request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

• On failure, responds with SdkError<UpdateRuleGroupError>

impl Client

pub fn update_size_constraint_set(&self) -> UpdateSizeConstraintSetFluentBuilder

Constructs a fluent builder for the UpdateSizeConstraintSet operation.

• The fluent builder is configurable:
  • size_constraint_set_id(impl Into<String>) / set_size_constraint_set_id(Option<String>):
    required: true
    

    The SizeConstraintSetId of the SizeConstraintSet that you want to update. SizeConstraintSetId is returned by CreateSizeConstraintSet and by ListSizeConstraintSets.

    
    
  • change_token(impl Into<String>) / set_change_token(Option<String>):
    required: true
    

    The value returned by the most recent call to GetChangeToken.

    
    
  • updates(SizeConstraintSetUpdate) / set_updates(Option<Vec::<SizeConstraintSetUpdate>>):
    required: true
    

    An array of SizeConstraintSetUpdate objects that you want to insert into or delete from a SizeConstraintSet. For more information, see the applicable data types:

    • SizeConstraintSetUpdate: Contains Action and SizeConstraint

    • SizeConstraint: Contains FieldToMatch, TextTransformation, ComparisonOperator, and Size

    • FieldToMatch: Contains Data and Type

    
    
• On success, responds with UpdateSizeConstraintSetOutput with field(s):
  • change_token(Option<String>):

    The ChangeToken that you used to submit the UpdateSizeConstraintSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

• On failure, responds with SdkError<UpdateSizeConstraintSetError>

impl Client

pub fn update_sql_injection_match_set( &self, ) -> UpdateSqlInjectionMatchSetFluentBuilder

Constructs a fluent builder for the UpdateSqlInjectionMatchSet operation.

• The fluent builder is configurable:
  • sql_injection_match_set_id(impl Into<String>) / set_sql_injection_match_set_id(Option<String>):
    required: true
    

    The SqlInjectionMatchSetId of the SqlInjectionMatchSet that you want to update. SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by ListSqlInjectionMatchSets.

    
    
  • change_token(impl Into<String>) / set_change_token(Option<String>):
    required: true
    

    The value returned by the most recent call to GetChangeToken.

    
    
  • updates(SqlInjectionMatchSetUpdate) / set_updates(Option<Vec::<SqlInjectionMatchSetUpdate>>):
    required: true
    

    An array of SqlInjectionMatchSetUpdate objects that you want to insert into or delete from a SqlInjectionMatchSet. For more information, see the applicable data types:

    • SqlInjectionMatchSetUpdate: Contains Action and SqlInjectionMatchTuple

    • SqlInjectionMatchTuple: Contains FieldToMatch and TextTransformation

    • FieldToMatch: Contains Data and Type

    
    
• On success, responds with UpdateSqlInjectionMatchSetOutput with field(s):
  • change_token(Option<String>):

    The ChangeToken that you used to submit the UpdateSqlInjectionMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

• On failure, responds with SdkError<UpdateSqlInjectionMatchSetError>

impl Client

pub fn update_web_acl(&self) -> UpdateWebACLFluentBuilder

Constructs a fluent builder for the UpdateWebACL operation.

• The fluent builder is configurable:
  • web_acl_id(impl Into<String>) / set_web_acl_id(Option<String>):
    required: true
    

    The WebACLId of the WebACL that you want to update. WebACLId is returned by CreateWebACL and by ListWebACLs.

    
    
  • change_token(impl Into<String>) / set_change_token(Option<String>):
    required: true
    

    The value returned by the most recent call to GetChangeToken.

    
    
  • updates(WebAclUpdate) / set_updates(Option<Vec::<WebAclUpdate>>):
    required: false
    

    An array of updates to make to the WebACL.

    An array of WebACLUpdate objects that you want to insert into or delete from a WebACL. For more information, see the applicable data types:

    • WebACLUpdate: Contains Action and ActivatedRule

    • ActivatedRule: Contains Action, OverrideAction, Priority, RuleId, and Type. ActivatedRule|OverrideAction applies only when updating or adding a RuleGroup to a WebACL. In this case, you do not use ActivatedRule|Action. For all other update requests, ActivatedRule|Action is used instead of ActivatedRule|OverrideAction.

    • WafAction: Contains Type

    
    
  • default_action(WafAction) / set_default_action(Option<WafAction>):
    required: false
    

    A default action for the web ACL, either ALLOW or BLOCK. AWS WAF performs the default action if a request doesn’t match the criteria in any of the rules in a web ACL.

    
    
• On success, responds with UpdateWebAclOutput with field(s):
  • change_token(Option<String>):

    The ChangeToken that you used to submit the UpdateWebACL request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

• On failure, responds with SdkError<UpdateWebACLError>

impl Client

pub fn update_xss_match_set(&self) -> UpdateXssMatchSetFluentBuilder

Constructs a fluent builder for the UpdateXssMatchSet operation.

• The fluent builder is configurable:
  • xss_match_set_id(impl Into<String>) / set_xss_match_set_id(Option<String>):
    required: true
    

    The XssMatchSetId of the XssMatchSet that you want to update. XssMatchSetId is returned by CreateXssMatchSet and by ListXssMatchSets.

    
    
  • change_token(impl Into<String>) / set_change_token(Option<String>):
    required: true
    

    The value returned by the most recent call to GetChangeToken.

    
    
  • updates(XssMatchSetUpdate) / set_updates(Option<Vec::<XssMatchSetUpdate>>):
    required: true
    

    An array of XssMatchSetUpdate objects that you want to insert into or delete from an XssMatchSet. For more information, see the applicable data types:

    • XssMatchSetUpdate: Contains Action and XssMatchTuple

    • XssMatchTuple: Contains FieldToMatch and TextTransformation

    • FieldToMatch: Contains Data and Type

    
    
• On success, responds with UpdateXssMatchSetOutput with field(s):
  • change_token(Option<String>):

    The ChangeToken that you used to submit the UpdateXssMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

• On failure, responds with SdkError<UpdateXssMatchSetError>

impl Client

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_impl configured.
• Identity caching is enabled without a sleep_impl and time_source configured.
• No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from an SDK Config.

Panics

• This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.
• This method will panic if no BehaviorVersion is provided. If you experience this panic, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.