All Downloads are FREE. Search and download functionalities are using the official Maven repository.

commonMain.aws.sdk.kotlin.services.wafv2.Wafv2Client.kt Maven / Gradle / Ivy

The newest version!
// Code generated by smithy-kotlin-codegen. DO NOT EDIT!

package aws.sdk.kotlin.services.wafv2

import aws.sdk.kotlin.runtime.auth.credentials.DefaultChainCredentialsProvider
import aws.sdk.kotlin.runtime.auth.credentials.internal.manage
import aws.sdk.kotlin.runtime.client.AwsSdkClientConfig
import aws.sdk.kotlin.runtime.config.AbstractAwsSdkClientFactory
import aws.sdk.kotlin.runtime.config.endpoints.resolveEndpointUrl
import aws.sdk.kotlin.runtime.config.profile.AwsProfile
import aws.sdk.kotlin.runtime.config.profile.AwsSharedConfig
import aws.sdk.kotlin.runtime.http.retries.AwsRetryPolicy
import aws.sdk.kotlin.services.wafv2.auth.DefaultWafv2AuthSchemeProvider
import aws.sdk.kotlin.services.wafv2.auth.Wafv2AuthSchemeProvider
import aws.sdk.kotlin.services.wafv2.endpoints.DefaultWafv2EndpointProvider
import aws.sdk.kotlin.services.wafv2.endpoints.Wafv2EndpointParameters
import aws.sdk.kotlin.services.wafv2.endpoints.Wafv2EndpointProvider
import aws.sdk.kotlin.services.wafv2.model.AssociateWebAclRequest
import aws.sdk.kotlin.services.wafv2.model.AssociateWebAclResponse
import aws.sdk.kotlin.services.wafv2.model.CheckCapacityRequest
import aws.sdk.kotlin.services.wafv2.model.CheckCapacityResponse
import aws.sdk.kotlin.services.wafv2.model.CreateApiKeyRequest
import aws.sdk.kotlin.services.wafv2.model.CreateApiKeyResponse
import aws.sdk.kotlin.services.wafv2.model.CreateIpSetRequest
import aws.sdk.kotlin.services.wafv2.model.CreateIpSetResponse
import aws.sdk.kotlin.services.wafv2.model.CreateRegexPatternSetRequest
import aws.sdk.kotlin.services.wafv2.model.CreateRegexPatternSetResponse
import aws.sdk.kotlin.services.wafv2.model.CreateRuleGroupRequest
import aws.sdk.kotlin.services.wafv2.model.CreateRuleGroupResponse
import aws.sdk.kotlin.services.wafv2.model.CreateWebAclRequest
import aws.sdk.kotlin.services.wafv2.model.CreateWebAclResponse
import aws.sdk.kotlin.services.wafv2.model.DeleteApiKeyRequest
import aws.sdk.kotlin.services.wafv2.model.DeleteApiKeyResponse
import aws.sdk.kotlin.services.wafv2.model.DeleteFirewallManagerRuleGroupsRequest
import aws.sdk.kotlin.services.wafv2.model.DeleteFirewallManagerRuleGroupsResponse
import aws.sdk.kotlin.services.wafv2.model.DeleteIpSetRequest
import aws.sdk.kotlin.services.wafv2.model.DeleteIpSetResponse
import aws.sdk.kotlin.services.wafv2.model.DeleteLoggingConfigurationRequest
import aws.sdk.kotlin.services.wafv2.model.DeleteLoggingConfigurationResponse
import aws.sdk.kotlin.services.wafv2.model.DeletePermissionPolicyRequest
import aws.sdk.kotlin.services.wafv2.model.DeletePermissionPolicyResponse
import aws.sdk.kotlin.services.wafv2.model.DeleteRegexPatternSetRequest
import aws.sdk.kotlin.services.wafv2.model.DeleteRegexPatternSetResponse
import aws.sdk.kotlin.services.wafv2.model.DeleteRuleGroupRequest
import aws.sdk.kotlin.services.wafv2.model.DeleteRuleGroupResponse
import aws.sdk.kotlin.services.wafv2.model.DeleteWebAclRequest
import aws.sdk.kotlin.services.wafv2.model.DeleteWebAclResponse
import aws.sdk.kotlin.services.wafv2.model.DescribeAllManagedProductsRequest
import aws.sdk.kotlin.services.wafv2.model.DescribeAllManagedProductsResponse
import aws.sdk.kotlin.services.wafv2.model.DescribeManagedProductsByVendorRequest
import aws.sdk.kotlin.services.wafv2.model.DescribeManagedProductsByVendorResponse
import aws.sdk.kotlin.services.wafv2.model.DescribeManagedRuleGroupRequest
import aws.sdk.kotlin.services.wafv2.model.DescribeManagedRuleGroupResponse
import aws.sdk.kotlin.services.wafv2.model.DisassociateWebAclRequest
import aws.sdk.kotlin.services.wafv2.model.DisassociateWebAclResponse
import aws.sdk.kotlin.services.wafv2.model.GenerateMobileSdkReleaseUrlRequest
import aws.sdk.kotlin.services.wafv2.model.GenerateMobileSdkReleaseUrlResponse
import aws.sdk.kotlin.services.wafv2.model.GetDecryptedApiKeyRequest
import aws.sdk.kotlin.services.wafv2.model.GetDecryptedApiKeyResponse
import aws.sdk.kotlin.services.wafv2.model.GetIpSetRequest
import aws.sdk.kotlin.services.wafv2.model.GetIpSetResponse
import aws.sdk.kotlin.services.wafv2.model.GetLoggingConfigurationRequest
import aws.sdk.kotlin.services.wafv2.model.GetLoggingConfigurationResponse
import aws.sdk.kotlin.services.wafv2.model.GetManagedRuleSetRequest
import aws.sdk.kotlin.services.wafv2.model.GetManagedRuleSetResponse
import aws.sdk.kotlin.services.wafv2.model.GetMobileSdkReleaseRequest
import aws.sdk.kotlin.services.wafv2.model.GetMobileSdkReleaseResponse
import aws.sdk.kotlin.services.wafv2.model.GetPermissionPolicyRequest
import aws.sdk.kotlin.services.wafv2.model.GetPermissionPolicyResponse
import aws.sdk.kotlin.services.wafv2.model.GetRateBasedStatementManagedKeysRequest
import aws.sdk.kotlin.services.wafv2.model.GetRateBasedStatementManagedKeysResponse
import aws.sdk.kotlin.services.wafv2.model.GetRegexPatternSetRequest
import aws.sdk.kotlin.services.wafv2.model.GetRegexPatternSetResponse
import aws.sdk.kotlin.services.wafv2.model.GetRuleGroupRequest
import aws.sdk.kotlin.services.wafv2.model.GetRuleGroupResponse
import aws.sdk.kotlin.services.wafv2.model.GetSampledRequestsRequest
import aws.sdk.kotlin.services.wafv2.model.GetSampledRequestsResponse
import aws.sdk.kotlin.services.wafv2.model.GetWebAclForResourceRequest
import aws.sdk.kotlin.services.wafv2.model.GetWebAclForResourceResponse
import aws.sdk.kotlin.services.wafv2.model.GetWebAclRequest
import aws.sdk.kotlin.services.wafv2.model.GetWebAclResponse
import aws.sdk.kotlin.services.wafv2.model.ListApiKeysRequest
import aws.sdk.kotlin.services.wafv2.model.ListApiKeysResponse
import aws.sdk.kotlin.services.wafv2.model.ListAvailableManagedRuleGroupVersionsRequest
import aws.sdk.kotlin.services.wafv2.model.ListAvailableManagedRuleGroupVersionsResponse
import aws.sdk.kotlin.services.wafv2.model.ListAvailableManagedRuleGroupsRequest
import aws.sdk.kotlin.services.wafv2.model.ListAvailableManagedRuleGroupsResponse
import aws.sdk.kotlin.services.wafv2.model.ListIpSetsRequest
import aws.sdk.kotlin.services.wafv2.model.ListIpSetsResponse
import aws.sdk.kotlin.services.wafv2.model.ListLoggingConfigurationsRequest
import aws.sdk.kotlin.services.wafv2.model.ListLoggingConfigurationsResponse
import aws.sdk.kotlin.services.wafv2.model.ListManagedRuleSetsRequest
import aws.sdk.kotlin.services.wafv2.model.ListManagedRuleSetsResponse
import aws.sdk.kotlin.services.wafv2.model.ListMobileSdkReleasesRequest
import aws.sdk.kotlin.services.wafv2.model.ListMobileSdkReleasesResponse
import aws.sdk.kotlin.services.wafv2.model.ListRegexPatternSetsRequest
import aws.sdk.kotlin.services.wafv2.model.ListRegexPatternSetsResponse
import aws.sdk.kotlin.services.wafv2.model.ListResourcesForWebAclRequest
import aws.sdk.kotlin.services.wafv2.model.ListResourcesForWebAclResponse
import aws.sdk.kotlin.services.wafv2.model.ListRuleGroupsRequest
import aws.sdk.kotlin.services.wafv2.model.ListRuleGroupsResponse
import aws.sdk.kotlin.services.wafv2.model.ListTagsForResourceRequest
import aws.sdk.kotlin.services.wafv2.model.ListTagsForResourceResponse
import aws.sdk.kotlin.services.wafv2.model.ListWebAclsRequest
import aws.sdk.kotlin.services.wafv2.model.ListWebAclsResponse
import aws.sdk.kotlin.services.wafv2.model.PutLoggingConfigurationRequest
import aws.sdk.kotlin.services.wafv2.model.PutLoggingConfigurationResponse
import aws.sdk.kotlin.services.wafv2.model.PutManagedRuleSetVersionsRequest
import aws.sdk.kotlin.services.wafv2.model.PutManagedRuleSetVersionsResponse
import aws.sdk.kotlin.services.wafv2.model.PutPermissionPolicyRequest
import aws.sdk.kotlin.services.wafv2.model.PutPermissionPolicyResponse
import aws.sdk.kotlin.services.wafv2.model.TagResourceRequest
import aws.sdk.kotlin.services.wafv2.model.TagResourceResponse
import aws.sdk.kotlin.services.wafv2.model.UntagResourceRequest
import aws.sdk.kotlin.services.wafv2.model.UntagResourceResponse
import aws.sdk.kotlin.services.wafv2.model.UpdateIpSetRequest
import aws.sdk.kotlin.services.wafv2.model.UpdateIpSetResponse
import aws.sdk.kotlin.services.wafv2.model.UpdateManagedRuleSetVersionExpiryDateRequest
import aws.sdk.kotlin.services.wafv2.model.UpdateManagedRuleSetVersionExpiryDateResponse
import aws.sdk.kotlin.services.wafv2.model.UpdateRegexPatternSetRequest
import aws.sdk.kotlin.services.wafv2.model.UpdateRegexPatternSetResponse
import aws.sdk.kotlin.services.wafv2.model.UpdateRuleGroupRequest
import aws.sdk.kotlin.services.wafv2.model.UpdateRuleGroupResponse
import aws.sdk.kotlin.services.wafv2.model.UpdateWebAclRequest
import aws.sdk.kotlin.services.wafv2.model.UpdateWebAclResponse
import aws.smithy.kotlin.runtime.auth.awscredentials.CredentialsProvider
import aws.smithy.kotlin.runtime.auth.awscredentials.CredentialsProviderConfig
import aws.smithy.kotlin.runtime.awsprotocol.ClockSkewInterceptor
import aws.smithy.kotlin.runtime.client.AbstractSdkClientBuilder
import aws.smithy.kotlin.runtime.client.AbstractSdkClientFactory
import aws.smithy.kotlin.runtime.client.LogMode
import aws.smithy.kotlin.runtime.client.RetryClientConfig
import aws.smithy.kotlin.runtime.client.RetryStrategyClientConfig
import aws.smithy.kotlin.runtime.client.RetryStrategyClientConfigImpl
import aws.smithy.kotlin.runtime.client.SdkClient
import aws.smithy.kotlin.runtime.client.SdkClientConfig
import aws.smithy.kotlin.runtime.http.auth.AuthScheme
import aws.smithy.kotlin.runtime.http.auth.HttpAuthConfig
import aws.smithy.kotlin.runtime.http.config.HttpClientConfig
import aws.smithy.kotlin.runtime.http.config.HttpEngineConfig
import aws.smithy.kotlin.runtime.http.engine.HttpClientEngine
import aws.smithy.kotlin.runtime.http.engine.HttpEngineConfigImpl
import aws.smithy.kotlin.runtime.http.interceptors.HttpInterceptor
import aws.smithy.kotlin.runtime.net.url.Url
import aws.smithy.kotlin.runtime.retries.RetryStrategy
import aws.smithy.kotlin.runtime.retries.policy.RetryPolicy
import aws.smithy.kotlin.runtime.telemetry.Global
import aws.smithy.kotlin.runtime.telemetry.TelemetryConfig
import aws.smithy.kotlin.runtime.telemetry.TelemetryProvider
import aws.smithy.kotlin.runtime.util.LazyAsyncValue
import kotlin.collections.List
import kotlin.jvm.JvmStatic


