AssociateWebACL

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

This is AWS WAF Classic Regional documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Associates a web ACL with a resource, either an application load balancer or Amazon API Gateway stage.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

WAFInternalErrorException:

The operation failed because of a system problem, even though the request was valid. Retry your request.

WAFInvalidAccountException:

The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.

WAFInvalidParameterException:

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

• You specified an invalid parameter name.

• You specified an invalid value.

• You tried to update an object (ByteMatchSet, IPSet, Rule, or WebACL) using an action other than INSERT or DELETE.

• You tried to create a WebACL with a DefaultAction Type other than ALLOW, BLOCK, or COUNT.

• You tried to create a RateBasedRule with a RateKey value other than IP.

• You tried to update a WebACL with a WafAction Type other than ALLOW, BLOCK, or COUNT.

• You tried to update a ByteMatchSet with a FieldToMatch Type other than HEADER, METHOD, QUERY_STRING, URI, or BODY.

• You tried to update a ByteMatchSet with a Field of HEADER but no value for Data.

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

WAFNonexistentItemException:

The operation failed because the referenced object doesn't exist.

WAFUnavailableEntityException:

The operation failed because the entity referenced is temporarily unavailable. Retry your request.

CreateByteMatchSet

$result = $client->createByteMatchSet([/* ... */]);
$promise = $client->createByteMatchSetAsync([/* ... */]);

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Creates a ByteMatchSet. You then use UpdateByteMatchSet to identify the part of a web request that you want AWS WAF to inspect, such as the values of the User-Agent header or the query string. For example, you can create a ByteMatchSet that matches any requests with User-Agent headers that contain the string BadBot. You can then configure AWS WAF to reject those requests.

To create and configure a ByteMatchSet, perform the following steps:

1. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateByteMatchSet request.

2. Submit a CreateByteMatchSet request.

3. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateByteMatchSet request.

4. Submit an UpdateByteMatchSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for.

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

Parameter Syntax

$result = $client->createByteMatchSet([
    'ChangeToken' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ByteMatchSet' => [
        'ByteMatchSetId' => '<string>',
        'ByteMatchTuples' => [
            [
                'FieldToMatch' => [
                    'Data' => '<string>',
                    'Type' => 'URI|QUERY_STRING|HEADER|METHOD|BODY|SINGLE_QUERY_ARG|ALL_QUERY_ARGS',
                ],
                'PositionalConstraint' => 'EXACTLY|STARTS_WITH|ENDS_WITH|CONTAINS|CONTAINS_WORD',
                'TargetString' => <string || resource || Psr\Http\Message\StreamInterface>,
                'TextTransformation' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE',
            ],
            // ...
        ],
        'Name' => '<string>',
    ],
    'ChangeToken' => '<string>',
]

Result Details

Errors

WAFDisallowedNameException:

The name specified is invalid.

WAFInternalErrorException:

The operation failed because of a system problem, even though the request was valid. Retry your request.

WAFInvalidAccountException:

The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.

WAFInvalidParameterException:

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

• You specified an invalid parameter name.

• You specified an invalid value.

• You tried to update an object (ByteMatchSet, IPSet, Rule, or WebACL) using an action other than INSERT or DELETE.

• You tried to create a WebACL with a DefaultAction Type other than ALLOW, BLOCK, or COUNT.

• You tried to create a RateBasedRule with a RateKey value other than IP.

• You tried to update a WebACL with a WafAction Type other than ALLOW, BLOCK, or COUNT.

• You tried to update a ByteMatchSet with a FieldToMatch Type other than HEADER, METHOD, QUERY_STRING, URI, or BODY.

• You tried to update a ByteMatchSet with a Field of HEADER but no value for Data.

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

WAFStaleDataException:

The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.

WAFLimitsExceededException:

The operation exceeds a 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.

CreateGeoMatchSet

$result = $client->createGeoMatchSet([/* ... */]);
$promise = $client->createGeoMatchSetAsync([/* ... */]);

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Creates an GeoMatchSet, which you use to specify which web requests you want to allow or block based on the country that the requests originate from. For example, if you're receiving a lot of requests from one or more countries and you want to block the requests, you can create an GeoMatchSet that contains those countries and then configure AWS WAF to block the requests.

To create and configure a GeoMatchSet, perform the following steps:

1. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateGeoMatchSet request.

2. Submit a CreateGeoMatchSet request.

3. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateGeoMatchSet request.

4. Submit an UpdateGeoMatchSetSet request to specify the countries that you want AWS WAF to watch for.

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

Parameter Syntax

$result = $client->createGeoMatchSet([
    'ChangeToken' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ChangeToken' => '<string>',
    'GeoMatchSet' => [
        'GeoMatchConstraints' => [
            [
                'Type' => 'Country',
                'Value' => 'AF|AX|AL|DZ|AS|AD|AO|AI|AQ|AG|AR|AM|AW|AU|AT|AZ|BS|BH|BD|BB|BY|BE|BZ|BJ|BM|BT|BO|BQ|BA|BW|BV|BR|IO|BN|BG|BF|BI|KH|CM|CA|CV|KY|CF|TD|CL|CN|CX|CC|CO|KM|CG|CD|CK|CR|CI|HR|CU|CW|CY|CZ|DK|DJ|DM|DO|EC|EG|SV|GQ|ER|EE|ET|FK|FO|FJ|FI|FR|GF|PF|TF|GA|GM|GE|DE|GH|GI|GR|GL|GD|GP|GU|GT|GG|GN|GW|GY|HT|HM|VA|HN|HK|HU|IS|IN|ID|IR|IQ|IE|IM|IL|IT|JM|JP|JE|JO|KZ|KE|KI|KP|KR|KW|KG|LA|LV|LB|LS|LR|LY|LI|LT|LU|MO|MK|MG|MW|MY|MV|ML|MT|MH|MQ|MR|MU|YT|MX|FM|MD|MC|MN|ME|MS|MA|MZ|MM|NA|NR|NP|NL|NC|NZ|NI|NE|NG|NU|NF|MP|NO|OM|PK|PW|PS|PA|PG|PY|PE|PH|PN|PL|PT|PR|QA|RE|RO|RU|RW|BL|SH|KN|LC|MF|PM|VC|WS|SM|ST|SA|SN|RS|SC|SL|SG|SX|SK|SI|SB|SO|ZA|GS|SS|ES|LK|SD|SR|SJ|SZ|SE|CH|SY|TW|TJ|TZ|TH|TL|TG|TK|TO|TT|TN|TR|TM|TC|TV|UG|UA|AE|GB|US|UM|UY|UZ|VU|VE|VN|VG|VI|WF|EH|YE|ZM|ZW',
            ],
            // ...
        ],
        'GeoMatchSetId' => '<string>',
        'Name' => '<string>',
    ],
]

Result Details

Errors

WAFStaleDataException:

The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.

WAFInternalErrorException:

The operation failed because of a system problem, even though the request was valid. Retry your request.

WAFInvalidAccountException:

The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.

WAFDisallowedNameException:

The name specified is invalid.

WAFInvalidParameterException:

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

• You specified an invalid parameter name.

• You specified an invalid value.

• You tried to update an object (ByteMatchSet, IPSet, Rule, or WebACL) using an action other than INSERT or DELETE.

• You tried to create a WebACL with a DefaultAction Type other than ALLOW, BLOCK, or COUNT.

• You tried to create a RateBasedRule with a RateKey value other than IP.

• You tried to update a WebACL with a WafAction Type other than ALLOW, BLOCK, or COUNT.

• You tried to update a ByteMatchSet with a FieldToMatch Type other than HEADER, METHOD, QUERY_STRING, URI, or BODY.

• You tried to update a ByteMatchSet with a Field of HEADER but no value for Data.

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

WAFLimitsExceededException:

The operation exceeds a 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.

CreateIPSet

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

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Creates an IPSet, which you use to specify which web requests that you want to allow or block based on the IP addresses that the requests originate from. For example, if you're receiving a lot of requests from one or more individual IP addresses or one or more ranges of IP addresses and you want to block the requests, you can create an IPSet that contains those IP addresses and then configure AWS WAF to block the requests.

To create and configure an IPSet, perform the following steps:

1. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateIPSet request.

2. Submit a CreateIPSet request.

3. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateIPSet request.

4. Submit an UpdateIPSet request to specify the IP addresses that you want AWS WAF to watch for.

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

Parameter Syntax

$result = $client->createIPSet([
    'ChangeToken' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ChangeToken' => '<string>',
    'IPSet' => [
        'IPSetDescriptors' => [
            [
                'Type' => 'IPV4|IPV6',
                'Value' => '<string>',
            ],
            // ...
        ],
        'IPSetId' => '<string>',
        'Name' => '<string>',
    ],
]

Result Details

Errors

WAFStaleDataException:

The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.

WAFInternalErrorException:

The operation failed because of a system problem, even though the request was valid. Retry your request.

WAFInvalidAccountException:

The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.

WAFDisallowedNameException:

The name specified is invalid.

WAFInvalidParameterException:

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

• You specified an invalid parameter name.

• You specified an invalid value.

• You tried to update an object (ByteMatchSet, IPSet, Rule, or WebACL) using an action other than INSERT or DELETE.

• You tried to create a WebACL with a DefaultAction Type other than ALLOW, BLOCK, or COUNT.

• You tried to create a RateBasedRule with a RateKey value other than IP.

• You tried to update a WebACL with a WafAction Type other than ALLOW, BLOCK, or COUNT.

• You tried to update a ByteMatchSet with a FieldToMatch Type other than HEADER, METHOD, QUERY_STRING, URI, or BODY.

• You tried to update a ByteMatchSet with a Field of HEADER but no value for Data.

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

WAFLimitsExceededException:

The operation exceeds a 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.

Examples

Example 1: To create an IP set

The following example creates an IP match set named MyIPSetFriendlyName.

$result = $client->createIPSet([
    'ChangeToken' => 'abcd12f2-46da-4fdb-b8d5-fbd4c466928f',
    'Name' => 'MyIPSetFriendlyName',
]);

Result syntax:

[
    'ChangeToken' => 'abcd12f2-46da-4fdb-b8d5-fbd4c466928f',
    'IPSet' => [
        'IPSetDescriptors' => [
            [
                'Type' => 'IPV4',
                'Value' => '192.0.2.44/32',
            ],
        ],
        'IPSetId' => 'example1ds3t-46da-4fdb-b8d5-abc321j569j5',
        'Name' => 'MyIPSetFriendlyName',
    ],
]

CreateRateBasedRule

$result = $client->createRateBasedRule([/* ... */]);
$promise = $client->createRateBasedRuleAsync([/* ... */]);

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Creates a RateBasedRule. The RateBasedRule contains a RateLimit, which specifies the maximum number of requests that AWS WAF allows from a specified IP address in a five-minute period. The RateBasedRule also contains the IPSet objects, ByteMatchSet objects, and other predicates that identify the requests that you want to count or block if these requests exceed the RateLimit.

If you add more than one predicate to a RateBasedRule, a request not only must exceed the RateLimit, but it also must match all the conditions to be counted or blocked. For example, suppose you add the following to a RateBasedRule:

• An IPSet that matches the IP address 192.0.2.44/32

• A ByteMatchSet that matches BadBot in the User-Agent header

Further, you specify a RateLimit of 1,000.

You then add the RateBasedRule to a WebACL and specify that you want to block requests that meet the conditions in the rule. For a request to be blocked, it must come from the IP address 192.0.2.44 and the User-Agent header in the request must contain the value BadBot. Further, requests that match these two conditions must be received at a rate of more than 1,000 requests every five minutes. If both conditions are met and the rate is exceeded, AWS WAF blocks the requests. If the rate drops below 1,000 for a five-minute period, AWS WAF no longer blocks the requests.

As a second example, suppose you want to limit requests to a particular page on your site. To do this, you could add the following to a RateBasedRule:

• A ByteMatchSet with FieldToMatch of URI

• A PositionalConstraint of STARTS_WITH

• A TargetString of login

Further, you specify a RateLimit of 1,000.

By adding this RateBasedRule to a WebACL, you could limit requests to your login page without affecting the rest of your site.

To create and configure a RateBasedRule, perform the following steps:

1. Create and update the predicates that you want to include in the rule. For more information, see CreateByteMatchSet, CreateIPSet, and CreateSqlInjectionMatchSet.

2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateRule request.

3. Submit a CreateRateBasedRule request.

4. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRule request.

5. Submit an UpdateRateBasedRule request to specify the predicates that you want to include in the rule.

6. Create and update a WebACL that contains the RateBasedRule. For more information, see CreateWebACL.

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

Parameter Syntax

$result = $client->createRateBasedRule([
    'ChangeToken' => '<string>', // REQUIRED
    'MetricName' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
    'RateKey' => 'IP', // REQUIRED
    'RateLimit' => <integer>, // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'ChangeToken' => '<string>',
    'Rule' => [
        'MatchPredicates' => [
            [
                'DataId' => '<string>',
                'Negated' => true || false,
                'Type' => 'IPMatch|ByteMatch|SqlInjectionMatch|GeoMatch|SizeConstraint|XssMatch|RegexMatch',
            ],
            // ...
        ],
        'MetricName' => '<string>',
        'Name' => '<string>',
        'RateKey' => 'IP',
        'RateLimit' => <integer>,
        'RuleId' => '<string>',
    ],
]

Result Details

Errors

WAFStaleDataException:

The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.

WAFInternalErrorException:

The operation failed because of a system problem, even though the request was valid. Retry your request.

WAFDisallowedNameException:

The name specified is invalid.

WAFInvalidParameterException:

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

• You specified an invalid parameter name.

• You specified an invalid value.

• You tried to update an object (ByteMatchSet, IPSet, Rule, or WebACL) using an action other than INSERT or DELETE.

• You tried to create a WebACL with a DefaultAction Type other than ALLOW, BLOCK, or COUNT.

• You tried to create a RateBasedRule with a RateKey value other than IP.

• You tried to update a WebACL with a WafAction Type other than ALLOW, BLOCK, or COUNT.

• You tried to update a ByteMatchSet with a FieldToMatch Type other than HEADER, METHOD, QUERY_STRING, URI, or BODY.

• You tried to update a ByteMatchSet with a Field of HEADER but no value for Data.

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

WAFLimitsExceededException:

The operation exceeds a 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:

WAFTagOperationInternalErrorException:

WAFBadRequestException:

CreateRegexMatchSet

$result = $client->createRegexMatchSet([/* ... */]);
$promise = $client->createRegexMatchSetAsync([/* ... */]);

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Creates a RegexMatchSet. You then use UpdateRegexMatchSet to identify the part of a web request that you want AWS WAF to inspect, such as the values of the User-Agent header or the query string. For example, you can create a RegexMatchSet that contains a RegexMatchTuple that looks for any requests with User-Agent headers that match a RegexPatternSet with pattern B[a@]dB[o0]t. You can then configure AWS WAF to reject those requests.

To create and configure a RegexMatchSet, perform the following steps:

1. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateRegexMatchSet request.

2. Submit a CreateRegexMatchSet request.

3. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRegexMatchSet request.

4. Submit an UpdateRegexMatchSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value, using a RegexPatternSet, that you want AWS WAF to watch for.

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

Parameter Syntax

$result = $client->createRegexMatchSet([
    'ChangeToken' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ChangeToken' => '<string>',
    'RegexMatchSet' => [
        'Name' => '<string>',
        'RegexMatchSetId' => '<string>',
        'RegexMatchTuples' => [
            [
                'FieldToMatch' => [
                    'Data' => '<string>',
                    'Type' => 'URI|QUERY_STRING|HEADER|METHOD|BODY|SINGLE_QUERY_ARG|ALL_QUERY_ARGS',
                ],
                'RegexPatternSetId' => '<string>',
                'TextTransformation' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE',
            ],
            // ...
        ],
    ],
]

Result Details

Errors

WAFStaleDataException:

The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.

WAFInternalErrorException:

The operation failed because of a system problem, even though the request was valid. Retry your request.

WAFDisallowedNameException:

The name specified is invalid.

WAFLimitsExceededException:

The operation exceeds a 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.

CreateRegexPatternSet

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

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Creates a RegexPatternSet. You then use UpdateRegexPatternSet to specify the regular expression (regex) pattern that you want AWS WAF to search for, such as B[a@]dB[o0]t. You can then configure AWS WAF to reject those requests.

To create and configure a RegexPatternSet, perform the following steps:

1. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateRegexPatternSet request.

2. Submit a CreateRegexPatternSet request.

3. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRegexPatternSet request.

4. Submit an UpdateRegexPatternSet request to specify the string that you want AWS WAF to watch for.

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

Parameter Syntax

$result = $client->createRegexPatternSet([
    'ChangeToken' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ChangeToken' => '<string>',
    'RegexPatternSet' => [
        'Name' => '<string>',
        'RegexPatternSetId' => '<string>',
        'RegexPatternStrings' => ['<string>', ...],
    ],
]

Result Details

Errors

WAFStaleDataException:

The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.

WAFInternalErrorException:

The operation failed because of a system problem, even though the request was valid. Retry your request.

WAFDisallowedNameException:

The name specified is invalid.

WAFLimitsExceededException:

The operation exceeds a 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.

CreateRule

$result = $client->createRule([/* ... */]);
$promise = $client->createRuleAsync([/* ... */]);

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Creates a Rule, which contains the IPSet objects, ByteMatchSet objects, and other predicates that identify the requests that you want to block. If you add more than one predicate to a Rule, a request must match all of the specifications to be allowed or blocked. For example, suppose that you add the following to a Rule:

• An IPSet that matches the IP address 192.0.2.44/32

• A ByteMatchSet that matches BadBot in the User-Agent header

You then add the Rule to a WebACL and specify that you want to blocks requests that satisfy the Rule. For a request to be blocked, it must come from the IP address 192.0.2.44 and the User-Agent header in the request must contain the value BadBot.

To create and configure a Rule, perform the following steps:

1. Create and update the predicates that you want to include in the Rule. For more information, see CreateByteMatchSet, CreateIPSet, and CreateSqlInjectionMatchSet.

2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateRule request.

3. Submit a CreateRule request.

4. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRule request.

5. Submit an UpdateRule request to specify the predicates that you want to include in the Rule.

6. Create and update a WebACL that contains the Rule. For more information, see CreateWebACL.

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

Parameter Syntax

$result = $client->createRule([
    'ChangeToken' => '<string>', // REQUIRED
    'MetricName' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'ChangeToken' => '<string>',
    'Rule' => [
        'MetricName' => '<string>',
        'Name' => '<string>',
        'Predicates' => [
            [
                'DataId' => '<string>',
                'Negated' => true || false,
                'Type' => 'IPMatch|ByteMatch|SqlInjectionMatch|GeoMatch|SizeConstraint|XssMatch|RegexMatch',
            ],
            // ...
        ],
        'RuleId' => '<string>',
    ],
]

Result Details

Errors

WAFStaleDataException:

The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.

WAFInternalErrorException:

The operation failed because of a system problem, even though the request was valid. Retry your request.

WAFDisallowedNameException:

The name specified is invalid.

WAFInvalidParameterException:

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

• You specified an invalid parameter name.

• You specified an invalid value.

• You tried to update an object (ByteMatchSet, IPSet, Rule, or WebACL) using an action other than INSERT or DELETE.

• You tried to create a WebACL with a DefaultAction Type other than ALLOW, BLOCK, or COUNT.

• You tried to create a RateBasedRule with a RateKey value other than IP.

• You tried to update a WebACL with a WafAction Type other than ALLOW, BLOCK, or COUNT.

• You tried to update a ByteMatchSet with a FieldToMatch Type other than HEADER, METHOD, QUERY_STRING, URI, or BODY.

• You tried to update a ByteMatchSet with a Field of HEADER but no value for Data.

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

WAFLimitsExceededException:

The operation exceeds a 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:

WAFTagOperationInternalErrorException:

WAFBadRequestException:

Examples

Example 1: To create a rule

The following example creates a rule named WAFByteHeaderRule.

$result = $client->createRule([
    'ChangeToken' => 'abcd12f2-46da-4fdb-b8d5-fbd4c466928f',
    'MetricName' => 'WAFByteHeaderRule',
    'Name' => 'WAFByteHeaderRule',
]);

Result syntax:

[
    'ChangeToken' => 'abcd12f2-46da-4fdb-b8d5-fbd4c466928f',
    'Rule' => [
        'MetricName' => 'WAFByteHeaderRule',
        'Name' => 'WAFByteHeaderRule',
        'Predicates' => [
            [
                'DataId' => 'MyByteMatchSetID',
                'Negated' => ,
                'Type' => 'ByteMatch',
            ],
        ],
        'RuleId' => 'WAFRule-1-Example',
    ],
]

CreateRuleGroup

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

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Creates a RuleGroup. A rule group is a collection of predefined rules that you add to a web ACL. You use UpdateRuleGroup to add rules to the rule group.

Rule groups are subject to the following limits:

• Three rule groups per account. You can request an increase to this limit by contacting customer support.

• One rule group per web ACL.

• Ten rules per rule group.

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

Parameter Syntax

$result = $client->createRuleGroup([
    'ChangeToken' => '<string>', // REQUIRED
    'MetricName' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'ChangeToken' => '<string>',
    'RuleGroup' => [
        'MetricName' => '<string>',
        'Name' => '<string>',
        'RuleGroupId' => '<string>',
    ],
]

Result Details

Errors

WAFStaleDataException:

The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.

WAFInternalErrorException:

The operation failed because of a system problem, even though the request was valid. Retry your request.

WAFDisallowedNameException:

The name specified is invalid.

WAFLimitsExceededException:

The operation exceeds a 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:

WAFTagOperationInternalErrorException:

WAFBadRequestException:

CreateSizeConstraintSet

$result = $client->createSizeConstraintSet([/* ... */]);
$promise = $client->createSizeConstraintSetAsync([/* ... */]);

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Creates a SizeConstraintSet. You then use UpdateSizeConstraintSet to identify the part of a web request that you want AWS WAF to check for length, such as the length of the User-Agent header or the length of the query string. For example, you can create a SizeConstraintSet that matches any requests that have a query string that is longer than 100 bytes. You can then configure AWS WAF to reject those requests.

To create and configure a SizeConstraintSet, perform the following steps:

1. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateSizeConstraintSet request.

2. Submit a CreateSizeConstraintSet request.

3. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateSizeConstraintSet request.

4. Submit an UpdateSizeConstraintSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for.

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

Parameter Syntax

$result = $client->createSizeConstraintSet([
    'ChangeToken' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ChangeToken' => '<string>',
    'SizeConstraintSet' => [
        'Name' => '<string>',
        'SizeConstraintSetId' => '<string>',
        'SizeConstraints' => [
            [
                'ComparisonOperator' => 'EQ|NE|LE|LT|GE|GT',
                'FieldToMatch' => [
                    'Data' => '<string>',
                    'Type' => 'URI|QUERY_STRING|HEADER|METHOD|BODY|SINGLE_QUERY_ARG|ALL_QUERY_ARGS',
                ],
                'Size' => <integer>,
                'TextTransformation' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE',
            ],
            // ...
        ],
    ],
]

Result Details

Errors

WAFStaleDataException:

The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.

WAFInternalErrorException:

The operation failed because of a system problem, even though the request was valid. Retry your request.

WAFInvalidAccountException:

The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.

WAFDisallowedNameException:

The name specified is invalid.

WAFInvalidParameterException:

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

• You specified an invalid parameter name.

• You specified an invalid value.

• You tried to update an object (ByteMatchSet, IPSet, Rule, or WebACL) using an action other than INSERT or DELETE.

• You tried to create a WebACL with a DefaultAction Type other than ALLOW, BLOCK, or COUNT.

• You tried to create a RateBasedRule with a RateKey value other than IP.

• You tried to update a WebACL with a WafAction Type other than ALLOW, BLOCK, or COUNT.

• You tried to update a ByteMatchSet with a FieldToMatch Type other than HEADER, METHOD, QUERY_STRING, URI, or BODY.

• You tried to update a ByteMatchSet with a Field of HEADER but no value for Data.

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

WAFLimitsExceededException:

The operation exceeds a 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.

Examples

Example 1: To create a size constraint

The following example creates size constraint set named MySampleSizeConstraintSet.

$result = $client->createSizeConstraintSet([
    'ChangeToken' => 'abcd12f2-46da-4fdb-b8d5-fbd4c466928f',
    'Name' => 'MySampleSizeConstraintSet',
]);

Result syntax:

[
    'ChangeToken' => 'abcd12f2-46da-4fdb-b8d5-fbd4c466928f',
    'SizeConstraintSet' => [
        'Name' => 'MySampleSizeConstraintSet',
        'SizeConstraintSetId' => 'example1ds3t-46da-4fdb-b8d5-abc321j569j5',
        'SizeConstraints' => [
            [
                'ComparisonOperator' => 'GT',
                'FieldToMatch' => [
                    'Type' => 'QUERY_STRING',
                ],
                'Size' => 0,
                'TextTransformation' => 'NONE',
            ],
        ],
    ],
]

CreateSqlInjectionMatchSet

$result = $client->createSqlInjectionMatchSet([/* ... */]);
$promise = $client->createSqlInjectionMatchSetAsync([/* ... */]);

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Creates a SqlInjectionMatchSet, which you use to allow, block, or count requests that contain snippets of SQL code in a specified part of web requests. AWS WAF searches for character sequences that are likely to be malicious strings.

To create and configure a SqlInjectionMatchSet, perform the following steps:

1. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateSqlInjectionMatchSet request.

2. Submit a CreateSqlInjectionMatchSet request.

3. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateSqlInjectionMatchSet request.

4. Submit an UpdateSqlInjectionMatchSet request to specify the parts of web requests in which you want to allow, block, or count malicious SQL code.

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

Parameter Syntax

$result = $client->createSqlInjectionMatchSet([
    'ChangeToken' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ChangeToken' => '<string>',
    'SqlInjectionMatchSet' => [
        'Name' => '<string>',
        'SqlInjectionMatchSetId' => '<string>',
        'SqlInjectionMatchTuples' => [
            [
                'FieldToMatch' => [
                    'Data' => '<string>',
                    'Type' => 'URI|QUERY_STRING|HEADER|METHOD|BODY|SINGLE_QUERY_ARG|ALL_QUERY_ARGS',
                ],
                'TextTransformation' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE',
            ],
            // ...
        ],
    ],
]

Result Details

Errors

WAFDisallowedNameException:

The name specified is invalid.

WAFInternalErrorException:

The operation failed because of a system problem, even though the request was valid. Retry your request.

WAFInvalidAccountException:

The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.

WAFInvalidParameterException:

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

• You specified an invalid parameter name.

• You specified an invalid value.

• You tried to update an object (ByteMatchSet, IPSet, Rule, or WebACL) using an action other than INSERT or DELETE.

• You tried to create a WebACL with a DefaultAction Type other than ALLOW, BLOCK, or COUNT.

• You tried to create a RateBasedRule with a RateKey value other than IP.

• You tried to update a WebACL with a WafAction Type other than ALLOW, BLOCK, or COUNT.

• You tried to update a ByteMatchSet with a FieldToMatch Type other than HEADER, METHOD, QUERY_STRING, URI, or BODY.

• You tried to update a ByteMatchSet with a Field of HEADER but no value for Data.

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

WAFStaleDataException:

The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.

WAFLimitsExceededException:

The operation exceeds a 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.

Examples

Example 1: To create a SQL injection match set

The following example creates a SQL injection match set named MySQLInjectionMatchSet.

$result = $client->createSqlInjectionMatchSet([
    'ChangeToken' => 'abcd12f2-46da-4fdb-b8d5-fbd4c466928f',
    'Name' => 'MySQLInjectionMatchSet',
]);

Result syntax:

[
    'ChangeToken' => 'abcd12f2-46da-4fdb-b8d5-fbd4c466928f',
    'SqlInjectionMatchSet' => [
        'Name' => 'MySQLInjectionMatchSet',
        'SqlInjectionMatchSetId' => 'example1ds3t-46da-4fdb-b8d5-abc321j569j5',
        'SqlInjectionMatchTuples' => [
            [
                'FieldToMatch' => [
                    'Type' => 'QUERY_STRING',
                ],
                'TextTransformation' => 'URL_DECODE',
            ],
        ],
    ],
]

CreateWebACL

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

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Creates a WebACL, which contains the Rules that identify the CloudFront web requests that you want to allow, block, or count. AWS WAF evaluates Rules in order based on the value of Priority for each Rule.

You also specify a default action, either ALLOW or BLOCK. If a web request doesn't match any of the Rules in a WebACL, AWS WAF responds to the request with the default action.

To create and configure a WebACL, perform the following steps:

1. Create and update the ByteMatchSet objects and other predicates that you want to include in Rules. For more information, see CreateByteMatchSet, UpdateByteMatchSet, CreateIPSet, UpdateIPSet, CreateSqlInjectionMatchSet, and UpdateSqlInjectionMatchSet.

2. Create and update the Rules that you want to include in the WebACL. For more information, see CreateRule and UpdateRule.

3. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateWebACL request.

4. Submit a CreateWebACL request.

5. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateWebACL request.

6. Submit an UpdateWebACL request to specify the Rules that you want to include in the WebACL, to specify the default action, and to associate the WebACL with a CloudFront distribution.

For more information about how to use the AWS WAF API, see the AWS WAF Developer Guide.

Parameter Syntax

$result = $client->createWebACL([
    'ChangeToken' => '<string>', // REQUIRED
    'DefaultAction' => [ // REQUIRED
        'Type' => 'BLOCK|ALLOW|COUNT', // REQUIRED
    ],
    'MetricName' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'ChangeToken' => '<string>',
    'WebACL' => [
        'DefaultAction' => [
            'Type' => 'BLOCK|ALLOW|COUNT',
        ],
        'MetricName' => '<string>',
        'Name' => '<string>',
        'Rules' => [
            [
                'Action' => [
                    'Type' => 'BLOCK|ALLOW|COUNT',
                ],
                'ExcludedRules' => [
                    [
                        'RuleId' => '<string>',
                    ],
                    // ...
                ],
                'OverrideAction' => [
                    'Type' => 'NONE|COUNT',
                ],
                'Priority' => <integer>,
                'RuleId' => '<string>',
                'Type' => 'REGULAR|RATE_BASED|GROUP',
            ],
            // ...
        ],
        'WebACLArn' => '<string>',
        'WebACLId' => '<string>',
    ],
]

Result Details

Errors

WAFStaleDataException:

The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.

WAFInternalErrorException:

The operation failed because of a system problem, even though the request was valid. Retry your request.

WAFInvalidAccountException:

The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.

WAFDisallowedNameException:

The name specified is invalid.

WAFInvalidParameterException:

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

• You specified an invalid parameter name.

• You specified an invalid value.

• You tried to update an object (ByteMatchSet, IPSet, Rule, or WebACL) using an action other than INSERT or DELETE.

• You tried to create a WebACL with a DefaultAction Type other than ALLOW, BLOCK, or COUNT.

• You tried to create a RateBasedRule with a RateKey value other than IP.

• You tried to update a WebACL with a WafAction Type other than ALLOW, BLOCK, or COUNT.

• You tried to update a ByteMatchSet with a FieldToMatch Type other than HEADER, METHOD, QUERY_STRING, URI, or BODY.

• You tried to update a ByteMatchSet with a Field of HEADER but no value for Data.

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

WAFLimitsExceededException:

The operation exceeds a 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:

WAFTagOperationInternalErrorException:

WAFBadRequestException:

Examples

Example 1: To create a web ACL

The following example creates a web ACL named CreateExample.

$result = $client->createWebACL([
    'ChangeToken' => 'abcd12f2-46da-4fdb-b8d5-fbd4c466928f',
    'DefaultAction' => [
        'Type' => 'ALLOW',
    ],
    'MetricName' => 'CreateExample',
    'Name' => 'CreateExample',
]);

Result syntax:

[
    'ChangeToken' => 'abcd12f2-46da-4fdb-b8d5-fbd4c466928f',
    'WebACL' => [
        'DefaultAction' => [
            'Type' => 'ALLOW',
        ],
        'MetricName' => 'CreateExample',
        'Name' => 'CreateExample',
        'Rules' => [
            [
                'Action' => [
                    'Type' => 'ALLOW',
                ],
                'Priority' => 1,
                'RuleId' => 'WAFRule-1-Example',
            ],
        ],
        'WebACLId' => 'example-46da-4444-5555-example',
    ],
]

CreateWebACLMigrationStack

$result = $client->createWebACLMigrationStack([/* ... */]);
$promise = $client->createWebACLMigrationStackAsync([/* ... */]);

Creates an AWS CloudFormation WAFV2 template for the specified web ACL in the specified Amazon S3 bucket. Then, in CloudFormation, you create a stack from the template, to create the web ACL and its resources in AWS WAFV2. Use this to migrate your AWS WAF Classic web ACL to the latest version of AWS WAF.

This is part of a larger migration procedure for web ACLs from AWS WAF Classic to the latest version of AWS WAF. For the full procedure, including caveats and manual steps to complete the migration and switch over to the new web ACL, see Migrating your AWS WAF Classic resources to AWS WAF in the AWS WAF Developer Guide.

Parameter Syntax

$result = $client->createWebACLMigrationStack([
    'IgnoreUnsupportedType' => true || false, // REQUIRED
    'S3BucketName' => '<string>', // REQUIRED
    'WebACLId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

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

Result Details

Errors

WAFInternalErrorException:

The operation failed because of a system problem, even though the request was valid. 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.

• You specified an invalid value.

• You tried to update an object (ByteMatchSet, IPSet, Rule, or WebACL) using an action other than INSERT or DELETE.

• You tried to create a WebACL with a DefaultAction Type other than ALLOW, BLOCK, or COUNT.

• You tried to create a RateBasedRule with a RateKey value other than IP.

• You tried to update a WebACL with a WafAction Type other than ALLOW, BLOCK, or COUNT.

• You tried to update a ByteMatchSet with a FieldToMatch Type other than HEADER, METHOD, QUERY_STRING, URI, or BODY.

• You tried to update a ByteMatchSet with a Field of HEADER but no value for Data.

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

WAFInvalidOperationException:

The operation failed because there was nothing to do. For example:

• You tried to remove a Rule from a WebACL, but the Rule isn't in the specified WebACL.

• You tried to remove an IP address from an IPSet, but the IP address isn't in the specified IPSet.

• You tried to remove a ByteMatchTuple from a ByteMatchSet, but the ByteMatchTuple isn't in the specified WebACL.

• You tried to add a Rule to a WebACL, but the Rule already exists in the specified WebACL.

• You tried to add a ByteMatchTuple to a ByteMatchSet, but the ByteMatchTuple already exists in the specified WebACL.

WAFNonexistentItemException:

The operation failed because the referenced object doesn't exist.

WAFEntityMigrationException:

The operation failed due to a problem with the migration. The failure cause is provided in the exception, in the MigrationErrorType:

• ENTITY_NOT_SUPPORTED - The web ACL has an unsupported entity but the IgnoreUnsupportedType is not set to true.

• ENTITY_NOT_FOUND - The web ACL doesn't exist.

• S3_BUCKET_NO_PERMISSION - You don't have permission to perform the PutObject action to the specified Amazon S3 bucket.

• S3_BUCKET_NOT_ACCESSIBLE - The bucket policy doesn't allow AWS WAF to perform the PutObject action in the bucket.

• S3_BUCKET_NOT_FOUND - The S3 bucket doesn't exist.

• S3_BUCKET_INVALID_REGION - The S3 bucket is not in the same Region as the web ACL.

• S3_INTERNAL_ERROR - AWS WAF failed to create the template in the S3 bucket for another reason.

CreateXssMatchSet

$result = $client->createXssMatchSet([/* ... */]);
$promise = $client->createXssMatchSetAsync([/* ... */]);

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Creates an XssMatchSet, which you use to allow, block, or count requests that contain cross-site scripting attacks in the specified part of web requests. AWS WAF searches for character sequences that are likely to be malicious strings.

To create and configure an XssMatchSet, perform the following steps:

1. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateXssMatchSet request.

2. Submit a CreateXssMatchSet request.

3. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateXssMatchSet request.

4. Submit an UpdateXssMatchSet request to specify the parts of web requests in which you want to allow, block, or count cross-site scripting attacks.

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

Parameter Syntax

$result = $client->createXssMatchSet([
    'ChangeToken' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ChangeToken' => '<string>',
    'XssMatchSet' => [
        'Name' => '<string>',
        'XssMatchSetId' => '<string>',
        'XssMatchTuples' => [
            [
                'FieldToMatch' => [
                    'Data' => '<string>',
                    'Type' => 'URI|QUERY_STRING|HEADER|METHOD|BODY|SINGLE_QUERY_ARG|ALL_QUERY_ARGS',
                ],
                'TextTransformation' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE',
            ],
            // ...
        ],
    ],
]

Result Details

Errors

WAFDisallowedNameException:

The name specified is invalid.

WAFInternalErrorException:

The operation failed because of a system problem, even though the request was valid. Retry your request.

WAFInvalidAccountException:

The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.

WAFInvalidParameterException:

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

• You specified an invalid parameter name.

• You specified an invalid value.

• You tried to update an object (ByteMatchSet, IPSet, Rule, or WebACL) using an action other than INSERT or DELETE.

• You tried to create a WebACL with a DefaultAction Type other than ALLOW, BLOCK, or COUNT.

• You tried to create a RateBasedRule with a RateKey value other than IP.

• You tried to update a WebACL with a WafAction Type other than ALLOW, BLOCK, or COUNT.

• You tried to update a ByteMatchSet with a FieldToMatch Type other than HEADER, METHOD, QUERY_STRING, URI, or BODY.

• You tried to update a ByteMatchSet with a Field of HEADER but no value for Data.

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

WAFStaleDataException:

The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.

WAFLimitsExceededException:

The operation exceeds a 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.

Examples

Example 1: To create an XSS match set

The following example creates an XSS match set named MySampleXssMatchSet.

$result = $client->createXssMatchSet([
    'ChangeToken' => 'abcd12f2-46da-4fdb-b8d5-fbd4c466928f',
    'Name' => 'MySampleXssMatchSet',
]);

Result syntax:

[
    'ChangeToken' => 'abcd12f2-46da-4fdb-b8d5-fbd4c466928f',
    'XssMatchSet' => [
        'Name' => 'MySampleXssMatchSet',
        'XssMatchSetId' => 'example1ds3t-46da-4fdb-b8d5-abc321j569j5',
        'XssMatchTuples' => [
            [
                'FieldToMatch' => [
                    'Type' => 'QUERY_STRING',
                ],
                'TextTransformation' => 'URL_DECODE',
            ],
        ],
    ],
]

DeleteByteMatchSet

$result = $client->deleteByteMatchSet([/* ... */]);
$promise = $client->deleteByteMatchSetAsync([/* ... */]);

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Permanently deletes a ByteMatchSet. You can't delete a ByteMatchSet if it's still used in any Rules or if it still includes any ByteMatchTuple objects (any filters).

If you just want to remove a ByteMatchSet from a Rule, use UpdateRule.

To permanently delete a ByteMatchSet, perform the following steps:

1. Update the ByteMatchSet to remove filters, if any. For more information, see UpdateByteMatchSet.

2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteByteMatchSet request.

3. Submit a DeleteByteMatchSet request.

Parameter Syntax

$result = $client->deleteByteMatchSet([
    'ByteMatchSetId' => '<string>', // REQUIRED
    'ChangeToken' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

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

Result Details

Errors

WAFInternalErrorException:

The operation failed because of a system problem, even though the request was valid. Retry your request.

WAFInvalidAccountException:

The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.

WAFNonexistentItemException:

The operation failed because the referenced object doesn't exist.

WAFReferencedItemException:

The operation failed because you tried to delete an object that is still in use. For example:

• You tried to delete a ByteMatchSet that is still referenced by a Rule.

• You tried to delete a Rule that is still referenced by a WebACL.

WAFStaleDataException:

The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.

WAFNonEmptyEntityException:

The operation failed because you tried to delete an object that isn't empty. For example:

• You tried to delete a WebACL that still contains one or more Rule objects.

• You tried to delete a Rule that still contains one or more ByteMatchSet objects or other predicates.

• You tried to delete a ByteMatchSet that contains one or more ByteMatchTuple objects.

• You tried to delete an IPSet that references one or more IP addresses.

Examples

Example 1: To delete a byte match set

The following example deletes a byte match set with the ID exampleIDs3t-46da-4fdb-b8d5-abc321j569j5.

$result = $client->deleteByteMatchSet([
    'ByteMatchSetId' => 'exampleIDs3t-46da-4fdb-b8d5-abc321j569j5',
    'ChangeToken' => 'abcd12f2-46da-4fdb-b8d5-fbd4c466928f',
]);

Result syntax:

[
    'ChangeToken' => 'abcd12f2-46da-4fdb-b8d5-fbd4c466928f',
]

DeleteGeoMatchSet

$result = $client->deleteGeoMatchSet([/* ... */]);
$promise = $client->deleteGeoMatchSetAsync([/* ... */]);

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Permanently deletes a GeoMatchSet. You can't delete a GeoMatchSet if it's still used in any Rules or if it still includes any countries.

If you just want to remove a GeoMatchSet from a Rule, use UpdateRule.

To permanently delete a GeoMatchSet from AWS WAF, perform the following steps:

1. Update the GeoMatchSet to remove any countries. For more information, see UpdateGeoMatchSet.

2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteGeoMatchSet request.

3. Submit a DeleteGeoMatchSet request.

Parameter Syntax

$result = $client->deleteGeoMatchSet([
    'ChangeToken' => '<string>', // REQUIRED
    'GeoMatchSetId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

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

Result Details

Errors

WAFStaleDataException:

The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.

WAFInternalErrorException:

The operation failed because of a system problem, even though the request was valid. Retry your request.

WAFInvalidAccountException:

The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.

WAFNonexistentItemException:

The operation failed because the referenced object doesn't exist.

WAFReferencedItemException:

The operation failed because you tried to delete an object that is still in use. For example:

• You tried to delete a ByteMatchSet that is still referenced by a Rule.

• You tried to delete a Rule that is still referenced by a WebACL.

WAFNonEmptyEntityException:

The operation failed because you tried to delete an object that isn't empty. For example:

• You tried to delete a WebACL that still contains one or more Rule objects.

• You tried to delete a Rule that still contains one or more ByteMatchSet objects or other predicates.

• You tried to delete a ByteMatchSet that contains one or more ByteMatchTuple objects.

• You tried to delete an IPSet that references one or more IP addresses.

DeleteIPSet

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

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Permanently deletes an IPSet. You can't delete an IPSet if it's still used in any Rules or if it still includes any IP addresses.

If you just want to remove an IPSet from a Rule, use UpdateRule.

To permanently delete an IPSet from AWS WAF, perform the following steps:

1. Update the IPSet to remove IP address ranges, if any. For more information, see UpdateIPSet.

2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteIPSet request.

3. Submit a DeleteIPSet request.

Parameter Syntax

$result = $client->deleteIPSet([
    'ChangeToken' => '<string>', // REQUIRED
    'IPSetId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

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

Result Details

Errors

WAFStaleDataException:

The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.

WAFInternalErrorException:

The operation failed because of a system problem, even though the request was valid. Retry your request.

WAFInvalidAccountException:

The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.

WAFNonexistentItemException:

The operation failed because the referenced object doesn't exist.

WAFReferencedItemException:

The operation failed because you tried to delete an object that is still in use. For example:

• You tried to delete a ByteMatchSet that is still referenced by a Rule.

• You tried to delete a Rule that is still referenced by a WebACL.

WAFNonEmptyEntityException:

The operation failed because you tried to delete an object that isn't empty. For example:

• You tried to delete a WebACL that still contains one or more Rule objects.

• You tried to delete a Rule that still contains one or more ByteMatchSet objects or other predicates.

• You tried to delete a ByteMatchSet that contains one or more ByteMatchTuple objects.

• You tried to delete an IPSet that references one or more IP addresses.

Examples

Example 1: To delete an IP set

The following example deletes an IP match set with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.

$result = $client->deleteIPSet([
    'ChangeToken' => 'abcd12f2-46da-4fdb-b8d5-fbd4c466928f',
    'IPSetId' => 'example1ds3t-46da-4fdb-b8d5-abc321j569j5',
]);

Result syntax:

[
    'ChangeToken' => 'abcd12f2-46da-4fdb-b8d5-fbd4c466928f',
]

DeleteLoggingConfiguration

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

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Permanently deletes the LoggingConfiguration from the specified web ACL.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

WAFInternalErrorException:

The operation failed because of a system problem, even though the request was valid. Retry your request.

WAFNonexistentItemException:

The operation failed because the referenced object doesn't exist.

WAFStaleDataException:

The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.

DeletePermissionPolicy

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

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Permanently deletes an IAM policy from the specified RuleGroup.

The user making the request must be the owner of the RuleGroup.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

WAFInternalErrorException:

The operation failed because of a system problem, even though the request was valid. Retry your request.

WAFStaleDataException:

The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.

WAFNonexistentItemException:

The operation failed because the referenced object doesn't exist.

DeleteRateBasedRule

$result = $client->deleteRateBasedRule([/* ... */]);
$promise = $client->deleteRateBasedRuleAsync([/* ... */]);

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Permanently deletes a RateBasedRule. You can't delete a rule if it's still used in any WebACL objects or if it still includes any predicates, such as ByteMatchSet objects.

If you just want to remove a rule from a WebACL, use UpdateWebACL.

To permanently delete a RateBasedRule from AWS WAF, perform the following steps:

1. Update the RateBasedRule to remove predicates, if any. For more information, see UpdateRateBasedRule.

2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteRateBasedRule request.

3. Submit a DeleteRateBasedRule request.

Parameter Syntax

$result = $client->deleteRateBasedRule([
    'ChangeToken' => '<string>', // REQUIRED
    'RuleId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

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

Result Details

Errors

WAFStaleDataException:

The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.

WAFInternalErrorException:

The operation failed because of a system problem, even though the request was valid. Retry your request.

WAFInvalidAccountException:

The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.

WAFNonexistentItemException:

The operation failed because the referenced object doesn't exist.

WAFReferencedItemException:

The operation failed because you tried to delete an object that is still in use. For example:

• You tried to delete a ByteMatchSet that is still referenced by a Rule.

• You tried to delete a Rule that is still referenced by a WebACL.

WAFNonEmptyEntityException:

The operation failed because you tried to delete an object that isn't empty. For example:

• You tried to delete a WebACL that still contains one or more Rule objects.

• You tried to delete a Rule that still contains one or more ByteMatchSet objects or other predicates.

• You tried to delete a ByteMatchSet that contains one or more ByteMatchTuple objects.

• You tried to delete an IPSet that references one or more IP addresses.

WAFTagOperationException:

WAFTagOperationInternalErrorException:

DeleteRegexMatchSet

$result = $client->deleteRegexMatchSet([/* ... */]);
$promise = $client->deleteRegexMatchSetAsync([/* ... */]);

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Permanently deletes a RegexMatchSet. You can't delete a RegexMatchSet if it's still used in any Rules or if it still includes any RegexMatchTuples objects (any filters).

If you just want to remove a RegexMatchSet from a Rule, use UpdateRule.

To permanently delete a RegexMatchSet, perform the following steps:

1. Update the RegexMatchSet to remove filters, if any. For more information, see UpdateRegexMatchSet.

2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteRegexMatchSet request.

3. Submit a DeleteRegexMatchSet request.

Parameter Syntax

$result = $client->deleteRegexMatchSet([
    'ChangeToken' => '<string>', // REQUIRED
    'RegexMatchSetId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

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

Result Details

Errors

WAFInternalErrorException:

The operation failed because of a system problem, even though the request was valid. Retry your request.

WAFInvalidAccountException:

The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.

WAFNonexistentItemException:

The operation failed because the referenced object doesn't exist.

WAFReferencedItemException:

The operation failed because you tried to delete an object that is still in use. For example:

• You tried to delete a ByteMatchSet that is still referenced by a Rule.

• You tried to delete a Rule that is still referenced by a WebACL.

WAFStaleDataException:

The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.

WAFNonEmptyEntityException:

The operation failed because you tried to delete an object that isn't empty. For example:

• You tried to delete a WebACL that still contains one or more Rule objects.

• You tried to delete a Rule that still contains one or more ByteMatchSet objects or other predicates.

• You tried to delete a ByteMatchSet that contains one or more ByteMatchTuple objects.

• You tried to delete an IPSet that references one or more IP addresses.

DeleteRegexPatternSet

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

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Permanently deletes a RegexPatternSet. You can't delete a RegexPatternSet if it's still used in any RegexMatchSet or if the RegexPatternSet is not empty.

Parameter Syntax

$result = $client->deleteRegexPatternSet([
    'ChangeToken' => '<string>', // REQUIRED
    'RegexPatternSetId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

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

Result Details

Errors

WAFInternalErrorException:

The operation failed because of a system problem, even though the request was valid. Retry your request.

WAFInvalidAccountException:

The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.

WAFNonexistentItemException:

The operation failed because the referenced object doesn't exist.

WAFReferencedItemException:

The operation failed because you tried to delete an object that is still in use. For example:

• You tried to delete a ByteMatchSet that is still referenced by a Rule.

• You tried to delete a Rule that is still referenced by a WebACL.

WAFStaleDataException:

The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.

WAFNonEmptyEntityException:

The operation failed because you tried to delete an object that isn't empty. For example:

• You tried to delete a WebACL that still contains one or more Rule objects.

• You tried to delete a Rule that still contains one or more ByteMatchSet objects or other predicates.

• You tried to delete a ByteMatchSet that contains one or more ByteMatchTuple objects.

• You tried to delete an IPSet that references one or more IP addresses.

DeleteRule

$result = $client->deleteRule([/* ... */]);
$promise = $client->deleteRuleAsync([/* ... */]);

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Permanently deletes a Rule. You can't delete a Rule if it's still used in any WebACL objects or if it still includes any predicates, such as ByteMatchSet objects.

If you just want to remove a Rule from a WebACL, use UpdateWebACL.

To permanently delete a Rule from AWS WAF, perform the following steps:

1. Update the Rule to remove predicates, if any. For more information, see UpdateRule.

2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteRule request.

3. Submit a DeleteRule request.

Parameter Syntax

$result = $client->deleteRule([
    'ChangeToken' => '<string>', // REQUIRED
    'RuleId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

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

Result Details

Errors

WAFStaleDataException:

The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.

WAFInternalErrorException:

The operation failed because of a system problem, even though the request was valid. Retry your request.

WAFInvalidAccountException:

The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.

WAFNonexistentItemException:

The operation failed because the referenced object doesn't exist.

WAFReferencedItemException:

The operation failed because you tried to delete an object that is still in use. For example:

• You tried to delete a ByteMatchSet that is still referenced by a Rule.

• You tried to delete a Rule that is still referenced by a WebACL.

WAFNonEmptyEntityException:

The operation failed because you tried to delete an object that isn't empty. For example:

• You tried to delete a WebACL that still contains one or more Rule objects.

• You tried to delete a Rule that still contains one or more ByteMatchSet objects or other predicates.

• You tried to delete a ByteMatchSet that contains one or more ByteMatchTuple objects.

• You tried to delete an IPSet that references one or more IP addresses.

WAFTagOperationException:

WAFTagOperationInternalErrorException:

Examples

Example 1: To delete a rule

The following example deletes a rule with the ID WAFRule-1-Example.

$result = $client->deleteRule([
    'ChangeToken' => 'abcd12f2-46da-4fdb-b8d5-fbd4c466928f',
    'RuleId' => 'WAFRule-1-Example',
]);

Result syntax:

[
    'ChangeToken' => 'abcd12f2-46da-4fdb-b8d5-fbd4c466928f',
]

DeleteRuleGroup

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

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Permanently deletes a RuleGroup. You can't delete a RuleGroup if it's still used in any WebACL objects or if it still includes any rules.

If you just want to remove a RuleGroup from a WebACL, use UpdateWebACL.

To permanently delete a RuleGroup from AWS WAF, perform the following steps:

1. Update the RuleGroup to remove rules, if any. For more information, see UpdateRuleGroup.

2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteRuleGroup request.

3. Submit a DeleteRuleGroup request.

Parameter Syntax

$result = $client->deleteRuleGroup([
    'ChangeToken' => '<string>', // REQUIRED
    'RuleGroupId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

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

Result Details

Errors

WAFStaleDataException:

The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.

WAFInternalErrorException:

The operation failed because of a system problem, even though the request was valid. Retry your request.

WAFNonexistentItemException:

The operation failed because the referenced object doesn't exist.

WAFReferencedItemException:

The operation failed because you tried to delete an object that is still in use. For example:

• You tried to delete a ByteMatchSet that is still referenced by a Rule.

• You tried to delete a Rule that is still referenced by a WebACL.

WAFNonEmptyEntityException:

The operation failed because you tried to delete an object that isn't empty. For example:

• You tried to delete a WebACL that still contains one or more Rule objects.

• You tried to delete a Rule that still contains one or more ByteMatchSet objects or other predicates.

• You tried to delete a ByteMatchSet that contains one or more ByteMatchTuple objects.

• You tried to delete an IPSet that references one or more IP addresses.

WAFInvalidOperationException:

The operation failed because there was nothing to do. For example:

• You tried to remove a Rule from a WebACL, but the Rule isn't in the specified WebACL.

• You tried to remove an IP address from an IPSet, but the IP address isn't in the specified IPSet.

• You tried to remove a ByteMatchTuple from a ByteMatchSet, but the ByteMatchTuple isn't in the specified WebACL.

• You tried to add a Rule to a WebACL, but the Rule already exists in the specified WebACL.

• You tried to add a ByteMatchTuple to a ByteMatchSet, but the ByteMatchTuple already exists in the specified WebACL.

WAFTagOperationException:

WAFTagOperationInternalErrorException:

DeleteSizeConstraintSet

$result = $client->deleteSizeConstraintSet([/* ... */]);
$promise = $client->deleteSizeConstraintSetAsync([/* ... */]);

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Permanently deletes a SizeConstraintSet. You can't delete a SizeConstraintSet if it's still used in any Rules or if it still includes any SizeConstraint objects (any filters).

If you just want to remove a SizeConstraintSet from a Rule, use UpdateRule.

To permanently delete a SizeConstraintSet, perform the following steps:

1. Update the SizeConstraintSet to remove filters, if any. For more information, see UpdateSizeConstraintSet.

2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteSizeConstraintSet request.

3. Submit a DeleteSizeConstraintSet request.

Parameter Syntax

$result = $client->deleteSizeConstraintSet([
    'ChangeToken' => '<string>', // REQUIRED
    'SizeConstraintSetId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

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

Result Details

Errors

WAFStaleDataException:

The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.

WAFInternalErrorException:

The operation failed because of a system problem, even though the request was valid. Retry your request.

WAFInvalidAccountException:

The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.

WAFNonexistentItemException:

The operation failed because the referenced object doesn't exist.

WAFReferencedItemException:

The operation failed because you tried to delete an object that is still in use. For example:

• You tried to delete a ByteMatchSet that is still referenced by a Rule.

• You tried to delete a Rule that is still referenced by a WebACL.

WAFNonEmptyEntityException:

The operation failed because you tried to delete an object that isn't empty. For example:

• You tried to delete a WebACL that still contains one or more Rule objects.

• You tried to delete a Rule that still contains one or more ByteMatchSet objects or other predicates.

• You tried to delete a ByteMatchSet that contains one or more ByteMatchTuple objects.

• You tried to delete an IPSet that references one or more IP addresses.

Examples

Example 1: To delete a size constraint set

The following example deletes a size constraint set with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.

$result = $client->deleteSizeConstraintSet([
    'ChangeToken' => 'abcd12f2-46da-4fdb-b8d5-fbd4c466928f',
    'SizeConstraintSetId' => 'example1ds3t-46da-4fdb-b8d5-abc321j569j5',
]);

Result syntax:

[
    'ChangeToken' => 'abcd12f2-46da-4fdb-b8d5-fbd4c466928f',
]

DeleteSqlInjectionMatchSet

$result = $client->deleteSqlInjectionMatchSet([/* ... */]);
$promise = $client->deleteSqlInjectionMatchSetAsync([/* ... */]);

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Permanently deletes a SqlInjectionMatchSet. You can't delete a SqlInjectionMatchSet if it's still used in any Rules or if it still contains any SqlInjectionMatchTuple objects.

If you just want to remove a SqlInjectionMatchSet from a Rule, use UpdateRule.

To permanently delete a SqlInjectionMatchSet from AWS WAF, perform the following steps:

1. Update the SqlInjectionMatchSet to remove filters, if any. For more information, see UpdateSqlInjectionMatchSet.

2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteSqlInjectionMatchSet request.

3. Submit a DeleteSqlInjectionMatchSet request.

Parameter Syntax

$result = $client->deleteSqlInjectionMatchSet([
    'ChangeToken' => '<string>', // REQUIRED
    'SqlInjectionMatchSetId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

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

Result Details

Errors

WAFInternalErrorException:

The operation failed because of a system problem, even though the request was valid. Retry your request.

WAFInvalidAccountException:

The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.

WAFNonexistentItemException:

The operation failed because the referenced object doesn't exist.

WAFReferencedItemException:

The operation failed because you tried to delete an object that is still in use. For example:

• You tried to delete a ByteMatchSet that is still referenced by a Rule.

• You tried to delete a Rule that is still referenced by a WebACL.

WAFStaleDataException:

The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.

WAFNonEmptyEntityException:

The operation failed because you tried to delete an object that isn't empty. For example:

• You tried to delete a WebACL that still contains one or more Rule objects.

• You tried to delete a Rule that still contains one or more ByteMatchSet objects or other predicates.

• You tried to delete a ByteMatchSet that contains one or more ByteMatchTuple objects.

• You tried to delete an IPSet that references one or more IP addresses.

Examples

Example 1: To delete a SQL injection match set

The following example deletes a SQL injection match set with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.

$result = $client->deleteSqlInjectionMatchSet([
    'ChangeToken' => 'abcd12f2-46da-4fdb-b8d5-fbd4c466928f',
    'SqlInjectionMatchSetId' => 'example1ds3t-46da-4fdb-b8d5-abc321j569j5',
]);

Result syntax:

[
    'ChangeToken' => 'abcd12f2-46da-4fdb-b8d5-fbd4c466928f',
]

DeleteWebACL

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

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Permanently deletes a WebACL. You can't delete a WebACL if it still contains any Rules.

To delete a WebACL, perform the following steps:

1. Update the WebACL to remove Rules, if any. For more information, see UpdateWebACL.

2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteWebACL request.

3. Submit a DeleteWebACL request.

Parameter Syntax

$result = $client->deleteWebACL([
    'ChangeToken' => '<string>', // REQUIRED
    'WebACLId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

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

Result Details

Errors

WAFStaleDataException:

The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.

WAFInternalErrorException:

The operation failed because of a system problem, even though the request was valid. Retry your request.

WAFInvalidAccountException:

The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.

WAFNonexistentItemException:

The operation failed because the referenced object doesn't exist.

WAFReferencedItemException:

The operation failed because you tried to delete an object that is still in use. For example:

• You tried to delete a ByteMatchSet that is still referenced by a Rule.

• You tried to delete a Rule that is still referenced by a WebACL.

WAFNonEmptyEntityException:

The operation failed because you tried to delete an object that isn't empty. For example:

• You tried to delete a WebACL that still contains one or more Rule objects.

• You tried to delete a Rule that still contains one or more ByteMatchSet objects or other predicates.

• You tried to delete a ByteMatchSet that contains one or more ByteMatchTuple objects.

• You tried to delete an IPSet that references one or more IP addresses.

WAFTagOperationException:

WAFTagOperationInternalErrorException:

Examples

Example 1: To delete a web ACL

The following example deletes a web ACL with the ID example-46da-4444-5555-example.

$result = $client->deleteWebACL([
    'ChangeToken' => 'abcd12f2-46da-4fdb-b8d5-fbd4c466928f',
    'WebACLId' => 'example-46da-4444-5555-example',
]);

Result syntax:

[
    'ChangeToken' => 'abcd12f2-46da-4fdb-b8d5-fbd4c466928f',
]

DeleteXssMatchSet

$result = $client->deleteXssMatchSet([/* ... */]);
$promise = $client->deleteXssMatchSetAsync([/* ... */]);

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Permanently deletes an XssMatchSet. You can't delete an XssMatchSet if it's still used in any Rules or if it still contains any XssMatchTuple objects.

If you just want to remove an XssMatchSet from a Rule, use UpdateRule.

To permanently delete an XssMatchSet from AWS WAF, perform the following steps:

1. Update the XssMatchSet to remove filters, if any. For more information, see UpdateXssMatchSet.

2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteXssMatchSet request.

3. Submit a DeleteXssMatchSet request.

Parameter Syntax

$result = $client->deleteXssMatchSet([
    'ChangeToken' => '<string>', // REQUIRED
    'XssMatchSetId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

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

Result Details

Errors

WAFInternalErrorException:

The operation failed because of a system problem, even though the request was valid. Retry your request.

WAFInvalidAccountException:

The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.

WAFNonexistentItemException:

The operation failed because the referenced object doesn't exist.

WAFReferencedItemException:

The operation failed because you tried to delete an object that is still in use. For example:

• You tried to delete a ByteMatchSet that is still referenced by a Rule.

• You tried to delete a Rule that is still referenced by a WebACL.

WAFStaleDataException:

The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.

WAFNonEmptyEntityException:

The operation failed because you tried to delete an object that isn't empty. For example:

• You tried to delete a WebACL that still contains one or more Rule objects.

• You tried to delete a Rule that still contains one or more ByteMatchSet objects or other predicates.

• You tried to delete a ByteMatchSet that contains one or more ByteMatchTuple objects.

• You tried to delete an IPSet that references one or more IP addresses.

Examples

Example 1: To delete an XSS match set

The following example deletes an XSS match set with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.

$result = $client->deleteXssMatchSet([
    'ChangeToken' => 'abcd12f2-46da-4fdb-b8d5-fbd4c466928f',
    'XssMatchSetId' => 'example1ds3t-46da-4fdb-b8d5-abc321j569j5',
]);

Result syntax:

[
    'ChangeToken' => 'abcd12f2-46da-4fdb-b8d5-fbd4c466928f',
]

DisassociateWebACL

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

This is AWS WAF Classic Regional documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Removes a web ACL from the specified resource, either an application load balancer or Amazon API Gateway stage.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

WAFInternalErrorException:

The operation failed because of a system problem, even though the request was valid. Retry your request.

WAFInvalidAccountException:

The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.

WAFInvalidParameterException:

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

• You specified an invalid parameter name.

• You specified an invalid value.

• You tried to update an object (ByteMatchSet, IPSet, Rule, or WebACL) using an action other than INSERT or DELETE.

• You tried to create a WebACL with a DefaultAction Type other than ALLOW, BLOCK, or COUNT.

• You tried to create a RateBasedRule with a RateKey value other than IP.

• You tried to update a WebACL with a WafAction Type other than ALLOW, BLOCK, or COUNT.

• You tried to update a ByteMatchSet with a FieldToMatch Type other than HEADER, METHOD, QUERY_STRING, URI, or BODY.

• You tried to update a ByteMatchSet with a Field of HEADER but no value for Data.

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

WAFNonexistentItemException:

The operation failed because the referenced object doesn't exist.

GetByteMatchSet

$result = $client->getByteMatchSet([/* ... */]);
$promise = $client->getByteMatchSetAsync([/* ... */]);

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Returns the ByteMatchSet specified by ByteMatchSetId.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'ByteMatchSet' => [
        'ByteMatchSetId' => '<string>',
        'ByteMatchTuples' => [
            [
                'FieldToMatch' => [
                    'Data' => '<string>',
                    'Type' => 'URI|QUERY_STRING|HEADER|METHOD|BODY|SINGLE_QUERY_ARG|ALL_QUERY_ARGS',
                ],
                'PositionalConstraint' => 'EXACTLY|STARTS_WITH|ENDS_WITH|CONTAINS|CONTAINS_WORD',
                'TargetString' => <string || resource || Psr\Http\Message\StreamInterface>,
                'TextTransformation' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE',
            ],
            // ...
        ],
        'Name' => '<string>',
    ],
]

Result Details

Errors

WAFInternalErrorException:

The operation failed because of a system problem, even though the request was valid. Retry your request.

WAFInvalidAccountException:

The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.

WAFNonexistentItemException:

The operation failed because the referenced object doesn't exist.

Examples

Example 1: To get a byte match set

The following example returns the details of a byte match set with the ID exampleIDs3t-46da-4fdb-b8d5-abc321j569j5.

$result = $client->getByteMatchSet([
    'ByteMatchSetId' => 'exampleIDs3t-46da-4fdb-b8d5-abc321j569j5',
]);

Result syntax:

[
    'ByteMatchSet' => [
        'ByteMatchSetId' => 'exampleIDs3t-46da-4fdb-b8d5-abc321j569j5',
        'ByteMatchTuples' => [
            [
                'FieldToMatch' => [
                    'Data' => 'referer',
                    'Type' => 'HEADER',
                ],
                'PositionalConstraint' => 'CONTAINS',
                'TargetString' => <BLOB>,
                'TextTransformation' => 'NONE',
            ],
        ],
        'Name' => 'ByteMatchNameExample',
    ],
]

GetChangeToken

$result = $client->getChangeToken([/* ... */]);
$promise = $client->getChangeTokenAsync([/* ... */]);

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

When you want to create, update, or delete AWS WAF objects, get a change token and include the change token in the create, update, or delete request. Change tokens ensure that your application doesn't submit conflicting requests to AWS WAF.

Each create, update, or delete request must use a unique change token. If your application submits a GetChangeToken request and then submits a second GetChangeToken request before submitting a create, update, or delete request, the second GetChangeToken request returns the same value as the first GetChangeToken request.

When you use a change token in a create, update, or delete request, the status of the change token changes to PENDING, which indicates that AWS WAF is propagating the change to all AWS WAF servers. Use GetChangeTokenStatus to determine the status of your change token.

Parameter Syntax

$result = $client->getChangeToken([
]);

Parameter Details

Result Syntax

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

Result Details

Errors

WAFInternalErrorException:

The operation failed because of a system problem, even though the request was valid. Retry your request.

Examples

Example 1: To get a change token

The following example returns a change token to use for a create, update or delete operation.

$result = $client->getChangeToken([
]);

Result syntax:

[
    'ChangeToken' => 'abcd12f2-46da-4fdb-b8d5-fbd4c466928f',
]

GetChangeTokenStatus

$result = $client->getChangeTokenStatus([/* ... */]);
$promise = $client->getChangeTokenStatusAsync([/* ... */]);

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Returns the status of a ChangeToken that you got by calling GetChangeToken. ChangeTokenStatus is one of the following values:

• PROVISIONED: You requested the change token by calling GetChangeToken, but you haven't used it yet in a call to create, update, or delete an AWS WAF object.

• PENDING: AWS WAF is propagating the create, update, or delete request to all AWS WAF servers.

• INSYNC: Propagation is complete.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'ChangeTokenStatus' => 'PROVISIONED|PENDING|INSYNC',
]

Result Details

Errors

WAFNonexistentItemException:

The operation failed because the referenced object doesn't exist.

WAFInternalErrorException:

The operation failed because of a system problem, even though the request was valid. Retry your request.

Examples

Example 1: To get the change token status

The following example returns the status of a change token with the ID abcd12f2-46da-4fdb-b8d5-fbd4c466928f.

$result = $client->getChangeTokenStatus([
    'ChangeToken' => 'abcd12f2-46da-4fdb-b8d5-fbd4c466928f',
]);

Result syntax:

[
    'ChangeTokenStatus' => 'PENDING',
]

GetGeoMatchSet

$result = $client->getGeoMatchSet([/* ... */]);
$promise = $client->getGeoMatchSetAsync([/* ... */]);

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Returns the GeoMatchSet that is specified by GeoMatchSetId.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'GeoMatchSet' => [
        'GeoMatchConstraints' => [
            [
                'Type' => 'Country',
                'Value' => 'AF|AX|AL|DZ|AS|AD|AO|AI|AQ|AG|AR|AM|AW|AU|AT|AZ|BS|BH|BD|BB|BY|BE|BZ|BJ|BM|BT|BO|BQ|BA|BW|BV|BR|IO|BN|BG|BF|BI|KH|CM|CA|CV|KY|CF|TD|CL|CN|CX|CC|CO|KM|CG|CD|CK|CR|CI|HR|CU|CW|CY|CZ|DK|DJ|DM|DO|EC|EG|SV|GQ|ER|EE|ET|FK|FO|FJ|FI|FR|GF|PF|TF|GA|GM|GE|DE|GH|GI|GR|GL|GD|GP|GU|GT|GG|GN|GW|GY|HT|HM|VA|HN|HK|HU|IS|IN|ID|IR|IQ|IE|IM|IL|IT|JM|JP|JE|JO|KZ|KE|KI|KP|KR|KW|KG|LA|LV|LB|LS|LR|LY|LI|LT|LU|MO|MK|MG|MW|MY|MV|ML|MT|MH|MQ|MR|MU|YT|MX|FM|MD|MC|MN|ME|MS|MA|MZ|MM|NA|NR|NP|NL|NC|NZ|NI|NE|NG|NU|NF|MP|NO|OM|PK|PW|PS|PA|PG|PY|PE|PH|PN|PL|PT|PR|QA|RE|RO|RU|RW|BL|SH|KN|LC|MF|PM|VC|WS|SM|ST|SA|SN|RS|SC|SL|SG|SX|SK|SI|SB|SO|ZA|GS|SS|ES|LK|SD|SR|SJ|SZ|SE|CH|SY|TW|TJ|TZ|TH|TL|TG|TK|TO|TT|TN|TR|TM|TC|TV|UG|UA|AE|GB|US|UM|UY|UZ|VU|VE|VN|VG|VI|WF|EH|YE|ZM|ZW',
            ],
            // ...
        ],
        'GeoMatchSetId' => '<string>',
        'Name' => '<string>',
    ],
]

Result Details

Errors

WAFInternalErrorException:

The operation failed because of a system problem, even though the request was valid. Retry your request.

WAFInvalidAccountException:

The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.

WAFNonexistentItemException:

The operation failed because the referenced object doesn't exist.

GetIPSet

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

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Returns the IPSet that is specified by IPSetId.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'IPSet' => [
        'IPSetDescriptors' => [
            [
                'Type' => 'IPV4|IPV6',
                'Value' => '<string>',
            ],
            // ...
        ],
        'IPSetId' => '<string>',
        'Name' => '<string>',
    ],
]

Result Details

Errors

WAFInternalErrorException:

The operation failed because of a system problem, even though the request was valid. Retry your request.

WAFInvalidAccountException:

The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.

WAFNonexistentItemException:

The operation failed because the referenced object doesn't exist.

Examples

Example 1: To get an IP set

The following example returns the details of an IP match set with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.

$result = $client->getIPSet([
    'IPSetId' => 'example1ds3t-46da-4fdb-b8d5-abc321j569j5',
]);

Result syntax:

[
    'IPSet' => [
        'IPSetDescriptors' => [
            [
                'Type' => 'IPV4',
                'Value' => '192.0.2.44/32',
            ],
        ],
        'IPSetId' => 'example1ds3t-46da-4fdb-b8d5-abc321j569j5',
        'Name' => 'MyIPSetFriendlyName',
    ],
]

GetLoggingConfiguration

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

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Returns the LoggingConfiguration for the specified web ACL.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'LoggingConfiguration' => [
        'LogDestinationConfigs' => ['<string>', ...],
        'RedactedFields' => [
            [
                'Data' => '<string>',
                'Type' => 'URI|QUERY_STRING|HEADER|METHOD|BODY|SINGLE_QUERY_ARG|ALL_QUERY_ARGS',
            ],
            // ...
        ],
        'ResourceArn' => '<string>',
    ],
]

Result Details

Errors

WAFInternalErrorException:

The operation failed because of a system problem, even though the request was valid. Retry your request.

WAFNonexistentItemException:

The operation failed because the referenced object doesn't exist.

GetPermissionPolicy

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

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Returns the IAM policy attached to the RuleGroup.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

WAFInternalErrorException:

The operation failed because of a system problem, even though the request was valid. Retry your request.

WAFNonexistentItemException:

The operation failed because the referenced object doesn't exist.

GetRateBasedRule

$result = $client->getRateBasedRule([/* ... */]);
$promise = $client->getRateBasedRuleAsync([/* ... */]);

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Returns the RateBasedRule that is specified by the RuleId that you included in the GetRateBasedRule request.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'Rule' => [
        'MatchPredicates' => [
            [
                'DataId' => '<string>',
                'Negated' => true || false,
                'Type' => 'IPMatch|ByteMatch|SqlInjectionMatch|GeoMatch|SizeConstraint|XssMatch|RegexMatch',
            ],
            // ...
        ],
        'MetricName' => '<string>',
        'Name' => '<string>',
        'RateKey' => 'IP',
        'RateLimit' => <integer>,
        'RuleId' => '<string>',
    ],
]

Result Details

Errors

WAFInternalErrorException:

The operation failed because of a system problem, even though the request was valid. Retry your request.

WAFInvalidAccountException:

The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.

WAFNonexistentItemException:

The operation failed because the referenced object doesn't exist.

GetRateBasedRuleManagedKeys

$result = $client->getRateBasedRuleManagedKeys([/* ... */]);
$promise = $client->getRateBasedRuleManagedKeysAsync([/* ... */]);

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Returns an array of IP addresses currently being blocked by the RateBasedRule that is specified by the RuleId. The maximum number of managed keys that will be blocked is 10,000. If more than 10,000 addresses exceed the rate limit, the 10,000 addresses with the highest rates will be blocked.

Parameter Syntax

$result = $client->getRateBasedRuleManagedKeys([
    'NextMarker' => '<string>',
    'RuleId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ManagedKeys' => ['<string>', ...],
    'NextMarker' => '<string>',
]

Result Details

Errors

WAFInternalErrorException:

The operation failed because of a system problem, even though the request was valid. Retry your request.

WAFInvalidAccountException:

The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.

WAFNonexistentItemException:

The operation failed because the referenced object 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.

• You specified an invalid value.

• You tried to update an object (ByteMatchSet, IPSet, Rule, or WebACL) using an action other than INSERT or DELETE.

• You tried to create a WebACL with a DefaultAction Type other than ALLOW, BLOCK, or COUNT.

• You tried to create a RateBasedRule with a RateKey value other than IP.

• You tried to update a WebACL with a WafAction Type other than ALLOW, BLOCK, or COUNT.

• You tried to update a ByteMatchSet with a FieldToMatch Type other than HEADER, METHOD, QUERY_STRING, URI, or BODY.

• You tried to update a ByteMatchSet with a Field of HEADER but no value for Data.

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

GetRegexMatchSet

$result = $client->getRegexMatchSet([/* ... */]);
$promise = $client->getRegexMatchSetAsync([/* ... */]);

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Returns the RegexMatchSet specified by RegexMatchSetId.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'RegexMatchSet' => [
        'Name' => '<string>',
        'RegexMatchSetId' => '<string>',
        'RegexMatchTuples' => [
            [
                'FieldToMatch' => [
                    'Data' => '<string>',
                    'Type' => 'URI|QUERY_STRING|HEADER|METHOD|BODY|SINGLE_QUERY_ARG|ALL_QUERY_ARGS',
                ],
                'RegexPatternSetId' => '<string>',
                'TextTransformation' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE',
            ],
            // ...
        ],
    ],
]

Result Details

Errors

WAFInternalErrorException:

The operation failed because of a system problem, even though the request was valid. Retry your request.

WAFInvalidAccountException:

The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.

WAFNonexistentItemException:

The operation failed because the referenced object doesn't exist.

GetRegexPatternSet

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

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Returns the RegexPatternSet specified by RegexPatternSetId.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'RegexPatternSet' => [
        'Name' => '<string>',
        'RegexPatternSetId' => '<string>',
        'RegexPatternStrings' => ['<string>', ...],
    ],
]

Result Details

Errors

WAFInternalErrorException:

The operation failed because of a system problem, even though the request was valid. Retry your request.

WAFInvalidAccountException:

The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.

WAFNonexistentItemException:

The operation failed because the referenced object doesn't exist.

GetRule

$result = $client->getRule([/* ... */]);
$promise = $client->getRuleAsync([/* ... */]);

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Returns the Rule that is specified by the RuleId that you included in the GetRule request.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'Rule' => [
        'MetricName' => '<string>',
        'Name' => '<string>',
        'Predicates' => [
            [
                'DataId' => '<string>',
                'Negated' => true || false,
                'Type' => 'IPMatch|ByteMatch|SqlInjectionMatch|GeoMatch|SizeConstraint|XssMatch|RegexMatch',
            ],
            // ...
        ],
        'RuleId' => '<string>',
    ],
]

Result Details

Errors

WAFInternalErrorException:

The operation failed because of a system problem, even though the request was valid. Retry your request.

WAFInvalidAccountException:

The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.

WAFNonexistentItemException:

The operation failed because the referenced object doesn't exist.

Examples

Example 1: To get a rule

The following example returns the details of a rule with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.

$result = $client->getRule([
    'RuleId' => 'example1ds3t-46da-4fdb-b8d5-abc321j569j5',
]);

Result syntax:

[
    'Rule' => [
        'MetricName' => 'WAFByteHeaderRule',
        'Name' => 'WAFByteHeaderRule',
        'Predicates' => [
            [
                'DataId' => 'MyByteMatchSetID',
                'Negated' => ,
                'Type' => 'ByteMatch',
            ],
        ],
        'RuleId' => 'example1ds3t-46da-4fdb-b8d5-abc321j569j5',
    ],
]

GetRuleGroup

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

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Returns the RuleGroup that is specified by the RuleGroupId that you included in the GetRuleGroup request.

To view the rules in a rule group, use ListActivatedRulesInRuleGroup.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'RuleGroup' => [
        'MetricName' => '<string>',
        'Name' => '<string>',
        'RuleGroupId' => '<string>',
    ],
]

Result Details

Errors

WAFInternalErrorException:

The operation failed because of a system problem, even though the request was valid. Retry your request.

WAFNonexistentItemException:

The operation failed because the referenced object doesn't exist.

GetSampledRequests

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

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Gets detailed information about a specified number of requests--a sample--that AWS WAF randomly selects from among the first 5,000 requests that your AWS resource received during a time range that you choose. You can specify a sample size of up to 500 requests, and you can specify any time range in the previous three hours.

GetSampledRequests returns a time range, which is usually the time range that you specified. However, if your resource (such as a CloudFront distribution) received 5,000 requests before the specified time range elapsed, GetSampledRequests returns an updated time range. This new time range indicates the actual period during which AWS WAF selected the requests in the sample.

Parameter Syntax

$result = $client->getSampledRequests([
    'MaxItems' => <integer>, // REQUIRED
    'RuleId' => '<string>', // REQUIRED
    'TimeWindow' => [ // REQUIRED
        'EndTime' => <integer || string || DateTime>, // REQUIRED
        'StartTime' => <integer || string || DateTime>, // REQUIRED
    ],
    'WebAclId' => '<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>',
            ],
            'RuleWithinRuleGroup' => '<string>',
            'Timestamp' => <DateTime>,
            'Weight' => <integer>,
        ],
        // ...
    ],
    'TimeWindow' => [
        'EndTime' => <DateTime>,
        'StartTime' => <DateTime>,
    ],
]

Result Details

Errors

WAFNonexistentItemException:

The operation failed because the referenced object doesn't exist.

WAFInternalErrorException:

The operation failed because of a system problem, even though the request was valid. Retry your request.

Examples

Example 1: To get a sampled requests

The following example returns detailed information about 100 requests --a sample-- that AWS WAF randomly selects from among the first 5,000 requests that your AWS resource received between the time period 2016-09-27T15:50Z to 2016-09-27T15:50Z.

$result = $client->getSampledRequests([
    'MaxItems' => 100,
    'RuleId' => 'WAFRule-1-Example',
    'TimeWindow' => [
        'EndTime' => ,
        'StartTime' => ,
    ],
    'WebAclId' => 'createwebacl-1472061481310',
]);

Result syntax:

[
    'PopulationSize' => 50,
    'SampledRequests' => [
        [
            'Action' => 'BLOCK',
            'Request' => [
                'ClientIP' => '192.0.2.44',
                'Country' => 'US',
                'HTTPVersion' => 'HTTP/1.1',
                'Headers' => [
                    [
                        'Name' => 'User-Agent',
                        'Value' => 'BadBot ',
                    ],
                ],
                'Method' => 'HEAD',
            ],
            'Timestamp' => ,
            'Weight' => 1,
        ],
    ],
    'TimeWindow' => [
        'EndTime' => ,
        'StartTime' => ,
    ],
]

GetSizeConstraintSet

$result = $client->getSizeConstraintSet([/* ... */]);
$promise = $client->getSizeConstraintSetAsync([/* ... */]);

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Returns the SizeConstraintSet specified by SizeConstraintSetId.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'SizeConstraintSet' => [
        'Name' => '<string>',
        'SizeConstraintSetId' => '<string>',
        'SizeConstraints' => [
            [
                'ComparisonOperator' => 'EQ|NE|LE|LT|GE|GT',
                'FieldToMatch' => [
                    'Data' => '<string>',
                    'Type' => 'URI|QUERY_STRING|HEADER|METHOD|BODY|SINGLE_QUERY_ARG|ALL_QUERY_ARGS',
                ],
                'Size' => <integer>,
                'TextTransformation' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE',
            ],
            // ...
        ],
    ],
]

Result Details

Errors

WAFInternalErrorException:

The operation failed because of a system problem, even though the request was valid. Retry your request.

WAFInvalidAccountException:

The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.

WAFNonexistentItemException:

The operation failed because the referenced object doesn't exist.

Examples

Example 1: To get a size constraint set

The following example returns the details of a size constraint match set with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.

$result = $client->getSizeConstraintSet([
    'SizeConstraintSetId' => 'example1ds3t-46da-4fdb-b8d5-abc321j569j5',
]);

Result syntax:

[
    'SizeConstraintSet' => [
        'Name' => 'MySampleSizeConstraintSet',
        'SizeConstraintSetId' => 'example1ds3t-46da-4fdb-b8d5-abc321j569j5',
        'SizeConstraints' => [
            [
                'ComparisonOperator' => 'GT',
                'FieldToMatch' => [
                    'Type' => 'QUERY_STRING',
                ],
                'Size' => 0,
                'TextTransformation' => 'NONE',
            ],
        ],
    ],
]

GetSqlInjectionMatchSet

$result = $client->getSqlInjectionMatchSet([/* ... */]);
$promise = $client->getSqlInjectionMatchSetAsync([/* ... */]);

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Returns the SqlInjectionMatchSet that is specified by SqlInjectionMatchSetId.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'SqlInjectionMatchSet' => [
        'Name' => '<string>',
        'SqlInjectionMatchSetId' => '<string>',
        'SqlInjectionMatchTuples' => [
            [
                'FieldToMatch' => [
                    'Data' => '<string>',
                    'Type' => 'URI|QUERY_STRING|HEADER|METHOD|BODY|SINGLE_QUERY_ARG|ALL_QUERY_ARGS',
                ],
                'TextTransformation' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE',
            ],
            // ...
        ],
    ],
]

Result Details

Errors

WAFInternalErrorException:

The operation failed because of a system problem, even though the request was valid. Retry your request.

WAFInvalidAccountException:

The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.

WAFNonexistentItemException:

The operation failed because the referenced object doesn't exist.

Examples

Example 1: To get a SQL injection match set

The following example returns the details of a SQL injection match set with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.

$result = $client->getSqlInjectionMatchSet([
    'SqlInjectionMatchSetId' => 'example1ds3t-46da-4fdb-b8d5-abc321j569j5',
]);

Result syntax:

[
    'SqlInjectionMatchSet' => [
        'Name' => 'MySQLInjectionMatchSet',
        'SqlInjectionMatchSetId' => 'example1ds3t-46da-4fdb-b8d5-abc321j569j5',
        'SqlInjectionMatchTuples' => [
            [
                'FieldToMatch' => [
                    'Type' => 'QUERY_STRING',
                ],
                'TextTransformation' => 'URL_DECODE',
            ],
        ],
    ],
]

GetWebACL

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

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Returns the WebACL that is specified by WebACLId.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'WebACL' => [
        'DefaultAction' => [
            'Type' => 'BLOCK|ALLOW|COUNT',
        ],
        'MetricName' => '<string>',
        'Name' => '<string>',
        'Rules' => [
            [
                'Action' => [
                    'Type' => 'BLOCK|ALLOW|COUNT',
                ],
                'ExcludedRules' => [
                    [
                        'RuleId' => '<string>',
                    ],
                    // ...
                ],
                'OverrideAction' => [
                    'Type' => 'NONE|COUNT',
                ],
                'Priority' => <integer>,
                'RuleId' => '<string>',
                'Type' => 'REGULAR|RATE_BASED|GROUP',
            ],
            // ...
        ],
        'WebACLArn' => '<string>',
        'WebACLId' => '<string>',
    ],
]

Result Details

Errors

WAFInternalErrorException:

The operation failed because of a system problem, even though the request was valid. Retry your request.

WAFInvalidAccountException:

The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.

WAFNonexistentItemException:

The operation failed because the referenced object doesn't exist.

Examples

Example 1: To get a web ACL

The following example returns the details of a web ACL with the ID createwebacl-1472061481310.

$result = $client->getWebACL([
    'WebACLId' => 'createwebacl-1472061481310',
]);

Result syntax:

[
    'WebACL' => [
        'DefaultAction' => [
            'Type' => 'ALLOW',
        ],
        'MetricName' => 'CreateExample',
        'Name' => 'CreateExample',
        'Rules' => [
            [
                'Action' => [
                    'Type' => 'ALLOW',
                ],
                'Priority' => 1,
                'RuleId' => 'WAFRule-1-Example',
            ],
        ],
        'WebACLId' => 'createwebacl-1472061481310',
    ],
]

GetWebACLForResource

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

This is AWS WAF Classic Regional documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Returns the web ACL for the specified resource, either an application load balancer or Amazon API Gateway stage.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'WebACLSummary' => [
        'Name' => '<string>',
        'WebACLId' => '<string>',
    ],
]

Result Details

Errors

WAFInternalErrorException:

The operation failed because of a system problem, even though the request was valid. Retry your request.

WAFInvalidAccountException:

The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.

WAFNonexistentItemException:

The operation failed because the referenced object 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.

• You specified an invalid value.

• You tried to update an object (ByteMatchSet, IPSet, Rule, or WebACL) using an action other than INSERT or DELETE.

• You tried to create a WebACL with a DefaultAction Type other than ALLOW, BLOCK, or COUNT.

• You tried to create a RateBasedRule with a RateKey value other than IP.

• You tried to update a WebACL with a WafAction Type other than ALLOW, BLOCK, or COUNT.

• You tried to update a ByteMatchSet with a FieldToMatch Type other than HEADER, METHOD, QUERY_STRING, URI, or BODY.

• You tried to update a ByteMatchSet with a Field of HEADER but no value for Data.

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

WAFUnavailableEntityException:

The operation failed because the entity referenced is temporarily unavailable. Retry your request.

GetXssMatchSet

$result = $client->getXssMatchSet([/* ... */]);
$promise = $client->getXssMatchSetAsync([/* ... */]);

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Returns the XssMatchSet that is specified by XssMatchSetId.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'XssMatchSet' => [
        'Name' => '<string>',
        'XssMatchSetId' => '<string>',
        'XssMatchTuples' => [
            [
                'FieldToMatch' => [
                    'Data' => '<string>',
                    'Type' => 'URI|QUERY_STRING|HEADER|METHOD|BODY|SINGLE_QUERY_ARG|ALL_QUERY_ARGS',
                ],
                'TextTransformation' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE',
            ],
            // ...
        ],
    ],
]

Result Details

Errors

WAFInternalErrorException:

The operation failed because of a system problem, even though the request was valid. Retry your request.

WAFInvalidAccountException:

The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.

WAFNonexistentItemException:

The operation failed because the referenced object doesn't exist.

Examples

Example 1: To get an XSS match set

The following example returns the details of an XSS match set with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.

$result = $client->getXssMatchSet([
    'XssMatchSetId' => 'example1ds3t-46da-4fdb-b8d5-abc321j569j5',
]);

Result syntax:

[
    'XssMatchSet' => [
        'Name' => 'MySampleXssMatchSet',
        'XssMatchSetId' => 'example1ds3t-46da-4fdb-b8d5-abc321j569j5',
        'XssMatchTuples' => [
            [
                'FieldToMatch' => [
                    'Type' => 'QUERY_STRING',
                ],
                'TextTransformation' => 'URL_DECODE',
            ],
        ],
    ],
]

ListActivatedRulesInRuleGroup

$result = $client->listActivatedRulesInRuleGroup([/* ... */]);
$promise = $client->listActivatedRulesInRuleGroupAsync([/* ... */]);

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Returns an array of ActivatedRule objects.

Parameter Syntax

$result = $client->listActivatedRulesInRuleGroup([
    'Limit' => <integer>,
    'NextMarker' => '<string>',
    'RuleGroupId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'ActivatedRules' => [
        [
            'Action' => [
                'Type' => 'BLOCK|ALLOW|COUNT',
            ],
            'ExcludedRules' => [
                [
                    'RuleId' => '<string>',
                ],
                // ...
            ],
            'OverrideAction' => [
                'Type' => 'NONE|COUNT',
            ],
            'Priority' => <integer>,
            'RuleId' => '<string>',
            'Type' => 'REGULAR|RATE_BASED|GROUP',
        ],
        // ...
    ],
    'NextMarker' => '<string>',
]

Result Details

Errors

WAFInternalErrorException:

The operation failed because of a system problem, even though the request was valid. Retry your request.

WAFNonexistentItemException:

The operation failed because the referenced object 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.

• You specified an invalid value.

• You tried to update an object (ByteMatchSet, IPSet, Rule, or WebACL) using an action other than INSERT or DELETE.

• You tried to create a WebACL with a DefaultAction Type other than ALLOW, BLOCK, or COUNT.

• You tried to create a RateBasedRule with a RateKey value other than IP.

• You tried to update a WebACL with a WafAction Type other than ALLOW, BLOCK, or COUNT.

• You tried to update a ByteMatchSet with a FieldToMatch Type other than HEADER, METHOD, QUERY_STRING, URI, or BODY.

• You tried to update a ByteMatchSet with a Field of HEADER but no value for Data.

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

ListByteMatchSets

$result = $client->listByteMatchSets([/* ... */]);
$promise = $client->listByteMatchSetsAsync([/* ... */]);

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Returns an array of ByteMatchSetSummary objects.

Parameter Syntax

$result = $client->listByteMatchSets([
    'Limit' => <integer>,
    'NextMarker' => '<string>',
]);

Parameter Details

Result Syntax

[
    'ByteMatchSets' => [
        [
            'ByteMatchSetId' => '<string>',
            'Name' => '<string>',
        ],
        // ...
    ],
    'NextMarker' => '<string>',
]

Result Details

Errors

WAFInternalErrorException:

The operation failed because of a system problem, even though the request was valid. Retry your request.

WAFInvalidAccountException:

The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.

ListGeoMatchSets

$result = $client->listGeoMatchSets([/* ... */]);
$promise = $client->listGeoMatchSetsAsync([/* ... */]);

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Returns an array of GeoMatchSetSummary objects in the response.

Parameter Syntax

$result = $client->listGeoMatchSets([
    'Limit' => <integer>,
    'NextMarker' => '<string>',
]);

Parameter Details

Result Syntax

[
    'GeoMatchSets' => [
        [
            'GeoMatchSetId' => '<string>',
            'Name' => '<string>',
        ],
        // ...
    ],
    'NextMarker' => '<string>',
]

Result Details

Errors

WAFInternalErrorException:

The operation failed because of a system problem, even though the request was valid. Retry your request.

WAFInvalidAccountException:

The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.

ListIPSets

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

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Returns an array of IPSetSummary objects in the response.

Parameter Syntax

$result = $client->listIPSets([
    'Limit' => <integer>,
    'NextMarker' => '<string>',
]);

Parameter Details