Struct aws_sdk_wafv2::client::Client

source · [−]
pub struct Client<C = DynConnector, M = DefaultMiddleware, R = Standard> { /* private fields */ }
Expand description

Client for AWS WAFV2

Client for invoking operations on AWS WAFV2. Each operation on AWS WAFV2 is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Examples

Constructing a client and invoking an operation

    // create a shared configuration. This can be used & shared between multiple service clients.
    let shared_config = aws_config::load_from_env().await;
    let client = aws_sdk_wafv2::Client::new(&shared_config);
    // invoke an operation
    /* let rsp = client
        .<operation_name>().
        .<param>("some value")
        .send().await; */

Constructing a client with custom configuration

use aws_config::RetryConfig;
    let shared_config = aws_config::load_from_env().await;
    let config = aws_sdk_wafv2::config::Builder::from(&shared_config)
        .retry_config(RetryConfig::disabled())
        .build();
    let client = aws_sdk_wafv2::Client::from_conf(config);

Implementations

Creates a client with the given service configuration.

Returns the client’s configuration.

Constructs a fluent builder for the AssociateWebACL operation.

Constructs a fluent builder for the CheckCapacity operation.

  • The fluent builder is configurable:
    • scope(Scope) / set_scope(Option<Scope>):

      Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.

      To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

      • CLI - Specify the Region when you use the CloudFront scope: –scope=CLOUDFRONT –region=us-east-1.

      • API and SDKs - For all calls, use the Region endpoint us-east-1.

    • rules(Vec<Rule>) / set_rules(Option<Vec<Rule>>):

      An array of Rule that you’re configuring to use in a rule group or web ACL.

  • On success, responds with CheckCapacityOutput with field(s):
  • On failure, responds with SdkError<CheckCapacityError>

Constructs a fluent builder for the CreateIPSet operation.

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

      The name of the IP set. You cannot change the name of an IPSet after you create it.

    • scope(Scope) / set_scope(Option<Scope>):

      Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.

      To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

      • CLI - Specify the Region when you use the CloudFront scope: –scope=CLOUDFRONT –region=us-east-1.

      • API and SDKs - For all calls, use the Region endpoint us-east-1.

    • description(impl Into<String>) / set_description(Option<String>):

      A description of the IP set that helps with identification.

    • ip_address_version(IpAddressVersion) / set_ip_address_version(Option<IpAddressVersion>):

      The version of the IP addresses, either IPV4 or IPV6.

    • addresses(Vec<String>) / set_addresses(Option<Vec<String>>):

      Contains an array of strings that specify one or more IP addresses or blocks of IP addresses in Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0.

      Examples:

      • To configure WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32.

      • To configure WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24.

      • To configure WAF to allow, block, or count requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.

      • To configure WAF to allow, block, or count requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.

      For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.

    • tags(Vec<Tag>) / set_tags(Option<Vec<Tag>>):

      An array of key:value pairs to associate with the resource.

  • On success, responds with CreateIpSetOutput with field(s):
    • summary(Option<IpSetSummary>):

      High-level information about an IPSet, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage an IPSet, and the ARN, that you provide to the IPSetReferenceStatement to use the address set in a Rule.

  • On failure, responds with SdkError<CreateIPSetError>

Constructs a fluent builder for the CreateRegexPatternSet operation.