public const val ServiceId: String = "WAFV2"
public const val SdkVersion: String = "1.3.76"
public const val ServiceApiVersion: String = "2019-07-29"

/**
 * # WAF
 * This is the latest version of the **WAF** API, released in November, 2019. The names of the entities that you use to access this API, like endpoints and namespaces, all have the versioning information added, like "V2" or "v2", to distinguish from the prior version. We recommend migrating your resources to this version, because it has a number of significant improvements.
 *
 * If you used WAF prior to this release, you can't use this WAFV2 API to access any WAF resources that you created before. WAF Classic support will end on September 30, 2025.
 *
 * For information about WAF, including how to migrate your WAF Classic resources to this version, see the [WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
 *
 * WAF is a web application firewall that lets you monitor the HTTP and HTTPS requests that are forwarded to an Amazon CloudFront distribution, Amazon API Gateway REST API, Application Load Balancer, AppSync GraphQL API, Amazon Cognito user pool, App Runner service, or Amazon Web Services Verified Access instance. WAF also lets you control access to your content, to protect the Amazon Web Services resource that WAF is monitoring. Based on conditions that you specify, such as the IP addresses that requests originate from or the values of query strings, the protected resource responds to requests with either the requested content, an HTTP 403 status code (Forbidden), or with a custom response.
 *
 * This API guide is for developers who need detailed information about WAF API actions, data types, and errors. For detailed information about WAF features and guidance for configuring and using WAF, see the [WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/what-is-aws-waf.html).
 *
 * You can make calls using the endpoints listed in [WAF endpoints and quotas](https://docs.aws.amazon.com/general/latest/gr/waf.html).
 * + For regional applications, you can use any of the endpoints in the list. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
 * + For Amazon CloudFront applications, you must use the API endpoint listed for US East (N. Virginia): us-east-1.
 *
 * Alternatively, you can use one of the Amazon Web Services SDKs to access an API that's tailored to the programming language or platform that you're using. For more information, see [Amazon Web Services SDKs](http://aws.amazon.com/tools/#SDKs).
 */
public interface Wafv2Client : SdkClient {
    /**
     * Wafv2Client's configuration
     */
    public override val config: Config

    public companion object : AbstractAwsSdkClientFactory()
     {
        @JvmStatic
        override fun builder(): Builder = Builder()

        override fun finalizeConfig(builder: Builder) {
            super.finalizeConfig(builder)
            builder.config.interceptors.add(0, ClockSkewInterceptor())
        }

        override suspend fun finalizeEnvironmentalConfig(builder: Builder, sharedConfig: LazyAsyncValue, activeProfile: LazyAsyncValue) {
            super.finalizeEnvironmentalConfig(builder, sharedConfig, activeProfile)
            builder.config.endpointUrl = builder.config.endpointUrl ?: resolveEndpointUrl(
                sharedConfig,
                "Wafv2",
                "WAFV2",
                "wafv2",
            )
        }
    }

    public class Builder internal constructor(): AbstractSdkClientBuilder() {
        override val config: Config.Builder = Config.Builder()
        override fun newClient(config: Config): Wafv2Client = DefaultWafv2Client(config)
    }

    public class Config private constructor(builder: Builder) : AwsSdkClientConfig, CredentialsProviderConfig, HttpAuthConfig, HttpClientConfig, HttpEngineConfig by builder.buildHttpEngineConfig(), RetryClientConfig, RetryStrategyClientConfig by builder.buildRetryStrategyClientConfig(), SdkClientConfig, TelemetryConfig {
        override val clientName: String = builder.clientName
        override val region: String? = builder.region
        override val authSchemes: kotlin.collections.List = builder.authSchemes
        override val credentialsProvider: CredentialsProvider = builder.credentialsProvider ?: DefaultChainCredentialsProvider(httpClient = httpClient, region = region).manage()
        public val endpointProvider: Wafv2EndpointProvider = builder.endpointProvider ?: DefaultWafv2EndpointProvider()
        public val endpointUrl: Url? = builder.endpointUrl
        override val interceptors: kotlin.collections.List = builder.interceptors
        override val logMode: LogMode = builder.logMode ?: LogMode.Default
        override val retryPolicy: RetryPolicy = builder.retryPolicy ?: AwsRetryPolicy.Default
        override val telemetryProvider: TelemetryProvider = builder.telemetryProvider ?: TelemetryProvider.Global
        override val useDualStack: Boolean = builder.useDualStack ?: false
        override val useFips: Boolean = builder.useFips ?: false
        override val applicationId: String? = builder.applicationId
        public val authSchemeProvider: Wafv2AuthSchemeProvider = builder.authSchemeProvider ?: DefaultWafv2AuthSchemeProvider()
        public companion object {
            public inline operator fun invoke(block: Builder.() -> kotlin.Unit): Config = Builder().apply(block).build()
        }

        public fun toBuilder(): Builder = Builder().apply {
            clientName = [email protected]
            region = [email protected]
            authSchemes = [email protected]
            credentialsProvider = [email protected]
            endpointProvider = [email protected]
            endpointUrl = [email protected]
            httpClient = [email protected]
            interceptors = [email protected]()
            logMode = [email protected]
            retryPolicy = [email protected]
            retryStrategy = [email protected]
            telemetryProvider = [email protected]
            useDualStack = [email protected]
            useFips = [email protected]
            applicationId = [email protected]
            authSchemeProvider = [email protected]
        }

        public class Builder : AwsSdkClientConfig.Builder, CredentialsProviderConfig.Builder, HttpAuthConfig.Builder, HttpClientConfig.Builder, HttpEngineConfig.Builder by HttpEngineConfigImpl.BuilderImpl(), RetryClientConfig.Builder, RetryStrategyClientConfig.Builder by RetryStrategyClientConfigImpl.BuilderImpl(), SdkClientConfig.Builder, TelemetryConfig.Builder {
            /**
             * A reader-friendly name for the client.
             */
            override var clientName: String = "WAFV2"

            /**
             * The AWS region (e.g. `us-west-2`) to make requests to. See about AWS
             * [global infrastructure](https://aws.amazon.com/about-aws/global-infrastructure/regions_az/) for more
             * information
             */
            override var region: String? = null

            /**
             * Register new or override default [AuthScheme]s configured for this client. By default, the set
             * of auth schemes configured comes from the service model. An auth scheme configured explicitly takes
             * precedence over the defaults and can be used to customize identity resolution and signing for specific
             * authentication schemes.
             */
            override var authSchemes: kotlin.collections.List = emptyList()

            /**
             * The AWS credentials provider to use for authenticating requests. If not provided a
             * [aws.sdk.kotlin.runtime.auth.credentials.DefaultChainCredentialsProvider] instance will be used.
             * NOTE: The caller is responsible for managing the lifetime of the provider when set. The SDK
             * client will not close it when the client is closed.
             */
            override var credentialsProvider: CredentialsProvider? = null

            /**
             * The endpoint provider used to determine where to make service requests. **This is an advanced config
             * option.**
             *
             * Endpoint resolution occurs as part of the workflow for every request made via the service client.
             *
             * The inputs to endpoint resolution are defined on a per-service basis (see [EndpointParameters]).
             */
            public var endpointProvider: Wafv2EndpointProvider? = null

            /**
             * A custom endpoint to route requests to. The endpoint set here is passed to the configured
             * [endpointProvider], which may inspect and modify it as needed.
             *
             * Setting a custom endpointUrl should generally be preferred to overriding the [endpointProvider] and is
             * the recommended way to route requests to development or preview instances of a service.
             *
             * **This is an advanced config option.**
             */
            public var endpointUrl: Url? = null

            /**
             * Add an [aws.smithy.kotlin.runtime.client.Interceptor] that will have access to read and modify
             * the request and response objects as they are processed by the SDK.
             * Interceptors added using this method are executed in the order they are configured and are always
             * later than any added automatically by the SDK.
             */
            override var interceptors: kotlin.collections.MutableList = kotlin.collections.mutableListOf()

            /**
             * Configure events that will be logged. By default clients will not output
             * raw requests or responses. Use this setting to opt-in to additional debug logging.
             *
             * This can be used to configure logging of requests, responses, retries, etc of SDK clients.
             *
             * **NOTE**: Logging of raw requests or responses may leak sensitive information! It may also have
             * performance considerations when dumping the request/response body. This is primarily a tool for
             * debug purposes.
             */
            override var logMode: LogMode? = null

            /**
             * The policy to use for evaluating operation results and determining whether/how to retry.
             */
            override var retryPolicy: RetryPolicy? = null

            /**
             * The telemetry provider used to instrument the SDK operations with. By default, the global telemetry
             * provider will be used.
             */
            override var telemetryProvider: TelemetryProvider? = null

            /**
             *            Flag to toggle whether to use dual-stack endpoints when making requests.
             *            See [https://docs.aws.amazon.com/sdkref/latest/guide/feature-endpoints.html] for more information.
             * `          Disabled by default.
             */
            override var useDualStack: Boolean? = null

            /**
             *            Flag to toggle whether to use [FIPS](https://aws.amazon.com/compliance/fips/) endpoints when making requests.
             * `          Disabled by default.
             */
            override var useFips: Boolean? = null

