@Generated(value="software.amazon.awssdk:codegen") public interface WafRegionalClient extends SdkClient
builder()
method.
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.
This is the AWS WAF Regional Classic API Reference for using AWS WAF Classic with the AWS resources, Elastic Load Balancing (ELB) Application Load Balancers and API Gateway APIs. The AWS WAF Classic actions and data types listed in the reference are available for protecting Elastic Load Balancing (ELB) Application Load Balancers and API Gateway APIs. You can use these actions and data types by means of the endpoints listed in AWS Regions and Endpoints. This guide is for developers who need detailed information about the AWS WAF Classic API actions, data types, and errors. For detailed information about AWS WAF Classic features and an overview of how to use the AWS WAF Classic API, see the AWS WAF Classic in the developer guide.
Modifier and Type | Field and Description |
---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider . |
static String |
SERVICE_NAME |
serviceName
close
static final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider
.static WafRegionalClient create()
WafRegionalClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from the
DefaultCredentialsProvider
.static WafRegionalClientBuilder builder()
WafRegionalClient
.default AssociateWebAclResponse associateWebACL(AssociateWebAclRequest associateWebAclRequest) throws WafInternalErrorException, WafInvalidAccountException, WafInvalidParameterException, WafNonexistentItemException, WafUnavailableEntityException, AwsServiceException, SdkClientException, WafException
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.
associateWebAclRequest
- 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default AssociateWebAclResponse associateWebACL(Consumer<AssociateWebAclRequest.Builder> associateWebAclRequest) throws WafInternalErrorException, WafInvalidAccountException, WafInvalidParameterException, WafNonexistentItemException, WafUnavailableEntityException, AwsServiceException, SdkClientException, WafException
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.
This is a convenience which creates an instance of the AssociateWebAclRequest.Builder
avoiding the need
to create one manually via AssociateWebAclRequest.builder()
associateWebAclRequest
- A Consumer
that will call methods on AssociateWebACLRequest.Builder
to create a request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default CreateByteMatchSetResponse createByteMatchSet(CreateByteMatchSetRequest createByteMatchSetRequest) throws WafDisallowedNameException, WafInternalErrorException, WafInvalidAccountException, WafInvalidParameterException, WafStaleDataException, WafLimitsExceededException, AwsServiceException, SdkClientException, WafException
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:
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of a
CreateByteMatchSet
request.
Submit a CreateByteMatchSet
request.
Use GetChangeToken
to get the change token that you provide in the ChangeToken
parameter of an UpdateByteMatchSet
request.
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.
createByteMatchSetRequest
- 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default CreateByteMatchSetResponse createByteMatchSet(Consumer<CreateByteMatchSetRequest.Builder> createByteMatchSetRequest) throws WafDisallowedNameException, WafInternalErrorException, WafInvalidAccountException, WafInvalidParameterException, WafStaleDataException, WafLimitsExceededException, AwsServiceException, SdkClientException, WafException
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:
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of a
CreateByteMatchSet
request.
Submit a CreateByteMatchSet
request.
Use GetChangeToken
to get the change token that you provide in the ChangeToken
parameter of an UpdateByteMatchSet
request.
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.
This is a convenience which creates an instance of the CreateByteMatchSetRequest.Builder
avoiding the
need to create one manually via CreateByteMatchSetRequest.builder()
createByteMatchSetRequest
- A Consumer
that will call methods on CreateByteMatchSetRequest.Builder
to create a
request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default CreateGeoMatchSetResponse createGeoMatchSet(CreateGeoMatchSetRequest createGeoMatchSetRequest) throws WafStaleDataException, WafInternalErrorException, WafInvalidAccountException, WafDisallowedNameException, WafInvalidParameterException, WafLimitsExceededException, AwsServiceException, SdkClientException, WafException
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:
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of a
CreateGeoMatchSet
request.
Submit a CreateGeoMatchSet
request.
Use GetChangeToken
to get the change token that you provide in the ChangeToken
parameter of an UpdateGeoMatchSet request.
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.
createGeoMatchSetRequest
- 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default CreateGeoMatchSetResponse createGeoMatchSet(Consumer<CreateGeoMatchSetRequest.Builder> createGeoMatchSetRequest) throws WafStaleDataException, WafInternalErrorException, WafInvalidAccountException, WafDisallowedNameException, WafInvalidParameterException, WafLimitsExceededException, AwsServiceException, SdkClientException, WafException
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:
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of a
CreateGeoMatchSet
request.
Submit a CreateGeoMatchSet
request.
Use GetChangeToken
to get the change token that you provide in the ChangeToken
parameter of an UpdateGeoMatchSet request.
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.
This is a convenience which creates an instance of the CreateGeoMatchSetRequest.Builder
avoiding the need
to create one manually via CreateGeoMatchSetRequest.builder()
createGeoMatchSetRequest
- A Consumer
that will call methods on CreateGeoMatchSetRequest.Builder
to create a 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.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default CreateIpSetResponse createIPSet(CreateIpSetRequest createIpSetRequest) throws WafStaleDataException, WafInternalErrorException, WafInvalidAccountException, WafDisallowedNameException, WafInvalidParameterException, WafLimitsExceededException, AwsServiceException, SdkClientException, WafException
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:
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of a
CreateIPSet
request.
Submit a CreateIPSet
request.
Use GetChangeToken
to get the change token that you provide in the ChangeToken
parameter of an UpdateIPSet request.
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.
createIpSetRequest
- 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default CreateIpSetResponse createIPSet(Consumer<CreateIpSetRequest.Builder> createIpSetRequest) throws WafStaleDataException, WafInternalErrorException, WafInvalidAccountException, WafDisallowedNameException, WafInvalidParameterException, WafLimitsExceededException, AwsServiceException, SdkClientException, WafException
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:
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of a
CreateIPSet
request.
Submit a CreateIPSet
request.
Use GetChangeToken
to get the change token that you provide in the ChangeToken
parameter of an UpdateIPSet request.
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.
This is a convenience which creates an instance of the CreateIpSetRequest.Builder
avoiding the need to
create one manually via CreateIpSetRequest.builder()
createIpSetRequest
- A Consumer
that will call methods on CreateIPSetRequest.Builder
to create a 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.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default CreateRateBasedRuleResponse createRateBasedRule(CreateRateBasedRuleRequest createRateBasedRuleRequest) throws WafStaleDataException, WafInternalErrorException, WafDisallowedNameException, WafInvalidParameterException, WafLimitsExceededException, WafTagOperationException, WafTagOperationInternalErrorException, WafBadRequestException, AwsServiceException, SdkClientException, WafException
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:
Create and update the predicates that you want to include in the rule. For more information, see CreateByteMatchSet, CreateIPSet, and CreateSqlInjectionMatchSet.
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of a
CreateRule
request.
Submit a CreateRateBasedRule
request.
Use GetChangeToken
to get the change token that you provide in the ChangeToken
parameter of an UpdateRule request.
Submit an UpdateRateBasedRule
request to specify the predicates that you want to include in the
rule.
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.
createRateBasedRuleRequest
- 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
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default CreateRateBasedRuleResponse createRateBasedRule(Consumer<CreateRateBasedRuleRequest.Builder> createRateBasedRuleRequest) throws WafStaleDataException, WafInternalErrorException, WafDisallowedNameException, WafInvalidParameterException, WafLimitsExceededException, WafTagOperationException, WafTagOperationInternalErrorException, WafBadRequestException, AwsServiceException, SdkClientException, WafException
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:
Create and update the predicates that you want to include in the rule. For more information, see CreateByteMatchSet, CreateIPSet, and CreateSqlInjectionMatchSet.
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of a
CreateRule
request.
Submit a CreateRateBasedRule
request.
Use GetChangeToken
to get the change token that you provide in the ChangeToken
parameter of an UpdateRule request.
Submit an UpdateRateBasedRule
request to specify the predicates that you want to include in the
rule.
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.
This is a convenience which creates an instance of the CreateRateBasedRuleRequest.Builder
avoiding the
need to create one manually via CreateRateBasedRuleRequest.builder()
createRateBasedRuleRequest
- A Consumer
that will call methods on CreateRateBasedRuleRequest.Builder
to create a
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.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
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default CreateRegexMatchSetResponse createRegexMatchSet(CreateRegexMatchSetRequest createRegexMatchSetRequest) throws WafStaleDataException, WafInternalErrorException, WafDisallowedNameException, WafLimitsExceededException, AwsServiceException, SdkClientException, WafException
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:
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of a
CreateRegexMatchSet
request.
Submit a CreateRegexMatchSet
request.
Use GetChangeToken
to get the change token that you provide in the ChangeToken
parameter of an UpdateRegexMatchSet
request.
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.
createRegexMatchSetRequest
- 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default CreateRegexMatchSetResponse createRegexMatchSet(Consumer<CreateRegexMatchSetRequest.Builder> createRegexMatchSetRequest) throws WafStaleDataException, WafInternalErrorException, WafDisallowedNameException, WafLimitsExceededException, AwsServiceException, SdkClientException, WafException
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:
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of a
CreateRegexMatchSet
request.
Submit a CreateRegexMatchSet
request.
Use GetChangeToken
to get the change token that you provide in the ChangeToken
parameter of an UpdateRegexMatchSet
request.
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.
This is a convenience which creates an instance of the CreateRegexMatchSetRequest.Builder
avoiding the
need to create one manually via CreateRegexMatchSetRequest.builder()
createRegexMatchSetRequest
- A Consumer
that will call methods on CreateRegexMatchSetRequest.Builder
to create a
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.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default CreateRegexPatternSetResponse createRegexPatternSet(CreateRegexPatternSetRequest createRegexPatternSetRequest) throws WafStaleDataException, WafInternalErrorException, WafDisallowedNameException, WafLimitsExceededException, AwsServiceException, SdkClientException, WafException
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:
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of a
CreateRegexPatternSet
request.
Submit a CreateRegexPatternSet
request.
Use GetChangeToken
to get the change token that you provide in the ChangeToken
parameter of an UpdateRegexPatternSet
request.
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.
createRegexPatternSetRequest
- 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default CreateRegexPatternSetResponse createRegexPatternSet(Consumer<CreateRegexPatternSetRequest.Builder> createRegexPatternSetRequest) throws WafStaleDataException, WafInternalErrorException, WafDisallowedNameException, WafLimitsExceededException, AwsServiceException, SdkClientException, WafException
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:
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of a
CreateRegexPatternSet
request.
Submit a CreateRegexPatternSet
request.
Use GetChangeToken
to get the change token that you provide in the ChangeToken
parameter of an UpdateRegexPatternSet
request.
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.
This is a convenience which creates an instance of the CreateRegexPatternSetRequest.Builder
avoiding the
need to create one manually via CreateRegexPatternSetRequest.builder()
createRegexPatternSetRequest
- A Consumer
that will call methods on CreateRegexPatternSetRequest.Builder
to create a
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.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default CreateRuleResponse createRule(CreateRuleRequest createRuleRequest) throws WafStaleDataException, WafInternalErrorException, WafDisallowedNameException, WafInvalidParameterException, WafLimitsExceededException, WafTagOperationException, WafTagOperationInternalErrorException, WafBadRequestException, AwsServiceException, SdkClientException, WafException
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:
Create and update the predicates that you want to include in the Rule
. For more information, see
CreateByteMatchSet, CreateIPSet, and CreateSqlInjectionMatchSet.
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of a
CreateRule
request.
Submit a CreateRule
request.
Use GetChangeToken
to get the change token that you provide in the ChangeToken
parameter of an UpdateRule request.
Submit an UpdateRule
request to specify the predicates that you want to include in the
Rule
.
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.
createRuleRequest
- 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
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default CreateRuleResponse createRule(Consumer<CreateRuleRequest.Builder> createRuleRequest) throws WafStaleDataException, WafInternalErrorException, WafDisallowedNameException, WafInvalidParameterException, WafLimitsExceededException, WafTagOperationException, WafTagOperationInternalErrorException, WafBadRequestException, AwsServiceException, SdkClientException, WafException
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:
Create and update the predicates that you want to include in the Rule
. For more information, see
CreateByteMatchSet, CreateIPSet, and CreateSqlInjectionMatchSet.
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of a
CreateRule
request.
Submit a CreateRule
request.
Use GetChangeToken
to get the change token that you provide in the ChangeToken
parameter of an UpdateRule request.
Submit an UpdateRule
request to specify the predicates that you want to include in the
Rule
.
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.
This is a convenience which creates an instance of the CreateRuleRequest.Builder
avoiding the need to
create one manually via CreateRuleRequest.builder()
createRuleRequest
- A Consumer
that will call methods on CreateRuleRequest.Builder
to create a 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.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
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default CreateRuleGroupResponse createRuleGroup(CreateRuleGroupRequest createRuleGroupRequest) throws WafStaleDataException, WafInternalErrorException, WafDisallowedNameException, WafLimitsExceededException, WafTagOperationException, WafTagOperationInternalErrorException, WafBadRequestException, AwsServiceException, SdkClientException, WafException
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.
createRuleGroupRequest
- 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
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default CreateRuleGroupResponse createRuleGroup(Consumer<CreateRuleGroupRequest.Builder> createRuleGroupRequest) throws WafStaleDataException, WafInternalErrorException, WafDisallowedNameException, WafLimitsExceededException, WafTagOperationException, WafTagOperationInternalErrorException, WafBadRequestException, AwsServiceException, SdkClientException, WafException
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.
This is a convenience which creates an instance of the CreateRuleGroupRequest.Builder
avoiding the need
to create one manually via CreateRuleGroupRequest.builder()
createRuleGroupRequest
- A Consumer
that will call methods on CreateRuleGroupRequest.Builder
to create a 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.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
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default CreateSizeConstraintSetResponse createSizeConstraintSet(CreateSizeConstraintSetRequest createSizeConstraintSetRequest) throws WafStaleDataException, WafInternalErrorException, WafInvalidAccountException, WafDisallowedNameException, WafInvalidParameterException, WafLimitsExceededException, AwsServiceException, SdkClientException, WafException
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:
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of a
CreateSizeConstraintSet
request.
Submit a CreateSizeConstraintSet
request.
Use GetChangeToken
to get the change token that you provide in the ChangeToken
parameter of an UpdateSizeConstraintSet
request.
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.
createSizeConstraintSetRequest
- 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default CreateSizeConstraintSetResponse createSizeConstraintSet(Consumer<CreateSizeConstraintSetRequest.Builder> createSizeConstraintSetRequest) throws WafStaleDataException, WafInternalErrorException, WafInvalidAccountException, WafDisallowedNameException, WafInvalidParameterException, WafLimitsExceededException, AwsServiceException, SdkClientException, WafException
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:
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of a
CreateSizeConstraintSet
request.
Submit a CreateSizeConstraintSet
request.
Use GetChangeToken
to get the change token that you provide in the ChangeToken
parameter of an UpdateSizeConstraintSet
request.
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.
This is a convenience which creates an instance of the CreateSizeConstraintSetRequest.Builder
avoiding
the need to create one manually via CreateSizeConstraintSetRequest.builder()
createSizeConstraintSetRequest
- A Consumer
that will call methods on CreateSizeConstraintSetRequest.Builder
to create a
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.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default CreateSqlInjectionMatchSetResponse createSqlInjectionMatchSet(CreateSqlInjectionMatchSetRequest createSqlInjectionMatchSetRequest) throws WafDisallowedNameException, WafInternalErrorException, WafInvalidAccountException, WafInvalidParameterException, WafStaleDataException, WafLimitsExceededException, AwsServiceException, SdkClientException, WafException
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:
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of a
CreateSqlInjectionMatchSet
request.
Submit a CreateSqlInjectionMatchSet
request.
Use GetChangeToken
to get the change token that you provide in the ChangeToken
parameter of an UpdateSqlInjectionMatchSet request.
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.
createSqlInjectionMatchSetRequest
- A request to create a SqlInjectionMatchSet.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default CreateSqlInjectionMatchSetResponse createSqlInjectionMatchSet(Consumer<CreateSqlInjectionMatchSetRequest.Builder> createSqlInjectionMatchSetRequest) throws WafDisallowedNameException, WafInternalErrorException, WafInvalidAccountException, WafInvalidParameterException, WafStaleDataException, WafLimitsExceededException, AwsServiceException, SdkClientException, WafException
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:
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of a
CreateSqlInjectionMatchSet
request.
Submit a CreateSqlInjectionMatchSet
request.
Use GetChangeToken
to get the change token that you provide in the ChangeToken
parameter of an UpdateSqlInjectionMatchSet request.
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.
This is a convenience which creates an instance of the CreateSqlInjectionMatchSetRequest.Builder
avoiding
the need to create one manually via CreateSqlInjectionMatchSetRequest.builder()
createSqlInjectionMatchSetRequest
- A Consumer
that will call methods on CreateSqlInjectionMatchSetRequest.Builder
to create a
request. A request to create a SqlInjectionMatchSet.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default CreateWebAclResponse createWebACL(CreateWebAclRequest createWebAclRequest) throws WafStaleDataException, WafInternalErrorException, WafInvalidAccountException, WafDisallowedNameException, WafInvalidParameterException, WafLimitsExceededException, WafTagOperationException, WafTagOperationInternalErrorException, WafBadRequestException, AwsServiceException, SdkClientException, WafException
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:
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.
Create and update the Rules
that you want to include in the WebACL
. For more
information, see CreateRule and UpdateRule.
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of a
CreateWebACL
request.
Submit a CreateWebACL
request.
Use GetChangeToken
to get the change token that you provide in the ChangeToken
parameter of an UpdateWebACL request.
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.
createWebAclRequest
- 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
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default CreateWebAclResponse createWebACL(Consumer<CreateWebAclRequest.Builder> createWebAclRequest) throws WafStaleDataException, WafInternalErrorException, WafInvalidAccountException, WafDisallowedNameException, WafInvalidParameterException, WafLimitsExceededException, WafTagOperationException, WafTagOperationInternalErrorException, WafBadRequestException, AwsServiceException, SdkClientException, WafException
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:
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.
Create and update the Rules
that you want to include in the WebACL
. For more
information, see CreateRule and UpdateRule.
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of a
CreateWebACL
request.
Submit a CreateWebACL
request.
Use GetChangeToken
to get the change token that you provide in the ChangeToken
parameter of an UpdateWebACL request.
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.
This is a convenience which creates an instance of the CreateWebAclRequest.Builder
avoiding the need to
create one manually via CreateWebAclRequest.builder()
createWebAclRequest
- A Consumer
that will call methods on CreateWebACLRequest.Builder
to create a 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.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
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default CreateWebAclMigrationStackResponse createWebACLMigrationStack(CreateWebAclMigrationStackRequest createWebAclMigrationStackRequest) throws WafInternalErrorException, WafInvalidParameterException, WafInvalidOperationException, WafNonexistentItemException, WafEntityMigrationException, AwsServiceException, SdkClientException, WafException
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.
createWebAclMigrationStackRequest
- 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.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default CreateWebAclMigrationStackResponse createWebACLMigrationStack(Consumer<CreateWebAclMigrationStackRequest.Builder> createWebAclMigrationStackRequest) throws WafInternalErrorException, WafInvalidParameterException, WafInvalidOperationException, WafNonexistentItemException, WafEntityMigrationException, AwsServiceException, SdkClientException, WafException
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.
This is a convenience which creates an instance of the CreateWebAclMigrationStackRequest.Builder
avoiding
the need to create one manually via CreateWebAclMigrationStackRequest.builder()
createWebAclMigrationStackRequest
- A Consumer
that will call methods on CreateWebACLMigrationStackRequest.Builder
to create a
request.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.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default CreateXssMatchSetResponse createXssMatchSet(CreateXssMatchSetRequest createXssMatchSetRequest) throws WafDisallowedNameException, WafInternalErrorException, WafInvalidAccountException, WafInvalidParameterException, WafStaleDataException, WafLimitsExceededException, AwsServiceException, SdkClientException, WafException
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:
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of a
CreateXssMatchSet
request.
Submit a CreateXssMatchSet
request.
Use GetChangeToken
to get the change token that you provide in the ChangeToken
parameter of an UpdateXssMatchSet request.
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.
createXssMatchSetRequest
- A request to create an XssMatchSet.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default CreateXssMatchSetResponse createXssMatchSet(Consumer<CreateXssMatchSetRequest.Builder> createXssMatchSetRequest) throws WafDisallowedNameException, WafInternalErrorException, WafInvalidAccountException, WafInvalidParameterException, WafStaleDataException, WafLimitsExceededException, AwsServiceException, SdkClientException, WafException
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:
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of a
CreateXssMatchSet
request.
Submit a CreateXssMatchSet
request.
Use GetChangeToken
to get the change token that you provide in the ChangeToken
parameter of an UpdateXssMatchSet request.
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.
This is a convenience which creates an instance of the CreateXssMatchSetRequest.Builder
avoiding the need
to create one manually via CreateXssMatchSetRequest.builder()
createXssMatchSetRequest
- A Consumer
that will call methods on CreateXssMatchSetRequest.Builder
to create a request.
A request to create an XssMatchSet.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default DeleteByteMatchSetResponse deleteByteMatchSet(DeleteByteMatchSetRequest deleteByteMatchSetRequest) throws WafInternalErrorException, WafInvalidAccountException, WafNonexistentItemException, WafReferencedItemException, WafStaleDataException, WafNonEmptyEntityException, AwsServiceException, SdkClientException, WafException
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:
Update the ByteMatchSet
to remove filters, if any. For more information, see
UpdateByteMatchSet.
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of a
DeleteByteMatchSet
request.
Submit a DeleteByteMatchSet
request.
deleteByteMatchSetRequest
- 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.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default DeleteByteMatchSetResponse deleteByteMatchSet(Consumer<DeleteByteMatchSetRequest.Builder> deleteByteMatchSetRequest) throws WafInternalErrorException, WafInvalidAccountException, WafNonexistentItemException, WafReferencedItemException, WafStaleDataException, WafNonEmptyEntityException, AwsServiceException, SdkClientException, WafException
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:
Update the ByteMatchSet
to remove filters, if any. For more information, see
UpdateByteMatchSet.
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of a
DeleteByteMatchSet
request.
Submit a DeleteByteMatchSet
request.
This is a convenience which creates an instance of the DeleteByteMatchSetRequest.Builder
avoiding the
need to create one manually via DeleteByteMatchSetRequest.builder()
deleteByteMatchSetRequest
- A Consumer
that will call methods on DeleteByteMatchSetRequest.Builder
to create a
request.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.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default DeleteGeoMatchSetResponse deleteGeoMatchSet(DeleteGeoMatchSetRequest deleteGeoMatchSetRequest) throws WafStaleDataException, WafInternalErrorException, WafInvalidAccountException, WafNonexistentItemException, WafReferencedItemException, WafNonEmptyEntityException, AwsServiceException, SdkClientException, WafException
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:
Update the GeoMatchSet
to remove any countries. For more information, see UpdateGeoMatchSet.
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of a
DeleteGeoMatchSet
request.
Submit a DeleteGeoMatchSet
request.
deleteGeoMatchSetRequest
- 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.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default DeleteGeoMatchSetResponse deleteGeoMatchSet(Consumer<DeleteGeoMatchSetRequest.Builder> deleteGeoMatchSetRequest) throws WafStaleDataException, WafInternalErrorException, WafInvalidAccountException, WafNonexistentItemException, WafReferencedItemException, WafNonEmptyEntityException, AwsServiceException, SdkClientException, WafException
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:
Update the GeoMatchSet
to remove any countries. For more information, see UpdateGeoMatchSet.
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of a
DeleteGeoMatchSet
request.
Submit a DeleteGeoMatchSet
request.
This is a convenience which creates an instance of the DeleteGeoMatchSetRequest.Builder
avoiding the need
to create one manually via DeleteGeoMatchSetRequest.builder()
deleteGeoMatchSetRequest
- A Consumer
that will call methods on DeleteGeoMatchSetRequest.Builder
to create a 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.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.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default DeleteIpSetResponse deleteIPSet(DeleteIpSetRequest deleteIpSetRequest) throws WafStaleDataException, WafInternalErrorException, WafInvalidAccountException, WafNonexistentItemException, WafReferencedItemException, WafNonEmptyEntityException, AwsServiceException, SdkClientException, WafException
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:
Update the IPSet
to remove IP address ranges, if any. For more information, see UpdateIPSet.
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of a
DeleteIPSet
request.
Submit a DeleteIPSet
request.
deleteIpSetRequest
- 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.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default DeleteIpSetResponse deleteIPSet(Consumer<DeleteIpSetRequest.Builder> deleteIpSetRequest) throws WafStaleDataException, WafInternalErrorException, WafInvalidAccountException, WafNonexistentItemException, WafReferencedItemException, WafNonEmptyEntityException, AwsServiceException, SdkClientException, WafException
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:
Update the IPSet
to remove IP address ranges, if any. For more information, see UpdateIPSet.
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of a
DeleteIPSet
request.
Submit a DeleteIPSet
request.
This is a convenience which creates an instance of the DeleteIpSetRequest.Builder
avoiding the need to
create one manually via DeleteIpSetRequest.builder()
deleteIpSetRequest
- A Consumer
that will call methods on DeleteIPSetRequest.Builder
to create a 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.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.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default DeleteLoggingConfigurationResponse deleteLoggingConfiguration(DeleteLoggingConfigurationRequest deleteLoggingConfigurationRequest) throws WafInternalErrorException, WafNonexistentItemException, WafStaleDataException, AwsServiceException, SdkClientException, WafException
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.
deleteLoggingConfigurationRequest
- 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default DeleteLoggingConfigurationResponse deleteLoggingConfiguration(Consumer<DeleteLoggingConfigurationRequest.Builder> deleteLoggingConfigurationRequest) throws WafInternalErrorException, WafNonexistentItemException, WafStaleDataException, AwsServiceException, SdkClientException, WafException
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.
This is a convenience which creates an instance of the DeleteLoggingConfigurationRequest.Builder
avoiding
the need to create one manually via DeleteLoggingConfigurationRequest.builder()
deleteLoggingConfigurationRequest
- A Consumer
that will call methods on DeleteLoggingConfigurationRequest.Builder
to create a
request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default DeletePermissionPolicyResponse deletePermissionPolicy(DeletePermissionPolicyRequest deletePermissionPolicyRequest) throws WafInternalErrorException, WafStaleDataException, WafNonexistentItemException, AwsServiceException, SdkClientException, WafException
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.
deletePermissionPolicyRequest
- 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default DeletePermissionPolicyResponse deletePermissionPolicy(Consumer<DeletePermissionPolicyRequest.Builder> deletePermissionPolicyRequest) throws WafInternalErrorException, WafStaleDataException, WafNonexistentItemException, AwsServiceException, SdkClientException, WafException
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.
This is a convenience which creates an instance of the DeletePermissionPolicyRequest.Builder
avoiding the
need to create one manually via DeletePermissionPolicyRequest.builder()
deletePermissionPolicyRequest
- A Consumer
that will call methods on DeletePermissionPolicyRequest.Builder
to create a
request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default DeleteRateBasedRuleResponse deleteRateBasedRule(DeleteRateBasedRuleRequest deleteRateBasedRuleRequest) throws WafStaleDataException, WafInternalErrorException, WafInvalidAccountException, WafNonexistentItemException, WafReferencedItemException, WafNonEmptyEntityException, WafTagOperationException, WafTagOperationInternalErrorException, AwsServiceException, SdkClientException, WafException
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:
Update the RateBasedRule
to remove predicates, if any. For more information, see
UpdateRateBasedRule.
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of a
DeleteRateBasedRule
request.
Submit a DeleteRateBasedRule
request.
deleteRateBasedRuleRequest
- 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
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default DeleteRateBasedRuleResponse deleteRateBasedRule(Consumer<DeleteRateBasedRuleRequest.Builder> deleteRateBasedRuleRequest) throws WafStaleDataException, WafInternalErrorException, WafInvalidAccountException, WafNonexistentItemException, WafReferencedItemException, WafNonEmptyEntityException, WafTagOperationException, WafTagOperationInternalErrorException, AwsServiceException, SdkClientException, WafException
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:
Update the RateBasedRule
to remove predicates, if any. For more information, see
UpdateRateBasedRule.
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of a
DeleteRateBasedRule
request.
Submit a DeleteRateBasedRule
request.
This is a convenience which creates an instance of the DeleteRateBasedRuleRequest.Builder
avoiding the
need to create one manually via DeleteRateBasedRuleRequest.builder()
deleteRateBasedRuleRequest
- A Consumer
that will call methods on DeleteRateBasedRuleRequest.Builder
to create a
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.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
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default DeleteRegexMatchSetResponse deleteRegexMatchSet(DeleteRegexMatchSetRequest deleteRegexMatchSetRequest) throws WafInternalErrorException, WafInvalidAccountException, WafNonexistentItemException, WafReferencedItemException, WafStaleDataException, WafNonEmptyEntityException, AwsServiceException, SdkClientException, WafException
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:
Update the RegexMatchSet
to remove filters, if any. For more information, see
UpdateRegexMatchSet.
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of a
DeleteRegexMatchSet
request.
Submit a DeleteRegexMatchSet
request.
deleteRegexMatchSetRequest
- 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.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default DeleteRegexMatchSetResponse deleteRegexMatchSet(Consumer<DeleteRegexMatchSetRequest.Builder> deleteRegexMatchSetRequest) throws WafInternalErrorException, WafInvalidAccountException, WafNonexistentItemException, WafReferencedItemException, WafStaleDataException, WafNonEmptyEntityException, AwsServiceException, SdkClientException, WafException
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:
Update the RegexMatchSet
to remove filters, if any. For more information, see
UpdateRegexMatchSet.
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of a
DeleteRegexMatchSet
request.
Submit a DeleteRegexMatchSet
request.
This is a convenience which creates an instance of the DeleteRegexMatchSetRequest.Builder
avoiding the
need to create one manually via DeleteRegexMatchSetRequest.builder()
deleteRegexMatchSetRequest
- A Consumer
that will call methods on DeleteRegexMatchSetRequest.Builder
to create a
request.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.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default DeleteRegexPatternSetResponse deleteRegexPatternSet(DeleteRegexPatternSetRequest deleteRegexPatternSetRequest) throws WafInternalErrorException, WafInvalidAccountException, WafNonexistentItemException, WafReferencedItemException, WafStaleDataException, WafNonEmptyEntityException, AwsServiceException, SdkClientException, WafException
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.
deleteRegexPatternSetRequest
- 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.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default DeleteRegexPatternSetResponse deleteRegexPatternSet(Consumer<DeleteRegexPatternSetRequest.Builder> deleteRegexPatternSetRequest) throws WafInternalErrorException, WafInvalidAccountException, WafNonexistentItemException, WafReferencedItemException, WafStaleDataException, WafNonEmptyEntityException, AwsServiceException, SdkClientException, WafException
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.
This is a convenience which creates an instance of the DeleteRegexPatternSetRequest.Builder
avoiding the
need to create one manually via DeleteRegexPatternSetRequest.builder()
deleteRegexPatternSetRequest
- A Consumer
that will call methods on DeleteRegexPatternSetRequest.Builder
to create a
request.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.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default DeleteRuleResponse deleteRule(DeleteRuleRequest deleteRuleRequest) throws WafStaleDataException, WafInternalErrorException, WafInvalidAccountException, WafNonexistentItemException, WafReferencedItemException, WafNonEmptyEntityException, WafTagOperationException, WafTagOperationInternalErrorException, AwsServiceException, SdkClientException, WafException
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:
Update the Rule
to remove predicates, if any. For more information, see UpdateRule.
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of a
DeleteRule
request.
Submit a DeleteRule
request.
deleteRuleRequest
- 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
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default DeleteRuleResponse deleteRule(Consumer<DeleteRuleRequest.Builder> deleteRuleRequest) throws WafStaleDataException, WafInternalErrorException, WafInvalidAccountException, WafNonexistentItemException, WafReferencedItemException, WafNonEmptyEntityException, WafTagOperationException, WafTagOperationInternalErrorException, AwsServiceException, SdkClientException, WafException
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:
Update the Rule
to remove predicates, if any. For more information, see UpdateRule.
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of a
DeleteRule
request.
Submit a DeleteRule
request.
This is a convenience which creates an instance of the DeleteRuleRequest.Builder
avoiding the need to
create one manually via DeleteRuleRequest.builder()
deleteRuleRequest
- A Consumer
that will call methods on DeleteRuleRequest.Builder
to create a 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.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
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default DeleteRuleGroupResponse deleteRuleGroup(DeleteRuleGroupRequest deleteRuleGroupRequest) throws WafStaleDataException, WafInternalErrorException, WafNonexistentItemException, WafReferencedItemException, WafNonEmptyEntityException, WafInvalidOperationException, WafTagOperationException, WafTagOperationInternalErrorException, AwsServiceException, SdkClientException, WafException
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:
Update the RuleGroup
to remove rules, if any. For more information, see UpdateRuleGroup.
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of a
DeleteRuleGroup
request.
Submit a DeleteRuleGroup
request.
deleteRuleGroupRequest
- 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
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default DeleteRuleGroupResponse deleteRuleGroup(Consumer<DeleteRuleGroupRequest.Builder> deleteRuleGroupRequest) throws WafStaleDataException, WafInternalErrorException, WafNonexistentItemException, WafReferencedItemException, WafNonEmptyEntityException, WafInvalidOperationException, WafTagOperationException, WafTagOperationInternalErrorException, AwsServiceException, SdkClientException, WafException
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:
Update the RuleGroup
to remove rules, if any. For more information, see UpdateRuleGroup.
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of a
DeleteRuleGroup
request.
Submit a DeleteRuleGroup
request.
This is a convenience which creates an instance of the DeleteRuleGroupRequest.Builder
avoiding the need
to create one manually via DeleteRuleGroupRequest.builder()
deleteRuleGroupRequest
- A Consumer
that will call methods on DeleteRuleGroupRequest.Builder
to create a 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.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
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default DeleteSizeConstraintSetResponse deleteSizeConstraintSet(DeleteSizeConstraintSetRequest deleteSizeConstraintSetRequest) throws WafStaleDataException, WafInternalErrorException, WafInvalidAccountException, WafNonexistentItemException, WafReferencedItemException, WafNonEmptyEntityException, AwsServiceException, SdkClientException, WafException
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:
Update the SizeConstraintSet
to remove filters, if any. For more information, see
UpdateSizeConstraintSet.
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of a
DeleteSizeConstraintSet
request.
Submit a DeleteSizeConstraintSet
request.
deleteSizeConstraintSetRequest
- 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.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default DeleteSizeConstraintSetResponse deleteSizeConstraintSet(Consumer<DeleteSizeConstraintSetRequest.Builder> deleteSizeConstraintSetRequest) throws WafStaleDataException, WafInternalErrorException, WafInvalidAccountException, WafNonexistentItemException, WafReferencedItemException, WafNonEmptyEntityException, AwsServiceException, SdkClientException, WafException
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:
Update the SizeConstraintSet
to remove filters, if any. For more information, see
UpdateSizeConstraintSet.
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of a
DeleteSizeConstraintSet
request.
Submit a DeleteSizeConstraintSet
request.
This is a convenience which creates an instance of the DeleteSizeConstraintSetRequest.Builder
avoiding
the need to create one manually via DeleteSizeConstraintSetRequest.builder()
deleteSizeConstraintSetRequest
- A Consumer
that will call methods on DeleteSizeConstraintSetRequest.Builder
to create a
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.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.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default DeleteSqlInjectionMatchSetResponse deleteSqlInjectionMatchSet(DeleteSqlInjectionMatchSetRequest deleteSqlInjectionMatchSetRequest) throws WafInternalErrorException, WafInvalidAccountException, WafNonexistentItemException, WafReferencedItemException, WafStaleDataException, WafNonEmptyEntityException, AwsServiceException, SdkClientException, WafException
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:
Update the SqlInjectionMatchSet
to remove filters, if any. For more information, see
UpdateSqlInjectionMatchSet.
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of a
DeleteSqlInjectionMatchSet
request.
Submit a DeleteSqlInjectionMatchSet
request.
deleteSqlInjectionMatchSetRequest
- A request to delete a SqlInjectionMatchSet from AWS WAF.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.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default DeleteSqlInjectionMatchSetResponse deleteSqlInjectionMatchSet(Consumer<DeleteSqlInjectionMatchSetRequest.Builder> deleteSqlInjectionMatchSetRequest) throws WafInternalErrorException, WafInvalidAccountException, WafNonexistentItemException, WafReferencedItemException, WafStaleDataException, WafNonEmptyEntityException, AwsServiceException, SdkClientException, WafException
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:
Update the SqlInjectionMatchSet
to remove filters, if any. For more information, see
UpdateSqlInjectionMatchSet.
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of a
DeleteSqlInjectionMatchSet
request.
Submit a DeleteSqlInjectionMatchSet
request.
This is a convenience which creates an instance of the DeleteSqlInjectionMatchSetRequest.Builder
avoiding
the need to create one manually via DeleteSqlInjectionMatchSetRequest.builder()
deleteSqlInjectionMatchSetRequest
- A Consumer
that will call methods on DeleteSqlInjectionMatchSetRequest.Builder
to create a
request. A request to delete a SqlInjectionMatchSet from AWS WAF.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.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default DeleteWebAclResponse deleteWebACL(DeleteWebAclRequest deleteWebAclRequest) throws WafStaleDataException, WafInternalErrorException, WafInvalidAccountException, WafNonexistentItemException, WafReferencedItemException, WafNonEmptyEntityException, WafTagOperationException, WafTagOperationInternalErrorException, AwsServiceException, SdkClientException, WafException
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:
Update the WebACL
to remove Rules
, if any. For more information, see
UpdateWebACL.
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of a
DeleteWebACL
request.
Submit a DeleteWebACL
request.
deleteWebAclRequest
- 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
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default DeleteWebAclResponse deleteWebACL(Consumer<DeleteWebAclRequest.Builder> deleteWebAclRequest) throws WafStaleDataException, WafInternalErrorException, WafInvalidAccountException, WafNonexistentItemException, WafReferencedItemException, WafNonEmptyEntityException, WafTagOperationException, WafTagOperationInternalErrorException, AwsServiceException, SdkClientException, WafException
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:
Update the WebACL
to remove Rules
, if any. For more information, see
UpdateWebACL.
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of a
DeleteWebACL
request.
Submit a DeleteWebACL
request.
This is a convenience which creates an instance of the DeleteWebAclRequest.Builder
avoiding the need to
create one manually via DeleteWebAclRequest.builder()
deleteWebAclRequest
- A Consumer
that will call methods on DeleteWebACLRequest.Builder
to create a 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.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
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default DeleteXssMatchSetResponse deleteXssMatchSet(DeleteXssMatchSetRequest deleteXssMatchSetRequest) throws WafInternalErrorException, WafInvalidAccountException, WafNonexistentItemException, WafReferencedItemException, WafStaleDataException, WafNonEmptyEntityException, AwsServiceException, SdkClientException, WafException
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:
Update the XssMatchSet
to remove filters, if any. For more information, see
UpdateXssMatchSet.
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of a
DeleteXssMatchSet
request.
Submit a DeleteXssMatchSet
request.
deleteXssMatchSetRequest
- A request to delete an XssMatchSet from AWS WAF.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.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default DeleteXssMatchSetResponse deleteXssMatchSet(Consumer<DeleteXssMatchSetRequest.Builder> deleteXssMatchSetRequest) throws WafInternalErrorException, WafInvalidAccountException, WafNonexistentItemException, WafReferencedItemException, WafStaleDataException, WafNonEmptyEntityException, AwsServiceException, SdkClientException, WafException
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:
Update the XssMatchSet
to remove filters, if any. For more information, see
UpdateXssMatchSet.
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of a
DeleteXssMatchSet
request.
Submit a DeleteXssMatchSet
request.
This is a convenience which creates an instance of the DeleteXssMatchSetRequest.Builder
avoiding the need
to create one manually via DeleteXssMatchSetRequest.builder()
deleteXssMatchSetRequest
- A Consumer
that will call methods on DeleteXssMatchSetRequest.Builder
to create a request.
A request to delete an XssMatchSet from AWS WAF.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.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default DisassociateWebAclResponse disassociateWebACL(DisassociateWebAclRequest disassociateWebAclRequest) throws WafInternalErrorException, WafInvalidAccountException, WafInvalidParameterException, WafNonexistentItemException, AwsServiceException, SdkClientException, WafException
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.
disassociateWebAclRequest
- 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default DisassociateWebAclResponse disassociateWebACL(Consumer<DisassociateWebAclRequest.Builder> disassociateWebAclRequest) throws WafInternalErrorException, WafInvalidAccountException, WafInvalidParameterException, WafNonexistentItemException, AwsServiceException, SdkClientException, WafException
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.
This is a convenience which creates an instance of the DisassociateWebAclRequest.Builder
avoiding the
need to create one manually via DisassociateWebAclRequest.builder()
disassociateWebAclRequest
- A Consumer
that will call methods on DisassociateWebACLRequest.Builder
to create a
request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default GetByteMatchSetResponse getByteMatchSet(GetByteMatchSetRequest getByteMatchSetRequest) throws WafInternalErrorException, WafInvalidAccountException, WafNonexistentItemException, AwsServiceException, SdkClientException, WafException
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
.
getByteMatchSetRequest
- 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default GetByteMatchSetResponse getByteMatchSet(Consumer<GetByteMatchSetRequest.Builder> getByteMatchSetRequest) throws WafInternalErrorException, WafInvalidAccountException, WafNonexistentItemException, AwsServiceException, SdkClientException, WafException
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
.
This is a convenience which creates an instance of the GetByteMatchSetRequest.Builder
avoiding the need
to create one manually via GetByteMatchSetRequest.builder()
getByteMatchSetRequest
- A Consumer
that will call methods on GetByteMatchSetRequest.Builder
to create a request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default GetChangeTokenResponse getChangeToken() throws WafInternalErrorException, AwsServiceException, SdkClientException, WafException
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.
WafInternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
getChangeToken(GetChangeTokenRequest)
,
AWS
API Documentationdefault GetChangeTokenResponse getChangeToken(GetChangeTokenRequest getChangeTokenRequest) throws WafInternalErrorException, AwsServiceException, SdkClientException, WafException
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.
getChangeTokenRequest
- WafInternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default GetChangeTokenResponse getChangeToken(Consumer<GetChangeTokenRequest.Builder> getChangeTokenRequest) throws WafInternalErrorException, AwsServiceException, SdkClientException, WafException
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.
This is a convenience which creates an instance of the GetChangeTokenRequest.Builder
avoiding the need to
create one manually via GetChangeTokenRequest.builder()
getChangeTokenRequest
- A Consumer
that will call methods on GetChangeTokenRequest.Builder
to create a request.WafInternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default GetChangeTokenStatusResponse getChangeTokenStatus(GetChangeTokenStatusRequest getChangeTokenStatusRequest) throws WafNonexistentItemException, WafInternalErrorException, AwsServiceException, SdkClientException, WafException
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.
getChangeTokenStatusRequest
- 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default GetChangeTokenStatusResponse getChangeTokenStatus(Consumer<GetChangeTokenStatusRequest.Builder> getChangeTokenStatusRequest) throws WafNonexistentItemException, WafInternalErrorException, AwsServiceException, SdkClientException, WafException
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.
This is a convenience which creates an instance of the GetChangeTokenStatusRequest.Builder
avoiding the
need to create one manually via GetChangeTokenStatusRequest.builder()
getChangeTokenStatusRequest
- A Consumer
that will call methods on GetChangeTokenStatusRequest.Builder
to create a
request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default GetGeoMatchSetResponse getGeoMatchSet(GetGeoMatchSetRequest getGeoMatchSetRequest) throws WafInternalErrorException, WafInvalidAccountException, WafNonexistentItemException, AwsServiceException, SdkClientException, WafException
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
.
getGeoMatchSetRequest
- 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default GetGeoMatchSetResponse getGeoMatchSet(Consumer<GetGeoMatchSetRequest.Builder> getGeoMatchSetRequest) throws WafInternalErrorException, WafInvalidAccountException, WafNonexistentItemException, AwsServiceException, SdkClientException, WafException
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
.
This is a convenience which creates an instance of the GetGeoMatchSetRequest.Builder
avoiding the need to
create one manually via GetGeoMatchSetRequest.builder()
getGeoMatchSetRequest
- A Consumer
that will call methods on GetGeoMatchSetRequest.Builder
to create a request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default GetIpSetResponse getIPSet(GetIpSetRequest getIpSetRequest) throws WafInternalErrorException, WafInvalidAccountException, WafNonexistentItemException, AwsServiceException, SdkClientException, WafException
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
.
getIpSetRequest
- 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default GetIpSetResponse getIPSet(Consumer<GetIpSetRequest.Builder> getIpSetRequest) throws WafInternalErrorException, WafInvalidAccountException, WafNonexistentItemException, AwsServiceException, SdkClientException, WafException
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
.
This is a convenience which creates an instance of the GetIpSetRequest.Builder
avoiding the need to
create one manually via GetIpSetRequest.builder()
getIpSetRequest
- A Consumer
that will call methods on GetIPSetRequest.Builder
to create a request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default GetLoggingConfigurationResponse getLoggingConfiguration(GetLoggingConfigurationRequest getLoggingConfigurationRequest) throws WafInternalErrorException, WafNonexistentItemException, AwsServiceException, SdkClientException, WafException
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.
getLoggingConfigurationRequest
- 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default GetLoggingConfigurationResponse getLoggingConfiguration(Consumer<GetLoggingConfigurationRequest.Builder> getLoggingConfigurationRequest) throws WafInternalErrorException, WafNonexistentItemException, AwsServiceException, SdkClientException, WafException
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.
This is a convenience which creates an instance of the GetLoggingConfigurationRequest.Builder
avoiding
the need to create one manually via GetLoggingConfigurationRequest.builder()
getLoggingConfigurationRequest
- A Consumer
that will call methods on GetLoggingConfigurationRequest.Builder
to create a
request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default GetPermissionPolicyResponse getPermissionPolicy(GetPermissionPolicyRequest getPermissionPolicyRequest) throws WafInternalErrorException, WafNonexistentItemException, AwsServiceException, SdkClientException, WafException
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.
getPermissionPolicyRequest
- 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default GetPermissionPolicyResponse getPermissionPolicy(Consumer<GetPermissionPolicyRequest.Builder> getPermissionPolicyRequest) throws WafInternalErrorException, WafNonexistentItemException, AwsServiceException, SdkClientException, WafException
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.
This is a convenience which creates an instance of the GetPermissionPolicyRequest.Builder
avoiding the
need to create one manually via GetPermissionPolicyRequest.builder()
getPermissionPolicyRequest
- A Consumer
that will call methods on GetPermissionPolicyRequest.Builder
to create a
request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default GetRateBasedRuleResponse getRateBasedRule(GetRateBasedRuleRequest getRateBasedRuleRequest) throws WafInternalErrorException, WafInvalidAccountException, WafNonexistentItemException, AwsServiceException, SdkClientException, WafException
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.
getRateBasedRuleRequest
- 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default GetRateBasedRuleResponse getRateBasedRule(Consumer<GetRateBasedRuleRequest.Builder> getRateBasedRuleRequest) throws WafInternalErrorException, WafInvalidAccountException, WafNonexistentItemException, AwsServiceException, SdkClientException, WafException
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.
This is a convenience which creates an instance of the GetRateBasedRuleRequest.Builder
avoiding the need
to create one manually via GetRateBasedRuleRequest.builder()
getRateBasedRuleRequest
- A Consumer
that will call methods on GetRateBasedRuleRequest.Builder
to create a request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default GetRateBasedRuleManagedKeysResponse getRateBasedRuleManagedKeys(GetRateBasedRuleManagedKeysRequest getRateBasedRuleManagedKeysRequest) throws WafInternalErrorException, WafInvalidAccountException, WafNonexistentItemException, WafInvalidParameterException, AwsServiceException, SdkClientException, WafException
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.
getRateBasedRuleManagedKeysRequest
- 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.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default GetRateBasedRuleManagedKeysResponse getRateBasedRuleManagedKeys(Consumer<GetRateBasedRuleManagedKeysRequest.Builder> getRateBasedRuleManagedKeysRequest) throws WafInternalErrorException, WafInvalidAccountException, WafNonexistentItemException, WafInvalidParameterException, AwsServiceException, SdkClientException, WafException
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.
This is a convenience which creates an instance of the GetRateBasedRuleManagedKeysRequest.Builder
avoiding the need to create one manually via GetRateBasedRuleManagedKeysRequest.builder()
getRateBasedRuleManagedKeysRequest
- A Consumer
that will call methods on GetRateBasedRuleManagedKeysRequest.Builder
to create
a request.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.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default GetRegexMatchSetResponse getRegexMatchSet(GetRegexMatchSetRequest getRegexMatchSetRequest) throws WafInternalErrorException, WafInvalidAccountException, WafNonexistentItemException, AwsServiceException, SdkClientException, WafException
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
.
getRegexMatchSetRequest
- 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default GetRegexMatchSetResponse getRegexMatchSet(Consumer<GetRegexMatchSetRequest.Builder> getRegexMatchSetRequest) throws WafInternalErrorException, WafInvalidAccountException, WafNonexistentItemException, AwsServiceException, SdkClientException, WafException
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
.
This is a convenience which creates an instance of the GetRegexMatchSetRequest.Builder
avoiding the need
to create one manually via GetRegexMatchSetRequest.builder()
getRegexMatchSetRequest
- A Consumer
that will call methods on GetRegexMatchSetRequest.Builder
to create a request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default GetRegexPatternSetResponse getRegexPatternSet(GetRegexPatternSetRequest getRegexPatternSetRequest) throws WafInternalErrorException, WafInvalidAccountException, WafNonexistentItemException, AwsServiceException, SdkClientException, WafException
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
.
getRegexPatternSetRequest
- 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default GetRegexPatternSetResponse getRegexPatternSet(Consumer<GetRegexPatternSetRequest.Builder> getRegexPatternSetRequest) throws WafInternalErrorException, WafInvalidAccountException, WafNonexistentItemException, AwsServiceException, SdkClientException, WafException
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
.
This is a convenience which creates an instance of the GetRegexPatternSetRequest.Builder
avoiding the
need to create one manually via GetRegexPatternSetRequest.builder()
getRegexPatternSetRequest
- A Consumer
that will call methods on GetRegexPatternSetRequest.Builder
to create a
request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default GetRuleResponse getRule(GetRuleRequest getRuleRequest) throws WafInternalErrorException, WafInvalidAccountException, WafNonexistentItemException, AwsServiceException, SdkClientException, WafException
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.
getRuleRequest
- 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default GetRuleResponse getRule(Consumer<GetRuleRequest.Builder> getRuleRequest) throws WafInternalErrorException, WafInvalidAccountException, WafNonexistentItemException, AwsServiceException, SdkClientException, WafException
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.
This is a convenience which creates an instance of the GetRuleRequest.Builder
avoiding the need to create
one manually via GetRuleRequest.builder()
getRuleRequest
- A Consumer
that will call methods on GetRuleRequest.Builder
to create a request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default GetRuleGroupResponse getRuleGroup(GetRuleGroupRequest getRuleGroupRequest) throws WafInternalErrorException, WafNonexistentItemException, AwsServiceException, SdkClientException, WafException
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.
getRuleGroupRequest
- 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default GetRuleGroupResponse getRuleGroup(Consumer<GetRuleGroupRequest.Builder> getRuleGroupRequest) throws WafInternalErrorException, WafNonexistentItemException, AwsServiceException, SdkClientException, WafException
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.
This is a convenience which creates an instance of the GetRuleGroupRequest.Builder
avoiding the need to
create one manually via GetRuleGroupRequest.builder()
getRuleGroupRequest
- A Consumer
that will call methods on GetRuleGroupRequest.Builder
to create a request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default GetSampledRequestsResponse getSampledRequests(GetSampledRequestsRequest getSampledRequestsRequest) throws WafNonexistentItemException, WafInternalErrorException, AwsServiceException, SdkClientException, WafException
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.
getSampledRequestsRequest
- 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default GetSampledRequestsResponse getSampledRequests(Consumer<GetSampledRequestsRequest.Builder> getSampledRequestsRequest) throws WafNonexistentItemException, WafInternalErrorException, AwsServiceException, SdkClientException, WafException
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.
This is a convenience which creates an instance of the GetSampledRequestsRequest.Builder
avoiding the
need to create one manually via GetSampledRequestsRequest.builder()
getSampledRequestsRequest
- A Consumer
that will call methods on GetSampledRequestsRequest.Builder
to create a
request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default GetSizeConstraintSetResponse getSizeConstraintSet(GetSizeConstraintSetRequest getSizeConstraintSetRequest) throws WafInternalErrorException, WafInvalidAccountException, WafNonexistentItemException, AwsServiceException, SdkClientException, WafException
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
.
getSizeConstraintSetRequest
- 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default GetSizeConstraintSetResponse getSizeConstraintSet(Consumer<GetSizeConstraintSetRequest.Builder> getSizeConstraintSetRequest) throws WafInternalErrorException, WafInvalidAccountException, WafNonexistentItemException, AwsServiceException, SdkClientException, WafException
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
.
This is a convenience which creates an instance of the GetSizeConstraintSetRequest.Builder
avoiding the
need to create one manually via GetSizeConstraintSetRequest.builder()
getSizeConstraintSetRequest
- A Consumer
that will call methods on GetSizeConstraintSetRequest.Builder
to create a
request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default GetSqlInjectionMatchSetResponse getSqlInjectionMatchSet(GetSqlInjectionMatchSetRequest getSqlInjectionMatchSetRequest) throws WafInternalErrorException, WafInvalidAccountException, WafNonexistentItemException, AwsServiceException, SdkClientException, WafException
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
.
getSqlInjectionMatchSetRequest
- A request to get a SqlInjectionMatchSet.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default GetSqlInjectionMatchSetResponse getSqlInjectionMatchSet(Consumer<GetSqlInjectionMatchSetRequest.Builder> getSqlInjectionMatchSetRequest) throws WafInternalErrorException, WafInvalidAccountException, WafNonexistentItemException, AwsServiceException, SdkClientException, WafException
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
.
This is a convenience which creates an instance of the GetSqlInjectionMatchSetRequest.Builder
avoiding
the need to create one manually via GetSqlInjectionMatchSetRequest.builder()
getSqlInjectionMatchSetRequest
- A Consumer
that will call methods on GetSqlInjectionMatchSetRequest.Builder
to create a
request. A request to get a SqlInjectionMatchSet.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default GetWebAclResponse getWebACL(GetWebAclRequest getWebAclRequest) throws WafInternalErrorException, WafInvalidAccountException, WafNonexistentItemException, AwsServiceException, SdkClientException, WafException
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
.
getWebAclRequest
- 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default GetWebAclResponse getWebACL(Consumer<GetWebAclRequest.Builder> getWebAclRequest) throws WafInternalErrorException, WafInvalidAccountException, WafNonexistentItemException, AwsServiceException, SdkClientException, WafException
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
.
This is a convenience which creates an instance of the GetWebAclRequest.Builder
avoiding the need to
create one manually via GetWebAclRequest.builder()
getWebAclRequest
- A Consumer
that will call methods on GetWebACLRequest.Builder
to create a request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default GetWebAclForResourceResponse getWebACLForResource(GetWebAclForResourceRequest getWebAclForResourceRequest) throws WafInternalErrorException, WafInvalidAccountException, WafNonexistentItemException, WafInvalidParameterException, WafUnavailableEntityException, AwsServiceException, SdkClientException, WafException
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.
getWebAclForResourceRequest
- 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default GetWebAclForResourceResponse getWebACLForResource(Consumer<GetWebAclForResourceRequest.Builder> getWebAclForResourceRequest) throws WafInternalErrorException, WafInvalidAccountException, WafNonexistentItemException, WafInvalidParameterException, WafUnavailableEntityException, AwsServiceException, SdkClientException, WafException
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.
This is a convenience which creates an instance of the GetWebAclForResourceRequest.Builder
avoiding the
need to create one manually via GetWebAclForResourceRequest.builder()
getWebAclForResourceRequest
- A Consumer
that will call methods on GetWebACLForResourceRequest.Builder
to create a
request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default GetXssMatchSetResponse getXssMatchSet(GetXssMatchSetRequest getXssMatchSetRequest) throws WafInternalErrorException, WafInvalidAccountException, WafNonexistentItemException, AwsServiceException, SdkClientException, WafException
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
.
getXssMatchSetRequest
- A request to get an XssMatchSet.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default GetXssMatchSetResponse getXssMatchSet(Consumer<GetXssMatchSetRequest.Builder> getXssMatchSetRequest) throws WafInternalErrorException, WafInvalidAccountException, WafNonexistentItemException, AwsServiceException, SdkClientException, WafException
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
.
This is a convenience which creates an instance of the GetXssMatchSetRequest.Builder
avoiding the need to
create one manually via GetXssMatchSetRequest.builder()
getXssMatchSetRequest
- A Consumer
that will call methods on GetXssMatchSetRequest.Builder
to create a request. A
request to get an XssMatchSet.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default ListActivatedRulesInRuleGroupResponse listActivatedRulesInRuleGroup(ListActivatedRulesInRuleGroupRequest listActivatedRulesInRuleGroupRequest) throws WafInternalErrorException, WafNonexistentItemException, WafInvalidParameterException, AwsServiceException, SdkClientException, WafException
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.
listActivatedRulesInRuleGroupRequest
- 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.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default ListActivatedRulesInRuleGroupResponse listActivatedRulesInRuleGroup(Consumer<ListActivatedRulesInRuleGroupRequest.Builder> listActivatedRulesInRuleGroupRequest) throws WafInternalErrorException, WafNonexistentItemException, WafInvalidParameterException, AwsServiceException, SdkClientException, WafException
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.
This is a convenience which creates an instance of the ListActivatedRulesInRuleGroupRequest.Builder
avoiding the need to create one manually via ListActivatedRulesInRuleGroupRequest.builder()
listActivatedRulesInRuleGroupRequest
- A Consumer
that will call methods on ListActivatedRulesInRuleGroupRequest.Builder
to
create a request.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.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default ListByteMatchSetsResponse listByteMatchSets() throws WafInternalErrorException, WafInvalidAccountException, AwsServiceException, SdkClientException, WafException
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.
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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
listByteMatchSets(ListByteMatchSetsRequest)
,
AWS API Documentationdefault ListByteMatchSetsResponse listByteMatchSets(ListByteMatchSetsRequest listByteMatchSetsRequest) throws WafInternalErrorException, WafInvalidAccountException, AwsServiceException, SdkClientException, WafException
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.
listByteMatchSetsRequest
- 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default ListByteMatchSetsResponse listByteMatchSets(Consumer<ListByteMatchSetsRequest.Builder> listByteMatchSetsRequest) throws WafInternalErrorException, WafInvalidAccountException, AwsServiceException, SdkClientException, WafException
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.
This is a convenience which creates an instance of the ListByteMatchSetsRequest.Builder
avoiding the need
to create one manually via ListByteMatchSetsRequest.builder()
listByteMatchSetsRequest
- A Consumer
that will call methods on ListByteMatchSetsRequest.Builder
to create a request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default ListGeoMatchSetsResponse listGeoMatchSets() throws WafInternalErrorException, WafInvalidAccountException, AwsServiceException, SdkClientException, WafException
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.
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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
listGeoMatchSets(ListGeoMatchSetsRequest)
,
AWS
API Documentationdefault ListGeoMatchSetsResponse listGeoMatchSets(ListGeoMatchSetsRequest listGeoMatchSetsRequest) throws WafInternalErrorException, WafInvalidAccountException, AwsServiceException, SdkClientException, WafException
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.
listGeoMatchSetsRequest
- 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default ListGeoMatchSetsResponse listGeoMatchSets(Consumer<ListGeoMatchSetsRequest.Builder> listGeoMatchSetsRequest) throws WafInternalErrorException, WafInvalidAccountException, AwsServiceException, SdkClientException, WafException
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.
This is a convenience which creates an instance of the ListGeoMatchSetsRequest.Builder
avoiding the need
to create one manually via ListGeoMatchSetsRequest.builder()
listGeoMatchSetsRequest
- A Consumer
that will call methods on ListGeoMatchSetsRequest.Builder
to create a request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default ListIpSetsResponse listIPSets() throws WafInternalErrorException, WafInvalidAccountException, AwsServiceException, SdkClientException, WafException
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.
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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
listIPSets(ListIpSetsRequest)
,
AWS API
Documentationdefault ListIpSetsResponse listIPSets(ListIpSetsRequest listIpSetsRequest) throws WafInternalErrorException, WafInvalidAccountException, AwsServiceException, SdkClientException, WafException
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.
listIpSetsRequest
- 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default ListIpSetsResponse listIPSets(Consumer<ListIpSetsRequest.Builder> listIpSetsRequest) throws WafInternalErrorException, WafInvalidAccountException, AwsServiceException, SdkClientException, WafException
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.
This is a convenience which creates an instance of the ListIpSetsRequest.Builder
avoiding the need to
create one manually via ListIpSetsRequest.builder()
listIpSetsRequest
- A Consumer
that will call methods on ListIPSetsRequest.Builder
to create a request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default ListLoggingConfigurationsResponse listLoggingConfigurations(ListLoggingConfigurationsRequest listLoggingConfigurationsRequest) throws WafInternalErrorException, WafNonexistentItemException, WafInvalidParameterException, AwsServiceException, SdkClientException, WafException
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 LoggingConfiguration objects.
listLoggingConfigurationsRequest
- 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.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default ListLoggingConfigurationsResponse listLoggingConfigurations(Consumer<ListLoggingConfigurationsRequest.Builder> listLoggingConfigurationsRequest) throws WafInternalErrorException, WafNonexistentItemException, WafInvalidParameterException, AwsServiceException, SdkClientException, WafException
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 LoggingConfiguration objects.
This is a convenience which creates an instance of the ListLoggingConfigurationsRequest.Builder
avoiding
the need to create one manually via ListLoggingConfigurationsRequest.builder()
listLoggingConfigurationsRequest
- A Consumer
that will call methods on ListLoggingConfigurationsRequest.Builder
to create a
request.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.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default ListRateBasedRulesResponse listRateBasedRules() throws WafInternalErrorException, WafInvalidAccountException, AwsServiceException, SdkClientException, WafException
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 RuleSummary objects.
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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
listRateBasedRules(ListRateBasedRulesRequest)
,
AWS API Documentationdefault ListRateBasedRulesResponse listRateBasedRules(ListRateBasedRulesRequest listRateBasedRulesRequest) throws WafInternalErrorException, WafInvalidAccountException, AwsServiceException, SdkClientException, WafException
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 RuleSummary objects.
listRateBasedRulesRequest
- 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default ListRateBasedRulesResponse listRateBasedRules(Consumer<ListRateBasedRulesRequest.Builder> listRateBasedRulesRequest) throws WafInternalErrorException, WafInvalidAccountException, AwsServiceException, SdkClientException, WafException
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 RuleSummary objects.
This is a convenience which creates an instance of the ListRateBasedRulesRequest.Builder
avoiding the
need to create one manually via ListRateBasedRulesRequest.builder()
listRateBasedRulesRequest
- A Consumer
that will call methods on ListRateBasedRulesRequest.Builder
to create a
request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default ListRegexMatchSetsResponse listRegexMatchSets() throws WafInternalErrorException, WafInvalidAccountException, AwsServiceException, SdkClientException, WafException
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 RegexMatchSetSummary objects.
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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
listRegexMatchSets(ListRegexMatchSetsRequest)
,
AWS API Documentationdefault ListRegexMatchSetsResponse listRegexMatchSets(ListRegexMatchSetsRequest listRegexMatchSetsRequest) throws WafInternalErrorException, WafInvalidAccountException, AwsServiceException, SdkClientException, WafException
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 RegexMatchSetSummary objects.
listRegexMatchSetsRequest
- 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default ListRegexMatchSetsResponse listRegexMatchSets(Consumer<ListRegexMatchSetsRequest.Builder> listRegexMatchSetsRequest) throws WafInternalErrorException, WafInvalidAccountException, AwsServiceException, SdkClientException, WafException
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 RegexMatchSetSummary objects.
This is a convenience which creates an instance of the ListRegexMatchSetsRequest.Builder
avoiding the
need to create one manually via ListRegexMatchSetsRequest.builder()
listRegexMatchSetsRequest
- A Consumer
that will call methods on ListRegexMatchSetsRequest.Builder
to create a
request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default ListRegexPatternSetsResponse listRegexPatternSets() throws WafInternalErrorException, WafInvalidAccountException, AwsServiceException, SdkClientException, WafException
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 RegexPatternSetSummary objects.
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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
listRegexPatternSets(ListRegexPatternSetsRequest)
,
AWS API Documentationdefault ListRegexPatternSetsResponse listRegexPatternSets(ListRegexPatternSetsRequest listRegexPatternSetsRequest) throws WafInternalErrorException, WafInvalidAccountException, AwsServiceException, SdkClientException, WafException
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 RegexPatternSetSummary objects.
listRegexPatternSetsRequest
- 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException