AWS WAFV2 2019-07-29

AssociateWebACL

$result = $client->associateWebACL([/* ... */]);
$promise = $client->associateWebACLAsync([/* ... */]);

Parameter Syntax

$result = $client->associateWebACL([
    'ResourceArn' => '<string>', // REQUIRED
    'WebACLArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

• WAFInternalErrorException:

  Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.

• WAFInvalidParameterException:

  The operation failed because WAF didn't recognize a parameter in the request. For example:

  • You specified a parameter name or value that isn't valid.

  • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

  • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

  • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated.

• WAFNonexistentItemException:

  WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.

• WAFUnavailableEntityException:

  WAF couldn’t retrieve a resource that you specified for this operation. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate. Verify the resources that you are specifying in your request parameters and then retry the operation.

• WAFInvalidOperationException:

  The operation isn't valid.

CheckCapacity

$result = $client->checkCapacity([/* ... */]);
$promise = $client->checkCapacityAsync([/* ... */]);

Parameter Syntax

$result = $client->checkCapacity([
    'Rules' => [ // REQUIRED
        [
            'Action' => [
                'Allow' => [
                    'CustomRequestHandling' => [
                        'InsertHeaders' => [ // REQUIRED
                            [
                                'Name' => '<string>', // REQUIRED
                                'Value' => '<string>', // REQUIRED
                            ],
                            // ...
                        ],
                    ],
                ],
                'Block' => [
                    'CustomResponse' => [
                        'CustomResponseBodyKey' => '<string>',
                        'ResponseCode' => <integer>, // REQUIRED
                        'ResponseHeaders' => [
                            [
                                'Name' => '<string>', // REQUIRED
                                'Value' => '<string>', // REQUIRED
                            ],
                            // ...
                        ],
                    ],
                ],
                'Captcha' => [
                    'CustomRequestHandling' => [
                        'InsertHeaders' => [ // REQUIRED
                            [
                                'Name' => '<string>', // REQUIRED
                                'Value' => '<string>', // REQUIRED
                            ],
                            // ...
                        ],
                    ],
                ],
                'Challenge' => [
                    'CustomRequestHandling' => [
                        'InsertHeaders' => [ // REQUIRED
                            [
                                'Name' => '<string>', // REQUIRED
                                'Value' => '<string>', // REQUIRED
                            ],
                            // ...
                        ],
                    ],
                ],
                'Count' => [
                    'CustomRequestHandling' => [
                        'InsertHeaders' => [ // REQUIRED
                            [
                                'Name' => '<string>', // REQUIRED
                                'Value' => '<string>', // REQUIRED
                            ],
                            // ...
                        ],
                    ],
                ],
            ],
            'CaptchaConfig' => [
                'ImmunityTimeProperty' => [
                    'ImmunityTime' => <integer>, // REQUIRED
                ],
            ],
            'ChallengeConfig' => [
                'ImmunityTimeProperty' => [
                    'ImmunityTime' => <integer>, // REQUIRED
                ],
            ],
            'Name' => '<string>', // REQUIRED
            'OverrideAction' => [
                'Count' => [
                    'CustomRequestHandling' => [
                        'InsertHeaders' => [ // REQUIRED
                            [
                                'Name' => '<string>', // REQUIRED
                                'Value' => '<string>', // REQUIRED
                            ],
                            // ...
                        ],
                    ],
                ],
                'None' => [
                ],
            ],
            'Priority' => <integer>, // REQUIRED
            'RuleLabels' => [
                [
                    'Name' => '<string>', // REQUIRED
                ],
                // ...
            ],
            'Statement' => [ // REQUIRED
                'AndStatement' => [
                    'Statements' => [ // REQUIRED
                        [...], // RECURSIVE
                        // ...
                    ],
                ],
                'ByteMatchStatement' => [
                    'FieldToMatch' => [ // REQUIRED
                        'AllQueryArguments' => [
                        ],
                        'Body' => [
                            'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                        ],
                        'Cookies' => [
                            'MatchPattern' => [ // REQUIRED
                                'All' => [
                                ],
                                'ExcludedCookies' => ['<string>', ...],
                                'IncludedCookies' => ['<string>', ...],
                            ],
                            'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED
                            'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED
                        ],
                        'Headers' => [
                            'MatchPattern' => [ // REQUIRED
                                'All' => [
                                ],
                                'ExcludedHeaders' => ['<string>', ...],
                                'IncludedHeaders' => ['<string>', ...],
                            ],
                            'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED
                            'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED
                        ],
                        'JsonBody' => [
                            'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING',
                            'MatchPattern' => [ // REQUIRED
                                'All' => [
                                ],
                                'IncludedPaths' => ['<string>', ...],
                            ],
                            'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED
                            'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                        ],
                        'Method' => [
                        ],
                        'QueryString' => [
                        ],
                        'SingleHeader' => [
                            'Name' => '<string>', // REQUIRED
                        ],
                        'SingleQueryArgument' => [
                            'Name' => '<string>', // REQUIRED
                        ],
                        'UriPath' => [
                        ],
                    ],
                    'PositionalConstraint' => 'EXACTLY|STARTS_WITH|ENDS_WITH|CONTAINS|CONTAINS_WORD', // REQUIRED
                    'SearchString' => <string || resource || Psr\Http\Message\StreamInterface>, // REQUIRED
                    'TextTransformations' => [ // REQUIRED
                        [
                            'Priority' => <integer>, // REQUIRED
                            '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', // REQUIRED
                        ],
                        // ...
                    ],
                ],
                'GeoMatchStatement' => [
                    'CountryCodes' => ['<string>', ...],
                    'ForwardedIPConfig' => [
                        'FallbackBehavior' => 'MATCH|NO_MATCH', // REQUIRED
                        'HeaderName' => '<string>', // REQUIRED
                    ],
                ],
                'IPSetReferenceStatement' => [
                    'ARN' => '<string>', // REQUIRED
                    'IPSetForwardedIPConfig' => [
                        'FallbackBehavior' => 'MATCH|NO_MATCH', // REQUIRED
                        'HeaderName' => '<string>', // REQUIRED
                        'Position' => 'FIRST|LAST|ANY', // REQUIRED
                    ],
                ],
                'LabelMatchStatement' => [
                    'Key' => '<string>', // REQUIRED
                    'Scope' => 'LABEL|NAMESPACE', // REQUIRED
                ],
                'ManagedRuleGroupStatement' => [
                    'ExcludedRules' => [
                        [
                            'Name' => '<string>', // REQUIRED
                        ],
                        // ...
                    ],
                    'ManagedRuleGroupConfigs' => [
                        [
                            'AWSManagedRulesBotControlRuleSet' => [
                                'InspectionLevel' => 'COMMON|TARGETED', // REQUIRED
                            ],
                            'LoginPath' => '<string>',
                            'PasswordField' => [
                                'Identifier' => '<string>', // REQUIRED
                            ],
                            'PayloadType' => 'JSON|FORM_ENCODED',
                            'UsernameField' => [
                                'Identifier' => '<string>', // REQUIRED
                            ],
                        ],
                        // ...
                    ],
                    'Name' => '<string>', // REQUIRED
                    'RuleActionOverrides' => [
                        [
                            'ActionToUse' => [ // REQUIRED
                                'Allow' => [
                                    'CustomRequestHandling' => [
                                        'InsertHeaders' => [ // REQUIRED
                                            [
                                                'Name' => '<string>', // REQUIRED
                                                'Value' => '<string>', // REQUIRED
                                            ],
                                            // ...
                                        ],
                                    ],
                                ],
                                'Block' => [
                                    'CustomResponse' => [
                                        'CustomResponseBodyKey' => '<string>',
                                        'ResponseCode' => <integer>, // REQUIRED
                                        'ResponseHeaders' => [
                                            [
                                                'Name' => '<string>', // REQUIRED
                                                'Value' => '<string>', // REQUIRED
                                            ],
                                            // ...
                                        ],
                                    ],
                                ],
                                'Captcha' => [
                                    'CustomRequestHandling' => [
                                        'InsertHeaders' => [ // REQUIRED
                                            [
                                                'Name' => '<string>', // REQUIRED
                                                'Value' => '<string>', // REQUIRED
                                            ],
                                            // ...
                                        ],
                                    ],
                                ],
                                'Challenge' => [
                                    'CustomRequestHandling' => [
                                        'InsertHeaders' => [ // REQUIRED
                                            [
                                                'Name' => '<string>', // REQUIRED
                                                'Value' => '<string>', // REQUIRED
                                            ],
                                            // ...
                                        ],
                                    ],
                                ],
                                'Count' => [
                                    'CustomRequestHandling' => [
                                        'InsertHeaders' => [ // REQUIRED
                                            [
                                                'Name' => '<string>', // REQUIRED
                                                'Value' => '<string>', // REQUIRED
                                            ],
                                            // ...
                                        ],
                                    ],
                                ],
                            ],
                            'Name' => '<string>', // REQUIRED
                        ],
                        // ...
                    ],
                    'ScopeDownStatement' => [...], // RECURSIVE
                    'VendorName' => '<string>', // REQUIRED
                    'Version' => '<string>',
                ],
                'NotStatement' => [
                    'Statement' => [...], // REQUIRED, RECURSIVE
                ],
                'OrStatement' => [
                    'Statements' => [ // REQUIRED
                        [...], // RECURSIVE
                        // ...
                    ],
                ],
                'RateBasedStatement' => [
                    'AggregateKeyType' => 'IP|FORWARDED_IP', // REQUIRED
                    'ForwardedIPConfig' => [
                        'FallbackBehavior' => 'MATCH|NO_MATCH', // REQUIRED
                        'HeaderName' => '<string>', // REQUIRED
                    ],
                    'Limit' => <integer>, // REQUIRED
                    'ScopeDownStatement' => [...], // RECURSIVE
                ],
                'RegexMatchStatement' => [
                    'FieldToMatch' => [ // REQUIRED
                        'AllQueryArguments' => [
                        ],
                        'Body' => [
                            'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                        ],
                        'Cookies' => [
                            'MatchPattern' => [ // REQUIRED
                                'All' => [
                                ],
                                'ExcludedCookies' => ['<string>', ...],
                                'IncludedCookies' => ['<string>', ...],
                            ],
                            'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED
                            'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED
                        ],
                        'Headers' => [
                            'MatchPattern' => [ // REQUIRED
                                'All' => [
                                ],
                                'ExcludedHeaders' => ['<string>', ...],
                                'IncludedHeaders' => ['<string>', ...],
                            ],
                            'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED
                            'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED
                        ],
                        'JsonBody' => [
                            'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING',
                            'MatchPattern' => [ // REQUIRED
                                'All' => [
                                ],
                                'IncludedPaths' => ['<string>', ...],
                            ],
                            'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED
                            'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                        ],
                        'Method' => [
                        ],
                        'QueryString' => [
                        ],
                        'SingleHeader' => [
                            'Name' => '<string>', // REQUIRED
                        ],
                        'SingleQueryArgument' => [
                            'Name' => '<string>', // REQUIRED
                        ],
                        'UriPath' => [
                        ],
                    ],
                    'RegexString' => '<string>', // REQUIRED
                    'TextTransformations' => [ // REQUIRED
                        [
                            'Priority' => <integer>, // REQUIRED
                            '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', // REQUIRED
                        ],
                        // ...
                    ],
                ],
                'RegexPatternSetReferenceStatement' => [
                    'ARN' => '<string>', // REQUIRED
                    'FieldToMatch' => [ // REQUIRED
                        'AllQueryArguments' => [
                        ],
                        'Body' => [
                            'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                        ],
                        'Cookies' => [
                            'MatchPattern' => [ // REQUIRED
                                'All' => [
                                ],
                                'ExcludedCookies' => ['<string>', ...],
                                'IncludedCookies' => ['<string>', ...],
                            ],
                            'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED
                            'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED
                        ],
                        'Headers' => [
                            'MatchPattern' => [ // REQUIRED
                                'All' => [
                                ],
                                'ExcludedHeaders' => ['<string>', ...],
                                'IncludedHeaders' => ['<string>', ...],
                            ],
                            'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED
                            'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED
                        ],
                        'JsonBody' => [
                            'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING',
                            'MatchPattern' => [ // REQUIRED
                                'All' => [
                                ],
                                'IncludedPaths' => ['<string>', ...],
                            ],
                            'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED
                            'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                        ],
                        'Method' => [
                        ],
                        'QueryString' => [
                        ],
                        'SingleHeader' => [
                            'Name' => '<string>', // REQUIRED
                        ],
                        'SingleQueryArgument' => [
                            'Name' => '<string>', // REQUIRED
                        ],
                        'UriPath' => [
                        ],
                    ],
                    'TextTransformations' => [ // REQUIRED
                        [
                            'Priority' => <integer>, // REQUIRED
                            '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', // REQUIRED
                        ],
                        // ...
                    ],
                ],
                'RuleGroupReferenceStatement' => [
                    'ARN' => '<string>', // REQUIRED
                    'ExcludedRules' => [
                        [
                            'Name' => '<string>', // REQUIRED
                        ],
                        // ...
                    ],
                    'RuleActionOverrides' => [
                        [
                            'ActionToUse' => [ // REQUIRED
                                'Allow' => [
                                    'CustomRequestHandling' => [
                                        'InsertHeaders' => [ // REQUIRED
                                            [
                                                'Name' => '<string>', // REQUIRED
                                                'Value' => '<string>', // REQUIRED
                                            ],
                                            // ...
                                        ],
                                    ],
                                ],
                                'Block' => [
                                    'CustomResponse' => [
                                        'CustomResponseBodyKey' => '<string>',
                                        'ResponseCode' => <integer>, // REQUIRED
                                        'ResponseHeaders' => [
                                            [
                                                'Name' => '<string>', // REQUIRED
                                                'Value' => '<string>', // REQUIRED
                                            ],
                                            // ...
                                        ],
                                    ],
                                ],
                                'Captcha' => [
                                    'CustomRequestHandling' => [
                                        'InsertHeaders' => [ // REQUIRED
                                            [
                                                'Name' => '<string>', // REQUIRED
                                                'Value' => '<string>', // REQUIRED
                                            ],
                                            // ...
                                        ],
                                    ],
                                ],
                                'Challenge' => [
                                    'CustomRequestHandling' => [
                                        'InsertHeaders' => [ // REQUIRED
                                            [
                                                'Name' => '<string>', // REQUIRED
                                                'Value' => '<string>', // REQUIRED
                                            ],
                                            // ...
                                        ],
                                    ],
                                ],
                                'Count' => [
                                    'CustomRequestHandling' => [
                                        'InsertHeaders' => [ // REQUIRED
                                            [
                                                'Name' => '<string>', // REQUIRED
                                                'Value' => '<string>', // REQUIRED
                                            ],
                                            // ...
                                        ],
                                    ],
                                ],
                            ],
                            'Name' => '<string>', // REQUIRED
                        ],
                        // ...
                    ],
                ],
                'SizeConstraintStatement' => [
                    'ComparisonOperator' => 'EQ|NE|LE|LT|GE|GT', // REQUIRED
                    'FieldToMatch' => [ // REQUIRED
                        'AllQueryArguments' => [
                        ],
                        'Body' => [
                            'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                        ],
                        'Cookies' => [
                            'MatchPattern' => [ // REQUIRED
                                'All' => [
                                ],
                                'ExcludedCookies' => ['<string>', ...],
                                'IncludedCookies' => ['<string>', ...],
                            ],
                            'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED
                            'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED
                        ],
                        'Headers' => [
                            'MatchPattern' => [ // REQUIRED
                                'All' => [
                                ],
                                'ExcludedHeaders' => ['<string>', ...],
                                'IncludedHeaders' => ['<string>', ...],
                            ],
                            'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED
                            'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED
                        ],
                        'JsonBody' => [
                            'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING',
                            'MatchPattern' => [ // REQUIRED
                                'All' => [
                                ],
                                'IncludedPaths' => ['<string>', ...],
                            ],
                            'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED
                            'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                        ],
                        'Method' => [
                        ],
                        'QueryString' => [
                        ],
                        'SingleHeader' => [
                            'Name' => '<string>', // REQUIRED
                        ],
                        'SingleQueryArgument' => [
                            'Name' => '<string>', // REQUIRED
                        ],
                        'UriPath' => [
                        ],
                    ],
                    'Size' => <integer>, // REQUIRED
                    'TextTransformations' => [ // REQUIRED
                        [
                            'Priority' => <integer>, // REQUIRED
                            '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', // REQUIRED
                        ],
                        // ...
                    ],
                ],
                'SqliMatchStatement' => [
                    'FieldToMatch' => [ // REQUIRED
                        'AllQueryArguments' => [
                        ],
                        'Body' => [
                            'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                        ],
                        'Cookies' => [
                            'MatchPattern' => [ // REQUIRED
                                'All' => [
                                ],
                                'ExcludedCookies' => ['<string>', ...],
                                'IncludedCookies' => ['<string>', ...],
                            ],
                            'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED
                            'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED
                        ],
                        'Headers' => [
                            'MatchPattern' => [ // REQUIRED
                                'All' => [
                                ],
                                'ExcludedHeaders' => ['<string>', ...],
                                'IncludedHeaders' => ['<string>', ...],
                            ],
                            'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED
                            'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED
                        ],
                        'JsonBody' => [
                            'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING',
                            'MatchPattern' => [ // REQUIRED
                                'All' => [
                                ],
                                'IncludedPaths' => ['<string>', ...],
                            ],
                            'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED
                            'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                        ],
                        'Method' => [
                        ],
                        'QueryString' => [
                        ],
                        'SingleHeader' => [
                            'Name' => '<string>', // REQUIRED
                        ],
                        'SingleQueryArgument' => [
                            'Name' => '<string>', // REQUIRED
                        ],
                        'UriPath' => [
                        ],
                    ],
                    'SensitivityLevel' => 'LOW|HIGH',
                    'TextTransformations' => [ // REQUIRED
                        [
                            'Priority' => <integer>, // REQUIRED
                            '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', // REQUIRED
                        ],
                        // ...
                    ],
                ],
                'XssMatchStatement' => [
                    'FieldToMatch' => [ // REQUIRED
                        'AllQueryArguments' => [
                        ],
                        'Body' => [
                            'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                        ],
                        'Cookies' => [
                            'MatchPattern' => [ // REQUIRED
                                'All' => [
                                ],
                                'ExcludedCookies' => ['<string>', ...],
                                'IncludedCookies' => ['<string>', ...],
                            ],
                            'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED
                            'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED
                        ],
                        'Headers' => [
                            'MatchPattern' => [ // REQUIRED
                                'All' => [
                                ],
                                'ExcludedHeaders' => ['<string>', ...],
                                'IncludedHeaders' => ['<string>', ...],
                            ],
                            'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED
                            'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED
                        ],
                        'JsonBody' => [
                            'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING',
                            'MatchPattern' => [ // REQUIRED
                                'All' => [
                                ],
                                'IncludedPaths' => ['<string>', ...],
                            ],
                            'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED
                            'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                        ],
                        'Method' => [
                        ],
                        'QueryString' => [
                        ],
                        'SingleHeader' => [
                            'Name' => '<string>', // REQUIRED
                        ],
                        'SingleQueryArgument' => [
                            'Name' => '<string>', // REQUIRED
                        ],
                        'UriPath' => [
                        ],
                    ],
                    'TextTransformations' => [ // REQUIRED
                        [
                            'Priority' => <integer>, // REQUIRED
                            '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', // REQUIRED
                        ],
                        // ...
                    ],
                ],
            ],
            'VisibilityConfig' => [ // REQUIRED
                'CloudWatchMetricsEnabled' => true || false, // REQUIRED
                'MetricName' => '<string>', // REQUIRED
                'SampledRequestsEnabled' => true || false, // REQUIRED
            ],
        ],
        // ...
    ],
    'Scope' => 'CLOUDFRONT|REGIONAL', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Capacity' => <integer>,
]

Result Details

Errors

• WAFInternalErrorException:

  Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.

• WAFInvalidParameterException:

  The operation failed because WAF didn't recognize a parameter in the request. For example:

  • You specified a parameter name or value that isn't valid.

  • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

  • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

  • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated.

• WAFNonexistentItemException:

  WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.

• WAFLimitsExceededException:

  WAF couldn’t perform the operation because you exceeded your resource limit. For example, the maximum number of WebACL objects that you can create for an Amazon Web Services account. For more information, see WAF quotas in the WAF Developer Guide.

• WAFInvalidResourceException:

  WAF couldn’t perform the operation because the resource that you requested isn’t valid. Check the resource, and try again.

• WAFUnavailableEntityException:

  WAF couldn’t retrieve a resource that you specified for this operation. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate. Verify the resources that you are specifying in your request parameters and then retry the operation.

• WAFSubscriptionNotFoundException:

  You tried to use a managed rule group that's available by subscription, but you aren't subscribed to it yet.

• WAFExpiredManagedRuleGroupVersionException:

  The operation failed because the specified version for the managed rule group has expired. You can retrieve the available versions for the managed rule group by calling ListAvailableManagedRuleGroupVersions.

• WAFInvalidOperationException:

  The operation isn't valid.

CreateIPSet

$result = $client->createIPSet([/* ... */]);
$promise = $client->createIPSetAsync([/* ... */]);

Parameter Syntax

$result = $client->createIPSet([
    'Addresses' => ['<string>', ...], // REQUIRED
    'Description' => '<string>',
    'IPAddressVersion' => 'IPV4|IPV6', // REQUIRED
    'Name' => '<string>', // REQUIRED
    'Scope' => 'CLOUDFRONT|REGIONAL', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'Summary' => [
        'ARN' => '<string>',
        'Description' => '<string>',
        'Id' => '<string>',
        'LockToken' => '<string>',
        'Name' => '<string>',
    ],
]

Result Details

Errors

• WAFInternalErrorException:

  Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.

• WAFInvalidParameterException:

  The operation failed because WAF didn't recognize a parameter in the request. For example:

  • You specified a parameter name or value that isn't valid.

  • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

  • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

  • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated.

• WAFDuplicateItemException:

  WAF couldn’t perform the operation because the resource that you tried to save is a duplicate of an existing one.

• WAFOptimisticLockException:

  WAF couldn’t save your changes because you tried to update or delete a resource that has changed since you last retrieved it. Get the resource again, make any changes you need to make to the new copy, and retry your operation.

• WAFLimitsExceededException:

  WAF couldn’t perform the operation because you exceeded your resource limit. For example, the maximum number of WebACL objects that you can create for an Amazon Web Services account. For more information, see WAF quotas in the WAF Developer Guide.

• WAFTagOperationException:

  An error occurred during the tagging operation. Retry your request.

• WAFTagOperationInternalErrorException:

  WAF couldn’t perform your tagging operation because of an internal error. Retry your request.

• WAFInvalidOperationException:

  The operation isn't valid.

CreateRegexPatternSet

$result = $client->createRegexPatternSet([/* ... */]);
$promise = $client->createRegexPatternSetAsync([/* ... */]);

Parameter Syntax

$result = $client->createRegexPatternSet([
    'Description' => '<string>',
    'Name' => '<string>', // REQUIRED
    'RegularExpressionList' => [ // REQUIRED
        [
            'RegexString' => '<string>',
        ],
        // ...
    ],
    'Scope' => 'CLOUDFRONT|REGIONAL', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'Summary' => [
        'ARN' => '<string>',
        'Description' => '<string>',
        'Id' => '<string>',
        'LockToken' => '<string>',
        'Name' => '<string>',
    ],
]

Result Details

Errors

• WAFInternalErrorException:

  Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.

• WAFInvalidParameterException:

  The operation failed because WAF didn't recognize a parameter in the request. For example:

  • You specified a parameter name or value that isn't valid.

  • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

  • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

  • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated.

• WAFDuplicateItemException:

  WAF couldn’t perform the operation because the resource that you tried to save is a duplicate of an existing one.

• WAFOptimisticLockException:

  WAF couldn’t save your changes because you tried to update or delete a resource that has changed since you last retrieved it. Get the resource again, make any changes you need to make to the new copy, and retry your operation.

• WAFLimitsExceededException:

  WAF couldn’t perform the operation because you exceeded your resource limit. For example, the maximum number of WebACL objects that you can create for an Amazon Web Services account. For more information, see WAF quotas in the WAF Developer Guide.

• WAFTagOperationException:

  An error occurred during the tagging operation. Retry your request.

• WAFTagOperationInternalErrorException:

  WAF couldn’t perform your tagging operation because of an internal error. Retry your request.

• WAFInvalidOperationException:

  The operation isn't valid.

CreateRuleGroup

$result = $client->createRuleGroup([/* ... */]);
$promise = $client->createRuleGroupAsync([/* ... */]);

Parameter Syntax

$result = $client->createRuleGroup([
    'Capacity' => <integer>, // REQUIRED
    'CustomResponseBodies' => [
        '<EntityName>' => [
            'Content' => '<string>', // REQUIRED
            'ContentType' => 'TEXT_PLAIN|TEXT_HTML|APPLICATION_JSON', // REQUIRED
        ],
        // ...
    ],
    'Description' => '<string>',
    'Name' => '<string>', // REQUIRED
    'Rules' => [
        [
            'Action' => [
                'Allow' => [
                    'CustomRequestHandling' => [
                        'InsertHeaders' => [ // REQUIRED
                            [
                                'Name' => '<string>', // REQUIRED
                                'Value' => '<string>', // REQUIRED
                            ],
                            // ...
                        ],
                    ],
                ],
                'Block' => [
                    'CustomResponse' => [
                        'CustomResponseBodyKey' => '<string>',
                        'ResponseCode' => <integer>, // REQUIRED
                        'ResponseHeaders' => [
                            [
                                'Name' => '<string>', // REQUIRED
                                'Value' => '<string>', // REQUIRED
                            ],
                            // ...
                        ],
                    ],
                ],
                'Captcha' => [
                    'CustomRequestHandling' => [
                        'InsertHeaders' => [ // REQUIRED
                            [
                                'Name' => '<string>', // REQUIRED
                                'Value' => '<string>', // REQUIRED
                            ],
                            // ...
                        ],
                    ],
                ],
                'Challenge' => [
                    'CustomRequestHandling' => [
                        'InsertHeaders' => [ // REQUIRED
                            [
                                'Name' => '<string>', // REQUIRED
                                'Value' => '<string>', // REQUIRED
                            ],
                            // ...
                        ],
                    ],
                ],
                'Count' => [
                    'CustomRequestHandling' => [
                        'InsertHeaders' => [ // REQUIRED
                            [
                                'Name' => '<string>', // REQUIRED
                                'Value' => '<string>', // REQUIRED
                            ],
                            // ...
                        ],
                    ],
                ],
            ],
            'CaptchaConfig' => [
                'ImmunityTimeProperty' => [
                    'ImmunityTime' => <integer>, // REQUIRED
                ],
            ],
            'ChallengeConfig' => [
                'ImmunityTimeProperty' => [
                    'ImmunityTime' => <integer>, // REQUIRED
                ],
            ],
            'Name' => '<string>', // REQUIRED
            'OverrideAction' => [
                'Count' => [
                    'CustomRequestHandling' => [
                        'InsertHeaders' => [ // REQUIRED
                            [
                                'Name' => '<string>', // REQUIRED
                                'Value' => '<string>', // REQUIRED
                            ],
                            // ...
                        ],
                    ],
                ],
                'None' => [
                ],
            ],
            'Priority' => <integer>, // REQUIRED
            'RuleLabels' => [
                [
                    'Name' => '<string>', // REQUIRED
                ],
                // ...
            ],
            'Statement' => [ // REQUIRED
                'AndStatement' => [
                    'Statements' => [ // REQUIRED
                        [...], // RECURSIVE
                        // ...
                    ],
                ],
                'ByteMatchStatement' => [
                    'FieldToMatch' => [ // REQUIRED
                        'AllQueryArguments' => [
                        ],
                        'Body' => [
                            'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                        ],
                        'Cookies' => [
                            'MatchPattern' => [ // REQUIRED
                                'All' => [
                                ],
                                'ExcludedCookies' => ['<string>', ...],
                                'IncludedCookies' => ['<string>', ...],
                            ],
                            'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED
                            'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED
                        ],
                        'Headers' => [
                            'MatchPattern' => [ // REQUIRED
                                'All' => [
                                ],
                                'ExcludedHeaders' => ['<string>', ...],
                                'IncludedHeaders' => ['<string>', ...],
                            ],
                            'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED
                            'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED
                        ],
                        'JsonBody' => [
                            'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING',
                            'MatchPattern' => [ // REQUIRED
                                'All' => [
                                ],
                                'IncludedPaths' => ['<string>', ...],
                            ],
                            'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED
                            'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                        ],
                        'Method' => [
                        ],
                        'QueryString' => [
                        ],
                        'SingleHeader' => [
                            'Name' => '<string>', // REQUIRED
                        ],
                        'SingleQueryArgument' => [
                            'Name' => '<string>', // REQUIRED
                        ],
                        'UriPath' => [
                        ],
                    ],
                    'PositionalConstraint' => 'EXACTLY|STARTS_WITH|ENDS_WITH|CONTAINS|CONTAINS_WORD', // REQUIRED
                    'SearchString' => <string || resource || Psr\Http\Message\StreamInterface>, // REQUIRED
                    'TextTransformations' => [ // REQUIRED
                        [
                            'Priority' => <integer>, // REQUIRED
                            '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', // REQUIRED
                        ],
                        // ...
                    ],
                ],
                'GeoMatchStatement' => [
                    'CountryCodes' => ['<string>', ...],
                    'ForwardedIPConfig' => [
                        'FallbackBehavior' => 'MATCH|NO_MATCH', // REQUIRED
                        'HeaderName' => '<string>', // REQUIRED
                    ],
                ],
                'IPSetReferenceStatement' => [
                    'ARN' => '<string>', // REQUIRED
                    'IPSetForwardedIPConfig' => [
                        'FallbackBehavior' => 'MATCH|NO_MATCH', // REQUIRED
                        'HeaderName' => '<string>', // REQUIRED
                        'Position' => 'FIRST|LAST|ANY', // REQUIRED
                    ],
                ],
                'LabelMatchStatement' => [
                    'Key' => '<string>', // REQUIRED
                    'Scope' => 'LABEL|NAMESPACE', // REQUIRED
                ],
                'ManagedRuleGroupStatement' => [
                    'ExcludedRules' => [
                        [
                            'Name' => '<string>', // REQUIRED
                        ],
                        // ...
                    ],
                    'ManagedRuleGroupConfigs' => [
                        [
                            'AWSManagedRulesBotControlRuleSet' => [
                                'InspectionLevel' => 'COMMON|TARGETED', // REQUIRED
                            ],
                            'LoginPath' => '<string>',
                            'PasswordField' => [
                                'Identifier' => '<string>', // REQUIRED
                            ],
                            'PayloadType' => 'JSON|FORM_ENCODED',
                            'UsernameField' => [
                                'Identifier' => '<string>', // REQUIRED
                            ],
                        ],
                        // ...
                    ],
                    'Name' => '<string>', // REQUIRED
                    'RuleActionOverrides' => [
                        [
                            'ActionToUse' => [ // REQUIRED
                                'Allow' => [
                                    'CustomRequestHandling' => [
                                        'InsertHeaders' => [ // REQUIRED
                                            [
                                                'Name' => '<string>', // REQUIRED
                                                'Value' => '<string>', // REQUIRED
                                            ],
                                            // ...
                                        ],
                                    ],
                                ],
                                'Block' => [
                                    'CustomResponse' => [
                                        'CustomResponseBodyKey' => '<string>',
                                        'ResponseCode' => <integer>, // REQUIRED
                                        'ResponseHeaders' => [
                                            [
                                                'Name' => '<string>', // REQUIRED
                                                'Value' => '<string>', // REQUIRED
                                            ],
                                            // ...
                                        ],
                                    ],
                                ],
                                'Captcha' => [
                                    'CustomRequestHandling' => [
                                        'InsertHeaders' => [ // REQUIRED
                                            [
                                                'Name' => '<string>', // REQUIRED
                                                'Value' => '<string>', // REQUIRED
                                            ],
                                            // ...
                                        ],
                                    ],
                                ],
                                'Challenge' => [
                                    'CustomRequestHandling' => [
                                        'InsertHeaders' => [ // REQUIRED
                                            [
                                                'Name' => '<string>', // REQUIRED
                                                'Value' => '<string>', // REQUIRED
                                            ],
                                            // ...
                                        ],
                                    ],
                                ],
                                'Count' => [
                                    'CustomRequestHandling' => [
                                        'InsertHeaders' => [ // REQUIRED
                                            [
                                                'Name' => '<string>', // REQUIRED
                                                'Value' => '<string>', // REQUIRED
                                            ],
                                            // ...
                                        ],
                                    ],
                                ],
                            ],
                            'Name' => '<string>', // REQUIRED
                        ],
                        // ...
                    ],
                    'ScopeDownStatement' => [...], // RECURSIVE
                    'VendorName' => '<string>', // REQUIRED
                    'Version' => '<string>',
                ],
                'NotStatement' => [
                    'Statement' => [...], // REQUIRED, RECURSIVE
                ],
                'OrStatement' => [
                    'Statements' => [ // REQUIRED
                        [...], // RECURSIVE
                        // ...
                    ],
                ],
                'RateBasedStatement' => [
                    'AggregateKeyType' => 'IP|FORWARDED_IP', // REQUIRED
                    'ForwardedIPConfig' => [
                        'FallbackBehavior' => 'MATCH|NO_MATCH', // REQUIRED
                        'HeaderName' => '<string>', // REQUIRED
                    ],
                    'Limit' => <integer>, // REQUIRED
                    'ScopeDownStatement' => [...], // RECURSIVE
                ],
                'RegexMatchStatement' => [
                    'FieldToMatch' => [ // REQUIRED
                        'AllQueryArguments' => [
                        ],
                        'Body' => [
                            'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                        ],
                        'Cookies' => [
                            'MatchPattern' => [ // REQUIRED
                                'All' => [
                                ],
                                'ExcludedCookies' => ['<string>', ...],
                                'IncludedCookies' => ['<string>', ...],
                            ],
                            'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED
                            'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED
                        ],
                        'Headers' => [
                            'MatchPattern' => [ // REQUIRED
                                'All' => [
                                ],
                                'ExcludedHeaders' => ['<string>', ...],
                                'IncludedHeaders' => ['<string>', ...],
                            ],
                            'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED
                            'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED
                        ],
                        'JsonBody' => [
                            'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING',
                            'MatchPattern' => [ // REQUIRED
                                'All' => [
                                ],
                                'IncludedPaths' => ['<string>', ...],
                            ],
                            'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED
                            'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                        ],
                        'Method' => [
                        ],
                        'QueryString' => [
                        ],
                        'SingleHeader' => [
                            'Name' => '<string>', // REQUIRED
                        ],
                        'SingleQueryArgument' => [
                            'Name' => '<string>', // REQUIRED
                        ],
                        'UriPath' => [
                        ],
                    ],
                    'RegexString' => '<string>', // REQUIRED
                    'TextTransformations' => [ // REQUIRED
                        [
                            'Priority' => <integer>, // REQUIRED
                            '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', // REQUIRED
                        ],
                        // ...
                    ],
                ],
                'RegexPatternSetReferenceStatement' => [
                    'ARN' => '<string>', // REQUIRED
                    'FieldToMatch' => [ // REQUIRED
                        'AllQueryArguments' => [
                        ],
                        'Body' => [
                            'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                        ],
                        'Cookies' => [
                            'MatchPattern' => [ // REQUIRED
                                'All' => [
                                ],
                                'ExcludedCookies' => ['<string>', ...],
                                'IncludedCookies' => ['<string>', ...],
                            ],
                            'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED
                            'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED
                        ],
                        'Headers' => [
                            'MatchPattern' => [ // REQUIRED
                                'All' => [
                                ],
                                'ExcludedHeaders' => ['<string>', ...],
                                'IncludedHeaders' => ['<string>', ...],
                            ],
                            'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED
                            'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED
                        ],
                        'JsonBody' => [
                            'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING',
                            'MatchPattern' => [ // REQUIRED
                                'All' => [
                                ],
                                'IncludedPaths' => ['<string>', ...],
                            ],
                            'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED
                            'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                        ],
                        'Method' => [
                        ],
                        'QueryString' => [
                        ],
                        'SingleHeader' => [
                            'Name' => '<string>', // REQUIRED
                        ],
                        'SingleQueryArgument' => [
                            'Name' => '<string>', // REQUIRED
                        ],
                        'UriPath' => [
                        ],
                    ],
                    'TextTransformations' => [ // REQUIRED
                        [
                            'Priority' => <integer>, // REQUIRED
                            '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', // REQUIRED
                        ],
                        // ...
                    ],
                ],
                'RuleGroupReferenceStatement' => [
                    'ARN' => '<string>', // REQUIRED
                    'ExcludedRules' => [
                        [
                            'Name' => '<string>', // REQUIRED
                        ],
                        // ...
                    ],
                    'RuleActionOverrides' => [
                        [
                            'ActionToUse' => [ // REQUIRED
                                'Allow' => [
                                    'CustomRequestHandling' => [
                                        'InsertHeaders' => [ // REQUIRED
                                            [
                                                'Name' => '<string>', // REQUIRED
                                                'Value' => '<string>', // REQUIRED
                                            ],
                                            // ...
                                        ],
                                    ],
                                ],
                                'Block' => [
                                    'CustomResponse' => [
                                        'CustomResponseBodyKey' => '<string>',
                                        'ResponseCode' => <integer>, // REQUIRED
                                        'ResponseHeaders' => [
                                            [
                                                'Name' => '<string>', // REQUIRED
                                                'Value' => '<string>', // REQUIRED
                                            ],
                                            // ...
                                        ],
                                    ],
                                ],
                                'Captcha' => [
                                    'CustomRequestHandling' => [
                                        'InsertHeaders' => [ // REQUIRED
                                            [
                                                'Name' => '<string>', // REQUIRED
                                                'Value' => '<string>', // REQUIRED
                                            ],
                                            // ...
                                        ],
                                    ],
                                ],
                                'Challenge' => [
                                    'CustomRequestHandling' => [
                                        'InsertHeaders' => [ // REQUIRED
                                            [
                                                'Name' => '<string>', // REQUIRED
                                                'Value' => '<string>', // REQUIRED
                                            ],
                                            // ...
                                        ],
                                    ],
                                ],
                                'Count' => [
                                    'CustomRequestHandling' => [
                                        'InsertHeaders' => [ // REQUIRED
                                            [
                                                'Name' => '<string>', // REQUIRED
                                                'Value' => '<string>', // REQUIRED
                                            ],
                                            // ...
                                        ],
                                    ],
                                ],
                            ],
                            'Name' => '<string>', // REQUIRED
                        ],
                        // ...
                    ],
                ],
                'SizeConstraintStatement' => [
                    'ComparisonOperator' => 'EQ|NE|LE|LT|GE|GT', // REQUIRED
                    'FieldToMatch' => [ // REQUIRED
                        'AllQueryArguments' => [
                        ],
                        'Body' => [
                            'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                        ],
                        'Cookies' => [
                            'MatchPattern' => [ // REQUIRED
                                'All' => [
                                ],
                                'ExcludedCookies' => ['<string>', ...],
                                'IncludedCookies' => ['<string>', ...],
                            ],
                            'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED
                            'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED
                        ],
                        'Headers' => [
                            'MatchPattern' => [ // REQUIRED
                                'All' => [
                                ],
                                'ExcludedHeaders' => ['<string>', ...],
                                'IncludedHeaders' => ['<string>', ...],
                            ],
                            'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED
                            'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED
                        ],
                        'JsonBody' => [
                            'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING',
                            'MatchPattern' => [ // REQUIRED
                                'All' => [
                                ],
                                'IncludedPaths' => ['<string>', ...],
                            ],
                            'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED
                            'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                        ],
                        'Method' => [
                        ],
                        'QueryString' => [
                        ],
                        'SingleHeader' => [
                            'Name' => '<string>', // REQUIRED
                        ],
                        'SingleQueryArgument' => [
                            'Name' => '<string>', // REQUIRED
                        ],
                        'UriPath' => [
                        ],
                    ],
                    'Size' => <integer>, // REQUIRED
                    'TextTransformations' => [ // REQUIRED
                        [
                            'Priority' => <integer>, // REQUIRED
                            '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', // REQUIRED
                        ],
                        // ...
                    ],
                ],
                'SqliMatchStatement' => [
                    'FieldToMatch' => [ // REQUIRED
                        'AllQueryArguments' => [
                        ],
                        'Body' => [
                            'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                        ],
                        'Cookies' => [
                            'MatchPattern' => [ // REQUIRED
                                'All' => [
                                ],
                                'ExcludedCookies' => ['<string>', ...],
                                'IncludedCookies' => ['<string>', ...],
                            ],
                            'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED
                            'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED
                        ],
                        'Headers' => [
                            'MatchPattern' => [ // REQUIRED
                                'All' => [
                                ],
                                'ExcludedHeaders' => ['<string>', ...],
                                'IncludedHeaders' => ['<string>', ...],
                            ],
                            'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED
                            'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED
                        ],
                        'JsonBody' => [
                            'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING',
                            'MatchPattern' => [ // REQUIRED
                                'All' => [
                                ],
                                'IncludedPaths' => ['<string>', ...],
                            ],
                            'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED
                            'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                        ],
                        'Method' => [
                        ],
                        'QueryString' => [
                        ],
                        'SingleHeader' => [
                            'Name' => '<string>', // REQUIRED
                        ],
                        'SingleQueryArgument' => [
                            'Name' => '<string>', // REQUIRED
                        ],
                        'UriPath' => [
                        ],
                    ],
                    'SensitivityLevel' => 'LOW|HIGH',
                    'TextTransformations' => [ // REQUIRED
                        [
                            'Priority' => <integer>, // REQUIRED
                            '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', // REQUIRED
                        ],
                        // ...
                    ],
                ],
                'XssMatchStatement' => [
                    'FieldToMatch' => [ // REQUIRED
                        'AllQueryArguments' => [
                        ],
                        'Body' => [
                            'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                        ],
                        'Cookies' => [
                            'MatchPattern' => [ // REQUIRED
                                'All' => [
                                ],
                                'ExcludedCookies' => ['<string>', ...],
                                'IncludedCookies' => ['<string>', ...],
                            ],
                            'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED
                            'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED
                        ],
                        'Headers' => [
                            'MatchPattern' => [ // REQUIRED
                                'All' => [
                                ],
                                'ExcludedHeaders' => ['<string>', ...],
                                'IncludedHeaders' => ['<string>', ...],
                            ],
                            'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED
                            'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED
                        ],
                        'JsonBody' => [
                            'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING',
                            'MatchPattern' => [ // REQUIRED
                                'All' => [
                                ],
                                'IncludedPaths' => ['<string>', ...],
                            ],
                            'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED
                            'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                        ],
                        'Method' => [
                        ],
                        'QueryString' => [
                        ],
                        'SingleHeader' => [
                            'Name' => '<string>', // REQUIRED
                        ],
                        'SingleQueryArgument' => [
                            'Name' => '<string>', // REQUIRED
                        ],
                        'UriPath' => [
                        ],
                    ],
                    'TextTransformations' => [ // REQUIRED
                        [
                            'Priority' => <integer>, // REQUIRED
                            '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', // REQUIRED
                        ],
                        // ...
                    ],
                ],
            ],
            'VisibilityConfig' => [ // REQUIRED
                'CloudWatchMetricsEnabled' => true || false, // REQUIRED
                'MetricName' => '<string>', // REQUIRED
                'SampledRequestsEnabled' => true || false, // REQUIRED
            ],
        ],
        // ...
    ],
    'Scope' => 'CLOUDFRONT|REGIONAL', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'VisibilityConfig' => [ // REQUIRED
        'CloudWatchMetricsEnabled' => true || false, // REQUIRED
        'MetricName' => '<string>', // REQUIRED
        'SampledRequestsEnabled' => true || false, // REQUIRED
    ],
]);

Parameter Details

Result Syntax

[
    'Summary' => [
        'ARN' => '<string>',
        'Description' => '<string>',
        'Id' => '<string>',
        'LockToken' => '<string>',
        'Name' => '<string>',
    ],
]

Result Details

Errors

• WAFInternalErrorException:

  Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.

• WAFInvalidParameterException:

  The operation failed because WAF didn't recognize a parameter in the request. For example:

  • You specified a parameter name or value that isn't valid.

  • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

  • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

  • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated.

• WAFDuplicateItemException:

  WAF couldn’t perform the operation because the resource that you tried to save is a duplicate of an existing one.

• WAFOptimisticLockException:

  WAF couldn’t save your changes because you tried to update or delete a resource that has changed since you last retrieved it. Get the resource again, make any changes you need to make to the new copy, and retry your operation.

• WAFLimitsExceededException:

  WAF couldn’t perform the operation because you exceeded your resource limit. For example, the maximum number of WebACL objects that you can create for an Amazon Web Services account. For more information, see WAF quotas in the WAF Developer Guide.

• WAFUnavailableEntityException:

  WAF couldn’t retrieve a resource that you specified for this operation. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate. Verify the resources that you are specifying in your request parameters and then retry the operation.

• WAFTagOperationException:

  An error occurred during the tagging operation. Retry your request.

• WAFTagOperationInternalErrorException:

  WAF couldn’t perform your tagging operation because of an internal error. Retry your request.

• WAFSubscriptionNotFoundException:

  You tried to use a managed rule group that's available by subscription, but you aren't subscribed to it yet.

• WAFNonexistentItemException:

  WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.

• WAFInvalidOperationException:

  The operation isn't valid.

CreateWebACL

$result = $client->createWebACL([/* ... */]);
$promise = $client->createWebACLAsync([/* ... */]);

Parameter Syntax

$result = $client->createWebACL([
    'CaptchaConfig' => [
        'ImmunityTimeProperty' => [
            'ImmunityTime' => <integer>, // REQUIRED
        ],
    ],
    'ChallengeConfig' => [
        'ImmunityTimeProperty' => [
            'ImmunityTime' => <integer>, // REQUIRED
        ],
    ],
    'CustomResponseBodies' => [
        '<EntityName>' => [
            'Content' => '<string>', // REQUIRED
            'ContentType' => 'TEXT_PLAIN|TEXT_HTML|APPLICATION_JSON', // REQUIRED
        ],
        // ...
    ],
    'DefaultAction' => [ // REQUIRED
        'Allow' => [
            'CustomRequestHandling' => [
                'InsertHeaders' => [ // REQUIRED
                    [
                        'Name' => '<string>', // REQUIRED
                        'Value' => '<string>', // REQUIRED
                    ],
                    // ...
                ],
            ],
        ],
        'Block' => [
            'CustomResponse' => [
                'CustomResponseBodyKey' => '<string>',
                'ResponseCode' => <integer>, // REQUIRED
                'ResponseHeaders' => [
                    [
                        'Name' => '<string>', // REQUIRED
                        'Value' => '<string>', // REQUIRED
                    ],
                    // ...
                ],
            ],
        ],
    ],
    'Description' => '<string>',
    'Name' => '<string>', // REQUIRED
    'Rules' => [
        [
            'Action' => [
                'Allow' => [
                    'CustomRequestHandling' => [
                        'InsertHeaders' => [ // REQUIRED
                            [
                                'Name' => '<string>', // REQUIRED
                                'Value' => '<string>', // REQUIRED
                            ],
                            // ...
                        ],
                    ],
                ],
                'Block' => [
                    'CustomResponse' => [
                        'CustomResponseBodyKey' => '<string>',
                        'ResponseCode' => <integer>, // REQUIRED
                        'ResponseHeaders' => [
                            [
                                'Name' => '<string>', // REQUIRED
                                'Value' => '<string>', // REQUIRED
                            ],
                            // ...
                        ],
                    ],
                ],
                'Captcha' => [
                    'CustomRequestHandling' => [
                        'InsertHeaders' => [ // REQUIRED
                            [
                                'Name' => '<string>', // REQUIRED
                                'Value' => '<string>', // REQUIRED
                            ],
                            // ...
                        ],
                    ],
                ],
                'Challenge' => [
                    'CustomRequestHandling' => [
                        'InsertHeaders' => [ // REQUIRED
                            [
                                'Name' => '<string>', // REQUIRED
                                'Value' => '<string>', // REQUIRED
                            ],
                            // ...
                        ],
                    ],
                ],
                'Count' => [
                    'CustomRequestHandling' => [
                        'InsertHeaders' => [ // REQUIRED
                            [
                                'Name' => '<string>', // REQUIRED
                                'Value' => '<string>', // REQUIRED
                            ],
                            // ...
                        ],
                    ],
                ],
            ],
            'CaptchaConfig' => [
                'ImmunityTimeProperty' => [
                    'ImmunityTime' => <integer>, // REQUIRED
                ],
            ],
            'ChallengeConfig' => [
                'ImmunityTimeProperty' => [
                    'ImmunityTime' => <integer>, // REQUIRED
                ],
            ],
            'Name' => '<string>', // REQUIRED
            'OverrideAction' => [
                'Count' => [
                    'CustomRequestHandling' => [
                        'InsertHeaders' => [ // REQUIRED
                            [
                                'Name' => '<string>', // REQUIRED
                                'Value' => '<string>', // REQUIRED
                            ],
                            // ...
                        ],
                    ],
                ],
                'None' => [
                ],
            ],
            'Priority' => <integer>, // REQUIRED
            'RuleLabels' => [
                [
                    'Name' => '<string>', // REQUIRED
                ],
                // ...
            ],
            'Statement' => [ // REQUIRED
                'AndStatement' => [
                    'Statements' => [ // REQUIRED
                        [...], // RECURSIVE
                        // ...
                    ],
                ],
                'ByteMatchStatement' => [
                    'FieldToMatch' => [ // REQUIRED
                        'AllQueryArguments' => [
                        ],
                        'Body' => [
                            'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                        ],
                        'Cookies' => [
                            'MatchPattern' => [ // REQUIRED
                                'All' => [
                                ],
                                'ExcludedCookies' => ['<string>', ...],
                                'IncludedCookies' => ['<string>', ...],
                            ],
                            'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED
                            'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED
                        ],
                        'Headers' => [
                            'MatchPattern' => [ // REQUIRED
                                'All' => [
                                ],
                                'ExcludedHeaders' => ['<string>', ...],
                                'IncludedHeaders' => ['<string>', ...],
                            ],
                            'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED
                            'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED
                        ],
                        'JsonBody' => [
                            'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING',
                            'MatchPattern' => [ // REQUIRED
                                'All' => [
                                ],
                                'IncludedPaths' => ['<string>', ...],
                            ],
                            'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED
                            'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                        ],
                        'Method' => [
                        ],
                        'QueryString' => [
                        ],
                        'SingleHeader' => [
                            'Name' => '<string>', // REQUIRED
                        ],
                        'SingleQueryArgument' => [
                            'Name' => '<string>', // REQUIRED
                        ],
                        'UriPath' => [
                        ],
                    ],
                    'PositionalConstraint' => 'EXACTLY|STARTS_WITH|ENDS_WITH|CONTAINS|CONTAINS_WORD', // REQUIRED
                    'SearchString' => <string || resource || Psr\Http\Message\StreamInterface>, // REQUIRED
                    'TextTransformations' => [ // REQUIRED
                        [
                            'Priority' => <integer>, // REQUIRED
                            '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', // REQUIRED
                        ],
                        // ...
                    ],
                ],
                'GeoMatchStatement' => [
                    'CountryCodes' => ['<string>', ...],
                    'ForwardedIPConfig' => [
                        'FallbackBehavior' => 'MATCH|NO_MATCH', // REQUIRED
                        'HeaderName' => '<string>', // REQUIRED
                    ],
                ],
                'IPSetReferenceStatement' => [
                    'ARN' => '<string>', // REQUIRED
                    'IPSetForwardedIPConfig' => [
                        'FallbackBehavior' => 'MATCH|NO_MATCH', // REQUIRED
                        'HeaderName' => '<string>', // REQUIRED
                        'Position' => 'FIRST|LAST|ANY', // REQUIRED
                    ],
                ],
                'LabelMatchStatement' => [
                    'Key' => '<string>', // REQUIRED
                    'Scope' => 'LABEL|NAMESPACE', // REQUIRED
                ],
                'ManagedRuleGroupStatement' => [
                    'ExcludedRules' => [
                        [
                            'Name' => '<string>', // REQUIRED
                        ],
                        // ...
                    ],
                    'ManagedRuleGroupConfigs' => [
                        [
                            'AWSManagedRulesBotControlRuleSet' => [
                                'InspectionLevel' => 'COMMON|TARGETED', // REQUIRED
                            ],
                            'LoginPath' => '<string>',
                            'PasswordField' => [
                                'Identifier' => '<string>', // REQUIRED
                            ],
                            'PayloadType' => 'JSON|FORM_ENCODED',
                            'UsernameField' => [
                                'Identifier' => '<string>', // REQUIRED
                            ],
                        ],
                        // ...
                    ],
                    'Name' => '<string>', // REQUIRED
                    'RuleActionOverrides' => [
                        [
                            'ActionToUse' => [ // REQUIRED
                                'Allow' => [
                                    'CustomRequestHandling' => [
                                        'InsertHeaders' => [ // REQUIRED
                                            [
                                                'Name' => '<string>', // REQUIRED
                                                'Value' => '<string>', // REQUIRED
                                            ],
                                            // ...
                                        ],
                                    ],
                                ],
                                'Block' => [
                                    'CustomResponse' => [
                                        'CustomResponseBodyKey' => '<string>',
                                        'ResponseCode' => <integer>, // REQUIRED
                                        'ResponseHeaders' => [
                                            [
                                                'Name' => '<string>', // REQUIRED
                                                'Value' => '<string>', // REQUIRED
                                            ],
                                            // ...
                                        ],
                                    ],
                                ],
                                'Captcha' => [
                                    'CustomRequestHandling' => [
                                        'InsertHeaders' => [ // REQUIRED
                                            [
                                                'Name' => '<string>', // REQUIRED
                                                'Value' => '<string>', // REQUIRED
                                            ],
                                            // ...
                                        ],
                                    ],
                                ],
                                'Challenge' => [
                                    'CustomRequestHandling' => [
                                        'InsertHeaders' => [ // REQUIRED
                                            [
                                                'Name' => '<string>', // REQUIRED
                                                'Value' => '<string>', // REQUIRED
                                            ],
                                            // ...
                                        ],
                                    ],
                                ],
                                'Count' => [
                                    'CustomRequestHandling' => [
                                        'InsertHeaders' => [ // REQUIRED
                                            [
                                                'Name' => '<string>', // REQUIRED
                                                'Value' => '<string>', // REQUIRED
                                            ],
                                            // ...
                                        ],
                                    ],
                                ],
                            ],
                            'Name' => '<string>', // REQUIRED
                        ],
                        // ...
                    ],
                    'ScopeDownStatement' => [...], // RECURSIVE
                    'VendorName' => '<string>', // REQUIRED
                    'Version' => '<string>',
                ],
                'NotStatement' => [
                    'Statement' => [...], // REQUIRED, RECURSIVE
                ],
                'OrStatement' => [
                    'Statements' => [ // REQUIRED
                        [...], // RECURSIVE
                        // ...
                    ],
                ],
                'RateBasedStatement' => [
                    'AggregateKeyType' => 'IP|FORWARDED_IP', // REQUIRED
                    'ForwardedIPConfig' => [
                        'FallbackBehavior' => 'MATCH|NO_MATCH', // REQUIRED
                        'HeaderName' => '<string>', // REQUIRED
                    ],
                    'Limit' => <integer>, // REQUIRED
                    'ScopeDownStatement' => [...], // RECURSIVE
                ],
                'RegexMatchStatement' => [
                    'FieldToMatch' => [ // REQUIRED
                        'AllQueryArguments' => [
                        ],
                        'Body' => [
                            'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                        ],
                        'Cookies' => [
                            'MatchPattern' => [ // REQUIRED
                                'All' => [
                                ],
                                'ExcludedCookies' => ['<string>', ...],
                                'IncludedCookies' => ['<string>', ...],
                            ],
                            'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED
                            'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED
                        ],
                        'Headers' => [
                            'MatchPattern' => [ // REQUIRED
                                'All' => [
                                ],
                                'ExcludedHeaders' => ['<string>', ...],
                                'IncludedHeaders' => ['<string>', ...],
                            ],
                            'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED
                            'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED
                        ],
                        'JsonBody' => [
                            'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING',
                            'MatchPattern' => [ // REQUIRED
                                'All' => [
                                ],
                                'IncludedPaths' => ['<string>', ...],
                            ],
                            'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED
                            'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                        ],
                        'Method' => [
                        ],
                        'QueryString' => [
                        ],
                        'SingleHeader' => [
                            'Name' => '<string>', // REQUIRED
                        ],
                        'SingleQueryArgument' => [
                            'Name' => '<string>', // REQUIRED
                        ],
                        'UriPath' => [
                        ],
                    ],
                    'RegexString' => '<string>', // REQUIRED
                    'TextTransformations' => [ // REQUIRED
                        [
                            'Priority' => <integer>, // REQUIRED
                            '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', // REQUIRED
                        ],
                        // ...
                    ],
                ],
                'RegexPatternSetReferenceStatement' => [
                    'ARN' => '<string>', // REQUIRED
                    'FieldToMatch' => [ // REQUIRED
                        'AllQueryArguments' => [
                        ],
                        'Body' => [
                            'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                        ],
                        'Cookies' => [
                            'MatchPattern' => [ // REQUIRED
                                'All' => [
                                ],
                                'ExcludedCookies' => ['<string>', ...],
                                'IncludedCookies' => ['<string>', ...],
                            ],
                            'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED
                            'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED
                        ],
                        'Headers' => [
                            'MatchPattern' => [ // REQUIRED
                                'All' => [
                                ],
                                'ExcludedHeaders' => ['<string>', ...],
                                'IncludedHeaders' => ['<string>', ...],
                            ],
                            'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED
                            'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED
                        ],
                        'JsonBody' => [
                            'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING',
                            'MatchPattern' => [ // REQUIRED
                                'All' => [
                                ],
                                'IncludedPaths' => ['<string>', ...],
                            ],
                            'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED
                            'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                        ],
                        'Method' => [
                        ],
                        'QueryString' => [
                        ],
                        'SingleHeader' => [
                            'Name' => '<string>', // REQUIRED
                        ],
                        'SingleQueryArgument' => [
                            'Name' => '<string>', // REQUIRED
                        ],
                        'UriPath' => [
                        ],
                    ],
                    'TextTransformations' => [ // REQUIRED
                        [
                            'Priority' => <integer>, // REQUIRED
                            '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', // REQUIRED
                        ],
                        // ...
                    ],
                ],
                'RuleGroupReferenceStatement' => [
                    'ARN' => '<string>', // REQUIRED
                    'ExcludedRules' => [
                        [
                            'Name' => '<string>', // REQUIRED
                        ],
                        // ...
                    ],
                    'RuleActionOverrides' => [
                        [
                            'ActionToUse' => [ // REQUIRED
                                'Allow' => [
                                    'CustomRequestHandling' => [
                                        'InsertHeaders' => [ // REQUIRED
                                            [
                                                'Name' => '<string>', // REQUIRED
                                                'Value' => '<string>', // REQUIRED
                                            ],
                                            // ...
                                        ],
                                    ],
                                ],
                                'Block' => [
                                    'CustomResponse' => [
                                        'CustomResponseBodyKey' => '<string>',
                                        'ResponseCode' => <integer>, // REQUIRED
                                        'ResponseHeaders' => [
                                            [
                                                'Name' => '<string>', // REQUIRED
                                                'Value' => '<string>', // REQUIRED
                                            ],
                                            // ...
                                        ],
                                    ],
                                ],
                                'Captcha' => [
                                    'CustomRequestHandling' => [
                                        'InsertHeaders' => [ // REQUIRED
                                            [
                                                'Name' => '<string>', // REQUIRED
                                                'Value' => '<string>', // REQUIRED
                                            ],
                                            // ...
                                        ],
                                    ],
                                ],
                                'Challenge' => [
                                    'CustomRequestHandling' => [
                                        'InsertHeaders' => [ // REQUIRED
                                            [
                                                'Name' => '<string>', // REQUIRED
                                                'Value' => '<string>', // REQUIRED
                                            ],
                                            // ...
                                        ],
                                    ],
                                ],
                                'Count' => [
                                    'CustomRequestHandling' => [
                                        'InsertHeaders' => [ // REQUIRED
                                            [
                                                'Name' => '<string>', // REQUIRED
                                                'Value' => '<string>', // REQUIRED
                                            ],
                                            // ...
                                        ],
                                    ],
                                ],
                            ],
                            'Name' => '<string>', // REQUIRED
                        ],
                        // ...
                    ],
                ],
                'SizeConstraintStatement' => [
                    'ComparisonOperator' => 'EQ|NE|LE|LT|GE|GT', // REQUIRED
                    'FieldToMatch' => [ // REQUIRED
                        'AllQueryArguments' => [
                        ],
                        'Body' => [
                            'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                        ],
                        'Cookies' => [
                            'MatchPattern' => [ // REQUIRED
                                'All' => [
                                ],
                                'ExcludedCookies' => ['<string>', ...],
                                'IncludedCookies' => ['<string>', ...],
                            ],
                            'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED
                            'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED
                        ],
                        'Headers' => [
                            'MatchPattern' => [ // REQUIRED
                                'All' => [
                                ],
                                'ExcludedHeaders' => ['<string>', ...],
                                'IncludedHeaders' => ['<string>', ...],
                            ],
                            'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED
                            'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED
                        ],
                        'JsonBody' => [
                            'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING',
                            'MatchPattern' => [ // REQUIRED
                                'All' => [
                                ],
                                'IncludedPaths' => ['<string>', ...],
                            ],
                            'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED
                            'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                        ],
                        'Method' => [
                        ],
                        'QueryString' => [
                        ],
                        'SingleHeader' => [
                            'Name' => '<string>', // REQUIRED
                        ],
                        'SingleQueryArgument' => [
                            'Name' => '<string>', // REQUIRED
                        ],
                        'UriPath' => [
                        ],
                    ],
                    'Size' => <integer>, // REQUIRED
                    'TextTransformations' => [ // REQUIRED
                        [
                            'Priority' => <integer>, // REQUIRED
                            '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', // REQUIRED
                        ],
                        // ...
                    ],
                ],
                'SqliMatchStatement' => [
                    'FieldToMatch' => [ // REQUIRED
                        'AllQueryArguments' => [
                        ],
                        'Body' => [
                            'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                        ],
                        'Cookies' => [
                            'MatchPattern' => [ // REQUIRED
                                'All' => [
                                ],
                                'ExcludedCookies' => ['<string>', ...],
                                'IncludedCookies' => ['<string>', ...],
                            ],
                            'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED
                            'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED
                        ],
                        'Headers' => [
                            'MatchPattern' => [ // REQUIRED
                                'All' => [
                                ],
                                'ExcludedHeaders' => ['<string>', ...],
                                'IncludedHeaders' => ['<string>', ...],
                            ],
                            'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED
                            'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED
                        ],
                        'JsonBody' => [
                            'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING',
                            'MatchPattern' => [ // REQUIRED
                                'All' => [
                                ],
                                'IncludedPaths' => ['<string>', ...],
                            ],
                            'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED
                            'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                        ],
                        'Method' => [
                        ],
                        'QueryString' => [
                        ],
                        'SingleHeader' => [
                            'Name' => '<string>', // REQUIRED
                        ],
                        'SingleQueryArgument' => [
                            'Name' => '<string>', // REQUIRED
                        ],
                        'UriPath' => [
                        ],
                    ],
                    'SensitivityLevel' => 'LOW|HIGH',
                    'TextTransformations' => [ // REQUIRED
                        [
                            'Priority' => <integer>, // REQUIRED
                            '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', // REQUIRED
                        ],
                        // ...
                    ],
                ],
                'XssMatchStatement' => [
                    'FieldToMatch' => [ // REQUIRED
                        'AllQueryArguments' => [
                        ],
                        'Body' => [
                            'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                        ],
                        'Cookies' => [
                            'MatchPattern' => [ // REQUIRED
                                'All' => [
                                ],
                                'ExcludedCookies' => ['<string>', ...],
                                'IncludedCookies' => ['<string>', ...],
                            ],
                            'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED
                            'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED
                        ],
                        'Headers' => [
                            'MatchPattern' => [ // REQUIRED
                                'All' => [
                                ],
                                'ExcludedHeaders' => ['<string>', ...],
                                'IncludedHeaders' => ['<string>', ...],
                            ],
                            'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED
                            'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED
                        ],
                        'JsonBody' => [
                            'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING',
                            'MatchPattern' => [ // REQUIRED
                                'All' => [
                                ],
                                'IncludedPaths' => ['<string>', ...],
                            ],
                            'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED
                            'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                        ],
                        'Method' => [
                        ],
                        'QueryString' => [
                        ],
                        'SingleHeader' => [
                            'Name' => '<string>', // REQUIRED
                        ],
                        'SingleQueryArgument' => [
                            'Name' => '<string>', // REQUIRED
                        ],
                        'UriPath' => [
                        ],
                    ],
                    'TextTransformations' => [ // REQUIRED
                        [
                            'Priority' => <integer>, // REQUIRED
                            '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', // REQUIRED
                        ],
                        // ...
                    ],
                ],
            ],
            'VisibilityConfig' => [ // REQUIRED
                'CloudWatchMetricsEnabled' => true || false, // REQUIRED
                'MetricName' => '<string>', // REQUIRED
                'SampledRequestsEnabled' => true || false, // REQUIRED
            ],
        ],
        // ...
    ],
    'Scope' => 'CLOUDFRONT|REGIONAL', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'TokenDomains' => ['<string>', ...],
    'VisibilityConfig' => [ // REQUIRED
        'CloudWatchMetricsEnabled' => true || false, // REQUIRED
        'MetricName' => '<string>', // REQUIRED
        'SampledRequestsEnabled' => true || false, // REQUIRED
    ],
]);

Parameter Details

Result Syntax

[
    'Summary' => [
        'ARN' => '<string>',
        'Description' => '<string>',
        'Id' => '<string>',
        'LockToken' => '<string>',
        'Name' => '<string>',
    ],
]

Result Details

Errors

• WAFInternalErrorException:

  Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.

• WAFInvalidParameterException:

  The operation failed because WAF didn't recognize a parameter in the request. For example:

  • You specified a parameter name or value that isn't valid.

  • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

  • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

  • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated.

• WAFDuplicateItemException:

  WAF couldn’t perform the operation because the resource that you tried to save is a duplicate of an existing one.

• WAFOptimisticLockException:

  WAF couldn’t save your changes because you tried to update or delete a resource that has changed since you last retrieved it. Get the resource again, make any changes you need to make to the new copy, and retry your operation.

• WAFLimitsExceededException:

  WAF couldn’t perform the operation because you exceeded your resource limit. For example, the maximum number of WebACL objects that you can create for an Amazon Web Services account. For more information, see WAF quotas in the WAF Developer Guide.

• WAFInvalidResourceException:

  WAF couldn’t perform the operation because the resource that you requested isn’t valid. Check the resource, and try again.

• WAFUnavailableEntityException:

  WAF couldn’t retrieve a resource that you specified for this operation. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate. Verify the resources that you are specifying in your request parameters and then retry the operation.

• WAFNonexistentItemException:

  WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.

• WAFTagOperationException:

  An error occurred during the tagging operation. Retry your request.

• WAFTagOperationInternalErrorException:

  WAF couldn’t perform your tagging operation because of an internal error. Retry your request.

• WAFSubscriptionNotFoundException:

  You tried to use a managed rule group that's available by subscription, but you aren't subscribed to it yet.

• WAFInvalidOperationException:

  The operation isn't valid.

• WAFConfigurationWarningException:

  The operation failed because you are inspecting the web request body, headers, or cookies without specifying how to handle oversize components. Rules that inspect the body must either provide an OversizeHandling configuration or they must be preceded by a SizeConstraintStatement that blocks the body content from being too large. Rules that inspect the headers or cookies must provide an OversizeHandling configuration.

  Provide the handling configuration and retry your operation.

  Alternately, you can suppress this warning by adding the following tag to the resource that you provide to this operation: Tag (key:WAF:OversizeFieldsHandlingConstraintOptOut, value:true).

• WAFExpiredManagedRuleGroupVersionException:

  The operation failed because the specified version for the managed rule group has expired. You can retrieve the available versions for the managed rule group by calling ListAvailableManagedRuleGroupVersions.

DeleteFirewallManagerRuleGroups

$result = $client->deleteFirewallManagerRuleGroups([/* ... */]);
$promise = $client->deleteFirewallManagerRuleGroupsAsync([/* ... */]);

Parameter Syntax

$result = $client->deleteFirewallManagerRuleGroups([
    'WebACLArn' => '<string>', // REQUIRED
    'WebACLLockToken' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'NextWebACLLockToken' => '<string>',
]

Result Details

Errors

• WAFInternalErrorException:

  Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.

• WAFInvalidParameterException:

  The operation failed because WAF didn't recognize a parameter in the request. For example:

  • You specified a parameter name or value that isn't valid.

  • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

  • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

  • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated.

• WAFNonexistentItemException:

  WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.

• WAFOptimisticLockException:

  WAF couldn’t save your changes because you tried to update or delete a resource that has changed since you last retrieved it. Get the resource again, make any changes you need to make to the new copy, and retry your operation.

• WAFInvalidOperationException:

  The operation isn't valid.

DeleteIPSet

$result = $client->deleteIPSet([/* ... */]);
$promise = $client->deleteIPSetAsync([/* ... */]);

Parameter Syntax

$result = $client->deleteIPSet([
    'Id' => '<string>', // REQUIRED
    'LockToken' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
    'Scope' => 'CLOUDFRONT|REGIONAL', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

• WAFInternalErrorException:

  Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.

• WAFInvalidParameterException:

  The operation failed because WAF didn't recognize a parameter in the request. For example:

  • You specified a parameter name or value that isn't valid.

  • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

  • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

  • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated.

• WAFNonexistentItemException:

  WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.

• WAFOptimisticLockException:

  WAF couldn’t save your changes because you tried to update or delete a resource that has changed since you last retrieved it. Get the resource again, make any changes you need to make to the new copy, and retry your operation.

• WAFAssociatedItemException:

  WAF couldn’t perform the operation because your resource is being used by another resource or it’s associated with another resource.

• WAFTagOperationException:

  An error occurred during the tagging operation. Retry your request.

• WAFTagOperationInternalErrorException:

  WAF couldn’t perform your tagging operation because of an internal error. Retry your request.

• WAFInvalidOperationException:

  The operation isn't valid.

DeleteLoggingConfiguration

$result = $client->deleteLoggingConfiguration([/* ... */]);
$promise = $client->deleteLoggingConfigurationAsync([/* ... */]);

Parameter Syntax

$result = $client->deleteLoggingConfiguration([
    'ResourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

• WAFInternalErrorException:

  Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.

• WAFNonexistentItemException:

  WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.

• WAFOptimisticLockException:

  WAF couldn’t save your changes because you tried to update or delete a resource that has changed since you last retrieved it. Get the resource again, make any changes you need to make to the new copy, and retry your operation.

• WAFInvalidParameterException:

  The operation failed because WAF didn't recognize a parameter in the request. For example:

  • You specified a parameter name or value that isn't valid.

  • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

  • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

  • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated.

• WAFInvalidOperationException:

  The operation isn't valid.

DeletePermissionPolicy

$result = $client->deletePermissionPolicy([/* ... */]);
$promise = $client->deletePermissionPolicyAsync([/* ... */]);

Parameter Syntax

$result = $client->deletePermissionPolicy([
    'ResourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

• WAFNonexistentItemException:

  WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.

• WAFInternalErrorException:

  Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.

• WAFInvalidParameterException:

  The operation failed because WAF didn't recognize a parameter in the request. For example:

  • You specified a parameter name or value that isn't valid.

  • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

  • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

  • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated.

DeleteRegexPatternSet

$result = $client->deleteRegexPatternSet([/* ... */]);
$promise = $client->deleteRegexPatternSetAsync([/* ... */]);

Parameter Syntax

$result = $client->deleteRegexPatternSet([
    'Id' => '<string>', // REQUIRED
    'LockToken' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
    'Scope' => 'CLOUDFRONT|REGIONAL', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

• WAFInternalErrorException:

  Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.

• WAFInvalidParameterException:

  The operation failed because WAF didn't recognize a parameter in the request. For example:

  • You specified a parameter name or value that isn't valid.

  • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

  • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

  • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated.

• WAFNonexistentItemException:

  WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.

• WAFOptimisticLockException:

  WAF couldn’t save your changes because you tried to update or delete a resource that has changed since you last retrieved it. Get the resource again, make any changes you need to make to the new copy, and retry your operation.

• WAFAssociatedItemException:

  WAF couldn’t perform the operation because your resource is being used by another resource or it’s associated with another resource.

• WAFTagOperationException:

  An error occurred during the tagging operation. Retry your request.

• WAFTagOperationInternalErrorException:

  WAF couldn’t perform your tagging operation because of an internal error. Retry your request.

• WAFInvalidOperationException:

  The operation isn't valid.

DeleteRuleGroup

$result = $client->deleteRuleGroup([/* ... */]);
$promise = $client->deleteRuleGroupAsync([/* ... */]);

Parameter Syntax

$result = $client->deleteRuleGroup([
    'Id' => '<string>', // REQUIRED
    'LockToken' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
    'Scope' => 'CLOUDFRONT|REGIONAL', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

• WAFInternalErrorException:

  Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.

• WAFInvalidParameterException:

  The operation failed because WAF didn't recognize a parameter in the request. For example:

  • You specified a parameter name or value that isn't valid.

  • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

  • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

  • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated.

• WAFNonexistentItemException:

  WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.

• WAFOptimisticLockException:

  WAF couldn’t save your changes because you tried to update or delete a resource that has changed since you last retrieved it. Get the resource again, make any changes you need to make to the new copy, and retry your operation.

• WAFAssociatedItemException:

  WAF couldn’t perform the operation because your resource is being used by another resource or it’s associated with another resource.

• WAFTagOperationException:

  An error occurred during the tagging operation. Retry your request.

• WAFTagOperationInternalErrorException:

  WAF couldn’t perform your tagging operation because of an internal error. Retry your request.

• WAFInvalidOperationException:

  The operation isn't valid.

DeleteWebACL

$result = $client->deleteWebACL([/* ... */]);
$promise = $client->deleteWebACLAsync([/* ... */]);

Parameter Syntax

$result = $client->deleteWebACL([
    'Id' => '<string>', // REQUIRED
    'LockToken' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
    'Scope' => 'CLOUDFRONT|REGIONAL', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

• WAFInternalErrorException:

  Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.

• WAFInvalidParameterException:

  The operation failed because WAF didn't recognize a parameter in the request. For example:

  • You specified a parameter name or value that isn't valid.

  • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

  • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

  • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated.

• WAFNonexistentItemException:

  WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.

• WAFOptimisticLockException:

  WAF couldn’t save your changes because you tried to update or delete a resource that has changed since you last retrieved it. Get the resource again, make any changes you need to make to the new copy, and retry your operation.

• WAFAssociatedItemException:

  WAF couldn’t perform the operation because your resource is being used by another resource or it’s associated with another resource.

• WAFTagOperationException:

  An error occurred during the tagging operation. Retry your request.

• WAFTagOperationInternalErrorException:

  WAF couldn’t perform your tagging operation because of an internal error. Retry your request.

• WAFInvalidOperationException:

  The operation isn't valid.

DescribeManagedRuleGroup

$result = $client->describeManagedRuleGroup([/* ... */]);
$promise = $client->describeManagedRuleGroupAsync([/* ... */]);

Parameter Syntax

$result = $client->describeManagedRuleGroup([
    'Name' => '<string>', // REQUIRED
    'Scope' => 'CLOUDFRONT|REGIONAL', // REQUIRED
    'VendorName' => '<string>', // REQUIRED
    'VersionName' => '<string>',
]);

Parameter Details

Result Syntax

[
    'AvailableLabels' => [
        [
            'Name' => '<string>',
        ],
        // ...
    ],
    'Capacity' => <integer>,
    'ConsumedLabels' => [
        [
            'Name' => '<string>',
        ],
        // ...
    ],
    'LabelNamespace' => '<string>',
    'Rules' => [
        [
            'Action' => [
                'Allow' => [
                    'CustomRequestHandling' => [
                        'InsertHeaders' => [
                            [
                                'Name' => '<string>',
                                'Value' => '<string>',
                            ],
                            // ...
                        ],
                    ],
                ],
                'Block' => [
                    'CustomResponse' => [
                        'CustomResponseBodyKey' => '<string>',
                        'ResponseCode' => <integer>,
                        'ResponseHeaders' => [
                            [
                                'Name' => '<string>',
                                'Value' => '<string>',
                            ],
                            // ...
                        ],
                    ],
                ],
                'Captcha' => [
                    'CustomRequestHandling' => [
                        'InsertHeaders' => [
                            [
                                'Name' => '<string>',
                                'Value' => '<string>',
                            ],
                            // ...
                        ],
                    ],
                ],
                'Challenge' => [
                    'CustomRequestHandling' => [
                        'InsertHeaders' => [
                            [
                                'Name' => '<string>',
                                'Value' => '<string>',
                            ],
                            // ...
                        ],
                    ],
                ],
                'Count' => [
                    'CustomRequestHandling' => [
                        'InsertHeaders' => [
                            [
                                'Name' => '<string>',
                                'Value' => '<string>',
                            ],
                            // ...
                        ],
                    ],
                ],
            ],
            'Name' => '<string>',
        ],
        // ...
    ],
    'SnsTopicArn' => '<string>',
    'VersionName' => '<string>',
]

Result Details

Errors

• WAFInternalErrorException:

  Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.

• WAFInvalidParameterException:

  The operation failed because WAF didn't recognize a parameter in the request. For example:

  • You specified a parameter name or value that isn't valid.

  • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

  • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

  • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated.

• WAFInvalidResourceException:

  WAF couldn’t perform the operation because the resource that you requested isn’t valid. Check the resource, and try again.

• WAFNonexistentItemException:

  WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.

• WAFInvalidOperationException:

  The operation isn't valid.

• WAFExpiredManagedRuleGroupVersionException:

  The operation failed because the specified version for the managed rule group has expired. You can retrieve the available versions for the managed rule group by calling ListAvailableManagedRuleGroupVersions.

DisassociateWebACL

$result = $client->disassociateWebACL([/* ... */]);
$promise = $client->disassociateWebACLAsync([/* ... */]);

Parameter Syntax

$result = $client->disassociateWebACL([
    'ResourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

• WAFInternalErrorException:

  Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.

• WAFInvalidParameterException:

  The operation failed because WAF didn't recognize a parameter in the request. For example:

  • You specified a parameter name or value that isn't valid.

  • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

  • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

  • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated.

• WAFNonexistentItemException:

  WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.

• WAFInvalidOperationException:

  The operation isn't valid.

GenerateMobileSdkReleaseUrl

$result = $client->generateMobileSdkReleaseUrl([/* ... */]);
$promise = $client->generateMobileSdkReleaseUrlAsync([/* ... */]);

Parameter Syntax

$result = $client->generateMobileSdkReleaseUrl([
    'Platform' => 'IOS|ANDROID', // REQUIRED
    'ReleaseVersion' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Url' => '<string>',
]

Result Details

Errors

• WAFInternalErrorException:

  Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.

• WAFNonexistentItemException:

  WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.

• WAFInvalidParameterException:

  The operation failed because WAF didn't recognize a parameter in the request. For example:

  • You specified a parameter name or value that isn't valid.

  • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

  • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

  • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated.

• WAFInvalidOperationException:

  The operation isn't valid.

GetIPSet

$result = $client->getIPSet([/* ... */]);
$promise = $client->getIPSetAsync([/* ... */]);

Parameter Syntax

$result = $client->getIPSet([
    'Id' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
    'Scope' => 'CLOUDFRONT|REGIONAL', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'IPSet' => [
        'ARN' => '<string>',
        'Addresses' => ['<string>', ...],
        'Description' => '<string>',
        'IPAddressVersion' => 'IPV4|IPV6',
        'Id' => '<string>',
        'Name' => '<string>',
    ],
    'LockToken' => '<string>',
]

Result Details

Errors

• WAFInternalErrorException:

  Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.

• WAFInvalidParameterException:

  The operation failed because WAF didn't recognize a parameter in the request. For example:

  • You specified a parameter name or value that isn't valid.

  • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

  • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

  • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated.

• WAFNonexistentItemException:

  WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.

• WAFInvalidOperationException:

  The operation isn't valid.

GetLoggingConfiguration

$result = $client->getLoggingConfiguration([/* ... */]);
$promise = $client->getLoggingConfigurationAsync([/* ... */]);

Parameter Syntax

$result = $client->getLoggingConfiguration([
    'ResourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'LoggingConfiguration' => [
        'LogDestinationConfigs' => ['<string>', ...],
        'LoggingFilter' => [
            'DefaultBehavior' => 'KEEP|DROP',
            'Filters' => [
                [
                    'Behavior' => 'KEEP|DROP',
                    'Conditions' => [
                        [
                            'ActionCondition' => [
                                'Action' => 'ALLOW|BLOCK|COUNT|CAPTCHA|CHALLENGE|EXCLUDED_AS_COUNT',
                            ],
                            'LabelNameCondition' => [
                                'LabelName' => '<string>',
                            ],
                        ],
                        // ...
                    ],
                    'Requirement' => 'MEETS_ALL|MEETS_ANY',
                ],
                // ...
            ],
        ],
        'ManagedByFirewallManager' => true || false,
        'RedactedFields' => [
            [
                'AllQueryArguments' => [
                ],
                'Body' => [
                    'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                ],
                'Cookies' => [
                    'MatchPattern' => [
                        'All' => [
                        ],
                        'ExcludedCookies' => ['<string>', ...],
                        'IncludedCookies' => ['<string>', ...],
                    ],
                    'MatchScope' => 'ALL|KEY|VALUE',
                    'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                ],
                'Headers' => [
                    'MatchPattern' => [
                        'All' => [
                        ],
                        'ExcludedHeaders' => ['<string>', ...],
                        'IncludedHeaders' => ['<string>', ...],
                    ],
                    'MatchScope' => 'ALL|KEY|VALUE',
                    'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                ],
                'JsonBody' => [
                    'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING',
                    'MatchPattern' => [
                        'All' => [
                        ],
                        'IncludedPaths' => ['<string>', ...],
                    ],
                    'MatchScope' => 'ALL|KEY|VALUE',
                    'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                ],
                'Method' => [
                ],
                'QueryString' => [
                ],
                'SingleHeader' => [
                    'Name' => '<string>',
                ],
                'SingleQueryArgument' => [
                    'Name' => '<string>',
                ],
                'UriPath' => [
                ],
            ],
            // ...
        ],
        'ResourceArn' => '<string>',
    ],
]

Result Details

Errors

• WAFInternalErrorException:

  Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.

• WAFNonexistentItemException:

  WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.

• WAFInvalidParameterException:

  The operation failed because WAF didn't recognize a parameter in the request. For example:

  • You specified a parameter name or value that isn't valid.

  • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

  • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

  • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated.

• WAFInvalidOperationException:

  The operation isn't valid.

GetManagedRuleSet

$result = $client->getManagedRuleSet([/* ... */]);
$promise = $client->getManagedRuleSetAsync([/* ... */]);

Parameter Syntax

$result = $client->getManagedRuleSet([
    'Id' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
    'Scope' => 'CLOUDFRONT|REGIONAL', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'LockToken' => '<string>',
    'ManagedRuleSet' => [
        'ARN' => '<string>',
        'Description' => '<string>',
        'Id' => '<string>',
        'LabelNamespace' => '<string>',
        'Name' => '<string>',
        'PublishedVersions' => [
            '<VersionKeyString>' => [
                'AssociatedRuleGroupArn' => '<string>',
                'Capacity' => <integer>,
                'ExpiryTimestamp' => <DateTime>,
                'ForecastedLifetime' => <integer>,
                'LastUpdateTimestamp' => <DateTime>,
                'PublishTimestamp' => <DateTime>,
            ],
            // ...
        ],
        'RecommendedVersion' => '<string>',
    ],
]

Result Details

Errors

• WAFInternalErrorException:

  Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.

• WAFInvalidParameterException:

  The operation failed because WAF didn't recognize a parameter in the request. For example:

  • You specified a parameter name or value that isn't valid.

  • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

  • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

  • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated.

• WAFNonexistentItemException:

  WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.

• WAFInvalidOperationException:

  The operation isn't valid.

GetMobileSdkRelease

$result = $client->getMobileSdkRelease([/* ... */]);
$promise = $client->getMobileSdkReleaseAsync([/* ... */]);

Parameter Syntax

$result = $client->getMobileSdkRelease([
    'Platform' => 'IOS|ANDROID', // REQUIRED
    'ReleaseVersion' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'MobileSdkRelease' => [
        'ReleaseNotes' => '<string>',
        'ReleaseVersion' => '<string>',
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'Timestamp' => <DateTime>,
    ],
]

Result Details

Errors

• WAFInternalErrorException:

  Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.

• WAFNonexistentItemException:

  WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.

• WAFInvalidParameterException:

  The operation failed because WAF didn't recognize a parameter in the request. For example:

  • You specified a parameter name or value that isn't valid.

  • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

  • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

  • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated.

• WAFInvalidOperationException:

  The operation isn't valid.

GetPermissionPolicy

$result = $client->getPermissionPolicy([/* ... */]);
$promise = $client->getPermissionPolicyAsync([/* ... */]);

Parameter Syntax

$result = $client->getPermissionPolicy([
    'ResourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Policy' => '<string>',
]

Result Details

Errors

• WAFNonexistentItemException:

  WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.

• WAFInternalErrorException:

  Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.

• WAFInvalidParameterException:

  The operation failed because WAF didn't recognize a parameter in the request. For example:

  • You specified a parameter name or value that isn't valid.

  • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

  • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

  • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated.

GetRateBasedStatementManagedKeys

$result = $client->getRateBasedStatementManagedKeys([/* ... */]);
$promise = $client->getRateBasedStatementManagedKeysAsync([/* ... */]);

Parameter Syntax

$result = $client->getRateBasedStatementManagedKeys([
    'RuleGroupRuleName' => '<string>',
    'RuleName' => '<string>', // REQUIRED
    'Scope' => 'CLOUDFRONT|REGIONAL', // REQUIRED
    'WebACLId' => '<string>', // REQUIRED
    'WebACLName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ManagedKeysIPV4' => [
        'Addresses' => ['<string>', ...],
        'IPAddressVersion' => 'IPV4|IPV6',
    ],
    'ManagedKeysIPV6' => [
        'Addresses' => ['<string>', ...],
        'IPAddressVersion' => 'IPV4|IPV6',
    ],
]

Result Details

Errors

• WAFInternalErrorException:

  Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.

• WAFInvalidParameterException:

  The operation failed because WAF didn't recognize a parameter in the request. For example:

  • You specified a parameter name or value that isn't valid.

  • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

  • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

  • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated.

• WAFNonexistentItemException:

  WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.

• WAFInvalidOperationException:

  The operation isn't valid.

GetRegexPatternSet

$result = $client->getRegexPatternSet([/* ... */]);
$promise = $client->getRegexPatternSetAsync([/* ... */]);

Parameter Syntax

$result = $client->getRegexPatternSet([
    'Id' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
    'Scope' => 'CLOUDFRONT|REGIONAL', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'LockToken' => '<string>',
    'RegexPatternSet' => [
        'ARN' => '<string>',
        'Description' => '<string>',
        'Id' => '<string>',
        'Name' => '<string>',
        'RegularExpressionList' => [
            [
                'RegexString' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Errors

• WAFInternalErrorException:

  Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.

• WAFInvalidParameterException:

  The operation failed because WAF didn't recognize a parameter in the request. For example:

  • You specified a parameter name or value that isn't valid.

  • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

  • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

  • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated.

• WAFNonexistentItemException:

  WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.

• WAFInvalidOperationException:

  The operation isn't valid.

GetRuleGroup

$result = $client->getRuleGroup([/* ... */]);
$promise = $client->getRuleGroupAsync([/* ... */]);

Parameter Syntax

$result = $client->getRuleGroup([
    'ARN' => '<string>',
    'Id' => '<string>',
    'Name' => '<string>',
    'Scope' => 'CLOUDFRONT|REGIONAL',
]);

Parameter Details

Result Syntax

[
    'LockToken' => '<string>',
    'RuleGroup' => [
        'ARN' => '<string>',
        'AvailableLabels' => [
            [
                'Name' => '<string>',
            ],
            // ...
        ],
        'Capacity' => <integer>,
        'ConsumedLabels' => [
            [
                'Name' => '<string>',
            ],
            // ...
        ],
        'CustomResponseBodies' => [
            '<EntityName>' => [
                'Content' => '<string>',
                'ContentType' => 'TEXT_PLAIN|TEXT_HTML|APPLICATION_JSON',
            ],
            // ...
        ],
        'Description' => '<string>',
        'Id' => '<string>',
        'LabelNamespace' => '<string>',
        'Name' => '<string>',
        'Rules' => [
            [
                'Action' => [
                    'Allow' => [
                        'CustomRequestHandling' => [
                            'InsertHeaders' => [
                                [
                                    'Name' => '<string>',
                                    'Value' => '<string>',
                                ],
                                // ...
                            ],
                        ],
                    ],
                    'Block' => [
                        'CustomResponse' => [
                            'CustomResponseBodyKey' => '<string>',
                            'ResponseCode' => <integer>,
                            'ResponseHeaders' => [
                                [
                                    'Name' => '<string>',
                                    'Value' => '<string>',
                                ],
                                // ...
                            ],
                        ],
                    ],
                    'Captcha' => [
                        'CustomRequestHandling' => [
                            'InsertHeaders' => [
                                [
                                    'Name' => '<string>',
                                    'Value' => '<string>',
                                ],
                                // ...
                            ],
                        ],
                    ],
                    'Challenge' => [
                        'CustomRequestHandling' => [
                            'InsertHeaders' => [
                                [
                                    'Name' => '<string>',
                                    'Value' => '<string>',
                                ],
                                // ...
                            ],
                        ],
                    ],
                    'Count' => [
                        'CustomRequestHandling' => [
                            'InsertHeaders' => [
                                [
                                    'Name' => '<string>',
                                    'Value' => '<string>',
                                ],
                                // ...
                            ],
                        ],
                    ],
                ],
                'CaptchaConfig' => [
                    'ImmunityTimeProperty' => [
                        'ImmunityTime' => <integer>,
                    ],
                ],
                'ChallengeConfig' => [
                    'ImmunityTimeProperty' => [
                        'ImmunityTime' => <integer>,
                    ],
                ],
                'Name' => '<string>',
                'OverrideAction' => [
                    'Count' => [
                        'CustomRequestHandling' => [
                            'InsertHeaders' => [
                                [
                                    'Name' => '<string>',
                                    'Value' => '<string>',
                                ],
                                // ...
                            ],
                        ],
                    ],
                    'None' => [
                    ],
                ],
                'Priority' => <integer>,
                'RuleLabels' => [
                    [
                        'Name' => '<string>',
                    ],
                    // ...
                ],
                'Statement' => [
                    'AndStatement' => [
                        'Statements' => [
                            [...], // RECURSIVE
                            // ...
                        ],
                    ],
                    'ByteMatchStatement' => [
                        'FieldToMatch' => [
                            'AllQueryArguments' => [
                            ],
                            'Body' => [
                                'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                            ],
                            'Cookies' => [
                                'MatchPattern' => [
                                    'All' => [
                                    ],
                                    'ExcludedCookies' => ['<string>', ...],
                                    'IncludedCookies' => ['<string>', ...],
                                ],
                                'MatchScope' => 'ALL|KEY|VALUE',
                                'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                            ],
                            'Headers' => [
                                'MatchPattern' => [
                                    'All' => [
                                    ],
                                    'ExcludedHeaders' => ['<string>', ...],
                                    'IncludedHeaders' => ['<string>', ...],
                                ],
                                'MatchScope' => 'ALL|KEY|VALUE',
                                'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                            ],
                            'JsonBody' => [
                                'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING',
                                'MatchPattern' => [
                                    'All' => [
                                    ],
                                    'IncludedPaths' => ['<string>', ...],
                                ],
                                'MatchScope' => 'ALL|KEY|VALUE',
                                'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                            ],
                            'Method' => [
                            ],
                            'QueryString' => [
                            ],
                            'SingleHeader' => [
                                'Name' => '<string>',
                            ],
                            'SingleQueryArgument' => [
                                'Name' => '<string>',
                            ],
                            'UriPath' => [
                            ],
                        ],
                        'PositionalConstraint' => 'EXACTLY|STARTS_WITH|ENDS_WITH|CONTAINS|CONTAINS_WORD',
                        'SearchString' => <string || resource || Psr\Http\Message\StreamInterface>,
                        'TextTransformations' => [
                            [
                                'Priority' => <integer>,
                                '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' => ['<string>', ...],
                        'ForwardedIPConfig' => [
                            'FallbackBehavior' => 'MATCH|NO_MATCH',
                            'HeaderName' => '<string>',
                        ],
                    ],
                    'IPSetReferenceStatement' => [
                        'ARN' => '<string>',
                        'IPSetForwardedIPConfig' => [
                            'FallbackBehavior' => 'MATCH|NO_MATCH',
                            'HeaderName' => '<string>',
                            'Position' => 'FIRST|LAST|ANY',
                        ],
                    ],
                    'LabelMatchStatement' => [
                        'Key' => '<string>',
                        'Scope' => 'LABEL|NAMESPACE',
                    ],
                    'ManagedRuleGroupStatement' => [
                        'ExcludedRules' => [
                            [
                                'Name' => '<string>',
                            ],
                            // ...
                        ],
                        'ManagedRuleGroupConfigs' => [
                            [
                                'AWSManagedRulesBotControlRuleSet' => [
                                    'InspectionLevel' => 'COMMON|TARGETED',
                                ],
                                'LoginPath' => '<string>',
                                'PasswordField' => [
                                    'Identifier' => '<string>',
                                ],
                                'PayloadType' => 'JSON|FORM_ENCODED',
                                'UsernameField' => [
                                    'Identifier' => '<string>',
                                ],
                            ],
                            // ...
                        ],
                        'Name' => '<string>',
                        'RuleActionOverrides' => [
                            [
                                'ActionToUse' => [
                                    'Allow' => [
                                        'CustomRequestHandling' => [
                                            'InsertHeaders' => [
                                                [
                                                    'Name' => '<string>',
                                                    'Value' => '<string>',
                                                ],
                                                // ...
                                            ],
                                        ],
                                    ],
                                    'Block' => [
                                        'CustomResponse' => [
                                            'CustomResponseBodyKey' => '<string>',
                                            'ResponseCode' => <integer>,
                                            'ResponseHeaders' => [
                                                [
                                                    'Name' => '<string>',
                                                    'Value' => '<string>',
                                                ],
                                                // ...
                                            ],
                                        ],
                                    ],
                                    'Captcha' => [
                                        'CustomRequestHandling' => [
                                            'InsertHeaders' => [
                                                [
                                                    'Name' => '<string>',
                                                    'Value' => '<string>',
                                                ],
                                                // ...
                                            ],
                                        ],
                                    ],
                                    'Challenge' => [
                                        'CustomRequestHandling' => [
                                            'InsertHeaders' => [
                                                [
                                                    'Name' => '<string>',
                                                    'Value' => '<string>',
                                                ],
                                                // ...
                                            ],
                                        ],
                                    ],
                                    'Count' => [
                                        'CustomRequestHandling' => [
                                            'InsertHeaders' => [
                                                [
                                                    'Name' => '<string>',
                                                    'Value' => '<string>',
                                                ],
                                                // ...
                                            ],
                                        ],
                                    ],
                                ],
                                'Name' => '<string>',
                            ],
                            // ...
                        ],
                        'ScopeDownStatement' => [...], // RECURSIVE
                        'VendorName' => '<string>',
                        'Version' => '<string>',
                    ],
                    'NotStatement' => [
                        'Statement' => [...], // RECURSIVE
                    ],
                    'OrStatement' => [
                        'Statements' => [
                            [...], // RECURSIVE
                            // ...
                        ],
                    ],
                    'RateBasedStatement' => [
                        'AggregateKeyType' => 'IP|FORWARDED_IP',
                        'ForwardedIPConfig' => [
                            'FallbackBehavior' => 'MATCH|NO_MATCH',
                            'HeaderName' => '<string>',
                        ],
                        'Limit' => <integer>,
                        'ScopeDownStatement' => [...], // RECURSIVE
                    ],
                    'RegexMatchStatement' => [
                        'FieldToMatch' => [
                            'AllQueryArguments' => [
                            ],
                            'Body' => [
                                'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                            ],
                            'Cookies' => [
                                'MatchPattern' => [
                                    'All' => [
                                    ],
                                    'ExcludedCookies' => ['<string>', ...],
                                    'IncludedCookies' => ['<string>', ...],
                                ],
                                'MatchScope' => 'ALL|KEY|VALUE',
                                'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                            ],
                            'Headers' => [
                                'MatchPattern' => [
                                    'All' => [
                                    ],
                                    'ExcludedHeaders' => ['<string>', ...],
                                    'IncludedHeaders' => ['<string>', ...],
                                ],
                                'MatchScope' => 'ALL|KEY|VALUE',
                                'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                            ],
                            'JsonBody' => [
                                'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING',
                                'MatchPattern' => [
                                    'All' => [
                                    ],
                                    'IncludedPaths' => ['<string>', ...],
                                ],
                                'MatchScope' => 'ALL|KEY|VALUE',
                                'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                            ],
                            'Method' => [
                            ],
                            'QueryString' => [
                            ],
                            'SingleHeader' => [
                                'Name' => '<string>',
                            ],
                            'SingleQueryArgument' => [
                                'Name' => '<string>',
                            ],
                            'UriPath' => [
                            ],
                        ],
                        'RegexString' => '<string>',
                        'TextTransformations' => [
                            [
                                'Priority' => <integer>,
                                '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',
                            ],
                            // ...
                        ],
                    ],
                    'RegexPatternSetReferenceStatement' => [
                        'ARN' => '<string>',
                        'FieldToMatch' => [
                            'AllQueryArguments' => [
                            ],
                            'Body' => [
                                'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                            ],
                            'Cookies' => [
                                'MatchPattern' => [
                                    'All' => [
                                    ],
                                    'ExcludedCookies' => ['<string>', ...],
                                    'IncludedCookies' => ['<string>', ...],
                                ],
                                'MatchScope' => 'ALL|KEY|VALUE',
                                'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                            ],
                            'Headers' => [
                                'MatchPattern' => [
                                    'All' => [
                                    ],
                                    'ExcludedHeaders' => ['<string>', ...],
                                    'IncludedHeaders' => ['<string>', ...],
                                ],
                                'MatchScope' => 'ALL|KEY|VALUE',
                                'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                            ],
                            'JsonBody' => [
                                'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING',
                                'MatchPattern' => [
                                    'All' => [
                                    ],
                                    'IncludedPaths' => ['<string>', ...],
                                ],
                                'MatchScope' => 'ALL|KEY|VALUE',
                                'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                            ],
                            'Method' => [
                            ],
                            'QueryString' => [
                            ],
                            'SingleHeader' => [
                                'Name' => '<string>',
                            ],
                            'SingleQueryArgument' => [
                                'Name' => '<string>',
                            ],
                            'UriPath' => [
                            ],
                        ],
                        'TextTransformations' => [
                            [
                                'Priority' => <integer>,
                                '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',
                            ],
                            // ...
                        ],
                    ],
                    'RuleGroupReferenceStatement' => [
                        'ARN' => '<string>',
                        'ExcludedRules' => [
                            [
                                'Name' => '<string>',
                            ],
                            // ...
                        ],
                        'RuleActionOverrides' => [
                            [
                                'ActionToUse' => [
                                    'Allow' => [
                                        'CustomRequestHandling' => [
                                            'InsertHeaders' => [
                                                [
                                                    'Name' => '<string>',
                                                    'Value' => '<string>',
                                                ],
                                                // ...
                                            ],
                                        ],
                                    ],
                                    'Block' => [
                                        'CustomResponse' => [
                                            'CustomResponseBodyKey' => '<string>',
                                            'ResponseCode' => <integer>,
                                            'ResponseHeaders' => [
                                                [
                                                    'Name' => '<string>',
                                                    'Value' => '<string>',
                                                ],
                                                // ...
                                            ],
                                        ],
                                    ],
                                    'Captcha' => [
                                        'CustomRequestHandling' => [
                                            'InsertHeaders' => [
                                                [
                                                    'Name' => '<string>',
                                                    'Value' => '<string>',
                                                ],
                                                // ...
                                            ],
                                        ],
                                    ],
                                    'Challenge' => [
                                        'CustomRequestHandling' => [
                                            'InsertHeaders' => [
                                                [
                                                    'Name' => '<string>',
                                                    'Value' => '<string>',
                                                ],
                                                // ...
                                            ],
                                        ],
                                    ],
                                    'Count' => [
                                        'CustomRequestHandling' => [
                                            'InsertHeaders' => [
                                                [
                                                    'Name' => '<string>',
                                                    'Value' => '<string>',
                                                ],
                                                // ...
                                            ],
                                        ],
                                    ],
                                ],
                                'Name' => '<string>',
                            ],
                            // ...
                        ],
                    ],
                    'SizeConstraintStatement' => [
                        'ComparisonOperator' => 'EQ|NE|LE|LT|GE|GT',
                        'FieldToMatch' => [
                            'AllQueryArguments' => [
                            ],
                            'Body' => [
                                'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                            ],
                            'Cookies' => [
                                'MatchPattern' => [
                                    'All' => [
                                    ],
                                    'ExcludedCookies' => ['<string>', ...],
                                    'IncludedCookies' => ['<string>', ...],
                                ],
                                'MatchScope' => 'ALL|KEY|VALUE',
                                'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                            ],
                            'Headers' => [
                                'MatchPattern' => [
                                    'All' => [
                                    ],
                                    'ExcludedHeaders' => ['<string>', ...],
                                    'IncludedHeaders' => ['<string>', ...],
                                ],
                                'MatchScope' => 'ALL|KEY|VALUE',
                                'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                            ],
                            'JsonBody' => [
                                'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING',
                                'MatchPattern' => [
                                    'All' => [
                                    ],
                                    'IncludedPaths' => ['<string>', ...],
                                ],
                                'MatchScope' => 'ALL|KEY|VALUE',
                                'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                            ],
                            'Method' => [
                            ],
                            'QueryString' => [
                            ],
                            'SingleHeader' => [
                                'Name' => '<string>',
                            ],
                            'SingleQueryArgument' => [
                                'Name' => '<string>',
                            ],
                            'UriPath' => [
                            ],
                        ],
                        'Size' => <integer>,
                        'TextTransformations' => [
                            [
                                'Priority' => <integer>,
                                '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',
                            ],
                            // ...
                        ],
                    ],
                    'SqliMatchStatement' => [
                        'FieldToMatch' => [
                            'AllQueryArguments' => [
                            ],
                            'Body' => [
                                'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                            ],
                            'Cookies' => [
                                'MatchPattern' => [
                                    'All' => [
                                    ],
                                    'ExcludedCookies' => ['<string>', ...],
                                    'IncludedCookies' => ['<string>', ...],
                                ],
                                'MatchScope' => 'ALL|KEY|VALUE',
                                'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                            ],
                            'Headers' => [
                                'MatchPattern' => [
                                    'All' => [
                                    ],
                                    'ExcludedHeaders' => ['<string>', ...],
                                    'IncludedHeaders' => ['<string>', ...],
                                ],
                                'MatchScope' => 'ALL|KEY|VALUE',
                                'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                            ],
                            'JsonBody' => [
                                'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING',
                                'MatchPattern' => [
                                    'All' => [
                                    ],
                                    'IncludedPaths' => ['<string>', ...],
                                ],
                                'MatchScope' => 'ALL|KEY|VALUE',
                                'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                            ],
                            'Method' => [
                            ],
                            'QueryString' => [
                            ],
                            'SingleHeader' => [
                                'Name' => '<string>',
                            ],
                            'SingleQueryArgument' => [
                                'Name' => '<string>',
                            ],
                            'UriPath' => [
                            ],
                        ],
                        'SensitivityLevel' => 'LOW|HIGH',
                        'TextTransformations' => [
                            [
                                'Priority' => <integer>,
                                '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',
                            ],
                            // ...
                        ],
                    ],
                    'XssMatchStatement' => [
                        'FieldToMatch' => [
                            'AllQueryArguments' => [
                            ],
                            'Body' => [
                                'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                            ],
                            'Cookies' => [
                                'MatchPattern' => [
                                    'All' => [
                                    ],
                                    'ExcludedCookies' => ['<string>', ...],
                                    'IncludedCookies' => ['<string>', ...],
                                ],
                                'MatchScope' => 'ALL|KEY|VALUE',
                                'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                            ],
                            'Headers' => [
                                'MatchPattern' => [
                                    'All' => [
                                    ],
                                    'ExcludedHeaders' => ['<string>', ...],
                                    'IncludedHeaders' => ['<string>', ...],
                                ],
                                'MatchScope' => 'ALL|KEY|VALUE',
                                'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                            ],
                            'JsonBody' => [
                                'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING',
                                'MatchPattern' => [
                                    'All' => [
                                    ],
                                    'IncludedPaths' => ['<string>', ...],
                                ],
                                'MatchScope' => 'ALL|KEY|VALUE',
                                'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                            ],
                            'Method' => [
                            ],
                            'QueryString' => [
                            ],
                            'SingleHeader' => [
                                'Name' => '<string>',
                            ],
                            'SingleQueryArgument' => [
                                'Name' => '<string>',
                            ],
                            'UriPath' => [
                            ],
                        ],
                        'TextTransformations' => [
                            [
                                'Priority' => <integer>,
                                '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',
                            ],
                            // ...
                        ],
                    ],
                ],
                'VisibilityConfig' => [
                    'CloudWatchMetricsEnabled' => true || false,
                    'MetricName' => '<string>',
                    'SampledRequestsEnabled' => true || false,
                ],
            ],
            // ...
        ],
        'VisibilityConfig' => [
            'CloudWatchMetricsEnabled' => true || false,
            'MetricName' => '<string>',
            'SampledRequestsEnabled' => true || false,
        ],
    ],
]

Result Details

Errors

• WAFInternalErrorException:

  Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.

• WAFInvalidParameterException:

  The operation failed because WAF didn't recognize a parameter in the request. For example:

  • You specified a parameter name or value that isn't valid.

  • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

  • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

  • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated.

• WAFNonexistentItemException:

  WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.

• WAFInvalidOperationException:

  The operation isn't valid.

GetSampledRequests

$result = $client->getSampledRequests([/* ... */]);
$promise = $client->getSampledRequestsAsync([/* ... */]);

Parameter Syntax

$result = $client->getSampledRequests([
    'MaxItems' => <integer>, // REQUIRED
    'RuleMetricName' => '<string>', // REQUIRED
    'Scope' => 'CLOUDFRONT|REGIONAL', // REQUIRED
    'TimeWindow' => [ // REQUIRED
        'EndTime' => <integer || string || DateTime>, // REQUIRED
        'StartTime' => <integer || string || DateTime>, // REQUIRED
    ],
    'WebAclArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'PopulationSize' => <integer>,
    'SampledRequests' => [
        [
            'Action' => '<string>',
            'CaptchaResponse' => [
                'FailureReason' => 'TOKEN_MISSING|TOKEN_EXPIRED|TOKEN_INVALID|TOKEN_DOMAIN_MISMATCH',
                'ResponseCode' => <integer>,
                'SolveTimestamp' => <integer>,
            ],
            'ChallengeResponse' => [
                'FailureReason' => 'TOKEN_MISSING|TOKEN_EXPIRED|TOKEN_INVALID|TOKEN_DOMAIN_MISMATCH',
                'ResponseCode' => <integer>,
                'SolveTimestamp' => <integer>,
            ],
            'Labels' => [
                [
                    'Name' => '<string>',
                ],
                // ...
            ],
            'OverriddenAction' => '<string>',
            'Request' => [
                'ClientIP' => '<string>',
                'Country' => '<string>',
                'HTTPVersion' => '<string>',
                'Headers' => [
                    [
                        'Name' => '<string>',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'Method' => '<string>',
                'URI' => '<string>',
            ],
            'RequestHeadersInserted' => [
                [
                    'Name' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
            'ResponseCodeSent' => <integer>,
            'RuleNameWithinRuleGroup' => '<string>',
            'Timestamp' => <DateTime>,
            'Weight' => <integer>,
        ],
        // ...
    ],
    'TimeWindow' => [
        'EndTime' => <DateTime>,
        'StartTime' => <DateTime>,
    ],
]

Result Details

Errors

• WAFNonexistentItemException:

  WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.

• WAFInternalErrorException:

  Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.

• WAFInvalidParameterException:

  The operation failed because WAF didn't recognize a parameter in the request. For example:

  • You specified a parameter name or value that isn't valid.

  • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

  • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

  • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated.

GetWebACL

$result = $client->getWebACL([/* ... */]);
$promise = $client->getWebACLAsync([/* ... */]);

Parameter Syntax

$result = $client->getWebACL([
    'Id' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
    'Scope' => 'CLOUDFRONT|REGIONAL', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ApplicationIntegrationURL' => '<string>',
    'LockToken' => '<string>',
    'WebACL' => [
        'ARN' => '<string>',
        'Capacity' => <integer>,
        'CaptchaConfig' => [
            'ImmunityTimeProperty' => [
                'ImmunityTime' => <integer>,
            ],
        ],
        'ChallengeConfig' => [
            'ImmunityTimeProperty' => [
                'ImmunityTime' => <integer>,
            ],
        ],
        'CustomResponseBodies' => [
            '<EntityName>' => [
                'Content' => '<string>',
                'ContentType' => 'TEXT_PLAIN|TEXT_HTML|APPLICATION_JSON',
            ],
            // ...
        ],
        'DefaultAction' => [
            'Allow' => [
                'CustomRequestHandling' => [
                    'InsertHeaders' => [
                        [
                            'Name' => '<string>',
                            'Value' => '<string>',
                        ],
                        // ...
                    ],
                ],
            ],
            'Block' => [
                'CustomResponse' => [
                    'CustomResponseBodyKey' => '<string>',
                    'ResponseCode' => <integer>,
                    'ResponseHeaders' => [
                        [
                            'Name' => '<string>',
                            'Value' => '<string>',
                        ],
                        // ...
                    ],
                ],
            ],
        ],
        'Description' => '<string>',
        'Id' => '<string>',
        'LabelNamespace' => '<string>',
        'ManagedByFirewallManager' => true || false,
        'Name' => '<string>',
        'PostProcessFirewallManagerRuleGroups' => [
            [
                'FirewallManagerStatement' => [
                    'ManagedRuleGroupStatement' => [
                        'ExcludedRules' => [
                            [
                                'Name' => '<string>',
                            ],
                            // ...
                        ],
                        'ManagedRuleGroupConfigs' => [
                            [
                                'AWSManagedRulesBotControlRuleSet' => [
                                    'InspectionLevel' => 'COMMON|TARGETED',
                                ],
                                'LoginPath' => '<string>',
                                'PasswordField' => [
                                    'Identifier' => '<string>',
                                ],
                                'PayloadType' => 'JSON|FORM_ENCODED',
                                'UsernameField' => [
                                    'Identifier' => '<string>',
                                ],
                            ],
                            // ...
                        ],
                        'Name' => '<string>',
                        'RuleActionOverrides' => [
                            [
                                'ActionToUse' => [
                                    'Allow' => [
                                        'CustomRequestHandling' => [
                                            'InsertHeaders' => [
                                                [
                                                    'Name' => '<string>',
                                                    'Value' => '<string>',
                                                ],
                                                // ...
                                            ],
                                        ],
                                    ],
                                    'Block' => [
                                        'CustomResponse' => [
                                            'CustomResponseBodyKey' => '<string>',
                                            'ResponseCode' => <integer>,
                                            'ResponseHeaders' => [
                                                [
                                                    'Name' => '<string>',
                                                    'Value' => '<string>',
                                                ],
                                                // ...
                                            ],
                                        ],
                                    ],
                                    'Captcha' => [
                                        'CustomRequestHandling' => [
                                            'InsertHeaders' => [
                                                [
                                                    'Name' => '<string>',
                                                    'Value' => '<string>',
                                                ],
                                                // ...
                                            ],
                                        ],
                                    ],
                                    'Challenge' => [
                                        'CustomRequestHandling' => [
                                            'InsertHeaders' => [
                                                [
                                                    'Name' => '<string>',
                                                    'Value' => '<string>',
                                                ],
                                                // ...
                                            ],
                                        ],
                                    ],
                                    'Count' => [
                                        'CustomRequestHandling' => [
                                            'InsertHeaders' => [
                                                [
                                                    'Name' => '<string>',
                                                    'Value' => '<string>',
                                                ],
                                                // ...
                                            ],
                                        ],
                                    ],
                                ],
                                'Name' => '<string>',
                            ],
                            // ...
                        ],
                        'ScopeDownStatement' => [
                            'AndStatement' => [
                                'Statements' => [
                                    [...], // RECURSIVE
                                    // ...
                                ],
                            ],
                            'ByteMatchStatement' => [
                                'FieldToMatch' => [
                                    'AllQueryArguments' => [
                                    ],
                                    'Body' => [
                                        'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                                    ],
                                    'Cookies' => [
                                        'MatchPattern' => [
                                            'All' => [
                                            ],
                                            'ExcludedCookies' => ['<string>', ...],
                                            'IncludedCookies' => ['<string>', ...],
                                        ],
                                        'MatchScope' => 'ALL|KEY|VALUE',
                                        'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                                    ],
                                    'Headers' => [
                                        'MatchPattern' => [
                                            'All' => [
                                            ],
                                            'ExcludedHeaders' => ['<string>', ...],
                                            'IncludedHeaders' => ['<string>', ...],
                                        ],
                                        'MatchScope' => 'ALL|KEY|VALUE',
                                        'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                                    ],
                                    'JsonBody' => [
                                        'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING',
                                        'MatchPattern' => [
                                            'All' => [
                                            ],
                                            'IncludedPaths' => ['<string>', ...],
                                        ],
                                        'MatchScope' => 'ALL|KEY|VALUE',
                                        'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                                    ],
                                    'Method' => [
                                    ],
                                    'QueryString' => [
                                    ],
                                    'SingleHeader' => [
                                        'Name' => '<string>',
                                    ],
                                    'SingleQueryArgument' => [
                                        'Name' => '<string>',
                                    ],
                                    'UriPath' => [
                                    ],
                                ],
                                'PositionalConstraint' => 'EXACTLY|STARTS_WITH|ENDS_WITH|CONTAINS|CONTAINS_WORD',
                                'SearchString' => <string || resource || Psr\Http\Message\StreamInterface>,
                                'TextTransformations' => [
                                    [
                                        'Priority' => <integer>,
                                        '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' => ['<string>', ...],
                                'ForwardedIPConfig' => [
                                    'FallbackBehavior' => 'MATCH|NO_MATCH',
                                    'HeaderName' => '<string>',
                                ],
                            ],
                            'IPSetReferenceStatement' => [
                                'ARN' => '<string>',
                                'IPSetForwardedIPConfig' => [
                                    'FallbackBehavior' => 'MATCH|NO_MATCH',
                                    'HeaderName' => '<string>',
                                    'Position' => 'FIRST|LAST|ANY',
                                ],
                            ],
                            'LabelMatchStatement' => [
                                'Key' => '<string>',
                                'Scope' => 'LABEL|NAMESPACE',
                            ],
                            'ManagedRuleGroupStatement' => [...], // RECURSIVE
                            'NotStatement' => [
                                'Statement' => [...], // RECURSIVE
                            ],
                            'OrStatement' => [
                                'Statements' => [
                                    [...], // RECURSIVE
                                    // ...
                                ],
                            ],
                            'RateBasedStatement' => [
                                'AggregateKeyType' => 'IP|FORWARDED_IP',
                                'ForwardedIPConfig' => [
                                    'FallbackBehavior' => 'MATCH|NO_MATCH',
                                    'HeaderName' => '<string>',
                                ],
                                'Limit' => <integer>,
                                'ScopeDownStatement' => [...], // RECURSIVE
                            ],
                            'RegexMatchStatement' => [
                                'FieldToMatch' => [
                                    'AllQueryArguments' => [
                                    ],
                                    'Body' => [
                                        'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                                    ],
                                    'Cookies' => [
                                        'MatchPattern' => [
                                            'All' => [
                                            ],
                                            'ExcludedCookies' => ['<string>', ...],
                                            'IncludedCookies' => ['<string>', ...],
                                        ],
                                        'MatchScope' => 'ALL|KEY|VALUE',
                                        'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                                    ],
                                    'Headers' => [
                                        'MatchPattern' => [
                                            'All' => [
                                            ],
                                            'ExcludedHeaders' => ['<string>', ...],
                                            'IncludedHeaders' => ['<string>', ...],
                                        ],
                                        'MatchScope' => 'ALL|KEY|VALUE',
                                        'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                                    ],
                                    'JsonBody' => [
                                        'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING',
                                        'MatchPattern' => [
                                            'All' => [
                                            ],
                                            'IncludedPaths' => ['<string>', ...],
                                        ],
                                        'MatchScope' => 'ALL|KEY|VALUE',
                                        'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                                    ],
                                    'Method' => [
                                    ],
                                    'QueryString' => [
                                    ],
                                    'SingleHeader' => [
                                        'Name' => '<string>',
                                    ],
                                    'SingleQueryArgument' => [
                                        'Name' => '<string>',
                                    ],
                                    'UriPath' => [
                                    ],
                                ],
                                'RegexString' => '<string>',
                                'TextTransformations' => [
                                    [
                                        'Priority' => <integer>,
                                        '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',
                                    ],
                                    // ...
                                ],
                            ],
                            'RegexPatternSetReferenceStatement' => [
                                'ARN' => '<string>',
                                'FieldToMatch' => [
                                    'AllQueryArguments' => [
                                    ],
                                    'Body' => [
                                        'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                                    ],
                                    'Cookies' => [
                                        'MatchPattern' => [
                                            'All' => [
                                            ],
                                            'ExcludedCookies' => ['<string>', ...],
                                            'IncludedCookies' => ['<string>', ...],
                                        ],
                                        'MatchScope' => 'ALL|KEY|VALUE',
                                        'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                                    ],
                                    'Headers' => [
                                        'MatchPattern' => [
                                            'All' => [
                                            ],
                                            'ExcludedHeaders' => ['<string>', ...],
                                            'IncludedHeaders' => ['<string>', ...],
                                        ],
                                        'MatchScope' => 'ALL|KEY|VALUE',
                                        'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                                    ],
                                    'JsonBody' => [
                                        'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING',
                                        'MatchPattern' => [
                                            'All' => [
                                            ],
                                            'IncludedPaths' => ['<string>', ...],
                                        ],
                                        'MatchScope' => 'ALL|KEY|VALUE',
                                        'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                                    ],
                                    'Method' => [
                                    ],
                                    'QueryString' => [
                                    ],
                                    'SingleHeader' => [
                                        'Name' => '<string>',
                                    ],
                                    'SingleQueryArgument' => [
                                        'Name' => '<string>',
                                    ],
                                    'UriPath' => [
                                    ],
                                ],
                                'TextTransformations' => [
                                    [
                                        'Priority' => <integer>,
                                        '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',
                                    ],
                                    // ...
                                ],
                            ],
                            'RuleGroupReferenceStatement' => [
                                'ARN' => '<string>',
                                'ExcludedRules' => [
                                    [
                                        'Name' => '<string>',
                                    ],
                                    // ...
                                ],
                                'RuleActionOverrides' => [
                                    [
                                        'ActionToUse' => [
                                            'Allow' => [
                                                'CustomRequestHandling' => [
                                                    'InsertHeaders' => [
                                                        [
                                                            'Name' => '<string>',
                                                            'Value' => '<string>',
                                                        ],
                                                        // ...
                                                    ],
                                                ],
                                            ],
                                            'Block' => [
                                                'CustomResponse' => [
                                                    'CustomResponseBodyKey' => '<string>',
                                                    'ResponseCode' => <integer>,
                                                    'ResponseHeaders' => [
                                                        [
                                                            'Name' => '<string>',
                                                            'Value' => '<string>',
                                                        ],
                                                        // ...
                                                    ],
                                                ],
                                            ],
                                            'Captcha' => [
                                                'CustomRequestHandling' => [
                                                    'InsertHeaders' => [
                                                        [
                                                            'Name' => '<string>',
                                                            'Value' => '<string>',
                                                        ],
                                                        // ...
                                                    ],
                                                ],
                                            ],
                                            'Challenge' => [
                                                'CustomRequestHandling' => [
                                                    'InsertHeaders' => [
                                                        [
                                                            'Name' => '<string>',
                                                            'Value' => '<string>',
                                                        ],
                                                        // ...
                                                    ],
                                                ],
                                            ],
                                            'Count' => [
                                                'CustomRequestHandling' => [
                                                    'InsertHeaders' => [
                                                        [
                                                            'Name' => '<string>',
                                                            'Value' => '<string>',
                                                        ],
                                                        // ...
                                                    ],
                                                ],
                                            ],
                                        ],
                                        'Name' => '<string>',
                                    ],
                                    // ...
                                ],
                            ],
                            'SizeConstraintStatement' => [
                                'ComparisonOperator' => 'EQ|NE|LE|LT|GE|GT',
                                'FieldToMatch' => [
                                    'AllQueryArguments' => [
                                    ],
                                    'Body' => [
                                        'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                                    ],
                                    'Cookies' => [
                                        'MatchPattern' => [
                                            'All' => [
                                            ],
                                            'ExcludedCookies' => ['<string>', ...],
                                            'IncludedCookies' => ['<string>', ...],
                                        ],
                                        'MatchScope' => 'ALL|KEY|VALUE',
                                        'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                                    ],
                                    'Headers' => [
                                        'MatchPattern' => [
                                            'All' => [
                                            ],
                                            'ExcludedHeaders' => ['<string>', ...],
                                            'IncludedHeaders' => ['<string>', ...],
                                        ],
                                        'MatchScope' => 'ALL|KEY|VALUE',
                                        'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                                    ],
                                    'JsonBody' => [
                                        'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING',
                                        'MatchPattern' => [
                                            'All' => [
                                            ],
                                            'IncludedPaths' => ['<string>', ...],
                                        ],
                                        'MatchScope' => 'ALL|KEY|VALUE',
                                        'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                                    ],
                                    'Method' => [
                                    ],
                                    'QueryString' => [
                                    ],
                                    'SingleHeader' => [
                                        'Name' => '<string>',
                                    ],
                                    'SingleQueryArgument' => [
                                        'Name' => '<string>',
                                    ],
                                    'UriPath' => [
                                    ],
                                ],
                                'Size' => <integer>,
                                'TextTransformations' => [
                                    [
                                        'Priority' => <integer>,
                                        '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',
                                    ],
                                    // ...
                                ],
                            ],
                            'SqliMatchStatement' => [
                                'FieldToMatch' => [
                                    'AllQueryArguments' => [
                                    ],
                                    'Body' => [
                                        'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                                    ],
                                    'Cookies' => [
                                        'MatchPattern' => [
                                            'All' => [
                                            ],
                                            'ExcludedCookies' => ['<string>', ...],
                                            'IncludedCookies' => ['<string>', ...],
                                        ],
                                        'MatchScope' => 'ALL|KEY|VALUE',
                                        'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                                    ],
                                    'Headers' => [
                                        'MatchPattern' => [
                                            'All' => [
                                            ],
                                            'ExcludedHeaders' => ['<string>', ...],
                                            'IncludedHeaders' => ['<string>', ...],
                                        ],
                                        'MatchScope' => 'ALL|KEY|VALUE',
                                        'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                                    ],
                                    'JsonBody' => [
                                        'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING',
                                        'MatchPattern' => [
                                            'All' => [
                                            ],
                                            'IncludedPaths' => ['<string>', ...],
                                        ],
                                        'MatchScope' => 'ALL|KEY|VALUE',
                                        'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                                    ],
                                    'Method' => [
                                    ],
                                    'QueryString' => [
                                    ],
                                    'SingleHeader' => [
                                        'Name' => '<string>',
                                    ],
                                    'SingleQueryArgument' => [
                                        'Name' => '<string>',
                                    ],
                                    'UriPath' => [
                                    ],
                                ],
                                'SensitivityLevel' => 'LOW|HIGH',
                                'TextTransformations' => [
                                    [
                                        'Priority' => <integer>,
                                        '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',
                                    ],
                                    // ...
                                ],
                            ],
                            'XssMatchStatement' => [
                                'FieldToMatch' => [
                                    'AllQueryArguments' => [
                                    ],
                                    'Body' => [
                                        'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                                    ],
                                    'Cookies' => [
                                        'MatchPattern' => [
                                            'All' => [
                                            ],
                                            'ExcludedCookies' => ['<string>', ...],
                                            'IncludedCookies' => ['<string>', ...],
                                        ],
                                        'MatchScope' => 'ALL|KEY|VALUE',
                                        'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                                    ],
                                    'Headers' => [
                                        'MatchPattern' => [
                                            'All' => [
                                            ],
                                            'ExcludedHeaders' => ['<string>', ...],
                                            'IncludedHeaders' => ['<string>', ...],
                                        ],
                                        'MatchScope' => 'ALL|KEY|VALUE',
                                        'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                                    ],
                                    'JsonBody' => [
                                        'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING',
                                        'MatchPattern' => [
                                            'All' => [
                                            ],
                                            'IncludedPaths' => ['<string>', ...],
                                        ],
                                        'MatchScope' => 'ALL|KEY|VALUE',
                                        'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                                    ],
                                    'Method' => [
                                    ],
                                    'QueryString' => [
                                    ],
                                    'SingleHeader' => [
                                        'Name' => '<string>',
                                    ],
                                    'SingleQueryArgument' => [
                                        'Name' => '<string>',
                                    ],
                                    'UriPath' => [
                                    ],
                                ],
                                'TextTransformations' => [
                                    [
                                        'Priority' => <integer>,
                                        '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',
                                    ],
                                    // ...
                                ],
                            ],
                        ],
                        'VendorName' => '<string>',
                        'Version' => '<string>',
                    ],
                    'RuleGroupReferenceStatement' => [
                        'ARN' => '<string>',
                        'ExcludedRules' => [
                            [
                                'Name' => '<string>',
                            ],
                            // ...
                        ],
                        'RuleActionOverrides' => [
                            [
                                'ActionToUse' => [
                                    'Allow' => [
                                        'CustomRequestHandling' => [
                                            'InsertHeaders' => [
                                                [
                                                    'Name' => '<string>',
                                                    'Value' => '<string>',
                                                ],
                                                // ...
                                            ],
                                        ],
                                    ],
                                    'Block' => [
                                        'CustomResponse' => [
                                            'CustomResponseBodyKey' => '<string>',
                                            'ResponseCode' => <integer>,
                                            'ResponseHeaders' => [
                                                [
                                                    'Name' => '<string>',
                                                    'Value' => '<string>',
                                                ],
                                                // ...
                                            ],
                                        ],
                                    ],
                                    'Captcha' => [
                                        'CustomRequestHandling' => [
                                            'InsertHeaders' => [
                                                [
                                                    'Name' => '<string>',
                                                    'Value' => '<string>',
                                                ],
                                                // ...
                                            ],
                                        ],
                                    ],
                                    'Challenge' => [
                                        'CustomRequestHandling' => [
                                            'InsertHeaders' => [
                                                [
                                                    'Name' => '<string>',
                                                    'Value' => '<string>',
                                                ],
                                                // ...
                                            ],
                                        ],
                                    ],
                                    'Count' => [
                                        'CustomRequestHandling' => [
                                            'InsertHeaders' => [
                                                [
                                                    'Name' => '<string>',
                                                    'Value' => '<string>',
                                                ],
                                                // ...
                                            ],
                                        ],
                                    ],
                                ],
                                'Name' => '<string>',
                            ],
                            // ...
                        ],
                    ],
                ],
                'Name' => '<string>',
                'OverrideAction' => [
                    'Count' => [
                        'CustomRequestHandling' => [
                            'InsertHeaders' => [
                                [
                                    'Name' => '<string>',
                                    'Value' => '<string>',
                                ],
                                // ...
                            ],
                        ],
                    ],
                    'None' => [
                    ],
                ],
                'Priority' => <integer>,
                'VisibilityConfig' => [
                    'CloudWatchMetricsEnabled' => true || false,
                    'MetricName' => '<string>',
                    'SampledRequestsEnabled' => true || false,
                ],
            ],
            // ...
        ],
        'PreProcessFirewallManagerRuleGroups' => [
            [
                'FirewallManagerStatement' => [
                    'ManagedRuleGroupStatement' => [
                        'ExcludedRules' => [
                            [
                                'Name' => '<string>',
                            ],
                            // ...
                        ],
                        'ManagedRuleGroupConfigs' => [
                            [
                                'AWSManagedRulesBotControlRuleSet' => [
                                    'InspectionLevel' => 'COMMON|TARGETED',
                                ],
                                'LoginPath' => '<string>',
                                'PasswordField' => [
                                    'Identifier' => '<string>',
                                ],
                                'PayloadType' => 'JSON|FORM_ENCODED',
                                'UsernameField' => [
                                    'Identifier' => '<string>',
                                ],
                            ],
                            // ...
                        ],
                        'Name' => '<string>',
                        'RuleActionOverrides' => [
                            [
                                'ActionToUse' => [
                                    'Allow' => [
                                        'CustomRequestHandling' => [
                                            'InsertHeaders' => [
                                                [
                                                    'Name' => '<string>',
                                                    'Value' => '<string>',
                                                ],
                                                // ...
                                            ],
                                        ],
                                    ],
                                    'Block' => [
                                        'CustomResponse' => [
                                            'CustomResponseBodyKey' => '<string>',
                                            'ResponseCode' => <integer>,
                                            'ResponseHeaders' => [
                                                [
                                                    'Name' => '<string>',
                                                    'Value' => '<string>',
                                                ],
                                                // ...
                                            ],
                                        ],
                                    ],
                                    'Captcha' => [
                                        'CustomRequestHandling' => [
                                            'InsertHeaders' => [
                                                [
                                                    'Name' => '<string>',
                                                    'Value' => '<string>',
                                                ],
                                                // ...
                                            ],
                                        ],
                                    ],
                                    'Challenge' => [
                                        'CustomRequestHandling' => [
                                            'InsertHeaders' => [
                                                [
                                                    'Name' => '<string>',
                                                    'Value' => '<string>',
                                                ],
                                                // ...
                                            ],
                                        ],
                                    ],
                                    'Count' => [
                                        'CustomRequestHandling' => [
                                            'InsertHeaders' => [
                                                [
                                                    'Name' => '<string>',
                                                    'Value' => '<string>',
                                                ],
                                                // ...
                                            ],
                                        ],
                                    ],
                                ],
                                'Name' => '<string>',
                            ],
                            // ...
                        ],
                        'ScopeDownStatement' => [
                            'AndStatement' => [
                                'Statements' => [
                                    [...], // RECURSIVE
                                    // ...
                                ],
                            ],
                            'ByteMatchStatement' => [
                                'FieldToMatch' => [
                                    'AllQueryArguments' => [
                                    ],
                                    'Body' => [
                                        'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                                    ],
                                    'Cookies' => [
                                        'MatchPattern' => [
                                            'All' => [
                                            ],
                                            'ExcludedCookies' => ['<string>', ...],
                                            'IncludedCookies' => ['<string>', ...],
                                        ],
                                        'MatchScope' => 'ALL|KEY|VALUE',
                                        'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                                    ],
                                    'Headers' => [
                                        'MatchPattern' => [
                                            'All' => [
                                            ],
                                            'ExcludedHeaders' => ['<string>', ...],
                                            'IncludedHeaders' => ['<string>', ...],
                                        ],
                                        'MatchScope' => 'ALL|KEY|VALUE',
                                        'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                                    ],
                                    'JsonBody' => [
                                        'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING',
                                        'MatchPattern' => [
                                            'All' => [
                                            ],
                                            'IncludedPaths' => ['<string>', ...],
                                        ],
                                        'MatchScope' => 'ALL|KEY|VALUE',
                                        'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                                    ],
                                    'Method' => [
                                    ],
                                    'QueryString' => [
                                    ],
                                    'SingleHeader' => [
                                        'Name' => '<string>',
                                    ],
                                    'SingleQueryArgument' => [
                                        'Name' => '<string>',
                                    ],
                                    'UriPath' => [
                                    ],
                                ],
                                'PositionalConstraint' => 'EXACTLY|STARTS_WITH|ENDS_WITH|CONTAINS|CONTAINS_WORD',
                                'SearchString' => <string || resource || Psr\Http\Message\StreamInterface>,
                                'TextTransformations' => [
                                    [
                                        'Priority' => <integer>,
                                        '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' => ['<string>', ...],
                                'ForwardedIPConfig' => [
                                    'FallbackBehavior' => 'MATCH|NO_MATCH',
                                    'HeaderName' => '<string>',
                                ],
                            ],
                            'IPSetReferenceStatement' => [
                                'ARN' => '<string>',
                                'IPSetForwardedIPConfig' => [
                                    'FallbackBehavior' => 'MATCH|NO_MATCH',
                                    'HeaderName' => '<string>',
                                    'Position' => 'FIRST|LAST|ANY',
                                ],
                            ],
                            'LabelMatchStatement' => [
                                'Key' => '<string>',
                                'Scope' => 'LABEL|NAMESPACE',
                            ],
                            'ManagedRuleGroupStatement' => [...], // RECURSIVE
                            'NotStatement' => [
                                'Statement' => [...], // RECURSIVE
                            ],
                            'OrStatement' => [
                                'Statements' => [
                                    [...], // RECURSIVE
                                    // ...
                                ],
                            ],
                            'RateBasedStatement' => [
                                'AggregateKeyType' => 'IP|FORWARDED_IP',
                                'ForwardedIPConfig' => [
                                    'FallbackBehavior' => 'MATCH|NO_MATCH',
                                    'HeaderName' => '<string>',
                                ],
                                'Limit' => <integer>,
                                'ScopeDownStatement' => [...], // RECURSIVE
                            ],
                            'RegexMatchStatement' => [
                                'FieldToMatch' => [
                                    'AllQueryArguments' => [
                                    ],
                                    'Body' => [
                                        'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                                    ],
                                    'Cookies' => [
                                        'MatchPattern' => [
                                            'All' => [
                                            ],
                                            'ExcludedCookies' => ['<string>', ...],
                                            'IncludedCookies' => ['<string>', ...],
                                        ],
                                        'MatchScope' => 'ALL|KEY|VALUE',
                                        'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                                    ],
                                    'Headers' => [
                                        'MatchPattern' => [
                                            'All' => [
                                            ],
                                            'ExcludedHeaders' => ['<string>', ...],
                                            'IncludedHeaders' => ['<string>', ...],
                                        ],
                                        'MatchScope' => 'ALL|KEY|VALUE',
                                        'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                                    ],
                                    'JsonBody' => [
                                        'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING',
                                        'MatchPattern' => [
                                            'All' => [
                                            ],
                                            'IncludedPaths' => ['<string>', ...],
                                        ],
                                        'MatchScope' => 'ALL|KEY|VALUE',
                                        'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                                    ],
                                    'Method' => [
                                    ],
                                    'QueryString' => [
                                    ],
                                    'SingleHeader' => [
                                        'Name' => '<string>',
                                    ],
                                    'SingleQueryArgument' => [
                                        'Name' => '<string>',
                                    ],
                                    'UriPath' => [
                                    ],
                                ],
                                'RegexString' => '<string>',
                                'TextTransformations' => [
                                    [
                                        'Priority' => <integer>,
                                        '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',
                                    ],
                                    // ...
                                ],
                            ],
                            'RegexPatternSetReferenceStatement' => [
                                'ARN' => '<string>',
                                'FieldToMatch' => [
                                    'AllQueryArguments' => [
                                    ],
                                    'Body' => [
                                        'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                                    ],
                                    'Cookies' => [
                                        'MatchPattern' => [
                                            'All' => [
                                            ],
                                            'ExcludedCookies' => ['<string>', ...],
                                            'IncludedCookies' => ['<string>', ...],
                                        ],
                                        'MatchScope' => 'ALL|KEY|VALUE',
                                        'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                                    ],
                                    'Headers' => [
                                        'MatchPattern' => [
                                            'All' => [
                                            ],
                                            'ExcludedHeaders' => ['<string>', ...],
                                            'IncludedHeaders' => ['<string>', ...],
                                        ],
                                        'MatchScope' => 'ALL|KEY|VALUE',
                                        'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                                    ],
                                    'JsonBody' => [
                                        'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING',
                                        'MatchPattern' => [
                                            'All' => [
                                            ],
                                            'IncludedPaths' => ['<string>', ...],
                                        ],
                                        'MatchScope' => 'ALL|KEY|VALUE',
                                        'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                                    ],
                                    'Method' => [
                                    ],
                                    'QueryString' => [
                                    ],
                                    'SingleHeader' => [
                                        'Name' => '<string>',
                                    ],
                                    'SingleQueryArgument' => [
                                        'Name' => '<string>',
                                    ],
                                    'UriPath' => [
                                    ],
                                ],
                                'TextTransformations' => [
                                    [
                                        'Priority' => <integer>,
                                        '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',
                                    ],
                                    // ...
                                ],
                            ],
                            'RuleGroupReferenceStatement' => [
                                'ARN' => '<string>',
                                'ExcludedRules' => [
                                    [
                                        'Name' => '<string>',
                                    ],
                                    // ...
                                ],
                                'RuleActionOverrides' => [
                                    [
                                        'ActionToUse' => [
                                            'Allow' => [
                                                'CustomRequestHandling' => [
                                                    'InsertHeaders' => [
                                                        [
                                                            'Name' => '<string>',
                                                            'Value' => '<string>',
                                                        ],
                                                        // ...
                                                    ],
                                                ],
                                            ],
                                            'Block' => [
                                                'CustomResponse' => [
                                                    'CustomResponseBodyKey' => '<string>',
                                                    'ResponseCode' => <integer>,
                                                    'ResponseHeaders' => [
                                                        [
                                                            'Name' => '<string>',
                                                            'Value' => '<string>',
                                                        ],
                                                        // ...
                                                    ],
                                                ],
                                            ],
                                            'Captcha' => [
                                                'CustomRequestHandling' => [
                                                    'InsertHeaders' => [
                                                        [
                                                            'Name' => '<string>',
                                                            'Value' => '<string>',
                                                        ],
                                                        // ...
                                                    ],
                                                ],
                                            ],
                                            'Challenge' => [
                                                'CustomRequestHandling' => [
                                                    'InsertHeaders' => [
                                                        [
                                                            'Name' => '<string>',
                                                            'Value' => '<string>',
                                                        ],
                                                        // ...
                                                    ],
                                                ],
                                            ],
                                            'Count' => [
                                                'CustomRequestHandling' => [
                                                    'InsertHeaders' => [
                                                        [
                                                            'Name' => '<string>',
                                                            'Value' => '<string>',
                                                        ],
                                                        // ...
                                                    ],
                                                ],
                                            ],
                                        ],
                                        'Name' => '<string>',
                                    ],
                                    // ...
                                ],
                            ],
                            'SizeConstraintStatement' => [
                                'ComparisonOperator' => 'EQ|NE|LE|LT|GE|GT',
                                'FieldToMatch' => [
                                    'AllQueryArguments' => [
                                    ],
                                    'Body' => [
                                        'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                                    ],
                                    'Cookies' => [
                                        'MatchPattern' => [
                                            'All' => [
                                            ],
                                            'ExcludedCookies' => ['<string>', ...],
                                            'IncludedCookies' => ['<string>', ...],
                                        ],
                                        'MatchScope' => 'ALL|KEY|VALUE',
                                        'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                                    ],
                                    'Headers' => [
                                        'MatchPattern' => [
                                            'All' => [
                                            ],
                                            'ExcludedHeaders' => ['<string>', ...],
                                            'IncludedHeaders' => ['<string>', ...],
                                        ],
                                        'MatchScope' => 'ALL|KEY|VALUE',
                                        'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                                    ],
                                    'JsonBody' => [
                                        'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING',
                                        'MatchPattern' => [
                                            'All' => [
                                            ],
                                            'IncludedPaths' => ['<string>', ...],
                                        ],
                                        'MatchScope' => 'ALL|KEY|VALUE',
                                        'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                                    ],
                                    'Method' => [
                                    ],
                                    'QueryString' => [
                                    ],
                                    'SingleHeader' => [
                                        'Name' => '<string>',
                                    ],
                                    'SingleQueryArgument' => [
                                        'Name' => '<string>',
                                    ],
                                    'UriPath' => [
                                    ],
                                ],
                                'Size' => <integer>,
                                'TextTransformations' => [
                                    [
                                        'Priority' => <integer>,
                                        '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',
                                    ],
                                    // ...
                                ],
                            ],
                            'SqliMatchStatement' => [
                                'FieldToMatch' => [
                                    'AllQueryArguments' => [
                                    ],
                                    'Body' => [
                                        'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                                    ],
                                    'Cookies' => [
                                        'MatchPattern' => [
                                            'All' => [
                                            ],
                                            'ExcludedCookies' => ['<string>', ...],
                                            'IncludedCookies' => ['<string>', ...],
                                        ],
                                        'MatchScope' => 'ALL|KEY|VALUE',
                                        'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                                    ],
                                    'Headers' => [
                                        'MatchPattern' => [
                                            'All' => [
                                            ],
                                            'ExcludedHeaders' => ['<string>', ...],
                                            'IncludedHeaders' => ['<string>', ...],
                                        ],
                                        'MatchScope' => 'ALL|KEY|VALUE',
                                        'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                                    ],
                                    'JsonBody' => [
                                        'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING',
                                        'MatchPattern' => [
                                            'All' => [
                                            ],
                                            'IncludedPaths' => ['<string>', ...],
                                        ],
                                        'MatchScope' => 'ALL|KEY|VALUE',
                                        'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                                    ],
                                    'Method' => [
                                    ],
                                    'QueryString' => [
                                    ],
                                    'SingleHeader' => [
                                        'Name' => '<string>',
                                    ],
                                    'SingleQueryArgument' => [
                                        'Name' => '<string>',
                                    ],
                                    'UriPath' => [
                                    ],
                                ],
                                'SensitivityLevel' => 'LOW|HIGH',
                                'TextTransformations' => [
                                    [
                                        'Priority' => <integer>,
                                        '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',
                                    ],
                                    // ...
                                ],
                            ],
                            'XssMatchStatement' => [
                                'FieldToMatch' => [
                                    'AllQueryArguments' => [
                                    ],
                                    'Body' => [
                                        'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                                    ],
                                    'Cookies' => [
                                        'MatchPattern' => [
                                            'All' => [
                                            ],
                                            'ExcludedCookies' => ['<string>', ...],
                                            'IncludedCookies' => ['<string>', ...],
                                        ],
                                        'MatchScope' => 'ALL|KEY|VALUE',
                                        'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                                    ],
                                    'Headers' => [
                                        'MatchPattern' => [
                                            'All' => [
                                            ],
                                            'ExcludedHeaders' => ['<string>', ...],
                                            'IncludedHeaders' => ['<string>', ...],
                                        ],
                                        'MatchScope' => 'ALL|KEY|VALUE',
                                        'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                                    ],
                                    'JsonBody' => [
                                        'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING',
                                        'MatchPattern' => [
                                            'All' => [
                                            ],
                                            'IncludedPaths' => ['<string>', ...],
                                        ],
                                        'MatchScope' => 'ALL|KEY|VALUE',
                                        'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                                    ],
                                    'Method' => [
                                    ],
                                    'QueryString' => [
                                    ],
                                    'SingleHeader' => [
                                        'Name' => '<string>',
                                    ],
                                    'SingleQueryArgument' => [
                                        'Name' => '<string>',
                                    ],
                                    'UriPath' => [
                                    ],
                                ],
                                'TextTransformations' => [
                                    [
                                        'Priority' => <integer>,
                                        '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',
                                    ],
                                    // ...
                                ],
                            ],
                        ],
                        'VendorName' => '<string>',
                        'Version' => '<string>',
                    ],
                    'RuleGroupReferenceStatement' => [
                        'ARN' => '<string>',
                        'ExcludedRules' => [
                            [
                                'Name' => '<string>',
                            ],
                            // ...
                        ],
                        'RuleActionOverrides' => [
                            [
                                'ActionToUse' => [
                                    'Allow' => [
                                        'CustomRequestHandling' => [
                                            'InsertHeaders' => [
                                                [
                                                    'Name' => '<string>',
                                                    'Value' => '<string>',
                                                ],
                                                // ...
                                            ],
                                        ],
                                    ],
                                    'Block' => [
                                        'CustomResponse' => [
                                            'CustomResponseBodyKey' => '<string>',
                                            'ResponseCode' => <integer>,
                                            'ResponseHeaders' => [
                                                [
                                                    'Name' => '<string>',
                                                    'Value' => '<string>',
                                                ],
                                                // ...
                                            ],
                                        ],
                                    ],
                                    'Captcha' => [
                                        'CustomRequestHandling' => [
                                            'InsertHeaders' => [
                                                [
                                                    'Name' => '<string>',
                                                    'Value' => '<string>',
                                                ],
                                                // ...
                                            ],
                                        ],
                                    ],
                                    'Challenge' => [
                                        'CustomRequestHandling' => [
                                            'InsertHeaders' => [
                                                [
                                                    'Name' => '<string>',
                                                    'Value' => '<string>',
                                                ],
                                                // ...
                                            ],
                                        ],
                                    ],
                                    'Count' => [
                                        'CustomRequestHandling' => [
                                            'InsertHeaders' => [
                                                [
                                                    'Name' => '<string>',
                                                    'Value' => '<string>',
                                                ],
                                                // ...
                                            ],
                                        ],
                                    ],
                                ],
                                'Name' => '<string>',
                            ],
                            // ...
                        ],
                    ],
                ],
                'Name' => '<string>',
                'OverrideAction' => [
                    'Count' => [
                        'CustomRequestHandling' => [
                            'InsertHeaders' => [
                                [
                                    'Name' => '<string>',
                                    'Value' => '<string>',
                                ],
                                // ...
                            ],
                        ],
                    ],
                    'None' => [
                    ],
                ],
                'Priority' => <integer>,
                'VisibilityConfig' => [
                    'CloudWatchMetricsEnabled' => true || false,
                    'MetricName' => '<string>',
                    'SampledRequestsEnabled' => true || false,
                ],
            ],
            // ...
        ],
        'Rules' => [
            [
                'Action' => [
                    'Allow' => [
                        'CustomRequestHandling' => [
                            'InsertHeaders' => [
                                [
                                    'Name' => '<string>',
                                    'Value' => '<string>',
                                ],
                                // ...
                            ],
                        ],
                    ],
                    'Block' => [
                        'CustomResponse' => [
                            'CustomResponseBodyKey' => '<string>',
                            'ResponseCode' => <integer>,
                            'ResponseHeaders' => [
                                [
                                    'Name' => '<string>',
                                    'Value' => '<string>',
                                ],
                                // ...
                            ],
                        ],
                    ],
                    'Captcha' => [
                        'CustomRequestHandling' => [
                            'InsertHeaders' => [
                                [
                                    'Name' => '<string>',
                                    'Value' => '<string>',
                                ],
                                // ...
                            ],
                        ],
                    ],
                    'Challenge' => [
                        'CustomRequestHandling' => [
                            'InsertHeaders' => [
                                [
                                    'Name' => '<string>',
                                    'Value' => '<string>',
                                ],
                                // ...
                            ],
                        ],
                    ],
                    'Count' => [
                        'CustomRequestHandling' => [
                            'InsertHeaders' => [
                                [
                                    'Name' => '<string>',
                                    'Value' => '<string>',
                                ],
                                // ...
                            ],
                        ],
                    ],
                ],
                'CaptchaConfig' => [
                    'ImmunityTimeProperty' => [
                        'ImmunityTime' => <integer>,
                    ],
                ],
                'ChallengeConfig' => [
                    'ImmunityTimeProperty' => [
                        'ImmunityTime' => <integer>,
                    ],
                ],
                'Name' => '<string>',
                'OverrideAction' => [
                    'Count' => [
                        'CustomRequestHandling' => [
                            'InsertHeaders' => [
                                [
                                    'Name' => '<string>',
                                    'Value' => '<string>',
                                ],
                                // ...
                            ],
                        ],
                    ],
                    'None' => [
                    ],
                ],
                'Priority' => <integer>,
                'RuleLabels' => [
                    [
                        'Name' => '<string>',
                    ],
                    // ...
                ],
                'Statement' => [
                    'AndStatement' => [
                        'Statements' => [
                            [...], // RECURSIVE
                            // ...
                        ],
                    ],
                    'ByteMatchStatement' => [
                        'FieldToMatch' => [
                            'AllQueryArguments' => [
                            ],
                            'Body' => [
                                'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                            ],
                            'Cookies' => [
                                'MatchPattern' => [
                                    'All' => [
                                    ],
                                    'ExcludedCookies' => ['<string>', ...],
                                    'IncludedCookies' => ['<string>', ...],
                                ],
                                'MatchScope' => 'ALL|KEY|VALUE',
                                'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                            ],
                            'Headers' => [
                                'MatchPattern' => [
                                    'All' => [
                                    ],
                                    'ExcludedHeaders' => ['<string>', ...],
                                    'IncludedHeaders' => ['<string>', ...],
                                ],
                                'MatchScope' => 'ALL|KEY|VALUE',
                                'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                            ],
                            'JsonBody' => [
                                'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING',
                                'MatchPattern' => [
                                    'All' => [
                                    ],
                                    'IncludedPaths' => ['<string>', ...],
                                ],
                                'MatchScope' => 'ALL|KEY|VALUE',
                                'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                            ],
                            'Method' => [
                            ],
                            'QueryString' => [
                            ],
                            'SingleHeader' => [
                                'Name' => '<string>',
                            ],
                            'SingleQueryArgument' => [
                                'Name' => '<string>',
                            ],
                            'UriPath' => [
                            ],
                        ],
                        'PositionalConstraint' => 'EXACTLY|STARTS_WITH|ENDS_WITH|CONTAINS|CONTAINS_WORD',
                        'SearchString' => <string || resource || Psr\Http\Message\StreamInterface>,
                        'TextTransformations' => [
                            [
                                'Priority' => <integer>,
                                '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' => ['<string>', ...],
                        'ForwardedIPConfig' => [
                            'FallbackBehavior' => 'MATCH|NO_MATCH',
                            'HeaderName' => '<string>',
                        ],
                    ],
                    'IPSetReferenceStatement' => [
                        'ARN' => '<string>',
                        'IPSetForwardedIPConfig' => [
                            'FallbackBehavior' => 'MATCH|NO_MATCH',
                            'HeaderName' => '<string>',
                            'Position' => 'FIRST|LAST|ANY',
                        ],
                    ],
                    'LabelMatchStatement' => [
                        'Key' => '<string>',
                        'Scope' => 'LABEL|NAMESPACE',
                    ],
                    'ManagedRuleGroupStatement' => [
                        'ExcludedRules' => [
                            [
                                'Name' => '<string>',
                            ],
                            // ...
                        ],
                        'ManagedRuleGroupConfigs' => [
                            [
                                'AWSManagedRulesBotControlRuleSet' => [
                                    'InspectionLevel' => 'COMMON|TARGETED',
                                ],
                                'LoginPath' => '<string>',
                                'PasswordField' => [
                                    'Identifier' => '<string>',
                                ],
                                'PayloadType' => 'JSON|FORM_ENCODED',
                                'UsernameField' => [
                                    'Identifier' => '<string>',
                                ],
                            ],
                            // ...
                        ],
                        'Name' => '<string>',
                        'RuleActionOverrides' => [
                            [
                                'ActionToUse' => [
                                    'Allow' => [
                                        'CustomRequestHandling' => [
                                            'InsertHeaders' => [
                                                [
                                                    'Name' => '<string>',
                                                    'Value' => '<string>',
                                                ],
                                                // ...
                                            ],
                                        ],
                                    ],
                                    'Block' => [
                                        'CustomResponse' => [
                                            'CustomResponseBodyKey' => '<string>',
                                            'ResponseCode' => <integer>,
                                            'ResponseHeaders' => [
                                                [
                                                    'Name' => '<string>',
                                                    'Value' => '<string>',
                                                ],
                                                // ...
                                            ],
                                        ],
                                    ],
                                    'Captcha' => [
                                        'CustomRequestHandling' => [
                                            'InsertHeaders' => [
                                                [
                                                    'Name' => '<string>',
                                                    'Value' => '<string>',
                                                ],
                                                // ...
                                            ],
                                        ],
                                    ],
                                    'Challenge' => [
                                        'CustomRequestHandling' => [
                                            'InsertHeaders' => [
                                                [
                                                    'Name' => '<string>',
                                                    'Value' => '<string>',
                                                ],
                                                // ...
                                            ],
                                        ],
                                    ],
                                    'Count' => [
                                        'CustomRequestHandling' => [
                                            'InsertHeaders' => [
                                                [
                                                    'Name' => '<string>',
                                                    'Value' => '<string>',
                                                ],
                                                // ...
                                            ],
                                        ],
                                    ],
                                ],
                                'Name' => '<string>',
                            ],
                            // ...
                        ],
                        'ScopeDownStatement' => [...], // RECURSIVE
                        'VendorName' => '<string>',
                        'Version' => '<string>',
                    ],
                    'NotStatement' => [
                        'Statement' => [...], // RECURSIVE
                    ],
                    'OrStatement' => [
                        'Statements' => [
                            [...], // RECURSIVE
                            // ...
                        ],
                    ],
                    'RateBasedStatement' => [
                        'AggregateKeyType' => 'IP|FORWARDED_IP',
                        'ForwardedIPConfig' => [
                            'FallbackBehavior' => 'MATCH|NO_MATCH',
                            'HeaderName' => '<string>',
                        ],
                        'Limit' => <integer>,
                        'ScopeDownStatement' => [...], // RECURSIVE
                    ],
                    'RegexMatchStatement' => [
                        'FieldToMatch' => [
                            'AllQueryArguments' => [
                            ],
                            'Body' => [
                                'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                            ],
                            'Cookies' => [
                                'MatchPattern' => [
                                    'All' => [
                                    ],
                                    'ExcludedCookies' => ['<string>', ...],
                                    'IncludedCookies' => ['<string>', ...],
                                ],
                                'MatchScope' => 'ALL|KEY|VALUE',
                                'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                            ],
                            'Headers' => [
                                'MatchPattern' => [
                                    'All' => [
                                    ],
                                    'ExcludedHeaders' => ['<string>', ...],
                                    'IncludedHeaders' => ['<string>', ...],
                                ],
                                'MatchScope' => 'ALL|KEY|VALUE',
                                'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                            ],
                            'JsonBody' => [
                                'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING',
                                'MatchPattern' => [
                                    'All' => [
                                    ],
                                    'IncludedPaths' => ['<string>', ...],
                                ],
                                'MatchScope' => 'ALL|KEY|VALUE',
                                'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                            ],
                            'Method' => [
                            ],
                            'QueryString' => [
                            ],
                            'SingleHeader' => [
                                'Name' => '<string>',
                            ],
                            'SingleQueryArgument' => [
                                'Name' => '<string>',
                            ],
                            'UriPath' => [
                            ],
                        ],
                        'RegexString' => '<string>',
                        'TextTransformations' => [
                            [
                                'Priority' => <integer>,
                                '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',
                            ],
                            // ...
                        ],
                    ],
                    'RegexPatternSetReferenceStatement' => [
                        'ARN' => '<string>',
                        'FieldToMatch' => [
                            'AllQueryArguments' => [
                            ],
                            'Body' => [
                                'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                            ],
                            'Cookies' => [
                                'MatchPattern' => [
                                    'All' => [
                                    ],
                                    'ExcludedCookies' => ['<string>', ...],
                                    'IncludedCookies' => ['<string>', ...],
                                ],
                                'MatchScope' => 'ALL|KEY|VALUE',
                                'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                            ],
                            'Headers' => [
                                'MatchPattern' => [
                                    'All' => [
                                    ],
                                    'ExcludedHeaders' => ['<string>', ...],
                                    'IncludedHeaders' => ['<string>', ...],
                                ],
                                'MatchScope' => 'ALL|KEY|VALUE',
                                'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                            ],
                            'JsonBody' => [
                                'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING',
                                'MatchPattern' => [
                                    'All' => [
                                    ],
                                    'IncludedPaths' => ['<string>', ...],
                                ],
                                'MatchScope' => 'ALL|KEY|VALUE',
                                'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                            ],
                            'Method' => [
                            ],
                            'QueryString' => [
                            ],
                            'SingleHeader' => [
                                'Name' => '<string>',
                            ],
                            'SingleQueryArgument' => [
                                'Name' => '<string>',
                            ],
                            'UriPath' => [
                            ],
                        ],
                        'TextTransformations' => [
                            [
                                'Priority' => <integer>,
                                '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',
                            ],
                            // ...
                        ],
                    ],
                    'RuleGroupReferenceStatement' => [
                        'ARN' => '<string>',
                        'ExcludedRules' => [
                            [
                                'Name' => '<string>',
                            ],
                            // ...
                        ],
                        'RuleActionOverrides' => [
                            [
                                'ActionToUse' => [
                                    'Allow' => [
                                        'CustomRequestHandling' => [
                                            'InsertHeaders' => [
                                                [
                                                    'Name' => '<string>',
                                                    'Value' => '<string>',
                                                ],
                                                // ...
                                            ],
                                        ],
                                    ],
                                    'Block' => [
                                        'CustomResponse' => [
                                            'CustomResponseBodyKey' => '<string>',
                                            'ResponseCode' => <integer>,
                                            'ResponseHeaders' => [
                                                [
                                                    'Name' => '<string>',
                                                    'Value' => '<string>',
                                                ],
                                                // ...
                                            ],
                                        ],
                                    ],
                                    'Captcha' => [
                                        'CustomRequestHandling' => [
                                            'InsertHeaders' => [
                                                [
                                                    'Name' => '<string>',
                                                    'Value' => '<string>',
                                                ],
                                                // ...
                                            ],
                                        ],
                                    ],
                                    'Challenge' => [
                                        'CustomRequestHandling' => [
                                            'InsertHeaders' => [
                                                [
                                                    'Name' => '<string>',
                                                    'Value' => '<string>',
                                                ],
                                                // ...
                                            ],
                                        ],
                                    ],
                                    'Count' => [
                                        'CustomRequestHandling' => [
                                            'InsertHeaders' => [
                                                [
                                                    'Name' => '<string>',
                                                    'Value' => '<string>',
                                                ],
                                                // ...
                                            ],
                                        ],
                                    ],
                                ],
                                'Name' => '<string>',
                            ],
                            // ...
                        ],
                    ],
                    'SizeConstraintStatement' => [
                        'ComparisonOperator' => 'EQ|NE|LE|LT|GE|GT',
                        'FieldToMatch' => [
                            'AllQueryArguments' => [
                            ],
                            'Body' => [
                                'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                            ],
                            'Cookies' => [
                                'MatchPattern' => [
                                    'All' => [
                                    ],
                                    'ExcludedCookies' => ['<string>', ...],
                                    'IncludedCookies' => ['<string>', ...],
                                ],
                                'MatchScope' => 'ALL|KEY|VALUE',
                                'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                            ],
                            'Headers' => [
                                'MatchPattern' => [
                                    'All' => [
                                    ],
                                    'ExcludedHeaders' => ['<string>', ...],
                                    'IncludedHeaders' => ['<string>', ...],
                                ],
                                'MatchScope' => 'ALL|KEY|VALUE',
                                'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                            ],
                            'JsonBody' => [
                                'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING',
                                'MatchPattern' => [
                                    'All' => [
                                    ],
                                    'IncludedPaths' => ['<string>', ...],
                                ],
                                'MatchScope' => 'ALL|KEY|VALUE',
                                'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                            ],
                            'Method' => [
                            ],
                            'QueryString' => [
                            ],
                            'SingleHeader' => [
                                'Name' => '<string>',
                            ],
                            'SingleQueryArgument' => [
                                'Name' => '<string>',
                            ],
                            'UriPath' => [
                            ],
                        ],
                        'Size' => <integer>,
                        'TextTransformations' => [
                            [
                                'Priority' => <integer>,
                                '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',
                            ],
                            // ...
                        ],
                    ],
                    'SqliMatchStatement' => [
                        'FieldToMatch' => [
                            'AllQueryArguments' => [
                            ],
                            'Body' => [
                                'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                            ],
                            'Cookies' => [
                                'MatchPattern' => [
                                    'All' => [
                                    ],
                                    'ExcludedCookies' => ['<string>', ...],
                                    'IncludedCookies' => ['<string>', ...],
                                ],
                                'MatchScope' => 'ALL|KEY|VALUE',
                                'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                            ],
                            'Headers' => [
                                'MatchPattern' => [
                                    'All' => [
                                    ],
                                    'ExcludedHeaders' => ['<string>', ...],
                                    'IncludedHeaders' => ['<string>', ...],
                                ],
                                'MatchScope' => 'ALL|KEY|VALUE',
                                'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                            ],
                            'JsonBody' => [
                                'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING',
                                'MatchPattern' => [
                                    'All' => [
                                    ],
                                    'IncludedPaths' => ['<string>', ...],
                                ],
                                'MatchScope' => 'ALL|KEY|VALUE',
                                'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                            ],
                            'Method' => [
                            ],
                            'QueryString' => [
                            ],
                            'SingleHeader' => [
                                'Name' => '<string>',
                            ],
                            'SingleQueryArgument' => [
                                'Name' => '<string>',
                            ],
                            'UriPath' => [
                            ],
                        ],
                        'SensitivityLevel' => 'LOW|HIGH',
                        'TextTransformations' => [
                            [
                                'Priority' => <integer>,
                                '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',
                            ],
                            // ...
                        ],
                    ],
                    'XssMatchStatement' => [
                        'FieldToMatch' => [
                            'AllQueryArguments' => [
                            ],
                            'Body' => [
                                'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                            ],
                            'Cookies' => [
                                'MatchPattern' => [
                                    'All' => [
                                    ],
                                    'ExcludedCookies' => ['<string>', ...],
                                    'IncludedCookies' => ['<string>', ...],
                                ],
                                'MatchScope' => 'ALL|KEY|VALUE',
                                'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                            ],
                            'Headers' => [
                                'MatchPattern' => [
                                    'All' => [
                                    ],
                                    'ExcludedHeaders' => ['<string>', ...],
                                    'IncludedHeaders' => ['<string>', ...],
                                ],
                                'MatchScope' => 'ALL|KEY|VALUE',
                                'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                            ],
                            'JsonBody' => [
                                'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING',
                                'MatchPattern' => [
                                    'All' => [
                                    ],
                                    'IncludedPaths' => ['<string>', ...],
                                ],
                                'MatchScope' => 'ALL|KEY|VALUE',
                                'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH',
                            ],
                            'Method' => [
                            ],
                            'QueryString' => [
                            ],
                            'SingleHeader' => [
                                'Name' => '<string>',
                            ],
                            'SingleQueryArgument' => [
                                'Name' => '<string>',
                            ],
                            'UriPath' => [
                            ],
                        ],
                        'TextTransformations' => [
                            [
                                'Priority' => <integer>,
                                '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',
                            ],
                            // ...
                        ],
                    ],
                ],
                'VisibilityConfig' => [
                    'CloudWatchMetricsEnabled' => true || false,
                    'MetricName' => '<string>',
                    'SampledRequestsEnabled' => true || false,
                ],
            ],
            // ...
        ],
        'TokenDomains' => ['<string>', ...],
        'VisibilityConfig' => [
            'CloudWatchMetricsEnabled' => true || false,
            'MetricName' => '<string>',
            'SampledRequestsEnabled' => true || false,
        ],
    ],
]

Result Details

Errors

• WAFInternalErrorException:

  Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.

• WAFInvalidParameterException:

  The operation failed because WAF didn't recognize a parameter in the request. For example:

  • You specified a parameter name or value that isn't valid.

  • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

  • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

  • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated.

• WAFNonexistentItemException:

  WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.

• WAFInvalidOperationException:

  The operation isn't valid.

GetWebACLForResource