            /**
             * An optional application specific identifier.
             * When set it will be appended to the User-Agent header of every request in the form of: `app/{applicationId}`.
             * When not explicitly set, the value will be loaded from the following locations:
             *
             * - JVM System Property: `aws.userAgentAppId`
             * - Environment variable: `AWS_SDK_UA_APP_ID`
             * - Shared configuration profile attribute: `sdk_ua_app_id`
             *
             * See [shared configuration settings](https://docs.aws.amazon.com/sdkref/latest/guide/settings-reference.html)
             * reference for more information on environment variables and shared config settings.
             */
            override var applicationId: String? = null

            /**
             * Configure the provider used to resolve the authentication scheme to use for a particular operation.
             */
            public var authSchemeProvider: Wafv2AuthSchemeProvider? = null

            override fun build(): Config = Config(this)
        }
    }

    /**
     * Associates a web ACL with a regional application resource, to protect the resource. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
     *
     * For Amazon CloudFront, don't use this call. Instead, use your CloudFront distribution configuration. To associate a web ACL, in the CloudFront call `UpdateDistribution`, set the web ACL ID to the Amazon Resource Name (ARN) of the web ACL. For information, see [UpdateDistribution](https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_UpdateDistribution.html) in the *Amazon CloudFront Developer Guide*.
     *
     * **Required permissions for customer-managed IAM policies**
     *
     * This call requires permissions that are specific to the protected resource type. For details, see [Permissions for AssociateWebACL](https://docs.aws.amazon.com/waf/latest/developerguide/security_iam_service-with-iam.html#security_iam_action-AssociateWebACL) in the *WAF Developer Guide*.
     *
     * **Temporary inconsistencies during updates**
     *
     * When you create or change a web ACL or other WAF resources, the changes take a small amount of time to propagate to all areas where the resources are stored. The propagation time can be from a few seconds to a number of minutes.
     *
     * The following are examples of the temporary inconsistencies that you might notice during change propagation:
     * + After you create a web ACL, if you try to associate it with a resource, you might get an exception indicating that the web ACL is unavailable.
     * + After you add a rule group to a web ACL, the new rule group rules might be in effect in one area where the web ACL is used and not in another.
     * + After you change a rule action setting, you might see the old action in some places and the new action in others.
     * + After you add an IP address to an IP set that is in use in a blocking rule, the new address might be blocked in one area while still allowed in another.
     */
    public suspend fun associateWebAcl(input: AssociateWebAclRequest): AssociateWebAclResponse

    /**
     * Returns the web ACL capacity unit (WCU) requirements for a specified scope and set of rules. You can use this to check the capacity requirements for the rules you want to use in a RuleGroup or WebACL.
     *
     * WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. For more information, see [WAF web ACL capacity units (WCU)](https://docs.aws.amazon.com/waf/latest/developerguide/aws-waf-capacity-units.html) in the *WAF Developer Guide*.
     */
    public suspend fun checkCapacity(input: CheckCapacityRequest): CheckCapacityResponse

    /**
     * Creates an API key that contains a set of token domains.
     *
     * API keys are required for the integration of the CAPTCHA API in your JavaScript client applications. The API lets you customize the placement and characteristics of the CAPTCHA puzzle for your end users. For more information about the CAPTCHA JavaScript integration, see [WAF client application integration](https://docs.aws.amazon.com/waf/latest/developerguide/waf-application-integration.html) in the *WAF Developer Guide*.
     *
     * You can use a single key for up to 5 domains. After you generate a key, you can copy it for use in your JavaScript integration.
     */
    public suspend fun createApiKey(input: CreateApiKeyRequest): CreateApiKeyResponse

    /**
     * Creates an IPSet, which you use to identify web requests that originate from specific IP addresses or ranges of IP addresses. For example, if you're receiving a lot of requests from a ranges of IP addresses, you can configure WAF to block them using an IPSet that lists those IP addresses.
     */
    public suspend fun createIpSet(input: CreateIpSetRequest): CreateIpSetResponse

    /**
     * Creates a RegexPatternSet, which you reference in a RegexPatternSetReferenceStatement, to have WAF inspect a web request component for the specified patterns.
     */
    public suspend fun createRegexPatternSet(input: CreateRegexPatternSetRequest): CreateRegexPatternSetResponse

    /**
     * Creates a RuleGroup per the specifications provided.
     *
     *  A rule group defines a collection of rules to inspect and control web requests that you can use in a WebACL. When you create a rule group, you define an immutable capacity limit. If you update a rule group, you must stay within the capacity. This allows others to reuse the rule group with confidence in its capacity requirements.
     */
    public suspend fun createRuleGroup(input: CreateRuleGroupRequest): CreateRuleGroupResponse

    /**
     * Creates a WebACL per the specifications provided.
     *
     *  A web ACL defines a collection of rules to use to inspect and control web requests. Each rule has a statement that defines what to look for in web requests and an action that WAF applies to requests that match the statement. In the web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a web ACL can be a combination of the types Rule, RuleGroup, and managed rule group. You can associate a web ACL with one or more Amazon Web Services resources to protect. The resources can be an Amazon CloudFront distribution, an Amazon API Gateway REST API, an Application Load Balancer, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
     */
    public suspend fun createWebAcl(input: CreateWebAclRequest): CreateWebAclResponse

    /**
     * Deletes the specified API key.
     *
     * After you delete a key, it can take up to 24 hours for WAF to disallow use of the key in all regions.
     */
    public suspend fun deleteApiKey(input: DeleteApiKeyRequest): DeleteApiKeyResponse

    /**
     * Deletes all rule groups that are managed by Firewall Manager from the specified WebACL.
     *
     * You can only use this if `ManagedByFirewallManager` and `RetrofittedByFirewallManager` are both false in the web ACL.
     */
    public suspend fun deleteFirewallManagerRuleGroups(input: DeleteFirewallManagerRuleGroupsRequest): DeleteFirewallManagerRuleGroupsResponse

    /**
     * Deletes the specified IPSet.
     */
    public suspend fun deleteIpSet(input: DeleteIpSetRequest): DeleteIpSetResponse

    /**
     * Deletes the LoggingConfiguration from the specified web ACL.
     */
    public suspend fun deleteLoggingConfiguration(input: DeleteLoggingConfigurationRequest): DeleteLoggingConfigurationResponse

    /**
     * Permanently deletes an IAM policy from the specified rule group.
     *
     * You must be the owner of the rule group to perform this operation.
     */
    public suspend fun deletePermissionPolicy(input: DeletePermissionPolicyRequest): DeletePermissionPolicyResponse

    /**
     * Deletes the specified RegexPatternSet.
     */
    public suspend fun deleteRegexPatternSet(input: DeleteRegexPatternSetRequest): DeleteRegexPatternSetResponse

    /**
     * Deletes the specified RuleGroup.
     */
    public suspend fun deleteRuleGroup(input: DeleteRuleGroupRequest): DeleteRuleGroupResponse

    /**
     * Deletes the specified WebACL.
     *
     * You can only use this if `ManagedByFirewallManager` is false in the web ACL.
     *
     * Before deleting any web ACL, first disassociate it from all resources.
     * + To retrieve a list of the resources that are associated with a web ACL, use the following calls:
     *    + For regional resources, call ListResourcesForWebACL.
     *    + For Amazon CloudFront distributions, use the CloudFront call `ListDistributionsByWebACLId`. For information, see [ListDistributionsByWebACLId](https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_ListDistributionsByWebACLId.html) in the *Amazon CloudFront API Reference*.
     * + To disassociate a resource from a web ACL, use the following calls:
     *    + For regional resources, call DisassociateWebACL.
     *    + For Amazon CloudFront distributions, provide an empty web ACL ID in the CloudFront call `UpdateDistribution`. For information, see [UpdateDistribution](https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_UpdateDistribution.html) in the *Amazon CloudFront API Reference*.
     */
    public suspend fun deleteWebAcl(input: DeleteWebAclRequest): DeleteWebAclResponse

    /**
     * Provides high-level information for the Amazon Web Services Managed Rules rule groups and Amazon Web Services Marketplace managed rule groups.
     */
    public suspend fun describeAllManagedProducts(input: DescribeAllManagedProductsRequest): DescribeAllManagedProductsResponse

    /**
     * Provides high-level information for the managed rule groups owned by a specific vendor.
     */
    public suspend fun describeManagedProductsByVendor(input: DescribeManagedProductsByVendorRequest): DescribeManagedProductsByVendorResponse

    /**
     * Provides high-level information for a managed rule group, including descriptions of the rules.
     */
    public suspend fun describeManagedRuleGroup(input: DescribeManagedRuleGroupRequest): DescribeManagedRuleGroupResponse

    /**
     * Disassociates the specified regional application resource from any existing web ACL association. A resource can have at most one web ACL association. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
     *
     * For Amazon CloudFront, don't use this call. Instead, use your CloudFront distribution configuration. To disassociate a web ACL, provide an empty web ACL ID in the CloudFront call `UpdateDistribution`. For information, see [UpdateDistribution](https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_UpdateDistribution.html) in the *Amazon CloudFront API Reference*.
     *
     * **Required permissions for customer-managed IAM policies**
     *
     * This call requires permissions that are specific to the protected resource type. For details, see [Permissions for DisassociateWebACL](https://docs.aws.amazon.com/waf/latest/developerguide/security_iam_service-with-iam.html#security_iam_action-DisassociateWebACL) in the *WAF Developer Guide*.
     */
    public suspend fun disassociateWebAcl(input: DisassociateWebAclRequest): DisassociateWebAclResponse

    /**
     * Generates a presigned download URL for the specified release of the mobile SDK.
     *
     * The mobile SDK is not generally available. Customers who have access to the mobile SDK can use it to establish and manage WAF tokens for use in HTTP(S) requests from a mobile device to WAF. For more information, see [WAF client application integration](https://docs.aws.amazon.com/waf/latest/developerguide/waf-application-integration.html) in the *WAF Developer Guide*.
     */
    public suspend fun generateMobileSdkReleaseUrl(input: GenerateMobileSdkReleaseUrlRequest): GenerateMobileSdkReleaseUrlResponse

    /**
     * Returns your API key in decrypted form. Use this to check the token domains that you have defined for the key.
     *
     * API keys are required for the integration of the CAPTCHA API in your JavaScript client applications. The API lets you customize the placement and characteristics of the CAPTCHA puzzle for your end users. For more information about the CAPTCHA JavaScript integration, see [WAF client application integration](https://docs.aws.amazon.com/waf/latest/developerguide/waf-application-integration.html) in the *WAF Developer Guide*.
     */
    public suspend fun getDecryptedApiKey(input: GetDecryptedApiKeyRequest): GetDecryptedApiKeyResponse

    /**
     * Retrieves the specified IPSet.
     */
    public suspend fun getIpSet(input: GetIpSetRequest): GetIpSetResponse

    /**
     * Returns the LoggingConfiguration for the specified web ACL.
     */
    public suspend fun getLoggingConfiguration(input: GetLoggingConfigurationRequest): GetLoggingConfigurationResponse

    /**
     * Retrieves the specified managed rule set.
     *
     * This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.
     *
     * Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are `ListManagedRuleSets`, `GetManagedRuleSet`, `PutManagedRuleSetVersions`, and `UpdateManagedRuleSetVersionExpiryDate`.
     */
    public suspend fun getManagedRuleSet(input: GetManagedRuleSetRequest): GetManagedRuleSetResponse

    /**
     * Retrieves information for the specified mobile SDK release, including release notes and tags.
     *
     * The mobile SDK is not generally available. Customers who have access to the mobile SDK can use it to establish and manage WAF tokens for use in HTTP(S) requests from a mobile device to WAF. For more information, see [WAF client application integration](https://docs.aws.amazon.com/waf/latest/developerguide/waf-application-integration.html) in the *WAF Developer Guide*.
     */
    public suspend fun getMobileSdkRelease(input: GetMobileSdkReleaseRequest): GetMobileSdkReleaseResponse

    /**
     * Returns the IAM policy that is attached to the specified rule group.
     *
     * You must be the owner of the rule group to perform this operation.
     */
    public suspend fun getPermissionPolicy(input: GetPermissionPolicyRequest): GetPermissionPolicyResponse

    /**
     * Retrieves the IP addresses that are currently blocked by a rate-based rule instance. This is only available for rate-based rules that aggregate solely on the IP address or on the forwarded IP address.
     *
     * The maximum number of addresses that can be blocked for a single rate-based rule instance is 10,000. If more than 10,000 addresses exceed the rate limit, those with the highest rates are blocked.
     *
     * For a rate-based rule that you've defined inside a rule group, provide the name of the rule group reference statement in your request, in addition to the rate-based rule name and the web ACL name.
     *
     * WAF monitors web requests and manages keys independently for each unique combination of web ACL, optional rule group, and rate-based rule. For example, if you define a rate-based rule inside a rule group, and then use the rule group in a web ACL, WAF monitors web requests and manages keys for that web ACL, rule group reference statement, and rate-based rule instance. If you use the same rule group in a second web ACL, WAF monitors web requests and manages keys for this second usage completely independent of your first.
     */
    public suspend fun getRateBasedStatementManagedKeys(input: GetRateBasedStatementManagedKeysRequest): GetRateBasedStatementManagedKeysResponse

    /**
     * Retrieves the specified RegexPatternSet.
     */
    public suspend fun getRegexPatternSet(input: GetRegexPatternSetRequest): GetRegexPatternSetResponse

    /**
     * Retrieves the specified RuleGroup.
     */
    public suspend fun getRuleGroup(input: GetRuleGroupRequest = GetRuleGroupRequest { }): GetRuleGroupResponse

    /**
     * Gets detailed information about a specified number of requests--a sample--that WAF randomly selects from among the first 5,000 requests that your Amazon Web Services resource received during a time range that you choose. You can specify a sample size of up to 500 requests, and you can specify any time range in the previous three hours.
     *
     * `GetSampledRequests` returns a time range, which is usually the time range that you specified. However, if your resource (such as a CloudFront distribution) received 5,000 requests before the specified time range elapsed, `GetSampledRequests` returns an updated time range. This new time range indicates the actual period during which WAF selected the requests in the sample.
     */
    public suspend fun getSampledRequests(input: GetSampledRequestsRequest): GetSampledRequestsResponse

    /**
     * Retrieves the specified WebACL.
     */
    public suspend fun getWebAcl(input: GetWebAclRequest): GetWebAclResponse

    /**
     * Retrieves the WebACL for the specified resource.
     *
     * This call uses `GetWebACL`, to verify that your account has permission to access the retrieved web ACL. If you get an error that indicates that your account isn't authorized to perform `wafv2:GetWebACL` on the resource, that error won't be included in your CloudTrail event history.
     *
     * For Amazon CloudFront, don't use this call. Instead, call the CloudFront action `GetDistributionConfig`. For information, see [GetDistributionConfig](https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_GetDistributionConfig.html) in the *Amazon CloudFront API Reference*.
     *
     * **Required permissions for customer-managed IAM policies**
     *
     * This call requires permissions that are specific to the protected resource type. For details, see [Permissions for GetWebACLForResource](https://docs.aws.amazon.com/waf/latest/developerguide/security_iam_service-with-iam.html#security_iam_action-GetWebACLForResource) in the *WAF Developer Guide*.
     */
    public suspend fun getWebAclForResource(input: GetWebAclForResourceRequest): GetWebAclForResourceResponse

    /**
     * Retrieves a list of the API keys that you've defined for the specified scope.
     *
     * API keys are required for the integration of the CAPTCHA API in your JavaScript client applications. The API lets you customize the placement and characteristics of the CAPTCHA puzzle for your end users. For more information about the CAPTCHA JavaScript integration, see [WAF client application integration](https://docs.aws.amazon.com/waf/latest/developerguide/waf-application-integration.html) in the *WAF Developer Guide*.
     */
    public suspend fun listApiKeys(input: ListApiKeysRequest): ListApiKeysResponse

    /**
     * Returns a list of the available versions for the specified managed rule group.
     */
    public suspend fun listAvailableManagedRuleGroupVersions(input: ListAvailableManagedRuleGroupVersionsRequest): ListAvailableManagedRuleGroupVersionsResponse

    /**
     * Retrieves an array of managed rule groups that are available for you to use. This list includes all Amazon Web Services Managed Rules rule groups and all of the Amazon Web Services Marketplace managed rule groups that you're subscribed to.
     */
    public suspend fun listAvailableManagedRuleGroups(input: ListAvailableManagedRuleGroupsRequest): ListAvailableManagedRuleGroupsResponse

    /**
     * Retrieves an array of IPSetSummary objects for the IP sets that you manage.
     */
    public suspend fun listIpSets(input: ListIpSetsRequest): ListIpSetsResponse

    /**
     * Retrieves an array of your LoggingConfiguration objects.
     */
    public suspend fun listLoggingConfigurations(input: ListLoggingConfigurationsRequest): ListLoggingConfigurationsResponse

    /**
     * Retrieves the managed rule sets that you own.
     *
     * This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.
     *
     * Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are `ListManagedRuleSets`, `GetManagedRuleSet`, `PutManagedRuleSetVersions`, and `UpdateManagedRuleSetVersionExpiryDate`.
     */
    public suspend fun listManagedRuleSets(input: ListManagedRuleSetsRequest): ListManagedRuleSetsResponse

    /**
     * Retrieves a list of the available releases for the mobile SDK and the specified device platform.
     *
     * The mobile SDK is not generally available. Customers who have access to the mobile SDK can use it to establish and manage WAF tokens for use in HTTP(S) requests from a mobile device to WAF. For more information, see [WAF client application integration](https://docs.aws.amazon.com/waf/latest/developerguide/waf-application-integration.html) in the *WAF Developer Guide*.
     */
    public suspend fun listMobileSdkReleases(input: ListMobileSdkReleasesRequest): ListMobileSdkReleasesResponse

    /**
     * Retrieves an array of RegexPatternSetSummary objects for the regex pattern sets that you manage.
     */
    public suspend fun listRegexPatternSets(input: ListRegexPatternSetsRequest): ListRegexPatternSetsResponse

    /**
     * Retrieves an array of the Amazon Resource Names (ARNs) for the regional resources that are associated with the specified web ACL.
     *
     * For Amazon CloudFront, don't use this call. Instead, use the CloudFront call `ListDistributionsByWebACLId`. For information, see [ListDistributionsByWebACLId](https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_ListDistributionsByWebACLId.html) in the *Amazon CloudFront API Reference*.
     *
     * **Required permissions for customer-managed IAM policies**
     *
     * This call requires permissions that are specific to the protected resource type. For details, see [Permissions for ListResourcesForWebACL](https://docs.aws.amazon.com/waf/latest/developerguide/security_iam_service-with-iam.html#security_iam_action-ListResourcesForWebACL) in the *WAF Developer Guide*.
     */
    public suspend fun listResourcesForWebAcl(input: ListResourcesForWebAclRequest): ListResourcesForWebAclResponse

    /**
     * Retrieves an array of RuleGroupSummary objects for the rule groups that you manage.
     */
    public suspend fun listRuleGroups(input: ListRuleGroupsRequest): ListRuleGroupsResponse

    /**
     * Retrieves the TagInfoForResource for the specified resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a resource.
     *
     * You can tag the Amazon Web Services resources that you manage through WAF: web ACLs, rule groups, IP sets, and regex pattern sets. You can't manage or view tags through the WAF console.
     */
    public suspend fun listTagsForResource(input: ListTagsForResourceRequest): ListTagsForResourceResponse

    /**
     * Retrieves an array of WebACLSummary objects for the web ACLs that you manage.
     */
    public suspend fun listWebAcls(input: ListWebAclsRequest): ListWebAclsResponse

    /**
     * Enables the specified LoggingConfiguration, to start logging from a web ACL, according to the configuration provided.
     *
     * This operation completely replaces any mutable specifications that you already have for a logging configuration with the ones that you provide to this call.
     *
     * To modify an existing logging configuration, do the following:
     * + Retrieve it by calling GetLoggingConfiguration
     * + Update its settings as needed
     * + Provide the complete logging configuration specification to this call
     * You can define one logging destination per web ACL.
     *
     * You can access information about the traffic that WAF inspects using the following steps:
     * + Create your logging destination. You can use an Amazon CloudWatch Logs log group, an Amazon Simple Storage Service (Amazon S3) bucket, or an Amazon Kinesis Data Firehose. The name that you give the destination must start with `aws-waf-logs-`. Depending on the type of destination, you might need to configure additional settings or permissions. For configuration requirements and pricing information for each destination type, see [Logging web ACL traffic](https://docs.aws.amazon.com/waf/latest/developerguide/logging.html) in the *WAF Developer Guide*.
     * + Associate your logging destination to your web ACL using a `PutLoggingConfiguration` request.
     *
     * When you successfully enable logging using a `PutLoggingConfiguration` request, WAF creates an additional role or policy that is required to write logs to the logging destination. For an Amazon CloudWatch Logs log group, WAF creates a resource policy on the log group. For an Amazon S3 bucket, WAF creates a bucket policy. For an Amazon Kinesis Data Firehose, WAF creates a service-linked role.
     *
     * For additional information about web ACL logging, see [Logging web ACL traffic information](https://docs.aws.amazon.com/waf/latest/developerguide/logging.html) in the *WAF Developer Guide*.
     */
    public suspend fun putLoggingConfiguration(input: PutLoggingConfigurationRequest): PutLoggingConfigurationResponse

    /**
     * Defines the versions of your managed rule set that you are offering to the customers. Customers see your offerings as managed rule groups with versioning.
     *
     * This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.
     *
     * Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are `ListManagedRuleSets`, `GetManagedRuleSet`, `PutManagedRuleSetVersions`, and `UpdateManagedRuleSetVersionExpiryDate`.
     *
     * Customers retrieve their managed rule group list by calling ListAvailableManagedRuleGroups. The name that you provide here for your managed rule set is the name the customer sees for the corresponding managed rule group. Customers can retrieve the available versions for a managed rule group by calling ListAvailableManagedRuleGroupVersions. You provide a rule group specification for each version. For each managed rule set, you must specify a version that you recommend using.
     *
     * To initiate the expiration of a managed rule group version, use UpdateManagedRuleSetVersionExpiryDate.
     */
    public suspend fun putManagedRuleSetVersions(input: PutManagedRuleSetVersionsRequest): PutManagedRuleSetVersionsResponse

