WAFV2 ***** Client ====== class WAFV2.Client A low-level client representing AWS WAFV2 Note: 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. WAF is a web application firewall that lets you monitor the HTTP and HTTPS requests that are forwarded to a protected resource. Protected resource types include Amazon CloudFront distribution, Amazon API Gateway REST API, Application Load Balancer, AppSync GraphQL API, Amazon Cognito user pool, App Runner service, Amplify application, and 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. You can make calls using the endpoints listed in WAF endpoints and quotas. * For regional resources, 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 and Amplify, 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. import boto3 client = boto3.client('wafv2') These are the available methods: * associate_web_acl * can_paginate * check_capacity * close * create_api_key * create_ip_set * create_regex_pattern_set * create_rule_group * create_web_acl * delete_api_key * delete_firewall_manager_rule_groups * delete_ip_set * delete_logging_configuration * delete_permission_policy * delete_regex_pattern_set * delete_rule_group * delete_web_acl * describe_all_managed_products * describe_managed_products_by_vendor * describe_managed_rule_group * disassociate_web_acl * generate_mobile_sdk_release_url * get_decrypted_api_key * get_ip_set * get_logging_configuration * get_managed_rule_set * get_mobile_sdk_release * get_paginator * get_permission_policy * get_rate_based_statement_managed_keys * get_regex_pattern_set * get_rule_group * get_sampled_requests * get_waiter * get_web_acl * get_web_acl_for_resource * list_api_keys * list_available_managed_rule_group_versions * list_available_managed_rule_groups * list_ip_sets * list_logging_configurations * list_managed_rule_sets * list_mobile_sdk_releases * list_regex_pattern_sets * list_resources_for_web_acl * list_rule_groups * list_tags_for_resource * list_web_acls * put_logging_configuration * put_managed_rule_set_versions * put_permission_policy * tag_resource * untag_resource * update_ip_set * update_managed_rule_set_version_expiry_date * update_regex_pattern_set * update_rule_group * update_web_acl WAFV2 / Client / update_ip_set update_ip_set ************* WAFV2.Client.update_ip_set(**kwargs) Updates the specified IPSet. Note: 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. See also: AWS API Documentation **Request Syntax** response = client.update_ip_set( Name='string', Scope='CLOUDFRONT'|'REGIONAL', Id='string', Description='string', Addresses=[ 'string', ], LockToken='string' ) Parameters: * **Name** (*string*) -- **[REQUIRED]** The name of the IP set. You cannot change the name of an "IPSet" after you create it. * **Scope** (*string*) -- **[REQUIRED]** Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. For an Amplify application, use "CLOUDFRONT". To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: * CLI - Specify the Region when you use the CloudFront scope: "--scope=CLOUDFRONT --region=us-east-1". * API and SDKs - For all calls, use the Region endpoint us- east-1. * **Id** (*string*) -- **[REQUIRED]** A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete. * **Description** (*string*) -- A description of the IP set that helps with identification. * **Addresses** (*list*) -- **[REQUIRED]** Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses that you want WAF to inspect for in incoming requests. All addresses must be specified using Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for "/0". Example address strings: * For requests that originated from the IP address 192.0.2.44, specify "192.0.2.44/32". * For requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify "192.0.2.0/24". * For requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify "1111:0000:0000:0000:0000:0000:0000:0111/128". * For requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify "1111:0000:0000:0000:0000:0000:0000:0000/64". For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing. Example JSON "Addresses" specifications: * Empty array: ""Addresses": []" * Array with one address: ""Addresses": ["192.0.2.44/32"]" * Array with three addresses: ""Addresses": ["192.0.2.44/32", "192.0.2.0/24", "192.0.0.0/16"]" * INVALID specification: ""Addresses": [""]" INVALID * *(string) --* * **LockToken** (*string*) -- **[REQUIRED]** A token used for optimistic locking. WAF returns a token to your "get" and "list" requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like "update" and "delete". WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a "WAFOptimisticLockException". If this happens, perform another "get", and use the new token returned by that operation. Return type: dict Returns: **Response Syntax** { 'NextLockToken': 'string' } **Response Structure** * *(dict) --* * **NextLockToken** *(string) --* A token used for optimistic locking. WAF returns this token to your "update" requests. You use "NextLockToken" in the same manner as you use "LockToken". **Exceptions** * "WAFV2.Client.exceptions.WAFInternalErrorException" * "WAFV2.Client.exceptions.WAFInvalidParameterException" * "WAFV2.Client.exceptions.WAFNonexistentItemException" * "WAFV2.Client.exceptions.WAFDuplicateItemException" * "WAFV2.Client.exceptions.WAFOptimisticLockException" * "WAFV2.Client.exceptions.WAFLimitsExceededException" * "WAFV2.Client.exceptions.WAFInvalidOperationException" WAFV2 / Client / generate_mobile_sdk_release_url generate_mobile_sdk_release_url ******************************* WAFV2.Client.generate_mobile_sdk_release_url(**kwargs) 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 in the *WAF Developer Guide*. See also: AWS API Documentation **Request Syntax** response = client.generate_mobile_sdk_release_url( Platform='IOS'|'ANDROID', ReleaseVersion='string' ) Parameters: * **Platform** (*string*) -- **[REQUIRED]** The device platform. * **ReleaseVersion** (*string*) -- **[REQUIRED]** The release version. For the latest available version, specify "LATEST". Return type: dict Returns: **Response Syntax** { 'Url': 'string' } **Response Structure** * *(dict) --* * **Url** *(string) --* The presigned download URL for the specified SDK release. **Exceptions** * "WAFV2.Client.exceptions.WAFInternalErrorException" * "WAFV2.Client.exceptions.WAFNonexistentItemException" * "WAFV2.Client.exceptions.WAFInvalidParameterException" * "WAFV2.Client.exceptions.WAFInvalidOperationException" WAFV2 / Client / get_sampled_requests get_sampled_requests ******************** WAFV2.Client.get_sampled_requests(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.get_sampled_requests( WebAclArn='string', RuleMetricName='string', Scope='CLOUDFRONT'|'REGIONAL', TimeWindow={ 'StartTime': datetime(2015, 1, 1), 'EndTime': datetime(2015, 1, 1) }, MaxItems=123 ) Parameters: * **WebAclArn** (*string*) -- **[REQUIRED]** The Amazon resource name (ARN) of the "WebACL" for which you want a sample of requests. * **RuleMetricName** (*string*) -- **[REQUIRED]** The metric name assigned to the "Rule" or "RuleGroup" dimension for which you want a sample of requests. * **Scope** (*string*) -- **[REQUIRED]** Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. For an Amplify application, use "CLOUDFRONT". To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: * CLI - Specify the Region when you use the CloudFront scope: "--scope=CLOUDFRONT --region=us-east-1". * API and SDKs - For all calls, use the Region endpoint us- east-1. * **TimeWindow** (*dict*) -- **[REQUIRED]** The start date and time and the end date and time of the range for which you want "GetSampledRequests" to return a sample of requests. You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special designator, "Z". For example, ""2016-09-27T14:50Z"". You can specify any time range in the previous three hours. If you specify a start time that's earlier than three hours ago, WAF sets it to three hours ago. * **StartTime** *(datetime) --* **[REQUIRED]** The beginning of the time range from which you want "GetSampledRequests" to return a sample of the requests that your Amazon Web Services resource received. You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special designator, "Z". For example, ""2016-09-27T14:50Z"". You can specify any time range in the previous three hours. * **EndTime** *(datetime) --* **[REQUIRED]** The end of the time range from which you want "GetSampledRequests" to return a sample of the requests that your Amazon Web Services resource received. You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special designator, "Z". For example, ""2016-09-27T14:50Z"". You can specify any time range in the previous three hours. * **MaxItems** (*integer*) -- **[REQUIRED]** The number of requests that you want WAF to return from among the first 5,000 requests that your Amazon Web Services resource received during the time range. If your resource received fewer requests than the value of "MaxItems", "GetSampledRequests" returns information about all of them. Return type: dict Returns: **Response Syntax** { 'SampledRequests': [ { 'Request': { 'ClientIP': 'string', 'Country': 'string', 'URI': 'string', 'Method': 'string', 'HTTPVersion': 'string', 'Headers': [ { 'Name': 'string', 'Value': 'string' }, ] }, 'Weight': 123, 'Timestamp': datetime(2015, 1, 1), 'Action': 'string', 'RuleNameWithinRuleGroup': 'string', 'RequestHeadersInserted': [ { 'Name': 'string', 'Value': 'string' }, ], 'ResponseCodeSent': 123, 'Labels': [ { 'Name': 'string' }, ], 'CaptchaResponse': { 'ResponseCode': 123, 'SolveTimestamp': 123, 'FailureReason': 'TOKEN_MISSING'|'TOKEN_EXPIRED'|'TOKEN_INVALID'|'TOKEN_DOMAIN_MISMATCH' }, 'ChallengeResponse': { 'ResponseCode': 123, 'SolveTimestamp': 123, 'FailureReason': 'TOKEN_MISSING'|'TOKEN_EXPIRED'|'TOKEN_INVALID'|'TOKEN_DOMAIN_MISMATCH' }, 'OverriddenAction': 'string' }, ], 'PopulationSize': 123, 'TimeWindow': { 'StartTime': datetime(2015, 1, 1), 'EndTime': datetime(2015, 1, 1) } } **Response Structure** * *(dict) --* * **SampledRequests** *(list) --* A complex type that contains detailed information about each of the requests in the sample. * *(dict) --* Represents a single sampled web request. The response from GetSampledRequests includes a "SampledHTTPRequests" complex type that appears as "SampledRequests" in the response syntax. "SampledHTTPRequests" contains an array of "SampledHTTPRequest" objects. * **Request** *(dict) --* A complex type that contains detailed information about the request. * **ClientIP** *(string) --* The IP address that the request originated from. If the web ACL is associated with a CloudFront distribution, this is the value of one of the following fields in CloudFront access logs: * "c-ip", if the viewer did not use an HTTP proxy or a load balancer to send the request * "x-forwarded-for", if the viewer did use an HTTP proxy or a load balancer to send the request * **Country** *(string) --* The two-letter country code for the country that the request originated from. For a current list of country codes, see the Wikipedia entry ISO 3166-1 alpha-2. * **URI** *(string) --* The URI path of the request, which identifies the resource, for example, "/images/daily-ad.jpg". * **Method** *(string) --* The HTTP method specified in the sampled web request. * **HTTPVersion** *(string) --* The HTTP version specified in the sampled web request, for example, "HTTP/1.1". * **Headers** *(list) --* A complex type that contains the name and value for each header in the sampled web request. * *(dict) --* Part of the response from GetSampledRequests. This is a complex type that appears as "Headers" in the response syntax. "HTTPHeader" contains the names and values of all of the headers that appear in one of the web requests. * **Name** *(string) --* The name of the HTTP header. * **Value** *(string) --* The value of the HTTP header. * **Weight** *(integer) --* A value that indicates how one result in the response relates proportionally to other results in the response. For example, a result that has a weight of "2" represents roughly twice as many web requests as a result that has a weight of "1". * **Timestamp** *(datetime) --* The time at which WAF received the request from your Amazon Web Services resource, in Unix time format (in seconds). * **Action** *(string) --* The action that WAF applied to the request. * **RuleNameWithinRuleGroup** *(string) --* The name of the "Rule" that the request matched. For managed rule groups, the format for this name is "##". For your own rule groups, the format for this name is "#". If the rule is not in a rule group, this field is absent. * **RequestHeadersInserted** *(list) --* Custom request headers inserted by WAF into the request, according to the custom request configuration for the matching rule action. * *(dict) --* Part of the response from GetSampledRequests. This is a complex type that appears as "Headers" in the response syntax. "HTTPHeader" contains the names and values of all of the headers that appear in one of the web requests. * **Name** *(string) --* The name of the HTTP header. * **Value** *(string) --* The value of the HTTP header. * **ResponseCodeSent** *(integer) --* The response code that was sent for the request. * **Labels** *(list) --* Labels applied to the web request by matching rules. WAF applies fully qualified labels to matching web requests. A fully qualified label is the concatenation of a label namespace and a rule label. The rule's rule group or web ACL defines the label namespace. For example, "awswaf:111122223333:myRuleGroup:testRules :testNS1:testNS2:labelNameA" or "awswaf:managed:aws :managed-rule-set:header:encoding:utf8". * *(dict) --* A single label container. This is used as an element of a label array in multiple contexts, for example, in "RuleLabels" inside a Rule and in "Labels" inside a SampledHTTPRequest. * **Name** *(string) --* The label string. * **CaptchaResponse** *(dict) --* The "CAPTCHA" response for the request. * **ResponseCode** *(integer) --* The HTTP response code indicating the status of the "CAPTCHA" token in the web request. If the token is missing, invalid, or expired, this code is "405 Method Not Allowed". * **SolveTimestamp** *(integer) --* The time that the "CAPTCHA" was last solved for the supplied token. * **FailureReason** *(string) --* The reason for failure, populated when the evaluation of the token fails. * **ChallengeResponse** *(dict) --* The "Challenge" response for the request. * **ResponseCode** *(integer) --* The HTTP response code indicating the status of the challenge token in the web request. If the token is missing, invalid, or expired, this code is "202 Request Accepted". * **SolveTimestamp** *(integer) --* The time that the challenge was last solved for the supplied token. * **FailureReason** *(string) --* The reason for failure, populated when the evaluation of the token fails. * **OverriddenAction** *(string) --* Used only for rule group rules that have a rule action override in place in the web ACL. This is the action that the rule group rule is configured for, and not the action that was applied to the request. The action that WAF applied is the "Action" value. * **PopulationSize** *(integer) --* The total number of requests from which "GetSampledRequests" got a sample of "MaxItems" requests. If "PopulationSize" is less than "MaxItems", the sample includes every request that your Amazon Web Services resource received during the specified time range. * **TimeWindow** *(dict) --* Usually, "TimeWindow" is the time range that you specified in the "GetSampledRequests" request. However, if your Amazon Web Services resource received more than 5,000 requests during the time range that you specified in the request, "GetSampledRequests" returns the time range for the first 5,000 requests. Times are in Coordinated Universal Time (UTC) format. * **StartTime** *(datetime) --* The beginning of the time range from which you want "GetSampledRequests" to return a sample of the requests that your Amazon Web Services resource received. You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special designator, "Z". For example, ""2016-09-27T14:50Z"". You can specify any time range in the previous three hours. * **EndTime** *(datetime) --* The end of the time range from which you want "GetSampledRequests" to return a sample of the requests that your Amazon Web Services resource received. You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special designator, "Z". For example, ""2016-09-27T14:50Z"". You can specify any time range in the previous three hours. **Exceptions** * "WAFV2.Client.exceptions.WAFNonexistentItemException" * "WAFV2.Client.exceptions.WAFInternalErrorException" * "WAFV2.Client.exceptions.WAFInvalidParameterException" WAFV2 / Client / get_paginator get_paginator ************* WAFV2.Client.get_paginator(operation_name) Create a paginator for an operation. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Raises: **OperationNotPageableError** -- Raised if the operation is not pageable. You can use the "client.can_paginate" method to check if an operation is pageable. Return type: "botocore.paginate.Paginator" Returns: A paginator object. WAFV2 / Client / create_regex_pattern_set create_regex_pattern_set ************************ WAFV2.Client.create_regex_pattern_set(**kwargs) Creates a RegexPatternSet, which you reference in a RegexPatternSetReferenceStatement, to have WAF inspect a web request component for the specified patterns. See also: AWS API Documentation **Request Syntax** response = client.create_regex_pattern_set( Name='string', Scope='CLOUDFRONT'|'REGIONAL', Description='string', RegularExpressionList=[ { 'RegexString': 'string' }, ], Tags=[ { 'Key': 'string', 'Value': 'string' }, ] ) Parameters: * **Name** (*string*) -- **[REQUIRED]** The name of the set. You cannot change the name after you create the set. * **Scope** (*string*) -- **[REQUIRED]** Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. For an Amplify application, use "CLOUDFRONT". To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: * CLI - Specify the Region when you use the CloudFront scope: "--scope=CLOUDFRONT --region=us-east-1". * API and SDKs - For all calls, use the Region endpoint us- east-1. * **Description** (*string*) -- A description of the set that helps with identification. * **RegularExpressionList** (*list*) -- **[REQUIRED]** Array of regular expression strings. * *(dict) --* A single regular expression. This is used in a RegexPatternSet and also in the configuration for the Amazon Web Services Managed Rules rule group "AWSManagedRulesAntiDDoSRuleSet". * **RegexString** *(string) --* The string representing the regular expression. * **Tags** (*list*) -- An array of key:value pairs to associate with the resource. * *(dict) --* A tag associated with an Amazon Web Services resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing or other management. Typically, the tag key represents a category, such as "environment", and the tag value represents a specific value within that category, such as "test," "development," or "production". Or 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. * **Key** *(string) --* **[REQUIRED]** Part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as "customer." Tag keys are case-sensitive. * **Value** *(string) --* **[REQUIRED]** Part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as "companyA" or "companyB." Tag values are case-sensitive. Return type: dict Returns: **Response Syntax** { 'Summary': { 'Name': 'string', 'Id': 'string', 'Description': 'string', 'LockToken': 'string', 'ARN': 'string' } } **Response Structure** * *(dict) --* * **Summary** *(dict) --* High-level information about a RegexPatternSet, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage a "RegexPatternSet", and the ARN, that you provide to the RegexPatternSetReferenceStatement to use the pattern set in a Rule. * **Name** *(string) --* The name of the data type instance. You cannot change the name after you create the instance. * **Id** *(string) --* A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete. * **Description** *(string) --* A description of the set that helps with identification. * **LockToken** *(string) --* A token used for optimistic locking. WAF returns a token to your "get" and "list" requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like "update" and "delete". WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a "WAFOptimisticLockException". If this happens, perform another "get", and use the new token returned by that operation. * **ARN** *(string) --* The Amazon Resource Name (ARN) of the entity. **Exceptions** * "WAFV2.Client.exceptions.WAFInternalErrorException" * "WAFV2.Client.exceptions.WAFInvalidParameterException" * "WAFV2.Client.exceptions.WAFDuplicateItemException" * "WAFV2.Client.exceptions.WAFOptimisticLockException" * "WAFV2.Client.exceptions.WAFLimitsExceededException" * "WAFV2.Client.exceptions.WAFTagOperationException" * "WAFV2.Client.exceptions.WAFTagOperationInternalErrorException" * "WAFV2.Client.exceptions.WAFInvalidOperationException" WAFV2 / Client / list_ip_sets list_ip_sets ************ WAFV2.Client.list_ip_sets(**kwargs) Retrieves an array of IPSetSummary objects for the IP sets that you manage. See also: AWS API Documentation **Request Syntax** response = client.list_ip_sets( Scope='CLOUDFRONT'|'REGIONAL', NextMarker='string', Limit=123 ) Parameters: * **Scope** (*string*) -- **[REQUIRED]** Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. For an Amplify application, use "CLOUDFRONT". To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: * CLI - Specify the Region when you use the CloudFront scope: "--scope=CLOUDFRONT --region=us-east-1". * API and SDKs - For all calls, use the Region endpoint us- east-1. * **NextMarker** (*string*) -- When you request a list of objects with a "Limit" setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a "NextMarker" value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request. * **Limit** (*integer*) -- The maximum number of objects that you want WAF to return for this request. If more objects are available, in the response, WAF provides a "NextMarker" value that you can use in a subsequent call to get the next batch of objects. Return type: dict Returns: **Response Syntax** { 'NextMarker': 'string', 'IPSets': [ { 'Name': 'string', 'Id': 'string', 'Description': 'string', 'LockToken': 'string', 'ARN': 'string' }, ] } **Response Structure** * *(dict) --* * **NextMarker** *(string) --* When you request a list of objects with a "Limit" setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a "NextMarker" value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request. * **IPSets** *(list) --* Array of IPSets. If you specified a "Limit" in your request, this might not be the full list. * *(dict) --* High-level information about an IPSet, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage an "IPSet", and the ARN, that you provide to the IPSetReferenceStatement to use the address set in a Rule. * **Name** *(string) --* The name of the IP set. You cannot change the name of an "IPSet" after you create it. * **Id** *(string) --* A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete. * **Description** *(string) --* A description of the IP set that helps with identification. * **LockToken** *(string) --* A token used for optimistic locking. WAF returns a token to your "get" and "list" requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like "update" and "delete". WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a "WAFOptimisticLockException". If this happens, perform another "get", and use the new token returned by that operation. * **ARN** *(string) --* The Amazon Resource Name (ARN) of the entity. **Exceptions** * "WAFV2.Client.exceptions.WAFInternalErrorException" * "WAFV2.Client.exceptions.WAFInvalidParameterException" * "WAFV2.Client.exceptions.WAFInvalidOperationException" WAFV2 / Client / delete_rule_group delete_rule_group ***************** WAFV2.Client.delete_rule_group(**kwargs) Deletes the specified RuleGroup. See also: AWS API Documentation **Request Syntax** response = client.delete_rule_group( Name='string', Scope='CLOUDFRONT'|'REGIONAL', Id='string', LockToken='string' ) Parameters: * **Name** (*string*) -- **[REQUIRED]** The name of the rule group. You cannot change the name of a rule group after you create it. * **Scope** (*string*) -- **[REQUIRED]** Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. For an Amplify application, use "CLOUDFRONT". To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: * CLI - Specify the Region when you use the CloudFront scope: "--scope=CLOUDFRONT --region=us-east-1". * API and SDKs - For all calls, use the Region endpoint us- east-1. * **Id** (*string*) -- **[REQUIRED]** A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete. * **LockToken** (*string*) -- **[REQUIRED]** A token used for optimistic locking. WAF returns a token to your "get" and "list" requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like "update" and "delete". WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a "WAFOptimisticLockException". If this happens, perform another "get", and use the new token returned by that operation. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "WAFV2.Client.exceptions.WAFInternalErrorException" * "WAFV2.Client.exceptions.WAFInvalidParameterException" * "WAFV2.Client.exceptions.WAFNonexistentItemException" * "WAFV2.Client.exceptions.WAFOptimisticLockException" * "WAFV2.Client.exceptions.WAFAssociatedItemException" * "WAFV2.Client.exceptions.WAFTagOperationException" * "WAFV2.Client.exceptions.WAFTagOperationInternalErrorException" * "WAFV2.Client.exceptions.WAFInvalidOperationException" WAFV2 / Client / list_api_keys list_api_keys ************* WAFV2.Client.list_api_keys(**kwargs) 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 in the *WAF Developer Guide*. See also: AWS API Documentation **Request Syntax** response = client.list_api_keys( Scope='CLOUDFRONT'|'REGIONAL', NextMarker='string', Limit=123 ) Parameters: * **Scope** (*string*) -- **[REQUIRED]** Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. For an Amplify application, use "CLOUDFRONT". To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: * CLI - Specify the Region when you use the CloudFront scope: "--scope=CLOUDFRONT --region=us-east-1". * API and SDKs - For all calls, use the Region endpoint us- east-1. * **NextMarker** (*string*) -- When you request a list of objects with a "Limit" setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a "NextMarker" value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request. * **Limit** (*integer*) -- The maximum number of objects that you want WAF to return for this request. If more objects are available, in the response, WAF provides a "NextMarker" value that you can use in a subsequent call to get the next batch of objects. Return type: dict Returns: **Response Syntax** { 'NextMarker': 'string', 'APIKeySummaries': [ { 'TokenDomains': [ 'string', ], 'APIKey': 'string', 'CreationTimestamp': datetime(2015, 1, 1), 'Version': 123 }, ], 'ApplicationIntegrationURL': 'string' } **Response Structure** * *(dict) --* * **NextMarker** *(string) --* When you request a list of objects with a "Limit" setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a "NextMarker" value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request. * **APIKeySummaries** *(list) --* The array of key summaries. If you specified a "Limit" in your request, this might not be the full list. * *(dict) --* Information for a single API 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 in the *WAF Developer Guide*. * **TokenDomains** *(list) --* The token domains that are defined in this API key. * *(string) --* * **APIKey** *(string) --* The generated, encrypted API key. You can copy this for use in your JavaScript CAPTCHA integration. * **CreationTimestamp** *(datetime) --* The date and time that the key was created. * **Version** *(integer) --* Internal value used by WAF to manage the key. * **ApplicationIntegrationURL** *(string) --* The CAPTCHA application integration URL, for use in your JavaScript implementation. **Exceptions** * "WAFV2.Client.exceptions.WAFInternalErrorException" * "WAFV2.Client.exceptions.WAFInvalidParameterException" * "WAFV2.Client.exceptions.WAFInvalidOperationException" * "WAFV2.Client.exceptions.WAFInvalidResourceException" WAFV2 / Client / can_paginate can_paginate ************ WAFV2.Client.can_paginate(operation_name) Check if an operation can be paginated. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Returns: "True" if the operation can be paginated, "False" otherwise. WAFV2 / Client / update_rule_group update_rule_group ***************** WAFV2.Client.update_rule_group(**kwargs) Updates the specified RuleGroup. Note: 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. See also: AWS API Documentation **Request Syntax** response = client.update_rule_group( Name='string', Scope='CLOUDFRONT'|'REGIONAL', Id='string', Description='string', Rules=[ { 'Name': 'string', 'Priority': 123, 'Statement': { 'ByteMatchStatement': { 'SearchString': b'bytes', 'FieldToMatch': { 'SingleHeader': { 'Name': 'string' }, 'SingleQueryArgument': { 'Name': 'string' }, 'AllQueryArguments': {} , 'UriPath': {} , 'QueryString': {} , 'Body': { 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'Method': {} , 'JsonBody': { 'MatchPattern': { 'All': {} , 'IncludedPaths': [ 'string', ] }, 'MatchScope': 'ALL'|'KEY'|'VALUE', 'InvalidFallbackBehavior': 'MATCH'|'NO_MATCH'|'EVALUATE_AS_STRING', 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'Headers': { 'MatchPattern': { 'All': {} , 'IncludedHeaders': [ 'string', ], 'ExcludedHeaders': [ 'string', ] }, 'MatchScope': 'ALL'|'KEY'|'VALUE', 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'Cookies': { 'MatchPattern': { 'All': {} , 'IncludedCookies': [ 'string', ], 'ExcludedCookies': [ 'string', ] }, 'MatchScope': 'ALL'|'KEY'|'VALUE', 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'HeaderOrder': { 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'JA3Fingerprint': { 'FallbackBehavior': 'MATCH'|'NO_MATCH' }, 'JA4Fingerprint': { 'FallbackBehavior': 'MATCH'|'NO_MATCH' }, 'UriFragment': { 'FallbackBehavior': 'MATCH'|'NO_MATCH' } }, 'TextTransformations': [ { 'Priority': 123, 'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE' }, ], 'PositionalConstraint': 'EXACTLY'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS'|'CONTAINS_WORD' }, 'SqliMatchStatement': { 'FieldToMatch': { 'SingleHeader': { 'Name': 'string' }, 'SingleQueryArgument': { 'Name': 'string' }, 'AllQueryArguments': {} , 'UriPath': {} , 'QueryString': {} , 'Body': { 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'Method': {} , 'JsonBody': { 'MatchPattern': { 'All': {} , 'IncludedPaths': [ 'string', ] }, 'MatchScope': 'ALL'|'KEY'|'VALUE', 'InvalidFallbackBehavior': 'MATCH'|'NO_MATCH'|'EVALUATE_AS_STRING', 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'Headers': { 'MatchPattern': { 'All': {} , 'IncludedHeaders': [ 'string', ], 'ExcludedHeaders': [ 'string', ] }, 'MatchScope': 'ALL'|'KEY'|'VALUE', 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'Cookies': { 'MatchPattern': { 'All': {} , 'IncludedCookies': [ 'string', ], 'ExcludedCookies': [ 'string', ] }, 'MatchScope': 'ALL'|'KEY'|'VALUE', 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'HeaderOrder': { 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'JA3Fingerprint': { 'FallbackBehavior': 'MATCH'|'NO_MATCH' }, 'JA4Fingerprint': { 'FallbackBehavior': 'MATCH'|'NO_MATCH' }, 'UriFragment': { 'FallbackBehavior': 'MATCH'|'NO_MATCH' } }, 'TextTransformations': [ { 'Priority': 123, 'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE' }, ], 'SensitivityLevel': 'LOW'|'HIGH' }, 'XssMatchStatement': { 'FieldToMatch': { 'SingleHeader': { 'Name': 'string' }, 'SingleQueryArgument': { 'Name': 'string' }, 'AllQueryArguments': {} , 'UriPath': {} , 'QueryString': {} , 'Body': { 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'Method': {} , 'JsonBody': { 'MatchPattern': { 'All': {} , 'IncludedPaths': [ 'string', ] }, 'MatchScope': 'ALL'|'KEY'|'VALUE', 'InvalidFallbackBehavior': 'MATCH'|'NO_MATCH'|'EVALUATE_AS_STRING', 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'Headers': { 'MatchPattern': { 'All': {} , 'IncludedHeaders': [ 'string', ], 'ExcludedHeaders': [ 'string', ] }, 'MatchScope': 'ALL'|'KEY'|'VALUE', 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'Cookies': { 'MatchPattern': { 'All': {} , 'IncludedCookies': [ 'string', ], 'ExcludedCookies': [ 'string', ] }, 'MatchScope': 'ALL'|'KEY'|'VALUE', 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'HeaderOrder': { 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'JA3Fingerprint': { 'FallbackBehavior': 'MATCH'|'NO_MATCH' }, 'JA4Fingerprint': { 'FallbackBehavior': 'MATCH'|'NO_MATCH' }, 'UriFragment': { 'FallbackBehavior': 'MATCH'|'NO_MATCH' } }, 'TextTransformations': [ { 'Priority': 123, 'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE' }, ] }, 'SizeConstraintStatement': { 'FieldToMatch': { 'SingleHeader': { 'Name': 'string' }, 'SingleQueryArgument': { 'Name': 'string' }, 'AllQueryArguments': {} , 'UriPath': {} , 'QueryString': {} , 'Body': { 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'Method': {} , 'JsonBody': { 'MatchPattern': { 'All': {} , 'IncludedPaths': [ 'string', ] }, 'MatchScope': 'ALL'|'KEY'|'VALUE', 'InvalidFallbackBehavior': 'MATCH'|'NO_MATCH'|'EVALUATE_AS_STRING', 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'Headers': { 'MatchPattern': { 'All': {} , 'IncludedHeaders': [ 'string', ], 'ExcludedHeaders': [ 'string', ] }, 'MatchScope': 'ALL'|'KEY'|'VALUE', 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'Cookies': { 'MatchPattern': { 'All': {} , 'IncludedCookies': [ 'string', ], 'ExcludedCookies': [ 'string', ] }, 'MatchScope': 'ALL'|'KEY'|'VALUE', 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'HeaderOrder': { 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'JA3Fingerprint': { 'FallbackBehavior': 'MATCH'|'NO_MATCH' }, 'JA4Fingerprint': { 'FallbackBehavior': 'MATCH'|'NO_MATCH' }, 'UriFragment': { 'FallbackBehavior': 'MATCH'|'NO_MATCH' } }, 'ComparisonOperator': 'EQ'|'NE'|'LE'|'LT'|'GE'|'GT', 'Size': 123, 'TextTransformations': [ { 'Priority': 123, 'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE' }, ] }, 'GeoMatchStatement': { 'CountryCodes': [ 'AF'|'AX'|'AL'|'DZ'|'AS'|'AD'|'AO'|'AI'|'AQ'|'AG'|'AR'|'AM'|'AW'|'AU'|'AT'|'AZ'|'BS'|'BH'|'BD'|'BB'|'BY'|'BE'|'BZ'|'BJ'|'BM'|'BT'|'BO'|'BQ'|'BA'|'BW'|'BV'|'BR'|'IO'|'BN'|'BG'|'BF'|'BI'|'KH'|'CM'|'CA'|'CV'|'KY'|'CF'|'TD'|'CL'|'CN'|'CX'|'CC'|'CO'|'KM'|'CG'|'CD'|'CK'|'CR'|'CI'|'HR'|'CU'|'CW'|'CY'|'CZ'|'DK'|'DJ'|'DM'|'DO'|'EC'|'EG'|'SV'|'GQ'|'ER'|'EE'|'ET'|'FK'|'FO'|'FJ'|'FI'|'FR'|'GF'|'PF'|'TF'|'GA'|'GM'|'GE'|'DE'|'GH'|'GI'|'GR'|'GL'|'GD'|'GP'|'GU'|'GT'|'GG'|'GN'|'GW'|'GY'|'HT'|'HM'|'VA'|'HN'|'HK'|'HU'|'IS'|'IN'|'ID'|'IR'|'IQ'|'IE'|'IM'|'IL'|'IT'|'JM'|'JP'|'JE'|'JO'|'KZ'|'KE'|'KI'|'KP'|'KR'|'KW'|'KG'|'LA'|'LV'|'LB'|'LS'|'LR'|'LY'|'LI'|'LT'|'LU'|'MO'|'MK'|'MG'|'MW'|'MY'|'MV'|'ML'|'MT'|'MH'|'MQ'|'MR'|'MU'|'YT'|'MX'|'FM'|'MD'|'MC'|'MN'|'ME'|'MS'|'MA'|'MZ'|'MM'|'NA'|'NR'|'NP'|'NL'|'NC'|'NZ'|'NI'|'NE'|'NG'|'NU'|'NF'|'MP'|'NO'|'OM'|'PK'|'PW'|'PS'|'PA'|'PG'|'PY'|'PE'|'PH'|'PN'|'PL'|'PT'|'PR'|'QA'|'RE'|'RO'|'RU'|'RW'|'BL'|'SH'|'KN'|'LC'|'MF'|'PM'|'VC'|'WS'|'SM'|'ST'|'SA'|'SN'|'RS'|'SC'|'SL'|'SG'|'SX'|'SK'|'SI'|'SB'|'SO'|'ZA'|'GS'|'SS'|'ES'|'LK'|'SD'|'SR'|'SJ'|'SZ'|'SE'|'CH'|'SY'|'TW'|'TJ'|'TZ'|'TH'|'TL'|'TG'|'TK'|'TO'|'TT'|'TN'|'TR'|'TM'|'TC'|'TV'|'UG'|'UA'|'AE'|'GB'|'US'|'UM'|'UY'|'UZ'|'VU'|'VE'|'VN'|'VG'|'VI'|'WF'|'EH'|'YE'|'ZM'|'ZW'|'XK', ], 'ForwardedIPConfig': { 'HeaderName': 'string', 'FallbackBehavior': 'MATCH'|'NO_MATCH' } }, 'RuleGroupReferenceStatement': { 'ARN': 'string', 'ExcludedRules': [ { 'Name': 'string' }, ], 'RuleActionOverrides': [ { 'Name': 'string', 'ActionToUse': { 'Block': { 'CustomResponse': { 'ResponseCode': 123, 'CustomResponseBodyKey': 'string', 'ResponseHeaders': [ { 'Name': 'string', 'Value': 'string' }, ] } }, 'Allow': { 'CustomRequestHandling': { 'InsertHeaders': [ { 'Name': 'string', 'Value': 'string' }, ] } }, 'Count': { 'CustomRequestHandling': { 'InsertHeaders': [ { 'Name': 'string', 'Value': 'string' }, ] } }, 'Captcha': { 'CustomRequestHandling': { 'InsertHeaders': [ { 'Name': 'string', 'Value': 'string' }, ] } }, 'Challenge': { 'CustomRequestHandling': { 'InsertHeaders': [ { 'Name': 'string', 'Value': 'string' }, ] } } } }, ] }, 'IPSetReferenceStatement': { 'ARN': 'string', 'IPSetForwardedIPConfig': { 'HeaderName': 'string', 'FallbackBehavior': 'MATCH'|'NO_MATCH', 'Position': 'FIRST'|'LAST'|'ANY' } }, 'RegexPatternSetReferenceStatement': { 'ARN': 'string', 'FieldToMatch': { 'SingleHeader': { 'Name': 'string' }, 'SingleQueryArgument': { 'Name': 'string' }, 'AllQueryArguments': {} , 'UriPath': {} , 'QueryString': {} , 'Body': { 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'Method': {} , 'JsonBody': { 'MatchPattern': { 'All': {} , 'IncludedPaths': [ 'string', ] }, 'MatchScope': 'ALL'|'KEY'|'VALUE', 'InvalidFallbackBehavior': 'MATCH'|'NO_MATCH'|'EVALUATE_AS_STRING', 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'Headers': { 'MatchPattern': { 'All': {} , 'IncludedHeaders': [ 'string', ], 'ExcludedHeaders': [ 'string', ] }, 'MatchScope': 'ALL'|'KEY'|'VALUE', 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'Cookies': { 'MatchPattern': { 'All': {} , 'IncludedCookies': [ 'string', ], 'ExcludedCookies': [ 'string', ] }, 'MatchScope': 'ALL'|'KEY'|'VALUE', 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'HeaderOrder': { 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'JA3Fingerprint': { 'FallbackBehavior': 'MATCH'|'NO_MATCH' }, 'JA4Fingerprint': { 'FallbackBehavior': 'MATCH'|'NO_MATCH' }, 'UriFragment': { 'FallbackBehavior': 'MATCH'|'NO_MATCH' } }, 'TextTransformations': [ { 'Priority': 123, 'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE' }, ] }, 'RateBasedStatement': { 'Limit': 123, 'EvaluationWindowSec': 123, 'AggregateKeyType': 'IP'|'FORWARDED_IP'|'CUSTOM_KEYS'|'CONSTANT', 'ScopeDownStatement': {'... recursive ...'}, 'ForwardedIPConfig': { 'HeaderName': 'string', 'FallbackBehavior': 'MATCH'|'NO_MATCH' }, 'CustomKeys': [ { 'Header': { 'Name': 'string', 'TextTransformations': [ { 'Priority': 123, 'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE' }, ] }, 'Cookie': { 'Name': 'string', 'TextTransformations': [ { 'Priority': 123, 'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE' }, ] }, 'QueryArgument': { 'Name': 'string', 'TextTransformations': [ { 'Priority': 123, 'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE' }, ] }, 'QueryString': { 'TextTransformations': [ { 'Priority': 123, 'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE' }, ] }, 'HTTPMethod': {} , 'ForwardedIP': {} , 'IP': {} , 'LabelNamespace': { 'Namespace': 'string' }, 'UriPath': { 'TextTransformations': [ { 'Priority': 123, 'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE' }, ] }, 'JA3Fingerprint': { 'FallbackBehavior': 'MATCH'|'NO_MATCH' }, 'JA4Fingerprint': { 'FallbackBehavior': 'MATCH'|'NO_MATCH' }, 'ASN': {} }, ] }, 'AndStatement': { 'Statements': [ {'... recursive ...'}, ] }, 'OrStatement': { 'Statements': [ {'... recursive ...'}, ] }, 'NotStatement': { 'Statement': {'... recursive ...'} }, 'ManagedRuleGroupStatement': { 'VendorName': 'string', 'Name': 'string', 'Version': 'string', 'ExcludedRules': [ { 'Name': 'string' }, ], 'ScopeDownStatement': {'... recursive ...'}, 'ManagedRuleGroupConfigs': [ { 'LoginPath': 'string', 'PayloadType': 'JSON'|'FORM_ENCODED', 'UsernameField': { 'Identifier': 'string' }, 'PasswordField': { 'Identifier': 'string' }, 'AWSManagedRulesBotControlRuleSet': { 'InspectionLevel': 'COMMON'|'TARGETED', 'EnableMachineLearning': True|False }, 'AWSManagedRulesATPRuleSet': { 'LoginPath': 'string', 'RequestInspection': { 'PayloadType': 'JSON'|'FORM_ENCODED', 'UsernameField': { 'Identifier': 'string' }, 'PasswordField': { 'Identifier': 'string' } }, 'ResponseInspection': { 'StatusCode': { 'SuccessCodes': [ 123, ], 'FailureCodes': [ 123, ] }, 'Header': { 'Name': 'string', 'SuccessValues': [ 'string', ], 'FailureValues': [ 'string', ] }, 'BodyContains': { 'SuccessStrings': [ 'string', ], 'FailureStrings': [ 'string', ] }, 'Json': { 'Identifier': 'string', 'SuccessValues': [ 'string', ], 'FailureValues': [ 'string', ] } }, 'EnableRegexInPath': True|False }, 'AWSManagedRulesACFPRuleSet': { 'CreationPath': 'string', 'RegistrationPagePath': 'string', 'RequestInspection': { 'PayloadType': 'JSON'|'FORM_ENCODED', 'UsernameField': { 'Identifier': 'string' }, 'PasswordField': { 'Identifier': 'string' }, 'EmailField': { 'Identifier': 'string' }, 'PhoneNumberFields': [ { 'Identifier': 'string' }, ], 'AddressFields': [ { 'Identifier': 'string' }, ] }, 'ResponseInspection': { 'StatusCode': { 'SuccessCodes': [ 123, ], 'FailureCodes': [ 123, ] }, 'Header': { 'Name': 'string', 'SuccessValues': [ 'string', ], 'FailureValues': [ 'string', ] }, 'BodyContains': { 'SuccessStrings': [ 'string', ], 'FailureStrings': [ 'string', ] }, 'Json': { 'Identifier': 'string', 'SuccessValues': [ 'string', ], 'FailureValues': [ 'string', ] } }, 'EnableRegexInPath': True|False }, 'AWSManagedRulesAntiDDoSRuleSet': { 'ClientSideActionConfig': { 'Challenge': { 'UsageOfAction': 'ENABLED'|'DISABLED', 'Sensitivity': 'LOW'|'MEDIUM'|'HIGH', 'ExemptUriRegularExpressions': [ { 'RegexString': 'string' }, ] } }, 'SensitivityToBlock': 'LOW'|'MEDIUM'|'HIGH' } }, ], 'RuleActionOverrides': [ { 'Name': 'string', 'ActionToUse': { 'Block': { 'CustomResponse': { 'ResponseCode': 123, 'CustomResponseBodyKey': 'string', 'ResponseHeaders': [ { 'Name': 'string', 'Value': 'string' }, ] } }, 'Allow': { 'CustomRequestHandling': { 'InsertHeaders': [ { 'Name': 'string', 'Value': 'string' }, ] } }, 'Count': { 'CustomRequestHandling': { 'InsertHeaders': [ { 'Name': 'string', 'Value': 'string' }, ] } }, 'Captcha': { 'CustomRequestHandling': { 'InsertHeaders': [ { 'Name': 'string', 'Value': 'string' }, ] } }, 'Challenge': { 'CustomRequestHandling': { 'InsertHeaders': [ { 'Name': 'string', 'Value': 'string' }, ] } } } }, ] }, 'LabelMatchStatement': { 'Scope': 'LABEL'|'NAMESPACE', 'Key': 'string' }, 'RegexMatchStatement': { 'RegexString': 'string', 'FieldToMatch': { 'SingleHeader': { 'Name': 'string' }, 'SingleQueryArgument': { 'Name': 'string' }, 'AllQueryArguments': {} , 'UriPath': {} , 'QueryString': {} , 'Body': { 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'Method': {} , 'JsonBody': { 'MatchPattern': { 'All': {} , 'IncludedPaths': [ 'string', ] }, 'MatchScope': 'ALL'|'KEY'|'VALUE', 'InvalidFallbackBehavior': 'MATCH'|'NO_MATCH'|'EVALUATE_AS_STRING', 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'Headers': { 'MatchPattern': { 'All': {} , 'IncludedHeaders': [ 'string', ], 'ExcludedHeaders': [ 'string', ] }, 'MatchScope': 'ALL'|'KEY'|'VALUE', 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'Cookies': { 'MatchPattern': { 'All': {} , 'IncludedCookies': [ 'string', ], 'ExcludedCookies': [ 'string', ] }, 'MatchScope': 'ALL'|'KEY'|'VALUE', 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'HeaderOrder': { 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'JA3Fingerprint': { 'FallbackBehavior': 'MATCH'|'NO_MATCH' }, 'JA4Fingerprint': { 'FallbackBehavior': 'MATCH'|'NO_MATCH' }, 'UriFragment': { 'FallbackBehavior': 'MATCH'|'NO_MATCH' } }, 'TextTransformations': [ { 'Priority': 123, 'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE' }, ] }, 'AsnMatchStatement': { 'AsnList': [ 123, ], 'ForwardedIPConfig': { 'HeaderName': 'string', 'FallbackBehavior': 'MATCH'|'NO_MATCH' } } }, 'Action': { 'Block': { 'CustomResponse': { 'ResponseCode': 123, 'CustomResponseBodyKey': 'string', 'ResponseHeaders': [ { 'Name': 'string', 'Value': 'string' }, ] } }, 'Allow': { 'CustomRequestHandling': { 'InsertHeaders': [ { 'Name': 'string', 'Value': 'string' }, ] } }, 'Count': { 'CustomRequestHandling': { 'InsertHeaders': [ { 'Name': 'string', 'Value': 'string' }, ] } }, 'Captcha': { 'CustomRequestHandling': { 'InsertHeaders': [ { 'Name': 'string', 'Value': 'string' }, ] } }, 'Challenge': { 'CustomRequestHandling': { 'InsertHeaders': [ { 'Name': 'string', 'Value': 'string' }, ] } } }, 'OverrideAction': { 'Count': { 'CustomRequestHandling': { 'InsertHeaders': [ { 'Name': 'string', 'Value': 'string' }, ] } }, 'None': {} }, 'RuleLabels': [ { 'Name': 'string' }, ], 'VisibilityConfig': { 'SampledRequestsEnabled': True|False, 'CloudWatchMetricsEnabled': True|False, 'MetricName': 'string' }, 'CaptchaConfig': { 'ImmunityTimeProperty': { 'ImmunityTime': 123 } }, 'ChallengeConfig': { 'ImmunityTimeProperty': { 'ImmunityTime': 123 } } }, ], VisibilityConfig={ 'SampledRequestsEnabled': True|False, 'CloudWatchMetricsEnabled': True|False, 'MetricName': 'string' }, LockToken='string', CustomResponseBodies={ 'string': { 'ContentType': 'TEXT_PLAIN'|'TEXT_HTML'|'APPLICATION_JSON', 'Content': 'string' } } ) **Parameters** :: # This section is too large to render. # Please see the AWS API Documentation linked below. `AWS API Documentation `_ Return type: dict Returns: **Response Syntax** { 'NextLockToken': 'string' } **Response Structure** * *(dict) --* * **NextLockToken** *(string) --* A token used for optimistic locking. WAF returns this token to your "update" requests. You use "NextLockToken" in the same manner as you use "LockToken". **Exceptions** * "WAFV2.Client.exceptions.WAFInternalErrorException" * "WAFV2.Client.exceptions.WAFInvalidParameterException" * "WAFV2.Client.exceptions.WAFNonexistentItemException" * "WAFV2.Client.exceptions.WAFDuplicateItemException" * "WAFV2.Client.exceptions.WAFOptimisticLockException" * "WAFV2.Client.exceptions.WAFLimitsExceededException" * "WAFV2.Client.exceptions.WAFUnavailableEntityException" * "WAFV2.Client.exceptions.WAFSubscriptionNotFoundException" * "WAFV2.Client.exceptions.WAFInvalidOperationException" * "WAFV2.Client.exceptions.WAFConfigurationWarningException" WAFV2 / Client / delete_permission_policy delete_permission_policy ************************ WAFV2.Client.delete_permission_policy(**kwargs) Permanently deletes an IAM policy from the specified rule group. You must be the owner of the rule group to perform this operation. See also: AWS API Documentation **Request Syntax** response = client.delete_permission_policy( ResourceArn='string' ) Parameters: **ResourceArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the rule group from which you want to delete the policy. You must be the owner of the rule group to perform this operation. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "WAFV2.Client.exceptions.WAFNonexistentItemException" * "WAFV2.Client.exceptions.WAFInternalErrorException" * "WAFV2.Client.exceptions.WAFInvalidParameterException" WAFV2 / Client / get_decrypted_api_key get_decrypted_api_key ********************* WAFV2.Client.get_decrypted_api_key(**kwargs) 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 in the *WAF Developer Guide*. See also: AWS API Documentation **Request Syntax** response = client.get_decrypted_api_key( Scope='CLOUDFRONT'|'REGIONAL', APIKey='string' ) Parameters: * **Scope** (*string*) -- **[REQUIRED]** Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. For an Amplify application, use "CLOUDFRONT". To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: * CLI - Specify the Region when you use the CloudFront scope: "--scope=CLOUDFRONT --region=us-east-1". * API and SDKs - For all calls, use the Region endpoint us- east-1. * **APIKey** (*string*) -- **[REQUIRED]** The encrypted API key. Return type: dict Returns: **Response Syntax** { 'TokenDomains': [ 'string', ], 'CreationTimestamp': datetime(2015, 1, 1) } **Response Structure** * *(dict) --* * **TokenDomains** *(list) --* The token domains that are defined in this API key. * *(string) --* * **CreationTimestamp** *(datetime) --* The date and time that the key was created. **Exceptions** * "WAFV2.Client.exceptions.WAFInternalErrorException" * "WAFV2.Client.exceptions.WAFNonexistentItemException" * "WAFV2.Client.exceptions.WAFInvalidParameterException" * "WAFV2.Client.exceptions.WAFInvalidOperationException" * "WAFV2.Client.exceptions.WAFInvalidResourceException" WAFV2 / Client / create_ip_set create_ip_set ************* WAFV2.Client.create_ip_set(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.create_ip_set( Name='string', Scope='CLOUDFRONT'|'REGIONAL', Description='string', IPAddressVersion='IPV4'|'IPV6', Addresses=[ 'string', ], Tags=[ { 'Key': 'string', 'Value': 'string' }, ] ) Parameters: * **Name** (*string*) -- **[REQUIRED]** The name of the IP set. You cannot change the name of an "IPSet" after you create it. * **Scope** (*string*) -- **[REQUIRED]** Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. For an Amplify application, use "CLOUDFRONT". To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: * CLI - Specify the Region when you use the CloudFront scope: "--scope=CLOUDFRONT --region=us-east-1". * API and SDKs - For all calls, use the Region endpoint us- east-1. * **Description** (*string*) -- A description of the IP set that helps with identification. * **IPAddressVersion** (*string*) -- **[REQUIRED]** The version of the IP addresses, either "IPV4" or "IPV6". * **Addresses** (*list*) -- **[REQUIRED]** Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses that you want WAF to inspect for in incoming requests. All addresses must be specified using Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for "/0". Example address strings: * For requests that originated from the IP address 192.0.2.44, specify "192.0.2.44/32". * For requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify "192.0.2.0/24". * For requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify "1111:0000:0000:0000:0000:0000:0000:0111/128". * For requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify "1111:0000:0000:0000:0000:0000:0000:0000/64". For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing. Example JSON "Addresses" specifications: * Empty array: ""Addresses": []" * Array with one address: ""Addresses": ["192.0.2.44/32"]" * Array with three addresses: ""Addresses": ["192.0.2.44/32", "192.0.2.0/24", "192.0.0.0/16"]" * INVALID specification: ""Addresses": [""]" INVALID * *(string) --* * **Tags** (*list*) -- An array of key:value pairs to associate with the resource. * *(dict) --* A tag associated with an Amazon Web Services resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing or other management. Typically, the tag key represents a category, such as "environment", and the tag value represents a specific value within that category, such as "test," "development," or "production". Or 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. * **Key** *(string) --* **[REQUIRED]** Part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as "customer." Tag keys are case-sensitive. * **Value** *(string) --* **[REQUIRED]** Part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as "companyA" or "companyB." Tag values are case-sensitive. Return type: dict Returns: **Response Syntax** { 'Summary': { 'Name': 'string', 'Id': 'string', 'Description': 'string', 'LockToken': 'string', 'ARN': 'string' } } **Response Structure** * *(dict) --* * **Summary** *(dict) --* High-level information about an IPSet, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage an "IPSet", and the ARN, that you provide to the IPSetReferenceStatement to use the address set in a Rule. * **Name** *(string) --* The name of the IP set. You cannot change the name of an "IPSet" after you create it. * **Id** *(string) --* A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete. * **Description** *(string) --* A description of the IP set that helps with identification. * **LockToken** *(string) --* A token used for optimistic locking. WAF returns a token to your "get" and "list" requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like "update" and "delete". WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a "WAFOptimisticLockException". If this happens, perform another "get", and use the new token returned by that operation. * **ARN** *(string) --* The Amazon Resource Name (ARN) of the entity. **Exceptions** * "WAFV2.Client.exceptions.WAFInternalErrorException" * "WAFV2.Client.exceptions.WAFInvalidParameterException" * "WAFV2.Client.exceptions.WAFDuplicateItemException" * "WAFV2.Client.exceptions.WAFOptimisticLockException" * "WAFV2.Client.exceptions.WAFLimitsExceededException" * "WAFV2.Client.exceptions.WAFTagOperationException" * "WAFV2.Client.exceptions.WAFTagOperationInternalErrorException" * "WAFV2.Client.exceptions.WAFInvalidOperationException" WAFV2 / Client / get_permission_policy get_permission_policy ********************* WAFV2.Client.get_permission_policy(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.get_permission_policy( ResourceArn='string' ) Parameters: **ResourceArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the rule group for which you want to get the policy. Return type: dict Returns: **Response Syntax** { 'Policy': 'string' } **Response Structure** * *(dict) --* * **Policy** *(string) --* The IAM policy that is attached to the specified rule group. **Exceptions** * "WAFV2.Client.exceptions.WAFNonexistentItemException" * "WAFV2.Client.exceptions.WAFInternalErrorException" * "WAFV2.Client.exceptions.WAFInvalidParameterException" WAFV2 / Client / delete_ip_set delete_ip_set ************* WAFV2.Client.delete_ip_set(**kwargs) Deletes the specified IPSet. See also: AWS API Documentation **Request Syntax** response = client.delete_ip_set( Name='string', Scope='CLOUDFRONT'|'REGIONAL', Id='string', LockToken='string' ) Parameters: * **Name** (*string*) -- **[REQUIRED]** The name of the IP set. You cannot change the name of an "IPSet" after you create it. * **Scope** (*string*) -- **[REQUIRED]** Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. For an Amplify application, use "CLOUDFRONT". To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: * CLI - Specify the Region when you use the CloudFront scope: "--scope=CLOUDFRONT --region=us-east-1". * API and SDKs - For all calls, use the Region endpoint us- east-1. * **Id** (*string*) -- **[REQUIRED]** A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete. * **LockToken** (*string*) -- **[REQUIRED]** A token used for optimistic locking. WAF returns a token to your "get" and "list" requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like "update" and "delete". WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a "WAFOptimisticLockException". If this happens, perform another "get", and use the new token returned by that operation. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "WAFV2.Client.exceptions.WAFInternalErrorException" * "WAFV2.Client.exceptions.WAFInvalidParameterException" * "WAFV2.Client.exceptions.WAFNonexistentItemException" * "WAFV2.Client.exceptions.WAFOptimisticLockException" * "WAFV2.Client.exceptions.WAFAssociatedItemException" * "WAFV2.Client.exceptions.WAFTagOperationException" * "WAFV2.Client.exceptions.WAFTagOperationInternalErrorException" * "WAFV2.Client.exceptions.WAFInvalidOperationException" WAFV2 / Client / update_regex_pattern_set update_regex_pattern_set ************************ WAFV2.Client.update_regex_pattern_set(**kwargs) Updates the specified RegexPatternSet. Note: 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. See also: AWS API Documentation **Request Syntax** response = client.update_regex_pattern_set( Name='string', Scope='CLOUDFRONT'|'REGIONAL', Id='string', Description='string', RegularExpressionList=[ { 'RegexString': 'string' }, ], LockToken='string' ) Parameters: * **Name** (*string*) -- **[REQUIRED]** The name of the set. You cannot change the name after you create the set. * **Scope** (*string*) -- **[REQUIRED]** Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. For an Amplify application, use "CLOUDFRONT". To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: * CLI - Specify the Region when you use the CloudFront scope: "--scope=CLOUDFRONT --region=us-east-1". * API and SDKs - For all calls, use the Region endpoint us- east-1. * **Id** (*string*) -- **[REQUIRED]** A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete. * **Description** (*string*) -- A description of the set that helps with identification. * **RegularExpressionList** (*list*) -- **[REQUIRED]** * *(dict) --* A single regular expression. This is used in a RegexPatternSet and also in the configuration for the Amazon Web Services Managed Rules rule group "AWSManagedRulesAntiDDoSRuleSet". * **RegexString** *(string) --* The string representing the regular expression. * **LockToken** (*string*) -- **[REQUIRED]** A token used for optimistic locking. WAF returns a token to your "get" and "list" requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like "update" and "delete". WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a "WAFOptimisticLockException". If this happens, perform another "get", and use the new token returned by that operation. Return type: dict Returns: **Response Syntax** { 'NextLockToken': 'string' } **Response Structure** * *(dict) --* * **NextLockToken** *(string) --* A token used for optimistic locking. WAF returns this token to your "update" requests. You use "NextLockToken" in the same manner as you use "LockToken". **Exceptions** * "WAFV2.Client.exceptions.WAFInternalErrorException" * "WAFV2.Client.exceptions.WAFInvalidParameterException" * "WAFV2.Client.exceptions.WAFNonexistentItemException" * "WAFV2.Client.exceptions.WAFDuplicateItemException" * "WAFV2.Client.exceptions.WAFOptimisticLockException" * "WAFV2.Client.exceptions.WAFLimitsExceededException" * "WAFV2.Client.exceptions.WAFInvalidOperationException" WAFV2 / Client / get_web_acl get_web_acl *********** WAFV2.Client.get_web_acl(**kwargs) Retrieves the specified WebACL. See also: AWS API Documentation **Request Syntax** response = client.get_web_acl( Name='string', Scope='CLOUDFRONT'|'REGIONAL', Id='string', ARN='string' ) Parameters: * **Name** (*string*) -- The name of the web ACL. You cannot change the name of a web ACL after you create it. * **Scope** (*string*) -- Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. For an Amplify application, use "CLOUDFRONT". To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: * CLI - Specify the Region when you use the CloudFront scope: "--scope=CLOUDFRONT --region=us-east-1". * API and SDKs - For all calls, use the Region endpoint us- east-1. * **Id** (*string*) -- The unique identifier for the web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete. * **ARN** (*string*) -- The Amazon Resource Name (ARN) of the web ACL that you want to retrieve. Return type: dict Returns: **Response Syntax** # This section is too large to render. # Please see the AWS API Documentation linked below. AWS API Documentation **Response Structure** # This section is too large to render. # Please see the AWS API Documentation linked below. AWS API Documentation **Exceptions** * "WAFV2.Client.exceptions.WAFInternalErrorException" * "WAFV2.Client.exceptions.WAFInvalidParameterException" * "WAFV2.Client.exceptions.WAFNonexistentItemException" * "WAFV2.Client.exceptions.WAFInvalidOperationException" WAFV2 / Client / put_permission_policy put_permission_policy ********************* WAFV2.Client.put_permission_policy(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.put_permission_policy( ResourceArn='string', Policy='string' ) Parameters: * **ResourceArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the RuleGroup to which you want to attach the policy. * **Policy** (*string*) -- **[REQUIRED]** The policy to attach to the specified rule group. The policy specifications must conform to the following: * The policy must be composed using IAM Policy version 2012-10-17. * The policy must include specifications for "Effect", "Action", and "Principal". * "Effect" must specify "Allow". * "Action" must specify "wafv2:CreateWebACL", "wafv2:UpdateWebACL", and "wafv2:PutFirewallManagerRuleGroups" and may optionally specify "wafv2:GetRuleGroup". WAF rejects any extra actions or wildcard actions in the policy. * The policy must not include a "Resource" parameter. For more information, see IAM Policies. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "WAFV2.Client.exceptions.WAFNonexistentItemException" * "WAFV2.Client.exceptions.WAFInternalErrorException" * "WAFV2.Client.exceptions.WAFInvalidParameterException" * "WAFV2.Client.exceptions.WAFInvalidPermissionPolicyException" WAFV2 / Client / list_available_managed_rule_group_versions list_available_managed_rule_group_versions ****************************************** WAFV2.Client.list_available_managed_rule_group_versions(**kwargs) Returns a list of the available versions for the specified managed rule group. See also: AWS API Documentation **Request Syntax** response = client.list_available_managed_rule_group_versions( VendorName='string', Name='string', Scope='CLOUDFRONT'|'REGIONAL', NextMarker='string', Limit=123 ) Parameters: * **VendorName** (*string*) -- **[REQUIRED]** The name of the managed rule group vendor. You use this, along with the rule group name, to identify a rule group. * **Name** (*string*) -- **[REQUIRED]** The name of the managed rule group. You use this, along with the vendor name, to identify the rule group. * **Scope** (*string*) -- **[REQUIRED]** Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. For an Amplify application, use "CLOUDFRONT". To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: * CLI - Specify the Region when you use the CloudFront scope: "--scope=CLOUDFRONT --region=us-east-1". * API and SDKs - For all calls, use the Region endpoint us- east-1. * **NextMarker** (*string*) -- When you request a list of objects with a "Limit" setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a "NextMarker" value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request. * **Limit** (*integer*) -- The maximum number of objects that you want WAF to return for this request. If more objects are available, in the response, WAF provides a "NextMarker" value that you can use in a subsequent call to get the next batch of objects. Return type: dict Returns: **Response Syntax** { 'NextMarker': 'string', 'Versions': [ { 'Name': 'string', 'LastUpdateTimestamp': datetime(2015, 1, 1) }, ], 'CurrentDefaultVersion': 'string' } **Response Structure** * *(dict) --* * **NextMarker** *(string) --* When you request a list of objects with a "Limit" setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a "NextMarker" value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request. * **Versions** *(list) --* The versions that are currently available for the specified managed rule group. If you specified a "Limit" in your request, this might not be the full list. * *(dict) --* Describes a single version of a managed rule group. * **Name** *(string) --* The version name. * **LastUpdateTimestamp** *(datetime) --* The date and time that the managed rule group owner updated the rule group version information. * **CurrentDefaultVersion** *(string) --* The name of the version that's currently set as the default. **Exceptions** * "WAFV2.Client.exceptions.WAFInternalErrorException" * "WAFV2.Client.exceptions.WAFInvalidParameterException" * "WAFV2.Client.exceptions.WAFNonexistentItemException" * "WAFV2.Client.exceptions.WAFInvalidOperationException" WAFV2 / Client / get_logging_configuration get_logging_configuration ************************* WAFV2.Client.get_logging_configuration(**kwargs) Returns the LoggingConfiguration for the specified web ACL. See also: AWS API Documentation **Request Syntax** response = client.get_logging_configuration( ResourceArn='string', LogType='WAF_LOGS', LogScope='CUSTOMER'|'SECURITY_LAKE' ) Parameters: * **ResourceArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the web ACL for which you want to get the LoggingConfiguration. * **LogType** (*string*) -- Used to distinguish between various logging options. Currently, there is one option. Default: "WAF_LOGS" * **LogScope** (*string*) -- The owner of the logging configuration, which must be set to "CUSTOMER" for the configurations that you manage. The log scope "SECURITY_LAKE" indicates a configuration that is managed through Amazon Security Lake. You can use Security Lake to collect log and event data from various sources for normalization, analysis, and management. For information, see Collecting data from Amazon Web Services services in the *Amazon Security Lake user guide*. Default: "CUSTOMER" Return type: dict Returns: **Response Syntax** { 'LoggingConfiguration': { 'ResourceArn': 'string', 'LogDestinationConfigs': [ 'string', ], 'RedactedFields': [ { 'SingleHeader': { 'Name': 'string' }, 'SingleQueryArgument': { 'Name': 'string' }, 'AllQueryArguments': {}, 'UriPath': {}, 'QueryString': {}, 'Body': { 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'Method': {}, 'JsonBody': { 'MatchPattern': { 'All': {}, 'IncludedPaths': [ 'string', ] }, 'MatchScope': 'ALL'|'KEY'|'VALUE', 'InvalidFallbackBehavior': 'MATCH'|'NO_MATCH'|'EVALUATE_AS_STRING', 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'Headers': { 'MatchPattern': { 'All': {}, 'IncludedHeaders': [ 'string', ], 'ExcludedHeaders': [ 'string', ] }, 'MatchScope': 'ALL'|'KEY'|'VALUE', 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'Cookies': { 'MatchPattern': { 'All': {}, 'IncludedCookies': [ 'string', ], 'ExcludedCookies': [ 'string', ] }, 'MatchScope': 'ALL'|'KEY'|'VALUE', 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'HeaderOrder': { 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'JA3Fingerprint': { 'FallbackBehavior': 'MATCH'|'NO_MATCH' }, 'JA4Fingerprint': { 'FallbackBehavior': 'MATCH'|'NO_MATCH' }, 'UriFragment': { 'FallbackBehavior': 'MATCH'|'NO_MATCH' } }, ], 'ManagedByFirewallManager': True|False, 'LoggingFilter': { 'Filters': [ { 'Behavior': 'KEEP'|'DROP', 'Requirement': 'MEETS_ALL'|'MEETS_ANY', 'Conditions': [ { 'ActionCondition': { 'Action': 'ALLOW'|'BLOCK'|'COUNT'|'CAPTCHA'|'CHALLENGE'|'EXCLUDED_AS_COUNT' }, 'LabelNameCondition': { 'LabelName': 'string' } }, ] }, ], 'DefaultBehavior': 'KEEP'|'DROP' }, 'LogType': 'WAF_LOGS', 'LogScope': 'CUSTOMER'|'SECURITY_LAKE' } } **Response Structure** * *(dict) --* * **LoggingConfiguration** *(dict) --* The LoggingConfiguration for the specified web ACL. * **ResourceArn** *(string) --* The Amazon Resource Name (ARN) of the web ACL that you want to associate with "LogDestinationConfigs". * **LogDestinationConfigs** *(list) --* The logging destination configuration that you want to associate with the web ACL. Note: You can associate one logging destination to a web ACL. * *(string) --* * **RedactedFields** *(list) --* The parts of the request that you want to keep out of the logs. For example, if you redact the "SingleHeader" field, the "HEADER" field in the logs will be "REDACTED" for all rules that use the "SingleHeader" "FieldToMatch" setting. If you configure data protection for the web ACL, the protection applies to the data that WAF sends to the logs. Redaction applies only to the component that's specified in the rule's "FieldToMatch" setting, so the "SingleHeader" redaction doesn't apply to rules that use the "Headers" "FieldToMatch". Note: You can specify only the following fields for redaction: "UriPath", "QueryString", "SingleHeader", and "Method". Note: This setting has no impact on request sampling. You can only exclude fields from request sampling by disabling sampling in the web ACL visibility configuration or by configuring data protection for the web ACL. * *(dict) --* Specifies a web request component to be used in a rule match statement or in a logging configuration. * In a rule statement, this is the part of the web request that you want WAF to inspect. Include the single "FieldToMatch" type that you want to inspect, with additional specifications as needed, according to the type. You specify a single request component in "FieldToMatch" for each rule statement that requires it. To inspect more than one component of the web request, create a separate rule statement for each component. Example JSON for a "QueryString" field to match: ""FieldToMatch": { "QueryString": {} }" Example JSON for a "Method" field to match specification: ""FieldToMatch": { "Method": { "Name": "DELETE" } }" * In a logging configuration, this is used in the "RedactedFields" property to specify a field to redact from the logging records. For this use case, note the following: * Even though all "FieldToMatch" settings are available, the only valid settings for field redaction are "UriPath", "QueryString", "SingleHeader", and "Method". * In this documentation, the descriptions of the individual fields talk about specifying the web request component to inspect, but for field redaction, you are specifying the component type to redact from the logs. * If you have request sampling enabled, the redacted fields configuration for logging has no impact on sampling. You can only exclude fields from request sampling by disabling sampling in the web ACL visibility configuration or by configuring data protection for the web ACL. * **SingleHeader** *(dict) --* Inspect a single header. Provide the name of the header to inspect, for example, "User-Agent" or "Referer". This setting isn't case sensitive. Example JSON: ""SingleHeader": { "Name": "haystack" }" Alternately, you can filter and inspect all headers with the "Headers" "FieldToMatch" setting. * **Name** *(string) --* The name of the query header to inspect. * **SingleQueryArgument** *(dict) --* Inspect a single query argument. Provide the name of the query argument to inspect, such as *UserName* or *SalesRegion*. The name can be up to 30 characters long and isn't case sensitive. Example JSON: ""SingleQueryArgument": { "Name": "myArgument" }" * **Name** *(string) --* The name of the query argument to inspect. * **AllQueryArguments** *(dict) --* Inspect all query arguments. * **UriPath** *(dict) --* Inspect the request URI path. This is the part of the web request that identifies a resource, for example, "/images/daily-ad.jpg". * **QueryString** *(dict) --* Inspect the query string. This is the part of a URL that appears after a "?" character, if any. * **Body** *(dict) --* Inspect the request body as plain text. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form. WAF does not support inspecting the entire contents of the web request body if the body exceeds the limit for the resource type. When a web request body is larger than the limit, the underlying host service only forwards the contents that are within the limit to WAF for inspection. * For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes). * For CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access, the default limit is 16 KB (16,384 bytes), and you can increase the limit for each resource type in the web ACL "AssociationConfig", for additional processing fees. * For Amplify, use the CloudFront limit. For information about how to handle oversized request bodies, see the "Body" object configuration. * **OversizeHandling** *(string) --* What WAF should do if the body is larger than WAF can inspect. WAF does not support inspecting the entire contents of the web request body if the body exceeds the limit for the resource type. When a web request body is larger than the limit, the underlying host service only forwards the contents that are within the limit to WAF for inspection. * For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes). * For CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access, the default limit is 16 KB (16,384 bytes), and you can increase the limit for each resource type in the web ACL "AssociationConfig", for additional processing fees. * For Amplify, use the CloudFront limit. The options for oversize handling are the following: * "CONTINUE" - Inspect the available body contents normally, according to the rule inspection criteria. * "MATCH" - Treat the web request as matching the rule statement. WAF applies the rule action to the request. * "NO_MATCH" - Treat the web request as not matching the rule statement. You can combine the "MATCH" or "NO_MATCH" settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over the limit. Default: "CONTINUE" * **Method** *(dict) --* Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform. * **JsonBody** *(dict) --* Inspect the request body as JSON. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form. WAF does not support inspecting the entire contents of the web request body if the body exceeds the limit for the resource type. When a web request body is larger than the limit, the underlying host service only forwards the contents that are within the limit to WAF for inspection. * For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes). * For CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access, the default limit is 16 KB (16,384 bytes), and you can increase the limit for each resource type in the web ACL "AssociationConfig", for additional processing fees. * For Amplify, use the CloudFront limit. For information about how to handle oversized request bodies, see the "JsonBody" object configuration. * **MatchPattern** *(dict) --* The patterns to look for in the JSON body. WAF inspects the results of these pattern matches against the rule inspection criteria. * **All** *(dict) --* Match all of the elements. See also "MatchScope" in JsonBody. You must specify either this setting or the "IncludedPaths" setting, but not both. * **IncludedPaths** *(list) --* Match only the specified include paths. See also "MatchScope" in JsonBody. Provide the include paths using JSON Pointer syntax. For example, ""IncludedPaths": ["/dogs/0/name", "/dogs/1/name"]". For information about this syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer. You must specify either this setting or the "All" setting, but not both. Note: Don't use this option to include all paths. Instead, use the "All" setting. * *(string) --* * **MatchScope** *(string) --* The parts of the JSON to match against using the "MatchPattern". If you specify "ALL", WAF matches against keys and values. "All" does not require a match to be found in the keys and a match to be found in the values. It requires a match to be found in the keys or the values or both. To require a match in the keys and in the values, use a logical "AND" statement to combine two match rules, one that inspects the keys and another that inspects the values. * **InvalidFallbackBehavior** *(string) --* What WAF should do if it fails to completely parse the JSON body. The options are the following: * "EVALUATE_AS_STRING" - Inspect the body as plain text. WAF applies the text transformations and inspection criteria that you defined for the JSON inspection to the body text string. * "MATCH" - Treat the web request as matching the rule statement. WAF applies the rule action to the request. * "NO_MATCH" - Treat the web request as not matching the rule statement. If you don't provide this setting, WAF parses and evaluates the content only up to the first parsing failure that it encounters. Note: WAF parsing doesn't fully validate the input JSON string, so parsing can succeed even for invalid JSON. When parsing succeeds, WAF doesn't apply the fallback behavior. For more information, see JSON body in the *WAF Developer Guide*. * **OversizeHandling** *(string) --* What WAF should do if the body is larger than WAF can inspect. WAF does not support inspecting the entire contents of the web request body if the body exceeds the limit for the resource type. When a web request body is larger than the limit, the underlying host service only forwards the contents that are within the limit to WAF for inspection. * For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes). * For CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access, the default limit is 16 KB (16,384 bytes), and you can increase the limit for each resource type in the web ACL "AssociationConfig", for additional processing fees. * For Amplify, use the CloudFront limit. The options for oversize handling are the following: * "CONTINUE" - Inspect the available body contents normally, according to the rule inspection criteria. * "MATCH" - Treat the web request as matching the rule statement. WAF applies the rule action to the request. * "NO_MATCH" - Treat the web request as not matching the rule statement. You can combine the "MATCH" or "NO_MATCH" settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over the limit. Default: "CONTINUE" * **Headers** *(dict) --* Inspect the request headers. You must configure scope and pattern matching filters in the "Headers" object, to define the set of headers to and the parts of the headers that WAF inspects. Only the first 8 KB (8192 bytes) of a request's headers and only the first 200 headers are forwarded to WAF for inspection by the underlying host service. You must configure how to handle any oversize header content in the "Headers" object. WAF applies the pattern matching filters to the headers that it receives from the underlying host service. * **MatchPattern** *(dict) --* The filter to use to identify the subset of headers to inspect in a web request. You must specify exactly one setting: either "All", "IncludedHeaders", or "ExcludedHeaders". Example JSON: ""MatchPattern": { "ExcludedHeaders": [ "KeyToExclude1", "KeyToExclude2" ] }" * **All** *(dict) --* Inspect all headers. * **IncludedHeaders** *(list) --* Inspect only the headers that have a key that matches one of the strings specified here. * *(string) --* * **ExcludedHeaders** *(list) --* Inspect only the headers whose keys don't match any of the strings specified here. * *(string) --* * **MatchScope** *(string) --* The parts of the headers to match with the rule inspection criteria. If you specify "ALL", WAF inspects both keys and values. "All" does not require a match to be found in the keys and a match to be found in the values. It requires a match to be found in the keys or the values or both. To require a match in the keys and in the values, use a logical "AND" statement to combine two match rules, one that inspects the keys and another that inspects the values. * **OversizeHandling** *(string) --* What WAF should do if the headers determined by your match scope are more numerous or larger than WAF can inspect. WAF does not support inspecting the entire contents of request headers when they exceed 8 KB (8192 bytes) or 200 total headers. The underlying host service forwards a maximum of 200 headers and at most 8 KB of header contents to WAF. The options for oversize handling are the following: * "CONTINUE" - Inspect the available headers normally, according to the rule inspection criteria. * "MATCH" - Treat the web request as matching the rule statement. WAF applies the rule action to the request. * "NO_MATCH" - Treat the web request as not matching the rule statement. * **Cookies** *(dict) --* Inspect the request cookies. You must configure scope and pattern matching filters in the "Cookies" object, to define the set of cookies and the parts of the cookies that WAF inspects. Only the first 8 KB (8192 bytes) of a request's cookies and only the first 200 cookies are forwarded to WAF for inspection by the underlying host service. You must configure how to handle any oversize cookie content in the "Cookies" object. WAF applies the pattern matching filters to the cookies that it receives from the underlying host service. * **MatchPattern** *(dict) --* The filter to use to identify the subset of cookies to inspect in a web request. You must specify exactly one setting: either "All", "IncludedCookies", or "ExcludedCookies". Example JSON: ""MatchPattern": { "IncludedCookies": [ "session-id-time", "session-id" ] }" * **All** *(dict) --* Inspect all cookies. * **IncludedCookies** *(list) --* Inspect only the cookies that have a key that matches one of the strings specified here. * *(string) --* * **ExcludedCookies** *(list) --* Inspect only the cookies whose keys don't match any of the strings specified here. * *(string) --* * **MatchScope** *(string) --* The parts of the cookies to inspect with the rule inspection criteria. If you specify "ALL", WAF inspects both keys and values. "All" does not require a match to be found in the keys and a match to be found in the values. It requires a match to be found in the keys or the values or both. To require a match in the keys and in the values, use a logical "AND" statement to combine two match rules, one that inspects the keys and another that inspects the values. * **OversizeHandling** *(string) --* What WAF should do if the cookies of the request are more numerous or larger than WAF can inspect. WAF does not support inspecting the entire contents of request cookies when they exceed 8 KB (8192 bytes) or 200 total cookies. The underlying host service forwards a maximum of 200 cookies and at most 8 KB of cookie contents to WAF. The options for oversize handling are the following: * "CONTINUE" - Inspect the available cookies normally, according to the rule inspection criteria. * "MATCH" - Treat the web request as matching the rule statement. WAF applies the rule action to the request. * "NO_MATCH" - Treat the web request as not matching the rule statement. * **HeaderOrder** *(dict) --* Inspect a string containing the list of the request's header names, ordered as they appear in the web request that WAF receives for inspection. WAF generates the string and then uses that as the field to match component in its inspection. WAF separates the header names in the string using colons and no added spaces, for example "host:user- agent:accept:authorization:referer". * **OversizeHandling** *(string) --* What WAF should do if the headers determined by your match scope are more numerous or larger than WAF can inspect. WAF does not support inspecting the entire contents of request headers when they exceed 8 KB (8192 bytes) or 200 total headers. The underlying host service forwards a maximum of 200 headers and at most 8 KB of header contents to WAF. The options for oversize handling are the following: * "CONTINUE" - Inspect the available headers normally, according to the rule inspection criteria. * "MATCH" - Treat the web request as matching the rule statement. WAF applies the rule action to the request. * "NO_MATCH" - Treat the web request as not matching the rule statement. * **JA3Fingerprint** *(dict) --* Available for use with Amazon CloudFront distributions and Application Load Balancers. Match against the request's JA3 fingerprint. The JA3 fingerprint is a 32-character hash derived from the TLS Client Hello of an incoming request. This fingerprint serves as a unique identifier for the client's TLS configuration. WAF calculates and logs this fingerprint for each request that has enough TLS Client Hello information for the calculation. Almost all web requests include this information. Note: You can use this choice only with a string match "ByteMatchStatement" with the "PositionalConstraint" set to "EXACTLY". You can obtain the JA3 fingerprint for client requests from the web ACL logs. If WAF is able to calculate the fingerprint, it includes it in the logs. For information about the logging fields, see Log fields in the *WAF Developer Guide*. Provide the JA3 fingerprint string from the logs in your string match statement specification, to match with any future requests that have the same TLS configuration. * **FallbackBehavior** *(string) --* The match status to assign to the web request if the request doesn't have a JA3 fingerprint. You can specify the following fallback behaviors: * "MATCH" - Treat the web request as matching the rule statement. WAF applies the rule action to the request. * "NO_MATCH" - Treat the web request as not matching the rule statement. * **JA4Fingerprint** *(dict) --* Available for use with Amazon CloudFront distributions and Application Load Balancers. Match against the request's JA4 fingerprint. The JA4 fingerprint is a 36-character hash derived from the TLS Client Hello of an incoming request. This fingerprint serves as a unique identifier for the client's TLS configuration. WAF calculates and logs this fingerprint for each request that has enough TLS Client Hello information for the calculation. Almost all web requests include this information. Note: You can use this choice only with a string match "ByteMatchStatement" with the "PositionalConstraint" set to "EXACTLY". You can obtain the JA4 fingerprint for client requests from the web ACL logs. If WAF is able to calculate the fingerprint, it includes it in the logs. For information about the logging fields, see Log fields in the *WAF Developer Guide*. Provide the JA4 fingerprint string from the logs in your string match statement specification, to match with any future requests that have the same TLS configuration. * **FallbackBehavior** *(string) --* The match status to assign to the web request if the request doesn't have a JA4 fingerprint. You can specify the following fallback behaviors: * "MATCH" - Treat the web request as matching the rule statement. WAF applies the rule action to the request. * "NO_MATCH" - Treat the web request as not matching the rule statement. * **UriFragment** *(dict) --* Inspect fragments of the request URI. You must configure scope and pattern matching filters in the "UriFragment" object, to define the fragment of a URI that WAF inspects. Only the first 8 KB (8192 bytes) of a request's URI fragments and only the first 200 URI fragments are forwarded to WAF for inspection by the underlying host service. You must configure how to handle any oversize URI fragment content in the "UriFragment" object. WAF applies the pattern matching filters to the cookies that it receives from the underlying host service. * **FallbackBehavior** *(string) --* What WAF should do if it fails to completely parse the JSON body. The options are the following: * "EVALUATE_AS_STRING" - Inspect the body as plain text. WAF applies the text transformations and inspection criteria that you defined for the JSON inspection to the body text string. * "MATCH" - Treat the web request as matching the rule statement. WAF applies the rule action to the request. * "NO_MATCH" - Treat the web request as not matching the rule statement. If you don't provide this setting, WAF parses and evaluates the content only up to the first parsing failure that it encounters. Example JSON: "{ "UriFragment": { "FallbackBehavior": "MATCH"} }" Note: WAF parsing doesn't fully validate the input JSON string, so parsing can succeed even for invalid JSON. When parsing succeeds, WAF doesn't apply the fallback behavior. For more information, see JSON body in the *WAF Developer Guide*. * **ManagedByFirewallManager** *(boolean) --* Indicates whether the logging configuration was created by Firewall Manager, as part of an WAF policy configuration. If true, only Firewall Manager can modify or delete the configuration. The logging configuration can be created by Firewall Manager for use with any web ACL that Firewall Manager is using for an WAF policy. Web ACLs that Firewall Manager creates and uses have their "ManagedByFirewallManager" property set to true. Web ACLs that were created by a customer account and then retrofitted by Firewall Manager for use by a policy have their "RetrofittedByFirewallManager" property set to true. For either case, any corresponding logging configuration will indicate "ManagedByFirewallManager". * **LoggingFilter** *(dict) --* Filtering that specifies which web requests are kept in the logs and which are dropped. You can filter on the rule action and on the web request labels that were applied by matching rules during web ACL evaluation. * **Filters** *(list) --* The filters that you want to apply to the logs. * *(dict) --* A single logging filter, used in LoggingFilter. * **Behavior** *(string) --* How to handle logs that satisfy the filter's conditions and requirement. * **Requirement** *(string) --* Logic to apply to the filtering conditions. You can specify that, in order to satisfy the filter, a log must match all conditions or must match at least one condition. * **Conditions** *(list) --* Match conditions for the filter. * *(dict) --* A single match condition for a Filter. * **ActionCondition** *(dict) --* A single action condition. This is the action setting that a log record must contain in order to meet the condition. * **Action** *(string) --* The action setting that a log record must contain in order to meet the condition. This is the action that WAF applied to the web request. For rule groups, this is either the configured rule action setting, or if you've applied a rule action override to the rule, it's the override action. The value "EXCLUDED_AS_COUNT" matches on excluded rules and also on rules that have a rule action override of Count. * **LabelNameCondition** *(dict) --* A single label name condition. This is the fully qualified label name that a log record must contain in order to meet the condition. Fully qualified labels have a prefix, optional namespaces, and label name. The prefix identifies the rule group or web ACL context of the rule that added the label. * **LabelName** *(string) --* The label name that a log record must contain in order to meet the condition. This must be a fully qualified label name. Fully qualified labels have a prefix, optional namespaces, and label name. The prefix identifies the rule group or web ACL context of the rule that added the label. * **DefaultBehavior** *(string) --* Default handling for logs that don't match any of the specified filtering conditions. * **LogType** *(string) --* Used to distinguish between various logging options. Currently, there is one option. Default: "WAF_LOGS" * **LogScope** *(string) --* The owner of the logging configuration, which must be set to "CUSTOMER" for the configurations that you manage. The log scope "SECURITY_LAKE" indicates a configuration that is managed through Amazon Security Lake. You can use Security Lake to collect log and event data from various sources for normalization, analysis, and management. For information, see Collecting data from Amazon Web Services services in the *Amazon Security Lake user guide*. Default: "CUSTOMER" **Exceptions** * "WAFV2.Client.exceptions.WAFInternalErrorException" * "WAFV2.Client.exceptions.WAFNonexistentItemException" * "WAFV2.Client.exceptions.WAFInvalidParameterException" * "WAFV2.Client.exceptions.WAFInvalidOperationException" WAFV2 / Client / list_tags_for_resource list_tags_for_resource ********************** WAFV2.Client.list_tags_for_resource(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.list_tags_for_resource( NextMarker='string', Limit=123, ResourceARN='string' ) Parameters: * **NextMarker** (*string*) -- When you request a list of objects with a "Limit" setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a "NextMarker" value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request. * **Limit** (*integer*) -- The maximum number of objects that you want WAF to return for this request. If more objects are available, in the response, WAF provides a "NextMarker" value that you can use in a subsequent call to get the next batch of objects. * **ResourceARN** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the resource. Return type: dict Returns: **Response Syntax** { 'NextMarker': 'string', 'TagInfoForResource': { 'ResourceARN': 'string', 'TagList': [ { 'Key': 'string', 'Value': 'string' }, ] } } **Response Structure** * *(dict) --* * **NextMarker** *(string) --* When you request a list of objects with a "Limit" setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a "NextMarker" value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request. * **TagInfoForResource** *(dict) --* The collection of tagging definitions for the resource. If you specified a "Limit" in your request, this might not be the full list. * **ResourceARN** *(string) --* The Amazon Resource Name (ARN) of the resource. * **TagList** *(list) --* The array of Tag objects defined for the resource. * *(dict) --* A tag associated with an Amazon Web Services resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing or other management. Typically, the tag key represents a category, such as "environment", and the tag value represents a specific value within that category, such as "test," "development," or "production". Or 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. * **Key** *(string) --* Part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as "customer." Tag keys are case-sensitive. * **Value** *(string) --* Part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as "companyA" or "companyB." Tag values are case-sensitive. **Exceptions** * "WAFV2.Client.exceptions.WAFInternalErrorException" * "WAFV2.Client.exceptions.WAFInvalidParameterException" * "WAFV2.Client.exceptions.WAFNonexistentItemException" * "WAFV2.Client.exceptions.WAFTagOperationException" * "WAFV2.Client.exceptions.WAFTagOperationInternalErrorException" * "WAFV2.Client.exceptions.WAFInvalidOperationException" WAFV2 / Client / list_rule_groups list_rule_groups **************** WAFV2.Client.list_rule_groups(**kwargs) Retrieves an array of RuleGroupSummary objects for the rule groups that you manage. See also: AWS API Documentation **Request Syntax** response = client.list_rule_groups( Scope='CLOUDFRONT'|'REGIONAL', NextMarker='string', Limit=123 ) Parameters: * **Scope** (*string*) -- **[REQUIRED]** Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. For an Amplify application, use "CLOUDFRONT". To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: * CLI - Specify the Region when you use the CloudFront scope: "--scope=CLOUDFRONT --region=us-east-1". * API and SDKs - For all calls, use the Region endpoint us- east-1. * **NextMarker** (*string*) -- When you request a list of objects with a "Limit" setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a "NextMarker" value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request. * **Limit** (*integer*) -- The maximum number of objects that you want WAF to return for this request. If more objects are available, in the response, WAF provides a "NextMarker" value that you can use in a subsequent call to get the next batch of objects. Return type: dict Returns: **Response Syntax** { 'NextMarker': 'string', 'RuleGroups': [ { 'Name': 'string', 'Id': 'string', 'Description': 'string', 'LockToken': 'string', 'ARN': 'string' }, ] } **Response Structure** * *(dict) --* * **NextMarker** *(string) --* When you request a list of objects with a "Limit" setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a "NextMarker" value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request. * **RuleGroups** *(list) --* Array of rule groups. If you specified a "Limit" in your request, this might not be the full list. * *(dict) --* High-level information about a RuleGroup, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage a "RuleGroup", and the ARN, that you provide to the RuleGroupReferenceStatement to use the rule group in a Rule. * **Name** *(string) --* The name of the data type instance. You cannot change the name after you create the instance. * **Id** *(string) --* A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete. * **Description** *(string) --* A description of the rule group that helps with identification. * **LockToken** *(string) --* A token used for optimistic locking. WAF returns a token to your "get" and "list" requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like "update" and "delete". WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a "WAFOptimisticLockException". If this happens, perform another "get", and use the new token returned by that operation. * **ARN** *(string) --* The Amazon Resource Name (ARN) of the entity. **Exceptions** * "WAFV2.Client.exceptions.WAFInternalErrorException" * "WAFV2.Client.exceptions.WAFInvalidParameterException" * "WAFV2.Client.exceptions.WAFInvalidOperationException" WAFV2 / Client / untag_resource untag_resource ************** WAFV2.Client.untag_resource(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.untag_resource( ResourceARN='string', TagKeys=[ 'string', ] ) Parameters: * **ResourceARN** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the resource. * **TagKeys** (*list*) -- **[REQUIRED]** An array of keys identifying the tags to disassociate from the resource. * *(string) --* Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "WAFV2.Client.exceptions.WAFInternalErrorException" * "WAFV2.Client.exceptions.WAFInvalidParameterException" * "WAFV2.Client.exceptions.WAFNonexistentItemException" * "WAFV2.Client.exceptions.WAFTagOperationException" * "WAFV2.Client.exceptions.WAFTagOperationInternalErrorException" * "WAFV2.Client.exceptions.WAFInvalidOperationException" WAFV2 / Client / list_web_acls list_web_acls ************* WAFV2.Client.list_web_acls(**kwargs) Retrieves an array of WebACLSummary objects for the web ACLs that you manage. See also: AWS API Documentation **Request Syntax** response = client.list_web_acls( Scope='CLOUDFRONT'|'REGIONAL', NextMarker='string', Limit=123 ) Parameters: * **Scope** (*string*) -- **[REQUIRED]** Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. For an Amplify application, use "CLOUDFRONT". To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: * CLI - Specify the Region when you use the CloudFront scope: "--scope=CLOUDFRONT --region=us-east-1". * API and SDKs - For all calls, use the Region endpoint us- east-1. * **NextMarker** (*string*) -- When you request a list of objects with a "Limit" setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a "NextMarker" value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request. * **Limit** (*integer*) -- The maximum number of objects that you want WAF to return for this request. If more objects are available, in the response, WAF provides a "NextMarker" value that you can use in a subsequent call to get the next batch of objects. Return type: dict Returns: **Response Syntax** { 'NextMarker': 'string', 'WebACLs': [ { 'Name': 'string', 'Id': 'string', 'Description': 'string', 'LockToken': 'string', 'ARN': 'string' }, ] } **Response Structure** * *(dict) --* * **NextMarker** *(string) --* When you request a list of objects with a "Limit" setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a "NextMarker" value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request. * **WebACLs** *(list) --* Array of web ACLs. If you specified a "Limit" in your request, this might not be the full list. * *(dict) --* High-level information about a WebACL, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage a "WebACL", and the ARN, that you provide to operations like AssociateWebACL. * **Name** *(string) --* The name of the web ACL. You cannot change the name of a web ACL after you create it. * **Id** *(string) --* The unique identifier for the web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete. * **Description** *(string) --* A description of the web ACL that helps with identification. * **LockToken** *(string) --* A token used for optimistic locking. WAF returns a token to your "get" and "list" requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like "update" and "delete". WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a "WAFOptimisticLockException". If this happens, perform another "get", and use the new token returned by that operation. * **ARN** *(string) --* The Amazon Resource Name (ARN) of the entity. **Exceptions** * "WAFV2.Client.exceptions.WAFInternalErrorException" * "WAFV2.Client.exceptions.WAFInvalidParameterException" * "WAFV2.Client.exceptions.WAFInvalidOperationException" WAFV2 / Client / associate_web_acl associate_web_acl ***************** WAFV2.Client.associate_web_acl(**kwargs) Associates a web ACL with a resource, to protect the resource. Use this for all resource types except for Amazon CloudFront distributions. For Amazon CloudFront, call "UpdateDistribution" for the distribution and provide the Amazon Resource Name (ARN) of the web ACL in the web ACL ID. For information, see UpdateDistribution 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 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. See also: AWS API Documentation **Request Syntax** response = client.associate_web_acl( WebACLArn='string', ResourceArn='string' ) Parameters: * **WebACLArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the web ACL that you want to associate with the resource. * **ResourceArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the resource to associate with the web ACL. The ARN must be in one of the following formats: * For an Application Load Balancer: "arn:partition:elasticloadbalancing:region:account- id:loadbalancer/app/load-balancer-name/load-balancer-id" * For an Amazon API Gateway REST API: "arn:partition:apigateway:region::/restapis/api-id/stages /stage-name" * For an AppSync GraphQL API: "arn:partition:appsync:region :account-id:apis/GraphQLApiId" * For an Amazon Cognito user pool: "arn:partition:cognito- idp:region:account-id:userpool/user-pool-id" * For an App Runner service: "arn:partition:apprunner:region :account-id:service/apprunner-service-name/apprunner- service-id" * For an Amazon Web Services Verified Access instance: "arn:partition:ec2:region:account-id:verified-access- instance/instance-id" * For an Amplify application: "arn:partition:amplify:region :account-id:apps/app-id" Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "WAFV2.Client.exceptions.WAFInternalErrorException" * "WAFV2.Client.exceptions.WAFInvalidParameterException" * "WAFV2.Client.exceptions.WAFNonexistentItemException" * "WAFV2.Client.exceptions.WAFUnavailableEntityException" * "WAFV2.Client.exceptions.WAFInvalidOperationException" WAFV2 / Client / get_web_acl_for_resource get_web_acl_for_resource ************************ WAFV2.Client.get_web_acl_for_resource(**kwargs) 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 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 in the *WAF Developer Guide*. See also: AWS API Documentation **Request Syntax** response = client.get_web_acl_for_resource( ResourceArn='string' ) Parameters: **ResourceArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the resource whose web ACL you want to retrieve. The ARN must be in one of the following formats: * For an Application Load Balancer: "arn:partition:elasticloadbalancing:region:account- id:loadbalancer/app/load-balancer-name/load-balancer-id" * For an Amazon API Gateway REST API: "arn:partition:apigateway:region::/restapis/api-id/stages /stage-name" * For an AppSync GraphQL API: "arn:partition:appsync:region :account-id:apis/GraphQLApiId" * For an Amazon Cognito user pool: "arn:partition:cognito- idp:region:account-id:userpool/user-pool-id" * For an App Runner service: "arn:partition:apprunner:region :account-id:service/apprunner-service-name/apprunner-service- id" * For an Amazon Web Services Verified Access instance: "arn:partition:ec2:region:account-id:verified-access-instance /instance-id" * For an Amplify application: "arn:partition:amplify:region :account-id:apps/app-id" Return type: dict Returns: **Response Syntax** # This section is too large to render. # Please see the AWS API Documentation linked below. AWS API Documentation **Response Structure** # This section is too large to render. # Please see the AWS API Documentation linked below. AWS API Documentation **Exceptions** * "WAFV2.Client.exceptions.WAFInternalErrorException" * "WAFV2.Client.exceptions.WAFNonexistentItemException" * "WAFV2.Client.exceptions.WAFInvalidParameterException" * "WAFV2.Client.exceptions.WAFUnavailableEntityException" * "WAFV2.Client.exceptions.WAFInvalidOperationException" WAFV2 / Client / get_waiter get_waiter ********** WAFV2.Client.get_waiter(waiter_name) Returns an object that can wait for some condition. Parameters: **waiter_name** (*str*) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters. Returns: The specified waiter object. Return type: "botocore.waiter.Waiter" WAFV2 / Client / check_capacity check_capacity ************** WAFV2.Client.check_capacity(**kwargs) 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) in the *WAF Developer Guide*. See also: AWS API Documentation **Request Syntax** response = client.check_capacity( Scope='CLOUDFRONT'|'REGIONAL', Rules=[ { 'Name': 'string', 'Priority': 123, 'Statement': { 'ByteMatchStatement': { 'SearchString': b'bytes', 'FieldToMatch': { 'SingleHeader': { 'Name': 'string' }, 'SingleQueryArgument': { 'Name': 'string' }, 'AllQueryArguments': {} , 'UriPath': {} , 'QueryString': {} , 'Body': { 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'Method': {} , 'JsonBody': { 'MatchPattern': { 'All': {} , 'IncludedPaths': [ 'string', ] }, 'MatchScope': 'ALL'|'KEY'|'VALUE', 'InvalidFallbackBehavior': 'MATCH'|'NO_MATCH'|'EVALUATE_AS_STRING', 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'Headers': { 'MatchPattern': { 'All': {} , 'IncludedHeaders': [ 'string', ], 'ExcludedHeaders': [ 'string', ] }, 'MatchScope': 'ALL'|'KEY'|'VALUE', 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'Cookies': { 'MatchPattern': { 'All': {} , 'IncludedCookies': [ 'string', ], 'ExcludedCookies': [ 'string', ] }, 'MatchScope': 'ALL'|'KEY'|'VALUE', 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'HeaderOrder': { 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'JA3Fingerprint': { 'FallbackBehavior': 'MATCH'|'NO_MATCH' }, 'JA4Fingerprint': { 'FallbackBehavior': 'MATCH'|'NO_MATCH' }, 'UriFragment': { 'FallbackBehavior': 'MATCH'|'NO_MATCH' } }, 'TextTransformations': [ { 'Priority': 123, 'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE' }, ], 'PositionalConstraint': 'EXACTLY'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS'|'CONTAINS_WORD' }, 'SqliMatchStatement': { 'FieldToMatch': { 'SingleHeader': { 'Name': 'string' }, 'SingleQueryArgument': { 'Name': 'string' }, 'AllQueryArguments': {} , 'UriPath': {} , 'QueryString': {} , 'Body': { 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'Method': {} , 'JsonBody': { 'MatchPattern': { 'All': {} , 'IncludedPaths': [ 'string', ] }, 'MatchScope': 'ALL'|'KEY'|'VALUE', 'InvalidFallbackBehavior': 'MATCH'|'NO_MATCH'|'EVALUATE_AS_STRING', 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'Headers': { 'MatchPattern': { 'All': {} , 'IncludedHeaders': [ 'string', ], 'ExcludedHeaders': [ 'string', ] }, 'MatchScope': 'ALL'|'KEY'|'VALUE', 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'Cookies': { 'MatchPattern': { 'All': {} , 'IncludedCookies': [ 'string', ], 'ExcludedCookies': [ 'string', ] }, 'MatchScope': 'ALL'|'KEY'|'VALUE', 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'HeaderOrder': { 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'JA3Fingerprint': { 'FallbackBehavior': 'MATCH'|'NO_MATCH' }, 'JA4Fingerprint': { 'FallbackBehavior': 'MATCH'|'NO_MATCH' }, 'UriFragment': { 'FallbackBehavior': 'MATCH'|'NO_MATCH' } }, 'TextTransformations': [ { 'Priority': 123, 'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE' }, ], 'SensitivityLevel': 'LOW'|'HIGH' }, 'XssMatchStatement': { 'FieldToMatch': { 'SingleHeader': { 'Name': 'string' }, 'SingleQueryArgument': { 'Name': 'string' }, 'AllQueryArguments': {} , 'UriPath': {} , 'QueryString': {} , 'Body': { 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'Method': {} , 'JsonBody': { 'MatchPattern': { 'All': {} , 'IncludedPaths': [ 'string', ] }, 'MatchScope': 'ALL'|'KEY'|'VALUE', 'InvalidFallbackBehavior': 'MATCH'|'NO_MATCH'|'EVALUATE_AS_STRING', 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'Headers': { 'MatchPattern': { 'All': {} , 'IncludedHeaders': [ 'string', ], 'ExcludedHeaders': [ 'string', ] }, 'MatchScope': 'ALL'|'KEY'|'VALUE', 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'Cookies': { 'MatchPattern': { 'All': {} , 'IncludedCookies': [ 'string', ], 'ExcludedCookies': [ 'string', ] }, 'MatchScope': 'ALL'|'KEY'|'VALUE', 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'HeaderOrder': { 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'JA3Fingerprint': { 'FallbackBehavior': 'MATCH'|'NO_MATCH' }, 'JA4Fingerprint': { 'FallbackBehavior': 'MATCH'|'NO_MATCH' }, 'UriFragment': { 'FallbackBehavior': 'MATCH'|'NO_MATCH' } }, 'TextTransformations': [ { 'Priority': 123, 'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE' }, ] }, 'SizeConstraintStatement': { 'FieldToMatch': { 'SingleHeader': { 'Name': 'string' }, 'SingleQueryArgument': { 'Name': 'string' }, 'AllQueryArguments': {} , 'UriPath': {} , 'QueryString': {} , 'Body': { 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'Method': {} , 'JsonBody': { 'MatchPattern': { 'All': {} , 'IncludedPaths': [ 'string', ] }, 'MatchScope': 'ALL'|'KEY'|'VALUE', 'InvalidFallbackBehavior': 'MATCH'|'NO_MATCH'|'EVALUATE_AS_STRING', 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'Headers': { 'MatchPattern': { 'All': {} , 'IncludedHeaders': [ 'string', ], 'ExcludedHeaders': [ 'string', ] }, 'MatchScope': 'ALL'|'KEY'|'VALUE', 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'Cookies': { 'MatchPattern': { 'All': {} , 'IncludedCookies': [ 'string', ], 'ExcludedCookies': [ 'string', ] }, 'MatchScope': 'ALL'|'KEY'|'VALUE', 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'HeaderOrder': { 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'JA3Fingerprint': { 'FallbackBehavior': 'MATCH'|'NO_MATCH' }, 'JA4Fingerprint': { 'FallbackBehavior': 'MATCH'|'NO_MATCH' }, 'UriFragment': { 'FallbackBehavior': 'MATCH'|'NO_MATCH' } }, 'ComparisonOperator': 'EQ'|'NE'|'LE'|'LT'|'GE'|'GT', 'Size': 123, 'TextTransformations': [ { 'Priority': 123, 'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE' }, ] }, 'GeoMatchStatement': { 'CountryCodes': [ 'AF'|'AX'|'AL'|'DZ'|'AS'|'AD'|'AO'|'AI'|'AQ'|'AG'|'AR'|'AM'|'AW'|'AU'|'AT'|'AZ'|'BS'|'BH'|'BD'|'BB'|'BY'|'BE'|'BZ'|'BJ'|'BM'|'BT'|'BO'|'BQ'|'BA'|'BW'|'BV'|'BR'|'IO'|'BN'|'BG'|'BF'|'BI'|'KH'|'CM'|'CA'|'CV'|'KY'|'CF'|'TD'|'CL'|'CN'|'CX'|'CC'|'CO'|'KM'|'CG'|'CD'|'CK'|'CR'|'CI'|'HR'|'CU'|'CW'|'CY'|'CZ'|'DK'|'DJ'|'DM'|'DO'|'EC'|'EG'|'SV'|'GQ'|'ER'|'EE'|'ET'|'FK'|'FO'|'FJ'|'FI'|'FR'|'GF'|'PF'|'TF'|'GA'|'GM'|'GE'|'DE'|'GH'|'GI'|'GR'|'GL'|'GD'|'GP'|'GU'|'GT'|'GG'|'GN'|'GW'|'GY'|'HT'|'HM'|'VA'|'HN'|'HK'|'HU'|'IS'|'IN'|'ID'|'IR'|'IQ'|'IE'|'IM'|'IL'|'IT'|'JM'|'JP'|'JE'|'JO'|'KZ'|'KE'|'KI'|'KP'|'KR'|'KW'|'KG'|'LA'|'LV'|'LB'|'LS'|'LR'|'LY'|'LI'|'LT'|'LU'|'MO'|'MK'|'MG'|'MW'|'MY'|'MV'|'ML'|'MT'|'MH'|'MQ'|'MR'|'MU'|'YT'|'MX'|'FM'|'MD'|'MC'|'MN'|'ME'|'MS'|'MA'|'MZ'|'MM'|'NA'|'NR'|'NP'|'NL'|'NC'|'NZ'|'NI'|'NE'|'NG'|'NU'|'NF'|'MP'|'NO'|'OM'|'PK'|'PW'|'PS'|'PA'|'PG'|'PY'|'PE'|'PH'|'PN'|'PL'|'PT'|'PR'|'QA'|'RE'|'RO'|'RU'|'RW'|'BL'|'SH'|'KN'|'LC'|'MF'|'PM'|'VC'|'WS'|'SM'|'ST'|'SA'|'SN'|'RS'|'SC'|'SL'|'SG'|'SX'|'SK'|'SI'|'SB'|'SO'|'ZA'|'GS'|'SS'|'ES'|'LK'|'SD'|'SR'|'SJ'|'SZ'|'SE'|'CH'|'SY'|'TW'|'TJ'|'TZ'|'TH'|'TL'|'TG'|'TK'|'TO'|'TT'|'TN'|'TR'|'TM'|'TC'|'TV'|'UG'|'UA'|'AE'|'GB'|'US'|'UM'|'UY'|'UZ'|'VU'|'VE'|'VN'|'VG'|'VI'|'WF'|'EH'|'YE'|'ZM'|'ZW'|'XK', ], 'ForwardedIPConfig': { 'HeaderName': 'string', 'FallbackBehavior': 'MATCH'|'NO_MATCH' } }, 'RuleGroupReferenceStatement': { 'ARN': 'string', 'ExcludedRules': [ { 'Name': 'string' }, ], 'RuleActionOverrides': [ { 'Name': 'string', 'ActionToUse': { 'Block': { 'CustomResponse': { 'ResponseCode': 123, 'CustomResponseBodyKey': 'string', 'ResponseHeaders': [ { 'Name': 'string', 'Value': 'string' }, ] } }, 'Allow': { 'CustomRequestHandling': { 'InsertHeaders': [ { 'Name': 'string', 'Value': 'string' }, ] } }, 'Count': { 'CustomRequestHandling': { 'InsertHeaders': [ { 'Name': 'string', 'Value': 'string' }, ] } }, 'Captcha': { 'CustomRequestHandling': { 'InsertHeaders': [ { 'Name': 'string', 'Value': 'string' }, ] } }, 'Challenge': { 'CustomRequestHandling': { 'InsertHeaders': [ { 'Name': 'string', 'Value': 'string' }, ] } } } }, ] }, 'IPSetReferenceStatement': { 'ARN': 'string', 'IPSetForwardedIPConfig': { 'HeaderName': 'string', 'FallbackBehavior': 'MATCH'|'NO_MATCH', 'Position': 'FIRST'|'LAST'|'ANY' } }, 'RegexPatternSetReferenceStatement': { 'ARN': 'string', 'FieldToMatch': { 'SingleHeader': { 'Name': 'string' }, 'SingleQueryArgument': { 'Name': 'string' }, 'AllQueryArguments': {} , 'UriPath': {} , 'QueryString': {} , 'Body': { 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'Method': {} , 'JsonBody': { 'MatchPattern': { 'All': {} , 'IncludedPaths': [ 'string', ] }, 'MatchScope': 'ALL'|'KEY'|'VALUE', 'InvalidFallbackBehavior': 'MATCH'|'NO_MATCH'|'EVALUATE_AS_STRING', 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'Headers': { 'MatchPattern': { 'All': {} , 'IncludedHeaders': [ 'string', ], 'ExcludedHeaders': [ 'string', ] }, 'MatchScope': 'ALL'|'KEY'|'VALUE', 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'Cookies': { 'MatchPattern': { 'All': {} , 'IncludedCookies': [ 'string', ], 'ExcludedCookies': [ 'string', ] }, 'MatchScope': 'ALL'|'KEY'|'VALUE', 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'HeaderOrder': { 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'JA3Fingerprint': { 'FallbackBehavior': 'MATCH'|'NO_MATCH' }, 'JA4Fingerprint': { 'FallbackBehavior': 'MATCH'|'NO_MATCH' }, 'UriFragment': { 'FallbackBehavior': 'MATCH'|'NO_MATCH' } }, 'TextTransformations': [ { 'Priority': 123, 'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE' }, ] }, 'RateBasedStatement': { 'Limit': 123, 'EvaluationWindowSec': 123, 'AggregateKeyType': 'IP'|'FORWARDED_IP'|'CUSTOM_KEYS'|'CONSTANT', 'ScopeDownStatement': {'... recursive ...'}, 'ForwardedIPConfig': { 'HeaderName': 'string', 'FallbackBehavior': 'MATCH'|'NO_MATCH' }, 'CustomKeys': [ { 'Header': { 'Name': 'string', 'TextTransformations': [ { 'Priority': 123, 'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE' }, ] }, 'Cookie': { 'Name': 'string', 'TextTransformations': [ { 'Priority': 123, 'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE' }, ] }, 'QueryArgument': { 'Name': 'string', 'TextTransformations': [ { 'Priority': 123, 'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE' }, ] }, 'QueryString': { 'TextTransformations': [ { 'Priority': 123, 'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE' }, ] }, 'HTTPMethod': {} , 'ForwardedIP': {} , 'IP': {} , 'LabelNamespace': { 'Namespace': 'string' }, 'UriPath': { 'TextTransformations': [ { 'Priority': 123, 'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE' }, ] }, 'JA3Fingerprint': { 'FallbackBehavior': 'MATCH'|'NO_MATCH' }, 'JA4Fingerprint': { 'FallbackBehavior': 'MATCH'|'NO_MATCH' }, 'ASN': {} }, ] }, 'AndStatement': { 'Statements': [ {'... recursive ...'}, ] }, 'OrStatement': { 'Statements': [ {'... recursive ...'}, ] }, 'NotStatement': { 'Statement': {'... recursive ...'} }, 'ManagedRuleGroupStatement': { 'VendorName': 'string', 'Name': 'string', 'Version': 'string', 'ExcludedRules': [ { 'Name': 'string' }, ], 'ScopeDownStatement': {'... recursive ...'}, 'ManagedRuleGroupConfigs': [ { 'LoginPath': 'string', 'PayloadType': 'JSON'|'FORM_ENCODED', 'UsernameField': { 'Identifier': 'string' }, 'PasswordField': { 'Identifier': 'string' }, 'AWSManagedRulesBotControlRuleSet': { 'InspectionLevel': 'COMMON'|'TARGETED', 'EnableMachineLearning': True|False }, 'AWSManagedRulesATPRuleSet': { 'LoginPath': 'string', 'RequestInspection': { 'PayloadType': 'JSON'|'FORM_ENCODED', 'UsernameField': { 'Identifier': 'string' }, 'PasswordField': { 'Identifier': 'string' } }, 'ResponseInspection': { 'StatusCode': { 'SuccessCodes': [ 123, ], 'FailureCodes': [ 123, ] }, 'Header': { 'Name': 'string', 'SuccessValues': [ 'string', ], 'FailureValues': [ 'string', ] }, 'BodyContains': { 'SuccessStrings': [ 'string', ], 'FailureStrings': [ 'string', ] }, 'Json': { 'Identifier': 'string', 'SuccessValues': [ 'string', ], 'FailureValues': [ 'string', ] } }, 'EnableRegexInPath': True|False }, 'AWSManagedRulesACFPRuleSet': { 'CreationPath': 'string', 'RegistrationPagePath': 'string', 'RequestInspection': { 'PayloadType': 'JSON'|'FORM_ENCODED', 'UsernameField': { 'Identifier': 'string' }, 'PasswordField': { 'Identifier': 'string' }, 'EmailField': { 'Identifier': 'string' }, 'PhoneNumberFields': [ { 'Identifier': 'string' }, ], 'AddressFields': [ { 'Identifier': 'string' }, ] }, 'ResponseInspection': { 'StatusCode': { 'SuccessCodes': [ 123, ], 'FailureCodes': [ 123, ] }, 'Header': { 'Name': 'string', 'SuccessValues': [ 'string', ], 'FailureValues': [ 'string', ] }, 'BodyContains': { 'SuccessStrings': [ 'string', ], 'FailureStrings': [ 'string', ] }, 'Json': { 'Identifier': 'string', 'SuccessValues': [ 'string', ], 'FailureValues': [ 'string', ] } }, 'EnableRegexInPath': True|False }, 'AWSManagedRulesAntiDDoSRuleSet': { 'ClientSideActionConfig': { 'Challenge': { 'UsageOfAction': 'ENABLED'|'DISABLED', 'Sensitivity': 'LOW'|'MEDIUM'|'HIGH', 'ExemptUriRegularExpressions': [ { 'RegexString': 'string' }, ] } }, 'SensitivityToBlock': 'LOW'|'MEDIUM'|'HIGH' } }, ], 'RuleActionOverrides': [ { 'Name': 'string', 'ActionToUse': { 'Block': { 'CustomResponse': { 'ResponseCode': 123, 'CustomResponseBodyKey': 'string', 'ResponseHeaders': [ { 'Name': 'string', 'Value': 'string' }, ] } }, 'Allow': { 'CustomRequestHandling': { 'InsertHeaders': [ { 'Name': 'string', 'Value': 'string' }, ] } }, 'Count': { 'CustomRequestHandling': { 'InsertHeaders': [ { 'Name': 'string', 'Value': 'string' }, ] } }, 'Captcha': { 'CustomRequestHandling': { 'InsertHeaders': [ { 'Name': 'string', 'Value': 'string' }, ] } }, 'Challenge': { 'CustomRequestHandling': { 'InsertHeaders': [ { 'Name': 'string', 'Value': 'string' }, ] } } } }, ] }, 'LabelMatchStatement': { 'Scope': 'LABEL'|'NAMESPACE', 'Key': 'string' }, 'RegexMatchStatement': { 'RegexString': 'string', 'FieldToMatch': { 'SingleHeader': { 'Name': 'string' }, 'SingleQueryArgument': { 'Name': 'string' }, 'AllQueryArguments': {} , 'UriPath': {} , 'QueryString': {} , 'Body': { 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'Method': {} , 'JsonBody': { 'MatchPattern': { 'All': {} , 'IncludedPaths': [ 'string', ] }, 'MatchScope': 'ALL'|'KEY'|'VALUE', 'InvalidFallbackBehavior': 'MATCH'|'NO_MATCH'|'EVALUATE_AS_STRING', 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'Headers': { 'MatchPattern': { 'All': {} , 'IncludedHeaders': [ 'string', ], 'ExcludedHeaders': [ 'string', ] }, 'MatchScope': 'ALL'|'KEY'|'VALUE', 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'Cookies': { 'MatchPattern': { 'All': {} , 'IncludedCookies': [ 'string', ], 'ExcludedCookies': [ 'string', ] }, 'MatchScope': 'ALL'|'KEY'|'VALUE', 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'HeaderOrder': { 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'JA3Fingerprint': { 'FallbackBehavior': 'MATCH'|'NO_MATCH' }, 'JA4Fingerprint': { 'FallbackBehavior': 'MATCH'|'NO_MATCH' }, 'UriFragment': { 'FallbackBehavior': 'MATCH'|'NO_MATCH' } }, 'TextTransformations': [ { 'Priority': 123, 'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE' }, ] }, 'AsnMatchStatement': { 'AsnList': [ 123, ], 'ForwardedIPConfig': { 'HeaderName': 'string', 'FallbackBehavior': 'MATCH'|'NO_MATCH' } } }, 'Action': { 'Block': { 'CustomResponse': { 'ResponseCode': 123, 'CustomResponseBodyKey': 'string', 'ResponseHeaders': [ { 'Name': 'string', 'Value': 'string' }, ] } }, 'Allow': { 'CustomRequestHandling': { 'InsertHeaders': [ { 'Name': 'string', 'Value': 'string' }, ] } }, 'Count': { 'CustomRequestHandling': { 'InsertHeaders': [ { 'Name': 'string', 'Value': 'string' }, ] } }, 'Captcha': { 'CustomRequestHandling': { 'InsertHeaders': [ { 'Name': 'string', 'Value': 'string' }, ] } }, 'Challenge': { 'CustomRequestHandling': { 'InsertHeaders': [ { 'Name': 'string', 'Value': 'string' }, ] } } }, 'OverrideAction': { 'Count': { 'CustomRequestHandling': { 'InsertHeaders': [ { 'Name': 'string', 'Value': 'string' }, ] } }, 'None': {} }, 'RuleLabels': [ { 'Name': 'string' }, ], 'VisibilityConfig': { 'SampledRequestsEnabled': True|False, 'CloudWatchMetricsEnabled': True|False, 'MetricName': 'string' }, 'CaptchaConfig': { 'ImmunityTimeProperty': { 'ImmunityTime': 123 } }, 'ChallengeConfig': { 'ImmunityTimeProperty': { 'ImmunityTime': 123 } } }, ] ) **Parameters** :: # This section is too large to render. # Please see the AWS API Documentation linked below. `AWS API Documentation `_ Return type: dict Returns: **Response Syntax** { 'Capacity': 123 } **Response Structure** * *(dict) --* * **Capacity** *(integer) --* The capacity required by the rules and scope. **Exceptions** * "WAFV2.Client.exceptions.WAFInternalErrorException" * "WAFV2.Client.exceptions.WAFInvalidParameterException" * "WAFV2.Client.exceptions.WAFNonexistentItemException" * "WAFV2.Client.exceptions.WAFLimitsExceededException" * "WAFV2.Client.exceptions.WAFInvalidResourceException" * "WAFV2.Client.exceptions.WAFUnavailableEntityException" * "WAFV2.Client.exceptions.WAFSubscriptionNotFoundException" * "WAFV2.Client.exceptions.WAFExpiredManagedRuleGroupVersionExcept ion" * "WAFV2.Client.exceptions.WAFInvalidOperationException" WAFV2 / Client / put_logging_configuration put_logging_configuration ************************* WAFV2.Client.put_logging_configuration(**kwargs) Enables the specified LoggingConfiguration, to start logging from a web ACL, according to the configuration provided. If you configure data protection for the web ACL, the protection applies to the data that WAF sends to the logs. Note: 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 Note: 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 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 in the *WAF Developer Guide*. See also: AWS API Documentation **Request Syntax** response = client.put_logging_configuration( LoggingConfiguration={ 'ResourceArn': 'string', 'LogDestinationConfigs': [ 'string', ], 'RedactedFields': [ { 'SingleHeader': { 'Name': 'string' }, 'SingleQueryArgument': { 'Name': 'string' }, 'AllQueryArguments': {} , 'UriPath': {} , 'QueryString': {} , 'Body': { 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'Method': {} , 'JsonBody': { 'MatchPattern': { 'All': {} , 'IncludedPaths': [ 'string', ] }, 'MatchScope': 'ALL'|'KEY'|'VALUE', 'InvalidFallbackBehavior': 'MATCH'|'NO_MATCH'|'EVALUATE_AS_STRING', 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'Headers': { 'MatchPattern': { 'All': {} , 'IncludedHeaders': [ 'string', ], 'ExcludedHeaders': [ 'string', ] }, 'MatchScope': 'ALL'|'KEY'|'VALUE', 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'Cookies': { 'MatchPattern': { 'All': {} , 'IncludedCookies': [ 'string', ], 'ExcludedCookies': [ 'string', ] }, 'MatchScope': 'ALL'|'KEY'|'VALUE', 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'HeaderOrder': { 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'JA3Fingerprint': { 'FallbackBehavior': 'MATCH'|'NO_MATCH' }, 'JA4Fingerprint': { 'FallbackBehavior': 'MATCH'|'NO_MATCH' }, 'UriFragment': { 'FallbackBehavior': 'MATCH'|'NO_MATCH' } }, ], 'ManagedByFirewallManager': True|False, 'LoggingFilter': { 'Filters': [ { 'Behavior': 'KEEP'|'DROP', 'Requirement': 'MEETS_ALL'|'MEETS_ANY', 'Conditions': [ { 'ActionCondition': { 'Action': 'ALLOW'|'BLOCK'|'COUNT'|'CAPTCHA'|'CHALLENGE'|'EXCLUDED_AS_COUNT' }, 'LabelNameCondition': { 'LabelName': 'string' } }, ] }, ], 'DefaultBehavior': 'KEEP'|'DROP' }, 'LogType': 'WAF_LOGS', 'LogScope': 'CUSTOMER'|'SECURITY_LAKE' } ) Parameters: **LoggingConfiguration** (*dict*) -- **[REQUIRED]** * **ResourceArn** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) of the web ACL that you want to associate with "LogDestinationConfigs". * **LogDestinationConfigs** *(list) --* **[REQUIRED]** The logging destination configuration that you want to associate with the web ACL. Note: You can associate one logging destination to a web ACL. * *(string) --* * **RedactedFields** *(list) --* The parts of the request that you want to keep out of the logs. For example, if you redact the "SingleHeader" field, the "HEADER" field in the logs will be "REDACTED" for all rules that use the "SingleHeader" "FieldToMatch" setting. If you configure data protection for the web ACL, the protection applies to the data that WAF sends to the logs. Redaction applies only to the component that's specified in the rule's "FieldToMatch" setting, so the "SingleHeader" redaction doesn't apply to rules that use the "Headers" "FieldToMatch". Note: You can specify only the following fields for redaction: "UriPath", "QueryString", "SingleHeader", and "Method". Note: This setting has no impact on request sampling. You can only exclude fields from request sampling by disabling sampling in the web ACL visibility configuration or by configuring data protection for the web ACL. * *(dict) --* Specifies a web request component to be used in a rule match statement or in a logging configuration. * In a rule statement, this is the part of the web request that you want WAF to inspect. Include the single "FieldToMatch" type that you want to inspect, with additional specifications as needed, according to the type. You specify a single request component in "FieldToMatch" for each rule statement that requires it. To inspect more than one component of the web request, create a separate rule statement for each component. Example JSON for a "QueryString" field to match: ""FieldToMatch": { "QueryString": {} }" Example JSON for a "Method" field to match specification: ""FieldToMatch": { "Method": { "Name": "DELETE" } }" * In a logging configuration, this is used in the "RedactedFields" property to specify a field to redact from the logging records. For this use case, note the following: * Even though all "FieldToMatch" settings are available, the only valid settings for field redaction are "UriPath", "QueryString", "SingleHeader", and "Method". * In this documentation, the descriptions of the individual fields talk about specifying the web request component to inspect, but for field redaction, you are specifying the component type to redact from the logs. * If you have request sampling enabled, the redacted fields configuration for logging has no impact on sampling. You can only exclude fields from request sampling by disabling sampling in the web ACL visibility configuration or by configuring data protection for the web ACL. * **SingleHeader** *(dict) --* Inspect a single header. Provide the name of the header to inspect, for example, "User-Agent" or "Referer". This setting isn't case sensitive. Example JSON: ""SingleHeader": { "Name": "haystack" }" Alternately, you can filter and inspect all headers with the "Headers" "FieldToMatch" setting. * **Name** *(string) --* **[REQUIRED]** The name of the query header to inspect. * **SingleQueryArgument** *(dict) --* Inspect a single query argument. Provide the name of the query argument to inspect, such as *UserName* or *SalesRegion*. The name can be up to 30 characters long and isn't case sensitive. Example JSON: ""SingleQueryArgument": { "Name": "myArgument" }" * **Name** *(string) --* **[REQUIRED]** The name of the query argument to inspect. * **AllQueryArguments** *(dict) --* Inspect all query arguments. * **UriPath** *(dict) --* Inspect the request URI path. This is the part of the web request that identifies a resource, for example, "/images /daily-ad.jpg". * **QueryString** *(dict) --* Inspect the query string. This is the part of a URL that appears after a "?" character, if any. * **Body** *(dict) --* Inspect the request body as plain text. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form. WAF does not support inspecting the entire contents of the web request body if the body exceeds the limit for the resource type. When a web request body is larger than the limit, the underlying host service only forwards the contents that are within the limit to WAF for inspection. * For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes). * For CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access, the default limit is 16 KB (16,384 bytes), and you can increase the limit for each resource type in the web ACL "AssociationConfig", for additional processing fees. * For Amplify, use the CloudFront limit. For information about how to handle oversized request bodies, see the "Body" object configuration. * **OversizeHandling** *(string) --* What WAF should do if the body is larger than WAF can inspect. WAF does not support inspecting the entire contents of the web request body if the body exceeds the limit for the resource type. When a web request body is larger than the limit, the underlying host service only forwards the contents that are within the limit to WAF for inspection. * For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes). * For CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access, the default limit is 16 KB (16,384 bytes), and you can increase the limit for each resource type in the web ACL "AssociationConfig", for additional processing fees. * For Amplify, use the CloudFront limit. The options for oversize handling are the following: * "CONTINUE" - Inspect the available body contents normally, according to the rule inspection criteria. * "MATCH" - Treat the web request as matching the rule statement. WAF applies the rule action to the request. * "NO_MATCH" - Treat the web request as not matching the rule statement. You can combine the "MATCH" or "NO_MATCH" settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over the limit. Default: "CONTINUE" * **Method** *(dict) --* Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform. * **JsonBody** *(dict) --* Inspect the request body as JSON. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form. WAF does not support inspecting the entire contents of the web request body if the body exceeds the limit for the resource type. When a web request body is larger than the limit, the underlying host service only forwards the contents that are within the limit to WAF for inspection. * For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes). * For CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access, the default limit is 16 KB (16,384 bytes), and you can increase the limit for each resource type in the web ACL "AssociationConfig", for additional processing fees. * For Amplify, use the CloudFront limit. For information about how to handle oversized request bodies, see the "JsonBody" object configuration. * **MatchPattern** *(dict) --* **[REQUIRED]** The patterns to look for in the JSON body. WAF inspects the results of these pattern matches against the rule inspection criteria. * **All** *(dict) --* Match all of the elements. See also "MatchScope" in JsonBody. You must specify either this setting or the "IncludedPaths" setting, but not both. * **IncludedPaths** *(list) --* Match only the specified include paths. See also "MatchScope" in JsonBody. Provide the include paths using JSON Pointer syntax. For example, ""IncludedPaths": ["/dogs/0/name", "/dogs/1/name"]". For information about this syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer. You must specify either this setting or the "All" setting, but not both. Note: Don't use this option to include all paths. Instead, use the "All" setting. * *(string) --* * **MatchScope** *(string) --* **[REQUIRED]** The parts of the JSON to match against using the "MatchPattern". If you specify "ALL", WAF matches against keys and values. "All" does not require a match to be found in the keys and a match to be found in the values. It requires a match to be found in the keys or the values or both. To require a match in the keys and in the values, use a logical "AND" statement to combine two match rules, one that inspects the keys and another that inspects the values. * **InvalidFallbackBehavior** *(string) --* What WAF should do if it fails to completely parse the JSON body. The options are the following: * "EVALUATE_AS_STRING" - Inspect the body as plain text. WAF applies the text transformations and inspection criteria that you defined for the JSON inspection to the body text string. * "MATCH" - Treat the web request as matching the rule statement. WAF applies the rule action to the request. * "NO_MATCH" - Treat the web request as not matching the rule statement. If you don't provide this setting, WAF parses and evaluates the content only up to the first parsing failure that it encounters. Note: WAF parsing doesn't fully validate the input JSON string, so parsing can succeed even for invalid JSON. When parsing succeeds, WAF doesn't apply the fallback behavior. For more information, see JSON body in the *WAF Developer Guide*. * **OversizeHandling** *(string) --* What WAF should do if the body is larger than WAF can inspect. WAF does not support inspecting the entire contents of the web request body if the body exceeds the limit for the resource type. When a web request body is larger than the limit, the underlying host service only forwards the contents that are within the limit to WAF for inspection. * For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes). * For CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access, the default limit is 16 KB (16,384 bytes), and you can increase the limit for each resource type in the web ACL "AssociationConfig", for additional processing fees. * For Amplify, use the CloudFront limit. The options for oversize handling are the following: * "CONTINUE" - Inspect the available body contents normally, according to the rule inspection criteria. * "MATCH" - Treat the web request as matching the rule statement. WAF applies the rule action to the request. * "NO_MATCH" - Treat the web request as not matching the rule statement. You can combine the "MATCH" or "NO_MATCH" settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over the limit. Default: "CONTINUE" * **Headers** *(dict) --* Inspect the request headers. You must configure scope and pattern matching filters in the "Headers" object, to define the set of headers to and the parts of the headers that WAF inspects. Only the first 8 KB (8192 bytes) of a request's headers and only the first 200 headers are forwarded to WAF for inspection by the underlying host service. You must configure how to handle any oversize header content in the "Headers" object. WAF applies the pattern matching filters to the headers that it receives from the underlying host service. * **MatchPattern** *(dict) --* **[REQUIRED]** The filter to use to identify the subset of headers to inspect in a web request. You must specify exactly one setting: either "All", "IncludedHeaders", or "ExcludedHeaders". Example JSON: ""MatchPattern": { "ExcludedHeaders": [ "KeyToExclude1", "KeyToExclude2" ] }" * **All** *(dict) --* Inspect all headers. * **IncludedHeaders** *(list) --* Inspect only the headers that have a key that matches one of the strings specified here. * *(string) --* * **ExcludedHeaders** *(list) --* Inspect only the headers whose keys don't match any of the strings specified here. * *(string) --* * **MatchScope** *(string) --* **[REQUIRED]** The parts of the headers to match with the rule inspection criteria. If you specify "ALL", WAF inspects both keys and values. "All" does not require a match to be found in the keys and a match to be found in the values. It requires a match to be found in the keys or the values or both. To require a match in the keys and in the values, use a logical "AND" statement to combine two match rules, one that inspects the keys and another that inspects the values. * **OversizeHandling** *(string) --* **[REQUIRED]** What WAF should do if the headers determined by your match scope are more numerous or larger than WAF can inspect. WAF does not support inspecting the entire contents of request headers when they exceed 8 KB (8192 bytes) or 200 total headers. The underlying host service forwards a maximum of 200 headers and at most 8 KB of header contents to WAF. The options for oversize handling are the following: * "CONTINUE" - Inspect the available headers normally, according to the rule inspection criteria. * "MATCH" - Treat the web request as matching the rule statement. WAF applies the rule action to the request. * "NO_MATCH" - Treat the web request as not matching the rule statement. * **Cookies** *(dict) --* Inspect the request cookies. You must configure scope and pattern matching filters in the "Cookies" object, to define the set of cookies and the parts of the cookies that WAF inspects. Only the first 8 KB (8192 bytes) of a request's cookies and only the first 200 cookies are forwarded to WAF for inspection by the underlying host service. You must configure how to handle any oversize cookie content in the "Cookies" object. WAF applies the pattern matching filters to the cookies that it receives from the underlying host service. * **MatchPattern** *(dict) --* **[REQUIRED]** The filter to use to identify the subset of cookies to inspect in a web request. You must specify exactly one setting: either "All", "IncludedCookies", or "ExcludedCookies". Example JSON: ""MatchPattern": { "IncludedCookies": [ "session-id-time", "session-id" ] }" * **All** *(dict) --* Inspect all cookies. * **IncludedCookies** *(list) --* Inspect only the cookies that have a key that matches one of the strings specified here. * *(string) --* * **ExcludedCookies** *(list) --* Inspect only the cookies whose keys don't match any of the strings specified here. * *(string) --* * **MatchScope** *(string) --* **[REQUIRED]** The parts of the cookies to inspect with the rule inspection criteria. If you specify "ALL", WAF inspects both keys and values. "All" does not require a match to be found in the keys and a match to be found in the values. It requires a match to be found in the keys or the values or both. To require a match in the keys and in the values, use a logical "AND" statement to combine two match rules, one that inspects the keys and another that inspects the values. * **OversizeHandling** *(string) --* **[REQUIRED]** What WAF should do if the cookies of the request are more numerous or larger than WAF can inspect. WAF does not support inspecting the entire contents of request cookies when they exceed 8 KB (8192 bytes) or 200 total cookies. The underlying host service forwards a maximum of 200 cookies and at most 8 KB of cookie contents to WAF. The options for oversize handling are the following: * "CONTINUE" - Inspect the available cookies normally, according to the rule inspection criteria. * "MATCH" - Treat the web request as matching the rule statement. WAF applies the rule action to the request. * "NO_MATCH" - Treat the web request as not matching the rule statement. * **HeaderOrder** *(dict) --* Inspect a string containing the list of the request's header names, ordered as they appear in the web request that WAF receives for inspection. WAF generates the string and then uses that as the field to match component in its inspection. WAF separates the header names in the string using colons and no added spaces, for example "host:user- agent:accept:authorization:referer". * **OversizeHandling** *(string) --* **[REQUIRED]** What WAF should do if the headers determined by your match scope are more numerous or larger than WAF can inspect. WAF does not support inspecting the entire contents of request headers when they exceed 8 KB (8192 bytes) or 200 total headers. The underlying host service forwards a maximum of 200 headers and at most 8 KB of header contents to WAF. The options for oversize handling are the following: * "CONTINUE" - Inspect the available headers normally, according to the rule inspection criteria. * "MATCH" - Treat the web request as matching the rule statement. WAF applies the rule action to the request. * "NO_MATCH" - Treat the web request as not matching the rule statement. * **JA3Fingerprint** *(dict) --* Available for use with Amazon CloudFront distributions and Application Load Balancers. Match against the request's JA3 fingerprint. The JA3 fingerprint is a 32-character hash derived from the TLS Client Hello of an incoming request. This fingerprint serves as a unique identifier for the client's TLS configuration. WAF calculates and logs this fingerprint for each request that has enough TLS Client Hello information for the calculation. Almost all web requests include this information. Note: You can use this choice only with a string match "ByteMatchStatement" with the "PositionalConstraint" set to "EXACTLY". You can obtain the JA3 fingerprint for client requests from the web ACL logs. If WAF is able to calculate the fingerprint, it includes it in the logs. For information about the logging fields, see Log fields in the *WAF Developer Guide*. Provide the JA3 fingerprint string from the logs in your string match statement specification, to match with any future requests that have the same TLS configuration. * **FallbackBehavior** *(string) --* **[REQUIRED]** The match status to assign to the web request if the request doesn't have a JA3 fingerprint. You can specify the following fallback behaviors: * "MATCH" - Treat the web request as matching the rule statement. WAF applies the rule action to the request. * "NO_MATCH" - Treat the web request as not matching the rule statement. * **JA4Fingerprint** *(dict) --* Available for use with Amazon CloudFront distributions and Application Load Balancers. Match against the request's JA4 fingerprint. The JA4 fingerprint is a 36-character hash derived from the TLS Client Hello of an incoming request. This fingerprint serves as a unique identifier for the client's TLS configuration. WAF calculates and logs this fingerprint for each request that has enough TLS Client Hello information for the calculation. Almost all web requests include this information. Note: You can use this choice only with a string match "ByteMatchStatement" with the "PositionalConstraint" set to "EXACTLY". You can obtain the JA4 fingerprint for client requests from the web ACL logs. If WAF is able to calculate the fingerprint, it includes it in the logs. For information about the logging fields, see Log fields in the *WAF Developer Guide*. Provide the JA4 fingerprint string from the logs in your string match statement specification, to match with any future requests that have the same TLS configuration. * **FallbackBehavior** *(string) --* **[REQUIRED]** The match status to assign to the web request if the request doesn't have a JA4 fingerprint. You can specify the following fallback behaviors: * "MATCH" - Treat the web request as matching the rule statement. WAF applies the rule action to the request. * "NO_MATCH" - Treat the web request as not matching the rule statement. * **UriFragment** *(dict) --* Inspect fragments of the request URI. You must configure scope and pattern matching filters in the "UriFragment" object, to define the fragment of a URI that WAF inspects. Only the first 8 KB (8192 bytes) of a request's URI fragments and only the first 200 URI fragments are forwarded to WAF for inspection by the underlying host service. You must configure how to handle any oversize URI fragment content in the "UriFragment" object. WAF applies the pattern matching filters to the cookies that it receives from the underlying host service. * **FallbackBehavior** *(string) --* What WAF should do if it fails to completely parse the JSON body. The options are the following: * "EVALUATE_AS_STRING" - Inspect the body as plain text. WAF applies the text transformations and inspection criteria that you defined for the JSON inspection to the body text string. * "MATCH" - Treat the web request as matching the rule statement. WAF applies the rule action to the request. * "NO_MATCH" - Treat the web request as not matching the rule statement. If you don't provide this setting, WAF parses and evaluates the content only up to the first parsing failure that it encounters. Example JSON: "{ "UriFragment": { "FallbackBehavior": "MATCH"} }" Note: WAF parsing doesn't fully validate the input JSON string, so parsing can succeed even for invalid JSON. When parsing succeeds, WAF doesn't apply the fallback behavior. For more information, see JSON body in the *WAF Developer Guide*. * **ManagedByFirewallManager** *(boolean) --* Indicates whether the logging configuration was created by Firewall Manager, as part of an WAF policy configuration. If true, only Firewall Manager can modify or delete the configuration. The logging configuration can be created by Firewall Manager for use with any web ACL that Firewall Manager is using for an WAF policy. Web ACLs that Firewall Manager creates and uses have their "ManagedByFirewallManager" property set to true. Web ACLs that were created by a customer account and then retrofitted by Firewall Manager for use by a policy have their "RetrofittedByFirewallManager" property set to true. For either case, any corresponding logging configuration will indicate "ManagedByFirewallManager". * **LoggingFilter** *(dict) --* Filtering that specifies which web requests are kept in the logs and which are dropped. You can filter on the rule action and on the web request labels that were applied by matching rules during web ACL evaluation. * **Filters** *(list) --* **[REQUIRED]** The filters that you want to apply to the logs. * *(dict) --* A single logging filter, used in LoggingFilter. * **Behavior** *(string) --* **[REQUIRED]** How to handle logs that satisfy the filter's conditions and requirement. * **Requirement** *(string) --* **[REQUIRED]** Logic to apply to the filtering conditions. You can specify that, in order to satisfy the filter, a log must match all conditions or must match at least one condition. * **Conditions** *(list) --* **[REQUIRED]** Match conditions for the filter. * *(dict) --* A single match condition for a Filter. * **ActionCondition** *(dict) --* A single action condition. This is the action setting that a log record must contain in order to meet the condition. * **Action** *(string) --* **[REQUIRED]** The action setting that a log record must contain in order to meet the condition. This is the action that WAF applied to the web request. For rule groups, this is either the configured rule action setting, or if you've applied a rule action override to the rule, it's the override action. The value "EXCLUDED_AS_COUNT" matches on excluded rules and also on rules that have a rule action override of Count. * **LabelNameCondition** *(dict) --* A single label name condition. This is the fully qualified label name that a log record must contain in order to meet the condition. Fully qualified labels have a prefix, optional namespaces, and label name. The prefix identifies the rule group or web ACL context of the rule that added the label. * **LabelName** *(string) --* **[REQUIRED]** The label name that a log record must contain in order to meet the condition. This must be a fully qualified label name. Fully qualified labels have a prefix, optional namespaces, and label name. The prefix identifies the rule group or web ACL context of the rule that added the label. * **DefaultBehavior** *(string) --* **[REQUIRED]** Default handling for logs that don't match any of the specified filtering conditions. * **LogType** *(string) --* Used to distinguish between various logging options. Currently, there is one option. Default: "WAF_LOGS" * **LogScope** *(string) --* The owner of the logging configuration, which must be set to "CUSTOMER" for the configurations that you manage. The log scope "SECURITY_LAKE" indicates a configuration that is managed through Amazon Security Lake. You can use Security Lake to collect log and event data from various sources for normalization, analysis, and management. For information, see Collecting data from Amazon Web Services services in the *Amazon Security Lake user guide*. Default: "CUSTOMER" Return type: dict Returns: **Response Syntax** { 'LoggingConfiguration': { 'ResourceArn': 'string', 'LogDestinationConfigs': [ 'string', ], 'RedactedFields': [ { 'SingleHeader': { 'Name': 'string' }, 'SingleQueryArgument': { 'Name': 'string' }, 'AllQueryArguments': {}, 'UriPath': {}, 'QueryString': {}, 'Body': { 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'Method': {}, 'JsonBody': { 'MatchPattern': { 'All': {}, 'IncludedPaths': [ 'string', ] }, 'MatchScope': 'ALL'|'KEY'|'VALUE', 'InvalidFallbackBehavior': 'MATCH'|'NO_MATCH'|'EVALUATE_AS_STRING', 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'Headers': { 'MatchPattern': { 'All': {}, 'IncludedHeaders': [ 'string', ], 'ExcludedHeaders': [ 'string', ] }, 'MatchScope': 'ALL'|'KEY'|'VALUE', 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'Cookies': { 'MatchPattern': { 'All': {}, 'IncludedCookies': [ 'string', ], 'ExcludedCookies': [ 'string', ] }, 'MatchScope': 'ALL'|'KEY'|'VALUE', 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'HeaderOrder': { 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'JA3Fingerprint': { 'FallbackBehavior': 'MATCH'|'NO_MATCH' }, 'JA4Fingerprint': { 'FallbackBehavior': 'MATCH'|'NO_MATCH' }, 'UriFragment': { 'FallbackBehavior': 'MATCH'|'NO_MATCH' } }, ], 'ManagedByFirewallManager': True|False, 'LoggingFilter': { 'Filters': [ { 'Behavior': 'KEEP'|'DROP', 'Requirement': 'MEETS_ALL'|'MEETS_ANY', 'Conditions': [ { 'ActionCondition': { 'Action': 'ALLOW'|'BLOCK'|'COUNT'|'CAPTCHA'|'CHALLENGE'|'EXCLUDED_AS_COUNT' }, 'LabelNameCondition': { 'LabelName': 'string' } }, ] }, ], 'DefaultBehavior': 'KEEP'|'DROP' }, 'LogType': 'WAF_LOGS', 'LogScope': 'CUSTOMER'|'SECURITY_LAKE' } } **Response Structure** * *(dict) --* * **LoggingConfiguration** *(dict) --* * **ResourceArn** *(string) --* The Amazon Resource Name (ARN) of the web ACL that you want to associate with "LogDestinationConfigs". * **LogDestinationConfigs** *(list) --* The logging destination configuration that you want to associate with the web ACL. Note: You can associate one logging destination to a web ACL. * *(string) --* * **RedactedFields** *(list) --* The parts of the request that you want to keep out of the logs. For example, if you redact the "SingleHeader" field, the "HEADER" field in the logs will be "REDACTED" for all rules that use the "SingleHeader" "FieldToMatch" setting. If you configure data protection for the web ACL, the protection applies to the data that WAF sends to the logs. Redaction applies only to the component that's specified in the rule's "FieldToMatch" setting, so the "SingleHeader" redaction doesn't apply to rules that use the "Headers" "FieldToMatch". Note: You can specify only the following fields for redaction: "UriPath", "QueryString", "SingleHeader", and "Method". Note: This setting has no impact on request sampling. You can only exclude fields from request sampling by disabling sampling in the web ACL visibility configuration or by configuring data protection for the web ACL. * *(dict) --* Specifies a web request component to be used in a rule match statement or in a logging configuration. * In a rule statement, this is the part of the web request that you want WAF to inspect. Include the single "FieldToMatch" type that you want to inspect, with additional specifications as needed, according to the type. You specify a single request component in "FieldToMatch" for each rule statement that requires it. To inspect more than one component of the web request, create a separate rule statement for each component. Example JSON for a "QueryString" field to match: ""FieldToMatch": { "QueryString": {} }" Example JSON for a "Method" field to match specification: ""FieldToMatch": { "Method": { "Name": "DELETE" } }" * In a logging configuration, this is used in the "RedactedFields" property to specify a field to redact from the logging records. For this use case, note the following: * Even though all "FieldToMatch" settings are available, the only valid settings for field redaction are "UriPath", "QueryString", "SingleHeader", and "Method". * In this documentation, the descriptions of the individual fields talk about specifying the web request component to inspect, but for field redaction, you are specifying the component type to redact from the logs. * If you have request sampling enabled, the redacted fields configuration for logging has no impact on sampling. You can only exclude fields from request sampling by disabling sampling in the web ACL visibility configuration or by configuring data protection for the web ACL. * **SingleHeader** *(dict) --* Inspect a single header. Provide the name of the header to inspect, for example, "User-Agent" or "Referer". This setting isn't case sensitive. Example JSON: ""SingleHeader": { "Name": "haystack" }" Alternately, you can filter and inspect all headers with the "Headers" "FieldToMatch" setting. * **Name** *(string) --* The name of the query header to inspect. * **SingleQueryArgument** *(dict) --* Inspect a single query argument. Provide the name of the query argument to inspect, such as *UserName* or *SalesRegion*. The name can be up to 30 characters long and isn't case sensitive. Example JSON: ""SingleQueryArgument": { "Name": "myArgument" }" * **Name** *(string) --* The name of the query argument to inspect. * **AllQueryArguments** *(dict) --* Inspect all query arguments. * **UriPath** *(dict) --* Inspect the request URI path. This is the part of the web request that identifies a resource, for example, "/images/daily-ad.jpg". * **QueryString** *(dict) --* Inspect the query string. This is the part of a URL that appears after a "?" character, if any. * **Body** *(dict) --* Inspect the request body as plain text. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form. WAF does not support inspecting the entire contents of the web request body if the body exceeds the limit for the resource type. When a web request body is larger than the limit, the underlying host service only forwards the contents that are within the limit to WAF for inspection. * For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes). * For CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access, the default limit is 16 KB (16,384 bytes), and you can increase the limit for each resource type in the web ACL "AssociationConfig", for additional processing fees. * For Amplify, use the CloudFront limit. For information about how to handle oversized request bodies, see the "Body" object configuration. * **OversizeHandling** *(string) --* What WAF should do if the body is larger than WAF can inspect. WAF does not support inspecting the entire contents of the web request body if the body exceeds the limit for the resource type. When a web request body is larger than the limit, the underlying host service only forwards the contents that are within the limit to WAF for inspection. * For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes). * For CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access, the default limit is 16 KB (16,384 bytes), and you can increase the limit for each resource type in the web ACL "AssociationConfig", for additional processing fees. * For Amplify, use the CloudFront limit. The options for oversize handling are the following: * "CONTINUE" - Inspect the available body contents normally, according to the rule inspection criteria. * "MATCH" - Treat the web request as matching the rule statement. WAF applies the rule action to the request. * "NO_MATCH" - Treat the web request as not matching the rule statement. You can combine the "MATCH" or "NO_MATCH" settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over the limit. Default: "CONTINUE" * **Method** *(dict) --* Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform. * **JsonBody** *(dict) --* Inspect the request body as JSON. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form. WAF does not support inspecting the entire contents of the web request body if the body exceeds the limit for the resource type. When a web request body is larger than the limit, the underlying host service only forwards the contents that are within the limit to WAF for inspection. * For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes). * For CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access, the default limit is 16 KB (16,384 bytes), and you can increase the limit for each resource type in the web ACL "AssociationConfig", for additional processing fees. * For Amplify, use the CloudFront limit. For information about how to handle oversized request bodies, see the "JsonBody" object configuration. * **MatchPattern** *(dict) --* The patterns to look for in the JSON body. WAF inspects the results of these pattern matches against the rule inspection criteria. * **All** *(dict) --* Match all of the elements. See also "MatchScope" in JsonBody. You must specify either this setting or the "IncludedPaths" setting, but not both. * **IncludedPaths** *(list) --* Match only the specified include paths. See also "MatchScope" in JsonBody. Provide the include paths using JSON Pointer syntax. For example, ""IncludedPaths": ["/dogs/0/name", "/dogs/1/name"]". For information about this syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer. You must specify either this setting or the "All" setting, but not both. Note: Don't use this option to include all paths. Instead, use the "All" setting. * *(string) --* * **MatchScope** *(string) --* The parts of the JSON to match against using the "MatchPattern". If you specify "ALL", WAF matches against keys and values. "All" does not require a match to be found in the keys and a match to be found in the values. It requires a match to be found in the keys or the values or both. To require a match in the keys and in the values, use a logical "AND" statement to combine two match rules, one that inspects the keys and another that inspects the values. * **InvalidFallbackBehavior** *(string) --* What WAF should do if it fails to completely parse the JSON body. The options are the following: * "EVALUATE_AS_STRING" - Inspect the body as plain text. WAF applies the text transformations and inspection criteria that you defined for the JSON inspection to the body text string. * "MATCH" - Treat the web request as matching the rule statement. WAF applies the rule action to the request. * "NO_MATCH" - Treat the web request as not matching the rule statement. If you don't provide this setting, WAF parses and evaluates the content only up to the first parsing failure that it encounters. Note: WAF parsing doesn't fully validate the input JSON string, so parsing can succeed even for invalid JSON. When parsing succeeds, WAF doesn't apply the fallback behavior. For more information, see JSON body in the *WAF Developer Guide*. * **OversizeHandling** *(string) --* What WAF should do if the body is larger than WAF can inspect. WAF does not support inspecting the entire contents of the web request body if the body exceeds the limit for the resource type. When a web request body is larger than the limit, the underlying host service only forwards the contents that are within the limit to WAF for inspection. * For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes). * For CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access, the default limit is 16 KB (16,384 bytes), and you can increase the limit for each resource type in the web ACL "AssociationConfig", for additional processing fees. * For Amplify, use the CloudFront limit. The options for oversize handling are the following: * "CONTINUE" - Inspect the available body contents normally, according to the rule inspection criteria. * "MATCH" - Treat the web request as matching the rule statement. WAF applies the rule action to the request. * "NO_MATCH" - Treat the web request as not matching the rule statement. You can combine the "MATCH" or "NO_MATCH" settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over the limit. Default: "CONTINUE" * **Headers** *(dict) --* Inspect the request headers. You must configure scope and pattern matching filters in the "Headers" object, to define the set of headers to and the parts of the headers that WAF inspects. Only the first 8 KB (8192 bytes) of a request's headers and only the first 200 headers are forwarded to WAF for inspection by the underlying host service. You must configure how to handle any oversize header content in the "Headers" object. WAF applies the pattern matching filters to the headers that it receives from the underlying host service. * **MatchPattern** *(dict) --* The filter to use to identify the subset of headers to inspect in a web request. You must specify exactly one setting: either "All", "IncludedHeaders", or "ExcludedHeaders". Example JSON: ""MatchPattern": { "ExcludedHeaders": [ "KeyToExclude1", "KeyToExclude2" ] }" * **All** *(dict) --* Inspect all headers. * **IncludedHeaders** *(list) --* Inspect only the headers that have a key that matches one of the strings specified here. * *(string) --* * **ExcludedHeaders** *(list) --* Inspect only the headers whose keys don't match any of the strings specified here. * *(string) --* * **MatchScope** *(string) --* The parts of the headers to match with the rule inspection criteria. If you specify "ALL", WAF inspects both keys and values. "All" does not require a match to be found in the keys and a match to be found in the values. It requires a match to be found in the keys or the values or both. To require a match in the keys and in the values, use a logical "AND" statement to combine two match rules, one that inspects the keys and another that inspects the values. * **OversizeHandling** *(string) --* What WAF should do if the headers determined by your match scope are more numerous or larger than WAF can inspect. WAF does not support inspecting the entire contents of request headers when they exceed 8 KB (8192 bytes) or 200 total headers. The underlying host service forwards a maximum of 200 headers and at most 8 KB of header contents to WAF. The options for oversize handling are the following: * "CONTINUE" - Inspect the available headers normally, according to the rule inspection criteria. * "MATCH" - Treat the web request as matching the rule statement. WAF applies the rule action to the request. * "NO_MATCH" - Treat the web request as not matching the rule statement. * **Cookies** *(dict) --* Inspect the request cookies. You must configure scope and pattern matching filters in the "Cookies" object, to define the set of cookies and the parts of the cookies that WAF inspects. Only the first 8 KB (8192 bytes) of a request's cookies and only the first 200 cookies are forwarded to WAF for inspection by the underlying host service. You must configure how to handle any oversize cookie content in the "Cookies" object. WAF applies the pattern matching filters to the cookies that it receives from the underlying host service. * **MatchPattern** *(dict) --* The filter to use to identify the subset of cookies to inspect in a web request. You must specify exactly one setting: either "All", "IncludedCookies", or "ExcludedCookies". Example JSON: ""MatchPattern": { "IncludedCookies": [ "session-id-time", "session-id" ] }" * **All** *(dict) --* Inspect all cookies. * **IncludedCookies** *(list) --* Inspect only the cookies that have a key that matches one of the strings specified here. * *(string) --* * **ExcludedCookies** *(list) --* Inspect only the cookies whose keys don't match any of the strings specified here. * *(string) --* * **MatchScope** *(string) --* The parts of the cookies to inspect with the rule inspection criteria. If you specify "ALL", WAF inspects both keys and values. "All" does not require a match to be found in the keys and a match to be found in the values. It requires a match to be found in the keys or the values or both. To require a match in the keys and in the values, use a logical "AND" statement to combine two match rules, one that inspects the keys and another that inspects the values. * **OversizeHandling** *(string) --* What WAF should do if the cookies of the request are more numerous or larger than WAF can inspect. WAF does not support inspecting the entire contents of request cookies when they exceed 8 KB (8192 bytes) or 200 total cookies. The underlying host service forwards a maximum of 200 cookies and at most 8 KB of cookie contents to WAF. The options for oversize handling are the following: * "CONTINUE" - Inspect the available cookies normally, according to the rule inspection criteria. * "MATCH" - Treat the web request as matching the rule statement. WAF applies the rule action to the request. * "NO_MATCH" - Treat the web request as not matching the rule statement. * **HeaderOrder** *(dict) --* Inspect a string containing the list of the request's header names, ordered as they appear in the web request that WAF receives for inspection. WAF generates the string and then uses that as the field to match component in its inspection. WAF separates the header names in the string using colons and no added spaces, for example "host:user- agent:accept:authorization:referer". * **OversizeHandling** *(string) --* What WAF should do if the headers determined by your match scope are more numerous or larger than WAF can inspect. WAF does not support inspecting the entire contents of request headers when they exceed 8 KB (8192 bytes) or 200 total headers. The underlying host service forwards a maximum of 200 headers and at most 8 KB of header contents to WAF. The options for oversize handling are the following: * "CONTINUE" - Inspect the available headers normally, according to the rule inspection criteria. * "MATCH" - Treat the web request as matching the rule statement. WAF applies the rule action to the request. * "NO_MATCH" - Treat the web request as not matching the rule statement. * **JA3Fingerprint** *(dict) --* Available for use with Amazon CloudFront distributions and Application Load Balancers. Match against the request's JA3 fingerprint. The JA3 fingerprint is a 32-character hash derived from the TLS Client Hello of an incoming request. This fingerprint serves as a unique identifier for the client's TLS configuration. WAF calculates and logs this fingerprint for each request that has enough TLS Client Hello information for the calculation. Almost all web requests include this information. Note: You can use this choice only with a string match "ByteMatchStatement" with the "PositionalConstraint" set to "EXACTLY". You can obtain the JA3 fingerprint for client requests from the web ACL logs. If WAF is able to calculate the fingerprint, it includes it in the logs. For information about the logging fields, see Log fields in the *WAF Developer Guide*. Provide the JA3 fingerprint string from the logs in your string match statement specification, to match with any future requests that have the same TLS configuration. * **FallbackBehavior** *(string) --* The match status to assign to the web request if the request doesn't have a JA3 fingerprint. You can specify the following fallback behaviors: * "MATCH" - Treat the web request as matching the rule statement. WAF applies the rule action to the request. * "NO_MATCH" - Treat the web request as not matching the rule statement. * **JA4Fingerprint** *(dict) --* Available for use with Amazon CloudFront distributions and Application Load Balancers. Match against the request's JA4 fingerprint. The JA4 fingerprint is a 36-character hash derived from the TLS Client Hello of an incoming request. This fingerprint serves as a unique identifier for the client's TLS configuration. WAF calculates and logs this fingerprint for each request that has enough TLS Client Hello information for the calculation. Almost all web requests include this information. Note: You can use this choice only with a string match "ByteMatchStatement" with the "PositionalConstraint" set to "EXACTLY". You can obtain the JA4 fingerprint for client requests from the web ACL logs. If WAF is able to calculate the fingerprint, it includes it in the logs. For information about the logging fields, see Log fields in the *WAF Developer Guide*. Provide the JA4 fingerprint string from the logs in your string match statement specification, to match with any future requests that have the same TLS configuration. * **FallbackBehavior** *(string) --* The match status to assign to the web request if the request doesn't have a JA4 fingerprint. You can specify the following fallback behaviors: * "MATCH" - Treat the web request as matching the rule statement. WAF applies the rule action to the request. * "NO_MATCH" - Treat the web request as not matching the rule statement. * **UriFragment** *(dict) --* Inspect fragments of the request URI. You must configure scope and pattern matching filters in the "UriFragment" object, to define the fragment of a URI that WAF inspects. Only the first 8 KB (8192 bytes) of a request's URI fragments and only the first 200 URI fragments are forwarded to WAF for inspection by the underlying host service. You must configure how to handle any oversize URI fragment content in the "UriFragment" object. WAF applies the pattern matching filters to the cookies that it receives from the underlying host service. * **FallbackBehavior** *(string) --* What WAF should do if it fails to completely parse the JSON body. The options are the following: * "EVALUATE_AS_STRING" - Inspect the body as plain text. WAF applies the text transformations and inspection criteria that you defined for the JSON inspection to the body text string. * "MATCH" - Treat the web request as matching the rule statement. WAF applies the rule action to the request. * "NO_MATCH" - Treat the web request as not matching the rule statement. If you don't provide this setting, WAF parses and evaluates the content only up to the first parsing failure that it encounters. Example JSON: "{ "UriFragment": { "FallbackBehavior": "MATCH"} }" Note: WAF parsing doesn't fully validate the input JSON string, so parsing can succeed even for invalid JSON. When parsing succeeds, WAF doesn't apply the fallback behavior. For more information, see JSON body in the *WAF Developer Guide*. * **ManagedByFirewallManager** *(boolean) --* Indicates whether the logging configuration was created by Firewall Manager, as part of an WAF policy configuration. If true, only Firewall Manager can modify or delete the configuration. The logging configuration can be created by Firewall Manager for use with any web ACL that Firewall Manager is using for an WAF policy. Web ACLs that Firewall Manager creates and uses have their "ManagedByFirewallManager" property set to true. Web ACLs that were created by a customer account and then retrofitted by Firewall Manager for use by a policy have their "RetrofittedByFirewallManager" property set to true. For either case, any corresponding logging configuration will indicate "ManagedByFirewallManager". * **LoggingFilter** *(dict) --* Filtering that specifies which web requests are kept in the logs and which are dropped. You can filter on the rule action and on the web request labels that were applied by matching rules during web ACL evaluation. * **Filters** *(list) --* The filters that you want to apply to the logs. * *(dict) --* A single logging filter, used in LoggingFilter. * **Behavior** *(string) --* How to handle logs that satisfy the filter's conditions and requirement. * **Requirement** *(string) --* Logic to apply to the filtering conditions. You can specify that, in order to satisfy the filter, a log must match all conditions or must match at least one condition. * **Conditions** *(list) --* Match conditions for the filter. * *(dict) --* A single match condition for a Filter. * **ActionCondition** *(dict) --* A single action condition. This is the action setting that a log record must contain in order to meet the condition. * **Action** *(string) --* The action setting that a log record must contain in order to meet the condition. This is the action that WAF applied to the web request. For rule groups, this is either the configured rule action setting, or if you've applied a rule action override to the rule, it's the override action. The value "EXCLUDED_AS_COUNT" matches on excluded rules and also on rules that have a rule action override of Count. * **LabelNameCondition** *(dict) --* A single label name condition. This is the fully qualified label name that a log record must contain in order to meet the condition. Fully qualified labels have a prefix, optional namespaces, and label name. The prefix identifies the rule group or web ACL context of the rule that added the label. * **LabelName** *(string) --* The label name that a log record must contain in order to meet the condition. This must be a fully qualified label name. Fully qualified labels have a prefix, optional namespaces, and label name. The prefix identifies the rule group or web ACL context of the rule that added the label. * **DefaultBehavior** *(string) --* Default handling for logs that don't match any of the specified filtering conditions. * **LogType** *(string) --* Used to distinguish between various logging options. Currently, there is one option. Default: "WAF_LOGS" * **LogScope** *(string) --* The owner of the logging configuration, which must be set to "CUSTOMER" for the configurations that you manage. The log scope "SECURITY_LAKE" indicates a configuration that is managed through Amazon Security Lake. You can use Security Lake to collect log and event data from various sources for normalization, analysis, and management. For information, see Collecting data from Amazon Web Services services in the *Amazon Security Lake user guide*. Default: "CUSTOMER" **Exceptions** * "WAFV2.Client.exceptions.WAFInternalErrorException" * "WAFV2.Client.exceptions.WAFNonexistentItemException" * "WAFV2.Client.exceptions.WAFOptimisticLockException" * "WAFV2.Client.exceptions.WAFServiceLinkedRoleErrorException" * "WAFV2.Client.exceptions.WAFInvalidParameterException" * "WAFV2.Client.exceptions.WAFInvalidOperationException" * "WAFV2.Client.exceptions.WAFLimitsExceededException" * "WAFV2.Client.exceptions.WAFLogDestinationPermissionIssueExcepti on" WAFV2 / Client / put_managed_rule_set_versions put_managed_rule_set_versions ***************************** WAFV2.Client.put_managed_rule_set_versions(**kwargs) 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. Note: 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. See also: AWS API Documentation **Request Syntax** response = client.put_managed_rule_set_versions( Name='string', Scope='CLOUDFRONT'|'REGIONAL', Id='string', LockToken='string', RecommendedVersion='string', VersionsToPublish={ 'string': { 'AssociatedRuleGroupArn': 'string', 'ForecastedLifetime': 123 } } ) Parameters: * **Name** (*string*) -- **[REQUIRED]** The name of the managed rule set. You use this, along with the rule set ID, to identify the rule set. This name is assigned to the corresponding managed rule group, which your customers can access and use. * **Scope** (*string*) -- **[REQUIRED]** Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. For an Amplify application, use "CLOUDFRONT". To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: * CLI - Specify the Region when you use the CloudFront scope: "--scope=CLOUDFRONT --region=us-east-1". * API and SDKs - For all calls, use the Region endpoint us- east-1. * **Id** (*string*) -- **[REQUIRED]** A unique identifier for the managed rule set. The ID is returned in the responses to commands like "list". You provide it to operations like "get" and "update". * **LockToken** (*string*) -- **[REQUIRED]** A token used for optimistic locking. WAF returns a token to your "get" and "list" requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like "update" and "delete". WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a "WAFOptimisticLockException". If this happens, perform another "get", and use the new token returned by that operation. * **RecommendedVersion** (*string*) -- The version of the named managed rule group that you'd like your customers to choose, from among your version offerings. * **VersionsToPublish** (*dict*) -- The versions of the named managed rule group that you want to offer to your customers. * *(string) --* * *(dict) --* A version of the named managed rule group, that the rule group's vendor publishes for use by customers. Note: 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". * **AssociatedRuleGroupArn** *(string) --* The Amazon Resource Name (ARN) of the vendor's rule group that's used in the published managed rule group version. * **ForecastedLifetime** *(integer) --* The amount of time the vendor expects this version of the managed rule group to last, in days. Return type: dict Returns: **Response Syntax** { 'NextLockToken': 'string' } **Response Structure** * *(dict) --* * **NextLockToken** *(string) --* A token used for optimistic locking. WAF returns a token to your "get" and "list" requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like "update" and "delete". WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a "WAFOptimisticLockException". If this happens, perform another "get", and use the new token returned by that operation. **Exceptions** * "WAFV2.Client.exceptions.WAFInternalErrorException" * "WAFV2.Client.exceptions.WAFInvalidParameterException" * "WAFV2.Client.exceptions.WAFNonexistentItemException" * "WAFV2.Client.exceptions.WAFOptimisticLockException" * "WAFV2.Client.exceptions.WAFInvalidOperationException" WAFV2 / Client / create_api_key create_api_key ************** WAFV2.Client.create_api_key(**kwargs) 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 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. See also: AWS API Documentation **Request Syntax** response = client.create_api_key( Scope='CLOUDFRONT'|'REGIONAL', TokenDomains=[ 'string', ] ) Parameters: * **Scope** (*string*) -- **[REQUIRED]** Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. For an Amplify application, use "CLOUDFRONT". To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: * CLI - Specify the Region when you use the CloudFront scope: "--scope=CLOUDFRONT --region=us-east-1". * API and SDKs - For all calls, use the Region endpoint us- east-1. * **TokenDomains** (*list*) -- **[REQUIRED]** The client application domains that you want to use this API key for. Example JSON: ""TokenDomains": ["abc.com", "store.abc.com"]" Public suffixes aren't allowed. For example, you can't use "gov.au" or "co.uk" as token domains. * *(string) --* Return type: dict Returns: **Response Syntax** { 'APIKey': 'string' } **Response Structure** * *(dict) --* * **APIKey** *(string) --* The generated, encrypted API key. You can copy this for use in your JavaScript CAPTCHA integration. **Exceptions** * "WAFV2.Client.exceptions.WAFInternalErrorException" * "WAFV2.Client.exceptions.WAFInvalidParameterException" * "WAFV2.Client.exceptions.WAFInvalidOperationException" * "WAFV2.Client.exceptions.WAFLimitsExceededException" WAFV2 / Client / list_resources_for_web_acl list_resources_for_web_acl ************************** WAFV2.Client.list_resources_for_web_acl(**kwargs) Retrieves an array of the Amazon Resource Names (ARNs) for the 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 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 in the *WAF Developer Guide*. See also: AWS API Documentation **Request Syntax** response = client.list_resources_for_web_acl( WebACLArn='string', ResourceType='APPLICATION_LOAD_BALANCER'|'API_GATEWAY'|'APPSYNC'|'COGNITO_USER_POOL'|'APP_RUNNER_SERVICE'|'VERIFIED_ACCESS_INSTANCE'|'AMPLIFY' ) Parameters: * **WebACLArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the web ACL. * **ResourceType** (*string*) -- Retrieves the web ACLs that are used by the specified resource type. For Amazon CloudFront, don't use this call. Instead, use the CloudFront call "ListDistributionsByWebACLId". For information, see ListDistributionsByWebACLId in the *Amazon CloudFront API Reference*. Note: If you don't provide a resource type, the call uses the resource type "APPLICATION_LOAD_BALANCER". Default: "APPLICATION_LOAD_BALANCER" Return type: dict Returns: **Response Syntax** { 'ResourceArns': [ 'string', ] } **Response Structure** * *(dict) --* * **ResourceArns** *(list) --* The array of Amazon Resource Names (ARNs) of the associated resources. * *(string) --* **Exceptions** * "WAFV2.Client.exceptions.WAFInternalErrorException" * "WAFV2.Client.exceptions.WAFNonexistentItemException" * "WAFV2.Client.exceptions.WAFInvalidParameterException" * "WAFV2.Client.exceptions.WAFInvalidOperationException" WAFV2 / Client / create_web_acl create_web_acl ************** WAFV2.Client.create_web_acl(**kwargs) 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 resource types include Amazon CloudFront distribution, Amazon API Gateway REST API, Application Load Balancer, AppSync GraphQL API, Amazon Cognito user pool, App Runner service, Amplify application, and Amazon Web Services Verified Access instance. See also: AWS API Documentation **Request Syntax** response = client.create_web_acl( Name='string', Scope='CLOUDFRONT'|'REGIONAL', DefaultAction={ 'Block': { 'CustomResponse': { 'ResponseCode': 123, 'CustomResponseBodyKey': 'string', 'ResponseHeaders': [ { 'Name': 'string', 'Value': 'string' }, ] } }, 'Allow': { 'CustomRequestHandling': { 'InsertHeaders': [ { 'Name': 'string', 'Value': 'string' }, ] } } }, Description='string', Rules=[ { 'Name': 'string', 'Priority': 123, 'Statement': { 'ByteMatchStatement': { 'SearchString': b'bytes', 'FieldToMatch': { 'SingleHeader': { 'Name': 'string' }, 'SingleQueryArgument': { 'Name': 'string' }, 'AllQueryArguments': {} , 'UriPath': {} , 'QueryString': {} , 'Body': { 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'Method': {} , 'JsonBody': { 'MatchPattern': { 'All': {} , 'IncludedPaths': [ 'string', ] }, 'MatchScope': 'ALL'|'KEY'|'VALUE', 'InvalidFallbackBehavior': 'MATCH'|'NO_MATCH'|'EVALUATE_AS_STRING', 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'Headers': { 'MatchPattern': { 'All': {} , 'IncludedHeaders': [ 'string', ], 'ExcludedHeaders': [ 'string', ] }, 'MatchScope': 'ALL'|'KEY'|'VALUE', 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'Cookies': { 'MatchPattern': { 'All': {} , 'IncludedCookies': [ 'string', ], 'ExcludedCookies': [ 'string', ] }, 'MatchScope': 'ALL'|'KEY'|'VALUE', 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'HeaderOrder': { 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'JA3Fingerprint': { 'FallbackBehavior': 'MATCH'|'NO_MATCH' }, 'JA4Fingerprint': { 'FallbackBehavior': 'MATCH'|'NO_MATCH' }, 'UriFragment': { 'FallbackBehavior': 'MATCH'|'NO_MATCH' } }, 'TextTransformations': [ { 'Priority': 123, 'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE' }, ], 'PositionalConstraint': 'EXACTLY'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS'|'CONTAINS_WORD' }, 'SqliMatchStatement': { 'FieldToMatch': { 'SingleHeader': { 'Name': 'string' }, 'SingleQueryArgument': { 'Name': 'string' }, 'AllQueryArguments': {} , 'UriPath': {} , 'QueryString': {} , 'Body': { 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'Method': {} , 'JsonBody': { 'MatchPattern': { 'All': {} , 'IncludedPaths': [ 'string', ] }, 'MatchScope': 'ALL'|'KEY'|'VALUE', 'InvalidFallbackBehavior': 'MATCH'|'NO_MATCH'|'EVALUATE_AS_STRING', 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'Headers': { 'MatchPattern': { 'All': {} , 'IncludedHeaders': [ 'string', ], 'ExcludedHeaders': [ 'string', ] }, 'MatchScope': 'ALL'|'KEY'|'VALUE', 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'Cookies': { 'MatchPattern': { 'All': {} , 'IncludedCookies': [ 'string', ], 'ExcludedCookies': [ 'string', ] }, 'MatchScope': 'ALL'|'KEY'|'VALUE', 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'HeaderOrder': { 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'JA3Fingerprint': { 'FallbackBehavior': 'MATCH'|'NO_MATCH' }, 'JA4Fingerprint': { 'FallbackBehavior': 'MATCH'|'NO_MATCH' }, 'UriFragment': { 'FallbackBehavior': 'MATCH'|'NO_MATCH' } }, 'TextTransformations': [ { 'Priority': 123, 'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE' }, ], 'SensitivityLevel': 'LOW'|'HIGH' }, 'XssMatchStatement': { 'FieldToMatch': { 'SingleHeader': { 'Name': 'string' }, 'SingleQueryArgument': { 'Name': 'string' }, 'AllQueryArguments': {} , 'UriPath': {} , 'QueryString': {} , 'Body': { 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'Method': {} , 'JsonBody': { 'MatchPattern': { 'All': {} , 'IncludedPaths': [ 'string', ] }, 'MatchScope': 'ALL'|'KEY'|'VALUE', 'InvalidFallbackBehavior': 'MATCH'|'NO_MATCH'|'EVALUATE_AS_STRING', 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'Headers': { 'MatchPattern': { 'All': {} , 'IncludedHeaders': [ 'string', ], 'ExcludedHeaders': [ 'string', ] }, 'MatchScope': 'ALL'|'KEY'|'VALUE', 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'Cookies': { 'MatchPattern': { 'All': {} , 'IncludedCookies': [ 'string', ], 'ExcludedCookies': [ 'string', ] }, 'MatchScope': 'ALL'|'KEY'|'VALUE', 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'HeaderOrder': { 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'JA3Fingerprint': { 'FallbackBehavior': 'MATCH'|'NO_MATCH' }, 'JA4Fingerprint': { 'FallbackBehavior': 'MATCH'|'NO_MATCH' }, 'UriFragment': { 'FallbackBehavior': 'MATCH'|'NO_MATCH' } }, 'TextTransformations': [ { 'Priority': 123, 'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE' }, ] }, 'SizeConstraintStatement': { 'FieldToMatch': { 'SingleHeader': { 'Name': 'string' }, 'SingleQueryArgument': { 'Name': 'string' }, 'AllQueryArguments': {} , 'UriPath': {} , 'QueryString': {} , 'Body': { 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'Method': {} , 'JsonBody': { 'MatchPattern': { 'All': {} , 'IncludedPaths': [ 'string', ] }, 'MatchScope': 'ALL'|'KEY'|'VALUE', 'InvalidFallbackBehavior': 'MATCH'|'NO_MATCH'|'EVALUATE_AS_STRING', 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'Headers': { 'MatchPattern': { 'All': {} , 'IncludedHeaders': [ 'string', ], 'ExcludedHeaders': [ 'string', ] }, 'MatchScope': 'ALL'|'KEY'|'VALUE', 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'Cookies': { 'MatchPattern': { 'All': {} , 'IncludedCookies': [ 'string', ], 'ExcludedCookies': [ 'string', ] }, 'MatchScope': 'ALL'|'KEY'|'VALUE', 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'HeaderOrder': { 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'JA3Fingerprint': { 'FallbackBehavior': 'MATCH'|'NO_MATCH' }, 'JA4Fingerprint': { 'FallbackBehavior': 'MATCH'|'NO_MATCH' }, 'UriFragment': { 'FallbackBehavior': 'MATCH'|'NO_MATCH' } }, 'ComparisonOperator': 'EQ'|'NE'|'LE'|'LT'|'GE'|'GT', 'Size': 123, 'TextTransformations': [ { 'Priority': 123, 'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE' }, ] }, 'GeoMatchStatement': { 'CountryCodes': [ 'AF'|'AX'|'AL'|'DZ'|'AS'|'AD'|'AO'|'AI'|'AQ'|'AG'|'AR'|'AM'|'AW'|'AU'|'AT'|'AZ'|'BS'|'BH'|'BD'|'BB'|'BY'|'BE'|'BZ'|'BJ'|'BM'|'BT'|'BO'|'BQ'|'BA'|'BW'|'BV'|'BR'|'IO'|'BN'|'BG'|'BF'|'BI'|'KH'|'CM'|'CA'|'CV'|'KY'|'CF'|'TD'|'CL'|'CN'|'CX'|'CC'|'CO'|'KM'|'CG'|'CD'|'CK'|'CR'|'CI'|'HR'|'CU'|'CW'|'CY'|'CZ'|'DK'|'DJ'|'DM'|'DO'|'EC'|'EG'|'SV'|'GQ'|'ER'|'EE'|'ET'|'FK'|'FO'|'FJ'|'FI'|'FR'|'GF'|'PF'|'TF'|'GA'|'GM'|'GE'|'DE'|'GH'|'GI'|'GR'|'GL'|'GD'|'GP'|'GU'|'GT'|'GG'|'GN'|'GW'|'GY'|'HT'|'HM'|'VA'|'HN'|'HK'|'HU'|'IS'|'IN'|'ID'|'IR'|'IQ'|'IE'|'IM'|'IL'|'IT'|'JM'|'JP'|'JE'|'JO'|'KZ'|'KE'|'KI'|'KP'|'KR'|'KW'|'KG'|'LA'|'LV'|'LB'|'LS'|'LR'|'LY'|'LI'|'LT'|'LU'|'MO'|'MK'|'MG'|'MW'|'MY'|'MV'|'ML'|'MT'|'MH'|'MQ'|'MR'|'MU'|'YT'|'MX'|'FM'|'MD'|'MC'|'MN'|'ME'|'MS'|'MA'|'MZ'|'MM'|'NA'|'NR'|'NP'|'NL'|'NC'|'NZ'|'NI'|'NE'|'NG'|'NU'|'NF'|'MP'|'NO'|'OM'|'PK'|'PW'|'PS'|'PA'|'PG'|'PY'|'PE'|'PH'|'PN'|'PL'|'PT'|'PR'|'QA'|'RE'|'RO'|'RU'|'RW'|'BL'|'SH'|'KN'|'LC'|'MF'|'PM'|'VC'|'WS'|'SM'|'ST'|'SA'|'SN'|'RS'|'SC'|'SL'|'SG'|'SX'|'SK'|'SI'|'SB'|'SO'|'ZA'|'GS'|'SS'|'ES'|'LK'|'SD'|'SR'|'SJ'|'SZ'|'SE'|'CH'|'SY'|'TW'|'TJ'|'TZ'|'TH'|'TL'|'TG'|'TK'|'TO'|'TT'|'TN'|'TR'|'TM'|'TC'|'TV'|'UG'|'UA'|'AE'|'GB'|'US'|'UM'|'UY'|'UZ'|'VU'|'VE'|'VN'|'VG'|'VI'|'WF'|'EH'|'YE'|'ZM'|'ZW'|'XK', ], 'ForwardedIPConfig': { 'HeaderName': 'string', 'FallbackBehavior': 'MATCH'|'NO_MATCH' } }, 'RuleGroupReferenceStatement': { 'ARN': 'string', 'ExcludedRules': [ { 'Name': 'string' }, ], 'RuleActionOverrides': [ { 'Name': 'string', 'ActionToUse': { 'Block': { 'CustomResponse': { 'ResponseCode': 123, 'CustomResponseBodyKey': 'string', 'ResponseHeaders': [ { 'Name': 'string', 'Value': 'string' }, ] } }, 'Allow': { 'CustomRequestHandling': { 'InsertHeaders': [ { 'Name': 'string', 'Value': 'string' }, ] } }, 'Count': { 'CustomRequestHandling': { 'InsertHeaders': [ { 'Name': 'string', 'Value': 'string' }, ] } }, 'Captcha': { 'CustomRequestHandling': { 'InsertHeaders': [ { 'Name': 'string', 'Value': 'string' }, ] } }, 'Challenge': { 'CustomRequestHandling': { 'InsertHeaders': [ { 'Name': 'string', 'Value': 'string' }, ] } } } }, ] }, 'IPSetReferenceStatement': { 'ARN': 'string', 'IPSetForwardedIPConfig': { 'HeaderName': 'string', 'FallbackBehavior': 'MATCH'|'NO_MATCH', 'Position': 'FIRST'|'LAST'|'ANY' } }, 'RegexPatternSetReferenceStatement': { 'ARN': 'string', 'FieldToMatch': { 'SingleHeader': { 'Name': 'string' }, 'SingleQueryArgument': { 'Name': 'string' }, 'AllQueryArguments': {} , 'UriPath': {} , 'QueryString': {} , 'Body': { 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'Method': {} , 'JsonBody': { 'MatchPattern': { 'All': {} , 'IncludedPaths': [ 'string', ] }, 'MatchScope': 'ALL'|'KEY'|'VALUE', 'InvalidFallbackBehavior': 'MATCH'|'NO_MATCH'|'EVALUATE_AS_STRING', 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'Headers': { 'MatchPattern': { 'All': {} , 'IncludedHeaders': [ 'string', ], 'ExcludedHeaders': [ 'string', ] }, 'MatchScope': 'ALL'|'KEY'|'VALUE', 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'Cookies': { 'MatchPattern': { 'All': {} , 'IncludedCookies': [ 'string', ], 'ExcludedCookies': [ 'string', ] }, 'MatchScope': 'ALL'|'KEY'|'VALUE', 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'HeaderOrder': { 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'JA3Fingerprint': { 'FallbackBehavior': 'MATCH'|'NO_MATCH' }, 'JA4Fingerprint': { 'FallbackBehavior': 'MATCH'|'NO_MATCH' }, 'UriFragment': { 'FallbackBehavior': 'MATCH'|'NO_MATCH' } }, 'TextTransformations': [ { 'Priority': 123, 'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE' }, ] }, 'RateBasedStatement': { 'Limit': 123, 'EvaluationWindowSec': 123, 'AggregateKeyType': 'IP'|'FORWARDED_IP'|'CUSTOM_KEYS'|'CONSTANT', 'ScopeDownStatement': {'... recursive ...'}, 'ForwardedIPConfig': { 'HeaderName': 'string', 'FallbackBehavior': 'MATCH'|'NO_MATCH' }, 'CustomKeys': [ { 'Header': { 'Name': 'string', 'TextTransformations': [ { 'Priority': 123, 'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE' }, ] }, 'Cookie': { 'Name': 'string', 'TextTransformations': [ { 'Priority': 123, 'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE' }, ] }, 'QueryArgument': { 'Name': 'string', 'TextTransformations': [ { 'Priority': 123, 'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE' }, ] }, 'QueryString': { 'TextTransformations': [ { 'Priority': 123, 'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE' }, ] }, 'HTTPMethod': {} , 'ForwardedIP': {} , 'IP': {} , 'LabelNamespace': { 'Namespace': 'string' }, 'UriPath': { 'TextTransformations': [ { 'Priority': 123, 'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE' }, ] }, 'JA3Fingerprint': { 'FallbackBehavior': 'MATCH'|'NO_MATCH' }, 'JA4Fingerprint': { 'FallbackBehavior': 'MATCH'|'NO_MATCH' }, 'ASN': {} }, ] }, 'AndStatement': { 'Statements': [ {'... recursive ...'}, ] }, 'OrStatement': { 'Statements': [ {'... recursive ...'}, ] }, 'NotStatement': { 'Statement': {'... recursive ...'} }, 'ManagedRuleGroupStatement': { 'VendorName': 'string', 'Name': 'string', 'Version': 'string', 'ExcludedRules': [ { 'Name': 'string' }, ], 'ScopeDownStatement': {'... recursive ...'}, 'ManagedRuleGroupConfigs': [ { 'LoginPath': 'string', 'PayloadType': 'JSON'|'FORM_ENCODED', 'UsernameField': { 'Identifier': 'string' }, 'PasswordField': { 'Identifier': 'string' }, 'AWSManagedRulesBotControlRuleSet': { 'InspectionLevel': 'COMMON'|'TARGETED', 'EnableMachineLearning': True|False }, 'AWSManagedRulesATPRuleSet': { 'LoginPath': 'string', 'RequestInspection': { 'PayloadType': 'JSON'|'FORM_ENCODED', 'UsernameField': { 'Identifier': 'string' }, 'PasswordField': { 'Identifier': 'string' } }, 'ResponseInspection': { 'StatusCode': { 'SuccessCodes': [ 123, ], 'FailureCodes': [ 123, ] }, 'Header': { 'Name': 'string', 'SuccessValues': [ 'string', ], 'FailureValues': [ 'string', ] }, 'BodyContains': { 'SuccessStrings': [ 'string', ], 'FailureStrings': [ 'string', ] }, 'Json': { 'Identifier': 'string', 'SuccessValues': [ 'string', ], 'FailureValues': [ 'string', ] } }, 'EnableRegexInPath': True|False }, 'AWSManagedRulesACFPRuleSet': { 'CreationPath': 'string', 'RegistrationPagePath': 'string', 'RequestInspection': { 'PayloadType': 'JSON'|'FORM_ENCODED', 'UsernameField': { 'Identifier': 'string' }, 'PasswordField': { 'Identifier': 'string' }, 'EmailField': { 'Identifier': 'string' }, 'PhoneNumberFields': [ { 'Identifier': 'string' }, ], 'AddressFields': [ { 'Identifier': 'string' }, ] }, 'ResponseInspection': { 'StatusCode': { 'SuccessCodes': [ 123, ], 'FailureCodes': [ 123, ] }, 'Header': { 'Name': 'string', 'SuccessValues': [ 'string', ], 'FailureValues': [ 'string', ] }, 'BodyContains': { 'SuccessStrings': [ 'string', ], 'FailureStrings': [ 'string', ] }, 'Json': { 'Identifier': 'string', 'SuccessValues': [ 'string', ], 'FailureValues': [ 'string', ] } }, 'EnableRegexInPath': True|False }, 'AWSManagedRulesAntiDDoSRuleSet': { 'ClientSideActionConfig': { 'Challenge': { 'UsageOfAction': 'ENABLED'|'DISABLED', 'Sensitivity': 'LOW'|'MEDIUM'|'HIGH', 'ExemptUriRegularExpressions': [ { 'RegexString': 'string' }, ] } }, 'SensitivityToBlock': 'LOW'|'MEDIUM'|'HIGH' } }, ], 'RuleActionOverrides': [ { 'Name': 'string', 'ActionToUse': { 'Block': { 'CustomResponse': { 'ResponseCode': 123, 'CustomResponseBodyKey': 'string', 'ResponseHeaders': [ { 'Name': 'string', 'Value': 'string' }, ] } }, 'Allow': { 'CustomRequestHandling': { 'InsertHeaders': [ { 'Name': 'string', 'Value': 'string' }, ] } }, 'Count': { 'CustomRequestHandling': { 'InsertHeaders': [ { 'Name': 'string', 'Value': 'string' }, ] } }, 'Captcha': { 'CustomRequestHandling': { 'InsertHeaders': [ { 'Name': 'string', 'Value': 'string' }, ] } }, 'Challenge': { 'CustomRequestHandling': { 'InsertHeaders': [ { 'Name': 'string', 'Value': 'string' }, ] } } } }, ] }, 'LabelMatchStatement': { 'Scope': 'LABEL'|'NAMESPACE', 'Key': 'string' }, 'RegexMatchStatement': { 'RegexString': 'string', 'FieldToMatch': { 'SingleHeader': { 'Name': 'string' }, 'SingleQueryArgument': { 'Name': 'string' }, 'AllQueryArguments': {} , 'UriPath': {} , 'QueryString': {} , 'Body': { 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'Method': {} , 'JsonBody': { 'MatchPattern': { 'All': {} , 'IncludedPaths': [ 'string', ] }, 'MatchScope': 'ALL'|'KEY'|'VALUE', 'InvalidFallbackBehavior': 'MATCH'|'NO_MATCH'|'EVALUATE_AS_STRING', 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'Headers': { 'MatchPattern': { 'All': {} , 'IncludedHeaders': [ 'string', ], 'ExcludedHeaders': [ 'string', ] }, 'MatchScope': 'ALL'|'KEY'|'VALUE', 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'Cookies': { 'MatchPattern': { 'All': {} , 'IncludedCookies': [ 'string', ], 'ExcludedCookies': [ 'string', ] }, 'MatchScope': 'ALL'|'KEY'|'VALUE', 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'HeaderOrder': { 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'JA3Fingerprint': { 'FallbackBehavior': 'MATCH'|'NO_MATCH' }, 'JA4Fingerprint': { 'FallbackBehavior': 'MATCH'|'NO_MATCH' }, 'UriFragment': { 'FallbackBehavior': 'MATCH'|'NO_MATCH' } }, 'TextTransformations': [ { 'Priority': 123, 'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE' }, ] }, 'AsnMatchStatement': { 'AsnList': [ 123, ], 'ForwardedIPConfig': { 'HeaderName': 'string', 'FallbackBehavior': 'MATCH'|'NO_MATCH' } } }, 'Action': { 'Block': { 'CustomResponse': { 'ResponseCode': 123, 'CustomResponseBodyKey': 'string', 'ResponseHeaders': [ { 'Name': 'string', 'Value': 'string' }, ] } }, 'Allow': { 'CustomRequestHandling': { 'InsertHeaders': [ { 'Name': 'string', 'Value': 'string' }, ] } }, 'Count': { 'CustomRequestHandling': { 'InsertHeaders': [ { 'Name': 'string', 'Value': 'string' }, ] } }, 'Captcha': { 'CustomRequestHandling': { 'InsertHeaders': [ { 'Name': 'string', 'Value': 'string' }, ] } }, 'Challenge': { 'CustomRequestHandling': { 'InsertHeaders': [ { 'Name': 'string', 'Value': 'string' }, ] } } }, 'OverrideAction': { 'Count': { 'CustomRequestHandling': { 'InsertHeaders': [ { 'Name': 'string', 'Value': 'string' }, ] } }, 'None': {} }, 'RuleLabels': [ { 'Name': 'string' }, ], 'VisibilityConfig': { 'SampledRequestsEnabled': True|False, 'CloudWatchMetricsEnabled': True|False, 'MetricName': 'string' }, 'CaptchaConfig': { 'ImmunityTimeProperty': { 'ImmunityTime': 123 } }, 'ChallengeConfig': { 'ImmunityTimeProperty': { 'ImmunityTime': 123 } } }, ], VisibilityConfig={ 'SampledRequestsEnabled': True|False, 'CloudWatchMetricsEnabled': True|False, 'MetricName': 'string' }, DataProtectionConfig={ 'DataProtections': [ { 'Field': { 'FieldType': 'SINGLE_HEADER'|'SINGLE_COOKIE'|'SINGLE_QUERY_ARGUMENT'|'QUERY_STRING'|'BODY', 'FieldKeys': [ 'string', ] }, 'Action': 'SUBSTITUTION'|'HASH', 'ExcludeRuleMatchDetails': True|False, 'ExcludeRateBasedDetails': True|False }, ] }, Tags=[ { 'Key': 'string', 'Value': 'string' }, ], CustomResponseBodies={ 'string': { 'ContentType': 'TEXT_PLAIN'|'TEXT_HTML'|'APPLICATION_JSON', 'Content': 'string' } }, CaptchaConfig={ 'ImmunityTimeProperty': { 'ImmunityTime': 123 } }, ChallengeConfig={ 'ImmunityTimeProperty': { 'ImmunityTime': 123 } }, TokenDomains=[ 'string', ], AssociationConfig={ 'RequestBody': { 'string': { 'DefaultSizeInspectionLimit': 'KB_16'|'KB_32'|'KB_48'|'KB_64' } } }, OnSourceDDoSProtectionConfig={ 'ALBLowReputationMode': 'ACTIVE_UNDER_DDOS'|'ALWAYS_ON' }, ApplicationConfig={ 'Attributes': [ { 'Name': 'string', 'Values': [ 'string', ] }, ] } ) **Parameters** :: # This section is too large to render. # Please see the AWS API Documentation linked below. `AWS API Documentation `_ Return type: dict Returns: **Response Syntax** { 'Summary': { 'Name': 'string', 'Id': 'string', 'Description': 'string', 'LockToken': 'string', 'ARN': 'string' } } **Response Structure** * *(dict) --* * **Summary** *(dict) --* High-level information about a WebACL, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage a "WebACL", and the ARN, that you provide to operations like AssociateWebACL. * **Name** *(string) --* The name of the web ACL. You cannot change the name of a web ACL after you create it. * **Id** *(string) --* The unique identifier for the web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete. * **Description** *(string) --* A description of the web ACL that helps with identification. * **LockToken** *(string) --* A token used for optimistic locking. WAF returns a token to your "get" and "list" requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like "update" and "delete". WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a "WAFOptimisticLockException". If this happens, perform another "get", and use the new token returned by that operation. * **ARN** *(string) --* The Amazon Resource Name (ARN) of the entity. **Exceptions** * "WAFV2.Client.exceptions.WAFInternalErrorException" * "WAFV2.Client.exceptions.WAFInvalidParameterException" * "WAFV2.Client.exceptions.WAFDuplicateItemException" * "WAFV2.Client.exceptions.WAFOptimisticLockException" * "WAFV2.Client.exceptions.WAFLimitsExceededException" * "WAFV2.Client.exceptions.WAFInvalidResourceException" * "WAFV2.Client.exceptions.WAFUnavailableEntityException" * "WAFV2.Client.exceptions.WAFNonexistentItemException" * "WAFV2.Client.exceptions.WAFTagOperationException" * "WAFV2.Client.exceptions.WAFTagOperationInternalErrorException" * "WAFV2.Client.exceptions.WAFSubscriptionNotFoundException" * "WAFV2.Client.exceptions.WAFInvalidOperationException" * "WAFV2.Client.exceptions.WAFConfigurationWarningException" * "WAFV2.Client.exceptions.WAFExpiredManagedRuleGroupVersionExcept ion" WAFV2 / Client / get_ip_set get_ip_set ********** WAFV2.Client.get_ip_set(**kwargs) Retrieves the specified IPSet. See also: AWS API Documentation **Request Syntax** response = client.get_ip_set( Name='string', Scope='CLOUDFRONT'|'REGIONAL', Id='string' ) Parameters: * **Name** (*string*) -- **[REQUIRED]** The name of the IP set. You cannot change the name of an "IPSet" after you create it. * **Scope** (*string*) -- **[REQUIRED]** Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. For an Amplify application, use "CLOUDFRONT". To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: * CLI - Specify the Region when you use the CloudFront scope: "--scope=CLOUDFRONT --region=us-east-1". * API and SDKs - For all calls, use the Region endpoint us- east-1. * **Id** (*string*) -- **[REQUIRED]** A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete. Return type: dict Returns: **Response Syntax** { 'IPSet': { 'Name': 'string', 'Id': 'string', 'ARN': 'string', 'Description': 'string', 'IPAddressVersion': 'IPV4'|'IPV6', 'Addresses': [ 'string', ] }, 'LockToken': 'string' } **Response Structure** * *(dict) --* * **IPSet** *(dict) --* * **Name** *(string) --* The name of the IP set. You cannot change the name of an "IPSet" after you create it. * **Id** *(string) --* A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete. * **ARN** *(string) --* The Amazon Resource Name (ARN) of the entity. * **Description** *(string) --* A description of the IP set that helps with identification. * **IPAddressVersion** *(string) --* The version of the IP addresses, either "IPV4" or "IPV6". * **Addresses** *(list) --* Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses that you want WAF to inspect for in incoming requests. All addresses must be specified using Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for "/0". Example address strings: * For requests that originated from the IP address 192.0.2.44, specify "192.0.2.44/32". * For requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify "192.0.2.0/24". * For requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify "1111:0000:0000:0000:0000:0000:0000:0111/128". * For requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify "1111:0000:0000:0000:0000:0000:0000:0000/64". For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing. Example JSON "Addresses" specifications: * Empty array: ""Addresses": []" * Array with one address: ""Addresses": ["192.0.2.44/32"]" * Array with three addresses: ""Addresses": ["192.0.2.44/32", "192.0.2.0/24", "192.0.0.0/16"]" * INVALID specification: ""Addresses": [""]" INVALID * *(string) --* * **LockToken** *(string) --* A token used for optimistic locking. WAF returns a token to your "get" and "list" requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like "update" and "delete". WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a "WAFOptimisticLockException". If this happens, perform another "get", and use the new token returned by that operation. **Exceptions** * "WAFV2.Client.exceptions.WAFInternalErrorException" * "WAFV2.Client.exceptions.WAFInvalidParameterException" * "WAFV2.Client.exceptions.WAFNonexistentItemException" * "WAFV2.Client.exceptions.WAFInvalidOperationException" WAFV2 / Client / delete_api_key delete_api_key ************** WAFV2.Client.delete_api_key(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.delete_api_key( Scope='CLOUDFRONT'|'REGIONAL', APIKey='string' ) Parameters: * **Scope** (*string*) -- **[REQUIRED]** Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. For an Amplify application, use "CLOUDFRONT". To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: * CLI - Specify the Region when you use the CloudFront scope: "--scope=CLOUDFRONT --region=us-east-1". * API and SDKs - For all calls, use the Region endpoint us- east-1. * **APIKey** (*string*) -- **[REQUIRED]** The encrypted API key that you want to delete. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "WAFV2.Client.exceptions.WAFInternalErrorException" * "WAFV2.Client.exceptions.WAFNonexistentItemException" * "WAFV2.Client.exceptions.WAFOptimisticLockException" * "WAFV2.Client.exceptions.WAFInvalidParameterException" * "WAFV2.Client.exceptions.WAFInvalidOperationException" WAFV2 / Client / list_available_managed_rule_groups list_available_managed_rule_groups ********************************** WAFV2.Client.list_available_managed_rule_groups(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.list_available_managed_rule_groups( Scope='CLOUDFRONT'|'REGIONAL', NextMarker='string', Limit=123 ) Parameters: * **Scope** (*string*) -- **[REQUIRED]** Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. For an Amplify application, use "CLOUDFRONT". To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: * CLI - Specify the Region when you use the CloudFront scope: "--scope=CLOUDFRONT --region=us-east-1". * API and SDKs - For all calls, use the Region endpoint us- east-1. * **NextMarker** (*string*) -- When you request a list of objects with a "Limit" setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a "NextMarker" value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request. * **Limit** (*integer*) -- The maximum number of objects that you want WAF to return for this request. If more objects are available, in the response, WAF provides a "NextMarker" value that you can use in a subsequent call to get the next batch of objects. Return type: dict Returns: **Response Syntax** { 'NextMarker': 'string', 'ManagedRuleGroups': [ { 'VendorName': 'string', 'Name': 'string', 'VersioningSupported': True|False, 'Description': 'string' }, ] } **Response Structure** * *(dict) --* * **NextMarker** *(string) --* When you request a list of objects with a "Limit" setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a "NextMarker" value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request. * **ManagedRuleGroups** *(list) --* Array of managed rule groups that you can use. If you specified a "Limit" in your request, this might not be the full list. * *(dict) --* High-level information about a managed rule group, returned by ListAvailableManagedRuleGroups. This provides information like the name and vendor name, that you provide when you add a ManagedRuleGroupStatement to a web ACL. Managed rule groups include Amazon Web Services Managed Rules rule groups and Amazon Web Services Marketplace managed rule groups. To use any Amazon Web Services Marketplace managed rule group, first subscribe to the rule group through Amazon Web Services Marketplace. * **VendorName** *(string) --* The name of the managed rule group vendor. You use this, along with the rule group name, to identify a rule group. * **Name** *(string) --* The name of the managed rule group. You use this, along with the vendor name, to identify the rule group. * **VersioningSupported** *(boolean) --* Indicates whether the managed rule group is versioned. If it is, you can retrieve the versions list by calling ListAvailableManagedRuleGroupVersions. * **Description** *(string) --* The description of the managed rule group, provided by Amazon Web Services Managed Rules or the Amazon Web Services Marketplace seller who manages it. **Exceptions** * "WAFV2.Client.exceptions.WAFInternalErrorException" * "WAFV2.Client.exceptions.WAFInvalidParameterException" * "WAFV2.Client.exceptions.WAFInvalidOperationException" WAFV2 / Client / delete_web_acl delete_web_acl ************** WAFV2.Client.delete_web_acl(**kwargs) Deletes the specified WebACL. You can only use this if "ManagedByFirewallManager" is false in the web ACL. Note: 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 Amazon CloudFront distributions, use the CloudFront call "ListDistributionsByWebACLId". For information, see ListDistributionsByWebACLId in the *Amazon CloudFront API Reference*. * For all other resources, call ListResourcesForWebACL. * To disassociate a resource from a web ACL, use the following calls: * For Amazon CloudFront distributions, provide an empty web ACL ID in the CloudFront call "UpdateDistribution". For information, see UpdateDistribution in the *Amazon CloudFront API Reference*. * For all other resources, call DisassociateWebACL. See also: AWS API Documentation **Request Syntax** response = client.delete_web_acl( Name='string', Scope='CLOUDFRONT'|'REGIONAL', Id='string', LockToken='string' ) Parameters: * **Name** (*string*) -- **[REQUIRED]** The name of the web ACL. You cannot change the name of a web ACL after you create it. * **Scope** (*string*) -- **[REQUIRED]** Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. For an Amplify application, use "CLOUDFRONT". To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: * CLI - Specify the Region when you use the CloudFront scope: "--scope=CLOUDFRONT --region=us-east-1". * API and SDKs - For all calls, use the Region endpoint us- east-1. * **Id** (*string*) -- **[REQUIRED]** The unique identifier for the web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete. * **LockToken** (*string*) -- **[REQUIRED]** A token used for optimistic locking. WAF returns a token to your "get" and "list" requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like "update" and "delete". WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a "WAFOptimisticLockException". If this happens, perform another "get", and use the new token returned by that operation. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "WAFV2.Client.exceptions.WAFInternalErrorException" * "WAFV2.Client.exceptions.WAFInvalidParameterException" * "WAFV2.Client.exceptions.WAFNonexistentItemException" * "WAFV2.Client.exceptions.WAFOptimisticLockException" * "WAFV2.Client.exceptions.WAFAssociatedItemException" * "WAFV2.Client.exceptions.WAFTagOperationException" * "WAFV2.Client.exceptions.WAFTagOperationInternalErrorException" * "WAFV2.Client.exceptions.WAFInvalidOperationException" WAFV2 / Client / describe_managed_products_by_vendor describe_managed_products_by_vendor *********************************** WAFV2.Client.describe_managed_products_by_vendor(**kwargs) Provides high-level information for the managed rule groups owned by a specific vendor. See also: AWS API Documentation **Request Syntax** response = client.describe_managed_products_by_vendor( VendorName='string', Scope='CLOUDFRONT'|'REGIONAL' ) Parameters: * **VendorName** (*string*) -- **[REQUIRED]** The name of the managed rule group vendor. You use this, along with the rule group name, to identify a rule group. * **Scope** (*string*) -- **[REQUIRED]** Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. For an Amplify application, use "CLOUDFRONT". To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: * CLI - Specify the Region when you use the CloudFront scope: "--scope=CLOUDFRONT --region=us-east-1". * API and SDKs - For all calls, use the Region endpoint us- east-1. Return type: dict Returns: **Response Syntax** { 'ManagedProducts': [ { 'VendorName': 'string', 'ManagedRuleSetName': 'string', 'ProductId': 'string', 'ProductLink': 'string', 'ProductTitle': 'string', 'ProductDescription': 'string', 'SnsTopicArn': 'string', 'IsVersioningSupported': True|False, 'IsAdvancedManagedRuleSet': True|False }, ] } **Response Structure** * *(dict) --* * **ManagedProducts** *(list) --* High-level information for the managed rule groups owned by the specified vendor. * *(dict) --* The properties of a managed product, such as an Amazon Web Services Managed Rules rule group or an Amazon Web Services Marketplace managed rule group. * **VendorName** *(string) --* The name of the managed rule group vendor. You use this, along with the rule group name, to identify a rule group. * **ManagedRuleSetName** *(string) --* The name of the managed rule group. For example, "AWSManagedRulesAnonymousIpList" or "AWSManagedRulesATPRuleSet". * **ProductId** *(string) --* A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete. * **ProductLink** *(string) --* For Amazon Web Services Marketplace managed rule groups only, the link to the rule group product page. * **ProductTitle** *(string) --* The display name for the managed rule group. For example, "Anonymous IP list" or "Account takeover prevention". * **ProductDescription** *(string) --* A short description of the managed rule group. * **SnsTopicArn** *(string) --* The Amazon resource name (ARN) of the Amazon Simple Notification Service SNS topic that's used to provide notification of changes to the managed rule group. You can subscribe to the SNS topic to receive notifications when the managed rule group is modified, such as for new versions and for version expiration. For more information, see the Amazon Simple Notification Service Developer Guide. * **IsVersioningSupported** *(boolean) --* Indicates whether the rule group is versioned. * **IsAdvancedManagedRuleSet** *(boolean) --* Indicates whether the rule group provides an advanced set of protections, such as the the Amazon Web Services Managed Rules rule groups that are used for WAF intelligent threat mitigation. **Exceptions** * "WAFV2.Client.exceptions.WAFInvalidOperationException" * "WAFV2.Client.exceptions.WAFInternalErrorException" * "WAFV2.Client.exceptions.WAFInvalidParameterException" WAFV2 / Client / get_rule_group get_rule_group ************** WAFV2.Client.get_rule_group(**kwargs) Retrieves the specified RuleGroup. See also: AWS API Documentation **Request Syntax** response = client.get_rule_group( Name='string', Scope='CLOUDFRONT'|'REGIONAL', Id='string', ARN='string' ) Parameters: * **Name** (*string*) -- The name of the rule group. You cannot change the name of a rule group after you create it. * **Scope** (*string*) -- Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. For an Amplify application, use "CLOUDFRONT". To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: * CLI - Specify the Region when you use the CloudFront scope: "--scope=CLOUDFRONT --region=us-east-1". * API and SDKs - For all calls, use the Region endpoint us- east-1. * **Id** (*string*) -- A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete. * **ARN** (*string*) -- The Amazon Resource Name (ARN) of the entity. Return type: dict Returns: **Response Syntax** { 'RuleGroup': { 'Name': 'string', 'Id': 'string', 'Capacity': 123, 'ARN': 'string', 'Description': 'string', 'Rules': [ { 'Name': 'string', 'Priority': 123, 'Statement': { 'ByteMatchStatement': { 'SearchString': b'bytes', 'FieldToMatch': { 'SingleHeader': { 'Name': 'string' }, 'SingleQueryArgument': { 'Name': 'string' }, 'AllQueryArguments': {}, 'UriPath': {}, 'QueryString': {}, 'Body': { 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'Method': {}, 'JsonBody': { 'MatchPattern': { 'All': {}, 'IncludedPaths': [ 'string', ] }, 'MatchScope': 'ALL'|'KEY'|'VALUE', 'InvalidFallbackBehavior': 'MATCH'|'NO_MATCH'|'EVALUATE_AS_STRING', 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'Headers': { 'MatchPattern': { 'All': {}, 'IncludedHeaders': [ 'string', ], 'ExcludedHeaders': [ 'string', ] }, 'MatchScope': 'ALL'|'KEY'|'VALUE', 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'Cookies': { 'MatchPattern': { 'All': {}, 'IncludedCookies': [ 'string', ], 'ExcludedCookies': [ 'string', ] }, 'MatchScope': 'ALL'|'KEY'|'VALUE', 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'HeaderOrder': { 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'JA3Fingerprint': { 'FallbackBehavior': 'MATCH'|'NO_MATCH' }, 'JA4Fingerprint': { 'FallbackBehavior': 'MATCH'|'NO_MATCH' }, 'UriFragment': { 'FallbackBehavior': 'MATCH'|'NO_MATCH' } }, 'TextTransformations': [ { 'Priority': 123, 'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE' }, ], 'PositionalConstraint': 'EXACTLY'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS'|'CONTAINS_WORD' }, 'SqliMatchStatement': { 'FieldToMatch': { 'SingleHeader': { 'Name': 'string' }, 'SingleQueryArgument': { 'Name': 'string' }, 'AllQueryArguments': {}, 'UriPath': {}, 'QueryString': {}, 'Body': { 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'Method': {}, 'JsonBody': { 'MatchPattern': { 'All': {}, 'IncludedPaths': [ 'string', ] }, 'MatchScope': 'ALL'|'KEY'|'VALUE', 'InvalidFallbackBehavior': 'MATCH'|'NO_MATCH'|'EVALUATE_AS_STRING', 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'Headers': { 'MatchPattern': { 'All': {}, 'IncludedHeaders': [ 'string', ], 'ExcludedHeaders': [ 'string', ] }, 'MatchScope': 'ALL'|'KEY'|'VALUE', 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'Cookies': { 'MatchPattern': { 'All': {}, 'IncludedCookies': [ 'string', ], 'ExcludedCookies': [ 'string', ] }, 'MatchScope': 'ALL'|'KEY'|'VALUE', 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'HeaderOrder': { 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'JA3Fingerprint': { 'FallbackBehavior': 'MATCH'|'NO_MATCH' }, 'JA4Fingerprint': { 'FallbackBehavior': 'MATCH'|'NO_MATCH' }, 'UriFragment': { 'FallbackBehavior': 'MATCH'|'NO_MATCH' } }, 'TextTransformations': [ { 'Priority': 123, 'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE' }, ], 'SensitivityLevel': 'LOW'|'HIGH' }, 'XssMatchStatement': { 'FieldToMatch': { 'SingleHeader': { 'Name': 'string' }, 'SingleQueryArgument': { 'Name': 'string' }, 'AllQueryArguments': {}, 'UriPath': {}, 'QueryString': {}, 'Body': { 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'Method': {}, 'JsonBody': { 'MatchPattern': { 'All': {}, 'IncludedPaths': [ 'string', ] }, 'MatchScope': 'ALL'|'KEY'|'VALUE', 'InvalidFallbackBehavior': 'MATCH'|'NO_MATCH'|'EVALUATE_AS_STRING', 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'Headers': { 'MatchPattern': { 'All': {}, 'IncludedHeaders': [ 'string', ], 'ExcludedHeaders': [ 'string', ] }, 'MatchScope': 'ALL'|'KEY'|'VALUE', 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'Cookies': { 'MatchPattern': { 'All': {}, 'IncludedCookies': [ 'string', ], 'ExcludedCookies': [ 'string', ] }, 'MatchScope': 'ALL'|'KEY'|'VALUE', 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'HeaderOrder': { 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'JA3Fingerprint': { 'FallbackBehavior': 'MATCH'|'NO_MATCH' }, 'JA4Fingerprint': { 'FallbackBehavior': 'MATCH'|'NO_MATCH' }, 'UriFragment': { 'FallbackBehavior': 'MATCH'|'NO_MATCH' } }, 'TextTransformations': [ { 'Priority': 123, 'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE' }, ] }, 'SizeConstraintStatement': { 'FieldToMatch': { 'SingleHeader': { 'Name': 'string' }, 'SingleQueryArgument': { 'Name': 'string' }, 'AllQueryArguments': {}, 'UriPath': {}, 'QueryString': {}, 'Body': { 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'Method': {}, 'JsonBody': { 'MatchPattern': { 'All': {}, 'IncludedPaths': [ 'string', ] }, 'MatchScope': 'ALL'|'KEY'|'VALUE', 'InvalidFallbackBehavior': 'MATCH'|'NO_MATCH'|'EVALUATE_AS_STRING', 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'Headers': { 'MatchPattern': { 'All': {}, 'IncludedHeaders': [ 'string', ], 'ExcludedHeaders': [ 'string', ] }, 'MatchScope': 'ALL'|'KEY'|'VALUE', 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'Cookies': { 'MatchPattern': { 'All': {}, 'IncludedCookies': [ 'string', ], 'ExcludedCookies': [ 'string', ] }, 'MatchScope': 'ALL'|'KEY'|'VALUE', 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'HeaderOrder': { 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'JA3Fingerprint': { 'FallbackBehavior': 'MATCH'|'NO_MATCH' }, 'JA4Fingerprint': { 'FallbackBehavior': 'MATCH'|'NO_MATCH' }, 'UriFragment': { 'FallbackBehavior': 'MATCH'|'NO_MATCH' } }, 'ComparisonOperator': 'EQ'|'NE'|'LE'|'LT'|'GE'|'GT', 'Size': 123, 'TextTransformations': [ { 'Priority': 123, 'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE' }, ] }, 'GeoMatchStatement': { 'CountryCodes': [ 'AF'|'AX'|'AL'|'DZ'|'AS'|'AD'|'AO'|'AI'|'AQ'|'AG'|'AR'|'AM'|'AW'|'AU'|'AT'|'AZ'|'BS'|'BH'|'BD'|'BB'|'BY'|'BE'|'BZ'|'BJ'|'BM'|'BT'|'BO'|'BQ'|'BA'|'BW'|'BV'|'BR'|'IO'|'BN'|'BG'|'BF'|'BI'|'KH'|'CM'|'CA'|'CV'|'KY'|'CF'|'TD'|'CL'|'CN'|'CX'|'CC'|'CO'|'KM'|'CG'|'CD'|'CK'|'CR'|'CI'|'HR'|'CU'|'CW'|'CY'|'CZ'|'DK'|'DJ'|'DM'|'DO'|'EC'|'EG'|'SV'|'GQ'|'ER'|'EE'|'ET'|'FK'|'FO'|'FJ'|'FI'|'FR'|'GF'|'PF'|'TF'|'GA'|'GM'|'GE'|'DE'|'GH'|'GI'|'GR'|'GL'|'GD'|'GP'|'GU'|'GT'|'GG'|'GN'|'GW'|'GY'|'HT'|'HM'|'VA'|'HN'|'HK'|'HU'|'IS'|'IN'|'ID'|'IR'|'IQ'|'IE'|'IM'|'IL'|'IT'|'JM'|'JP'|'JE'|'JO'|'KZ'|'KE'|'KI'|'KP'|'KR'|'KW'|'KG'|'LA'|'LV'|'LB'|'LS'|'LR'|'LY'|'LI'|'LT'|'LU'|'MO'|'MK'|'MG'|'MW'|'MY'|'MV'|'ML'|'MT'|'MH'|'MQ'|'MR'|'MU'|'YT'|'MX'|'FM'|'MD'|'MC'|'MN'|'ME'|'MS'|'MA'|'MZ'|'MM'|'NA'|'NR'|'NP'|'NL'|'NC'|'NZ'|'NI'|'NE'|'NG'|'NU'|'NF'|'MP'|'NO'|'OM'|'PK'|'PW'|'PS'|'PA'|'PG'|'PY'|'PE'|'PH'|'PN'|'PL'|'PT'|'PR'|'QA'|'RE'|'RO'|'RU'|'RW'|'BL'|'SH'|'KN'|'LC'|'MF'|'PM'|'VC'|'WS'|'SM'|'ST'|'SA'|'SN'|'RS'|'SC'|'SL'|'SG'|'SX'|'SK'|'SI'|'SB'|'SO'|'ZA'|'GS'|'SS'|'ES'|'LK'|'SD'|'SR'|'SJ'|'SZ'|'SE'|'CH'|'SY'|'TW'|'TJ'|'TZ'|'TH'|'TL'|'TG'|'TK'|'TO'|'TT'|'TN'|'TR'|'TM'|'TC'|'TV'|'UG'|'UA'|'AE'|'GB'|'US'|'UM'|'UY'|'UZ'|'VU'|'VE'|'VN'|'VG'|'VI'|'WF'|'EH'|'YE'|'ZM'|'ZW'|'XK', ], 'ForwardedIPConfig': { 'HeaderName': 'string', 'FallbackBehavior': 'MATCH'|'NO_MATCH' } }, 'RuleGroupReferenceStatement': { 'ARN': 'string', 'ExcludedRules': [ { 'Name': 'string' }, ], 'RuleActionOverrides': [ { 'Name': 'string', 'ActionToUse': { 'Block': { 'CustomResponse': { 'ResponseCode': 123, 'CustomResponseBodyKey': 'string', 'ResponseHeaders': [ { 'Name': 'string', 'Value': 'string' }, ] } }, 'Allow': { 'CustomRequestHandling': { 'InsertHeaders': [ { 'Name': 'string', 'Value': 'string' }, ] } }, 'Count': { 'CustomRequestHandling': { 'InsertHeaders': [ { 'Name': 'string', 'Value': 'string' }, ] } }, 'Captcha': { 'CustomRequestHandling': { 'InsertHeaders': [ { 'Name': 'string', 'Value': 'string' }, ] } }, 'Challenge': { 'CustomRequestHandling': { 'InsertHeaders': [ { 'Name': 'string', 'Value': 'string' }, ] } } } }, ] }, 'IPSetReferenceStatement': { 'ARN': 'string', 'IPSetForwardedIPConfig': { 'HeaderName': 'string', 'FallbackBehavior': 'MATCH'|'NO_MATCH', 'Position': 'FIRST'|'LAST'|'ANY' } }, 'RegexPatternSetReferenceStatement': { 'ARN': 'string', 'FieldToMatch': { 'SingleHeader': { 'Name': 'string' }, 'SingleQueryArgument': { 'Name': 'string' }, 'AllQueryArguments': {}, 'UriPath': {}, 'QueryString': {}, 'Body': { 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'Method': {}, 'JsonBody': { 'MatchPattern': { 'All': {}, 'IncludedPaths': [ 'string', ] }, 'MatchScope': 'ALL'|'KEY'|'VALUE', 'InvalidFallbackBehavior': 'MATCH'|'NO_MATCH'|'EVALUATE_AS_STRING', 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'Headers': { 'MatchPattern': { 'All': {}, 'IncludedHeaders': [ 'string', ], 'ExcludedHeaders': [ 'string', ] }, 'MatchScope': 'ALL'|'KEY'|'VALUE', 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'Cookies': { 'MatchPattern': { 'All': {}, 'IncludedCookies': [ 'string', ], 'ExcludedCookies': [ 'string', ] }, 'MatchScope': 'ALL'|'KEY'|'VALUE', 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'HeaderOrder': { 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'JA3Fingerprint': { 'FallbackBehavior': 'MATCH'|'NO_MATCH' }, 'JA4Fingerprint': { 'FallbackBehavior': 'MATCH'|'NO_MATCH' }, 'UriFragment': { 'FallbackBehavior': 'MATCH'|'NO_MATCH' } }, 'TextTransformations': [ { 'Priority': 123, 'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE' }, ] }, 'RateBasedStatement': { 'Limit': 123, 'EvaluationWindowSec': 123, 'AggregateKeyType': 'IP'|'FORWARDED_IP'|'CUSTOM_KEYS'|'CONSTANT', 'ScopeDownStatement': {'... recursive ...'}, 'ForwardedIPConfig': { 'HeaderName': 'string', 'FallbackBehavior': 'MATCH'|'NO_MATCH' }, 'CustomKeys': [ { 'Header': { 'Name': 'string', 'TextTransformations': [ { 'Priority': 123, 'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE' }, ] }, 'Cookie': { 'Name': 'string', 'TextTransformations': [ { 'Priority': 123, 'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE' }, ] }, 'QueryArgument': { 'Name': 'string', 'TextTransformations': [ { 'Priority': 123, 'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE' }, ] }, 'QueryString': { 'TextTransformations': [ { 'Priority': 123, 'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE' }, ] }, 'HTTPMethod': {}, 'ForwardedIP': {}, 'IP': {}, 'LabelNamespace': { 'Namespace': 'string' }, 'UriPath': { 'TextTransformations': [ { 'Priority': 123, 'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE' }, ] }, 'JA3Fingerprint': { 'FallbackBehavior': 'MATCH'|'NO_MATCH' }, 'JA4Fingerprint': { 'FallbackBehavior': 'MATCH'|'NO_MATCH' }, 'ASN': {} }, ] }, 'AndStatement': { 'Statements': [ {'... recursive ...'}, ] }, 'OrStatement': { 'Statements': [ {'... recursive ...'}, ] }, 'NotStatement': { 'Statement': {'... recursive ...'} }, 'ManagedRuleGroupStatement': { 'VendorName': 'string', 'Name': 'string', 'Version': 'string', 'ExcludedRules': [ { 'Name': 'string' }, ], 'ScopeDownStatement': {'... recursive ...'}, 'ManagedRuleGroupConfigs': [ { 'LoginPath': 'string', 'PayloadType': 'JSON'|'FORM_ENCODED', 'UsernameField': { 'Identifier': 'string' }, 'PasswordField': { 'Identifier': 'string' }, 'AWSManagedRulesBotControlRuleSet': { 'InspectionLevel': 'COMMON'|'TARGETED', 'EnableMachineLearning': True|False }, 'AWSManagedRulesATPRuleSet': { 'LoginPath': 'string', 'RequestInspection': { 'PayloadType': 'JSON'|'FORM_ENCODED', 'UsernameField': { 'Identifier': 'string' }, 'PasswordField': { 'Identifier': 'string' } }, 'ResponseInspection': { 'StatusCode': { 'SuccessCodes': [ 123, ], 'FailureCodes': [ 123, ] }, 'Header': { 'Name': 'string', 'SuccessValues': [ 'string', ], 'FailureValues': [ 'string', ] }, 'BodyContains': { 'SuccessStrings': [ 'string', ], 'FailureStrings': [ 'string', ] }, 'Json': { 'Identifier': 'string', 'SuccessValues': [ 'string', ], 'FailureValues': [ 'string', ] } }, 'EnableRegexInPath': True|False }, 'AWSManagedRulesACFPRuleSet': { 'CreationPath': 'string', 'RegistrationPagePath': 'string', 'RequestInspection': { 'PayloadType': 'JSON'|'FORM_ENCODED', 'UsernameField': { 'Identifier': 'string' }, 'PasswordField': { 'Identifier': 'string' }, 'EmailField': { 'Identifier': 'string' }, 'PhoneNumberFields': [ { 'Identifier': 'string' }, ], 'AddressFields': [ { 'Identifier': 'string' }, ] }, 'ResponseInspection': { 'StatusCode': { 'SuccessCodes': [ 123, ], 'FailureCodes': [ 123, ] }, 'Header': { 'Name': 'string', 'SuccessValues': [ 'string', ], 'FailureValues': [ 'string', ] }, 'BodyContains': { 'SuccessStrings': [ 'string', ], 'FailureStrings': [ 'string', ] }, 'Json': { 'Identifier': 'string', 'SuccessValues': [ 'string', ], 'FailureValues': [ 'string', ] } }, 'EnableRegexInPath': True|False }, 'AWSManagedRulesAntiDDoSRuleSet': { 'ClientSideActionConfig': { 'Challenge': { 'UsageOfAction': 'ENABLED'|'DISABLED', 'Sensitivity': 'LOW'|'MEDIUM'|'HIGH', 'ExemptUriRegularExpressions': [ { 'RegexString': 'string' }, ] } }, 'SensitivityToBlock': 'LOW'|'MEDIUM'|'HIGH' } }, ], 'RuleActionOverrides': [ { 'Name': 'string', 'ActionToUse': { 'Block': { 'CustomResponse': { 'ResponseCode': 123, 'CustomResponseBodyKey': 'string', 'ResponseHeaders': [ { 'Name': 'string', 'Value': 'string' }, ] } }, 'Allow': { 'CustomRequestHandling': { 'InsertHeaders': [ { 'Name': 'string', 'Value': 'string' }, ] } }, 'Count': { 'CustomRequestHandling': { 'InsertHeaders': [ { 'Name': 'string', 'Value': 'string' }, ] } }, 'Captcha': { 'CustomRequestHandling': { 'InsertHeaders': [ { 'Name': 'string', 'Value': 'string' }, ] } }, 'Challenge': { 'CustomRequestHandling': { 'InsertHeaders': [ { 'Name': 'string', 'Value': 'string' }, ] } } } }, ] }, 'LabelMatchStatement': { 'Scope': 'LABEL'|'NAMESPACE', 'Key': 'string' }, 'RegexMatchStatement': { 'RegexString': 'string', 'FieldToMatch': { 'SingleHeader': { 'Name': 'string' }, 'SingleQueryArgument': { 'Name': 'string' }, 'AllQueryArguments': {}, 'UriPath': {}, 'QueryString': {}, 'Body': { 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'Method': {}, 'JsonBody': { 'MatchPattern': { 'All': {}, 'IncludedPaths': [ 'string', ] }, 'MatchScope': 'ALL'|'KEY'|'VALUE', 'InvalidFallbackBehavior': 'MATCH'|'NO_MATCH'|'EVALUATE_AS_STRING', 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'Headers': { 'MatchPattern': { 'All': {}, 'IncludedHeaders': [ 'string', ], 'ExcludedHeaders': [ 'string', ] }, 'MatchScope': 'ALL'|'KEY'|'VALUE', 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'Cookies': { 'MatchPattern': { 'All': {}, 'IncludedCookies': [ 'string', ], 'ExcludedCookies': [ 'string', ] }, 'MatchScope': 'ALL'|'KEY'|'VALUE', 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'HeaderOrder': { 'OversizeHandling': 'CONTINUE'|'MATCH'|'NO_MATCH' }, 'JA3Fingerprint': { 'FallbackBehavior': 'MATCH'|'NO_MATCH' }, 'JA4Fingerprint': { 'FallbackBehavior': 'MATCH'|'NO_MATCH' }, 'UriFragment': { 'FallbackBehavior': 'MATCH'|'NO_MATCH' } }, 'TextTransformations': [ { 'Priority': 123, 'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'|'BASE64_DECODE'|'HEX_DECODE'|'MD5'|'REPLACE_COMMENTS'|'ESCAPE_SEQ_DECODE'|'SQL_HEX_DECODE'|'CSS_DECODE'|'JS_DECODE'|'NORMALIZE_PATH'|'NORMALIZE_PATH_WIN'|'REMOVE_NULLS'|'REPLACE_NULLS'|'BASE64_DECODE_EXT'|'URL_DECODE_UNI'|'UTF8_TO_UNICODE' }, ] }, 'AsnMatchStatement': { 'AsnList': [ 123, ], 'ForwardedIPConfig': { 'HeaderName': 'string', 'FallbackBehavior': 'MATCH'|'NO_MATCH' } } }, 'Action': { 'Block': { 'CustomResponse': { 'ResponseCode': 123, 'CustomResponseBodyKey': 'string', 'ResponseHeaders': [ { 'Name': 'string', 'Value': 'string' }, ] } }, 'Allow': { 'CustomRequestHandling': { 'InsertHeaders': [ { 'Name': 'string', 'Value': 'string' }, ] } }, 'Count': { 'CustomRequestHandling': { 'InsertHeaders': [ { 'Name': 'string', 'Value': 'string' }, ] } }, 'Captcha': { 'CustomRequestHandling': { 'InsertHeaders': [ { 'Name': 'string', 'Value': 'string' }, ] } }, 'Challenge': { 'CustomRequestHandling': { 'InsertHeaders': [ { 'Name': 'string', 'Value': 'string' }, ] } } }, 'OverrideAction': { 'Count': { 'CustomRequestHandling': { 'InsertHeaders': [ { 'Name': 'string', 'Value': 'string' }, ] } }, 'None': {} }, 'RuleLabels': [ { 'Name': 'string' }, ], 'VisibilityConfig': { 'SampledRequestsEnabled': True|False, 'CloudWatchMetricsEnabled': True|False, 'MetricName': 'string' }, 'CaptchaConfig': { 'ImmunityTimeProperty': { 'ImmunityTime': 123 } }, 'ChallengeConfig': { 'ImmunityTimeProperty': { 'ImmunityTime': 123 } } }, ], 'VisibilityConfig': { 'SampledRequestsEnabled': True|False, 'CloudWatchMetricsEnabled': True|False, 'MetricName': 'string' }, 'LabelNamespace': 'string', 'CustomResponseBodies': { 'string': { 'ContentType': 'TEXT_PLAIN'|'TEXT_HTML'|'APPLICATION_JSON', 'Content': 'string' } }, 'AvailableLabels': [ { 'Name': 'string' }, ], 'ConsumedLabels': [ { 'Name': 'string' }, ] }, 'LockToken': 'string' } **Response Structure** # This section is too large to render. # Please see the AWS API Documentation linked below. AWS API Documentation **Exceptions** * "WAFV2.Client.exceptions.WAFInternalErrorException" * "WAFV2.Client.exceptions.WAFInvalidParameterException" * "WAFV2.Client.exceptions.WAFNonexistentItemException" * "WAFV2.Client.exceptions.WAFInvalidOperationException" WAFV2 / Client / close close ***** WAFV2.Client.close() Closes underlying endpoint connections. WAFV2 / Client / describe_managed_rule_group describe_managed_rule_group *************************** WAFV2.Client.describe_managed_rule_group(**kwargs) Provides high-level information for a managed rule group, including descriptions of the rules. See also: AWS API Documentation **Request Syntax** response = client.describe_managed_rule_group( VendorName='string', Name='string', Scope='CLOUDFRONT'|'REGIONAL', VersionName='string' ) Parameters: * **VendorName** (*string*) -- **[REQUIRED]** The name of the managed rule group vendor. You use this, along with the rule group name, to identify a rule group. * **Name** (*string*) -- **[REQUIRED]** The name of the managed rule group. You use this, along with the vendor name, to identify the rule group. * **Scope** (*string*) -- **[REQUIRED]** Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. For an Amplify application, use "CLOUDFRONT". To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: * CLI - Specify the Region when you use the CloudFront scope: "--scope=CLOUDFRONT --region=us-east-1". * API and SDKs - For all calls, use the Region endpoint us- east-1. * **VersionName** (*string*) -- The version of the rule group. You can only use a version that is not scheduled for expiration. If you don't provide this, WAF uses the vendor's default version. Return type: dict Returns: **Response Syntax** { 'VersionName': 'string', 'SnsTopicArn': 'string', 'Capacity': 123, 'Rules': [ { 'Name': 'string', 'Action': { 'Block': { 'CustomResponse': { 'ResponseCode': 123, 'CustomResponseBodyKey': 'string', 'ResponseHeaders': [ { 'Name': 'string', 'Value': 'string' }, ] } }, 'Allow': { 'CustomRequestHandling': { 'InsertHeaders': [ { 'Name': 'string', 'Value': 'string' }, ] } }, 'Count': { 'CustomRequestHandling': { 'InsertHeaders': [ { 'Name': 'string', 'Value': 'string' }, ] } }, 'Captcha': { 'CustomRequestHandling': { 'InsertHeaders': [ { 'Name': 'string', 'Value': 'string' }, ] } }, 'Challenge': { 'CustomRequestHandling': { 'InsertHeaders': [ { 'Name': 'string', 'Value': 'string' }, ] } } } }, ], 'LabelNamespace': 'string', 'AvailableLabels': [ { 'Name': 'string' }, ], 'ConsumedLabels': [ { 'Name': 'string' }, ] } **Response Structure** * *(dict) --* * **VersionName** *(string) --* The managed rule group's version. * **SnsTopicArn** *(string) --* The Amazon resource name (ARN) of the Amazon Simple Notification Service SNS topic that's used to provide notification of changes to the managed rule group. You can subscribe to the SNS topic to receive notifications when the managed rule group is modified, such as for new versions and for version expiration. For more information, see the Amazon Simple Notification Service Developer Guide. * **Capacity** *(integer) --* The web ACL capacity units (WCUs) required for this rule group. WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. For more information, see WAF web ACL capacity units (WCU) in the *WAF Developer Guide*. * **Rules** *(list) --* * *(dict) --* High-level information about a Rule, returned by operations like DescribeManagedRuleGroup. This provides information like the ID, that you can use to retrieve and manage a "RuleGroup", and the ARN, that you provide to the RuleGroupReferenceStatement to use the rule group in a Rule. * **Name** *(string) --* The name of the rule. * **Action** *(dict) --* The action that WAF should take on a web request when it matches a rule's statement. Settings at the web ACL level can override the rule action setting. * **Block** *(dict) --* Instructs WAF to block the web request. * **CustomResponse** *(dict) --* Defines a custom response for the web request. For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the *WAF Developer Guide*. * **ResponseCode** *(integer) --* The HTTP status code to return to the client. For a list of status codes that you can use in your custom responses, see Supported status codes for custom response in the *WAF Developer Guide*. * **CustomResponseBodyKey** *(string) --* References the response body that you want WAF to return to the web request client. You can define a custom response for a rule action or a default web ACL action that is set to block. To do this, you first define the response body key and value in the "CustomResponseBodies" setting for the WebACL or RuleGroup where you want to use it. Then, in the rule action or web ACL default action "BlockAction" setting, you reference the response body using this key. * **ResponseHeaders** *(list) --* The HTTP headers to use in the response. You can specify any header name except for "content-type". Duplicate header names are not allowed. For information about the limits on count and size for custom request and response settings, see WAF quotas in the *WAF Developer Guide*. * *(dict) --* A custom header for custom request and response handling. This is used in CustomResponse and CustomRequestHandling. * **Name** *(string) --* The name of the custom header. For custom request header insertion, when WAF inserts the header into the request, it prefixes this name "x-amzn-waf-", to avoid confusion with the headers that are already in the request. For example, for the header name "sample", WAF inserts the header "x-amzn-waf- sample". * **Value** *(string) --* The value of the custom header. * **Allow** *(dict) --* Instructs WAF to allow the web request. * **CustomRequestHandling** *(dict) --* Defines custom handling for the web request. For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the *WAF Developer Guide*. * **InsertHeaders** *(list) --* The HTTP headers to insert into the request. Duplicate header names are not allowed. For information about the limits on count and size for custom request and response settings, see WAF quotas in the *WAF Developer Guide*. * *(dict) --* A custom header for custom request and response handling. This is used in CustomResponse and CustomRequestHandling. * **Name** *(string) --* The name of the custom header. For custom request header insertion, when WAF inserts the header into the request, it prefixes this name "x-amzn-waf-", to avoid confusion with the headers that are already in the request. For example, for the header name "sample", WAF inserts the header "x-amzn-waf- sample". * **Value** *(string) --* The value of the custom header. * **Count** *(dict) --* Instructs WAF to count the web request and then continue evaluating the request using the remaining rules in the web ACL. * **CustomRequestHandling** *(dict) --* Defines custom handling for the web request. For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the *WAF Developer Guide*. * **InsertHeaders** *(list) --* The HTTP headers to insert into the request. Duplicate header names are not allowed. For information about the limits on count and size for custom request and response settings, see WAF quotas in the *WAF Developer Guide*. * *(dict) --* A custom header for custom request and response handling. This is used in CustomResponse and CustomRequestHandling. * **Name** *(string) --* The name of the custom header. For custom request header insertion, when WAF inserts the header into the request, it prefixes this name "x-amzn-waf-", to avoid confusion with the headers that are already in the request. For example, for the header name "sample", WAF inserts the header "x-amzn-waf- sample". * **Value** *(string) --* The value of the custom header. * **Captcha** *(dict) --* Instructs WAF to run a "CAPTCHA" check against the web request. * **CustomRequestHandling** *(dict) --* Defines custom handling for the web request, used when the "CAPTCHA" inspection determines that the request's token is valid and unexpired. For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the *WAF Developer Guide*. * **InsertHeaders** *(list) --* The HTTP headers to insert into the request. Duplicate header names are not allowed. For information about the limits on count and size for custom request and response settings, see WAF quotas in the *WAF Developer Guide*. * *(dict) --* A custom header for custom request and response handling. This is used in CustomResponse and CustomRequestHandling. * **Name** *(string) --* The name of the custom header. For custom request header insertion, when WAF inserts the header into the request, it prefixes this name "x-amzn-waf-", to avoid confusion with the headers that are already in the request. For example, for the header name "sample", WAF inserts the header "x-amzn-waf- sample". * **Value** *(string) --* The value of the custom header. * **Challenge** *(dict) --* Instructs WAF to run a "Challenge" check against the web request. * **CustomRequestHandling** *(dict) --* Defines custom handling for the web request, used when the challenge inspection determines that the request's token is valid and unexpired. For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the *WAF Developer Guide*. * **InsertHeaders** *(list) --* The HTTP headers to insert into the request. Duplicate header names are not allowed. For information about the limits on count and size for custom request and response settings, see WAF quotas in the *WAF Developer Guide*. * *(dict) --* A custom header for custom request and response handling. This is used in CustomResponse and CustomRequestHandling. * **Name** *(string) --* The name of the custom header. For custom request header insertion, when WAF inserts the header into the request, it prefixes this name "x-amzn-waf-", to avoid confusion with the headers that are already in the request. For example, for the header name "sample", WAF inserts the header "x-amzn-waf- sample". * **Value** *(string) --* The value of the custom header. * **LabelNamespace** *(string) --* The label namespace prefix for this rule group. All labels added by rules in this rule group have this prefix. * The syntax for the label namespace prefix for a managed rule group is the following: "awswaf:managed::": * When a rule with a label matches a web request, WAF adds the fully qualified label to the request. A fully qualified label is made up of the label namespace from the rule group or web ACL where the rule is defined and the label from the rule, separated by a colon: "