pub struct Client { /* private fields */ }
Expand description
Client for AWS WAF Regional
Client for invoking operations on AWS WAF Regional. Each operation on AWS WAF Regional 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_wafregional::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_wafregional::config::Builder::from(&sdk_config)
.some_service_specific_setting("value")
.build();
See the aws-config
docs and Config
for more information on customizing configuration.
Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.
§Using the Client
A client has a function for every operation that can be performed by the service.
For example, the AssociateWebACL
operation has
a Client::associate_web_acl
, function which returns a builder for that operation.
The fluent builder ultimately has a send()
function that returns an async future that
returns a result, as illustrated below:
let result = client.associate_web_acl()
.web_acl_id("example")
.send()
.await;
The underlying HTTP requests that get made by this can be modified with the customize_operation
function on the fluent builder. See the customize
module for more
information.
Implementations§
Source§impl Client
impl Client
Sourcepub fn associate_web_acl(&self) -> AssociateWebACLFluentBuilder
pub fn associate_web_acl(&self) -> AssociateWebACLFluentBuilder
Constructs a fluent builder for the AssociateWebACL
operation.
- The fluent builder is configurable:
web_acl_id(impl Into<String>)
/set_web_acl_id(Option<String>)
:
required: trueA unique identifier (ID) for the web ACL.
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: trueThe ARN (Amazon Resource Name) of the resource to be protected, either an application load balancer or Amazon API Gateway stage.
The ARN should be in one of the following formats:
-
For an Application Load Balancer:
arn:aws:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id
-
For an Amazon API Gateway stage:
arn:aws:apigateway:region::/restapis/api-id/stages/stage-name
-
- On success, responds with
AssociateWebAclOutput
- On failure, responds with
SdkError<AssociateWebACLError>
Source§impl Client
impl Client
Sourcepub fn create_byte_match_set(&self) -> CreateByteMatchSetFluentBuilder
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: trueA friendly name or description of the
ByteMatchSet
. You can’t changeName
after you create aByteMatchSet
.change_token(impl Into<String>)
/set_change_token(Option<String>)
:
required: trueThe 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 noByteMatchTuple
objects.change_token(Option<String>)
:The
ChangeToken
that you used to submit theCreateByteMatchSet
request. You can also use this value to query the status of the request. For more information, seeGetChangeTokenStatus
.
- On failure, responds with
SdkError<CreateByteMatchSetError>
Source§impl Client
impl Client
Sourcepub fn create_geo_match_set(&self) -> CreateGeoMatchSetFluentBuilder
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: trueA friendly name or description of the
GeoMatchSet
. You can’t changeName
after you create theGeoMatchSet
.change_token(impl Into<String>)
/set_change_token(Option<String>)
:
required: trueThe 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 theCreateGeoMatchSet
response. TheGeoMatchSet
contains noGeoMatchConstraints
.change_token(Option<String>)
:The
ChangeToken
that you used to submit theCreateGeoMatchSet
request. You can also use this value to query the status of the request. For more information, seeGetChangeTokenStatus
.
- On failure, responds with
SdkError<CreateGeoMatchSetError>
Source§impl Client
impl Client
Sourcepub fn create_ip_set(&self) -> CreateIPSetFluentBuilder
pub fn create_ip_set(&self) -> CreateIPSetFluentBuilder
Constructs a fluent builder for the CreateIPSet
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueA friendly name or description of the
IPSet
. You can’t changeName
after you create theIPSet
.change_token(impl Into<String>)
/set_change_token(Option<String>)
:
required: trueThe 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 theCreateIPSet
response.change_token(Option<String>)
:The
ChangeToken
that you used to submit theCreateIPSet
request. You can also use this value to query the status of the request. For more information, seeGetChangeTokenStatus
.
- On failure, responds with
SdkError<CreateIPSetError>
Source§impl Client
impl Client
Sourcepub fn create_rate_based_rule(&self) -> CreateRateBasedRuleFluentBuilder
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: trueA friendly name or description of the
RateBasedRule
. You can’t change the name of aRateBasedRule
after you create it.metric_name(impl Into<String>)
/set_metric_name(Option<String>)
:
required: trueA 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 theRateBasedRule
.rate_key(RateKey)
/set_rate_key(Option<RateKey>)
:
required: trueThe 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
isIP
.IP
indicates that requests that arrive from the same IP address are subject to theRateLimit
that is specified in theRateBasedRule
.rate_limit(i64)
/set_rate_limit(Option<i64>)
:
required: trueThe 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 theRateLimit
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: trueThe
ChangeToken
that you used to submit theCreateRateBasedRule
request. You can also use this value to query the status of the request. For more information, seeGetChangeTokenStatus
.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 theCreateRateBasedRule
response.change_token(Option<String>)
:The
ChangeToken
that you used to submit theCreateRateBasedRule
request. You can also use this value to query the status of the request. For more information, seeGetChangeTokenStatus
.
- On failure, responds with
SdkError<CreateRateBasedRuleError>
Source§impl Client
impl Client
Sourcepub fn create_regex_match_set(&self) -> CreateRegexMatchSetFluentBuilder
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: trueA friendly name or description of the
RegexMatchSet
. You can’t changeName
after you create aRegexMatchSet
.change_token(impl Into<String>)
/set_change_token(Option<String>)
:
required: trueThe 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 noRegexMatchTuple
objects.change_token(Option<String>)
:The
ChangeToken
that you used to submit theCreateRegexMatchSet
request. You can also use this value to query the status of the request. For more information, seeGetChangeTokenStatus
.
- On failure, responds with
SdkError<CreateRegexMatchSetError>
Source§impl Client
impl Client
Sourcepub fn create_regex_pattern_set(&self) -> CreateRegexPatternSetFluentBuilder
pub fn create_regex_pattern_set(&self) -> CreateRegexPatternSetFluentBuilder
Constructs a fluent builder for the CreateRegexPatternSet
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueA friendly name or description of the
RegexPatternSet
. You can’t changeName
after you create aRegexPatternSet
.change_token(impl Into<String>)
/set_change_token(Option<String>)
:
required: trueThe 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 theCreateRegexPatternSet
request. You can also use this value to query the status of the request. For more information, seeGetChangeTokenStatus
.
- On failure, responds with
SdkError<CreateRegexPatternSetError>
Source§impl Client
impl Client
Sourcepub fn create_rule(&self) -> CreateRuleFluentBuilder
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: trueA friendly name or description of the
Rule
. You can’t change the name of aRule
after you create it.metric_name(impl Into<String>)
/set_metric_name(Option<String>)
:
required: trueA 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 theRule
.change_token(impl Into<String>)
/set_change_token(Option<String>)
:
required: trueThe 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 theCreateRule
response.change_token(Option<String>)
:The
ChangeToken
that you used to submit theCreateRule
request. You can also use this value to query the status of the request. For more information, seeGetChangeTokenStatus
.
- On failure, responds with
SdkError<CreateRuleError>
Source§impl Client
impl Client
Sourcepub fn create_rule_group(&self) -> CreateRuleGroupFluentBuilder
pub fn create_rule_group(&self) -> CreateRuleGroupFluentBuilder
Constructs a fluent builder for the CreateRuleGroup
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueA friendly name or description of the
RuleGroup
. You can’t changeName
after you create aRuleGroup
.metric_name(impl Into<String>)
/set_metric_name(Option<String>)
:
required: trueA 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 theRuleGroup
.change_token(impl Into<String>)
/set_change_token(Option<String>)
:
required: trueThe 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 theCreateRuleGroup
request. You can also use this value to query the status of the request. For more information, seeGetChangeTokenStatus
.
- On failure, responds with
SdkError<CreateRuleGroupError>
Source§impl Client
impl Client
Sourcepub fn create_size_constraint_set(&self) -> CreateSizeConstraintSetFluentBuilder
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: trueA friendly name or description of the
SizeConstraintSet
. You can’t changeName
after you create aSizeConstraintSet
.change_token(impl Into<String>)
/set_change_token(Option<String>)
:
required: trueThe 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 noSizeConstraint
objects.change_token(Option<String>)
:The
ChangeToken
that you used to submit theCreateSizeConstraintSet
request. You can also use this value to query the status of the request. For more information, seeGetChangeTokenStatus
.
- On failure, responds with
SdkError<CreateSizeConstraintSetError>
Source§impl Client
impl Client
Sourcepub fn create_sql_injection_match_set(
&self,
) -> CreateSqlInjectionMatchSetFluentBuilder
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: trueA friendly name or description for the
SqlInjectionMatchSet
that you’re creating. You can’t changeName
after you create theSqlInjectionMatchSet
.change_token(impl Into<String>)
/set_change_token(Option<String>)
:
required: trueThe 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 theCreateSqlInjectionMatchSet
request. You can also use this value to query the status of the request. For more information, seeGetChangeTokenStatus
.
- On failure, responds with
SdkError<CreateSqlInjectionMatchSetError>
Source§impl Client
impl Client
Sourcepub fn create_web_acl(&self) -> CreateWebACLFluentBuilder
pub fn create_web_acl(&self) -> CreateWebACLFluentBuilder
Constructs a fluent builder for the CreateWebACL
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueA friendly name or description of the
WebACL
. You can’t changeName
after you create theWebACL
.metric_name(impl Into<String>)
/set_metric_name(Option<String>)
:
required: trueA 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 changeMetricName
after you create theWebACL
.default_action(WafAction)
/set_default_action(Option<WafAction>)
:
required: trueThe 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 theWebACL
.change_token(impl Into<String>)
/set_change_token(Option<String>)
:
required: trueThe 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 theCreateWebACL
response.change_token(Option<String>)
:The
ChangeToken
that you used to submit theCreateWebACL
request. You can also use this value to query the status of the request. For more information, seeGetChangeTokenStatus
.
- On failure, responds with
SdkError<CreateWebACLError>
Source§impl Client
impl Client
Sourcepub fn create_web_acl_migration_stack(
&self,
) -> CreateWebACLMigrationStackFluentBuilder
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: trueThe 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: trueThe 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: trueIndicates 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>
Source§impl Client
impl Client
Sourcepub fn create_xss_match_set(&self) -> CreateXssMatchSetFluentBuilder
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: trueA friendly name or description for the
XssMatchSet
that you’re creating. You can’t changeName
after you create theXssMatchSet
.change_token(impl Into<String>)
/set_change_token(Option<String>)
:
required: trueThe 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 theCreateXssMatchSet
request. You can also use this value to query the status of the request. For more information, seeGetChangeTokenStatus
.
- On failure, responds with
SdkError<CreateXssMatchSetError>
Source§impl Client
impl Client
Sourcepub fn delete_byte_match_set(&self) -> DeleteByteMatchSetFluentBuilder
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: trueThe
ByteMatchSetId
of theByteMatchSet
that you want to delete.ByteMatchSetId
is returned byCreateByteMatchSet
and byListByteMatchSets
.change_token(impl Into<String>)
/set_change_token(Option<String>)
:
required: trueThe 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 theDeleteByteMatchSet
request. You can also use this value to query the status of the request. For more information, seeGetChangeTokenStatus
.
- On failure, responds with
SdkError<DeleteByteMatchSetError>
Source§impl Client
impl Client
Sourcepub fn delete_geo_match_set(&self) -> DeleteGeoMatchSetFluentBuilder
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: trueThe
GeoMatchSetID
of theGeoMatchSet
that you want to delete.GeoMatchSetId
is returned byCreateGeoMatchSet
and byListGeoMatchSets
.change_token(impl Into<String>)
/set_change_token(Option<String>)
:
required: trueThe 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 theDeleteGeoMatchSet
request. You can also use this value to query the status of the request. For more information, seeGetChangeTokenStatus
.
- On failure, responds with
SdkError<DeleteGeoMatchSetError>
Source§impl Client
impl Client
Sourcepub fn delete_ip_set(&self) -> DeleteIPSetFluentBuilder
pub fn delete_ip_set(&self) -> DeleteIPSetFluentBuilder
Constructs a fluent builder for the DeleteIPSet
operation.
- The fluent builder is configurable:
ip_set_id(impl Into<String>)
/set_ip_set_id(Option<String>)
:
required: trueThe
IPSetId
of theIPSet
that you want to delete.IPSetId
is returned byCreateIPSet
and byListIPSets
.change_token(impl Into<String>)
/set_change_token(Option<String>)
:
required: trueThe 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 theDeleteIPSet
request. You can also use this value to query the status of the request. For more information, seeGetChangeTokenStatus
.
- On failure, responds with
SdkError<DeleteIPSetError>
Source§impl Client
impl Client
Sourcepub fn delete_logging_configuration(
&self,
) -> DeleteLoggingConfigurationFluentBuilder
pub fn delete_logging_configuration( &self, ) -> DeleteLoggingConfigurationFluentBuilder
Constructs a fluent builder for the DeleteLoggingConfiguration
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) of the web ACL from which you want to delete the
LoggingConfiguration
.
- On success, responds with
DeleteLoggingConfigurationOutput
- On failure, responds with
SdkError<DeleteLoggingConfigurationError>
Source§impl Client
impl Client
Sourcepub fn delete_permission_policy(&self) -> DeletePermissionPolicyFluentBuilder
pub fn delete_permission_policy(&self) -> DeletePermissionPolicyFluentBuilder
Constructs a fluent builder for the DeletePermissionPolicy
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) of the 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>
Source§impl Client
impl Client
Sourcepub fn delete_rate_based_rule(&self) -> DeleteRateBasedRuleFluentBuilder
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: trueThe
RuleId
of theRateBasedRule
that you want to delete.RuleId
is returned byCreateRateBasedRule
and byListRateBasedRules
.change_token(impl Into<String>)
/set_change_token(Option<String>)
:
required: trueThe 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 theDeleteRateBasedRule
request. You can also use this value to query the status of the request. For more information, seeGetChangeTokenStatus
.
- On failure, responds with
SdkError<DeleteRateBasedRuleError>
Source§impl Client
impl Client
Sourcepub fn delete_regex_match_set(&self) -> DeleteRegexMatchSetFluentBuilder
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: trueThe
RegexMatchSetId
of theRegexMatchSet
that you want to delete.RegexMatchSetId
is returned byCreateRegexMatchSet
and byListRegexMatchSets
.change_token(impl Into<String>)
/set_change_token(Option<String>)
:
required: trueThe 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 theDeleteRegexMatchSet
request. You can also use this value to query the status of the request. For more information, seeGetChangeTokenStatus
.
- On failure, responds with
SdkError<DeleteRegexMatchSetError>
Source§impl Client
impl Client
Sourcepub fn delete_regex_pattern_set(&self) -> DeleteRegexPatternSetFluentBuilder
pub fn delete_regex_pattern_set(&self) -> DeleteRegexPatternSetFluentBuilder
Constructs a fluent builder for the DeleteRegexPatternSet
operation.
- The fluent builder is configurable:
regex_pattern_set_id(impl Into<String>)
/set_regex_pattern_set_id(Option<String>)
:
required: trueThe
RegexPatternSetId
of theRegexPatternSet
that you want to delete.RegexPatternSetId
is returned byCreateRegexPatternSet
and byListRegexPatternSets
.change_token(impl Into<String>)
/set_change_token(Option<String>)
:
required: trueThe 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 theDeleteRegexPatternSet
request. You can also use this value to query the status of the request. For more information, seeGetChangeTokenStatus
.
- On failure, responds with
SdkError<DeleteRegexPatternSetError>
Source§impl Client
impl Client
Sourcepub fn delete_rule(&self) -> DeleteRuleFluentBuilder
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: trueThe
RuleId
of theRule
that you want to delete.RuleId
is returned byCreateRule
and byListRules
.change_token(impl Into<String>)
/set_change_token(Option<String>)
:
required: trueThe 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 theDeleteRule
request. You can also use this value to query the status of the request. For more information, seeGetChangeTokenStatus
.
- On failure, responds with
SdkError<DeleteRuleError>
Source§impl Client
impl Client
Sourcepub fn delete_rule_group(&self) -> DeleteRuleGroupFluentBuilder
pub fn delete_rule_group(&self) -> DeleteRuleGroupFluentBuilder
Constructs a fluent builder for the DeleteRuleGroup
operation.
- The fluent builder is configurable:
rule_group_id(impl Into<String>)
/set_rule_group_id(Option<String>)
:
required: trueThe
RuleGroupId
of theRuleGroup
that you want to delete.RuleGroupId
is returned byCreateRuleGroup
and byListRuleGroups
.change_token(impl Into<String>)
/set_change_token(Option<String>)
:
required: trueThe 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 theDeleteRuleGroup
request. You can also use this value to query the status of the request. For more information, seeGetChangeTokenStatus
.
- On failure, responds with
SdkError<DeleteRuleGroupError>
Source§impl Client
impl Client
Sourcepub fn delete_size_constraint_set(&self) -> DeleteSizeConstraintSetFluentBuilder
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: trueThe
SizeConstraintSetId
of theSizeConstraintSet
that you want to delete.SizeConstraintSetId
is returned byCreateSizeConstraintSet
and byListSizeConstraintSets
.change_token(impl Into<String>)
/set_change_token(Option<String>)
:
required: trueThe 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 theDeleteSizeConstraintSet
request. You can also use this value to query the status of the request. For more information, seeGetChangeTokenStatus
.
- On failure, responds with
SdkError<DeleteSizeConstraintSetError>
Source§impl Client
impl Client
Sourcepub fn delete_sql_injection_match_set(
&self,
) -> DeleteSqlInjectionMatchSetFluentBuilder
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: trueThe
SqlInjectionMatchSetId
of theSqlInjectionMatchSet
that you want to delete.SqlInjectionMatchSetId
is returned byCreateSqlInjectionMatchSet
and byListSqlInjectionMatchSets
.change_token(impl Into<String>)
/set_change_token(Option<String>)
:
required: trueThe 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 theDeleteSqlInjectionMatchSet
request. You can also use this value to query the status of the request. For more information, seeGetChangeTokenStatus
.
- On failure, responds with
SdkError<DeleteSqlInjectionMatchSetError>
Source§impl Client
impl Client
Sourcepub fn delete_web_acl(&self) -> DeleteWebACLFluentBuilder
pub fn delete_web_acl(&self) -> DeleteWebACLFluentBuilder
Constructs a fluent builder for the DeleteWebACL
operation.
- The fluent builder is configurable:
web_acl_id(impl Into<String>)
/set_web_acl_id(Option<String>)
:
required: trueThe
WebACLId
of theWebACL
that you want to delete.WebACLId
is returned byCreateWebACL
and byListWebACLs
.change_token(impl Into<String>)
/set_change_token(Option<String>)
:
required: trueThe 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 theDeleteWebACL
request. You can also use this value to query the status of the request. For more information, seeGetChangeTokenStatus
.
- On failure, responds with
SdkError<DeleteWebACLError>
Source§impl Client
impl Client
Sourcepub fn delete_xss_match_set(&self) -> DeleteXssMatchSetFluentBuilder
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: trueThe
XssMatchSetId
of theXssMatchSet
that you want to delete.XssMatchSetId
is returned byCreateXssMatchSet
and byListXssMatchSets
.change_token(impl Into<String>)
/set_change_token(Option<String>)
:
required: trueThe 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 theDeleteXssMatchSet
request. You can also use this value to query the status of the request. For more information, seeGetChangeTokenStatus
.
- On failure, responds with
SdkError<DeleteXssMatchSetError>
Source§impl Client
impl Client
Sourcepub fn disassociate_web_acl(&self) -> DisassociateWebACLFluentBuilder
pub fn disassociate_web_acl(&self) -> DisassociateWebACLFluentBuilder
Constructs a fluent builder for the DisassociateWebACL
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: trueThe ARN (Amazon Resource Name) of the resource from which the web ACL is being removed, either an application load balancer or Amazon API Gateway stage.
The ARN should be in one of the following formats:
-
For an Application Load Balancer:
arn:aws:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id
-
For an Amazon API Gateway stage:
arn:aws:apigateway:region::/restapis/api-id/stages/stage-name
-
- On success, responds with
DisassociateWebAclOutput
- On failure, responds with
SdkError<DisassociateWebACLError>
Source§impl Client
impl Client
Sourcepub fn get_byte_match_set(&self) -> GetByteMatchSetFluentBuilder
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: trueThe
ByteMatchSetId
of theByteMatchSet
that you want to get.ByteMatchSetId
is returned byCreateByteMatchSet
and byListByteMatchSets
.
- On success, responds with
GetByteMatchSetOutput
with field(s):byte_match_set(Option<ByteMatchSet>)
:Information about the
ByteMatchSet
that you specified in theGetByteMatchSet
request. For more information, see the following topics:-
ByteMatchSet
: ContainsByteMatchSetId
,ByteMatchTuples
, andName
-
ByteMatchTuples
: Contains an array ofByteMatchTuple
objects. EachByteMatchTuple
object containsFieldToMatch
,PositionalConstraint
,TargetString
, andTextTransformation
-
FieldToMatch
: ContainsData
andType
-
- On failure, responds with
SdkError<GetByteMatchSetError>
Source§impl Client
impl Client
Sourcepub fn get_change_token(&self) -> GetChangeTokenFluentBuilder
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 aGetChangeTokenStatus
request to get the current status of the request.
- On failure, responds with
SdkError<GetChangeTokenError>
Source§impl Client
impl Client
Sourcepub fn get_change_token_status(&self) -> GetChangeTokenStatusFluentBuilder
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: trueThe 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>
Source§impl Client
impl Client
Sourcepub fn get_geo_match_set(&self) -> GetGeoMatchSetFluentBuilder
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: trueThe
GeoMatchSetId
of theGeoMatchSet
that you want to get.GeoMatchSetId
is returned byCreateGeoMatchSet
and byListGeoMatchSets
.
- On success, responds with
GetGeoMatchSetOutput
with field(s):geo_match_set(Option<GeoMatchSet>)
:Information about the
GeoMatchSet
that you specified in theGetGeoMatchSet
request. This includes theType
, which for aGeoMatchContraint
is alwaysCountry
, as well as theValue
, which is the identifier for a specific country.
- On failure, responds with
SdkError<GetGeoMatchSetError>
Source§impl Client
impl Client
Sourcepub fn get_ip_set(&self) -> GetIPSetFluentBuilder
pub fn get_ip_set(&self) -> GetIPSetFluentBuilder
Constructs a fluent builder for the GetIPSet
operation.
- The fluent builder is configurable:
ip_set_id(impl Into<String>)
/set_ip_set_id(Option<String>)
:
required: trueThe
IPSetId
of theIPSet
that you want to get.IPSetId
is returned byCreateIPSet
and byListIPSets
.
- On success, responds with
GetIpSetOutput
with field(s):ip_set(Option<IpSet>)
:Information about the
IPSet
that you specified in theGetIPSet
request. For more information, see the following topics:-
IPSet
: ContainsIPSetDescriptors
,IPSetId
, andName
-
IPSetDescriptors
: Contains an array ofIPSetDescriptor
objects. EachIPSetDescriptor
object containsType
andValue
-
- On failure, responds with
SdkError<GetIPSetError>
Source§impl Client
impl Client
Sourcepub fn get_logging_configuration(&self) -> GetLoggingConfigurationFluentBuilder
pub fn get_logging_configuration(&self) -> GetLoggingConfigurationFluentBuilder
Constructs a fluent builder for the GetLoggingConfiguration
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) of the web ACL for which you want to get the
LoggingConfiguration
.
- On success, responds with
GetLoggingConfigurationOutput
with field(s):logging_configuration(Option<LoggingConfiguration>)
:The
LoggingConfiguration
for the specified web ACL.
- On failure, responds with
SdkError<GetLoggingConfigurationError>
Source§impl Client
impl Client
Sourcepub fn get_permission_policy(&self) -> GetPermissionPolicyFluentBuilder
pub fn get_permission_policy(&self) -> GetPermissionPolicyFluentBuilder
Constructs a fluent builder for the GetPermissionPolicy
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) of the 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>
Source§impl Client
impl Client
Sourcepub fn get_rate_based_rule(&self) -> GetRateBasedRuleFluentBuilder
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: trueThe
RuleId
of theRateBasedRule
that you want to get.RuleId
is returned byCreateRateBasedRule
and byListRateBasedRules
.
- On success, responds with
GetRateBasedRuleOutput
with field(s):rule(Option<RateBasedRule>)
:Information about the
RateBasedRule
that you specified in theGetRateBasedRule
request.
- On failure, responds with
SdkError<GetRateBasedRuleError>
Source§impl Client
impl Client
Sourcepub fn get_rate_based_rule_managed_keys(
&self,
) -> GetRateBasedRuleManagedKeysFluentBuilder
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: trueThe
RuleId
of theRateBasedRule
for which you want to get a list ofManagedKeys
.RuleId
is returned byCreateRateBasedRule
and byListRateBasedRules
.next_marker(impl Into<String>)
/set_next_marker(Option<String>)
:
required: falseA 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>
Source§impl Client
impl Client
Sourcepub fn get_regex_match_set(&self) -> GetRegexMatchSetFluentBuilder
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: trueThe
RegexMatchSetId
of theRegexMatchSet
that you want to get.RegexMatchSetId
is returned byCreateRegexMatchSet
and byListRegexMatchSets
.
- On success, responds with
GetRegexMatchSetOutput
with field(s):regex_match_set(Option<RegexMatchSet>)
:Information about the
RegexMatchSet
that you specified in theGetRegexMatchSet
request. For more information, seeRegexMatchTuple
.
- On failure, responds with
SdkError<GetRegexMatchSetError>
Source§impl Client
impl Client
Sourcepub fn get_regex_pattern_set(&self) -> GetRegexPatternSetFluentBuilder
pub fn get_regex_pattern_set(&self) -> GetRegexPatternSetFluentBuilder
Constructs a fluent builder for the GetRegexPatternSet
operation.
- The fluent builder is configurable:
regex_pattern_set_id(impl Into<String>)
/set_regex_pattern_set_id(Option<String>)
:
required: trueThe
RegexPatternSetId
of theRegexPatternSet
that you want to get.RegexPatternSetId
is returned byCreateRegexPatternSet
and byListRegexPatternSets
.
- On success, responds with
GetRegexPatternSetOutput
with field(s):regex_pattern_set(Option<RegexPatternSet>)
:Information about the
RegexPatternSet
that you specified in theGetRegexPatternSet
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>
Source§impl Client
impl Client
Sourcepub fn get_rule(&self) -> GetRuleFluentBuilder
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: trueThe
RuleId
of theRule
that you want to get.RuleId
is returned byCreateRule
and byListRules
.
- On success, responds with
GetRuleOutput
with field(s):rule(Option<Rule>)
:Information about the
Rule
that you specified in theGetRule
request. For more information, see the following topics:-
Rule
: ContainsMetricName
,Name
, an array ofPredicate
objects, andRuleId
-
Predicate
: EachPredicate
object containsDataId
,Negated
, andType
-
- On failure, responds with
SdkError<GetRuleError>
Source§impl Client
impl Client
Sourcepub fn get_rule_group(&self) -> GetRuleGroupFluentBuilder
pub fn get_rule_group(&self) -> GetRuleGroupFluentBuilder
Constructs a fluent builder for the GetRuleGroup
operation.
- The fluent builder is configurable:
rule_group_id(impl Into<String>)
/set_rule_group_id(Option<String>)
:
required: trueThe
RuleGroupId
of theRuleGroup
that you want to get.RuleGroupId
is returned byCreateRuleGroup
and byListRuleGroups
.
- On success, responds with
GetRuleGroupOutput
with field(s):rule_group(Option<RuleGroup>)
:Information about the
RuleGroup
that you specified in theGetRuleGroup
request.
- On failure, responds with
SdkError<GetRuleGroupError>
Source§impl Client
impl Client
Sourcepub fn get_sampled_requests(&self) -> GetSampledRequestsFluentBuilder
pub fn get_sampled_requests(&self) -> GetSampledRequestsFluentBuilder
Constructs a fluent builder for the GetSampledRequests
operation.
- The fluent builder is configurable:
web_acl_id(impl Into<String>)
/set_web_acl_id(Option<String>)
:
required: trueThe
WebACLId
of theWebACL
for which you wantGetSampledRequests
to return a sample of requests.rule_id(impl Into<String>)
/set_rule_id(Option<String>)
:
required: trueRuleId
is one of three values:-
The
RuleId
of theRule
or theRuleGroupId
of theRuleGroup
for which you wantGetSampledRequests
to return a sample of requests. -
Default_Action
, which causesGetSampledRequests
to return a sample of the requests that didn’t match any of the rules in the specifiedWebACL
.
-
time_window(TimeWindow)
/set_time_window(Option<TimeWindow>)
:
required: trueThe start date and time and the end date and time of the range for which you want
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: trueThe 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 ofMaxItems
requests. IfPopulationSize
is less thanMaxItems
, 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 theGetSampledRequests
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>
Source§impl Client
impl Client
Sourcepub fn get_size_constraint_set(&self) -> GetSizeConstraintSetFluentBuilder
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: trueThe
SizeConstraintSetId
of theSizeConstraintSet
that you want to get.SizeConstraintSetId
is returned byCreateSizeConstraintSet
and byListSizeConstraintSets
.
- On success, responds with
GetSizeConstraintSetOutput
with field(s):size_constraint_set(Option<SizeConstraintSet>)
:Information about the
SizeConstraintSet
that you specified in theGetSizeConstraintSet
request. For more information, see the following topics:-
SizeConstraintSet
: ContainsSizeConstraintSetId
,SizeConstraints
, andName
-
SizeConstraints
: Contains an array ofSizeConstraint
objects. EachSizeConstraint
object containsFieldToMatch
,TextTransformation
,ComparisonOperator
, andSize
-
FieldToMatch
: ContainsData
andType
-
- On failure, responds with
SdkError<GetSizeConstraintSetError>
Source§impl Client
impl Client
Sourcepub fn get_sql_injection_match_set(
&self,
) -> GetSqlInjectionMatchSetFluentBuilder
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: trueThe
SqlInjectionMatchSetId
of theSqlInjectionMatchSet
that you want to get.SqlInjectionMatchSetId
is returned byCreateSqlInjectionMatchSet
and byListSqlInjectionMatchSets
.
- On success, responds with
GetSqlInjectionMatchSetOutput
with field(s):sql_injection_match_set(Option<SqlInjectionMatchSet>)
:Information about the
SqlInjectionMatchSet
that you specified in theGetSqlInjectionMatchSet
request. For more information, see the following topics:-
SqlInjectionMatchSet
: ContainsName
,SqlInjectionMatchSetId
, and an array ofSqlInjectionMatchTuple
objects -
SqlInjectionMatchTuple
: EachSqlInjectionMatchTuple
object containsFieldToMatch
andTextTransformation
-
FieldToMatch
: ContainsData
andType
-
- On failure, responds with
SdkError<GetSqlInjectionMatchSetError>
Source§impl Client
impl Client
Sourcepub fn get_web_acl(&self) -> GetWebACLFluentBuilder
pub fn get_web_acl(&self) -> GetWebACLFluentBuilder
Constructs a fluent builder for the GetWebACL
operation.
- The fluent builder is configurable:
web_acl_id(impl Into<String>)
/set_web_acl_id(Option<String>)
:
required: trueThe
WebACLId
of theWebACL
that you want to get.WebACLId
is returned byCreateWebACL
and byListWebACLs
.
- On success, responds with
GetWebAclOutput
with field(s):web_acl(Option<WebAcl>)
:Information about the
WebACL
that you specified in theGetWebACL
request. For more information, see the following topics:-
WebACL
: ContainsDefaultAction
,MetricName
,Name
, an array ofRule
objects, andWebACLId
-
DefaultAction
(Data type isWafAction
): ContainsType
-
Rules
: Contains an array ofActivatedRule
objects, which containAction
,Priority
, andRuleId
-
Action
: ContainsType
-
- On failure, responds with
SdkError<GetWebACLError>
Source§impl Client
impl Client
Sourcepub fn get_web_acl_for_resource(&self) -> GetWebACLForResourceFluentBuilder
pub fn get_web_acl_for_resource(&self) -> GetWebACLForResourceFluentBuilder
Constructs a fluent builder for the GetWebACLForResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: trueThe ARN (Amazon Resource Name) of the resource for which to get the web ACL, either an application load balancer or Amazon API Gateway stage.
The ARN should be in one of the following formats:
-
For an Application Load Balancer:
arn:aws:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id
-
For an Amazon API Gateway stage:
arn:aws:apigateway:region::/restapis/api-id/stages/stage-name
-
- On success, responds with
GetWebAclForResourceOutput
with field(s):web_acl_summary(Option<WebAclSummary>)
:Information about the web ACL that you specified in the
GetWebACLForResource
request. If there is no associated resource, a null WebACLSummary is returned.
- On failure, responds with
SdkError<GetWebACLForResourceError>
Source§impl Client
impl Client
Sourcepub fn get_xss_match_set(&self) -> GetXssMatchSetFluentBuilder
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: trueThe
XssMatchSetId
of theXssMatchSet
that you want to get.XssMatchSetId
is returned byCreateXssMatchSet
and byListXssMatchSets
.
- On success, responds with
GetXssMatchSetOutput
with field(s):xss_match_set(Option<XssMatchSet>)
:Information about the
XssMatchSet
that you specified in theGetXssMatchSet
request. For more information, see the following topics:-
XssMatchSet
: ContainsName
,XssMatchSetId
, and an array ofXssMatchTuple
objects -
XssMatchTuple
: EachXssMatchTuple
object containsFieldToMatch
andTextTransformation
-
FieldToMatch
: ContainsData
andType
-
- On failure, responds with
SdkError<GetXssMatchSetError>
Source§impl Client
impl Client
Sourcepub fn list_activated_rules_in_rule_group(
&self,
) -> ListActivatedRulesInRuleGroupFluentBuilder
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: falseThe
RuleGroupId
of theRuleGroup
for which you want to get a list ofActivatedRule
objects.next_marker(impl Into<String>)
/set_next_marker(Option<String>)
:
required: falseIf you specify a value for
Limit
and you have moreActivatedRules
than the value ofLimit
, AWS WAF returns aNextMarker
value in the response that allows you to list another group ofActivatedRules
. For the second and subsequentListActivatedRulesInRuleGroup
requests, specify the value ofNextMarker
from the previous response to get information about another batch ofActivatedRules
.limit(i32)
/set_limit(Option<i32>)
:
required: falseSpecifies the number of
ActivatedRules
that you want AWS WAF to return for this request. If you have moreActivatedRules
than the number that you specify forLimit
, the response includes aNextMarker
value that you can use to get another batch ofActivatedRules
.
- On success, responds with
ListActivatedRulesInRuleGroupOutput
with field(s):next_marker(Option<String>)
:If you have more
ActivatedRules
than the number that you specified forLimit
in the request, the response includes aNextMarker
value. To list moreActivatedRules
, submit anotherListActivatedRulesInRuleGroup
request, and specify theNextMarker
value from the response in theNextMarker
value in the next request.activated_rules(Option<Vec::<ActivatedRule>>)
:An array of
ActivatedRules
objects.
- On failure, responds with
SdkError<ListActivatedRulesInRuleGroupError>
Source§impl Client
impl Client
Sourcepub fn list_byte_match_sets(&self) -> ListByteMatchSetsFluentBuilder
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: falseIf you specify a value for
Limit
and you have moreByteMatchSets
than the value ofLimit
, AWS WAF returns aNextMarker
value in the response that allows you to list another group ofByteMatchSets
. For the second and subsequentListByteMatchSets
requests, specify the value ofNextMarker
from the previous response to get information about another batch ofByteMatchSets
.limit(i32)
/set_limit(Option<i32>)
:
required: falseSpecifies the number of
ByteMatchSet
objects that you want AWS WAF to return for this request. If you have moreByteMatchSets
objects than the number you specify forLimit
, the response includes aNextMarker
value that you can use to get another batch ofByteMatchSet
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 forLimit
in the request, the response includes aNextMarker
value. To list moreByteMatchSet
objects, submit anotherListByteMatchSets
request, and specify theNextMarker
value from the response in theNextMarker
value in the next request.byte_match_sets(Option<Vec::<ByteMatchSetSummary>>)
:An array of
ByteMatchSetSummary
objects.
- On failure, responds with
SdkError<ListByteMatchSetsError>
Source§impl Client
impl Client
Sourcepub fn list_geo_match_sets(&self) -> ListGeoMatchSetsFluentBuilder
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: falseIf you specify a value for
Limit
and you have moreGeoMatchSet
s than the value ofLimit
, AWS WAF returns aNextMarker
value in the response that allows you to list another group ofGeoMatchSet
objects. For the second and subsequentListGeoMatchSets
requests, specify the value ofNextMarker
from the previous response to get information about another batch ofGeoMatchSet
objects.limit(i32)
/set_limit(Option<i32>)
:
required: falseSpecifies the number of
GeoMatchSet
objects that you want AWS WAF to return for this request. If you have moreGeoMatchSet
objects than the number you specify forLimit
, the response includes aNextMarker
value that you can use to get another batch ofGeoMatchSet
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 forLimit
in the request, the response includes aNextMarker
value. To list moreGeoMatchSet
objects, submit anotherListGeoMatchSets
request, and specify theNextMarker
value from the response in theNextMarker
value in the next request.geo_match_sets(Option<Vec::<GeoMatchSetSummary>>)
:An array of
GeoMatchSetSummary
objects.
- On failure, responds with
SdkError<ListGeoMatchSetsError>
Source§impl Client
impl Client
Sourcepub fn list_ip_sets(&self) -> ListIPSetsFluentBuilder
pub fn list_ip_sets(&self) -> ListIPSetsFluentBuilder
Constructs a fluent builder for the ListIPSets
operation.
- The fluent builder is configurable:
next_marker(impl Into<String>)
/set_next_marker(Option<String>)
:
required: falseAWS WAF returns a
NextMarker
value in the response that allows you to list another group ofIPSets
. For the second and subsequentListIPSets
requests, specify the value ofNextMarker
from the previous response to get information about another batch ofIPSets
.limit(i32)
/set_limit(Option<i32>)
:
required: falseSpecifies the number of
IPSet
objects that you want AWS WAF to return for this request. If you have moreIPSet
objects than the number you specify forLimit
, the response includes aNextMarker
value that you can use to get another batch ofIPSet
objects.
- On success, responds with
ListIpSetsOutput
with field(s):next_marker(Option<String>)
:To list more
IPSet
objects, submit anotherListIPSets
request, and in the next request use theNextMarker
response value as theNextMarker
value.ip_sets(Option<Vec::<IpSetSummary>>)
:An array of
IPSetSummary
objects.
- On failure, responds with
SdkError<ListIPSetsError>
Source§impl Client
impl Client
Sourcepub fn list_logging_configurations(
&self,
) -> ListLoggingConfigurationsFluentBuilder
pub fn list_logging_configurations( &self, ) -> ListLoggingConfigurationsFluentBuilder
Constructs a fluent builder for the ListLoggingConfigurations
operation.
- The fluent builder is configurable:
next_marker(impl Into<String>)
/set_next_marker(Option<String>)
:
required: falseIf you specify a value for
Limit
and you have moreLoggingConfigurations
than the value ofLimit
, AWS WAF returns aNextMarker
value in the response that allows you to list another group ofLoggingConfigurations
. For the second and subsequentListLoggingConfigurations
requests, specify the value ofNextMarker
from the previous response to get information about another batch ofListLoggingConfigurations
.limit(i32)
/set_limit(Option<i32>)
:
required: falseSpecifies the number of
LoggingConfigurations
that you want AWS WAF to return for this request. If you have moreLoggingConfigurations
than the number that you specify forLimit
, the response includes aNextMarker
value that you can use to get another batch ofLoggingConfigurations
.
- 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 forLimit
in the request, the response includes aNextMarker
value. To list moreLoggingConfigurations
, submit anotherListLoggingConfigurations
request, and specify theNextMarker
value from the response in theNextMarker
value in the next request.
- On failure, responds with
SdkError<ListLoggingConfigurationsError>
Source§impl Client
impl Client
Sourcepub fn list_rate_based_rules(&self) -> ListRateBasedRulesFluentBuilder
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: falseIf you specify a value for
Limit
and you have moreRules
than the value ofLimit
, AWS WAF returns aNextMarker
value in the response that allows you to list another group ofRules
. For the second and subsequentListRateBasedRules
requests, specify the value ofNextMarker
from the previous response to get information about another batch ofRules
.limit(i32)
/set_limit(Option<i32>)
:
required: falseSpecifies the number of
Rules
that you want AWS WAF to return for this request. If you have moreRules
than the number that you specify forLimit
, the response includes aNextMarker
value that you can use to get another batch ofRules
.
- On success, responds with
ListRateBasedRulesOutput
with field(s):next_marker(Option<String>)
:If you have more
Rules
than the number that you specified forLimit
in the request, the response includes aNextMarker
value. To list moreRules
, submit anotherListRateBasedRules
request, and specify theNextMarker
value from the response in theNextMarker
value in the next request.rules(Option<Vec::<RuleSummary>>)
:An array of
RuleSummary
objects.
- On failure, responds with
SdkError<ListRateBasedRulesError>
Source§impl Client
impl Client
Sourcepub fn list_regex_match_sets(&self) -> ListRegexMatchSetsFluentBuilder
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: falseIf you specify a value for
Limit
and you have moreRegexMatchSet
objects than the value ofLimit
, AWS WAF returns aNextMarker
value in the response that allows you to list another group ofByteMatchSets
. For the second and subsequentListRegexMatchSets
requests, specify the value ofNextMarker
from the previous response to get information about another batch ofRegexMatchSet
objects.limit(i32)
/set_limit(Option<i32>)
:
required: falseSpecifies the number of
RegexMatchSet
objects that you want AWS WAF to return for this request. If you have moreRegexMatchSet
objects than the number you specify forLimit
, the response includes aNextMarker
value that you can use to get another batch ofRegexMatchSet
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 forLimit
in the request, the response includes aNextMarker
value. To list moreRegexMatchSet
objects, submit anotherListRegexMatchSets
request, and specify theNextMarker
value from the response in theNextMarker
value in the next request.regex_match_sets(Option<Vec::<RegexMatchSetSummary>>)
:An array of
RegexMatchSetSummary
objects.
- On failure, responds with
SdkError<ListRegexMatchSetsError>
Source§impl Client
impl Client
Sourcepub fn list_regex_pattern_sets(&self) -> ListRegexPatternSetsFluentBuilder
pub fn list_regex_pattern_sets(&self) -> ListRegexPatternSetsFluentBuilder
Constructs a fluent builder for the ListRegexPatternSets
operation.
- The fluent builder is configurable:
next_marker(impl Into<String>)
/set_next_marker(Option<String>)
:
required: falseIf you specify a value for
Limit
and you have moreRegexPatternSet
objects than the value ofLimit
, AWS WAF returns aNextMarker
value in the response that allows you to list another group ofRegexPatternSet
objects. For the second and subsequentListRegexPatternSets
requests, specify the value ofNextMarker
from the previous response to get information about another batch ofRegexPatternSet
objects.limit(i32)
/set_limit(Option<i32>)
:
required: falseSpecifies the number of
RegexPatternSet
objects that you want AWS WAF to return for this request. If you have moreRegexPatternSet
objects than the number you specify forLimit
, the response includes aNextMarker
value that you can use to get another batch ofRegexPatternSet
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 forLimit
in the request, the response includes aNextMarker
value. To list moreRegexPatternSet
objects, submit anotherListRegexPatternSets
request, and specify theNextMarker
value from the response in theNextMarker
value in the next request.regex_pattern_sets(Option<Vec::<RegexPatternSetSummary>>)
:An array of
RegexPatternSetSummary
objects.
- On failure, responds with
SdkError<ListRegexPatternSetsError>
Source§impl Client
impl Client
Sourcepub fn list_resources_for_web_acl(&self) -> ListResourcesForWebACLFluentBuilder
pub fn list_resources_for_web_acl(&self) -> ListResourcesForWebACLFluentBuilder
Constructs a fluent builder for the ListResourcesForWebACL
operation.
- The fluent builder is configurable:
web_acl_id(impl Into<String>)
/set_web_acl_id(Option<String>)
:
required: trueThe unique identifier (ID) of the web ACL for which to list the associated resources.
resource_type(ResourceType)
/set_resource_type(Option<ResourceType>)
:
required: falseThe type of resource to list, either an application load balancer or Amazon API Gateway.
- On success, responds with
ListResourcesForWebAclOutput
with field(s):resource_arns(Option<Vec::<String>>)
:An array of ARNs (Amazon Resource Names) of the resources associated with the specified web ACL. An array with zero elements is returned if there are no resources associated with the web ACL.
- On failure, responds with
SdkError<ListResourcesForWebACLError>
Source§impl Client
impl Client
Sourcepub fn list_rule_groups(&self) -> ListRuleGroupsFluentBuilder
pub fn list_rule_groups(&self) -> ListRuleGroupsFluentBuilder
Constructs a fluent builder for the ListRuleGroups
operation.
- The fluent builder is configurable:
next_marker(impl Into<String>)
/set_next_marker(Option<String>)
:
required: falseIf you specify a value for
Limit
and you have moreRuleGroups
than the value ofLimit
, AWS WAF returns aNextMarker
value in the response that allows you to list another group ofRuleGroups
. For the second and subsequentListRuleGroups
requests, specify the value ofNextMarker
from the previous response to get information about another batch ofRuleGroups
.limit(i32)
/set_limit(Option<i32>)
:
required: falseSpecifies the number of
RuleGroups
that you want AWS WAF to return for this request. If you have moreRuleGroups
than the number that you specify forLimit
, the response includes aNextMarker
value that you can use to get another batch ofRuleGroups
.
- On success, responds with
ListRuleGroupsOutput
with field(s):next_marker(Option<String>)
:If you have more
RuleGroups
than the number that you specified forLimit
in the request, the response includes aNextMarker
value. To list moreRuleGroups
, submit anotherListRuleGroups
request, and specify theNextMarker
value from the response in theNextMarker
value in the next request.rule_groups(Option<Vec::<RuleGroupSummary>>)
:An array of
RuleGroup
objects.
- On failure, responds with
SdkError<ListRuleGroupsError>
Source§impl Client
impl Client
Sourcepub fn list_rules(&self) -> ListRulesFluentBuilder
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: falseIf you specify a value for
Limit
and you have moreRules
than the value ofLimit
, AWS WAF returns aNextMarker
value in the response that allows you to list another group ofRules
. For the second and subsequentListRules
requests, specify the value ofNextMarker
from the previous response to get information about another batch ofRules
.limit(i32)
/set_limit(Option<i32>)
:
required: falseSpecifies the number of
Rules
that you want AWS WAF to return for this request. If you have moreRules
than the number that you specify forLimit
, the response includes aNextMarker
value that you can use to get another batch ofRules
.
- On success, responds with
ListRulesOutput
with field(s):next_marker(Option<String>)
:If you have more
Rules
than the number that you specified forLimit
in the request, the response includes aNextMarker
value. To list moreRules
, submit anotherListRules
request, and specify theNextMarker
value from the response in theNextMarker
value in the next request.rules(Option<Vec::<RuleSummary>>)
:An array of
RuleSummary
objects.
- On failure, responds with
SdkError<ListRulesError>
Source§impl Client
impl Client
Sourcepub fn list_size_constraint_sets(&self) -> ListSizeConstraintSetsFluentBuilder
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: falseIf you specify a value for
Limit
and you have moreSizeConstraintSets
than the value ofLimit
, AWS WAF returns aNextMarker
value in the response that allows you to list another group ofSizeConstraintSets
. For the second and subsequentListSizeConstraintSets
requests, specify the value ofNextMarker
from the previous response to get information about another batch ofSizeConstraintSets
.limit(i32)
/set_limit(Option<i32>)
:
required: falseSpecifies the number of
SizeConstraintSet
objects that you want AWS WAF to return for this request. If you have moreSizeConstraintSets
objects than the number you specify forLimit
, the response includes aNextMarker
value that you can use to get another batch ofSizeConstraintSet
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 forLimit
in the request, the response includes aNextMarker
value. To list moreSizeConstraintSet
objects, submit anotherListSizeConstraintSets
request, and specify theNextMarker
value from the response in theNextMarker
value in the next request.size_constraint_sets(Option<Vec::<SizeConstraintSetSummary>>)
:An array of
SizeConstraintSetSummary
objects.
- On failure, responds with
SdkError<ListSizeConstraintSetsError>
Source§impl Client
impl Client
Sourcepub fn list_sql_injection_match_sets(
&self,
) -> ListSqlInjectionMatchSetsFluentBuilder
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: falseIf you specify a value for
Limit
and you have moreSqlInjectionMatchSet
objects than the value ofLimit
, AWS WAF returns aNextMarker
value in the response that allows you to list another group ofSqlInjectionMatchSets
. For the second and subsequentListSqlInjectionMatchSets
requests, specify the value ofNextMarker
from the previous response to get information about another batch ofSqlInjectionMatchSets
.limit(i32)
/set_limit(Option<i32>)
:
required: falseSpecifies the number of
SqlInjectionMatchSet
objects that you want AWS WAF to return for this request. If you have moreSqlInjectionMatchSet
objects than the number you specify forLimit
, the response includes aNextMarker
value that you can use to get another batch ofRules
.
- On success, responds with
ListSqlInjectionMatchSetsOutput
with field(s):next_marker(Option<String>)
:If you have more
SqlInjectionMatchSet
objects than the number that you specified forLimit
in the request, the response includes aNextMarker
value. To list moreSqlInjectionMatchSet
objects, submit anotherListSqlInjectionMatchSets
request, and specify theNextMarker
value from the response in theNextMarker
value in the next request.sql_injection_match_sets(Option<Vec::<SqlInjectionMatchSetSummary>>)
:An array of
SqlInjectionMatchSetSummary
objects.
- On failure, responds with
SdkError<ListSqlInjectionMatchSetsError>
Source§impl Client
impl Client
Sourcepub fn list_subscribed_rule_groups(
&self,
) -> ListSubscribedRuleGroupsFluentBuilder
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: falseIf you specify a value for
Limit
and you have moreByteMatchSets
subscribed rule groups than the value ofLimit
, AWS WAF returns aNextMarker
value in the response that allows you to list another group of subscribed rule groups. For the second and subsequentListSubscribedRuleGroupsRequest
requests, specify the value ofNextMarker
from the previous response to get information about another batch of subscribed rule groups.limit(i32)
/set_limit(Option<i32>)
:
required: falseSpecifies 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 aNextMarker
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 aNextMarker
value. To list more objects, submit anotherListSubscribedRuleGroups
request, and specify theNextMarker
value from the response in theNextMarker
value in the next request.rule_groups(Option<Vec::<SubscribedRuleGroupSummary>>)
:An array of
RuleGroup
objects.
- On failure, responds with
SdkError<ListSubscribedRuleGroupsError>
Source§impl Client
impl Client
Constructs a fluent builder for the ListTagsForResource
operation.
- The fluent builder is configurable:
next_marker(impl Into<String>)
/set_next_marker(Option<String>)
:
required: falselimit(i32)
/set_limit(Option<i32>)
:
required: falseresource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: true
- On success, responds with
ListTagsForResourceOutput
with field(s): - On failure, responds with
SdkError<ListTagsForResourceError>
Source§impl Client
impl Client
Sourcepub fn list_web_acls(&self) -> ListWebACLsFluentBuilder
pub fn list_web_acls(&self) -> ListWebACLsFluentBuilder
Constructs a fluent builder for the ListWebACLs
operation.
- The fluent builder is configurable:
next_marker(impl Into<String>)
/set_next_marker(Option<String>)
:
required: falseIf you specify a value for
Limit
and you have moreWebACL
objects than the number that you specify forLimit
, AWS WAF returns aNextMarker
value in the response that allows you to list another group ofWebACL
objects. For the second and subsequentListWebACLs
requests, specify the value ofNextMarker
from the previous response to get information about another batch ofWebACL
objects.limit(i32)
/set_limit(Option<i32>)
:
required: falseSpecifies the number of
WebACL
objects that you want AWS WAF to return for this request. If you have moreWebACL
objects than the number that you specify forLimit
, the response includes aNextMarker
value that you can use to get another batch ofWebACL
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 forLimit
in the request, the response includes aNextMarker
value. To list moreWebACL
objects, submit anotherListWebACLs
request, and specify theNextMarker
value from the response in theNextMarker
value in the next request.web_acls(Option<Vec::<WebAclSummary>>)
:An array of
WebACLSummary
objects.
- On failure, responds with
SdkError<ListWebACLsError>
Source§impl Client
impl Client
Sourcepub fn list_xss_match_sets(&self) -> ListXssMatchSetsFluentBuilder
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: falseIf you specify a value for
Limit
and you have moreXssMatchSet
objects than the value ofLimit
, AWS WAF returns aNextMarker
value in the response that allows you to list another group ofXssMatchSets
. For the second and subsequentListXssMatchSets
requests, specify the value ofNextMarker
from the previous response to get information about another batch ofXssMatchSets
.limit(i32)
/set_limit(Option<i32>)
:
required: falseSpecifies the number of
XssMatchSet
objects that you want AWS WAF to return for this request. If you have moreXssMatchSet
objects than the number you specify forLimit
, the response includes aNextMarker
value that you can use to get another batch ofRules
.
- On success, responds with
ListXssMatchSetsOutput
with field(s):next_marker(Option<String>)
:If you have more
XssMatchSet
objects than the number that you specified forLimit
in the request, the response includes aNextMarker
value. To list moreXssMatchSet
objects, submit anotherListXssMatchSets
request, and specify theNextMarker
value from the response in theNextMarker
value in the next request.xss_match_sets(Option<Vec::<XssMatchSetSummary>>)
:An array of
XssMatchSetSummary
objects.
- On failure, responds with
SdkError<ListXssMatchSetsError>
Source§impl Client
impl Client
Sourcepub fn put_logging_configuration(&self) -> PutLoggingConfigurationFluentBuilder
pub fn put_logging_configuration(&self) -> PutLoggingConfigurationFluentBuilder
Constructs a fluent builder for the PutLoggingConfiguration
operation.
- The fluent builder is configurable:
logging_configuration(LoggingConfiguration)
/set_logging_configuration(Option<LoggingConfiguration>)
:
required: trueThe 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
inRedactedFields
, you must use one of the following values:URI
,QUERY_STRING
,HEADER
, orMETHOD
.
- 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>
Source§impl Client
impl Client
Sourcepub fn put_permission_policy(&self) -> PutPermissionPolicyFluentBuilder
pub fn put_permission_policy(&self) -> PutPermissionPolicyFluentBuilder
Constructs a fluent builder for the PutPermissionPolicy
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) of the RuleGroup to which you want to attach the policy.
policy(impl Into<String>)
/set_policy(Option<String>)
:
required: trueThe policy to attach to the specified RuleGroup.
- On success, responds with
PutPermissionPolicyOutput
- On failure, responds with
SdkError<PutPermissionPolicyError>
Source§impl Client
impl Client
Sourcepub fn tag_resource(&self) -> TagResourceFluentBuilder
pub fn tag_resource(&self) -> TagResourceFluentBuilder
Constructs a fluent builder for the TagResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: truetags(Tag)
/set_tags(Option<Vec::<Tag>>)
:
required: true
- On success, responds with
TagResourceOutput
- On failure, responds with
SdkError<TagResourceError>
Source§impl Client
impl Client
Sourcepub fn untag_resource(&self) -> UntagResourceFluentBuilder
pub fn untag_resource(&self) -> UntagResourceFluentBuilder
Constructs a fluent builder for the UntagResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: truetag_keys(impl Into<String>)
/set_tag_keys(Option<Vec::<String>>)
:
required: true
- On success, responds with
UntagResourceOutput
- On failure, responds with
SdkError<UntagResourceError>
Source§impl Client
impl Client
Sourcepub fn update_byte_match_set(&self) -> UpdateByteMatchSetFluentBuilder
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: trueThe
ByteMatchSetId
of theByteMatchSet
that you want to update.ByteMatchSetId
is returned byCreateByteMatchSet
and byListByteMatchSets
.change_token(impl Into<String>)
/set_change_token(Option<String>)
:
required: trueThe value returned by the most recent call to
GetChangeToken
.updates(ByteMatchSetUpdate)
/set_updates(Option<Vec::<ByteMatchSetUpdate>>)
:
required: trueAn array of
ByteMatchSetUpdate
objects that you want to insert into or delete from aByteMatchSet
. For more information, see the applicable data types:-
ByteMatchSetUpdate
: ContainsAction
andByteMatchTuple
-
ByteMatchTuple
: ContainsFieldToMatch
,PositionalConstraint
,TargetString
, andTextTransformation
-
FieldToMatch
: ContainsData
andType
-
- On success, responds with
UpdateByteMatchSetOutput
with field(s):change_token(Option<String>)
:The
ChangeToken
that you used to submit theUpdateByteMatchSet
request. You can also use this value to query the status of the request. For more information, seeGetChangeTokenStatus
.
- On failure, responds with
SdkError<UpdateByteMatchSetError>
Source§impl Client
impl Client
Sourcepub fn update_geo_match_set(&self) -> UpdateGeoMatchSetFluentBuilder
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: trueThe
GeoMatchSetId
of theGeoMatchSet
that you want to update.GeoMatchSetId
is returned byCreateGeoMatchSet
and byListGeoMatchSets
.change_token(impl Into<String>)
/set_change_token(Option<String>)
:
required: trueThe value returned by the most recent call to
GetChangeToken
.updates(GeoMatchSetUpdate)
/set_updates(Option<Vec::<GeoMatchSetUpdate>>)
:
required: trueAn array of
GeoMatchSetUpdate
objects that you want to insert into or delete from anGeoMatchSet
. For more information, see the applicable data types:-
GeoMatchSetUpdate
: ContainsAction
andGeoMatchConstraint
-
GeoMatchConstraint
: ContainsType
andValue
You can have only one
Type
andValue
perGeoMatchConstraint
. To add multiple countries, include multipleGeoMatchSetUpdate
objects in your request.
-
- On success, responds with
UpdateGeoMatchSetOutput
with field(s):change_token(Option<String>)
:The
ChangeToken
that you used to submit theUpdateGeoMatchSet
request. You can also use this value to query the status of the request. For more information, seeGetChangeTokenStatus
.
- On failure, responds with
SdkError<UpdateGeoMatchSetError>
Source§impl Client
impl Client
Sourcepub fn update_ip_set(&self) -> UpdateIPSetFluentBuilder
pub fn update_ip_set(&self) -> UpdateIPSetFluentBuilder
Constructs a fluent builder for the UpdateIPSet
operation.
- The fluent builder is configurable:
ip_set_id(impl Into<String>)
/set_ip_set_id(Option<String>)
:
required: trueThe
IPSetId
of theIPSet
that you want to update.IPSetId
is returned byCreateIPSet
and byListIPSets
.change_token(impl Into<String>)
/set_change_token(Option<String>)
:
required: trueThe value returned by the most recent call to
GetChangeToken
.updates(IpSetUpdate)
/set_updates(Option<Vec::<IpSetUpdate>>)
:
required: trueAn array of
IPSetUpdate
objects that you want to insert into or delete from anIPSet
. For more information, see the applicable data types:-
IPSetUpdate
: ContainsAction
andIPSetDescriptor
-
IPSetDescriptor
: ContainsType
andValue
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 theUpdateIPSet
request. You can also use this value to query the status of the request. For more information, seeGetChangeTokenStatus
.
- On failure, responds with
SdkError<UpdateIPSetError>
Source§impl Client
impl Client
Sourcepub fn update_rate_based_rule(&self) -> UpdateRateBasedRuleFluentBuilder
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: trueThe
RuleId
of theRateBasedRule
that you want to update.RuleId
is returned byCreateRateBasedRule
and byListRateBasedRules
.change_token(impl Into<String>)
/set_change_token(Option<String>)
:
required: trueThe value returned by the most recent call to
GetChangeToken
.updates(RuleUpdate)
/set_updates(Option<Vec::<RuleUpdate>>)
:
required: trueAn array of
RuleUpdate
objects that you want to insert into or delete from aRateBasedRule
.rate_limit(i64)
/set_rate_limit(Option<i64>)
:
required: trueThe 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 theRateLimit
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 theUpdateRateBasedRule
request. You can also use this value to query the status of the request. For more information, seeGetChangeTokenStatus
.
- On failure, responds with
SdkError<UpdateRateBasedRuleError>
Source§impl Client
impl Client
Sourcepub fn update_regex_match_set(&self) -> UpdateRegexMatchSetFluentBuilder
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: trueThe
RegexMatchSetId
of theRegexMatchSet
that you want to update.RegexMatchSetId
is returned byCreateRegexMatchSet
and byListRegexMatchSets
.updates(RegexMatchSetUpdate)
/set_updates(Option<Vec::<RegexMatchSetUpdate>>)
:
required: trueAn array of
RegexMatchSetUpdate
objects that you want to insert into or delete from aRegexMatchSet
. For more information, seeRegexMatchTuple
.change_token(impl Into<String>)
/set_change_token(Option<String>)
:
required: trueThe 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 theUpdateRegexMatchSet
request. You can also use this value to query the status of the request. For more information, seeGetChangeTokenStatus
.
- On failure, responds with
SdkError<UpdateRegexMatchSetError>
Source§impl Client
impl Client
Sourcepub fn update_regex_pattern_set(&self) -> UpdateRegexPatternSetFluentBuilder
pub fn update_regex_pattern_set(&self) -> UpdateRegexPatternSetFluentBuilder
Constructs a fluent builder for the UpdateRegexPatternSet
operation.
- The fluent builder is configurable:
regex_pattern_set_id(impl Into<String>)
/set_regex_pattern_set_id(Option<String>)
:
required: trueThe
RegexPatternSetId
of theRegexPatternSet
that you want to update.RegexPatternSetId
is returned byCreateRegexPatternSet
and byListRegexPatternSets
.updates(RegexPatternSetUpdate)
/set_updates(Option<Vec::<RegexPatternSetUpdate>>)
:
required: trueAn array of
RegexPatternSetUpdate
objects that you want to insert into or delete from aRegexPatternSet
.change_token(impl Into<String>)
/set_change_token(Option<String>)
:
required: trueThe 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 theUpdateRegexPatternSet
request. You can also use this value to query the status of the request. For more information, seeGetChangeTokenStatus
.
- On failure, responds with
SdkError<UpdateRegexPatternSetError>
Source§impl Client
impl Client
Sourcepub fn update_rule(&self) -> UpdateRuleFluentBuilder
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: trueThe
RuleId
of theRule
that you want to update.RuleId
is returned byCreateRule
and byListRules
.change_token(impl Into<String>)
/set_change_token(Option<String>)
:
required: trueThe value returned by the most recent call to
GetChangeToken
.updates(RuleUpdate)
/set_updates(Option<Vec::<RuleUpdate>>)
:
required: trueAn array of
RuleUpdate
objects that you want to insert into or delete from aRule
. For more information, see the applicable data types:-
RuleUpdate
: ContainsAction
andPredicate
-
Predicate
: ContainsDataId
,Negated
, andType
-
FieldToMatch
: ContainsData
andType
-
- On success, responds with
UpdateRuleOutput
with field(s):change_token(Option<String>)
:The
ChangeToken
that you used to submit theUpdateRule
request. You can also use this value to query the status of the request. For more information, seeGetChangeTokenStatus
.
- On failure, responds with
SdkError<UpdateRuleError>
Source§impl Client
impl Client
Sourcepub fn update_rule_group(&self) -> UpdateRuleGroupFluentBuilder
pub fn update_rule_group(&self) -> UpdateRuleGroupFluentBuilder
Constructs a fluent builder for the UpdateRuleGroup
operation.
- The fluent builder is configurable:
rule_group_id(impl Into<String>)
/set_rule_group_id(Option<String>)
:
required: trueThe
RuleGroupId
of theRuleGroup
that you want to update.RuleGroupId
is returned byCreateRuleGroup
and byListRuleGroups
.updates(RuleGroupUpdate)
/set_updates(Option<Vec::<RuleGroupUpdate>>)
:
required: trueAn array of
RuleGroupUpdate
objects that you want to insert into or delete from aRuleGroup
.You can only insert
REGULAR
rules into a rule group.ActivatedRule|OverrideAction
applies only when updating or adding aRuleGroup
to aWebACL
. In this case you do not useActivatedRule|Action
. For all other update requests,ActivatedRule|Action
is used instead ofActivatedRule|OverrideAction
.change_token(impl Into<String>)
/set_change_token(Option<String>)
:
required: trueThe 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 theUpdateRuleGroup
request. You can also use this value to query the status of the request. For more information, seeGetChangeTokenStatus
.
- On failure, responds with
SdkError<UpdateRuleGroupError>
Source§impl Client
impl Client
Sourcepub fn update_size_constraint_set(&self) -> UpdateSizeConstraintSetFluentBuilder
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: trueThe
SizeConstraintSetId
of theSizeConstraintSet
that you want to update.SizeConstraintSetId
is returned byCreateSizeConstraintSet
and byListSizeConstraintSets
.change_token(impl Into<String>)
/set_change_token(Option<String>)
:
required: trueThe value returned by the most recent call to
GetChangeToken
.updates(SizeConstraintSetUpdate)
/set_updates(Option<Vec::<SizeConstraintSetUpdate>>)
:
required: trueAn array of
SizeConstraintSetUpdate
objects that you want to insert into or delete from aSizeConstraintSet
. For more information, see the applicable data types:-
SizeConstraintSetUpdate
: ContainsAction
andSizeConstraint
-
SizeConstraint
: ContainsFieldToMatch
,TextTransformation
,ComparisonOperator
, andSize
-
FieldToMatch
: ContainsData
andType
-
- On success, responds with
UpdateSizeConstraintSetOutput
with field(s):change_token(Option<String>)
:The
ChangeToken
that you used to submit theUpdateSizeConstraintSet
request. You can also use this value to query the status of the request. For more information, seeGetChangeTokenStatus
.
- On failure, responds with
SdkError<UpdateSizeConstraintSetError>
Source§impl Client
impl Client
Sourcepub fn update_sql_injection_match_set(
&self,
) -> UpdateSqlInjectionMatchSetFluentBuilder
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: trueThe
SqlInjectionMatchSetId
of theSqlInjectionMatchSet
that you want to update.SqlInjectionMatchSetId
is returned byCreateSqlInjectionMatchSet
and byListSqlInjectionMatchSets
.change_token(impl Into<String>)
/set_change_token(Option<String>)
:
required: trueThe value returned by the most recent call to
GetChangeToken
.updates(SqlInjectionMatchSetUpdate)
/set_updates(Option<Vec::<SqlInjectionMatchSetUpdate>>)
:
required: trueAn array of
SqlInjectionMatchSetUpdate
objects that you want to insert into or delete from aSqlInjectionMatchSet
. For more information, see the applicable data types:-
SqlInjectionMatchSetUpdate
: ContainsAction
andSqlInjectionMatchTuple
-
SqlInjectionMatchTuple
: ContainsFieldToMatch
andTextTransformation
-
FieldToMatch
: ContainsData
andType
-
- On success, responds with
UpdateSqlInjectionMatchSetOutput
with field(s):change_token(Option<String>)
:The
ChangeToken
that you used to submit theUpdateSqlInjectionMatchSet
request. You can also use this value to query the status of the request. For more information, seeGetChangeTokenStatus
.
- On failure, responds with
SdkError<UpdateSqlInjectionMatchSetError>
Source§impl Client
impl Client
Sourcepub fn update_web_acl(&self) -> UpdateWebACLFluentBuilder
pub fn update_web_acl(&self) -> UpdateWebACLFluentBuilder
Constructs a fluent builder for the UpdateWebACL
operation.
- The fluent builder is configurable:
web_acl_id(impl Into<String>)
/set_web_acl_id(Option<String>)
:
required: trueThe
WebACLId
of theWebACL
that you want to update.WebACLId
is returned byCreateWebACL
and byListWebACLs
.change_token(impl Into<String>)
/set_change_token(Option<String>)
:
required: trueThe value returned by the most recent call to
GetChangeToken
.updates(WebAclUpdate)
/set_updates(Option<Vec::<WebAclUpdate>>)
:
required: falseAn array of updates to make to the
WebACL
.An array of
WebACLUpdate
objects that you want to insert into or delete from aWebACL
. For more information, see the applicable data types:-
WebACLUpdate
: ContainsAction
andActivatedRule
-
ActivatedRule
: ContainsAction
,OverrideAction
,Priority
,RuleId
, andType
.ActivatedRule|OverrideAction
applies only when updating or adding aRuleGroup
to aWebACL
. In this case, you do not useActivatedRule|Action
. For all other update requests,ActivatedRule|Action
is used instead ofActivatedRule|OverrideAction
. -
WafAction
: ContainsType
-
default_action(WafAction)
/set_default_action(Option<WafAction>)
:
required: falseA 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 theUpdateWebACL
request. You can also use this value to query the status of the request. For more information, seeGetChangeTokenStatus
.
- On failure, responds with
SdkError<UpdateWebACLError>
Source§impl Client
impl Client
Sourcepub fn update_xss_match_set(&self) -> UpdateXssMatchSetFluentBuilder
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: trueThe
XssMatchSetId
of theXssMatchSet
that you want to update.XssMatchSetId
is returned byCreateXssMatchSet
and byListXssMatchSets
.change_token(impl Into<String>)
/set_change_token(Option<String>)
:
required: trueThe value returned by the most recent call to
GetChangeToken
.updates(XssMatchSetUpdate)
/set_updates(Option<Vec::<XssMatchSetUpdate>>)
:
required: trueAn array of
XssMatchSetUpdate
objects that you want to insert into or delete from anXssMatchSet
. For more information, see the applicable data types:-
XssMatchSetUpdate
: ContainsAction
andXssMatchTuple
-
XssMatchTuple
: ContainsFieldToMatch
andTextTransformation
-
FieldToMatch
: ContainsData
andType
-
- On success, responds with
UpdateXssMatchSetOutput
with field(s):change_token(Option<String>)
:The
ChangeToken
that you used to submit theUpdateXssMatchSet
request. You can also use this value to query the status of the request. For more information, seeGetChangeTokenStatus
.
- On failure, responds with
SdkError<UpdateXssMatchSetError>
Source§impl Client
impl Client
Sourcepub fn from_conf(conf: Config) -> Self
pub fn from_conf(conf: Config) -> Self
Creates a new client from the service Config
.
§Panics
This method will panic in the following cases:
- Retries or timeouts are enabled without a
sleep_impl
configured. - Identity caching is enabled without a
sleep_impl
andtime_source
configured. - No
behavior_version
is provided.
The panic message for each of these will have instructions on how to resolve them.
Source§impl Client
impl Client
Sourcepub fn new(sdk_config: &SdkConfig) -> Self
pub fn new(sdk_config: &SdkConfig) -> Self
Creates a new client from an SDK Config.
§Panics
- This method will panic if the
sdk_config
is missing an async sleep implementation. If you experience this panic, set thesleep_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 thehttp_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, setbehavior_version
on the Config or enable thebehavior-version-latest
Cargo feature.
Trait Implementations§
Auto Trait Implementations§
impl Freeze for Client
impl !RefUnwindSafe for Client
impl Send for Client
impl Sync for Client
impl Unpin for Client
impl !UnwindSafe for Client
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightBlack
.
§Example
println!("{}", value.bright_black());
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightGreen
.
§Example
println!("{}", value.bright_green());
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightYellow
.
§Example
println!("{}", value.bright_yellow());
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightMagenta
.
§Example
println!("{}", value.bright_magenta());
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightWhite
.
§Example
println!("{}", value.bright_white());
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightBlack
.
§Example
println!("{}", value.on_bright_black());
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightGreen
.
§Example
println!("{}", value.on_bright_green());
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightYellow
.
§Example
println!("{}", value.on_bright_yellow());
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightBlue
.
§Example
println!("{}", value.on_bright_blue());
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightMagenta
.
§Example
println!("{}", value.on_bright_magenta());
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightCyan
.
§Example
println!("{}", value.on_bright_cyan());
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightWhite
.
§Example
println!("{}", value.on_bright_white());
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn underline(&self) -> Painted<&T>
fn underline(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::Underline
.
§Example
println!("{}", value.underline());
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::RapidBlink
.
§Example
println!("{}", value.rapid_blink());
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);