    /**
     * Use this to share a rule group with other accounts.
     *
     * This action attaches an IAM policy to the specified resource. You must be the owner of the rule group to perform this operation.
     *
     * This action is subject to the following restrictions:
     * + You can attach only one policy with each `PutPermissionPolicy` request.
     * + The ARN in the request must be a valid WAF RuleGroup ARN and the rule group must exist in the same Region.
     * + The user making the request must be the owner of the rule group.
     *
     * If a rule group has been shared with your account, you can access it through the call `GetRuleGroup`, and you can reference it in `CreateWebACL` and `UpdateWebACL`. Rule groups that are shared with you don't appear in your WAF console rule groups listing.
     */
    public suspend fun putPermissionPolicy(input: PutPermissionPolicyRequest): PutPermissionPolicyResponse

    /**
     * Associates tags with the specified Amazon Web Services resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a resource.
     *
     * You can tag the Amazon Web Services resources that you manage through WAF: web ACLs, rule groups, IP sets, and regex pattern sets. You can't manage or view tags through the WAF console.
     */
    public suspend fun tagResource(input: TagResourceRequest): TagResourceResponse

    /**
     * Disassociates tags from an Amazon Web Services resource. Tags are key:value pairs that you can associate with Amazon Web Services resources. For example, the tag key might be "customer" and the tag value might be "companyA." You can specify one or more tags to add to each container. You can add up to 50 tags to each Amazon Web Services resource.
     */
    public suspend fun untagResource(input: UntagResourceRequest): UntagResourceResponse

    /**
     * Updates the specified IPSet.
     *
     * This operation completely replaces the mutable specifications that you already have for the IP set with the ones that you provide to this call.
     *
     * To modify an IP set, do the following:
     * + Retrieve it by calling GetIPSet
     * + Update its settings as needed
     * + Provide the complete IP set specification to this call
     * **Temporary inconsistencies during updates**
     *
     * When you create or change a web ACL or other WAF resources, the changes take a small amount of time to propagate to all areas where the resources are stored. The propagation time can be from a few seconds to a number of minutes.
     *
     * The following are examples of the temporary inconsistencies that you might notice during change propagation:
     * + After you create a web ACL, if you try to associate it with a resource, you might get an exception indicating that the web ACL is unavailable.
     * + After you add a rule group to a web ACL, the new rule group rules might be in effect in one area where the web ACL is used and not in another.
     * + After you change a rule action setting, you might see the old action in some places and the new action in others.
     * + After you add an IP address to an IP set that is in use in a blocking rule, the new address might be blocked in one area while still allowed in another.
     */
    public suspend fun updateIpSet(input: UpdateIpSetRequest): UpdateIpSetResponse

    /**
     * Updates the expiration information for your managed rule set. Use this to initiate the expiration of a managed rule group version. After you initiate expiration for a version, WAF excludes it from the response to ListAvailableManagedRuleGroupVersions for the managed rule group.
     *
     * This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.
     *
     * Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are `ListManagedRuleSets`, `GetManagedRuleSet`, `PutManagedRuleSetVersions`, and `UpdateManagedRuleSetVersionExpiryDate`.
     */
    public suspend fun updateManagedRuleSetVersionExpiryDate(input: UpdateManagedRuleSetVersionExpiryDateRequest): UpdateManagedRuleSetVersionExpiryDateResponse

    /**
     * Updates the specified RegexPatternSet.
     *
     * This operation completely replaces the mutable specifications that you already have for the regex pattern set with the ones that you provide to this call.
     *
     * To modify a regex pattern set, do the following:
     * + Retrieve it by calling GetRegexPatternSet
     * + Update its settings as needed
     * + Provide the complete regex pattern set specification to this call
     * **Temporary inconsistencies during updates**
     *
     * When you create or change a web ACL or other WAF resources, the changes take a small amount of time to propagate to all areas where the resources are stored. The propagation time can be from a few seconds to a number of minutes.
     *
     * The following are examples of the temporary inconsistencies that you might notice during change propagation:
     * + After you create a web ACL, if you try to associate it with a resource, you might get an exception indicating that the web ACL is unavailable.
     * + After you add a rule group to a web ACL, the new rule group rules might be in effect in one area where the web ACL is used and not in another.
     * + After you change a rule action setting, you might see the old action in some places and the new action in others.
     * + After you add an IP address to an IP set that is in use in a blocking rule, the new address might be blocked in one area while still allowed in another.
     */
    public suspend fun updateRegexPatternSet(input: UpdateRegexPatternSetRequest): UpdateRegexPatternSetResponse

    /**
     * Updates the specified RuleGroup.
     *
     * This operation completely replaces the mutable specifications that you already have for the rule group with the ones that you provide to this call.
     *
     * To modify a rule group, do the following:
     * + Retrieve it by calling GetRuleGroup
     * + Update its settings as needed
     * + Provide the complete rule group specification to this call
     *  A rule group defines a collection of rules to inspect and control web requests that you can use in a WebACL. When you create a rule group, you define an immutable capacity limit. If you update a rule group, you must stay within the capacity. This allows others to reuse the rule group with confidence in its capacity requirements.
     *
     * **Temporary inconsistencies during updates**
     *
     * When you create or change a web ACL or other WAF resources, the changes take a small amount of time to propagate to all areas where the resources are stored. The propagation time can be from a few seconds to a number of minutes.
     *
     * The following are examples of the temporary inconsistencies that you might notice during change propagation:
     * + After you create a web ACL, if you try to associate it with a resource, you might get an exception indicating that the web ACL is unavailable.
     * + After you add a rule group to a web ACL, the new rule group rules might be in effect in one area where the web ACL is used and not in another.
     * + After you change a rule action setting, you might see the old action in some places and the new action in others.
     * + After you add an IP address to an IP set that is in use in a blocking rule, the new address might be blocked in one area while still allowed in another.
     */
    public suspend fun updateRuleGroup(input: UpdateRuleGroupRequest): UpdateRuleGroupResponse

    /**
     * Updates the specified WebACL. While updating a web ACL, WAF provides continuous coverage to the resources that you have associated with the web ACL.
     *
     * This operation completely replaces the mutable specifications that you already have for the web ACL with the ones that you provide to this call.
     *
     * To modify a web ACL, do the following:
     * + Retrieve it by calling GetWebACL
     * + Update its settings as needed
     * + Provide the complete web ACL specification to this call
     *  A web ACL defines a collection of rules to use to inspect and control web requests. Each rule has a statement that defines what to look for in web requests and an action that WAF applies to requests that match the statement. In the web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a web ACL can be a combination of the types Rule, RuleGroup, and managed rule group. You can associate a web ACL with one or more Amazon Web Services resources to protect. The resources can be an Amazon CloudFront distribution, an Amazon API Gateway REST API, an Application Load Balancer, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
     *
     * **Temporary inconsistencies during updates**
     *
     * When you create or change a web ACL or other WAF resources, the changes take a small amount of time to propagate to all areas where the resources are stored. The propagation time can be from a few seconds to a number of minutes.
     *
     * The following are examples of the temporary inconsistencies that you might notice during change propagation:
     * + After you create a web ACL, if you try to associate it with a resource, you might get an exception indicating that the web ACL is unavailable.
     * + After you add a rule group to a web ACL, the new rule group rules might be in effect in one area where the web ACL is used and not in another.
     * + After you change a rule action setting, you might see the old action in some places and the new action in others.
     * + After you add an IP address to an IP set that is in use in a blocking rule, the new address might be blocked in one area while still allowed in another.
     */
    public suspend fun updateWebAcl(input: UpdateWebAclRequest): UpdateWebAclResponse
}

/**
 * Create a copy of the client with one or more configuration values overridden.
 * This method allows the caller to perform scoped config overrides for one or more client operations.
 *
 * Any resources created on your behalf will be shared between clients, and will only be closed when ALL clients using them are closed.
 * If you provide a resource (e.g. [HttpClientEngine]) to the SDK, you are responsible for managing the lifetime of that resource.
 */
public fun Wafv2Client.withConfig(block: Wafv2Client.Config.Builder.() -> Unit): Wafv2Client {
    val newConfig = config.toBuilder().apply(block).build()
    return DefaultWafv2Client(newConfig)
}

/**
 * Associates a web ACL with a regional application resource, to protect the resource. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
 *
 * For Amazon CloudFront, don't use this call. Instead, use your CloudFront distribution configuration. To associate a web ACL, in the CloudFront call `UpdateDistribution`, set the web ACL ID to the Amazon Resource Name (ARN) of the web ACL. For information, see [UpdateDistribution](https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_UpdateDistribution.html) in the *Amazon CloudFront Developer Guide*.
 *
 * **Required permissions for customer-managed IAM policies**
 *
 * This call requires permissions that are specific to the protected resource type. For details, see [Permissions for AssociateWebACL](https://docs.aws.amazon.com/waf/latest/developerguide/security_iam_service-with-iam.html#security_iam_action-AssociateWebACL) in the *WAF Developer Guide*.
 *
 * **Temporary inconsistencies during updates**
 *
 * When you create or change a web ACL or other WAF resources, the changes take a small amount of time to propagate to all areas where the resources are stored. The propagation time can be from a few seconds to a number of minutes.
 *
 * The following are examples of the temporary inconsistencies that you might notice during change propagation:
 * + After you create a web ACL, if you try to associate it with a resource, you might get an exception indicating that the web ACL is unavailable.
 * + After you add a rule group to a web ACL, the new rule group rules might be in effect in one area where the web ACL is used and not in another.
 * + After you change a rule action setting, you might see the old action in some places and the new action in others.
 * + After you add an IP address to an IP set that is in use in a blocking rule, the new address might be blocked in one area while still allowed in another.
 */
public suspend inline fun Wafv2Client.associateWebAcl(crossinline block: AssociateWebAclRequest.Builder.() -> Unit): AssociateWebAclResponse = associateWebAcl(AssociateWebAclRequest.Builder().apply(block).build())

/**
 * Returns the web ACL capacity unit (WCU) requirements for a specified scope and set of rules. You can use this to check the capacity requirements for the rules you want to use in a RuleGroup or WebACL.
 *
 * WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. For more information, see [WAF web ACL capacity units (WCU)](https://docs.aws.amazon.com/waf/latest/developerguide/aws-waf-capacity-units.html) in the *WAF Developer Guide*.
 */
public suspend inline fun Wafv2Client.checkCapacity(crossinline block: CheckCapacityRequest.Builder.() -> Unit): CheckCapacityResponse = checkCapacity(CheckCapacityRequest.Builder().apply(block).build())

/**
 * Creates an API key that contains a set of token domains.
 *
 * API keys are required for the integration of the CAPTCHA API in your JavaScript client applications. The API lets you customize the placement and characteristics of the CAPTCHA puzzle for your end users. For more information about the CAPTCHA JavaScript integration, see [WAF client application integration](https://docs.aws.amazon.com/waf/latest/developerguide/waf-application-integration.html) in the *WAF Developer Guide*.
 *
 * You can use a single key for up to 5 domains. After you generate a key, you can copy it for use in your JavaScript integration.
 */
public suspend inline fun Wafv2Client.createApiKey(crossinline block: CreateApiKeyRequest.Builder.() -> Unit): CreateApiKeyResponse = createApiKey(CreateApiKeyRequest.Builder().apply(block).build())

/**
 * Creates an IPSet, which you use to identify web requests that originate from specific IP addresses or ranges of IP addresses. For example, if you're receiving a lot of requests from a ranges of IP addresses, you can configure WAF to block them using an IPSet that lists those IP addresses.
 */
public suspend inline fun Wafv2Client.createIpSet(crossinline block: CreateIpSetRequest.Builder.() -> Unit): CreateIpSetResponse = createIpSet(CreateIpSetRequest.Builder().apply(block).build())

/**
 * Creates a RegexPatternSet, which you reference in a RegexPatternSetReferenceStatement, to have WAF inspect a web request component for the specified patterns.
 */
public suspend inline fun Wafv2Client.createRegexPatternSet(crossinline block: CreateRegexPatternSetRequest.Builder.() -> Unit): CreateRegexPatternSetResponse = createRegexPatternSet(CreateRegexPatternSetRequest.Builder().apply(block).build())

/**
 * Creates a RuleGroup per the specifications provided.
 *
 *  A rule group defines a collection of rules to inspect and control web requests that you can use in a WebACL. When you create a rule group, you define an immutable capacity limit. If you update a rule group, you must stay within the capacity. This allows others to reuse the rule group with confidence in its capacity requirements.
 */
public suspend inline fun Wafv2Client.createRuleGroup(crossinline block: CreateRuleGroupRequest.Builder.() -> Unit): CreateRuleGroupResponse = createRuleGroup(CreateRuleGroupRequest.Builder().apply(block).build())

/**
 * Creates a WebACL per the specifications provided.
 *
 *  A web ACL defines a collection of rules to use to inspect and control web requests. Each rule has a statement that defines what to look for in web requests and an action that WAF applies to requests that match the statement. In the web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a web ACL can be a combination of the types Rule, RuleGroup, and managed rule group. You can associate a web ACL with one or more Amazon Web Services resources to protect. The resources can be an Amazon CloudFront distribution, an Amazon API Gateway REST API, an Application Load Balancer, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
 */
public suspend inline fun Wafv2Client.createWebAcl(crossinline block: CreateWebAclRequest.Builder.() -> Unit): CreateWebAclResponse = createWebAcl(CreateWebAclRequest.Builder().apply(block).build())

/**
 * Deletes the specified API key.
 *
 * After you delete a key, it can take up to 24 hours for WAF to disallow use of the key in all regions.
 */
public suspend inline fun Wafv2Client.deleteApiKey(crossinline block: DeleteApiKeyRequest.Builder.() -> Unit): DeleteApiKeyResponse = deleteApiKey(DeleteApiKeyRequest.Builder().apply(block).build())

/**
 * Deletes all rule groups that are managed by Firewall Manager from the specified WebACL.
 *
 * You can only use this if `ManagedByFirewallManager` and `RetrofittedByFirewallManager` are both false in the web ACL.
 */
public suspend inline fun Wafv2Client.deleteFirewallManagerRuleGroups(crossinline block: DeleteFirewallManagerRuleGroupsRequest.Builder.() -> Unit): DeleteFirewallManagerRuleGroupsResponse = deleteFirewallManagerRuleGroups(DeleteFirewallManagerRuleGroupsRequest.Builder().apply(block).build())

/**
 * Deletes the specified IPSet.
 */
public suspend inline fun Wafv2Client.deleteIpSet(crossinline block: DeleteIpSetRequest.Builder.() -> Unit): DeleteIpSetResponse = deleteIpSet(DeleteIpSetRequest.Builder().apply(block).build())

/**
 * Deletes the LoggingConfiguration from the specified web ACL.
 */
public suspend inline fun Wafv2Client.deleteLoggingConfiguration(crossinline block: DeleteLoggingConfigurationRequest.Builder.() -> Unit): DeleteLoggingConfigurationResponse = deleteLoggingConfiguration(DeleteLoggingConfigurationRequest.Builder().apply(block).build())

/**
 * Permanently deletes an IAM policy from the specified rule group.
 *
 * You must be the owner of the rule group to perform this operation.
 */
public suspend inline fun Wafv2Client.deletePermissionPolicy(crossinline block: DeletePermissionPolicyRequest.Builder.() -> Unit): DeletePermissionPolicyResponse = deletePermissionPolicy(DeletePermissionPolicyRequest.Builder().apply(block).build())

/**
 * Deletes the specified RegexPatternSet.
 */
public suspend inline fun Wafv2Client.deleteRegexPatternSet(crossinline block: DeleteRegexPatternSetRequest.Builder.() -> Unit): DeleteRegexPatternSetResponse = deleteRegexPatternSet(DeleteRegexPatternSetRequest.Builder().apply(block).build())

/**
 * Deletes the specified RuleGroup.
 */
public suspend inline fun Wafv2Client.deleteRuleGroup(crossinline block: DeleteRuleGroupRequest.Builder.() -> Unit): DeleteRuleGroupResponse = deleteRuleGroup(DeleteRuleGroupRequest.Builder().apply(block).build())

/**
 * Deletes the specified WebACL.
 *
 * You can only use this if `ManagedByFirewallManager` is false in the web ACL.
 *
 * Before deleting any web ACL, first disassociate it from all resources.
 * + To retrieve a list of the resources that are associated with a web ACL, use the following calls:
 *    + For regional resources, call ListResourcesForWebACL.
 *    + For Amazon CloudFront distributions, use the CloudFront call `ListDistributionsByWebACLId`. For information, see [ListDistributionsByWebACLId](https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_ListDistributionsByWebACLId.html) in the *Amazon CloudFront API Reference*.
 * + To disassociate a resource from a web ACL, use the following calls:
 *    + For regional resources, call DisassociateWebACL.
 *    + For Amazon CloudFront distributions, provide an empty web ACL ID in the CloudFront call `UpdateDistribution`. For information, see [UpdateDistribution](https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_UpdateDistribution.html) in the *Amazon CloudFront API Reference*.
 */
public suspend inline fun Wafv2Client.deleteWebAcl(crossinline block: DeleteWebAclRequest.Builder.() -> Unit): DeleteWebAclResponse = deleteWebAcl(DeleteWebAclRequest.Builder().apply(block).build())

/**
 * Provides high-level information for the Amazon Web Services Managed Rules rule groups and Amazon Web Services Marketplace managed rule groups.
 */
public suspend inline fun Wafv2Client.describeAllManagedProducts(crossinline block: DescribeAllManagedProductsRequest.Builder.() -> Unit): DescribeAllManagedProductsResponse = describeAllManagedProducts(DescribeAllManagedProductsRequest.Builder().apply(block).build())

/**
 * Provides high-level information for the managed rule groups owned by a specific vendor.
 */
public suspend inline fun Wafv2Client.describeManagedProductsByVendor(crossinline block: DescribeManagedProductsByVendorRequest.Builder.() -> Unit): DescribeManagedProductsByVendorResponse = describeManagedProductsByVendor(DescribeManagedProductsByVendorRequest.Builder().apply(block).build())

/**
 * Provides high-level information for a managed rule group, including descriptions of the rules.
 */
public suspend inline fun Wafv2Client.describeManagedRuleGroup(crossinline block: DescribeManagedRuleGroupRequest.Builder.() -> Unit): DescribeManagedRuleGroupResponse = describeManagedRuleGroup(DescribeManagedRuleGroupRequest.Builder().apply(block).build())

/**
 * Disassociates the specified regional application resource from any existing web ACL association. A resource can have at most one web ACL association. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
 *
 * For Amazon CloudFront, don't use this call. Instead, use your CloudFront distribution configuration. To disassociate a web ACL, provide an empty web ACL ID in the CloudFront call `UpdateDistribution`. For information, see [UpdateDistribution](https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_UpdateDistribution.html) in the *Amazon CloudFront API Reference*.
 *
 * **Required permissions for customer-managed IAM policies**
 *
 * This call requires permissions that are specific to the protected resource type. For details, see [Permissions for DisassociateWebACL](https://docs.aws.amazon.com/waf/latest/developerguide/security_iam_service-with-iam.html#security_iam_action-DisassociateWebACL) in the *WAF Developer Guide*.
 */
public suspend inline fun Wafv2Client.disassociateWebAcl(crossinline block: DisassociateWebAclRequest.Builder.() -> Unit): DisassociateWebAclResponse = disassociateWebAcl(DisassociateWebAclRequest.Builder().apply(block).build())

/**
 * Generates a presigned download URL for the specified release of the mobile SDK.
 *
 * The mobile SDK is not generally available. Customers who have access to the mobile SDK can use it to establish and manage WAF tokens for use in HTTP(S) requests from a mobile device to WAF. For more information, see [WAF client application integration](https://docs.aws.amazon.com/waf/latest/developerguide/waf-application-integration.html) in the *WAF Developer Guide*.
 */
public suspend inline fun Wafv2Client.generateMobileSdkReleaseUrl(crossinline block: GenerateMobileSdkReleaseUrlRequest.Builder.() -> Unit): GenerateMobileSdkReleaseUrlResponse = generateMobileSdkReleaseUrl(GenerateMobileSdkReleaseUrlRequest.Builder().apply(block).build())

/**
 * Returns your API key in decrypted form. Use this to check the token domains that you have defined for the key.
 *
 * API keys are required for the integration of the CAPTCHA API in your JavaScript client applications. The API lets you customize the placement and characteristics of the CAPTCHA puzzle for your end users. For more information about the CAPTCHA JavaScript integration, see [WAF client application integration](https://docs.aws.amazon.com/waf/latest/developerguide/waf-application-integration.html) in the *WAF Developer Guide*.
 */
public suspend inline fun Wafv2Client.getDecryptedApiKey(crossinline block: GetDecryptedApiKeyRequest.Builder.() -> Unit): GetDecryptedApiKeyResponse = getDecryptedApiKey(GetDecryptedApiKeyRequest.Builder().apply(block).build())

/**
 * Retrieves the specified IPSet.
 */
public suspend inline fun Wafv2Client.getIpSet(crossinline block: GetIpSetRequest.Builder.() -> Unit): GetIpSetResponse = getIpSet(GetIpSetRequest.Builder().apply(block).build())

/**
 * Returns the LoggingConfiguration for the specified web ACL.
 */
public suspend inline fun Wafv2Client.getLoggingConfiguration(crossinline block: GetLoggingConfigurationRequest.Builder.() -> Unit): GetLoggingConfigurationResponse = getLoggingConfiguration(GetLoggingConfigurationRequest.Builder().apply(block).build())

/**
 * Retrieves the specified managed rule set.
 *
 * This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.
 *
 * Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are `ListManagedRuleSets`, `GetManagedRuleSet`, `PutManagedRuleSetVersions`, and `UpdateManagedRuleSetVersionExpiryDate`.
 */
public suspend inline fun Wafv2Client.getManagedRuleSet(crossinline block: GetManagedRuleSetRequest.Builder.() -> Unit): GetManagedRuleSetResponse = getManagedRuleSet(GetManagedRuleSetRequest.Builder().apply(block).build())

/**
 * Retrieves information for the specified mobile SDK release, including release notes and tags.
 *
 * The mobile SDK is not generally available. Customers who have access to the mobile SDK can use it to establish and manage WAF tokens for use in HTTP(S) requests from a mobile device to WAF. For more information, see [WAF client application integration](https://docs.aws.amazon.com/waf/latest/developerguide/waf-application-integration.html) in the *WAF Developer Guide*.
 */
public suspend inline fun Wafv2Client.getMobileSdkRelease(crossinline block: GetMobileSdkReleaseRequest.Builder.() -> Unit): GetMobileSdkReleaseResponse = getMobileSdkRelease(GetMobileSdkReleaseRequest.Builder().apply(block).build())

/**
 * Returns the IAM policy that is attached to the specified rule group.
 *
 * You must be the owner of the rule group to perform this operation.
 */
public suspend inline fun Wafv2Client.getPermissionPolicy(crossinline block: GetPermissionPolicyRequest.Builder.() -> Unit): GetPermissionPolicyResponse = getPermissionPolicy(GetPermissionPolicyRequest.Builder().apply(block).build())

/**
 * Retrieves the IP addresses that are currently blocked by a rate-based rule instance. This is only available for rate-based rules that aggregate solely on the IP address or on the forwarded IP address.
 *
 * The maximum number of addresses that can be blocked for a single rate-based rule instance is 10,000. If more than 10,000 addresses exceed the rate limit, those with the highest rates are blocked.
 *
 * For a rate-based rule that you've defined inside a rule group, provide the name of the rule group reference statement in your request, in addition to the rate-based rule name and the web ACL name.
 *
 * WAF monitors web requests and manages keys independently for each unique combination of web ACL, optional rule group, and rate-based rule. For example, if you define a rate-based rule inside a rule group, and then use the rule group in a web ACL, WAF monitors web requests and manages keys for that web ACL, rule group reference statement, and rate-based rule instance. If you use the same rule group in a second web ACL, WAF monitors web requests and manages keys for this second usage completely independent of your first.
 */
public suspend inline fun Wafv2Client.getRateBasedStatementManagedKeys(crossinline block: GetRateBasedStatementManagedKeysRequest.Builder.() -> Unit): GetRateBasedStatementManagedKeysResponse = getRateBasedStatementManagedKeys(GetRateBasedStatementManagedKeysRequest.Builder().apply(block).build())

/**
 * Retrieves the specified RegexPatternSet.
 */
public suspend inline fun Wafv2Client.getRegexPatternSet(crossinline block: GetRegexPatternSetRequest.Builder.() -> Unit): GetRegexPatternSetResponse = getRegexPatternSet(GetRegexPatternSetRequest.Builder().apply(block).build())

/**
 * Retrieves the specified RuleGroup.
 */
public suspend inline fun Wafv2Client.getRuleGroup(crossinline block: GetRuleGroupRequest.Builder.() -> Unit): GetRuleGroupResponse = getRuleGroup(GetRuleGroupRequest.Builder().apply(block).build())

/**
 * Gets detailed information about a specified number of requests--a sample--that WAF randomly selects from among the first 5,000 requests that your Amazon Web Services resource received during a time range that you choose. You can specify a sample size of up to 500 requests, and you can specify any time range in the previous three hours.
 *
 * `GetSampledRequests` returns a time range, which is usually the time range that you specified. However, if your resource (such as a CloudFront distribution) received 5,000 requests before the specified time range elapsed, `GetSampledRequests` returns an updated time range. This new time range indicates the actual period during which WAF selected the requests in the sample.
 */
public suspend inline fun Wafv2Client.getSampledRequests(crossinline block: GetSampledRequestsRequest.Builder.() -> Unit): GetSampledRequestsResponse = getSampledRequests(GetSampledRequestsRequest.Builder().apply(block).build())

/**
 * Retrieves the specified WebACL.
 */
public suspend inline fun Wafv2Client.getWebAcl(crossinline block: GetWebAclRequest.Builder.() -> Unit): GetWebAclResponse = getWebAcl(GetWebAclRequest.Builder().apply(block).build())

/**
 * Retrieves the WebACL for the specified resource.
 *
 * This call uses `GetWebACL`, to verify that your account has permission to access the retrieved web ACL. If you get an error that indicates that your account isn't authorized to perform `wafv2:GetWebACL` on the resource, that error won't be included in your CloudTrail event history.
 *
 * For Amazon CloudFront, don't use this call. Instead, call the CloudFront action `GetDistributionConfig`. For information, see [GetDistributionConfig](https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_GetDistributionConfig.html) in the *Amazon CloudFront API Reference*.
 *
 * **Required permissions for customer-managed IAM policies**
 *
 * This call requires permissions that are specific to the protected resource type. For details, see [Permissions for GetWebACLForResource](https://docs.aws.amazon.com/waf/latest/developerguide/security_iam_service-with-iam.html#security_iam_action-GetWebACLForResource) in the *WAF Developer Guide*.
 */
public suspend inline fun Wafv2Client.getWebAclForResource(crossinline block: GetWebAclForResourceRequest.Builder.() -> Unit): GetWebAclForResourceResponse = getWebAclForResource(GetWebAclForResourceRequest.Builder().apply(block).build())

/**
 * Retrieves a list of the API keys that you've defined for the specified scope.
 *
 * API keys are required for the integration of the CAPTCHA API in your JavaScript client applications. The API lets you customize the placement and characteristics of the CAPTCHA puzzle for your end users. For more information about the CAPTCHA JavaScript integration, see [WAF client application integration](https://docs.aws.amazon.com/waf/latest/developerguide/waf-application-integration.html) in the *WAF Developer Guide*.
 */
public suspend inline fun Wafv2Client.listApiKeys(crossinline block: ListApiKeysRequest.Builder.() -> Unit): ListApiKeysResponse = listApiKeys(ListApiKeysRequest.Builder().apply(block).build())

/**
 * Returns a list of the available versions for the specified managed rule group.
 */
public suspend inline fun Wafv2Client.listAvailableManagedRuleGroupVersions(crossinline block: ListAvailableManagedRuleGroupVersionsRequest.Builder.() -> Unit): ListAvailableManagedRuleGroupVersionsResponse = listAvailableManagedRuleGroupVersions(ListAvailableManagedRuleGroupVersionsRequest.Builder().apply(block).build())

/**
 * Retrieves an array of managed rule groups that are available for you to use. This list includes all Amazon Web Services Managed Rules rule groups and all of the Amazon Web Services Marketplace managed rule groups that you're subscribed to.
 */
public suspend inline fun Wafv2Client.listAvailableManagedRuleGroups(crossinline block: ListAvailableManagedRuleGroupsRequest.Builder.() -> Unit): ListAvailableManagedRuleGroupsResponse = listAvailableManagedRuleGroups(ListAvailableManagedRuleGroupsRequest.Builder().apply(block).build())

/**
 * Retrieves an array of IPSetSummary objects for the IP sets that you manage.
 */
public suspend inline fun Wafv2Client.listIpSets(crossinline block: ListIpSetsRequest.Builder.() -> Unit): ListIpSetsResponse = listIpSets(ListIpSetsRequest.Builder().apply(block).build())

/**
 * Retrieves an array of your LoggingConfiguration objects.
 */
public suspend inline fun Wafv2Client.listLoggingConfigurations(crossinline block: ListLoggingConfigurationsRequest.Builder.() -> Unit): ListLoggingConfigurationsResponse = listLoggingConfigurations(ListLoggingConfigurationsRequest.Builder().apply(block).build())

/**
 * Retrieves the managed rule sets that you own.
 *
 * This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.
 *
 * Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are `ListManagedRuleSets`, `GetManagedRuleSet`, `PutManagedRuleSetVersions`, and `UpdateManagedRuleSetVersionExpiryDate`.
 */
public suspend inline fun Wafv2Client.listManagedRuleSets(crossinline block: ListManagedRuleSetsRequest.Builder.() -> Unit): ListManagedRuleSetsResponse = listManagedRuleSets(ListManagedRuleSetsRequest.Builder().apply(block).build())

/**
 * Retrieves a list of the available releases for the mobile SDK and the specified device platform.
 *
 * The mobile SDK is not generally available. Customers who have access to the mobile SDK can use it to establish and manage WAF tokens for use in HTTP(S) requests from a mobile device to WAF. For more information, see [WAF client application integration](https://docs.aws.amazon.com/waf/latest/developerguide/waf-application-integration.html) in the *WAF Developer Guide*.
 */
public suspend inline fun Wafv2Client.listMobileSdkReleases(crossinline block: ListMobileSdkReleasesRequest.Builder.() -> Unit): ListMobileSdkReleasesResponse = listMobileSdkReleases(ListMobileSdkReleasesRequest.Builder().apply(block).build())

/**
 * Retrieves an array of RegexPatternSetSummary objects for the regex pattern sets that you manage.
 */
public suspend inline fun Wafv2Client.listRegexPatternSets(crossinline block: ListRegexPatternSetsRequest.Builder.() -> Unit): ListRegexPatternSetsResponse = listRegexPatternSets(ListRegexPatternSetsRequest.Builder().apply(block).build())

/**
 * Retrieves an array of the Amazon Resource Names (ARNs) for the regional resources that are associated with the specified web ACL.
 *
 * For Amazon CloudFront, don't use this call. Instead, use the CloudFront call `ListDistributionsByWebACLId`. For information, see [ListDistributionsByWebACLId](https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_ListDistributionsByWebACLId.html) in the *Amazon CloudFront API Reference*.
 *
 * **Required permissions for customer-managed IAM policies**
 *
 * This call requires permissions that are specific to the protected resource type. For details, see [Permissions for ListResourcesForWebACL](https://docs.aws.amazon.com/waf/latest/developerguide/security_iam_service-with-iam.html#security_iam_action-ListResourcesForWebACL) in the *WAF Developer Guide*.
 */
public suspend inline fun Wafv2Client.listResourcesForWebAcl(crossinline block: ListResourcesForWebAclRequest.Builder.() -> Unit): ListResourcesForWebAclResponse = listResourcesForWebAcl(ListResourcesForWebAclRequest.Builder().apply(block).build())

/**
 * Retrieves an array of RuleGroupSummary objects for the rule groups that you manage.
 */
public suspend inline fun Wafv2Client.listRuleGroups(crossinline block: ListRuleGroupsRequest.Builder.() -> Unit): ListRuleGroupsResponse = listRuleGroups(ListRuleGroupsRequest.Builder().apply(block).build())

/**
 * Retrieves the TagInfoForResource for the specified resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a resource.
 *
 * You can tag the Amazon Web Services resources that you manage through WAF: web ACLs, rule groups, IP sets, and regex pattern sets. You can't manage or view tags through the WAF console.
 */
public suspend inline fun Wafv2Client.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse = listTagsForResource(ListTagsForResourceRequest.Builder().apply(block).build())

/**
 * Retrieves an array of WebACLSummary objects for the web ACLs that you manage.
 */
public suspend inline fun Wafv2Client.listWebAcls(crossinline block: ListWebAclsRequest.Builder.() -> Unit): ListWebAclsResponse = listWebAcls(ListWebAclsRequest.Builder().apply(block).build())