Constructs a fluent builder for the CreateRuleGroup operation.

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

      The name of the rule group. You cannot change the name of a rule group after you create it.

    • scope(Scope) / set_scope(Option<Scope>):

      Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.

      To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

      • CLI - Specify the Region when you use the CloudFront scope: –scope=CLOUDFRONT –region=us-east-1.

      • API and SDKs - For all calls, use the Region endpoint us-east-1.

    • capacity(i64) / set_capacity(i64):

      The web ACL capacity units (WCUs) required for this rule group.

      When you create your own rule group, you define this, and you cannot change it after creation. When you add or modify the rules in a rule group, WAF enforces this limit. You can check the capacity for a set of rules using CheckCapacity.

      WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. The WCU limit for web ACLs is 1,500.

    • description(impl Into<String>) / set_description(Option<String>):

      A description of the rule group that helps with identification.

    • rules(Vec<Rule>) / set_rules(Option<Vec<Rule>>):

      The Rule statements used to identify the web requests that you want to allow, block, or count. Each rule includes one top-level statement that WAF uses to identify matching web requests, and parameters that govern how WAF handles them.

    • visibility_config(VisibilityConfig) / set_visibility_config(Option<VisibilityConfig>):

      Defines and enables Amazon CloudWatch metrics and web request sample collection.

    • tags(Vec<Tag>) / set_tags(Option<Vec<Tag>>):

      An array of key:value pairs to associate with the resource.

    • custom_response_bodies(HashMap<String, CustomResponseBody>) / set_custom_response_bodies(Option<HashMap<String, CustomResponseBody>>):

      A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the rule group, and then use them in the rules that you define in the rule group.

      For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.

      For information about the limits on count and size for custom request and response settings, see WAF quotas in the WAF Developer Guide.

  • On success, responds with CreateRuleGroupOutput with field(s):
    • summary(Option<RuleGroupSummary>):

      High-level information about a RuleGroup, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage a RuleGroup, and the ARN, that you provide to the RuleGroupReferenceStatement to use the rule group in a Rule.

  • On failure, responds with SdkError<CreateRuleGroupError>

Constructs a fluent builder for the CreateWebACL operation.

Constructs a fluent builder for the DeleteFirewallManagerRuleGroups operation.

  • The fluent builder is configurable:
    • web_acl_arn(impl Into<String>) / set_web_acl_arn(Option<String>):

      The Amazon Resource Name (ARN) of the web ACL.

    • web_acl_lock_token(impl Into<String>) / set_web_acl_lock_token(Option<String>):

      A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

  • On success, responds with DeleteFirewallManagerRuleGroupsOutput with field(s):
    • next_web_acl_lock_token(Option<String>):

      A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

  • On failure, responds with SdkError<DeleteFirewallManagerRuleGroupsError>

Constructs a fluent builder for the DeleteIPSet operation.

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

      The name of the IP set. You cannot change the name of an IPSet after you create it.

    • scope(Scope) / set_scope(Option<Scope>):

      Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.

      To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

      • CLI - Specify the Region when you use the CloudFront scope: –scope=CLOUDFRONT –region=us-east-1.

      • API and SDKs - For all calls, use the Region endpoint us-east-1.

    • id(impl Into<String>) / set_id(Option<String>):

      A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

    • lock_token(impl Into<String>) / set_lock_token(Option<String>):

      A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

  • On success, responds with DeleteIpSetOutput
  • On failure, responds with SdkError<DeleteIPSetError>

Constructs a fluent builder for the DeleteLoggingConfiguration operation.

Constructs a fluent builder for the DeletePermissionPolicy operation.

Constructs a fluent builder for the DeleteRegexPatternSet operation.

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

      The name of the set. You cannot change the name after you create the set.

    • scope(Scope) / set_scope(Option<Scope>):

      Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.

      To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

      • CLI - Specify the Region when you use the CloudFront scope: –scope=CLOUDFRONT –region=us-east-1.

      • API and SDKs - For all calls, use the Region endpoint us-east-1.

    • id(impl Into<String>) / set_id(Option<String>):

      A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

    • lock_token(impl Into<String>) / set_lock_token(Option<String>):

      A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

  • On success, responds with DeleteRegexPatternSetOutput
  • On failure, responds with SdkError<DeleteRegexPatternSetError>

Constructs a fluent builder for the DeleteRuleGroup operation.

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

      The name of the rule group. You cannot change the name of a rule group after you create it.

    • scope(Scope) / set_scope(Option<Scope>):

      Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.

      To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

      • CLI - Specify the Region when you use the CloudFront scope: –scope=CLOUDFRONT –region=us-east-1.

      • API and SDKs - For all calls, use the Region endpoint us-east-1.

    • id(impl Into<String>) / set_id(Option<String>):

      A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

    • lock_token(impl Into<String>) / set_lock_token(Option<String>):

      A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

  • On success, responds with DeleteRuleGroupOutput
  • On failure, responds with SdkError<DeleteRuleGroupError>

Constructs a fluent builder for the DeleteWebACL operation.

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

      The name of the web ACL. You cannot change the name of a web ACL after you create it.

    • scope(Scope) / set_scope(Option<Scope>):

      Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.

      To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

      • CLI - Specify the Region when you use the CloudFront scope: –scope=CLOUDFRONT –region=us-east-1.

      • API and SDKs - For all calls, use the Region endpoint us-east-1.

    • id(impl Into<String>) / set_id(Option<String>):

      The unique identifier for the web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

    • lock_token(impl Into<String>) / set_lock_token(Option<String>):

      A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

  • On success, responds with DeleteWebAclOutput
  • On failure, responds with SdkError<DeleteWebACLError>

Constructs a fluent builder for the DescribeManagedRuleGroup operation.

  • The fluent builder is configurable:
    • vendor_name(impl Into<String>) / set_vendor_name(Option<String>):

      The name of the managed rule group vendor. You use this, along with the rule group name, to identify the rule group.

    • name(impl Into<String>) / set_name(Option<String>):

      The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.

    • scope(Scope) / set_scope(Option<Scope>):

      Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.

      To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

      • CLI - Specify the Region when you use the CloudFront scope: –scope=CLOUDFRONT –region=us-east-1.

      • API and SDKs - For all calls, use the Region endpoint us-east-1.

    • version_name(impl Into<String>) / set_version_name(Option<String>):

      The version of the rule group. You can only use a version that is not scheduled for expiration. If you don’t provide this, WAF uses the vendor’s default version.

  • On success, responds with DescribeManagedRuleGroupOutput with field(s):
    • version_name(Option<String>):

      The managed rule group’s version.

    • sns_topic_arn(Option<String>):

      The Amazon resource name (ARN) of the Amazon Simple Notification Service SNS topic that’s used to record changes to the managed rule group. You can subscribe to the SNS topic to receive notifications when the managed rule group is modified, such as for new versions and for version expiration. For more information, see the Amazon Simple Notification Service Developer Guide.

    • capacity(i64):

      The web ACL capacity units (WCUs) required for this rule group. WAF uses web ACL capacity units (WCU) to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. WAF calculates capacity differently for each rule type, to reflect each rule’s relative cost. Rule group capacity is fixed at creation, so users can plan their web ACL WCU usage when they use a rule group. The WCU limit for web ACLs is 1,500.

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

    • label_namespace(Option<String>):

      The label namespace prefix for this rule group. All labels added by rules in this rule group have this prefix.

      • The syntax for the label namespace prefix for a managed rule group is the following:

        awswaf:managed: : :

      • When a rule with a label matches a web request, WAF adds the fully qualified label to the request. A fully qualified label is made up of the label namespace from the rule group or web ACL where the rule is defined and the label from the rule, separated by a colon:

    • available_labels(Option<Vec<LabelSummary>>):

      The labels that one or more rules in this rule group add to matching web requests. These labels are defined in the RuleLabels for a Rule.

    • consumed_labels(Option<Vec<LabelSummary>>):

      The labels that one or more rules in this rule group match against in label match statements. These labels are defined in a LabelMatchStatement specification, in the Statement definition of a rule.

  • On failure, responds with SdkError<DescribeManagedRuleGroupError>

Constructs a fluent builder for the DisassociateWebACL operation.

  • The fluent builder is configurable:
    • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):

      The Amazon Resource Name (ARN) of the resource to disassociate from the web ACL.

      The ARN must be in one of the following formats:

      • For an Application Load Balancer: arn:aws:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id

      • For an Amazon API Gateway REST API: arn:aws:apigateway:region::/restapis/api-id/stages/stage-name

      • For an AppSync GraphQL API: arn:aws:appsync:region:account-id:apis/GraphQLApiId

  • On success, responds with DisassociateWebAclOutput
  • On failure, responds with SdkError<DisassociateWebACLError>

Constructs a fluent builder for the GetIPSet operation.

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

      The name of the IP set. You cannot change the name of an IPSet after you create it.

    • scope(Scope) / set_scope(Option<Scope>):

      Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.

      To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

      • CLI - Specify the Region when you use the CloudFront scope: –scope=CLOUDFRONT –region=us-east-1.

      • API and SDKs - For all calls, use the Region endpoint us-east-1.

    • id(impl Into<String>) / set_id(Option<String>):

      A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

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

    • lock_token(Option<String>):

      A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

  • On failure, responds with SdkError<GetIPSetError>

Constructs a fluent builder for the GetLoggingConfiguration operation.

Constructs a fluent builder for the GetManagedRuleSet operation.

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

      The name of the managed rule set. You use this, along with the rule set ID, to identify the rule set.

      This name is assigned to the corresponding managed rule group, which your customers can access and use.

    • scope(Scope) / set_scope(Option<Scope>):

      Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.

      To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

      • CLI - Specify the Region when you use the CloudFront scope: –scope=CLOUDFRONT –region=us-east-1.

      • API and SDKs - For all calls, use the Region endpoint us-east-1.

    • id(impl Into<String>) / set_id(Option<String>):

      A unique identifier for the managed rule set. The ID is returned in the responses to commands like list. You provide it to operations like get and update.

  • On success, responds with GetManagedRuleSetOutput with field(s):
    • managed_rule_set(Option<ManagedRuleSet>):

      The managed rule set that you requested.

    • lock_token(Option<String>):

      A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

  • On failure, responds with SdkError<GetManagedRuleSetError>

Constructs a fluent builder for the GetPermissionPolicy operation.

Constructs a fluent builder for the GetRateBasedStatementManagedKeys operation.

Constructs a fluent builder for the GetRegexPatternSet operation.

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

      The name of the set. You cannot change the name after you create the set.

    • scope(Scope) / set_scope(Option<Scope>):

      Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.

      To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

      • CLI - Specify the Region when you use the CloudFront scope: –scope=CLOUDFRONT –region=us-east-1.

      • API and SDKs - For all calls, use the Region endpoint us-east-1.

    • id(impl Into<String>) / set_id(Option<String>):

      A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

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

    • lock_token(Option<String>):

      A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

  • On failure, responds with SdkError<GetRegexPatternSetError>

Constructs a fluent builder for the GetRuleGroup operation.

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

      The name of the rule group. You cannot change the name of a rule group after you create it.

    • scope(Scope) / set_scope(Option<Scope>):

      Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.

      To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

      • CLI - Specify the Region when you use the CloudFront scope: –scope=CLOUDFRONT –region=us-east-1.

      • API and SDKs - For all calls, use the Region endpoint us-east-1.

    • id(impl Into<String>) / set_id(Option<String>):

      A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

    • arn(impl Into<String>) / set_arn(Option<String>):

      The Amazon Resource Name (ARN) of the entity.

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

    • lock_token(Option<String>):

      A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

  • On failure, responds with SdkError<GetRuleGroupError>

Constructs a fluent builder for the GetSampledRequests operation.

  • The fluent builder is configurable:
    • web_acl_arn(impl Into<String>) / set_web_acl_arn(Option<String>):

      The Amazon resource name (ARN) of the WebACL for which you want a sample of requests.

    • rule_metric_name(impl Into<String>) / set_rule_metric_name(Option<String>):

      The metric name assigned to the Rule or RuleGroup for which you want a sample of requests.

    • scope(Scope) / set_scope(Option<Scope>):

      Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.

      To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

      • CLI - Specify the Region when you use the CloudFront scope: –scope=CLOUDFRONT –region=us-east-1.

      • API and SDKs - For all calls, use the Region endpoint us-east-1.

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

      The start date and time and the end date and time of the range for which you want GetSampledRequests to return a sample of requests. You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, “2016-09-27T14:50Z”. You can specify any time range in the previous three hours. If you specify a start time that’s earlier than three hours ago, WAF sets it to three hours ago.

    • max_items(i64) / set_max_items(i64):

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

  • On success, responds with GetSampledRequestsOutput with field(s):
    • sampled_requests(Option<Vec<SampledHttpRequest>>):

      A complex type that contains detailed information about each of the requests in the sample.

    • population_size(i64):

      The total number of requests from which GetSampledRequests got a sample of MaxItems requests. If PopulationSize is less than MaxItems, the sample includes every request that your Amazon Web Services resource received during the specified time range.

    • time_window(Option<TimeWindow>):

      Usually, TimeWindow is the time range that you specified in the GetSampledRequests request. However, if your Amazon Web Services 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>

Constructs a fluent builder for the GetWebACL operation.

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

      The name of the web ACL. You cannot change the name of a web ACL after you create it.

    • scope(Scope) / set_scope(Option<Scope>):

      Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.

      To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

      • CLI - Specify the Region when you use the CloudFront scope: –scope=CLOUDFRONT –region=us-east-1.

      • API and SDKs - For all calls, use the Region endpoint us-east-1.

    • id(impl Into<String>) / set_id(Option<String>):

      The unique identifier for the web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

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

      The web ACL specification. You can modify the settings in this web ACL and use it to update this web ACL or create a new one.

    • lock_token(Option<String>):

      A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

  • On failure, responds with SdkError<GetWebACLError>

Constructs a fluent builder for the GetWebACLForResource operation.

Constructs a fluent builder for the ListAvailableManagedRuleGroups operation.

  • The fluent builder is configurable:
    • scope(Scope) / set_scope(Option<Scope>):

      Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.

      To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

      • CLI - Specify the Region when you use the CloudFront scope: –scope=CLOUDFRONT –region=us-east-1.

      • API and SDKs - For all calls, use the Region endpoint us-east-1.

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

      When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

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

      The maximum number of objects that you want WAF to return for this request. If more objects are available, in the response, WAF provides a NextMarker value that you can use in a subsequent call to get the next batch of objects.

  • On success, responds with ListAvailableManagedRuleGroupsOutput with field(s):
  • On failure, responds with SdkError<ListAvailableManagedRuleGroupsError>

Constructs a fluent builder for the ListAvailableManagedRuleGroupVersions operation.

  • The fluent builder is configurable:
    • vendor_name(impl Into<String>) / set_vendor_name(Option<String>):

      The name of the managed rule group vendor. You use this, along with the rule group name, to identify the rule group.

    • name(impl Into<String>) / set_name(Option<String>):

      The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.

    • scope(Scope) / set_scope(Option<Scope>):

      Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.

      To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

      • CLI - Specify the Region when you use the CloudFront scope: –scope=CLOUDFRONT –region=us-east-1.

      • API and SDKs - For all calls, use the Region endpoint us-east-1.

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

      When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

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

      The maximum number of objects that you want WAF to return for this request. If more objects are available, in the response, WAF provides a NextMarker value that you can use in a subsequent call to get the next batch of objects.

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

      When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

    • versions(Option<Vec<ManagedRuleGroupVersion>>):

      The versions that are currently available for the specified managed rule group.

  • On failure, responds with SdkError<ListAvailableManagedRuleGroupVersionsError>

Constructs a fluent builder for the ListIPSets operation.

  • The fluent builder is configurable:
    • scope(Scope) / set_scope(Option<Scope>):

      Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.

      To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

      • CLI - Specify the Region when you use the CloudFront scope: –scope=CLOUDFRONT –region=us-east-1.

      • API and SDKs - For all calls, use the Region endpoint us-east-1.

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

      When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

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

      The maximum number of objects that you want WAF to return for this request. If more objects are available, in the response, WAF provides a NextMarker value that you can use in a subsequent call to get the next batch of objects.

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

      When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

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

      Array of IPSets. This may not be the full list of IPSets that you have defined. See the Limit specification for this request.

  • On failure, responds with SdkError<ListIPSetsError>

