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 AWS WAF couldn’t perform the operation because of a system problem. Retry your request.

• WAFInvalidParameterException:

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

  • You specified an invalid parameter name or value.

  • 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 cannot be associated.

• WAFNonexistentItemException:

  AWS WAF couldn’t perform the operation because your resource doesn’t exist.

• WAFUnavailableEntityException:

  AWS WAF couldn’t retrieve the resource that you requested. Retry your request.

• WAFInvalidOperationException:

  The operation isn't valid.

CheckCapacity

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

Parameter Syntax

$result = $client->checkCapacity([
    'Rules' => [ // REQUIRED
        [
            'Action' => [
                'Allow' => [
                ],
                'Block' => [
                ],
                'Count' => [
                ],
            ],
            'Name' => '<string>', // REQUIRED
            'OverrideAction' => [
                'Count' => [
                ],
                'None' => [
                ],
            ],
            'Priority' => <integer>, // REQUIRED
            'Statement' => [ // REQUIRED
                'AndStatement' => [
                    'Statements' => [ // REQUIRED
                        [...], // RECURSIVE
                        // ...
                    ],
                ],
                'ByteMatchStatement' => [
                    'FieldToMatch' => [ // REQUIRED
                        'AllQueryArguments' => [
                        ],
                        'Body' => [
                        ],
                        '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', // 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
                    ],
                ],
                'ManagedRuleGroupStatement' => [
                    'ExcludedRules' => [
                        [
                            'Name' => '<string>', // REQUIRED
                        ],
                        // ...
                    ],
                    'Name' => '<string>', // REQUIRED
                    'VendorName' => '<string>', // REQUIRED
                ],
                '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
                ],
                'RegexPatternSetReferenceStatement' => [
                    'ARN' => '<string>', // REQUIRED
                    'FieldToMatch' => [ // REQUIRED
                        'AllQueryArguments' => [
                        ],
                        'Body' => [
                        ],
                        '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', // REQUIRED
                        ],
                        // ...
                    ],
                ],
                'RuleGroupReferenceStatement' => [
                    'ARN' => '<string>', // REQUIRED
                    'ExcludedRules' => [
                        [
                            'Name' => '<string>', // REQUIRED
                        ],
                        // ...
                    ],
                ],
                'SizeConstraintStatement' => [
                    'ComparisonOperator' => 'EQ|NE|LE|LT|GE|GT', // REQUIRED
                    'FieldToMatch' => [ // REQUIRED
                        'AllQueryArguments' => [
                        ],
                        'Body' => [
                        ],
                        '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', // REQUIRED
                        ],
                        // ...
                    ],
                ],
                'SqliMatchStatement' => [
                    'FieldToMatch' => [ // REQUIRED
                        'AllQueryArguments' => [
                        ],
                        'Body' => [
                        ],
                        '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', // REQUIRED
                        ],
                        // ...
                    ],
                ],
                'XssMatchStatement' => [
                    'FieldToMatch' => [ // REQUIRED
                        'AllQueryArguments' => [
                        ],
                        'Body' => [
                        ],
                        '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', // 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 AWS WAF couldn’t perform the operation because of a system problem. Retry your request.

• WAFInvalidParameterException:

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

  • You specified an invalid parameter name or value.

  • 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 cannot be associated.

• WAFNonexistentItemException:

  AWS WAF couldn’t perform the operation because your resource doesn’t exist.

• WAFLimitsExceededException:

  AWS 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 AWS account. For more information, see Limits in the AWS WAF Developer Guide.

• WAFInvalidResourceException:

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

• WAFUnavailableEntityException:

  AWS WAF couldn’t retrieve the resource that you requested. Retry your request.

• WAFSubscriptionNotFoundException:

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 AWS WAF couldn’t perform the operation because of a system problem. Retry your request.

• WAFInvalidParameterException:

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

  • You specified an invalid parameter name or value.

  • 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 cannot be associated.

• WAFDuplicateItemException:

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

• WAFOptimisticLockException:

  AWS 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:

  AWS 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 AWS account. For more information, see Limits in the AWS WAF Developer Guide.

• WAFTagOperationException:

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

• WAFTagOperationInternalErrorException:

  AWS 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 AWS WAF couldn’t perform the operation because of a system problem. Retry your request.

• WAFInvalidParameterException:

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

  • You specified an invalid parameter name or value.

  • 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 cannot be associated.

• WAFDuplicateItemException:

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

• WAFOptimisticLockException:

  AWS 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:

  AWS 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 AWS account. For more information, see Limits in the AWS WAF Developer Guide.

• WAFTagOperationException:

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

• WAFTagOperationInternalErrorException:

  AWS 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
    'Description' => '<string>',
    'Name' => '<string>', // REQUIRED
    'Rules' => [
        [
            'Action' => [
                'Allow' => [
                ],
                'Block' => [
                ],
                'Count' => [
                ],
            ],
            'Name' => '<string>', // REQUIRED
            'OverrideAction' => [
                'Count' => [
                ],
                'None' => [
                ],
            ],
            'Priority' => <integer>, // REQUIRED
            'Statement' => [ // REQUIRED
                'AndStatement' => [
                    'Statements' => [ // REQUIRED
                        [...], // RECURSIVE
                        // ...
                    ],
                ],
                'ByteMatchStatement' => [
                    'FieldToMatch' => [ // REQUIRED
                        'AllQueryArguments' => [
                        ],
                        'Body' => [
                        ],
                        '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', // 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
                    ],
                ],
                'ManagedRuleGroupStatement' => [
                    'ExcludedRules' => [
                        [
                            'Name' => '<string>', // REQUIRED
                        ],
                        // ...
                    ],
                    'Name' => '<string>', // REQUIRED
                    'VendorName' => '<string>', // REQUIRED
                ],
                '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
                ],
                'RegexPatternSetReferenceStatement' => [
                    'ARN' => '<string>', // REQUIRED
                    'FieldToMatch' => [ // REQUIRED
                        'AllQueryArguments' => [
                        ],
                        'Body' => [
                        ],
                        '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', // REQUIRED
                        ],
                        // ...
                    ],
                ],
                'RuleGroupReferenceStatement' => [
                    'ARN' => '<string>', // REQUIRED
                    'ExcludedRules' => [
                        [
                            'Name' => '<string>', // REQUIRED
                        ],
                        // ...
                    ],
                ],
                'SizeConstraintStatement' => [
                    'ComparisonOperator' => 'EQ|NE|LE|LT|GE|GT', // REQUIRED
                    'FieldToMatch' => [ // REQUIRED
                        'AllQueryArguments' => [
                        ],
                        'Body' => [
                        ],
                        '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', // REQUIRED
                        ],
                        // ...
                    ],
                ],
                'SqliMatchStatement' => [
                    'FieldToMatch' => [ // REQUIRED
                        'AllQueryArguments' => [
                        ],
                        'Body' => [
                        ],
                        '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', // REQUIRED
                        ],
                        // ...
                    ],
                ],
                'XssMatchStatement' => [
                    'FieldToMatch' => [ // REQUIRED
                        'AllQueryArguments' => [
                        ],
                        'Body' => [
                        ],
                        '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', // 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 AWS WAF couldn’t perform the operation because of a system problem. Retry your request.

• WAFInvalidParameterException:

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

  • You specified an invalid parameter name or value.

  • 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 cannot be associated.

• WAFDuplicateItemException:

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

• WAFOptimisticLockException:

  AWS 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:

  AWS 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 AWS account. For more information, see Limits in the AWS WAF Developer Guide.

• WAFUnavailableEntityException:

  AWS WAF couldn’t retrieve the resource that you requested. Retry your request.

• WAFTagOperationException:

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

• WAFTagOperationInternalErrorException:

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

• WAFSubscriptionNotFoundException:

• WAFNonexistentItemException:

  AWS WAF couldn’t perform the operation because your resource doesn’t exist.

• WAFInvalidOperationException:

  The operation isn't valid.

CreateWebACL

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

Parameter Syntax

$result = $client->createWebACL([
    'DefaultAction' => [ // REQUIRED
        'Allow' => [
        ],
        'Block' => [
        ],
    ],
    'Description' => '<string>',
    'Name' => '<string>', // REQUIRED
    'Rules' => [
        [
            'Action' => [
                'Allow' => [
                ],
                'Block' => [
                ],
                'Count' => [
                ],
            ],
            'Name' => '<string>', // REQUIRED
            'OverrideAction' => [
                'Count' => [
                ],
                'None' => [
                ],
            ],
            'Priority' => <integer>, // REQUIRED
            'Statement' => [ // REQUIRED
                'AndStatement' => [
                    'Statements' => [ // REQUIRED
                        [...], // RECURSIVE
                        // ...
                    ],
                ],
                'ByteMatchStatement' => [
                    'FieldToMatch' => [ // REQUIRED
                        'AllQueryArguments' => [
                        ],
                        'Body' => [
                        ],
                        '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', // 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
                    ],
                ],
                'ManagedRuleGroupStatement' => [
                    'ExcludedRules' => [
                        [
                            'Name' => '<string>', // REQUIRED
                        ],
                        // ...
                    ],
                    'Name' => '<string>', // REQUIRED
                    'VendorName' => '<string>', // REQUIRED
                ],
                '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
                ],
                'RegexPatternSetReferenceStatement' => [
                    'ARN' => '<string>', // REQUIRED
                    'FieldToMatch' => [ // REQUIRED
                        'AllQueryArguments' => [
                        ],
                        'Body' => [
                        ],
                        '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', // REQUIRED
                        ],
                        // ...
                    ],
                ],
                'RuleGroupReferenceStatement' => [
                    'ARN' => '<string>', // REQUIRED
                    'ExcludedRules' => [
                        [
                            'Name' => '<string>', // REQUIRED
                        ],
                        // ...
                    ],
                ],
                'SizeConstraintStatement' => [
                    'ComparisonOperator' => 'EQ|NE|LE|LT|GE|GT', // REQUIRED
                    'FieldToMatch' => [ // REQUIRED
                        'AllQueryArguments' => [
                        ],
                        'Body' => [
                        ],
                        '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', // REQUIRED
                        ],
                        // ...
                    ],
                ],
                'SqliMatchStatement' => [
                    'FieldToMatch' => [ // REQUIRED
                        'AllQueryArguments' => [
                        ],
                        'Body' => [
                        ],
                        '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', // REQUIRED
                        ],
                        // ...
                    ],
                ],
                'XssMatchStatement' => [
                    'FieldToMatch' => [ // REQUIRED
                        'AllQueryArguments' => [
                        ],
                        'Body' => [
                        ],
                        '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', // 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 AWS WAF couldn’t perform the operation because of a system problem. Retry your request.

• WAFInvalidParameterException:

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

  • You specified an invalid parameter name or value.

  • 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 cannot be associated.

• WAFDuplicateItemException:

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

• WAFOptimisticLockException:

  AWS 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:

  AWS 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 AWS account. For more information, see Limits in the AWS WAF Developer Guide.

• WAFInvalidResourceException:

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

• WAFUnavailableEntityException:

  AWS WAF couldn’t retrieve the resource that you requested. Retry your request.

• WAFNonexistentItemException:

  AWS WAF couldn’t perform the operation because your resource doesn’t exist.

• WAFTagOperationException:

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

• WAFTagOperationInternalErrorException:

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

• WAFSubscriptionNotFoundException:

• WAFInvalidOperationException:

  The operation isn't valid.

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 AWS WAF couldn’t perform the operation because of a system problem. Retry your request.

• WAFInvalidParameterException:

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

  • You specified an invalid parameter name or value.

  • 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 cannot be associated.

• WAFNonexistentItemException:

  AWS WAF couldn’t perform the operation because your resource doesn’t exist.

• WAFOptimisticLockException:

  AWS 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 AWS WAF couldn’t perform the operation because of a system problem. Retry your request.

• WAFInvalidParameterException:

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

  • You specified an invalid parameter name or value.

  • 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 cannot be associated.

• WAFNonexistentItemException:

  AWS WAF couldn’t perform the operation because your resource doesn’t exist.

• WAFOptimisticLockException:

  AWS 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:

  AWS 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:

  AWS 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 AWS WAF couldn’t perform the operation because of a system problem. Retry your request.

• WAFNonexistentItemException:

  AWS WAF couldn’t perform the operation because your resource doesn’t exist.

• WAFOptimisticLockException:

  AWS 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 AWS WAF didn't recognize a parameter in the request. For example:

  • You specified an invalid parameter name or value.

  • 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 cannot 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:

  AWS WAF couldn’t perform the operation because your resource doesn’t exist.

• WAFInternalErrorException:

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

• WAFInvalidParameterException:

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

  • You specified an invalid parameter name or value.

  • 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 cannot 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 AWS WAF couldn’t perform the operation because of a system problem. Retry your request.

• WAFInvalidParameterException:

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

  • You specified an invalid parameter name or value.

  • 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 cannot be associated.

• WAFNonexistentItemException:

  AWS WAF couldn’t perform the operation because your resource doesn’t exist.

• WAFOptimisticLockException:

  AWS 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:

  AWS 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:

  AWS 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 AWS WAF couldn’t perform the operation because of a system problem. Retry your request.

• WAFInvalidParameterException:

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

  • You specified an invalid parameter name or value.

  • 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 cannot be associated.

• WAFNonexistentItemException:

  AWS WAF couldn’t perform the operation because your resource doesn’t exist.

• WAFOptimisticLockException:

  AWS 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:

  AWS 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:

  AWS 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 AWS WAF couldn’t perform the operation because of a system problem. Retry your request.

• WAFInvalidParameterException:

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

  • You specified an invalid parameter name or value.

  • 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 cannot be associated.

• WAFNonexistentItemException:

  AWS WAF couldn’t perform the operation because your resource doesn’t exist.

• WAFOptimisticLockException:

  AWS 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:

  AWS 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:

  AWS 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
]);

Parameter Details

Result Syntax

[
    'Capacity' => <integer>,
    'Rules' => [
        [
            'Action' => [
                'Allow' => [
                ],
                'Block' => [
                ],
                'Count' => [
                ],
            ],
            'Name' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

• WAFInternalErrorException:

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

• WAFInvalidParameterException:

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

  • You specified an invalid parameter name or value.

  • 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 cannot be associated.

• WAFInvalidResourceException:

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

• WAFNonexistentItemException:

  AWS WAF couldn’t perform the operation because your resource doesn’t exist.

• WAFInvalidOperationException:

  The operation isn't valid.

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 AWS WAF couldn’t perform the operation because of a system problem. Retry your request.

• WAFInvalidParameterException:

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

  • You specified an invalid parameter name or value.

  • 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 cannot be associated.

• WAFNonexistentItemException:

  AWS WAF couldn’t perform the operation because your resource doesn’t exist.

• 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 AWS WAF couldn’t perform the operation because of a system problem. Retry your request.

• WAFInvalidParameterException:

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

  • You specified an invalid parameter name or value.

  • 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 cannot be associated.

• WAFNonexistentItemException:

  AWS WAF couldn’t perform the operation because your resource doesn’t exist.

• 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>', ...],
        'ManagedByFirewallManager' => true || false,
        'RedactedFields' => [
            [
                'AllQueryArguments' => [
                ],
                'Body' => [
                ],
                'Method' => [
                ],
                'QueryString' => [
                ],
                'SingleHeader' => [
                    'Name' => '<string>',
                ],
                'SingleQueryArgument' => [
                    'Name' => '<string>',
                ],
                'UriPath' => [
                ],
            ],
            // ...
        ],
        'ResourceArn' => '<string>',
    ],
]

Result Details

Errors

• WAFInternalErrorException:

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

• WAFNonexistentItemException:

  AWS WAF couldn’t perform the operation because your resource doesn’t exist.

• WAFInvalidParameterException:

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

  • You specified an invalid parameter name or value.

  • 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 cannot 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:

  AWS WAF couldn’t perform the operation because your resource doesn’t exist.

• WAFInternalErrorException:

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

• WAFInvalidParameterException:

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

  • You specified an invalid parameter name or value.

  • 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 cannot be associated.

GetRateBasedStatementManagedKeys

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

Parameter Syntax

$result = $client->getRateBasedStatementManagedKeys([
    '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 AWS WAF couldn’t perform the operation because of a system problem. Retry your request.

• WAFInvalidParameterException:

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

  • You specified an invalid parameter name or value.

  • 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 cannot be associated.

• WAFNonexistentItemException:

  AWS WAF couldn’t perform the operation because your resource doesn’t exist.

• 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 AWS WAF couldn’t perform the operation because of a system problem. Retry your request.

• WAFInvalidParameterException:

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

  • You specified an invalid parameter name or value.

  • 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 cannot be associated.

• WAFNonexistentItemException:

  AWS WAF couldn’t perform the operation because your resource doesn’t exist.

• WAFInvalidOperationException:

  The operation isn't valid.

GetRuleGroup

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

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'LockToken' => '<string>',
    'RuleGroup' => [
        'ARN' => '<string>',
        'Capacity' => <integer>,
        'Description' => '<string>',
        'Id' => '<string>',
        'Name' => '<string>',
        'Rules' => [
            [
                'Action' => [
                    'Allow' => [
                    ],
                    'Block' => [
                    ],
                    'Count' => [
                    ],
                ],
                'Name' => '<string>',
                'OverrideAction' => [
                    'Count' => [
                    ],
                    'None' => [
                    ],
                ],
                'Priority' => <integer>,
                'Statement' => [
                    'AndStatement' => [
                        'Statements' => [
                            [...], // RECURSIVE
                            // ...
                        ],
                    ],
                    'ByteMatchStatement' => [
                        'FieldToMatch' => [
                            'AllQueryArguments' => [
                            ],
                            'Body' => [
                            ],
                            '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',
                            ],
                            // ...
                        ],
                    ],
                    'GeoMatchStatement' => [
                        'CountryCodes' => ['<string>', ...],
                        'ForwardedIPConfig' => [
                            'FallbackBehavior' => 'MATCH|NO_MATCH',
                            'HeaderName' => '<string>',
                        ],
                    ],
                    'IPSetReferenceStatement' => [
                        'ARN' => '<string>',
                        'IPSetForwardedIPConfig' => [
                            'FallbackBehavior' => 'MATCH|NO_MATCH',
                            'HeaderName' => '<string>',
                            'Position' => 'FIRST|LAST|ANY',
                        ],
                    ],
                    'ManagedRuleGroupStatement' => [
                        'ExcludedRules' => [
                            [
                                'Name' => '<string>',
                            ],
                            // ...
                        ],
                        'Name' => '<string>',
                        'VendorName' => '<string>',
                    ],
                    'NotStatement' => [
                        'Statement' => [...], // RECURSIVE
                    ],
                    'OrStatement' => [
                        'Statements' => [
                            [...], // RECURSIVE
                            // ...
                        ],
                    ],
                    'RateBasedStatement' => [
                        'AggregateKeyType' => 'IP|FORWARDED_IP',
                        'ForwardedIPConfig' => [
                            'FallbackBehavior' => 'MATCH|NO_MATCH',
                            'HeaderName' => '<string>',
                        ],
                        'Limit' => <integer>,
                        'ScopeDownStatement' => [...], // RECURSIVE
                    ],
                    'RegexPatternSetReferenceStatement' => [
                        'ARN' => '<string>',
                        'FieldToMatch' => [
                            'AllQueryArguments' => [
                            ],
                            'Body' => [
                            ],
                            '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',
                            ],
                            // ...
                        ],
                    ],
                    'RuleGroupReferenceStatement' => [
                        'ARN' => '<string>',
                        'ExcludedRules' => [
                            [
                                'Name' => '<string>',
                            ],
                            // ...
                        ],
                    ],
                    'SizeConstraintStatement' => [
                        'ComparisonOperator' => 'EQ|NE|LE|LT|GE|GT',
                        'FieldToMatch' => [
                            'AllQueryArguments' => [
                            ],
                            'Body' => [
                            ],
                            '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',
                            ],
                            // ...
                        ],
                    ],
                    'SqliMatchStatement' => [
                        'FieldToMatch' => [
                            'AllQueryArguments' => [
                            ],
                            'Body' => [
                            ],
                            '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',
                            ],
                            // ...
                        ],
                    ],
                    'XssMatchStatement' => [
                        'FieldToMatch' => [
                            'AllQueryArguments' => [
                            ],
                            'Body' => [
                            ],
                            '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',
                            ],
                            // ...
                        ],
                    ],
                ],
                '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 AWS WAF couldn’t perform the operation because of a system problem. Retry your request.

• WAFInvalidParameterException:

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

  • You specified an invalid parameter name or value.

  • 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 cannot be associated.

• WAFNonexistentItemException:

  AWS WAF couldn’t perform the operation because your resource doesn’t exist.

• 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>',
            'Request' => [
                'ClientIP' => '<string>',
                'Country' => '<string>',
                'HTTPVersion' => '<string>',
                'Headers' => [
                    [
                        'Name' => '<string>',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'Method' => '<string>',
                'URI' => '<string>',
            ],
            'RuleNameWithinRuleGroup' => '<string>',
            'Timestamp' => <DateTime>,
            'Weight' => <integer>,
        ],
        // ...
    ],
    'TimeWindow' => [
        'EndTime' => <DateTime>,
        'StartTime' => <DateTime>,
    ],
]

Result Details

Errors

• WAFNonexistentItemException:

  AWS WAF couldn’t perform the operation because your resource doesn’t exist.

• WAFInternalErrorException:

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

• WAFInvalidParameterException:

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

  • You specified an invalid parameter name or value.

  • 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 cannot 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

[
    'LockToken' => '<string>',
    'WebACL' => [
        'ARN' => '<string>',
        'Capacity' => <integer>,
        'DefaultAction' => [
            'Allow' => [
            ],
            'Block' => [
            ],
        ],
        'Description' => '<string>',
        'Id' => '<string>',
        'ManagedByFirewallManager' => true || false,
        'Name' => '<string>',
        'PostProcessFirewallManagerRuleGroups' => [
            [
                'FirewallManagerStatement' => [
                    'ManagedRuleGroupStatement' => [
                        'ExcludedRules' => [
                            [
                                'Name' => '<string>',
                            ],
                            // ...
                        ],
                        'Name' => '<string>',
                        'VendorName' => '<string>',
                    ],
                    'RuleGroupReferenceStatement' => [
                        'ARN' => '<string>',
                        'ExcludedRules' => [
                            [
                                'Name' => '<string>',
                            ],
                            // ...
                        ],
                    ],
                ],
                'Name' => '<string>',
                'OverrideAction' => [
                    'Count' => [
                    ],
                    'None' => [
                    ],
                ],
                'Priority' => <integer>,
                'VisibilityConfig' => [
                    'CloudWatchMetricsEnabled' => true || false,
                    'MetricName' => '<string>',
                    'SampledRequestsEnabled' => true || false,
                ],
            ],
            // ...
        ],
        'PreProcessFirewallManagerRuleGroups' => [
            [
                'FirewallManagerStatement' => [
                    'ManagedRuleGroupStatement' => [
                        'ExcludedRules' => [
                            [
                                'Name' => '<string>',
                            ],
                            // ...
                        ],
                        'Name' => '<string>',
                        'VendorName' => '<string>',
                    ],
                    'RuleGroupReferenceStatement' => [
                        'ARN' => '<string>',
                        'ExcludedRules' => [
                            [
                                'Name' => '<string>',
                            ],
                            // ...
                        ],
                    ],
                ],
                'Name' => '<string>',
                'OverrideAction' => [
                    'Count' => [
                    ],
                    'None' => [
                    ],
                ],
                'Priority' => <integer>,
                'VisibilityConfig' => [
                    'CloudWatchMetricsEnabled' => true || false,
                    'MetricName' => '<string>',
                    'SampledRequestsEnabled' => true || false,
                ],
            ],
            // ...
        ],
        'Rules' => [
            [
                'Action' => [
                    'Allow' => [
                    ],
                    'Block' => [
                    ],
                    'Count' => [
                    ],
                ],
                'Name' => '<string>',
                'OverrideAction' => [
                    'Count' => [
                    ],
                    'None' => [
                    ],
                ],
                'Priority' => <integer>,
                'Statement' => [
                    'AndStatement' => [
                        'Statements' => [
                            [...], // RECURSIVE
                            // ...
                        ],
                    ],
                    'ByteMatchStatement' => [
                        'FieldToMatch' => [
                            'AllQueryArguments' => [
                            ],
                            'Body' => [
                            ],
                            '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',
                            ],
                            // ...
                        ],
                    ],
                    'GeoMatchStatement' => [
                        'CountryCodes' => ['<string>', ...],
                        'ForwardedIPConfig' => [
                            'FallbackBehavior' => 'MATCH|NO_MATCH',
                            'HeaderName' => '<string>',
                        ],
                    ],
                    'IPSetReferenceStatement' => [
                        'ARN' => '<string>',
                        'IPSetForwardedIPConfig' => [
                            'FallbackBehavior' => 'MATCH|NO_MATCH',
                            'HeaderName' => '<string>',
                            'Position' => 'FIRST|LAST|ANY',
                        ],
                    ],
                    'ManagedRuleGroupStatement' => [
                        'ExcludedRules' => [
                            [
                                'Name' => '<string>',
                            ],
                            // ...
                        ],
                        'Name' => '<string>',
                        'VendorName' => '<string>',
                    ],
                    'NotStatement' => [
                        'Statement' => [...], // RECURSIVE
                    ],
                    'OrStatement' => [
                        'Statements' => [
                            [...], // RECURSIVE
                            // ...
                        ],
                    ],
                    'RateBasedStatement' => [
                        'AggregateKeyType' => 'IP|FORWARDED_IP',
                        'ForwardedIPConfig' => [
                            'FallbackBehavior' => 'MATCH|NO_MATCH',
                            'HeaderName' => '<string>',
                        ],
                        'Limit' => <integer>,
                        'ScopeDownStatement' => [...], // RECURSIVE
                    ],
                    'RegexPatternSetReferenceStatement' => [
                        'ARN' => '<string>',
                        'FieldToMatch' => [
                            'AllQueryArguments' => [
                            ],
                            'Body' => [
                            ],
                            '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',
                            ],
                            // ...
                        ],
                    ],
                    'RuleGroupReferenceStatement' => [
                        'ARN' => '<string>',
                        'ExcludedRules' => [
                            [
                                'Name' => '<string>',
                            ],
                            // ...
                        ],
                    ],
                    'SizeConstraintStatement' => [
                        'ComparisonOperator' => 'EQ|NE|LE|LT|GE|GT',
                        'FieldToMatch' => [
                            'AllQueryArguments' => [
                            ],
                            'Body' => [
                            ],
                            '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',
                            ],
                            // ...
                        ],
                    ],
                    'SqliMatchStatement' => [
                        'FieldToMatch' => [
                            'AllQueryArguments' => [
                            ],
                            'Body' => [
                            ],
                            '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',
                            ],
                            // ...
                        ],
                    ],
                    'XssMatchStatement' => [
                        'FieldToMatch' => [
                            'AllQueryArguments' => [
                            ],
                            'Body' => [
                            ],
                            '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',
                            ],
                            // ...
                        ],
                    ],
                ],
                '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 AWS WAF couldn’t perform the operation because of a system problem. Retry your request.

• WAFInvalidParameterException:

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

  • You specified an invalid parameter name or value.

  • 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 cannot be associated.

• WAFNonexistentItemException:

  AWS WAF couldn’t perform the operation because your resource doesn’t exist.

• WAFInvalidOperationException:

  The operation isn't valid.

GetWebACLForResource

$result = $client->getWebACLForResource([/* ... */]);
$promise = $client->getWebACLForResourceAsync([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'WebACL' => [
        'ARN' => '<string>',
        'Capacity' => <integer>,
        'DefaultAction' => [
            'Allow' => [
            ],
            'Block' => [
            ],
        ],
        'Description' => '<string>',
        'Id' => '<string>',
        'ManagedByFirewallManager' => true || false,
        'Name' => '<string>',
        'PostProcessFirewallManagerRuleGroups' => [
            [
                'FirewallManagerStatement' => [
                    'ManagedRuleGroupStatement' => [
                        'ExcludedRules' => [
                            [
                                'Name' => '<string>',
                            ],
                            // ...
                        ],
                        'Name' => '<string>',
                        'VendorName' => '<string>',
                    ],
                    'RuleGroupReferenceStatement' => [
                        'ARN' => '<string>',
                        'ExcludedRules' => [
                            [
                                'Name' => '<string>',
                            ],
                            // ...
                        ],
                    ],
                ],
                'Name' => '<string>',
                'OverrideAction' => [
                    'Count' => [
                    ],
                    'None' => [
                    ],
                ],
                'Priority' => <integer>,
                'VisibilityConfig' => [
                    'CloudWatchMetricsEnabled' => true || false,
                    'MetricName' => '<string>',
                    'SampledRequestsEnabled' => true || false,
                ],
            ],
            // ...
        ],
        'PreProcessFirewallManagerRuleGroups' => [
            [
                'FirewallManagerStatement' => [
                    'ManagedRuleGroupStatement' => [
                        'ExcludedRules' => [
                            [
                                'Name' => '<string>',
                            ],
                            // ...
                        ],
                        'Name' => '<string>',
                        'VendorName' => '<string>',
                    ],
                    'RuleGroupReferenceStatement' => [
                        'ARN' => '<string>',
                        'ExcludedRules' => [
                            [
                                'Name' => '<string>',
                            ],
                            // ...
                        ],
                    ],
                ],
                'Name' => '<string>',
                'OverrideAction' => [
                    'Count' => [
                    ],
                    'None' => [
                    ],
                ],
                'Priority' => <integer>,
                'VisibilityConfig' => [
                    'CloudWatchMetricsEnabled' => true || false,
                    'MetricName' => '<string>',
                    'SampledRequestsEnabled' => true || false,
                ],
            ],
            // ...
        ],
        'Rules' => [
            [
                'Action' => [
                    'Allow' => [
                    ],
                    'Block' => [
                    ],
                    'Count' => [
                    ],
                ],
                'Name' => '<string>',
                'OverrideAction' => [
                    'Count' => [
                    ],
                    'None' => [
                    ],
                ],
                'Priority' => <integer>,
                'Statement' => [
                    'AndStatement' => [
                        'Statements' => [
                            [...], // RECURSIVE
                            // ...
                        ],
                    ],
                    'ByteMatchStatement' => [
                        'FieldToMatch' => [
                            'AllQueryArguments' => [
                            ],
                            'Body' => [
                            ],
                            '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',
                            ],
                            // ...
                        ],
                    ],
                    'GeoMatchStatement' => [
                        'CountryCodes' => ['<string>', ...],
                        'ForwardedIPConfig' => [
                            'FallbackBehavior' => 'MATCH|NO_MATCH',
                            'HeaderName' => '<string>',
                        ],
                    ],
                    'IPSetReferenceStatement' => [
                        'ARN' => '<string>',
                        'IPSetForwardedIPConfig' => [
                            'FallbackBehavior' => 'MATCH|NO_MATCH',
                            'HeaderName' => '<string>',
                            'Position' => 'FIRST|LAST|ANY',
                        ],
                    ],
                    'ManagedRuleGroupStatement' => [
                        'ExcludedRules' => [
                            [
                                'Name' => '<string>',
                            ],
                            // ...
                        ],
                        'Name' => '<string>',
                        'VendorName' => '<string>',
                    ],
                    'NotStatement' => [
                        'Statement' => [...], // RECURSIVE
                    ],
                    'OrStatement' => [
                        'Statements' => [
                            [...], // RECURSIVE
                            // ...
                        ],
                    ],
                    'RateBasedStatement' => [
                        'AggregateKeyType' => 'IP|FORWARDED_IP',
                        'ForwardedIPConfig' => [
                            'FallbackBehavior' => 'MATCH|NO_MATCH',
                            'HeaderName' => '<string>',
                        ],
                        'Limit' => <integer>,
                        'ScopeDownStatement' => [...], // RECURSIVE
                    ],
                    'RegexPatternSetReferenceStatement' => [
                        'ARN' => '<string>',
                        'FieldToMatch' => [
                            'AllQueryArguments' => [
                            ],
                            'Body' => [
                            ],
                            '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',
                            ],
                            // ...
                        ],
                    ],
                    'RuleGroupReferenceStatement' => [
                        'ARN' => '<string>',
                        'ExcludedRules' => [
                            [
                                'Name' => '<string>',
                            ],
                            // ...
                        ],
                    ],
                    'SizeConstraintStatement' => [
                        'ComparisonOperator' => 'EQ|NE|LE|LT|GE|GT',
                        'FieldToMatch' => [
                            'AllQueryArguments' => [
                            ],
                            'Body' => [
                            ],
                            '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',
                            ],
                            // ...
                        ],
                    ],
                    'SqliMatchStatement' => [
                        'FieldToMatch' => [
                            'AllQueryArguments' => [
                            ],
                            'Body' => [
                            ],
                            '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',
                            ],
                            // ...
                        ],
                    ],
                    'XssMatchStatement' => [
                        'FieldToMatch' => [
                            'AllQueryArguments' => [
                            ],
                            'Body' => [
                            ],
                            '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',
                            ],
                            // ...
                        ],
                    ],
                ],
                '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 AWS WAF couldn’t perform the operation because of a system problem. Retry your request.

• WAFNonexistentItemException:

  AWS WAF couldn’t perform the operation because your resource doesn’t exist.

• WAFInvalidParameterException:

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

  • You specified an invalid parameter name or value.

  • 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 cannot be associated.

• WAFUnavailableEntityException:

  AWS WAF couldn’t retrieve the resource that you requested. Retry your request.

• WAFInvalidOperationException:

  The operation isn't valid.

ListAvailableManagedRuleGroups

$result = $client->listAvailableManagedRuleGroups([/* ... */]);
$promise = $client->listAvailableManagedRuleGroupsAsync([/* ... */]);

Parameter Syntax

$result = $client->listAvailableManagedRuleGroups([
    'Limit' => <integer>,
    'NextMarker' => '<string>',
    'Scope' => 'CLOUDFRONT|REGIONAL', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ManagedRuleGroups' => [
        [
            'Description' => '<string>',
            'Name' => '<string>',
            'VendorName' => '<string>',
        ],
        // ...
    ],
    'NextMarker' => '<string>',
]

Result Details

Errors

• WAFInternalErrorException:

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

• WAFInvalidParameterException:

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

  • You specified an invalid parameter name or value.

  • 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 cannot be associated.

• WAFInvalidOperationException:

  The operation isn't valid.

ListIPSets

$result = $client->listIPSets([/* ... */]);
$promise = $client->listIPSetsAsync([/* ... */]);

Parameter Syntax

$result = $client->listIPSets([
    'Limit' => <integer>,
    'NextMarker' => '<string>',
    'Scope' => 'CLOUDFRONT|REGIONAL', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'IPSets' => [
        [
            'ARN' => '<string>',
            'Description' => '<string>',
            'Id' => '<string>',
            'LockToken' => '<string>',
            'Name' => '<string>',
        ],
        // ...
    ],
    'NextMarker' => '<string>',
]

Result Details

Errors

• WAFInternalErrorException:

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

• WAFInvalidParameterException:

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

  • You specified an invalid parameter name or value.

  • 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 cannot be associated.

• WAFInvalidOperationException:

  The operation isn't valid.

ListLoggingConfigurations

$result = $client->listLoggingConfigurations([/* ... */]);
$promise = $client->listLoggingConfigurationsAsync([/* ... */]);

Parameter Syntax

$result = $client->listLoggingConfigurations([
    'Limit' => <integer>,
    'NextMarker' => '<string>',
    'Scope' => 'CLOUDFRONT|REGIONAL',
]);

Parameter Details

Result Syntax

[
    'LoggingConfigurations' => [
        [
            'LogDestinationConfigs' => ['<string>', ...],
            'ManagedByFirewallManager' => true || false,
            'RedactedFields' => [
                [
                    'AllQueryArguments' => [
                    ],
                    'Body' => [
                    ],
                    'Method' => [
                    ],
                    'QueryString' => [
                    ],
                    'SingleHeader' => [
                        'Name' => '<string>',
                    ],
                    'SingleQueryArgument' => [
                        'Name' => '<string>',
                    ],
                    'UriPath' => [
                    ],
                ],
                // ...
            ],
            'ResourceArn' => '<string>',
        ],
        // ...
    ],
    'NextMarker' => '<string>',
]

Result Details

Errors

• WAFInternalErrorException:

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

• WAFInvalidParameterException:

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

  • You specified an invalid parameter name or value.

  • 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 cannot be associated.

• WAFInvalidOperationException:

  The operation isn't valid.

ListRegexPatternSets

$result = $client->listRegexPatternSets([/* ... */]);
$promise = $client->listRegexPatternSetsAsync([/* ... */]);

Parameter Syntax

$result = $client->listRegexPatternSets([
    'Limit' => <integer>,
    'NextMarker' => '<string>',
    'Scope' => 'CLOUDFRONT|REGIONAL', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'NextMarker' => '<string>',
    'RegexPatternSets' => [
        [
            'ARN' => '<string>',
            'Description' => '<string>',
            'Id' => '<string>',
            'LockToken' => '<string>',
            'Name' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

• WAFInternalErrorException:

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

• WAFInvalidParameterException:

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

  • You specified an invalid parameter name or value.

  • 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 cannot be associated.

• WAFInvalidOperationException:

  The operation isn't valid.

ListResourcesForWebACL

$result = $client->listResourcesForWebACL([/* ... */]);
$promise = $client->listResourcesForWebACLAsync([/* ... */]);

Parameter Syntax

$result = $client->listResourcesForWebACL([
    'ResourceType' => 'APPLICATION_LOAD_BALANCER|API_GATEWAY|APPSYNC',
    'WebACLArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ResourceArns' => ['<string>', ...],
]

Result Details

Errors

• WAFInternalErrorException:

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

• WAFNonexistentItemException:

  AWS WAF couldn’t perform the operation because your resource doesn’t exist.

• WAFInvalidParameterException:

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

  • You specified an invalid parameter name or value.

  • 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 cannot be associated.

• WAFInvalidOperationException:

  The operation isn't valid.

ListRuleGroups

$result = $client->listRuleGroups([/* ... */]);
$promise = $client->listRuleGroupsAsync([/* ... */]);

Parameter Syntax

$result = $client->listRuleGroups([
    'Limit' => <integer>,
    'NextMarker' => '<string>',
    'Scope' => 'CLOUDFRONT|REGIONAL', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'NextMarker' => '<string>',
    'RuleGroups' => [
        [
            'ARN' => '<string>',
            'Description' => '<string>',
            'Id' => '<string>',
            'LockToken' => '<string>',
            'Name' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

• WAFInternalErrorException:

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

• WAFInvalidParameterException:

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

  • You specified an invalid parameter name or value.

  • 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 cannot be associated.

• WAFInvalidOperationException:

  The operation isn't valid.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Parameter Syntax

$result = $client->listTagsForResource([
    'Limit' => <integer>,
    'NextMarker' => '<string>',
    'ResourceARN' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'NextMarker' => '<string>',
    'TagInfoForResource' => [
        'ResourceARN' => '<string>',
        'TagList' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Errors

• WAFInternalErrorException:

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

• WAFInvalidParameterException:

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

  • You specified an invalid parameter name or value.

  • 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 cannot be associated.

• WAFNonexistentItemException:

  AWS WAF couldn’t perform the operation because your resource doesn’t exist.

• WAFTagOperationException:

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

• WAFTagOperationInternalErrorException:

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

• WAFInvalidOperationException:

  The operation isn't valid.

ListWebACLs

$result = $client->listWebACLs([/* ... */]);
$promise = $client->listWebACLsAsync([/* ... */]);

Parameter Syntax

$result = $client->listWebACLs([
    'Limit' => <integer>,
    'NextMarker' => '<string>',
    'Scope' => 'CLOUDFRONT|REGIONAL', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'NextMarker' => '<string>',
    'WebACLs' => [
        [
            'ARN' => '<string>',
            'Description' => '<string>',
            'Id' => '<string>',
            'LockToken' => '<string>',
            'Name' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

• WAFInternalErrorException:

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

• WAFInvalidParameterException:

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

  • You specified an invalid parameter name or value.

  • 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 cannot be associated.

• WAFInvalidOperationException:

  The operation isn't valid.

PutLoggingConfiguration

$result = $client->putLoggingConfiguration([/* ... */]);
$promise = $client->putLoggingConfigurationAsync([/* ... */]);

Parameter Syntax

$result = $client->putLoggingConfiguration([
    'LoggingConfiguration' => [ // REQUIRED
        'LogDestinationConfigs' => ['<string>', ...], // REQUIRED
        'ManagedByFirewallManager' => true || false,
        'RedactedFields' => [
            [
                'AllQueryArguments' => [
                ],
                'Body' => [
                ],
                'Method' => [
                ],
                'QueryString' => [
                ],
                'SingleHeader' => [
                    'Name' => '<string>', // REQUIRED
                ],
                'SingleQueryArgument' => [
                    'Name' => '<string>', // REQUIRED
                ],
                'UriPath' => [
                ],
            ],
            // ...
        ],
        'ResourceArn' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Result Syntax

[
    'LoggingConfiguration' => [
        'LogDestinationConfigs' => ['<string>', ...],
        'ManagedByFirewallManager' => true || false,
        'RedactedFields' => [
            [
                'AllQueryArguments' => [
                ],
                'Body' => [
                ],
                'Method' => [
                ],
                'QueryString' => [
                ],
                'SingleHeader' => [
                    'Name' => '<string>',
                ],
                'SingleQueryArgument' => [
                    'Name' => '<string>',
                ],
                'UriPath' => [
                ],
            ],
            // ...
        ],
        'ResourceArn' => '<string>',
    ],
]

Result Details

Errors

• WAFInternalErrorException:

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

• WAFNonexistentItemException:

  AWS WAF couldn’t perform the operation because your resource doesn’t exist.

• WAFOptimisticLockException:

  AWS 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.

• WAFServiceLinkedRoleErrorException:

  AWS WAF is not able to access the service linked role. This can be caused by a previous PutLoggingConfiguration request, which can lock the service linked role for about 20 seconds. Please try your request again. The service linked role can also be locked by a previous DeleteServiceLinkedRole request, which can lock the role for 15 minutes or more. If you recently made a call to DeleteServiceLinkedRole, wait at least 15 minutes and try the request again. If you receive this same exception again, you will have to wait additional time until the role is unlocked.

• WAFInvalidParameterException:

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

  • You specified an invalid parameter name or value.

  • 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 cannot be associated.

• WAFInvalidOperationException:

  The operation isn't valid.

• WAFLimitsExceededException:

  AWS 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 AWS account. For more information, see Limits in the AWS WAF Developer Guide.

PutPermissionPolicy

$result = $client->putPermissionPolicy([/* ... */]);
$promise = $client->putPermissionPolicyAsync([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

• WAFNonexistentItemException:

  AWS WAF couldn’t perform the operation because your resource doesn’t exist.

• WAFInternalErrorException:

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

• WAFInvalidParameterException:

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

  • You specified an invalid parameter name or value.

  • 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 cannot be associated.

• WAFInvalidPermissionPolicyException:

  The operation failed because the specified policy isn't in the proper format.

  The policy specifications must conform to the following:

  • The policy must be composed using IAM Policy version 2012-10-17 or version 2015-01-01.

  • The policy must include specifications for Effect, Action, and Principal.

  • Effect must specify Allow.

  • Action must specify wafv2:CreateWebACL, wafv2:UpdateWebACL, and wafv2:PutFirewallManagerRuleGroups. AWS WAF rejects any extra actions or wildcard actions in the policy.

  • The policy must not include a Resource parameter.

  For more information, see IAM Policies.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Parameter Syntax

$result = $client->tagResource([
    'ResourceARN' => '<string>', // REQUIRED
    'Tags' => [ // REQUIRED
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

• WAFInternalErrorException:

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

• WAFInvalidParameterException:

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

  • You specified an invalid parameter name or value.

  • 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 cannot be associated.

• WAFLimitsExceededException:

  AWS 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 AWS account. For more information, see Limits in the AWS WAF Developer Guide.

• WAFNonexistentItemException:

  AWS WAF couldn’t perform the operation because your resource doesn’t exist.

• WAFTagOperationException:

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

• WAFTagOperationInternalErrorException:

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

• WAFInvalidOperationException:

  The operation isn't valid.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Parameter Syntax

$result = $client->untagResource([
    'ResourceARN' => '<string>', // REQUIRED
    'TagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

• WAFInternalErrorException:

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

• WAFInvalidParameterException:

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

  • You specified an invalid parameter name or value.

  • 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 cannot be associated.

• WAFNonexistentItemException:

  AWS WAF couldn’t perform the operation because your resource doesn’t exist.

• WAFTagOperationException:

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

• WAFTagOperationInternalErrorException:

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

• WAFInvalidOperationException:

  The operation isn't valid.

UpdateIPSet

$result = $client->updateIPSet([/* ... */]);
$promise = $client->updateIPSetAsync([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

• WAFInternalErrorException:

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

• WAFInvalidParameterException:

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

  • You specified an invalid parameter name or value.

  • 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 cannot be associated.

• WAFNonexistentItemException:

  AWS WAF couldn’t perform the operation because your resource doesn’t exist.

• WAFDuplicateItemException:

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

• WAFOptimisticLockException:

  AWS 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:

  AWS 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 AWS account. For more information, see Limits in the AWS WAF Developer Guide.

• WAFInvalidOperationException:

  The operation isn't valid.

UpdateRegexPatternSet

$result = $client->updateRegexPatternSet([/* ... */]);
$promise = $client->updateRegexPatternSetAsync([/* ... */]);

Parameter Syntax

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

Parameter Details