/**
 * Enables the specified LoggingConfiguration, to start logging from a web ACL, according to the configuration provided.
 *
 * This operation completely replaces any mutable specifications that you already have for a logging configuration with the ones that you provide to this call.
 *
 * To modify an existing logging configuration, do the following:
 * + Retrieve it by calling GetLoggingConfiguration
 * + Update its settings as needed
 * + Provide the complete logging configuration specification to this call
 * You can define one logging destination per web ACL.
 *
 * You can access information about the traffic that WAF inspects using the following steps:
 * + Create your logging destination. You can use an Amazon CloudWatch Logs log group, an Amazon Simple Storage Service (Amazon S3) bucket, or an Amazon Kinesis Data Firehose. The name that you give the destination must start with `aws-waf-logs-`. Depending on the type of destination, you might need to configure additional settings or permissions. For configuration requirements and pricing information for each destination type, see [Logging web ACL traffic](https://docs.aws.amazon.com/waf/latest/developerguide/logging.html) in the *WAF Developer Guide*.
 * + Associate your logging destination to your web ACL using a `PutLoggingConfiguration` request.
 *
 * When you successfully enable logging using a `PutLoggingConfiguration` request, WAF creates an additional role or policy that is required to write logs to the logging destination. For an Amazon CloudWatch Logs log group, WAF creates a resource policy on the log group. For an Amazon S3 bucket, WAF creates a bucket policy. For an Amazon Kinesis Data Firehose, WAF creates a service-linked role.
 *
 * For additional information about web ACL logging, see [Logging web ACL traffic information](https://docs.aws.amazon.com/waf/latest/developerguide/logging.html) in the *WAF Developer Guide*.
 */
public suspend inline fun Wafv2Client.putLoggingConfiguration(crossinline block: PutLoggingConfigurationRequest.Builder.() -> Unit): PutLoggingConfigurationResponse = putLoggingConfiguration(PutLoggingConfigurationRequest.Builder().apply(block).build())

/**
 * Defines the versions of your managed rule set that you are offering to the customers. Customers see your offerings as managed rule groups with versioning.
 *
 * This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.
 *
 * Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are `ListManagedRuleSets`, `GetManagedRuleSet`, `PutManagedRuleSetVersions`, and `UpdateManagedRuleSetVersionExpiryDate`.
 *
 * Customers retrieve their managed rule group list by calling ListAvailableManagedRuleGroups. The name that you provide here for your managed rule set is the name the customer sees for the corresponding managed rule group. Customers can retrieve the available versions for a managed rule group by calling ListAvailableManagedRuleGroupVersions. You provide a rule group specification for each version. For each managed rule set, you must specify a version that you recommend using.
 *
 * To initiate the expiration of a managed rule group version, use UpdateManagedRuleSetVersionExpiryDate.
 */
public suspend inline fun Wafv2Client.putManagedRuleSetVersions(crossinline block: PutManagedRuleSetVersionsRequest.Builder.() -> Unit): PutManagedRuleSetVersionsResponse = putManagedRuleSetVersions(PutManagedRuleSetVersionsRequest.Builder().apply(block).build())

/**
 * Use this to share a rule group with other accounts.
 *
 * This action attaches an IAM policy to the specified resource. You must be the owner of the rule group to perform this operation.
 *
 * This action is subject to the following restrictions:
 * + You can attach only one policy with each `PutPermissionPolicy` request.
 * + The ARN in the request must be a valid WAF RuleGroup ARN and the rule group must exist in the same Region.
 * + The user making the request must be the owner of the rule group.
 *
 * If a rule group has been shared with your account, you can access it through the call `GetRuleGroup`, and you can reference it in `CreateWebACL` and `UpdateWebACL`. Rule groups that are shared with you don't appear in your WAF console rule groups listing.
 */
public suspend inline fun Wafv2Client.putPermissionPolicy(crossinline block: PutPermissionPolicyRequest.Builder.() -> Unit): PutPermissionPolicyResponse = putPermissionPolicy(PutPermissionPolicyRequest.Builder().apply(block).build())

/**
 * Associates tags with the specified Amazon Web Services resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a resource.
 *
 * You can tag the Amazon Web Services resources that you manage through WAF: web ACLs, rule groups, IP sets, and regex pattern sets. You can't manage or view tags through the WAF console.
 */
public suspend inline fun Wafv2Client.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse = tagResource(TagResourceRequest.Builder().apply(block).build())

/**
 * Disassociates tags from an Amazon Web Services resource. Tags are key:value pairs that you can associate with Amazon Web Services resources. For example, the tag key might be "customer" and the tag value might be "companyA." You can specify one or more tags to add to each container. You can add up to 50 tags to each Amazon Web Services resource.
 */
public suspend inline fun Wafv2Client.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse = untagResource(UntagResourceRequest.Builder().apply(block).build())

/**
 * Updates the specified IPSet.
 *
 * This operation completely replaces the mutable specifications that you already have for the IP set with the ones that you provide to this call.
 *
 * To modify an IP set, do the following:
 * + Retrieve it by calling GetIPSet
 * + Update its settings as needed
 * + Provide the complete IP set specification to this call
 * **Temporary inconsistencies during updates**
 *
 * When you create or change a web ACL or other WAF resources, the changes take a small amount of time to propagate to all areas where the resources are stored. The propagation time can be from a few seconds to a number of minutes.
 *
 * The following are examples of the temporary inconsistencies that you might notice during change propagation:
 * + After you create a web ACL, if you try to associate it with a resource, you might get an exception indicating that the web ACL is unavailable.
 * + After you add a rule group to a web ACL, the new rule group rules might be in effect in one area where the web ACL is used and not in another.
 * + After you change a rule action setting, you might see the old action in some places and the new action in others.
 * + After you add an IP address to an IP set that is in use in a blocking rule, the new address might be blocked in one area while still allowed in another.
 */
public suspend inline fun Wafv2Client.updateIpSet(crossinline block: UpdateIpSetRequest.Builder.() -> Unit): UpdateIpSetResponse = updateIpSet(UpdateIpSetRequest.Builder().apply(block).build())

/**
 * Updates the expiration information for your managed rule set. Use this to initiate the expiration of a managed rule group version. After you initiate expiration for a version, WAF excludes it from the response to ListAvailableManagedRuleGroupVersions for the managed rule group.
 *
 * This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.
 *
 * Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are `ListManagedRuleSets`, `GetManagedRuleSet`, `PutManagedRuleSetVersions`, and `UpdateManagedRuleSetVersionExpiryDate`.
 */
public suspend inline fun Wafv2Client.updateManagedRuleSetVersionExpiryDate(crossinline block: UpdateManagedRuleSetVersionExpiryDateRequest.Builder.() -> Unit): UpdateManagedRuleSetVersionExpiryDateResponse = updateManagedRuleSetVersionExpiryDate(UpdateManagedRuleSetVersionExpiryDateRequest.Builder().apply(block).build())

/**
 * Updates the specified RegexPatternSet.
 *
 * This operation completely replaces the mutable specifications that you already have for the regex pattern set with the ones that you provide to this call.
 *
 * To modify a regex pattern set, do the following:
 * + Retrieve it by calling GetRegexPatternSet
 * + Update its settings as needed
 * + Provide the complete regex pattern set specification to this call
 * **Temporary inconsistencies during updates**
 *
 * When you create or change a web ACL or other WAF resources, the changes take a small amount of time to propagate to all areas where the resources are stored. The propagation time can be from a few seconds to a number of minutes.
 *
 * The following are examples of the temporary inconsistencies that you might notice during change propagation:
 * + After you create a web ACL, if you try to associate it with a resource, you might get an exception indicating that the web ACL is unavailable.
 * + After you add a rule group to a web ACL, the new rule group rules might be in effect in one area where the web ACL is used and not in another.
 * + After you change a rule action setting, you might see the old action in some places and the new action in others.
 * + After you add an IP address to an IP set that is in use in a blocking rule, the new address might be blocked in one area while still allowed in another.
 */
public suspend inline fun Wafv2Client.updateRegexPatternSet(crossinline block: UpdateRegexPatternSetRequest.Builder.() -> Unit): UpdateRegexPatternSetResponse = updateRegexPatternSet(UpdateRegexPatternSetRequest.Builder().apply(block).build())

/**
 * Updates the specified RuleGroup.
 *
 * This operation completely replaces the mutable specifications that you already have for the rule group with the ones that you provide to this call.
 *
 * To modify a rule group, do the following:
 * + Retrieve it by calling GetRuleGroup
 * + Update its settings as needed
 * + Provide the complete rule group specification to this call
 *  A rule group defines a collection of rules to inspect and control web requests that you can use in a WebACL. When you create a rule group, you define an immutable capacity limit. If you update a rule group, you must stay within the capacity. This allows others to reuse the rule group with confidence in its capacity requirements.
 *
 * **Temporary inconsistencies during updates**
 *
 * When you create or change a web ACL or other WAF resources, the changes take a small amount of time to propagate to all areas where the resources are stored. The propagation time can be from a few seconds to a number of minutes.
 *
 * The following are examples of the temporary inconsistencies that you might notice during change propagation:
 * + After you create a web ACL, if you try to associate it with a resource, you might get an exception indicating that the web ACL is unavailable.
 * + After you add a rule group to a web ACL, the new rule group rules might be in effect in one area where the web ACL is used and not in another.
 * + After you change a rule action setting, you might see the old action in some places and the new action in others.
 * + After you add an IP address to an IP set that is in use in a blocking rule, the new address might be blocked in one area while still allowed in another.
 */
public suspend inline fun Wafv2Client.updateRuleGroup(crossinline block: UpdateRuleGroupRequest.Builder.() -> Unit): UpdateRuleGroupResponse = updateRuleGroup(UpdateRuleGroupRequest.Builder().apply(block).build())

/**
 * Updates the specified WebACL. While updating a web ACL, WAF provides continuous coverage to the resources that you have associated with the web ACL.
 *
 * This operation completely replaces the mutable specifications that you already have for the web ACL with the ones that you provide to this call.
 *
 * To modify a web ACL, do the following:
 * + Retrieve it by calling GetWebACL
 * + Update its settings as needed
 * + Provide the complete web ACL specification to this call
 *  A web ACL defines a collection of rules to use to inspect and control web requests. Each rule has a statement that defines what to look for in web requests and an action that WAF applies to requests that match the statement. In the web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a web ACL can be a combination of the types Rule, RuleGroup, and managed rule group. You can associate a web ACL with one or more Amazon Web Services resources to protect. The resources can be an Amazon CloudFront distribution, an Amazon API Gateway REST API, an Application Load Balancer, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
 *
 * **Temporary inconsistencies during updates**
 *
 * When you create or change a web ACL or other WAF resources, the changes take a small amount of time to propagate to all areas where the resources are stored. The propagation time can be from a few seconds to a number of minutes.
 *
 * The following are examples of the temporary inconsistencies that you might notice during change propagation:
 * + After you create a web ACL, if you try to associate it with a resource, you might get an exception indicating that the web ACL is unavailable.
 * + After you add a rule group to a web ACL, the new rule group rules might be in effect in one area where the web ACL is used and not in another.
 * + After you change a rule action setting, you might see the old action in some places and the new action in others.
 * + After you add an IP address to an IP set that is in use in a blocking rule, the new address might be blocked in one area while still allowed in another.
 */
public suspend inline fun Wafv2Client.updateWebAcl(crossinline block: UpdateWebAclRequest.Builder.() -> Unit): UpdateWebAclResponse = updateWebAcl(UpdateWebAclRequest.Builder().apply(block).build())




© 2015 - 2025 Weber Informatics LLC | Privacy Policy