Constructs a fluent builder for the ListLoggingConfigurations operation.

  • The fluent builder is configurable:
    • scope(Scope) / set_scope(Option<Scope>):

      Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.

      To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

      • CLI - Specify the Region when you use the CloudFront scope: –scope=CLOUDFRONT –region=us-east-1.

      • API and SDKs - For all calls, use the Region endpoint us-east-1.

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

      When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

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

      The maximum number of objects that you want WAF to return for this request. If more objects are available, in the response, WAF provides a NextMarker value that you can use in a subsequent call to get the next batch of objects.

  • On success, responds with ListLoggingConfigurationsOutput with field(s):
  • On failure, responds with SdkError<ListLoggingConfigurationsError>

Constructs a fluent builder for the ListManagedRuleSets operation.

  • The fluent builder is configurable:
    • scope(Scope) / set_scope(Option<Scope>):

      Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.

      To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

      • CLI - Specify the Region when you use the CloudFront scope: –scope=CLOUDFRONT –region=us-east-1.

      • API and SDKs - For all calls, use the Region endpoint us-east-1.

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

      When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

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

      The maximum number of objects that you want WAF to return for this request. If more objects are available, in the response, WAF provides a NextMarker value that you can use in a subsequent call to get the next batch of objects.

  • On success, responds with ListManagedRuleSetsOutput with field(s):
  • On failure, responds with SdkError<ListManagedRuleSetsError>

Constructs a fluent builder for the ListRegexPatternSets operation.

  • The fluent builder is configurable:
    • scope(Scope) / set_scope(Option<Scope>):

      Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.

      To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

      • CLI - Specify the Region when you use the CloudFront scope: –scope=CLOUDFRONT –region=us-east-1.

      • API and SDKs - For all calls, use the Region endpoint us-east-1.

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

      When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

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

      The maximum number of objects that you want WAF to return for this request. If more objects are available, in the response, WAF provides a NextMarker value that you can use in a subsequent call to get the next batch of objects.

  • On success, responds with ListRegexPatternSetsOutput with field(s):
  • On failure, responds with SdkError<ListRegexPatternSetsError>

Constructs a fluent builder for the ListResourcesForWebACL operation.

Constructs a fluent builder for the ListRuleGroups operation.

  • The fluent builder is configurable:
    • scope(Scope) / set_scope(Option<Scope>):

      Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.

      To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

      • CLI - Specify the Region when you use the CloudFront scope: –scope=CLOUDFRONT –region=us-east-1.

      • API and SDKs - For all calls, use the Region endpoint us-east-1.

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

      When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

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

      The maximum number of objects that you want WAF to return for this request. If more objects are available, in the response, WAF provides a NextMarker value that you can use in a subsequent call to get the next batch of objects.

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

      When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

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

  • On failure, responds with SdkError<ListRuleGroupsError>

Constructs a fluent builder for the ListTagsForResource operation.

Constructs a fluent builder for the ListWebACLs operation.

  • The fluent builder is configurable:
    • scope(Scope) / set_scope(Option<Scope>):

      Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.

      To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

      • CLI - Specify the Region when you use the CloudFront scope: –scope=CLOUDFRONT –region=us-east-1.

      • API and SDKs - For all calls, use the Region endpoint us-east-1.

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

      When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

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

      The maximum number of objects that you want WAF to return for this request. If more objects are available, in the response, WAF provides a NextMarker value that you can use in a subsequent call to get the next batch of objects.

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

      When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

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

  • On failure, responds with SdkError<ListWebACLsError>

Constructs a fluent builder for the PutLoggingConfiguration operation.

Constructs a fluent builder for the PutManagedRuleSetVersions operation.

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

      The name of the managed rule set. You use this, along with the rule set ID, to identify the rule set.

      This name is assigned to the corresponding managed rule group, which your customers can access and use.

    • scope(Scope) / set_scope(Option<Scope>):

      Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.

      To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

      • CLI - Specify the Region when you use the CloudFront scope: –scope=CLOUDFRONT –region=us-east-1.

      • API and SDKs - For all calls, use the Region endpoint us-east-1.

    • id(impl Into<String>) / set_id(Option<String>):

      A unique identifier for the managed rule set. The ID is returned in the responses to commands like list. You provide it to operations like get and update.

    • lock_token(impl Into<String>) / set_lock_token(Option<String>):

      A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

    • recommended_version(impl Into<String>) / set_recommended_version(Option<String>):

      The version of the named managed rule group that you’d like your customers to choose, from among your version offerings.

    • versions_to_publish(HashMap<String, VersionToPublish>) / set_versions_to_publish(Option<HashMap<String, VersionToPublish>>):

      The versions of the named managed rule group that you want to offer to your customers.

  • On success, responds with PutManagedRuleSetVersionsOutput with field(s):
    • next_lock_token(Option<String>):

      A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

  • On failure, responds with SdkError<PutManagedRuleSetVersionsError>

Constructs a fluent builder for the PutPermissionPolicy operation.

Constructs a fluent builder for the TagResource operation.

Constructs a fluent builder for the UntagResource operation.

Constructs a fluent builder for the UpdateIPSet operation.

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

      The name of the IP set. You cannot change the name of an IPSet after you create it.

    • scope(Scope) / set_scope(Option<Scope>):

      Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.

      To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

      • CLI - Specify the Region when you use the CloudFront scope: –scope=CLOUDFRONT –region=us-east-1.

      • API and SDKs - For all calls, use the Region endpoint us-east-1.

    • id(impl Into<String>) / set_id(Option<String>):

      A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

    • description(impl Into<String>) / set_description(Option<String>):

      A description of the IP set that helps with identification.

    • addresses(Vec<String>) / set_addresses(Option<Vec<String>>):

      Contains an array of strings that specify one or more IP addresses or blocks of IP addresses in Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0.

      Examples:

      • To configure WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32.

      • To configure WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24.

      • To configure WAF to allow, block, or count requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.

      • To configure WAF to allow, block, or count requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.

      For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.

    • lock_token(impl Into<String>) / set_lock_token(Option<String>):

      A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

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

      A token used for optimistic locking. WAF returns this token to your update requests. You use NextLockToken in the same manner as you use LockToken.

  • On failure, responds with SdkError<UpdateIPSetError>

Constructs a fluent builder for the UpdateManagedRuleSetVersionExpiryDate operation.

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

      The name of the managed rule set. You use this, along with the rule set ID, to identify the rule set.

      This name is assigned to the corresponding managed rule group, which your customers can access and use.

    • scope(Scope) / set_scope(Option<Scope>):

      Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.

      To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

      • CLI - Specify the Region when you use the CloudFront scope: –scope=CLOUDFRONT –region=us-east-1.

      • API and SDKs - For all calls, use the Region endpoint us-east-1.

    • id(impl Into<String>) / set_id(Option<String>):

      A unique identifier for the managed rule set. The ID is returned in the responses to commands like list. You provide it to operations like get and update.

    • lock_token(impl Into<String>) / set_lock_token(Option<String>):

      A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

    • version_to_expire(impl Into<String>) / set_version_to_expire(Option<String>):

      The version that you want to remove from your list of offerings for the named managed rule group.

    • expiry_timestamp(DateTime) / set_expiry_timestamp(Option<DateTime>):

      The time that you want the version to expire.

      Times are in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, “2016-09-27T14:50Z”.

  • On success, responds with UpdateManagedRuleSetVersionExpiryDateOutput with field(s):
    • expiring_version(Option<String>):

      The version that is set to expire.

    • expiry_timestamp(Option<DateTime>):

      The time that the version will expire.

      Times are in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, “2016-09-27T14:50Z”.

    • next_lock_token(Option<String>):

      A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

  • On failure, responds with SdkError<UpdateManagedRuleSetVersionExpiryDateError>

Constructs a fluent builder for the UpdateRegexPatternSet operation.

Constructs a fluent builder for the UpdateRuleGroup operation.

Constructs a fluent builder for the UpdateWebACL operation.

Creates a client with the given service config and connector override.

Creates a new client from a shared config.

Creates a new client from the service Config.

Trait Implementations

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Formats the value using the given formatter. Read more

Performs the conversion.

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Performs the conversion.

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Performs the conversion.

The resulting type after obtaining ownership.

Creates owned data from borrowed data, usually by cloning. Read more

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more