C# Class Amazon.WAFRegional.AmazonWAFRegionalClient

Implementation for accessing WAFRegional This is the AWS WAF Regional API Reference for using AWS WAF with Elastic Load Balancing (ELB) Application Load Balancers. The AWS WAF actions and data types listed in the reference are available for protecting Application Load Balancers. 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 API actions, data types, and errors. For detailed information about AWS WAF features and an overview of how to use the AWS WAF API, see the AWS WAF Developer Guide.
Inheritance: AmazonServiceClient, IAmazonWAFRegional
ファイルを表示 Open project: aws/aws-sdk-net

Public Methods

Method Description
AmazonWAFRegionalClient ( ) : System

Constructs AmazonWAFRegionalClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration>

AmazonWAFRegionalClient ( AWSCredentials credentials ) : System

Constructs AmazonWAFRegionalClient with AWS Credentials

AmazonWAFRegionalClient ( AWSCredentials credentials, AmazonWAFRegionalConfig clientConfig ) : System

Constructs AmazonWAFRegionalClient with AWS Credentials and an AmazonWAFRegionalClient Configuration object.

AmazonWAFRegionalClient ( AWSCredentials credentials, RegionEndpoint region ) : System

Constructs AmazonWAFRegionalClient with AWS Credentials

AmazonWAFRegionalClient ( AmazonWAFRegionalConfig config ) : System

Constructs AmazonWAFRegionalClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration>

AmazonWAFRegionalClient ( RegionEndpoint region ) : System

Constructs AmazonWAFRegionalClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration>

AmazonWAFRegionalClient ( string awsAccessKeyId, string awsSecretAccessKey ) : System

Constructs AmazonWAFRegionalClient with AWS Access Key ID and AWS Secret Key

AmazonWAFRegionalClient ( string awsAccessKeyId, string awsSecretAccessKey, AmazonWAFRegionalConfig clientConfig ) : System

Constructs AmazonWAFRegionalClient with AWS Access Key ID, AWS Secret Key and an AmazonWAFRegionalClient Configuration object.

AmazonWAFRegionalClient ( string awsAccessKeyId, string awsSecretAccessKey, RegionEndpoint region ) : System

Constructs AmazonWAFRegionalClient with AWS Access Key ID and AWS Secret Key

AmazonWAFRegionalClient ( string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken ) : System

Constructs AmazonWAFRegionalClient with AWS Access Key ID and AWS Secret Key

AmazonWAFRegionalClient ( string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken, AmazonWAFRegionalConfig clientConfig ) : System

Constructs AmazonWAFRegionalClient with AWS Access Key ID, AWS Secret Key and an AmazonWAFRegionalClient Configuration object.

AmazonWAFRegionalClient ( string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken, RegionEndpoint region ) : System

Constructs AmazonWAFRegionalClient with AWS Access Key ID and AWS Secret Key

AssociateWebACL ( AssociateWebACLRequest request ) : AssociateWebACLResponse

Associates a web ACL with a resource.

AssociateWebACLAsync ( AssociateWebACLRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the AssociateWebACL operation.

BeginAssociateWebACL ( AssociateWebACLRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the AssociateWebACL operation.

BeginCreateByteMatchSet ( CreateByteMatchSetRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the CreateByteMatchSet operation.

BeginCreateIPSet ( CreateIPSetRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the CreateIPSet operation.

BeginCreateRule ( CreateRuleRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the CreateRule operation.

BeginCreateSizeConstraintSet ( CreateSizeConstraintSetRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the CreateSizeConstraintSet operation.

BeginCreateSqlInjectionMatchSet ( CreateSqlInjectionMatchSetRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the CreateSqlInjectionMatchSet operation.

BeginCreateWebACL ( CreateWebACLRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the CreateWebACL operation.

BeginCreateXssMatchSet ( CreateXssMatchSetRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the CreateXssMatchSet operation.

BeginDeleteByteMatchSet ( DeleteByteMatchSetRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the DeleteByteMatchSet operation.

BeginDeleteIPSet ( DeleteIPSetRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the DeleteIPSet operation.

BeginDeleteRule ( DeleteRuleRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the DeleteRule operation.

BeginDeleteSizeConstraintSet ( DeleteSizeConstraintSetRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the DeleteSizeConstraintSet operation.

BeginDeleteSqlInjectionMatchSet ( DeleteSqlInjectionMatchSetRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the DeleteSqlInjectionMatchSet operation.

BeginDeleteWebACL ( DeleteWebACLRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the DeleteWebACL operation.

BeginDeleteXssMatchSet ( DeleteXssMatchSetRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the DeleteXssMatchSet operation.

BeginDisassociateWebACL ( DisassociateWebACLRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the DisassociateWebACL operation.

BeginGetByteMatchSet ( GetByteMatchSetRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the GetByteMatchSet operation.

BeginGetChangeToken ( GetChangeTokenRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the GetChangeToken operation.

BeginGetChangeTokenStatus ( GetChangeTokenStatusRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the GetChangeTokenStatus operation.

BeginGetIPSet ( GetIPSetRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the GetIPSet operation.

BeginGetRule ( GetRuleRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the GetRule operation.

BeginGetSampledRequests ( GetSampledRequestsRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the GetSampledRequests operation.

BeginGetSizeConstraintSet ( GetSizeConstraintSetRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the GetSizeConstraintSet operation.

BeginGetSqlInjectionMatchSet ( GetSqlInjectionMatchSetRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the GetSqlInjectionMatchSet operation.

BeginGetWebACL ( GetWebACLRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the GetWebACL operation.

BeginGetWebACLForResource ( GetWebACLForResourceRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the GetWebACLForResource operation.

BeginGetXssMatchSet ( GetXssMatchSetRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the GetXssMatchSet operation.

BeginListByteMatchSets ( ListByteMatchSetsRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the ListByteMatchSets operation.

BeginListIPSets ( ListIPSetsRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the ListIPSets operation.

BeginListResourcesForWebACL ( ListResourcesForWebACLRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the ListResourcesForWebACL operation.

BeginListRules ( ListRulesRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the ListRules operation.

BeginListSizeConstraintSets ( ListSizeConstraintSetsRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the ListSizeConstraintSets operation.

BeginListSqlInjectionMatchSets ( ListSqlInjectionMatchSetsRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the ListSqlInjectionMatchSets operation.

BeginListWebACLs ( ListWebACLsRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the ListWebACLs operation.

BeginListXssMatchSets ( ListXssMatchSetsRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the ListXssMatchSets operation.

BeginUpdateByteMatchSet ( UpdateByteMatchSetRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the UpdateByteMatchSet operation.

BeginUpdateIPSet ( UpdateIPSetRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the UpdateIPSet operation.

BeginUpdateRule ( UpdateRuleRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the UpdateRule operation.

BeginUpdateSizeConstraintSet ( UpdateSizeConstraintSetRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the UpdateSizeConstraintSet operation.

BeginUpdateSqlInjectionMatchSet ( UpdateSqlInjectionMatchSetRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the UpdateSqlInjectionMatchSet operation.

BeginUpdateWebACL ( UpdateWebACLRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the UpdateWebACL operation.

BeginUpdateXssMatchSet ( UpdateXssMatchSetRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the UpdateXssMatchSet operation.

CreateByteMatchSet ( CreateByteMatchSetRequest request ) : CreateByteMatchSetResponse

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

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

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

  2. Submit a CreateByteMatchSet request.

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

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

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

CreateByteMatchSet ( string name, string changeToken ) : CreateByteMatchSetResponse

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

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

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

  2. Submit a CreateByteMatchSet request.

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

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

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

CreateByteMatchSetAsync ( CreateByteMatchSetRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the CreateByteMatchSet operation.

CreateByteMatchSetAsync ( string name, string changeToken, System cancellationToken = default(CancellationToken) ) : Task

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

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

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

  2. Submit a CreateByteMatchSet request.

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

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

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

CreateIPSet ( CreateIPSetRequest request ) : CreateIPSetResponse

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

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

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

  2. Submit a CreateIPSet request.

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

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

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

CreateIPSet ( string name, string changeToken ) : CreateIPSetResponse

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

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

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

  2. Submit a CreateIPSet request.

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

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

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

CreateIPSetAsync ( CreateIPSetRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the CreateIPSet operation.

CreateIPSetAsync ( string name, string changeToken, System cancellationToken = default(CancellationToken) ) : Task

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

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

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

  2. Submit a CreateIPSet request.

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

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

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

CreateRule ( CreateRuleRequest request ) : CreateRuleResponse

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 you add the following to a Rule:

  • An IPSet that matches the IP address 192.0.2.44/32

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

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

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

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

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

  3. Submit a CreateRule request.

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

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

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

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

CreateRule ( string name, string changeToken, string metricName ) : CreateRuleResponse

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 you add the following to a Rule:

  • An IPSet that matches the IP address 192.0.2.44/32

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

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

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

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

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

  3. Submit a CreateRule request.

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

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

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

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

CreateRuleAsync ( CreateRuleRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the CreateRule operation.

CreateRuleAsync ( string name, string changeToken, string metricName, System cancellationToken = default(CancellationToken) ) : Task

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 you add the following to a Rule:

  • An IPSet that matches the IP address 192.0.2.44/32

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

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

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

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

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

  3. Submit a CreateRule request.

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

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

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

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

CreateSizeConstraintSet ( CreateSizeConstraintSetRequest request ) : CreateSizeConstraintSetResponse

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

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

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

  2. Submit a CreateSizeConstraintSet request.

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

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

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

CreateSizeConstraintSetAsync ( CreateSizeConstraintSetRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the CreateSizeConstraintSet operation.

CreateSqlInjectionMatchSet ( CreateSqlInjectionMatchSetRequest request ) : CreateSqlInjectionMatchSetResponse

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

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

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

  2. Submit a CreateSqlInjectionMatchSet request.

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

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

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

CreateSqlInjectionMatchSet ( string name, string changeToken ) : CreateSqlInjectionMatchSetResponse

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

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

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

  2. Submit a CreateSqlInjectionMatchSet request.

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

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

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

CreateSqlInjectionMatchSetAsync ( CreateSqlInjectionMatchSetRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the CreateSqlInjectionMatchSet operation.

CreateSqlInjectionMatchSetAsync ( string name, string changeToken, System cancellationToken = default(CancellationToken) ) : Task

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

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

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

  2. Submit a CreateSqlInjectionMatchSet request.

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

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

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

CreateWebACL ( CreateWebACLRequest request ) : CreateWebACLResponse

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

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

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

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

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

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

  4. Submit a CreateWebACL request.

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

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

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

CreateWebACLAsync ( CreateWebACLRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the CreateWebACL operation.

CreateXssMatchSet ( CreateXssMatchSetRequest request ) : CreateXssMatchSetResponse

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

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

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

  2. Submit a CreateXssMatchSet request.

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

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

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

CreateXssMatchSetAsync ( CreateXssMatchSetRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the CreateXssMatchSet operation.

DeleteByteMatchSet ( DeleteByteMatchSetRequest request ) : DeleteByteMatchSetResponse

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

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

To permanently delete a ByteMatchSet, perform the following steps:

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

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

  3. Submit a DeleteByteMatchSet request.

DeleteByteMatchSet ( string byteMatchSetId, string changeToken ) : DeleteByteMatchSetResponse

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

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

To permanently delete a ByteMatchSet, perform the following steps:

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

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

  3. Submit a DeleteByteMatchSet request.

DeleteByteMatchSetAsync ( DeleteByteMatchSetRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the DeleteByteMatchSet operation.

DeleteByteMatchSetAsync ( string byteMatchSetId, string changeToken, System cancellationToken = default(CancellationToken) ) : Task

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

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

To permanently delete a ByteMatchSet, perform the following steps:

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

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

  3. Submit a DeleteByteMatchSet request.

DeleteIPSet ( DeleteIPSetRequest request ) : DeleteIPSetResponse

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

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

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

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

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

  3. Submit a DeleteIPSet request.

DeleteIPSet ( string ipSetId, string changeToken ) : DeleteIPSetResponse

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

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

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

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

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

  3. Submit a DeleteIPSet request.

DeleteIPSetAsync ( DeleteIPSetRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the DeleteIPSet operation.

DeleteIPSetAsync ( string ipSetId, string changeToken, System cancellationToken = default(CancellationToken) ) : Task

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

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

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

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

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

  3. Submit a DeleteIPSet request.

DeleteRule ( DeleteRuleRequest request ) : DeleteRuleResponse

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

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

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

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

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

  3. Submit a DeleteRule request.

DeleteRule ( string ruleId, string changeToken ) : DeleteRuleResponse

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

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

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

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

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

  3. Submit a DeleteRule request.

DeleteRuleAsync ( DeleteRuleRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the DeleteRule operation.

DeleteRuleAsync ( string ruleId, string changeToken, System cancellationToken = default(CancellationToken) ) : Task

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

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

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

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

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

  3. Submit a DeleteRule request.

DeleteSizeConstraintSet ( DeleteSizeConstraintSetRequest request ) : DeleteSizeConstraintSetResponse

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

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

To permanently delete a SizeConstraintSet, perform the following steps:

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

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

  3. Submit a DeleteSizeConstraintSet request.

DeleteSizeConstraintSetAsync ( DeleteSizeConstraintSetRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the DeleteSizeConstraintSet operation.

DeleteSqlInjectionMatchSet ( DeleteSqlInjectionMatchSetRequest request ) : DeleteSqlInjectionMatchSetResponse

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

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

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

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

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

  3. Submit a DeleteSqlInjectionMatchSet request.

DeleteSqlInjectionMatchSet ( string sqlInjectionMatchSetId, string changeToken ) : DeleteSqlInjectionMatchSetResponse

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

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

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

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

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

  3. Submit a DeleteSqlInjectionMatchSet request.

DeleteSqlInjectionMatchSetAsync ( DeleteSqlInjectionMatchSetRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the DeleteSqlInjectionMatchSet operation.

DeleteSqlInjectionMatchSetAsync ( string sqlInjectionMatchSetId, string changeToken, System cancellationToken = default(CancellationToken) ) : Task

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

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

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

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

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

  3. Submit a DeleteSqlInjectionMatchSet request.

DeleteWebACL ( DeleteWebACLRequest request ) : DeleteWebACLResponse

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

To delete a WebACL, perform the following steps:

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

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

  3. Submit a DeleteWebACL request.

DeleteWebACL ( string webACLId, string changeToken ) : DeleteWebACLResponse

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

To delete a WebACL, perform the following steps:

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

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

  3. Submit a DeleteWebACL request.

DeleteWebACLAsync ( DeleteWebACLRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the DeleteWebACL operation.

DeleteWebACLAsync ( string webACLId, string changeToken, System cancellationToken = default(CancellationToken) ) : Task

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

To delete a WebACL, perform the following steps:

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

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

  3. Submit a DeleteWebACL request.

DeleteXssMatchSet ( DeleteXssMatchSetRequest request ) : DeleteXssMatchSetResponse

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

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

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

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

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

  3. Submit a DeleteXssMatchSet request.

DeleteXssMatchSetAsync ( DeleteXssMatchSetRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the DeleteXssMatchSet operation.

DisassociateWebACL ( DisassociateWebACLRequest request ) : DisassociateWebACLResponse

Removes a web ACL from the specified resource.

DisassociateWebACLAsync ( DisassociateWebACLRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the DisassociateWebACL operation.

EndAssociateWebACL ( IAsyncResult asyncResult ) : AssociateWebACLResponse

Finishes the asynchronous execution of the AssociateWebACL operation.

EndCreateByteMatchSet ( IAsyncResult asyncResult ) : CreateByteMatchSetResponse

Finishes the asynchronous execution of the CreateByteMatchSet operation.

EndCreateIPSet ( IAsyncResult asyncResult ) : CreateIPSetResponse

Finishes the asynchronous execution of the CreateIPSet operation.

EndCreateRule ( IAsyncResult asyncResult ) : CreateRuleResponse

Finishes the asynchronous execution of the CreateRule operation.

EndCreateSizeConstraintSet ( IAsyncResult asyncResult ) : CreateSizeConstraintSetResponse

Finishes the asynchronous execution of the CreateSizeConstraintSet operation.

EndCreateSqlInjectionMatchSet ( IAsyncResult asyncResult ) : CreateSqlInjectionMatchSetResponse

Finishes the asynchronous execution of the CreateSqlInjectionMatchSet operation.

EndCreateWebACL ( IAsyncResult asyncResult ) : CreateWebACLResponse

Finishes the asynchronous execution of the CreateWebACL operation.

EndCreateXssMatchSet ( IAsyncResult asyncResult ) : CreateXssMatchSetResponse

Finishes the asynchronous execution of the CreateXssMatchSet operation.

EndDeleteByteMatchSet ( IAsyncResult asyncResult ) : DeleteByteMatchSetResponse

Finishes the asynchronous execution of the DeleteByteMatchSet operation.

EndDeleteIPSet ( IAsyncResult asyncResult ) : DeleteIPSetResponse

Finishes the asynchronous execution of the DeleteIPSet operation.

EndDeleteRule ( IAsyncResult asyncResult ) : DeleteRuleResponse

Finishes the asynchronous execution of the DeleteRule operation.

EndDeleteSizeConstraintSet ( IAsyncResult asyncResult ) : DeleteSizeConstraintSetResponse

Finishes the asynchronous execution of the DeleteSizeConstraintSet operation.

EndDeleteSqlInjectionMatchSet ( IAsyncResult asyncResult ) : DeleteSqlInjectionMatchSetResponse

Finishes the asynchronous execution of the DeleteSqlInjectionMatchSet operation.

EndDeleteWebACL ( IAsyncResult asyncResult ) : DeleteWebACLResponse

Finishes the asynchronous execution of the DeleteWebACL operation.

EndDeleteXssMatchSet ( IAsyncResult asyncResult ) : DeleteXssMatchSetResponse

Finishes the asynchronous execution of the DeleteXssMatchSet operation.

EndDisassociateWebACL ( IAsyncResult asyncResult ) : DisassociateWebACLResponse

Finishes the asynchronous execution of the DisassociateWebACL operation.

EndGetByteMatchSet ( IAsyncResult asyncResult ) : GetByteMatchSetResponse

Finishes the asynchronous execution of the GetByteMatchSet operation.

EndGetChangeToken ( IAsyncResult asyncResult ) : GetChangeTokenResponse

Finishes the asynchronous execution of the GetChangeToken operation.

EndGetChangeTokenStatus ( IAsyncResult asyncResult ) : GetChangeTokenStatusResponse

Finishes the asynchronous execution of the GetChangeTokenStatus operation.

EndGetIPSet ( IAsyncResult asyncResult ) : GetIPSetResponse

Finishes the asynchronous execution of the GetIPSet operation.

EndGetRule ( IAsyncResult asyncResult ) : GetRuleResponse

Finishes the asynchronous execution of the GetRule operation.

EndGetSampledRequests ( IAsyncResult asyncResult ) : GetSampledRequestsResponse

Finishes the asynchronous execution of the GetSampledRequests operation.

EndGetSizeConstraintSet ( IAsyncResult asyncResult ) : GetSizeConstraintSetResponse

Finishes the asynchronous execution of the GetSizeConstraintSet operation.

EndGetSqlInjectionMatchSet ( IAsyncResult asyncResult ) : GetSqlInjectionMatchSetResponse

Finishes the asynchronous execution of the GetSqlInjectionMatchSet operation.

EndGetWebACL ( IAsyncResult asyncResult ) : GetWebACLResponse

Finishes the asynchronous execution of the GetWebACL operation.

EndGetWebACLForResource ( IAsyncResult asyncResult ) : GetWebACLForResourceResponse

Finishes the asynchronous execution of the GetWebACLForResource operation.

EndGetXssMatchSet ( IAsyncResult asyncResult ) : GetXssMatchSetResponse

Finishes the asynchronous execution of the GetXssMatchSet operation.

EndListByteMatchSets ( IAsyncResult asyncResult ) : ListByteMatchSetsResponse

Finishes the asynchronous execution of the ListByteMatchSets operation.

EndListIPSets ( IAsyncResult asyncResult ) : ListIPSetsResponse

Finishes the asynchronous execution of the ListIPSets operation.

EndListResourcesForWebACL ( IAsyncResult asyncResult ) : ListResourcesForWebACLResponse

Finishes the asynchronous execution of the ListResourcesForWebACL operation.

EndListRules ( IAsyncResult asyncResult ) : ListRulesResponse

Finishes the asynchronous execution of the ListRules operation.

EndListSizeConstraintSets ( IAsyncResult asyncResult ) : ListSizeConstraintSetsResponse

Finishes the asynchronous execution of the ListSizeConstraintSets operation.

EndListSqlInjectionMatchSets ( IAsyncResult asyncResult ) : ListSqlInjectionMatchSetsResponse

Finishes the asynchronous execution of the ListSqlInjectionMatchSets operation.

EndListWebACLs ( IAsyncResult asyncResult ) : ListWebACLsResponse

Finishes the asynchronous execution of the ListWebACLs operation.

EndListXssMatchSets ( IAsyncResult asyncResult ) : ListXssMatchSetsResponse

Finishes the asynchronous execution of the ListXssMatchSets operation.

EndUpdateByteMatchSet ( IAsyncResult asyncResult ) : UpdateByteMatchSetResponse

Finishes the asynchronous execution of the UpdateByteMatchSet operation.

EndUpdateIPSet ( IAsyncResult asyncResult ) : UpdateIPSetResponse

Finishes the asynchronous execution of the UpdateIPSet operation.

EndUpdateRule ( IAsyncResult asyncResult ) : UpdateRuleResponse

Finishes the asynchronous execution of the UpdateRule operation.

EndUpdateSizeConstraintSet ( IAsyncResult asyncResult ) : UpdateSizeConstraintSetResponse

Finishes the asynchronous execution of the UpdateSizeConstraintSet operation.

EndUpdateSqlInjectionMatchSet ( IAsyncResult asyncResult ) : UpdateSqlInjectionMatchSetResponse

Finishes the asynchronous execution of the UpdateSqlInjectionMatchSet operation.

EndUpdateWebACL ( IAsyncResult asyncResult ) : UpdateWebACLResponse

Finishes the asynchronous execution of the UpdateWebACL operation.

EndUpdateXssMatchSet ( IAsyncResult asyncResult ) : UpdateXssMatchSetResponse

Finishes the asynchronous execution of the UpdateXssMatchSet operation.

GetByteMatchSet ( GetByteMatchSetRequest request ) : GetByteMatchSetResponse

Returns the ByteMatchSet specified by ByteMatchSetId.

GetByteMatchSet ( string byteMatchSetId ) : GetByteMatchSetResponse

Returns the ByteMatchSet specified by ByteMatchSetId.

GetByteMatchSetAsync ( GetByteMatchSetRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the GetByteMatchSet operation.

GetByteMatchSetAsync ( string byteMatchSetId, System cancellationToken = default(CancellationToken) ) : Task

Returns the ByteMatchSet specified by ByteMatchSetId.

GetChangeToken ( ) : GetChangeTokenResponse

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.

GetChangeToken ( GetChangeTokenRequest request ) : GetChangeTokenResponse

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.

GetChangeTokenAsync ( GetChangeTokenRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the GetChangeToken operation.

GetChangeTokenAsync ( System cancellationToken = default(CancellationToken) ) : Task

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.

GetChangeTokenStatus ( GetChangeTokenStatusRequest request ) : GetChangeTokenStatusResponse

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.

  • IN_SYNC: Propagation is complete.

GetChangeTokenStatus ( string changeToken ) : GetChangeTokenStatusResponse

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.

  • IN_SYNC: Propagation is complete.

GetChangeTokenStatusAsync ( GetChangeTokenStatusRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the GetChangeTokenStatus operation.

GetChangeTokenStatusAsync ( string changeToken, System cancellationToken = default(CancellationToken) ) : Task

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.

  • IN_SYNC: Propagation is complete.

GetIPSet ( GetIPSetRequest request ) : GetIPSetResponse

Returns the IPSet that is specified by IPSetId.

GetIPSet ( string ipSetId ) : GetIPSetResponse

Returns the IPSet that is specified by IPSetId.

GetIPSetAsync ( GetIPSetRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the GetIPSet operation.

GetIPSetAsync ( string ipSetId, System cancellationToken = default(CancellationToken) ) : Task

Returns the IPSet that is specified by IPSetId.

GetRule ( GetRuleRequest request ) : GetRuleResponse

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

GetRule ( string ruleId ) : GetRuleResponse

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

GetRuleAsync ( GetRuleRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the GetRule operation.

GetRuleAsync ( string ruleId, System cancellationToken = default(CancellationToken) ) : Task

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

GetSampledRequests ( GetSampledRequestsRequest request ) : GetSampledRequestsResponse

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

GetSampledRequestsAsync ( GetSampledRequestsRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the GetSampledRequests operation.

GetSizeConstraintSet ( GetSizeConstraintSetRequest request ) : GetSizeConstraintSetResponse

Returns the SizeConstraintSet specified by SizeConstraintSetId.

GetSizeConstraintSetAsync ( GetSizeConstraintSetRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the GetSizeConstraintSet operation.

GetSqlInjectionMatchSet ( GetSqlInjectionMatchSetRequest request ) : GetSqlInjectionMatchSetResponse

Returns the SqlInjectionMatchSet that is specified by SqlInjectionMatchSetId.

GetSqlInjectionMatchSet ( string sqlInjectionMatchSetId ) : GetSqlInjectionMatchSetResponse

Returns the SqlInjectionMatchSet that is specified by SqlInjectionMatchSetId.

GetSqlInjectionMatchSetAsync ( GetSqlInjectionMatchSetRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the GetSqlInjectionMatchSet operation.

GetSqlInjectionMatchSetAsync ( string sqlInjectionMatchSetId, System cancellationToken = default(CancellationToken) ) : Task

Returns the SqlInjectionMatchSet that is specified by SqlInjectionMatchSetId.

GetWebACL ( GetWebACLRequest request ) : GetWebACLResponse

Returns the WebACL that is specified by WebACLId.

GetWebACL ( string webACLId ) : GetWebACLResponse

Returns the WebACL that is specified by WebACLId.

GetWebACLAsync ( GetWebACLRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the GetWebACL operation.

GetWebACLAsync ( string webACLId, System cancellationToken = default(CancellationToken) ) : Task

Returns the WebACL that is specified by WebACLId.

GetWebACLForResource ( GetWebACLForResourceRequest request ) : GetWebACLForResourceResponse

Returns the web ACL for the specified resource.

GetWebACLForResourceAsync ( GetWebACLForResourceRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the GetWebACLForResource operation.

GetXssMatchSet ( GetXssMatchSetRequest request ) : GetXssMatchSetResponse

Returns the XssMatchSet that is specified by XssMatchSetId.

GetXssMatchSetAsync ( GetXssMatchSetRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the GetXssMatchSet operation.

ListByteMatchSets ( ListByteMatchSetsRequest request ) : ListByteMatchSetsResponse

Returns an array of ByteMatchSetSummary objects.

ListByteMatchSetsAsync ( ListByteMatchSetsRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the ListByteMatchSets operation.

ListIPSets ( ListIPSetsRequest request ) : ListIPSetsResponse

Returns an array of IPSetSummary objects in the response.

ListIPSetsAsync ( ListIPSetsRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the ListIPSets operation.

ListResourcesForWebACL ( ListResourcesForWebACLRequest request ) : ListResourcesForWebACLResponse

Returns an array of resources associated with the specified web ACL.

ListResourcesForWebACLAsync ( ListResourcesForWebACLRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the ListResourcesForWebACL operation.

ListRules ( ListRulesRequest request ) : ListRulesResponse

Returns an array of RuleSummary objects.

ListRulesAsync ( ListRulesRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the ListRules operation.

ListSizeConstraintSets ( ListSizeConstraintSetsRequest request ) : ListSizeConstraintSetsResponse

Returns an array of SizeConstraintSetSummary objects.

ListSizeConstraintSetsAsync ( ListSizeConstraintSetsRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the ListSizeConstraintSets operation.

ListSqlInjectionMatchSets ( ListSqlInjectionMatchSetsRequest request ) : ListSqlInjectionMatchSetsResponse

Returns an array of SqlInjectionMatchSet objects.

ListSqlInjectionMatchSetsAsync ( ListSqlInjectionMatchSetsRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the ListSqlInjectionMatchSets operation.

ListWebACLs ( ListWebACLsRequest request ) : ListWebACLsResponse

Returns an array of WebACLSummary objects in the response.

ListWebACLsAsync ( ListWebACLsRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the ListWebACLs operation.

ListXssMatchSets ( ListXssMatchSetsRequest request ) : ListXssMatchSetsResponse

Returns an array of XssMatchSet objects.

ListXssMatchSetsAsync ( ListXssMatchSetsRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the ListXssMatchSets operation.

UpdateByteMatchSet ( UpdateByteMatchSetRequest request ) : UpdateByteMatchSetResponse

Inserts or deletes ByteMatchTuple objects (filters) in a ByteMatchSet. For each ByteMatchTuple object, you specify the following values:

  • Whether to insert or delete the object from the array. If you want to change a ByteMatchSetUpdate object, you delete the existing object and add a new one.

  • The part of a web request that you want AWS WAF to inspect, such as a query string or the value of the User-Agent header.

  • The bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to look for. For more information, including how you specify the values for the AWS WAF API and the AWS CLI or SDKs, see TargetString in the ByteMatchTuple data type.

  • Where to look, such as at the beginning or the end of a query string.

  • Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for the specified string.

For example, you can add a ByteMatchSetUpdate object that matches web requests in which User-Agent headers contain the string BadBot. You can then configure AWS WAF to block those requests.

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

  1. Create a ByteMatchSet. For more information, see CreateByteMatchSet.

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

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

UpdateByteMatchSet ( string byteMatchSetId, List updates, string changeToken ) : UpdateByteMatchSetResponse

Inserts or deletes ByteMatchTuple objects (filters) in a ByteMatchSet. For each ByteMatchTuple object, you specify the following values:

  • Whether to insert or delete the object from the array. If you want to change a ByteMatchSetUpdate object, you delete the existing object and add a new one.

  • The part of a web request that you want AWS WAF to inspect, such as a query string or the value of the User-Agent header.

  • The bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to look for. For more information, including how you specify the values for the AWS WAF API and the AWS CLI or SDKs, see TargetString in the ByteMatchTuple data type.

  • Where to look, such as at the beginning or the end of a query string.

  • Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for the specified string.

For example, you can add a ByteMatchSetUpdate object that matches web requests in which User-Agent headers contain the string BadBot. You can then configure AWS WAF to block those requests.

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

  1. Create a ByteMatchSet. For more information, see CreateByteMatchSet.

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

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

UpdateByteMatchSetAsync ( UpdateByteMatchSetRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the UpdateByteMatchSet operation.

UpdateByteMatchSetAsync ( string byteMatchSetId, List updates, string changeToken, System cancellationToken = default(CancellationToken) ) : Task

Inserts or deletes ByteMatchTuple objects (filters) in a ByteMatchSet. For each ByteMatchTuple object, you specify the following values:

  • Whether to insert or delete the object from the array. If you want to change a ByteMatchSetUpdate object, you delete the existing object and add a new one.

  • The part of a web request that you want AWS WAF to inspect, such as a query string or the value of the User-Agent header.

  • The bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to look for. For more information, including how you specify the values for the AWS WAF API and the AWS CLI or SDKs, see TargetString in the ByteMatchTuple data type.

  • Where to look, such as at the beginning or the end of a query string.

  • Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for the specified string.

For example, you can add a ByteMatchSetUpdate object that matches web requests in which User-Agent headers contain the string BadBot. You can then configure AWS WAF to block those requests.

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

  1. Create a ByteMatchSet. For more information, see CreateByteMatchSet.

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

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

UpdateIPSet ( UpdateIPSetRequest request ) : UpdateIPSetResponse

Inserts or deletes IPSetDescriptor objects in an IPSet. For each IPSetDescriptor object, you specify the following values:

  • Whether to insert or delete the object from the array. If you want to change an IPSetDescriptor object, you delete the existing object and add a new one.

  • The IP address version, IPv4 or IPv6.

  • The IP address in CIDR notation, for example, 192.0.2.0/24 (for the range of IP addresses from 192.0.2.0 to 192.0.2.255) or 192.0.2.44/32 (for the individual IP address 192.0.2.44).

AWS WAF supports /8, /16, /24, and /32 IP address ranges for IPv4, and /24, /32, /48, /56, /64 and /128 for IPv6. For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.

IPv6 addresses can be represented using any of the following formats:

  • 1111:0000:0000:0000:0000:0000:0000:0111/128

  • 1111:0:0:0:0:0:0:0111/128

  • 1111::0111/128

  • 1111::111/128

You use an IPSet to specify which web requests you want to allow or block based on the IP addresses that the requests originated from. For example, if you're receiving a lot of requests from one or a small number of IP addresses and you want to block the requests, you can create an IPSet that specifies those IP addresses, and then configure AWS WAF to block the requests.

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

  1. Submit a CreateIPSet request.

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

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

When you update an IPSet, you specify the IP addresses that you want to add and/or the IP addresses that you want to delete. If you want to change an IP address, you delete the existing IP address and add the new one.

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

UpdateIPSet ( string ipSetId, List updates, string changeToken ) : UpdateIPSetResponse

Inserts or deletes IPSetDescriptor objects in an IPSet. For each IPSetDescriptor object, you specify the following values:

  • Whether to insert or delete the object from the array. If you want to change an IPSetDescriptor object, you delete the existing object and add a new one.

  • The IP address version, IPv4 or IPv6.

  • The IP address in CIDR notation, for example, 192.0.2.0/24 (for the range of IP addresses from 192.0.2.0 to 192.0.2.255) or 192.0.2.44/32 (for the individual IP address 192.0.2.44).

AWS WAF supports /8, /16, /24, and /32 IP address ranges for IPv4, and /24, /32, /48, /56, /64 and /128 for IPv6. For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.

IPv6 addresses can be represented using any of the following formats:

  • 1111:0000:0000:0000:0000:0000:0000:0111/128

  • 1111:0:0:0:0:0:0:0111/128

  • 1111::0111/128

  • 1111::111/128

You use an IPSet to specify which web requests you want to allow or block based on the IP addresses that the requests originated from. For example, if you're receiving a lot of requests from one or a small number of IP addresses and you want to block the requests, you can create an IPSet that specifies those IP addresses, and then configure AWS WAF to block the requests.

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

  1. Submit a CreateIPSet request.

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

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

When you update an IPSet, you specify the IP addresses that you want to add and/or the IP addresses that you want to delete. If you want to change an IP address, you delete the existing IP address and add the new one.

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

UpdateIPSetAsync ( UpdateIPSetRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the UpdateIPSet operation.

UpdateIPSetAsync ( string ipSetId, List updates, string changeToken, System cancellationToken = default(CancellationToken) ) : Task

Inserts or deletes IPSetDescriptor objects in an IPSet. For each IPSetDescriptor object, you specify the following values:

  • Whether to insert or delete the object from the array. If you want to change an IPSetDescriptor object, you delete the existing object and add a new one.

  • The IP address version, IPv4 or IPv6.

  • The IP address in CIDR notation, for example, 192.0.2.0/24 (for the range of IP addresses from 192.0.2.0 to 192.0.2.255) or 192.0.2.44/32 (for the individual IP address 192.0.2.44).

AWS WAF supports /8, /16, /24, and /32 IP address ranges for IPv4, and /24, /32, /48, /56, /64 and /128 for IPv6. For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.

IPv6 addresses can be represented using any of the following formats:

  • 1111:0000:0000:0000:0000:0000:0000:0111/128

  • 1111:0:0:0:0:0:0:0111/128

  • 1111::0111/128

  • 1111::111/128

You use an IPSet to specify which web requests you want to allow or block based on the IP addresses that the requests originated from. For example, if you're receiving a lot of requests from one or a small number of IP addresses and you want to block the requests, you can create an IPSet that specifies those IP addresses, and then configure AWS WAF to block the requests.

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

  1. Submit a CreateIPSet request.

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

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

When you update an IPSet, you specify the IP addresses that you want to add and/or the IP addresses that you want to delete. If you want to change an IP address, you delete the existing IP address and add the new one.

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

UpdateRule ( UpdateRuleRequest request ) : UpdateRuleResponse

Inserts or deletes Predicate objects in a Rule. Each Predicate object identifies a predicate, such as a ByteMatchSet or an IPSet, that specifies the web requests that you want to allow, block, or count. If you add more than one predicate to a Rule, a request must match all of the specifications to be allowed, blocked, or counted. For example, suppose you add the following to a Rule:

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

  • An IPSet that matches the IP address 192.0.2.44

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

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

  1. Create and update the predicates that you want to include in the Rule.

  2. Create the Rule. See CreateRule.

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

  4. Submit an UpdateRule request to add predicates to the Rule.

  5. Create and update a WebACL that contains the Rule. See CreateWebACL.

If you want to replace one ByteMatchSet or IPSet with another, you delete the existing one and add the new one.

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

UpdateRule ( string ruleId, List updates, string changeToken ) : UpdateRuleResponse

Inserts or deletes Predicate objects in a Rule. Each Predicate object identifies a predicate, such as a ByteMatchSet or an IPSet, that specifies the web requests that you want to allow, block, or count. If you add more than one predicate to a Rule, a request must match all of the specifications to be allowed, blocked, or counted. For example, suppose you add the following to a Rule:

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

  • An IPSet that matches the IP address 192.0.2.44

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

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

  1. Create and update the predicates that you want to include in the Rule.

  2. Create the Rule. See CreateRule.

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

  4. Submit an UpdateRule request to add predicates to the Rule.

  5. Create and update a WebACL that contains the Rule. See CreateWebACL.

If you want to replace one ByteMatchSet or IPSet with another, you delete the existing one and add the new one.

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

UpdateRuleAsync ( UpdateRuleRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the UpdateRule operation.

UpdateRuleAsync ( string ruleId, List updates, string changeToken, System cancellationToken = default(CancellationToken) ) : Task

Inserts or deletes Predicate objects in a Rule. Each Predicate object identifies a predicate, such as a ByteMatchSet or an IPSet, that specifies the web requests that you want to allow, block, or count. If you add more than one predicate to a Rule, a request must match all of the specifications to be allowed, blocked, or counted. For example, suppose you add the following to a Rule:

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

  • An IPSet that matches the IP address 192.0.2.44

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

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

  1. Create and update the predicates that you want to include in the Rule.

  2. Create the Rule. See CreateRule.

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

  4. Submit an UpdateRule request to add predicates to the Rule.

  5. Create and update a WebACL that contains the Rule. See CreateWebACL.

If you want to replace one ByteMatchSet or IPSet with another, you delete the existing one and add the new one.

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

UpdateSizeConstraintSet ( UpdateSizeConstraintSetRequest request ) : UpdateSizeConstraintSetResponse

Inserts or deletes SizeConstraint objects (filters) in a SizeConstraintSet. For each SizeConstraint object, you specify the following values:

  • Whether to insert or delete the object from the array. If you want to change a SizeConstraintSetUpdate object, you delete the existing object and add a new one.

  • The part of a web request that you want AWS WAF to evaluate, such as the length of a query string or the length of the User-Agent header.

  • Whether to perform any transformations on the request, such as converting it to lowercase, before checking its length. Note that transformations of the request body are not supported because the AWS resource forwards only the first 8192 bytes of your request to AWS WAF.

  • A ComparisonOperator used for evaluating the selected part of the request against the specified Size, such as equals, greater than, less than, and so on.

  • The length, in bytes, that you want AWS WAF to watch for in selected part of the request. The length is computed after applying the transformation.

For example, you can add a SizeConstraintSetUpdate object that matches web requests in which the length of the User-Agent header is greater than 100 bytes. You can then configure AWS WAF to block those requests.

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

  1. Create a SizeConstraintSet. For more information, see CreateSizeConstraintSet.

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

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

UpdateSizeConstraintSetAsync ( UpdateSizeConstraintSetRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the UpdateSizeConstraintSet operation.

UpdateSqlInjectionMatchSet ( UpdateSqlInjectionMatchSetRequest request ) : UpdateSqlInjectionMatchSetResponse

Inserts or deletes SqlInjectionMatchTuple objects (filters) in a SqlInjectionMatchSet. For each SqlInjectionMatchTuple object, you specify the following values:

  • Action: Whether to insert the object into or delete the object from the array. To change a SqlInjectionMatchTuple, you delete the existing object and add a new one.

  • FieldToMatch: The part of web requests that you want AWS WAF to inspect and, if you want AWS WAF to inspect a header, the name of the header.

  • TextTransformation: Which text transformation, if any, to perform on the web request before inspecting the request for snippets of malicious SQL code.

You use SqlInjectionMatchSet objects to specify which CloudFront requests you want to allow, block, or count. For example, if you're receiving requests that contain snippets of SQL code in the query string and you want to block the requests, you can create a SqlInjectionMatchSet with the applicable settings, and then configure AWS WAF to block the requests.

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

  1. Submit a CreateSqlInjectionMatchSet request.

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

  3. Submit an UpdateSqlInjectionMatchSet request to specify the parts of web requests that you want AWS WAF to inspect for snippets of 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.

UpdateSqlInjectionMatchSet ( string sqlInjectionMatchSetId, List updates, string changeToken ) : UpdateSqlInjectionMatchSetResponse

Inserts or deletes SqlInjectionMatchTuple objects (filters) in a SqlInjectionMatchSet. For each SqlInjectionMatchTuple object, you specify the following values:

  • Action: Whether to insert the object into or delete the object from the array. To change a SqlInjectionMatchTuple, you delete the existing object and add a new one.

  • FieldToMatch: The part of web requests that you want AWS WAF to inspect and, if you want AWS WAF to inspect a header, the name of the header.

  • TextTransformation: Which text transformation, if any, to perform on the web request before inspecting the request for snippets of malicious SQL code.

You use SqlInjectionMatchSet objects to specify which CloudFront requests you want to allow, block, or count. For example, if you're receiving requests that contain snippets of SQL code in the query string and you want to block the requests, you can create a SqlInjectionMatchSet with the applicable settings, and then configure AWS WAF to block the requests.

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

  1. Submit a CreateSqlInjectionMatchSet request.

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

  3. Submit an UpdateSqlInjectionMatchSet request to specify the parts of web requests that you want AWS WAF to inspect for snippets of 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.

UpdateSqlInjectionMatchSetAsync ( UpdateSqlInjectionMatchSetRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the UpdateSqlInjectionMatchSet operation.

UpdateSqlInjectionMatchSetAsync ( string sqlInjectionMatchSetId, List updates, string changeToken, System cancellationToken = default(CancellationToken) ) : Task

Inserts or deletes SqlInjectionMatchTuple objects (filters) in a SqlInjectionMatchSet. For each SqlInjectionMatchTuple object, you specify the following values:

  • Action: Whether to insert the object into or delete the object from the array. To change a SqlInjectionMatchTuple, you delete the existing object and add a new one.

  • FieldToMatch: The part of web requests that you want AWS WAF to inspect and, if you want AWS WAF to inspect a header, the name of the header.

  • TextTransformation: Which text transformation, if any, to perform on the web request before inspecting the request for snippets of malicious SQL code.

You use SqlInjectionMatchSet objects to specify which CloudFront requests you want to allow, block, or count. For example, if you're receiving requests that contain snippets of SQL code in the query string and you want to block the requests, you can create a SqlInjectionMatchSet with the applicable settings, and then configure AWS WAF to block the requests.

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

  1. Submit a CreateSqlInjectionMatchSet request.

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

  3. Submit an UpdateSqlInjectionMatchSet request to specify the parts of web requests that you want AWS WAF to inspect for snippets of 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.

UpdateWebACL ( UpdateWebACLRequest request ) : UpdateWebACLResponse

Inserts or deletes ActivatedRule objects in a WebACL. Each Rule identifies web requests that you want to allow, block, or count. When you update a WebACL, you specify the following values:

  • A default action for the WebACL, either ALLOW or BLOCK. AWS WAF performs the default action if a request doesn't match the criteria in any of the Rules in a WebACL.

  • The Rules that you want to add and/or delete. If you want to replace one Rule with another, you delete the existing Rule and add the new one.

  • For each Rule, whether you want AWS WAF to allow requests, block requests, or count requests that match the conditions in the Rule.

  • The order in which you want AWS WAF to evaluate the Rules in a WebACL. If you add more than one Rule to a WebACL, AWS WAF evaluates each request against the Rules in order based on the value of Priority. (The Rule that has the lowest value for Priority is evaluated first.) When a web request matches all of the predicates (such as ByteMatchSets and IPSets) in a Rule, AWS WAF immediately takes the corresponding action, allow or block, and doesn't evaluate the request against the remaining Rules in the WebACL, if any.

  • The CloudFront distribution that you want to associate with the WebACL.

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

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

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

  3. Create a WebACL. See CreateWebACL.

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

  5. 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 to allow or block HTTP requests, see the AWS WAF Developer Guide.

UpdateWebACLAsync ( UpdateWebACLRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the UpdateWebACL operation.

UpdateXssMatchSet ( UpdateXssMatchSetRequest request ) : UpdateXssMatchSetResponse

Inserts or deletes XssMatchTuple objects (filters) in an XssMatchSet. For each XssMatchTuple object, you specify the following values:

  • Action: Whether to insert the object into or delete the object from the array. To change a XssMatchTuple, you delete the existing object and add a new one.

  • FieldToMatch: The part of web requests that you want AWS WAF to inspect and, if you want AWS WAF to inspect a header, the name of the header.

  • TextTransformation: Which text transformation, if any, to perform on the web request before inspecting the request for cross-site scripting attacks.

You use XssMatchSet objects to specify which CloudFront requests you want to allow, block, or count. For example, if you're receiving requests that contain cross-site scripting attacks in the request body and you want to block the requests, you can create an XssMatchSet with the applicable settings, and then configure AWS WAF to block the requests.

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

  1. Submit a CreateXssMatchSet request.

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

  3. Submit an UpdateXssMatchSet request to specify the parts of web requests that you want AWS WAF to inspect for 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.

UpdateXssMatchSetAsync ( UpdateXssMatchSetRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the UpdateXssMatchSet operation.

Protected Methods

Method Description
CreateSigner ( ) : AbstractAWSSigner

Creates the signer for the service.

Dispose ( bool disposing ) : void

Disposes the service client.

Method Details

AmazonWAFRegionalClient() public method

Constructs AmazonWAFRegionalClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration>
public AmazonWAFRegionalClient ( ) : System
return System

AmazonWAFRegionalClient() public method

Constructs AmazonWAFRegionalClient with AWS Credentials
public AmazonWAFRegionalClient ( AWSCredentials credentials ) : System
credentials Amazon.Runtime.AWSCredentials AWS Credentials
return System

AmazonWAFRegionalClient() public method

Constructs AmazonWAFRegionalClient with AWS Credentials and an AmazonWAFRegionalClient Configuration object.
public AmazonWAFRegionalClient ( AWSCredentials credentials, AmazonWAFRegionalConfig clientConfig ) : System
credentials Amazon.Runtime.AWSCredentials AWS Credentials
clientConfig AmazonWAFRegionalConfig The AmazonWAFRegionalClient Configuration Object
return System

AmazonWAFRegionalClient() public method

Constructs AmazonWAFRegionalClient with AWS Credentials
public AmazonWAFRegionalClient ( AWSCredentials credentials, RegionEndpoint region ) : System
credentials Amazon.Runtime.AWSCredentials AWS Credentials
region RegionEndpoint The region to connect.
return System

AmazonWAFRegionalClient() public method

Constructs AmazonWAFRegionalClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration>
public AmazonWAFRegionalClient ( AmazonWAFRegionalConfig config ) : System
config AmazonWAFRegionalConfig The AmazonWAFRegionalClient Configuration Object
return System

AmazonWAFRegionalClient() public method

Constructs AmazonWAFRegionalClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration>
public AmazonWAFRegionalClient ( RegionEndpoint region ) : System
region RegionEndpoint The region to connect.
return System

AmazonWAFRegionalClient() public method

Constructs AmazonWAFRegionalClient with AWS Access Key ID and AWS Secret Key
public AmazonWAFRegionalClient ( string awsAccessKeyId, string awsSecretAccessKey ) : System
awsAccessKeyId string AWS Access Key ID
awsSecretAccessKey string AWS Secret Access Key
return System

AmazonWAFRegionalClient() public method

Constructs AmazonWAFRegionalClient with AWS Access Key ID, AWS Secret Key and an AmazonWAFRegionalClient Configuration object.
public AmazonWAFRegionalClient ( string awsAccessKeyId, string awsSecretAccessKey, AmazonWAFRegionalConfig clientConfig ) : System
awsAccessKeyId string AWS Access Key ID
awsSecretAccessKey string AWS Secret Access Key
clientConfig AmazonWAFRegionalConfig The AmazonWAFRegionalClient Configuration Object
return System

AmazonWAFRegionalClient() public method

Constructs AmazonWAFRegionalClient with AWS Access Key ID and AWS Secret Key
public AmazonWAFRegionalClient ( string awsAccessKeyId, string awsSecretAccessKey, RegionEndpoint region ) : System
awsAccessKeyId string AWS Access Key ID
awsSecretAccessKey string AWS Secret Access Key
region RegionEndpoint The region to connect.
return System

AmazonWAFRegionalClient() public method

Constructs AmazonWAFRegionalClient with AWS Access Key ID and AWS Secret Key
public AmazonWAFRegionalClient ( string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken ) : System
awsAccessKeyId string AWS Access Key ID
awsSecretAccessKey string AWS Secret Access Key
awsSessionToken string AWS Session Token
return System

AmazonWAFRegionalClient() public method

Constructs AmazonWAFRegionalClient with AWS Access Key ID, AWS Secret Key and an AmazonWAFRegionalClient Configuration object.
public AmazonWAFRegionalClient ( string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken, AmazonWAFRegionalConfig clientConfig ) : System
awsAccessKeyId string AWS Access Key ID
awsSecretAccessKey string AWS Secret Access Key
awsSessionToken string AWS Session Token
clientConfig AmazonWAFRegionalConfig The AmazonWAFRegionalClient Configuration Object
return System

AmazonWAFRegionalClient() public method

Constructs AmazonWAFRegionalClient with AWS Access Key ID and AWS Secret Key
public AmazonWAFRegionalClient ( string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken, RegionEndpoint region ) : System
awsAccessKeyId string AWS Access Key ID
awsSecretAccessKey string AWS Secret Access Key
awsSessionToken string AWS Session Token
region RegionEndpoint The region to connect.
return System

AssociateWebACL() public method

Associates a web ACL with a resource.
/// The operation failed because of a system problem, even though the request was valid. /// Retry your request. /// /// The operation failed because you tried to create, update, or delete an object by using /// an invalid account identifier. /// /// 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 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, QUERY_STRING, or URI. /// ///
  • /// /// 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. /// ///
/// /// The operation failed because the referenced object doesn't exist. /// /// The operation failed because the entity referenced is temporarily unavailable. Retry /// your request. ///
public AssociateWebACL ( AssociateWebACLRequest request ) : AssociateWebACLResponse
request Amazon.WAFRegional.Model.AssociateWebACLRequest Container for the necessary parameters to execute the AssociateWebACL service method.
return AssociateWebACLResponse

AssociateWebACLAsync() public method

Initiates the asynchronous execution of the AssociateWebACL operation.
public AssociateWebACLAsync ( AssociateWebACLRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.WAFRegional.Model.AssociateWebACLRequest Container for the necessary parameters to execute the AssociateWebACL operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

BeginAssociateWebACL() public method

Initiates the asynchronous execution of the AssociateWebACL operation.
public BeginAssociateWebACL ( AssociateWebACLRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.WAFRegional.Model.AssociateWebACLRequest Container for the necessary parameters to execute the AssociateWebACL operation on AmazonWAFRegionalClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginCreateByteMatchSet() public method

Initiates the asynchronous execution of the CreateByteMatchSet operation.
public BeginCreateByteMatchSet ( CreateByteMatchSetRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.WAFRegional.Model.CreateByteMatchSetRequest Container for the necessary parameters to execute the CreateByteMatchSet operation on AmazonWAFRegionalClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginCreateIPSet() public method

Initiates the asynchronous execution of the CreateIPSet operation.
public BeginCreateIPSet ( CreateIPSetRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.WAFRegional.Model.CreateIPSetRequest Container for the necessary parameters to execute the CreateIPSet operation on AmazonWAFRegionalClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginCreateRule() public method

Initiates the asynchronous execution of the CreateRule operation.
public BeginCreateRule ( CreateRuleRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.WAFRegional.Model.CreateRuleRequest Container for the necessary parameters to execute the CreateRule operation on AmazonWAFRegionalClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginCreateSizeConstraintSet() public method

Initiates the asynchronous execution of the CreateSizeConstraintSet operation.
public BeginCreateSizeConstraintSet ( CreateSizeConstraintSetRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.WAFRegional.Model.CreateSizeConstraintSetRequest Container for the necessary parameters to execute the CreateSizeConstraintSet operation on AmazonWAFRegionalClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginCreateSqlInjectionMatchSet() public method

Initiates the asynchronous execution of the CreateSqlInjectionMatchSet operation.
public BeginCreateSqlInjectionMatchSet ( CreateSqlInjectionMatchSetRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.WAFRegional.Model.CreateSqlInjectionMatchSetRequest Container for the necessary parameters to execute the CreateSqlInjectionMatchSet operation on AmazonWAFRegionalClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginCreateWebACL() public method

Initiates the asynchronous execution of the CreateWebACL operation.
public BeginCreateWebACL ( CreateWebACLRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.WAFRegional.Model.CreateWebACLRequest Container for the necessary parameters to execute the CreateWebACL operation on AmazonWAFRegionalClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginCreateXssMatchSet() public method

Initiates the asynchronous execution of the CreateXssMatchSet operation.
public BeginCreateXssMatchSet ( CreateXssMatchSetRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.WAFRegional.Model.CreateXssMatchSetRequest Container for the necessary parameters to execute the CreateXssMatchSet operation on AmazonWAFRegionalClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginDeleteByteMatchSet() public method

Initiates the asynchronous execution of the DeleteByteMatchSet operation.
public BeginDeleteByteMatchSet ( DeleteByteMatchSetRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.WAFRegional.Model.DeleteByteMatchSetRequest Container for the necessary parameters to execute the DeleteByteMatchSet operation on AmazonWAFRegionalClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginDeleteIPSet() public method

Initiates the asynchronous execution of the DeleteIPSet operation.
public BeginDeleteIPSet ( DeleteIPSetRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.WAFRegional.Model.DeleteIPSetRequest Container for the necessary parameters to execute the DeleteIPSet operation on AmazonWAFRegionalClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginDeleteRule() public method

Initiates the asynchronous execution of the DeleteRule operation.
public BeginDeleteRule ( DeleteRuleRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.WAFRegional.Model.DeleteRuleRequest Container for the necessary parameters to execute the DeleteRule operation on AmazonWAFRegionalClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginDeleteSizeConstraintSet() public method

Initiates the asynchronous execution of the DeleteSizeConstraintSet operation.
public BeginDeleteSizeConstraintSet ( DeleteSizeConstraintSetRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.WAFRegional.Model.DeleteSizeConstraintSetRequest Container for the necessary parameters to execute the DeleteSizeConstraintSet operation on AmazonWAFRegionalClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginDeleteSqlInjectionMatchSet() public method

Initiates the asynchronous execution of the DeleteSqlInjectionMatchSet operation.
public BeginDeleteSqlInjectionMatchSet ( DeleteSqlInjectionMatchSetRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.WAFRegional.Model.DeleteSqlInjectionMatchSetRequest Container for the necessary parameters to execute the DeleteSqlInjectionMatchSet operation on AmazonWAFRegionalClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginDeleteWebACL() public method

Initiates the asynchronous execution of the DeleteWebACL operation.
public BeginDeleteWebACL ( DeleteWebACLRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.WAFRegional.Model.DeleteWebACLRequest Container for the necessary parameters to execute the DeleteWebACL operation on AmazonWAFRegionalClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginDeleteXssMatchSet() public method

Initiates the asynchronous execution of the DeleteXssMatchSet operation.
public BeginDeleteXssMatchSet ( DeleteXssMatchSetRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.WAFRegional.Model.DeleteXssMatchSetRequest Container for the necessary parameters to execute the DeleteXssMatchSet operation on AmazonWAFRegionalClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginDisassociateWebACL() public method

Initiates the asynchronous execution of the DisassociateWebACL operation.
public BeginDisassociateWebACL ( DisassociateWebACLRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.WAFRegional.Model.DisassociateWebACLRequest Container for the necessary parameters to execute the DisassociateWebACL operation on AmazonWAFRegionalClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginGetByteMatchSet() public method

Initiates the asynchronous execution of the GetByteMatchSet operation.
public BeginGetByteMatchSet ( GetByteMatchSetRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.WAFRegional.Model.GetByteMatchSetRequest Container for the necessary parameters to execute the GetByteMatchSet operation on AmazonWAFRegionalClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginGetChangeToken() public method

Initiates the asynchronous execution of the GetChangeToken operation.
public BeginGetChangeToken ( GetChangeTokenRequest request, AsyncCallback callback, object state ) : IAsyncResult
request GetChangeTokenRequest Container for the necessary parameters to execute the GetChangeToken operation on AmazonWAFRegionalClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginGetChangeTokenStatus() public method

Initiates the asynchronous execution of the GetChangeTokenStatus operation.
public BeginGetChangeTokenStatus ( GetChangeTokenStatusRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.WAFRegional.Model.GetChangeTokenStatusRequest Container for the necessary parameters to execute the GetChangeTokenStatus operation on AmazonWAFRegionalClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginGetIPSet() public method

Initiates the asynchronous execution of the GetIPSet operation.
public BeginGetIPSet ( GetIPSetRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.WAFRegional.Model.GetIPSetRequest Container for the necessary parameters to execute the GetIPSet operation on AmazonWAFRegionalClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginGetRule() public method

Initiates the asynchronous execution of the GetRule operation.
public BeginGetRule ( GetRuleRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.WAFRegional.Model.GetRuleRequest Container for the necessary parameters to execute the GetRule operation on AmazonWAFRegionalClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginGetSampledRequests() public method

Initiates the asynchronous execution of the GetSampledRequests operation.
public BeginGetSampledRequests ( GetSampledRequestsRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.WAFRegional.Model.GetSampledRequestsRequest Container for the necessary parameters to execute the GetSampledRequests operation on AmazonWAFRegionalClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginGetSizeConstraintSet() public method

Initiates the asynchronous execution of the GetSizeConstraintSet operation.
public BeginGetSizeConstraintSet ( GetSizeConstraintSetRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.WAFRegional.Model.GetSizeConstraintSetRequest Container for the necessary parameters to execute the GetSizeConstraintSet operation on AmazonWAFRegionalClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginGetSqlInjectionMatchSet() public method

Initiates the asynchronous execution of the GetSqlInjectionMatchSet operation.
public BeginGetSqlInjectionMatchSet ( GetSqlInjectionMatchSetRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.WAFRegional.Model.GetSqlInjectionMatchSetRequest Container for the necessary parameters to execute the GetSqlInjectionMatchSet operation on AmazonWAFRegionalClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginGetWebACL() public method

Initiates the asynchronous execution of the GetWebACL operation.
public BeginGetWebACL ( GetWebACLRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.WAFRegional.Model.GetWebACLRequest Container for the necessary parameters to execute the GetWebACL operation on AmazonWAFRegionalClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginGetWebACLForResource() public method

Initiates the asynchronous execution of the GetWebACLForResource operation.
public BeginGetWebACLForResource ( GetWebACLForResourceRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.WAFRegional.Model.GetWebACLForResourceRequest Container for the necessary parameters to execute the GetWebACLForResource operation on AmazonWAFRegionalClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginGetXssMatchSet() public method

Initiates the asynchronous execution of the GetXssMatchSet operation.
public BeginGetXssMatchSet ( GetXssMatchSetRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.WAFRegional.Model.GetXssMatchSetRequest Container for the necessary parameters to execute the GetXssMatchSet operation on AmazonWAFRegionalClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginListByteMatchSets() public method

Initiates the asynchronous execution of the ListByteMatchSets operation.
public BeginListByteMatchSets ( ListByteMatchSetsRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.WAFRegional.Model.ListByteMatchSetsRequest Container for the necessary parameters to execute the ListByteMatchSets operation on AmazonWAFRegionalClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginListIPSets() public method

Initiates the asynchronous execution of the ListIPSets operation.
public BeginListIPSets ( ListIPSetsRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.WAFRegional.Model.ListIPSetsRequest Container for the necessary parameters to execute the ListIPSets operation on AmazonWAFRegionalClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginListResourcesForWebACL() public method

Initiates the asynchronous execution of the ListResourcesForWebACL operation.
public BeginListResourcesForWebACL ( ListResourcesForWebACLRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.WAFRegional.Model.ListResourcesForWebACLRequest Container for the necessary parameters to execute the ListResourcesForWebACL operation on AmazonWAFRegionalClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginListRules() public method

Initiates the asynchronous execution of the ListRules operation.
public BeginListRules ( ListRulesRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.WAFRegional.Model.ListRulesRequest Container for the necessary parameters to execute the ListRules operation on AmazonWAFRegionalClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginListSizeConstraintSets() public method

Initiates the asynchronous execution of the ListSizeConstraintSets operation.
public BeginListSizeConstraintSets ( ListSizeConstraintSetsRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.WAFRegional.Model.ListSizeConstraintSetsRequest Container for the necessary parameters to execute the ListSizeConstraintSets operation on AmazonWAFRegionalClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginListSqlInjectionMatchSets() public method

Initiates the asynchronous execution of the ListSqlInjectionMatchSets operation.
public BeginListSqlInjectionMatchSets ( ListSqlInjectionMatchSetsRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.WAFRegional.Model.ListSqlInjectionMatchSetsRequest Container for the necessary parameters to execute the ListSqlInjectionMatchSets operation on AmazonWAFRegionalClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginListWebACLs() public method

Initiates the asynchronous execution of the ListWebACLs operation.
public BeginListWebACLs ( ListWebACLsRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.WAFRegional.Model.ListWebACLsRequest Container for the necessary parameters to execute the ListWebACLs operation on AmazonWAFRegionalClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginListXssMatchSets() public method

Initiates the asynchronous execution of the ListXssMatchSets operation.
public BeginListXssMatchSets ( ListXssMatchSetsRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.WAFRegional.Model.ListXssMatchSetsRequest Container for the necessary parameters to execute the ListXssMatchSets operation on AmazonWAFRegionalClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginUpdateByteMatchSet() public method

Initiates the asynchronous execution of the UpdateByteMatchSet operation.
public BeginUpdateByteMatchSet ( UpdateByteMatchSetRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.WAFRegional.Model.UpdateByteMatchSetRequest Container for the necessary parameters to execute the UpdateByteMatchSet operation on AmazonWAFRegionalClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginUpdateIPSet() public method

Initiates the asynchronous execution of the UpdateIPSet operation.
public BeginUpdateIPSet ( UpdateIPSetRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.WAFRegional.Model.UpdateIPSetRequest Container for the necessary parameters to execute the UpdateIPSet operation on AmazonWAFRegionalClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginUpdateRule() public method

Initiates the asynchronous execution of the UpdateRule operation.
public BeginUpdateRule ( UpdateRuleRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.WAFRegional.Model.UpdateRuleRequest Container for the necessary parameters to execute the UpdateRule operation on AmazonWAFRegionalClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginUpdateSizeConstraintSet() public method

Initiates the asynchronous execution of the UpdateSizeConstraintSet operation.
public BeginUpdateSizeConstraintSet ( UpdateSizeConstraintSetRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.WAFRegional.Model.UpdateSizeConstraintSetRequest Container for the necessary parameters to execute the UpdateSizeConstraintSet operation on AmazonWAFRegionalClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginUpdateSqlInjectionMatchSet() public method

Initiates the asynchronous execution of the UpdateSqlInjectionMatchSet operation.
public BeginUpdateSqlInjectionMatchSet ( UpdateSqlInjectionMatchSetRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.WAFRegional.Model.UpdateSqlInjectionMatchSetRequest Container for the necessary parameters to execute the UpdateSqlInjectionMatchSet operation on AmazonWAFRegionalClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginUpdateWebACL() public method

Initiates the asynchronous execution of the UpdateWebACL operation.
public BeginUpdateWebACL ( UpdateWebACLRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.WAFRegional.Model.UpdateWebACLRequest Container for the necessary parameters to execute the UpdateWebACL operation on AmazonWAFRegionalClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginUpdateXssMatchSet() public method

Initiates the asynchronous execution of the UpdateXssMatchSet operation.
public BeginUpdateXssMatchSet ( UpdateXssMatchSetRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.WAFRegional.Model.UpdateXssMatchSetRequest Container for the necessary parameters to execute the UpdateXssMatchSet operation on AmazonWAFRegionalClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

CreateByteMatchSet() public method

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

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

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

  2. Submit a CreateByteMatchSet request.

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

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

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

/// The name specified is invalid. /// /// The operation failed because of a system problem, even though the request was valid. /// Retry your request. /// /// The operation failed because you tried to create, update, or delete an object by using /// an invalid account identifier. /// /// 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 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, QUERY_STRING, or URI. /// ///
  • /// /// 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. /// ///
/// /// 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. /// /// The operation failed because you tried to create, update, or delete an object by using /// a change token that has already been used. ///
public CreateByteMatchSet ( CreateByteMatchSetRequest request ) : CreateByteMatchSetResponse
request Amazon.WAFRegional.Model.CreateByteMatchSetRequest Container for the necessary parameters to execute the CreateByteMatchSet service method.
return Amazon.WAFRegional.Model.CreateByteMatchSetResponse

CreateByteMatchSet() public method

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

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

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

  2. Submit a CreateByteMatchSet request.

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

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

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

/// The name specified is invalid. /// /// The operation failed because of a system problem, even though the request was valid. /// Retry your request. /// /// The operation failed because you tried to create, update, or delete an object by using /// an invalid account identifier. /// /// 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 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, QUERY_STRING, or URI. /// ///
  • /// /// 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. /// ///
/// /// 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. /// /// The operation failed because you tried to create, update, or delete an object by using /// a change token that has already been used. ///
public CreateByteMatchSet ( string name, string changeToken ) : CreateByteMatchSetResponse
name string A friendly name or description of the ByteMatchSet. You can't change Name after you create a ByteMatchSet.
changeToken string The value returned by the most recent call to GetChangeToken.
return Amazon.WAFRegional.Model.CreateByteMatchSetResponse

CreateByteMatchSetAsync() public method

Initiates the asynchronous execution of the CreateByteMatchSet operation.
public CreateByteMatchSetAsync ( CreateByteMatchSetRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.WAFRegional.Model.CreateByteMatchSetRequest Container for the necessary parameters to execute the CreateByteMatchSet operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

CreateByteMatchSetAsync() public method

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

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

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

  2. Submit a CreateByteMatchSet request.

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

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

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

/// The name specified is invalid. /// /// The operation failed because of a system problem, even though the request was valid. /// Retry your request. /// /// The operation failed because you tried to create, update, or delete an object by using /// an invalid account identifier. /// /// 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 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, QUERY_STRING, or URI. /// ///
  • /// /// 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. /// ///
/// /// 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. /// /// The operation failed because you tried to create, update, or delete an object by using /// a change token that has already been used. ///
public CreateByteMatchSetAsync ( string name, string changeToken, System cancellationToken = default(CancellationToken) ) : Task
name string A friendly name or description of the ByteMatchSet. You can't change Name after you create a ByteMatchSet.
changeToken string The value returned by the most recent call to GetChangeToken.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

CreateIPSet() public method

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

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

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

  2. Submit a CreateIPSet request.

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

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

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

/// The name specified is invalid. /// /// The operation failed because of a system problem, even though the request was valid. /// Retry your request. /// /// The operation failed because you tried to create, update, or delete an object by using /// an invalid account identifier. /// /// 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 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, QUERY_STRING, or URI. /// ///
  • /// /// 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. /// ///
/// /// 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. /// /// The operation failed because you tried to create, update, or delete an object by using /// a change token that has already been used. ///
public CreateIPSet ( CreateIPSetRequest request ) : CreateIPSetResponse
request Amazon.WAFRegional.Model.CreateIPSetRequest Container for the necessary parameters to execute the CreateIPSet service method.
return Amazon.WAFRegional.Model.CreateIPSetResponse

CreateIPSet() public method

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

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

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

  2. Submit a CreateIPSet request.

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

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

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

/// The name specified is invalid. /// /// The operation failed because of a system problem, even though the request was valid. /// Retry your request. /// /// The operation failed because you tried to create, update, or delete an object by using /// an invalid account identifier. /// /// 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 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, QUERY_STRING, or URI. /// ///
  • /// /// 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. /// ///
/// /// 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. /// /// The operation failed because you tried to create, update, or delete an object by using /// a change token that has already been used. ///
public CreateIPSet ( string name, string changeToken ) : CreateIPSetResponse
name string A friendly name or description of the IPSet. You can't change Name after you create the IPSet.
changeToken string The value returned by the most recent call to GetChangeToken.
return Amazon.WAFRegional.Model.CreateIPSetResponse

CreateIPSetAsync() public method

Initiates the asynchronous execution of the CreateIPSet operation.
public CreateIPSetAsync ( CreateIPSetRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.WAFRegional.Model.CreateIPSetRequest Container for the necessary parameters to execute the CreateIPSet operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

CreateIPSetAsync() public method

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

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

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

  2. Submit a CreateIPSet request.

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

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

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

/// The name specified is invalid. /// /// The operation failed because of a system problem, even though the request was valid. /// Retry your request. /// /// The operation failed because you tried to create, update, or delete an object by using /// an invalid account identifier. /// /// 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 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, QUERY_STRING, or URI. /// ///
  • /// /// 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. /// ///
/// /// 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. /// /// The operation failed because you tried to create, update, or delete an object by using /// a change token that has already been used. ///
public CreateIPSetAsync ( string name, string changeToken, System cancellationToken = default(CancellationToken) ) : Task
name string A friendly name or description of the IPSet. You can't change Name after you create the IPSet.
changeToken string The value returned by the most recent call to GetChangeToken.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

CreateRule() public method

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 you add the following to a Rule:
  • An IPSet that matches the IP address 192.0.2.44/32

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

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

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

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

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

  3. Submit a CreateRule request.

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

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

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

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

/// The name specified is invalid. /// /// The operation failed because of a system problem, even though the request was valid. /// Retry your request. /// /// 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 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, QUERY_STRING, or URI. /// ///
  • /// /// 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. /// ///
/// /// 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. /// /// The operation failed because you tried to create, update, or delete an object by using /// a change token that has already been used. ///
public CreateRule ( CreateRuleRequest request ) : CreateRuleResponse
request Amazon.WAFRegional.Model.CreateRuleRequest Container for the necessary parameters to execute the CreateRule service method.
return Amazon.WAFRegional.Model.CreateRuleResponse

CreateRule() public method

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 you add the following to a Rule:
  • An IPSet that matches the IP address 192.0.2.44/32

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

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

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

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

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

  3. Submit a CreateRule request.

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

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

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

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

/// The name specified is invalid. /// /// The operation failed because of a system problem, even though the request was valid. /// Retry your request. /// /// 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 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, QUERY_STRING, or URI. /// ///
  • /// /// 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. /// ///
/// /// 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. /// /// The operation failed because you tried to create, update, or delete an object by using /// a change token that has already been used. ///
public CreateRule ( string name, string changeToken, string metricName ) : CreateRuleResponse
name string A friendly name or description of the Rule. You can't change the name of a Rule after you create it.
changeToken string The value returned by the most recent call to GetChangeToken.
metricName string A friendly name or description for the metrics for this Rule. The name can contain only alphanumeric characters (A-Z, a-z, 0-9); the name can't contain whitespace. You can't change the name of the metric after you create the Rule.
return Amazon.WAFRegional.Model.CreateRuleResponse

CreateRuleAsync() public method

Initiates the asynchronous execution of the CreateRule operation.
public CreateRuleAsync ( CreateRuleRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.WAFRegional.Model.CreateRuleRequest Container for the necessary parameters to execute the CreateRule operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

CreateRuleAsync() public method

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 you add the following to a Rule:
  • An IPSet that matches the IP address 192.0.2.44/32

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

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

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

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

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

  3. Submit a CreateRule request.

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

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

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

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

/// The name specified is invalid. /// /// The operation failed because of a system problem, even though the request was valid. /// Retry your request. /// /// 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 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, QUERY_STRING, or URI. /// ///
  • /// /// 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. /// ///
/// /// 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. /// /// The operation failed because you tried to create, update, or delete an object by using /// a change token that has already been used. ///
public CreateRuleAsync ( string name, string changeToken, string metricName, System cancellationToken = default(CancellationToken) ) : Task
name string A friendly name or description of the Rule. You can't change the name of a Rule after you create it.
changeToken string The value returned by the most recent call to GetChangeToken.
metricName string A friendly name or description for the metrics for this Rule. The name can contain only alphanumeric characters (A-Z, a-z, 0-9); the name can't contain whitespace. You can't change the name of the metric after you create the Rule.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

CreateSigner() protected method

Creates the signer for the service.
protected CreateSigner ( ) : AbstractAWSSigner
return Amazon.Runtime.Internal.Auth.AbstractAWSSigner

CreateSizeConstraintSet() public method

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

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

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

  2. Submit a CreateSizeConstraintSet request.

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

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

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

/// The name specified is invalid. /// /// The operation failed because of a system problem, even though the request was valid. /// Retry your request. /// /// The operation failed because you tried to create, update, or delete an object by using /// an invalid account identifier. /// /// 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 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, QUERY_STRING, or URI. /// ///
  • /// /// 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. /// ///
/// /// 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. /// /// The operation failed because you tried to create, update, or delete an object by using /// a change token that has already been used. ///
public CreateSizeConstraintSet ( CreateSizeConstraintSetRequest request ) : CreateSizeConstraintSetResponse
request Amazon.WAFRegional.Model.CreateSizeConstraintSetRequest Container for the necessary parameters to execute the CreateSizeConstraintSet service method.
return Amazon.WAFRegional.Model.CreateSizeConstraintSetResponse

CreateSizeConstraintSetAsync() public method

Initiates the asynchronous execution of the CreateSizeConstraintSet operation.
public CreateSizeConstraintSetAsync ( CreateSizeConstraintSetRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.WAFRegional.Model.CreateSizeConstraintSetRequest Container for the necessary parameters to execute the CreateSizeConstraintSet operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

CreateSqlInjectionMatchSet() public method

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

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

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

  2. Submit a CreateSqlInjectionMatchSet request.

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

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

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

/// The name specified is invalid. /// /// The operation failed because of a system problem, even though the request was valid. /// Retry your request. /// /// The operation failed because you tried to create, update, or delete an object by using /// an invalid account identifier. /// /// 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 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, QUERY_STRING, or URI. /// ///
  • /// /// 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. /// ///
/// /// 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. /// /// The operation failed because you tried to create, update, or delete an object by using /// a change token that has already been used. ///
public CreateSqlInjectionMatchSet ( CreateSqlInjectionMatchSetRequest request ) : CreateSqlInjectionMatchSetResponse
request Amazon.WAFRegional.Model.CreateSqlInjectionMatchSetRequest Container for the necessary parameters to execute the CreateSqlInjectionMatchSet service method.
return Amazon.WAFRegional.Model.CreateSqlInjectionMatchSetResponse

CreateSqlInjectionMatchSet() public method

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

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

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

  2. Submit a CreateSqlInjectionMatchSet request.

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

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

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

/// The name specified is invalid. /// /// The operation failed because of a system problem, even though the request was valid. /// Retry your request. /// /// The operation failed because you tried to create, update, or delete an object by using /// an invalid account identifier. /// /// 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 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, QUERY_STRING, or URI. /// ///
  • /// /// 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. /// ///
/// /// 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. /// /// The operation failed because you tried to create, update, or delete an object by using /// a change token that has already been used. ///
public CreateSqlInjectionMatchSet ( string name, string changeToken ) : CreateSqlInjectionMatchSetResponse
name string A friendly name or description for the SqlInjectionMatchSet that you're creating. You can't change Name after you create the SqlInjectionMatchSet.
changeToken string The value returned by the most recent call to GetChangeToken.
return Amazon.WAFRegional.Model.CreateSqlInjectionMatchSetResponse

CreateSqlInjectionMatchSetAsync() public method

Initiates the asynchronous execution of the CreateSqlInjectionMatchSet operation.
public CreateSqlInjectionMatchSetAsync ( CreateSqlInjectionMatchSetRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.WAFRegional.Model.CreateSqlInjectionMatchSetRequest Container for the necessary parameters to execute the CreateSqlInjectionMatchSet operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

CreateSqlInjectionMatchSetAsync() public method

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

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

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

  2. Submit a CreateSqlInjectionMatchSet request.

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

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

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

/// The name specified is invalid. /// /// The operation failed because of a system problem, even though the request was valid. /// Retry your request. /// /// The operation failed because you tried to create, update, or delete an object by using /// an invalid account identifier. /// /// 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 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, QUERY_STRING, or URI. /// ///
  • /// /// 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. /// ///
/// /// 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. /// /// The operation failed because you tried to create, update, or delete an object by using /// a change token that has already been used. ///
public CreateSqlInjectionMatchSetAsync ( string name, string changeToken, System cancellationToken = default(CancellationToken) ) : Task
name string A friendly name or description for the SqlInjectionMatchSet that you're creating. You can't change Name after you create the SqlInjectionMatchSet.
changeToken string The value returned by the most recent call to GetChangeToken.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

CreateWebACL() public method

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

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

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

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

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

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

  4. Submit a CreateWebACL request.

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

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

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

/// The name specified is invalid. /// /// The operation failed because of a system problem, even though the request was valid. /// Retry your request. /// /// The operation failed because you tried to create, update, or delete an object by using /// an invalid account identifier. /// /// 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 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, QUERY_STRING, or URI. /// ///
  • /// /// 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. /// ///
/// /// 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. /// /// The operation failed because you tried to create, update, or delete an object by using /// a change token that has already been used. ///
public CreateWebACL ( CreateWebACLRequest request ) : CreateWebACLResponse
request Amazon.WAFRegional.Model.CreateWebACLRequest Container for the necessary parameters to execute the CreateWebACL service method.
return Amazon.WAFRegional.Model.CreateWebACLResponse

CreateWebACLAsync() public method

Initiates the asynchronous execution of the CreateWebACL operation.
public CreateWebACLAsync ( CreateWebACLRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.WAFRegional.Model.CreateWebACLRequest Container for the necessary parameters to execute the CreateWebACL operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

CreateXssMatchSet() public method

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

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

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

  2. Submit a CreateXssMatchSet request.

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

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

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

/// The name specified is invalid. /// /// The operation failed because of a system problem, even though the request was valid. /// Retry your request. /// /// The operation failed because you tried to create, update, or delete an object by using /// an invalid account identifier. /// /// 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 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, QUERY_STRING, or URI. /// ///
  • /// /// 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. /// ///
/// /// 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. /// /// The operation failed because you tried to create, update, or delete an object by using /// a change token that has already been used. ///
public CreateXssMatchSet ( CreateXssMatchSetRequest request ) : CreateXssMatchSetResponse
request Amazon.WAFRegional.Model.CreateXssMatchSetRequest Container for the necessary parameters to execute the CreateXssMatchSet service method.
return Amazon.WAFRegional.Model.CreateXssMatchSetResponse

CreateXssMatchSetAsync() public method

Initiates the asynchronous execution of the CreateXssMatchSet operation.
public CreateXssMatchSetAsync ( CreateXssMatchSetRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.WAFRegional.Model.CreateXssMatchSetRequest Container for the necessary parameters to execute the CreateXssMatchSet operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

DeleteByteMatchSet() public method

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

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

To permanently delete a ByteMatchSet, perform the following steps:

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

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

  3. Submit a DeleteByteMatchSet request.

/// The operation failed because of a system problem, even though the request was valid. /// Retry your request. /// /// The operation failed because you tried to create, update, or delete an object by using /// an invalid account identifier. /// /// 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. /// ///
/// /// The operation failed because the referenced object doesn't exist. /// /// 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. /// ///
/// /// The operation failed because you tried to create, update, or delete an object by using /// a change token that has already been used. ///
public DeleteByteMatchSet ( DeleteByteMatchSetRequest request ) : DeleteByteMatchSetResponse
request Amazon.WAFRegional.Model.DeleteByteMatchSetRequest Container for the necessary parameters to execute the DeleteByteMatchSet service method.
return Amazon.WAFRegional.Model.DeleteByteMatchSetResponse

DeleteByteMatchSet() public method

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

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

To permanently delete a ByteMatchSet, perform the following steps:

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

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

  3. Submit a DeleteByteMatchSet request.

/// The operation failed because of a system problem, even though the request was valid. /// Retry your request. /// /// The operation failed because you tried to create, update, or delete an object by using /// an invalid account identifier. /// /// 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. /// ///
/// /// The operation failed because the referenced object doesn't exist. /// /// 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. /// ///
/// /// The operation failed because you tried to create, update, or delete an object by using /// a change token that has already been used. ///
public DeleteByteMatchSet ( string byteMatchSetId, string changeToken ) : DeleteByteMatchSetResponse
byteMatchSetId string The ByteMatchSetId of the ByteMatchSet that you want to delete. ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets.
changeToken string The value returned by the most recent call to GetChangeToken.
return Amazon.WAFRegional.Model.DeleteByteMatchSetResponse

DeleteByteMatchSetAsync() public method

Initiates the asynchronous execution of the DeleteByteMatchSet operation.
public DeleteByteMatchSetAsync ( DeleteByteMatchSetRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.WAFRegional.Model.DeleteByteMatchSetRequest Container for the necessary parameters to execute the DeleteByteMatchSet operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

DeleteByteMatchSetAsync() public method

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

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

To permanently delete a ByteMatchSet, perform the following steps:

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

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

  3. Submit a DeleteByteMatchSet request.

/// The operation failed because of a system problem, even though the request was valid. /// Retry your request. /// /// The operation failed because you tried to create, update, or delete an object by using /// an invalid account identifier. /// /// 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. /// ///
/// /// The operation failed because the referenced object doesn't exist. /// /// 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. /// ///
/// /// The operation failed because you tried to create, update, or delete an object by using /// a change token that has already been used. ///
public DeleteByteMatchSetAsync ( string byteMatchSetId, string changeToken, System cancellationToken = default(CancellationToken) ) : Task
byteMatchSetId string The ByteMatchSetId of the ByteMatchSet that you want to delete. ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets.
changeToken string The value returned by the most recent call to GetChangeToken.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

DeleteIPSet() public method

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

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

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

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

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

  3. Submit a DeleteIPSet request.

/// The operation failed because of a system problem, even though the request was valid. /// Retry your request. /// /// The operation failed because you tried to create, update, or delete an object by using /// an invalid account identifier. /// /// 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. /// ///
/// /// The operation failed because the referenced object doesn't exist. /// /// 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. /// ///
/// /// The operation failed because you tried to create, update, or delete an object by using /// a change token that has already been used. ///
public DeleteIPSet ( DeleteIPSetRequest request ) : DeleteIPSetResponse
request Amazon.WAFRegional.Model.DeleteIPSetRequest Container for the necessary parameters to execute the DeleteIPSet service method.
return Amazon.WAFRegional.Model.DeleteIPSetResponse

DeleteIPSet() public method

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

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

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

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

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

  3. Submit a DeleteIPSet request.

/// The operation failed because of a system problem, even though the request was valid. /// Retry your request. /// /// The operation failed because you tried to create, update, or delete an object by using /// an invalid account identifier. /// /// 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. /// ///
/// /// The operation failed because the referenced object doesn't exist. /// /// 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. /// ///
/// /// The operation failed because you tried to create, update, or delete an object by using /// a change token that has already been used. ///
public DeleteIPSet ( string ipSetId, string changeToken ) : DeleteIPSetResponse
ipSetId string The IPSetId of the IPSet that you want to delete. IPSetId is returned by CreateIPSet and by ListIPSets.
changeToken string The value returned by the most recent call to GetChangeToken.
return Amazon.WAFRegional.Model.DeleteIPSetResponse

DeleteIPSetAsync() public method

Initiates the asynchronous execution of the DeleteIPSet operation.
public DeleteIPSetAsync ( DeleteIPSetRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.WAFRegional.Model.DeleteIPSetRequest Container for the necessary parameters to execute the DeleteIPSet operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

DeleteIPSetAsync() public method

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

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

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

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

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

  3. Submit a DeleteIPSet request.

/// The operation failed because of a system problem, even though the request was valid. /// Retry your request. /// /// The operation failed because you tried to create, update, or delete an object by using /// an invalid account identifier. /// /// 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. /// ///
/// /// The operation failed because the referenced object doesn't exist. /// /// 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. /// ///
/// /// The operation failed because you tried to create, update, or delete an object by using /// a change token that has already been used. ///
public DeleteIPSetAsync ( string ipSetId, string changeToken, System cancellationToken = default(CancellationToken) ) : Task
ipSetId string The IPSetId of the IPSet that you want to delete. IPSetId is returned by CreateIPSet and by ListIPSets.
changeToken string The value returned by the most recent call to GetChangeToken.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

DeleteRule() public method

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

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

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

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

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

  3. Submit a DeleteRule request.

/// The operation failed because of a system problem, even though the request was valid. /// Retry your request. /// /// The operation failed because you tried to create, update, or delete an object by using /// an invalid account identifier. /// /// 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. /// ///
/// /// The operation failed because the referenced object doesn't exist. /// /// 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. /// ///
/// /// The operation failed because you tried to create, update, or delete an object by using /// a change token that has already been used. ///
public DeleteRule ( DeleteRuleRequest request ) : DeleteRuleResponse
request Amazon.WAFRegional.Model.DeleteRuleRequest Container for the necessary parameters to execute the DeleteRule service method.
return Amazon.WAFRegional.Model.DeleteRuleResponse

DeleteRule() public method

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

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

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

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

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

  3. Submit a DeleteRule request.

/// The operation failed because of a system problem, even though the request was valid. /// Retry your request. /// /// The operation failed because you tried to create, update, or delete an object by using /// an invalid account identifier. /// /// 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. /// ///
/// /// The operation failed because the referenced object doesn't exist. /// /// 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. /// ///
/// /// The operation failed because you tried to create, update, or delete an object by using /// a change token that has already been used. ///
public DeleteRule ( string ruleId, string changeToken ) : DeleteRuleResponse
ruleId string The RuleId of the Rule that you want to delete. RuleId is returned by CreateRule and by ListRules.
changeToken string The value returned by the most recent call to GetChangeToken.
return Amazon.WAFRegional.Model.DeleteRuleResponse

DeleteRuleAsync() public method

Initiates the asynchronous execution of the DeleteRule operation.
public DeleteRuleAsync ( DeleteRuleRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.WAFRegional.Model.DeleteRuleRequest Container for the necessary parameters to execute the DeleteRule operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

DeleteRuleAsync() public method

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

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

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

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

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

  3. Submit a DeleteRule request.

/// The operation failed because of a system problem, even though the request was valid. /// Retry your request. /// /// The operation failed because you tried to create, update, or delete an object by using /// an invalid account identifier. /// /// 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. /// ///
/// /// The operation failed because the referenced object doesn't exist. /// /// 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. /// ///
/// /// The operation failed because you tried to create, update, or delete an object by using /// a change token that has already been used. ///
public DeleteRuleAsync ( string ruleId, string changeToken, System cancellationToken = default(CancellationToken) ) : Task
ruleId string The RuleId of the Rule that you want to delete. RuleId is returned by CreateRule and by ListRules.
changeToken string The value returned by the most recent call to GetChangeToken.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

DeleteSizeConstraintSet() public method

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

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

To permanently delete a SizeConstraintSet, perform the following steps:

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

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

  3. Submit a DeleteSizeConstraintSet request.

/// The operation failed because of a system problem, even though the request was valid. /// Retry your request. /// /// The operation failed because you tried to create, update, or delete an object by using /// an invalid account identifier. /// /// 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. /// ///
/// /// The operation failed because the referenced object doesn't exist. /// /// 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. /// ///
/// /// The operation failed because you tried to create, update, or delete an object by using /// a change token that has already been used. ///
public DeleteSizeConstraintSet ( DeleteSizeConstraintSetRequest request ) : DeleteSizeConstraintSetResponse
request Amazon.WAFRegional.Model.DeleteSizeConstraintSetRequest Container for the necessary parameters to execute the DeleteSizeConstraintSet service method.
return Amazon.WAFRegional.Model.DeleteSizeConstraintSetResponse

DeleteSizeConstraintSetAsync() public method

Initiates the asynchronous execution of the DeleteSizeConstraintSet operation.
public DeleteSizeConstraintSetAsync ( DeleteSizeConstraintSetRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.WAFRegional.Model.DeleteSizeConstraintSetRequest Container for the necessary parameters to execute the DeleteSizeConstraintSet operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

DeleteSqlInjectionMatchSet() public method

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

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

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

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

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

  3. Submit a DeleteSqlInjectionMatchSet request.

/// The operation failed because of a system problem, even though the request was valid. /// Retry your request. /// /// The operation failed because you tried to create, update, or delete an object by using /// an invalid account identifier. /// /// 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. /// ///
/// /// The operation failed because the referenced object doesn't exist. /// /// 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. /// ///
/// /// The operation failed because you tried to create, update, or delete an object by using /// a change token that has already been used. ///
public DeleteSqlInjectionMatchSet ( DeleteSqlInjectionMatchSetRequest request ) : DeleteSqlInjectionMatchSetResponse
request Amazon.WAFRegional.Model.DeleteSqlInjectionMatchSetRequest Container for the necessary parameters to execute the DeleteSqlInjectionMatchSet service method.
return Amazon.WAFRegional.Model.DeleteSqlInjectionMatchSetResponse

DeleteSqlInjectionMatchSet() public method

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

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

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

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

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

  3. Submit a DeleteSqlInjectionMatchSet request.

/// The operation failed because of a system problem, even though the request was valid. /// Retry your request. /// /// The operation failed because you tried to create, update, or delete an object by using /// an invalid account identifier. /// /// 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. /// ///
/// /// The operation failed because the referenced object doesn't exist. /// /// 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. /// ///
/// /// The operation failed because you tried to create, update, or delete an object by using /// a change token that has already been used. ///
public DeleteSqlInjectionMatchSet ( string sqlInjectionMatchSetId, string changeToken ) : DeleteSqlInjectionMatchSetResponse
sqlInjectionMatchSetId string The SqlInjectionMatchSetId of the SqlInjectionMatchSet that you want to delete. SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by ListSqlInjectionMatchSets.
changeToken string The value returned by the most recent call to GetChangeToken.
return Amazon.WAFRegional.Model.DeleteSqlInjectionMatchSetResponse

DeleteSqlInjectionMatchSetAsync() public method

Initiates the asynchronous execution of the DeleteSqlInjectionMatchSet operation.
public DeleteSqlInjectionMatchSetAsync ( DeleteSqlInjectionMatchSetRequest request, System cancellationToken = default(CancellationToken) ) : Task
request DeleteSqlInjectionMatchSetRequest Container for the necessary parameters to execute the DeleteSqlInjectionMatchSet operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

DeleteSqlInjectionMatchSetAsync() public method

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

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

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

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

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

  3. Submit a DeleteSqlInjectionMatchSet request.

/// The operation failed because of a system problem, even though the request was valid. /// Retry your request. /// /// The operation failed because you tried to create, update, or delete an object by using /// an invalid account identifier. /// /// 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. /// ///
/// /// The operation failed because the referenced object doesn't exist. /// /// 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. /// ///
/// /// The operation failed because you tried to create, update, or delete an object by using /// a change token that has already been used. ///
public DeleteSqlInjectionMatchSetAsync ( string sqlInjectionMatchSetId, string changeToken, System cancellationToken = default(CancellationToken) ) : Task
sqlInjectionMatchSetId string The SqlInjectionMatchSetId of the SqlInjectionMatchSet that you want to delete. SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by ListSqlInjectionMatchSets.
changeToken string The value returned by the most recent call to GetChangeToken.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

DeleteWebACL() public method

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

To delete a WebACL, perform the following steps:

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

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

  3. Submit a DeleteWebACL request.

/// The operation failed because of a system problem, even though the request was valid. /// Retry your request. /// /// The operation failed because you tried to create, update, or delete an object by using /// an invalid account identifier. /// /// 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. /// ///
/// /// The operation failed because the referenced object doesn't exist. /// /// 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. /// ///
/// /// The operation failed because you tried to create, update, or delete an object by using /// a change token that has already been used. ///
public DeleteWebACL ( DeleteWebACLRequest request ) : DeleteWebACLResponse
request DeleteWebACLRequest Container for the necessary parameters to execute the DeleteWebACL service method.
return DeleteWebACLResponse

DeleteWebACL() public method

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

To delete a WebACL, perform the following steps:

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

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

  3. Submit a DeleteWebACL request.

/// The operation failed because of a system problem, even though the request was valid. /// Retry your request. /// /// The operation failed because you tried to create, update, or delete an object by using /// an invalid account identifier. /// /// 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. /// ///
/// /// The operation failed because the referenced object doesn't exist. /// /// 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. /// ///
/// /// The operation failed because you tried to create, update, or delete an object by using /// a change token that has already been used. ///
public DeleteWebACL ( string webACLId, string changeToken ) : DeleteWebACLResponse
webACLId string The WebACLId of the WebACL that you want to delete. WebACLId is returned by CreateWebACL and by ListWebACLs.
changeToken string The value returned by the most recent call to GetChangeToken.
return DeleteWebACLResponse

DeleteWebACLAsync() public method

Initiates the asynchronous execution of the DeleteWebACL operation.
public DeleteWebACLAsync ( DeleteWebACLRequest request, System cancellationToken = default(CancellationToken) ) : Task
request DeleteWebACLRequest Container for the necessary parameters to execute the DeleteWebACL operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

DeleteWebACLAsync() public method

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

To delete a WebACL, perform the following steps:

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

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

  3. Submit a DeleteWebACL request.

/// The operation failed because of a system problem, even though the request was valid. /// Retry your request. /// /// The operation failed because you tried to create, update, or delete an object by using /// an invalid account identifier. /// /// 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. /// ///
/// /// The operation failed because the referenced object doesn't exist. /// /// 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. /// ///
/// /// The operation failed because you tried to create, update, or delete an object by using /// a change token that has already been used. ///
public DeleteWebACLAsync ( string webACLId, string changeToken, System cancellationToken = default(CancellationToken) ) : Task
webACLId string The WebACLId of the WebACL that you want to delete. WebACLId is returned by CreateWebACL and by ListWebACLs.
changeToken string The value returned by the most recent call to GetChangeToken.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

DeleteXssMatchSet() public method

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

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

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

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

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

  3. Submit a DeleteXssMatchSet request.

/// The operation failed because of a system problem, even though the request was valid. /// Retry your request. /// /// The operation failed because you tried to create, update, or delete an object by using /// an invalid account identifier. /// /// 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. /// ///
/// /// The operation failed because the referenced object doesn't exist. /// /// 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. /// ///
/// /// The operation failed because you tried to create, update, or delete an object by using /// a change token that has already been used. ///
public DeleteXssMatchSet ( DeleteXssMatchSetRequest request ) : DeleteXssMatchSetResponse
request DeleteXssMatchSetRequest Container for the necessary parameters to execute the DeleteXssMatchSet service method.
return DeleteXssMatchSetResponse

DeleteXssMatchSetAsync() public method

Initiates the asynchronous execution of the DeleteXssMatchSet operation.
public DeleteXssMatchSetAsync ( DeleteXssMatchSetRequest request, System cancellationToken = default(CancellationToken) ) : Task
request DeleteXssMatchSetRequest Container for the necessary parameters to execute the DeleteXssMatchSet operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

DisassociateWebACL() public method

Removes a web ACL from the specified resource.
/// The operation failed because of a system problem, even though the request was valid. /// Retry your request. /// /// The operation failed because you tried to create, update, or delete an object by using /// an invalid account identifier. /// /// 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 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, QUERY_STRING, or URI. /// ///
  • /// /// 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. /// ///
/// /// The operation failed because the referenced object doesn't exist. ///
public DisassociateWebACL ( DisassociateWebACLRequest request ) : DisassociateWebACLResponse
request DisassociateWebACLRequest Container for the necessary parameters to execute the DisassociateWebACL service method.
return DisassociateWebACLResponse

DisassociateWebACLAsync() public method

Initiates the asynchronous execution of the DisassociateWebACL operation.
public DisassociateWebACLAsync ( DisassociateWebACLRequest request, System cancellationToken = default(CancellationToken) ) : Task
request DisassociateWebACLRequest Container for the necessary parameters to execute the DisassociateWebACL operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

Dispose() protected method

Disposes the service client.
protected Dispose ( bool disposing ) : void
disposing bool
return void

EndAssociateWebACL() public method

Finishes the asynchronous execution of the AssociateWebACL operation.
public EndAssociateWebACL ( IAsyncResult asyncResult ) : AssociateWebACLResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginAssociateWebACL.
return AssociateWebACLResponse

EndCreateByteMatchSet() public method

Finishes the asynchronous execution of the CreateByteMatchSet operation.
public EndCreateByteMatchSet ( IAsyncResult asyncResult ) : CreateByteMatchSetResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginCreateByteMatchSet.
return CreateByteMatchSetResponse

EndCreateIPSet() public method

Finishes the asynchronous execution of the CreateIPSet operation.
public EndCreateIPSet ( IAsyncResult asyncResult ) : CreateIPSetResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginCreateIPSet.
return CreateIPSetResponse

EndCreateRule() public method

Finishes the asynchronous execution of the CreateRule operation.
public EndCreateRule ( IAsyncResult asyncResult ) : CreateRuleResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginCreateRule.
return CreateRuleResponse

EndCreateSizeConstraintSet() public method

Finishes the asynchronous execution of the CreateSizeConstraintSet operation.
public EndCreateSizeConstraintSet ( IAsyncResult asyncResult ) : CreateSizeConstraintSetResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginCreateSizeConstraintSet.
return CreateSizeConstraintSetResponse

EndCreateSqlInjectionMatchSet() public method

Finishes the asynchronous execution of the CreateSqlInjectionMatchSet operation.
public EndCreateSqlInjectionMatchSet ( IAsyncResult asyncResult ) : CreateSqlInjectionMatchSetResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginCreateSqlInjectionMatchSet.
return CreateSqlInjectionMatchSetResponse

EndCreateWebACL() public method

Finishes the asynchronous execution of the CreateWebACL operation.
public EndCreateWebACL ( IAsyncResult asyncResult ) : CreateWebACLResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginCreateWebACL.
return CreateWebACLResponse

EndCreateXssMatchSet() public method

Finishes the asynchronous execution of the CreateXssMatchSet operation.
public EndCreateXssMatchSet ( IAsyncResult asyncResult ) : CreateXssMatchSetResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginCreateXssMatchSet.
return CreateXssMatchSetResponse

EndDeleteByteMatchSet() public method

Finishes the asynchronous execution of the DeleteByteMatchSet operation.
public EndDeleteByteMatchSet ( IAsyncResult asyncResult ) : DeleteByteMatchSetResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginDeleteByteMatchSet.
return DeleteByteMatchSetResponse

EndDeleteIPSet() public method

Finishes the asynchronous execution of the DeleteIPSet operation.
public EndDeleteIPSet ( IAsyncResult asyncResult ) : DeleteIPSetResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginDeleteIPSet.
return DeleteIPSetResponse

EndDeleteRule() public method

Finishes the asynchronous execution of the DeleteRule operation.
public EndDeleteRule ( IAsyncResult asyncResult ) : DeleteRuleResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginDeleteRule.
return DeleteRuleResponse

EndDeleteSizeConstraintSet() public method

Finishes the asynchronous execution of the DeleteSizeConstraintSet operation.
public EndDeleteSizeConstraintSet ( IAsyncResult asyncResult ) : DeleteSizeConstraintSetResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginDeleteSizeConstraintSet.
return DeleteSizeConstraintSetResponse

EndDeleteSqlInjectionMatchSet() public method

Finishes the asynchronous execution of the DeleteSqlInjectionMatchSet operation.
public EndDeleteSqlInjectionMatchSet ( IAsyncResult asyncResult ) : DeleteSqlInjectionMatchSetResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginDeleteSqlInjectionMatchSet.
return DeleteSqlInjectionMatchSetResponse

EndDeleteWebACL() public method

Finishes the asynchronous execution of the DeleteWebACL operation.
public EndDeleteWebACL ( IAsyncResult asyncResult ) : DeleteWebACLResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginDeleteWebACL.
return DeleteWebACLResponse

EndDeleteXssMatchSet() public method

Finishes the asynchronous execution of the DeleteXssMatchSet operation.
public EndDeleteXssMatchSet ( IAsyncResult asyncResult ) : DeleteXssMatchSetResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginDeleteXssMatchSet.
return DeleteXssMatchSetResponse

EndDisassociateWebACL() public method

Finishes the asynchronous execution of the DisassociateWebACL operation.
public EndDisassociateWebACL ( IAsyncResult asyncResult ) : DisassociateWebACLResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginDisassociateWebACL.
return DisassociateWebACLResponse

EndGetByteMatchSet() public method

Finishes the asynchronous execution of the GetByteMatchSet operation.
public EndGetByteMatchSet ( IAsyncResult asyncResult ) : GetByteMatchSetResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginGetByteMatchSet.
return GetByteMatchSetResponse

EndGetChangeToken() public method

Finishes the asynchronous execution of the GetChangeToken operation.
public EndGetChangeToken ( IAsyncResult asyncResult ) : GetChangeTokenResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginGetChangeToken.
return GetChangeTokenResponse

EndGetChangeTokenStatus() public method

Finishes the asynchronous execution of the GetChangeTokenStatus operation.
public EndGetChangeTokenStatus ( IAsyncResult asyncResult ) : GetChangeTokenStatusResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginGetChangeTokenStatus.
return GetChangeTokenStatusResponse

EndGetIPSet() public method

Finishes the asynchronous execution of the GetIPSet operation.
public EndGetIPSet ( IAsyncResult asyncResult ) : GetIPSetResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginGetIPSet.
return GetIPSetResponse

EndGetRule() public method

Finishes the asynchronous execution of the GetRule operation.
public EndGetRule ( IAsyncResult asyncResult ) : GetRuleResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginGetRule.
return GetRuleResponse

EndGetSampledRequests() public method

Finishes the asynchronous execution of the GetSampledRequests operation.
public EndGetSampledRequests ( IAsyncResult asyncResult ) : GetSampledRequestsResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginGetSampledRequests.
return GetSampledRequestsResponse

EndGetSizeConstraintSet() public method

Finishes the asynchronous execution of the GetSizeConstraintSet operation.
public EndGetSizeConstraintSet ( IAsyncResult asyncResult ) : GetSizeConstraintSetResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginGetSizeConstraintSet.
return GetSizeConstraintSetResponse

EndGetSqlInjectionMatchSet() public method

Finishes the asynchronous execution of the GetSqlInjectionMatchSet operation.
public EndGetSqlInjectionMatchSet ( IAsyncResult asyncResult ) : GetSqlInjectionMatchSetResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginGetSqlInjectionMatchSet.
return GetSqlInjectionMatchSetResponse

EndGetWebACL() public method

Finishes the asynchronous execution of the GetWebACL operation.
public EndGetWebACL ( IAsyncResult asyncResult ) : GetWebACLResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginGetWebACL.
return GetWebACLResponse

EndGetWebACLForResource() public method

Finishes the asynchronous execution of the GetWebACLForResource operation.
public EndGetWebACLForResource ( IAsyncResult asyncResult ) : GetWebACLForResourceResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginGetWebACLForResource.
return GetWebACLForResourceResponse

EndGetXssMatchSet() public method

Finishes the asynchronous execution of the GetXssMatchSet operation.
public EndGetXssMatchSet ( IAsyncResult asyncResult ) : GetXssMatchSetResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginGetXssMatchSet.
return GetXssMatchSetResponse

EndListByteMatchSets() public method

Finishes the asynchronous execution of the ListByteMatchSets operation.
public EndListByteMatchSets ( IAsyncResult asyncResult ) : ListByteMatchSetsResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginListByteMatchSets.
return ListByteMatchSetsResponse

EndListIPSets() public method

Finishes the asynchronous execution of the ListIPSets operation.
public EndListIPSets ( IAsyncResult asyncResult ) : ListIPSetsResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginListIPSets.
return ListIPSetsResponse

EndListResourcesForWebACL() public method

Finishes the asynchronous execution of the ListResourcesForWebACL operation.
public EndListResourcesForWebACL ( IAsyncResult asyncResult ) : ListResourcesForWebACLResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginListResourcesForWebACL.
return ListResourcesForWebACLResponse

EndListRules() public method

Finishes the asynchronous execution of the ListRules operation.
public EndListRules ( IAsyncResult asyncResult ) : ListRulesResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginListRules.
return ListRulesResponse

EndListSizeConstraintSets() public method

Finishes the asynchronous execution of the ListSizeConstraintSets operation.
public EndListSizeConstraintSets ( IAsyncResult asyncResult ) : ListSizeConstraintSetsResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginListSizeConstraintSets.
return ListSizeConstraintSetsResponse

EndListSqlInjectionMatchSets() public method

Finishes the asynchronous execution of the ListSqlInjectionMatchSets operation.
public EndListSqlInjectionMatchSets ( IAsyncResult asyncResult ) : ListSqlInjectionMatchSetsResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginListSqlInjectionMatchSets.
return ListSqlInjectionMatchSetsResponse

EndListWebACLs() public method

Finishes the asynchronous execution of the ListWebACLs operation.
public EndListWebACLs ( IAsyncResult asyncResult ) : ListWebACLsResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginListWebACLs.
return ListWebACLsResponse

EndListXssMatchSets() public method

Finishes the asynchronous execution of the ListXssMatchSets operation.
public EndListXssMatchSets ( IAsyncResult asyncResult ) : ListXssMatchSetsResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginListXssMatchSets.
return ListXssMatchSetsResponse

EndUpdateByteMatchSet() public method

Finishes the asynchronous execution of the UpdateByteMatchSet operation.
public EndUpdateByteMatchSet ( IAsyncResult asyncResult ) : UpdateByteMatchSetResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginUpdateByteMatchSet.
return UpdateByteMatchSetResponse

EndUpdateIPSet() public method

Finishes the asynchronous execution of the UpdateIPSet operation.
public EndUpdateIPSet ( IAsyncResult asyncResult ) : UpdateIPSetResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginUpdateIPSet.
return UpdateIPSetResponse

EndUpdateRule() public method

Finishes the asynchronous execution of the UpdateRule operation.
public EndUpdateRule ( IAsyncResult asyncResult ) : UpdateRuleResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginUpdateRule.
return UpdateRuleResponse

EndUpdateSizeConstraintSet() public method

Finishes the asynchronous execution of the UpdateSizeConstraintSet operation.
public EndUpdateSizeConstraintSet ( IAsyncResult asyncResult ) : UpdateSizeConstraintSetResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginUpdateSizeConstraintSet.
return UpdateSizeConstraintSetResponse

EndUpdateSqlInjectionMatchSet() public method

Finishes the asynchronous execution of the UpdateSqlInjectionMatchSet operation.
public EndUpdateSqlInjectionMatchSet ( IAsyncResult asyncResult ) : UpdateSqlInjectionMatchSetResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginUpdateSqlInjectionMatchSet.
return UpdateSqlInjectionMatchSetResponse

EndUpdateWebACL() public method

Finishes the asynchronous execution of the UpdateWebACL operation.
public EndUpdateWebACL ( IAsyncResult asyncResult ) : UpdateWebACLResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginUpdateWebACL.
return UpdateWebACLResponse

EndUpdateXssMatchSet() public method

Finishes the asynchronous execution of the UpdateXssMatchSet operation.
public EndUpdateXssMatchSet ( IAsyncResult asyncResult ) : UpdateXssMatchSetResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginUpdateXssMatchSet.
return UpdateXssMatchSetResponse

GetByteMatchSet() public method

Returns the ByteMatchSet specified by ByteMatchSetId.
/// The operation failed because of a system problem, even though the request was valid. /// Retry your request. /// /// The operation failed because you tried to create, update, or delete an object by using /// an invalid account identifier. /// /// The operation failed because the referenced object doesn't exist. ///
public GetByteMatchSet ( GetByteMatchSetRequest request ) : GetByteMatchSetResponse
request GetByteMatchSetRequest Container for the necessary parameters to execute the GetByteMatchSet service method.
return GetByteMatchSetResponse

GetByteMatchSet() public method

Returns the ByteMatchSet specified by ByteMatchSetId.
/// The operation failed because of a system problem, even though the request was valid. /// Retry your request. /// /// The operation failed because you tried to create, update, or delete an object by using /// an invalid account identifier. /// /// The operation failed because the referenced object doesn't exist. ///
public GetByteMatchSet ( string byteMatchSetId ) : GetByteMatchSetResponse
byteMatchSetId string The ByteMatchSetId of the ByteMatchSet that you want to get. ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets.
return GetByteMatchSetResponse

GetByteMatchSetAsync() public method

Initiates the asynchronous execution of the GetByteMatchSet operation.
public GetByteMatchSetAsync ( GetByteMatchSetRequest request, System cancellationToken = default(CancellationToken) ) : Task
request GetByteMatchSetRequest Container for the necessary parameters to execute the GetByteMatchSet operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

GetByteMatchSetAsync() public method

Returns the ByteMatchSet specified by ByteMatchSetId.
/// The operation failed because of a system problem, even though the request was valid. /// Retry your request. /// /// The operation failed because you tried to create, update, or delete an object by using /// an invalid account identifier. /// /// The operation failed because the referenced object doesn't exist. ///
public GetByteMatchSetAsync ( string byteMatchSetId, System cancellationToken = default(CancellationToken) ) : Task
byteMatchSetId string The ByteMatchSetId of the ByteMatchSet that you want to get. ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

GetChangeToken() public method

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.

/// The operation failed because of a system problem, even though the request was valid. /// Retry your request. ///
public GetChangeToken ( ) : GetChangeTokenResponse
return GetChangeTokenResponse

GetChangeToken() public method

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.

/// The operation failed because of a system problem, even though the request was valid. /// Retry your request. ///
public GetChangeToken ( GetChangeTokenRequest request ) : GetChangeTokenResponse
request GetChangeTokenRequest Container for the necessary parameters to execute the GetChangeToken service method.
return GetChangeTokenResponse

GetChangeTokenAsync() public method

Initiates the asynchronous execution of the GetChangeToken operation.
public GetChangeTokenAsync ( GetChangeTokenRequest request, System cancellationToken = default(CancellationToken) ) : Task
request GetChangeTokenRequest Container for the necessary parameters to execute the GetChangeToken operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

GetChangeTokenAsync() public method

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.

/// The operation failed because of a system problem, even though the request was valid. /// Retry your request. ///
public GetChangeTokenAsync ( System cancellationToken = default(CancellationToken) ) : Task
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

GetChangeTokenStatus() public method

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.

  • IN_SYNC: Propagation is complete.

/// The operation failed because of a system problem, even though the request was valid. /// Retry your request. /// /// The operation failed because the referenced object doesn't exist. ///
public GetChangeTokenStatus ( GetChangeTokenStatusRequest request ) : GetChangeTokenStatusResponse
request GetChangeTokenStatusRequest Container for the necessary parameters to execute the GetChangeTokenStatus service method.
return GetChangeTokenStatusResponse

GetChangeTokenStatus() public method

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.

  • IN_SYNC: Propagation is complete.

/// The operation failed because of a system problem, even though the request was valid. /// Retry your request. /// /// The operation failed because the referenced object doesn't exist. ///
public GetChangeTokenStatus ( string changeToken ) : GetChangeTokenStatusResponse
changeToken string The change token for which you want to get the status. This change token was previously returned in the GetChangeToken response.
return GetChangeTokenStatusResponse

GetChangeTokenStatusAsync() public method

Initiates the asynchronous execution of the GetChangeTokenStatus operation.
public GetChangeTokenStatusAsync ( GetChangeTokenStatusRequest request, System cancellationToken = default(CancellationToken) ) : Task
request GetChangeTokenStatusRequest Container for the necessary parameters to execute the GetChangeTokenStatus operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

GetChangeTokenStatusAsync() public method

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.

  • IN_SYNC: Propagation is complete.

/// The operation failed because of a system problem, even though the request was valid. /// Retry your request. /// /// The operation failed because the referenced object doesn't exist. ///
public GetChangeTokenStatusAsync ( string changeToken, System cancellationToken = default(CancellationToken) ) : Task
changeToken string The change token for which you want to get the status. This change token was previously returned in the GetChangeToken response.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

GetIPSet() public method

Returns the IPSet that is specified by IPSetId.
/// The operation failed because of a system problem, even though the request was valid. /// Retry your request. /// /// The operation failed because you tried to create, update, or delete an object by using /// an invalid account identifier. /// /// The operation failed because the referenced object doesn't exist. ///
public GetIPSet ( GetIPSetRequest request ) : GetIPSetResponse
request GetIPSetRequest Container for the necessary parameters to execute the GetIPSet service method.
return GetIPSetResponse

GetIPSet() public method

Returns the IPSet that is specified by IPSetId.
/// The operation failed because of a system problem, even though the request was valid. /// Retry your request. /// /// The operation failed because you tried to create, update, or delete an object by using /// an invalid account identifier. /// /// The operation failed because the referenced object doesn't exist. ///
public GetIPSet ( string ipSetId ) : GetIPSetResponse
ipSetId string The IPSetId of the IPSet that you want to get. IPSetId is returned by CreateIPSet and by ListIPSets.
return GetIPSetResponse

GetIPSetAsync() public method

Initiates the asynchronous execution of the GetIPSet operation.
public GetIPSetAsync ( GetIPSetRequest request, System cancellationToken = default(CancellationToken) ) : Task
request GetIPSetRequest Container for the necessary parameters to execute the GetIPSet operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

GetIPSetAsync() public method

Returns the IPSet that is specified by IPSetId.
/// The operation failed because of a system problem, even though the request was valid. /// Retry your request. /// /// The operation failed because you tried to create, update, or delete an object by using /// an invalid account identifier. /// /// The operation failed because the referenced object doesn't exist. ///
public GetIPSetAsync ( string ipSetId, System cancellationToken = default(CancellationToken) ) : Task
ipSetId string The IPSetId of the IPSet that you want to get. IPSetId is returned by CreateIPSet and by ListIPSets.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

GetRule() public method

Returns the Rule that is specified by the RuleId that you included in the GetRule request.
/// The operation failed because of a system problem, even though the request was valid. /// Retry your request. /// /// The operation failed because you tried to create, update, or delete an object by using /// an invalid account identifier. /// /// The operation failed because the referenced object doesn't exist. ///
public GetRule ( GetRuleRequest request ) : GetRuleResponse
request GetRuleRequest Container for the necessary parameters to execute the GetRule service method.
return GetRuleResponse

GetRule() public method

Returns the Rule that is specified by the RuleId that you included in the GetRule request.
/// The operation failed because of a system problem, even though the request was valid. /// Retry your request. /// /// The operation failed because you tried to create, update, or delete an object by using /// an invalid account identifier. /// /// The operation failed because the referenced object doesn't exist. ///
public GetRule ( string ruleId ) : GetRuleResponse
ruleId string The RuleId of the Rule that you want to get. RuleId is returned by CreateRule and by ListRules.
return GetRuleResponse

GetRuleAsync() public method

Initiates the asynchronous execution of the GetRule operation.
public GetRuleAsync ( GetRuleRequest request, System cancellationToken = default(CancellationToken) ) : Task
request GetRuleRequest Container for the necessary parameters to execute the GetRule operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

GetRuleAsync() public method

Returns the Rule that is specified by the RuleId that you included in the GetRule request.
/// The operation failed because of a system problem, even though the request was valid. /// Retry your request. /// /// The operation failed because you tried to create, update, or delete an object by using /// an invalid account identifier. /// /// The operation failed because the referenced object doesn't exist. ///
public GetRuleAsync ( string ruleId, System cancellationToken = default(CancellationToken) ) : Task
ruleId string The RuleId of the Rule that you want to get. RuleId is returned by CreateRule and by ListRules.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

GetSampledRequests() public method

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

/// The operation failed because of a system problem, even though the request was valid. /// Retry your request. /// /// The operation failed because the referenced object doesn't exist. ///
public GetSampledRequests ( GetSampledRequestsRequest request ) : GetSampledRequestsResponse
request GetSampledRequestsRequest Container for the necessary parameters to execute the GetSampledRequests service method.
return GetSampledRequestsResponse

GetSampledRequestsAsync() public method

Initiates the asynchronous execution of the GetSampledRequests operation.
public GetSampledRequestsAsync ( GetSampledRequestsRequest request, System cancellationToken = default(CancellationToken) ) : Task
request GetSampledRequestsRequest Container for the necessary parameters to execute the GetSampledRequests operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

GetSizeConstraintSet() public method

Returns the SizeConstraintSet specified by SizeConstraintSetId.
/// The operation failed because of a system problem, even though the request was valid. /// Retry your request. /// /// The operation failed because you tried to create, update, or delete an object by using /// an invalid account identifier. /// /// The operation failed because the referenced object doesn't exist. ///
public GetSizeConstraintSet ( GetSizeConstraintSetRequest request ) : GetSizeConstraintSetResponse
request GetSizeConstraintSetRequest Container for the necessary parameters to execute the GetSizeConstraintSet service method.
return GetSizeConstraintSetResponse

GetSizeConstraintSetAsync() public method

Initiates the asynchronous execution of the GetSizeConstraintSet operation.
public GetSizeConstraintSetAsync ( GetSizeConstraintSetRequest request, System cancellationToken = default(CancellationToken) ) : Task
request GetSizeConstraintSetRequest Container for the necessary parameters to execute the GetSizeConstraintSet operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

GetSqlInjectionMatchSet() public method

Returns the SqlInjectionMatchSet that is specified by SqlInjectionMatchSetId.
/// The operation failed because of a system problem, even though the request was valid. /// Retry your request. /// /// The operation failed because you tried to create, update, or delete an object by using /// an invalid account identifier. /// /// The operation failed because the referenced object doesn't exist. ///
public GetSqlInjectionMatchSet ( GetSqlInjectionMatchSetRequest request ) : GetSqlInjectionMatchSetResponse
request GetSqlInjectionMatchSetRequest Container for the necessary parameters to execute the GetSqlInjectionMatchSet service method.
return GetSqlInjectionMatchSetResponse

GetSqlInjectionMatchSet() public method

Returns the SqlInjectionMatchSet that is specified by SqlInjectionMatchSetId.
/// The operation failed because of a system problem, even though the request was valid. /// Retry your request. /// /// The operation failed because you tried to create, update, or delete an object by using /// an invalid account identifier. /// /// The operation failed because the referenced object doesn't exist. ///
public GetSqlInjectionMatchSet ( string sqlInjectionMatchSetId ) : GetSqlInjectionMatchSetResponse
sqlInjectionMatchSetId string The SqlInjectionMatchSetId of the SqlInjectionMatchSet that you want to get. SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by ListSqlInjectionMatchSets.
return GetSqlInjectionMatchSetResponse

GetSqlInjectionMatchSetAsync() public method

Initiates the asynchronous execution of the GetSqlInjectionMatchSet operation.
public GetSqlInjectionMatchSetAsync ( GetSqlInjectionMatchSetRequest request, System cancellationToken = default(CancellationToken) ) : Task
request GetSqlInjectionMatchSetRequest Container for the necessary parameters to execute the GetSqlInjectionMatchSet operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

GetSqlInjectionMatchSetAsync() public method

Returns the SqlInjectionMatchSet that is specified by SqlInjectionMatchSetId.
/// The operation failed because of a system problem, even though the request was valid. /// Retry your request. /// /// The operation failed because you tried to create, update, or delete an object by using /// an invalid account identifier. /// /// The operation failed because the referenced object doesn't exist. ///
public GetSqlInjectionMatchSetAsync ( string sqlInjectionMatchSetId, System cancellationToken = default(CancellationToken) ) : Task
sqlInjectionMatchSetId string The SqlInjectionMatchSetId of the SqlInjectionMatchSet that you want to get. SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by ListSqlInjectionMatchSets.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

GetWebACL() public method

Returns the WebACL that is specified by WebACLId.
/// The operation failed because of a system problem, even though the request was valid. /// Retry your request. /// /// The operation failed because you tried to create, update, or delete an object by using /// an invalid account identifier. /// /// The operation failed because the referenced object doesn't exist. ///
public GetWebACL ( GetWebACLRequest request ) : GetWebACLResponse
request GetWebACLRequest Container for the necessary parameters to execute the GetWebACL service method.
return GetWebACLResponse

GetWebACL() public method

Returns the WebACL that is specified by WebACLId.
/// The operation failed because of a system problem, even though the request was valid. /// Retry your request. /// /// The operation failed because you tried to create, update, or delete an object by using /// an invalid account identifier. /// /// The operation failed because the referenced object doesn't exist. ///
public GetWebACL ( string webACLId ) : GetWebACLResponse
webACLId string The WebACLId of the WebACL that you want to get. WebACLId is returned by CreateWebACL and by ListWebACLs.
return GetWebACLResponse

GetWebACLAsync() public method

Initiates the asynchronous execution of the GetWebACL operation.
public GetWebACLAsync ( GetWebACLRequest request, System cancellationToken = default(CancellationToken) ) : Task
request GetWebACLRequest Container for the necessary parameters to execute the GetWebACL operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

GetWebACLAsync() public method

Returns the WebACL that is specified by WebACLId.
/// The operation failed because of a system problem, even though the request was valid. /// Retry your request. /// /// The operation failed because you tried to create, update, or delete an object by using /// an invalid account identifier. /// /// The operation failed because the referenced object doesn't exist. ///
public GetWebACLAsync ( string webACLId, System cancellationToken = default(CancellationToken) ) : Task
webACLId string The WebACLId of the WebACL that you want to get. WebACLId is returned by CreateWebACL and by ListWebACLs.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

GetWebACLForResource() public method

Returns the web ACL for the specified resource.
/// The operation failed because of a system problem, even though the request was valid. /// Retry your request. /// /// The operation failed because you tried to create, update, or delete an object by using /// an invalid account identifier. /// /// 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 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, QUERY_STRING, or URI. /// ///
  • /// /// 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. /// ///
/// /// The operation failed because the referenced object doesn't exist. /// /// The operation failed because the entity referenced is temporarily unavailable. Retry /// your request. ///
public GetWebACLForResource ( GetWebACLForResourceRequest request ) : GetWebACLForResourceResponse
request GetWebACLForResourceRequest Container for the necessary parameters to execute the GetWebACLForResource service method.
return GetWebACLForResourceResponse

GetWebACLForResourceAsync() public method

Initiates the asynchronous execution of the GetWebACLForResource operation.
public GetWebACLForResourceAsync ( GetWebACLForResourceRequest request, System cancellationToken = default(CancellationToken) ) : Task
request GetWebACLForResourceRequest Container for the necessary parameters to execute the GetWebACLForResource operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

GetXssMatchSet() public method

Returns the XssMatchSet that is specified by XssMatchSetId.
/// The operation failed because of a system problem, even though the request was valid. /// Retry your request. /// /// The operation failed because you tried to create, update, or delete an object by using /// an invalid account identifier. /// /// The operation failed because the referenced object doesn't exist. ///
public GetXssMatchSet ( GetXssMatchSetRequest request ) : GetXssMatchSetResponse
request GetXssMatchSetRequest Container for the necessary parameters to execute the GetXssMatchSet service method.
return GetXssMatchSetResponse

GetXssMatchSetAsync() public method

Initiates the asynchronous execution of the GetXssMatchSet operation.
public GetXssMatchSetAsync ( GetXssMatchSetRequest request, System cancellationToken = default(CancellationToken) ) : Task
request GetXssMatchSetRequest Container for the necessary parameters to execute the GetXssMatchSet operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

ListByteMatchSets() public method

Returns an array of ByteMatchSetSummary objects.
/// The operation failed because of a system problem, even though the request was valid. /// Retry your request. /// /// The operation failed because you tried to create, update, or delete an object by using /// an invalid account identifier. ///
public ListByteMatchSets ( ListByteMatchSetsRequest request ) : ListByteMatchSetsResponse
request ListByteMatchSetsRequest Container for the necessary parameters to execute the ListByteMatchSets service method.
return ListByteMatchSetsResponse

ListByteMatchSetsAsync() public method

Initiates the asynchronous execution of the ListByteMatchSets operation.
public ListByteMatchSetsAsync ( ListByteMatchSetsRequest request, System cancellationToken = default(CancellationToken) ) : Task
request ListByteMatchSetsRequest Container for the necessary parameters to execute the ListByteMatchSets operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

ListIPSets() public method

Returns an array of IPSetSummary objects in the response.
/// The operation failed because of a system problem, even though the request was valid. /// Retry your request. /// /// The operation failed because you tried to create, update, or delete an object by using /// an invalid account identifier. ///
public ListIPSets ( ListIPSetsRequest request ) : ListIPSetsResponse
request ListIPSetsRequest Container for the necessary parameters to execute the ListIPSets service method.
return ListIPSetsResponse

ListIPSetsAsync() public method

Initiates the asynchronous execution of the ListIPSets operation.
public ListIPSetsAsync ( ListIPSetsRequest request, System cancellationToken = default(CancellationToken) ) : Task
request ListIPSetsRequest Container for the necessary parameters to execute the ListIPSets operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

ListResourcesForWebACL() public method

Returns an array of resources associated with the specified web ACL.
/// The operation failed because of a system problem, even though the request was valid. /// Retry your request. /// /// The operation failed because you tried to create, update, or delete an object by using /// an invalid account identifier. /// /// The operation failed because the referenced object doesn't exist. ///
public ListResourcesForWebACL ( ListResourcesForWebACLRequest request ) : ListResourcesForWebACLResponse
request ListResourcesForWebACLRequest Container for the necessary parameters to execute the ListResourcesForWebACL service method.
return ListResourcesForWebACLResponse

ListResourcesForWebACLAsync() public method

Initiates the asynchronous execution of the ListResourcesForWebACL operation.
public ListResourcesForWebACLAsync ( ListResourcesForWebACLRequest request, System cancellationToken = default(CancellationToken) ) : Task
request ListResourcesForWebACLRequest Container for the necessary parameters to execute the ListResourcesForWebACL operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

ListRules() public method

Returns an array of RuleSummary objects.
/// The operation failed because of a system problem, even though the request was valid. /// Retry your request. /// /// The operation failed because you tried to create, update, or delete an object by using /// an invalid account identifier. ///
public ListRules ( ListRulesRequest request ) : ListRulesResponse
request ListRulesRequest Container for the necessary parameters to execute the ListRules service method.
return ListRulesResponse

ListRulesAsync() public method

Initiates the asynchronous execution of the ListRules operation.
public ListRulesAsync ( ListRulesRequest request, System cancellationToken = default(CancellationToken) ) : Task
request ListRulesRequest Container for the necessary parameters to execute the ListRules operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

ListSizeConstraintSets() public method

Returns an array of SizeConstraintSetSummary objects.
/// The operation failed because of a system problem, even though the request was valid. /// Retry your request. /// /// The operation failed because you tried to create, update, or delete an object by using /// an invalid account identifier. ///
public ListSizeConstraintSets ( ListSizeConstraintSetsRequest request ) : ListSizeConstraintSetsResponse
request ListSizeConstraintSetsRequest Container for the necessary parameters to execute the ListSizeConstraintSets service method.
return ListSizeConstraintSetsResponse

ListSizeConstraintSetsAsync() public method

Initiates the asynchronous execution of the ListSizeConstraintSets operation.
public ListSizeConstraintSetsAsync ( ListSizeConstraintSetsRequest request, System cancellationToken = default(CancellationToken) ) : Task
request ListSizeConstraintSetsRequest Container for the necessary parameters to execute the ListSizeConstraintSets operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

ListSqlInjectionMatchSets() public method

Returns an array of SqlInjectionMatchSet objects.
/// The operation failed because of a system problem, even though the request was valid. /// Retry your request. /// /// The operation failed because you tried to create, update, or delete an object by using /// an invalid account identifier. ///
public ListSqlInjectionMatchSets ( ListSqlInjectionMatchSetsRequest request ) : ListSqlInjectionMatchSetsResponse
request ListSqlInjectionMatchSetsRequest Container for the necessary parameters to execute the ListSqlInjectionMatchSets service method.
return ListSqlInjectionMatchSetsResponse

ListSqlInjectionMatchSetsAsync() public method

Initiates the asynchronous execution of the ListSqlInjectionMatchSets operation.
public ListSqlInjectionMatchSetsAsync ( ListSqlInjectionMatchSetsRequest request, System cancellationToken = default(CancellationToken) ) : Task
request ListSqlInjectionMatchSetsRequest Container for the necessary parameters to execute the ListSqlInjectionMatchSets operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

ListWebACLs() public method

Returns an array of WebACLSummary objects in the response.
/// The operation failed because of a system problem, even though the request was valid. /// Retry your request. /// /// The operation failed because you tried to create, update, or delete an object by using /// an invalid account identifier. ///
public ListWebACLs ( ListWebACLsRequest request ) : ListWebACLsResponse
request ListWebACLsRequest Container for the necessary parameters to execute the ListWebACLs service method.
return ListWebACLsResponse

ListWebACLsAsync() public method

Initiates the asynchronous execution of the ListWebACLs operation.
public ListWebACLsAsync ( ListWebACLsRequest request, System cancellationToken = default(CancellationToken) ) : Task
request ListWebACLsRequest Container for the necessary parameters to execute the ListWebACLs operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

ListXssMatchSets() public method

Returns an array of XssMatchSet objects.
/// The operation failed because of a system problem, even though the request was valid. /// Retry your request. /// /// The operation failed because you tried to create, update, or delete an object by using /// an invalid account identifier. ///
public ListXssMatchSets ( ListXssMatchSetsRequest request ) : ListXssMatchSetsResponse
request ListXssMatchSetsRequest Container for the necessary parameters to execute the ListXssMatchSets service method.
return ListXssMatchSetsResponse

ListXssMatchSetsAsync() public method

Initiates the asynchronous execution of the ListXssMatchSets operation.
public ListXssMatchSetsAsync ( ListXssMatchSetsRequest request, System cancellationToken = default(CancellationToken) ) : Task
request ListXssMatchSetsRequest Container for the necessary parameters to execute the ListXssMatchSets operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

UpdateByteMatchSet() public method

Inserts or deletes ByteMatchTuple objects (filters) in a ByteMatchSet. For each ByteMatchTuple object, you specify the following values:
  • Whether to insert or delete the object from the array. If you want to change a ByteMatchSetUpdate object, you delete the existing object and add a new one.

  • The part of a web request that you want AWS WAF to inspect, such as a query string or the value of the User-Agent header.

  • The bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to look for. For more information, including how you specify the values for the AWS WAF API and the AWS CLI or SDKs, see TargetString in the ByteMatchTuple data type.

  • Where to look, such as at the beginning or the end of a query string.

  • Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for the specified string.

For example, you can add a ByteMatchSetUpdate object that matches web requests in which User-Agent headers contain the string BadBot. You can then configure AWS WAF to block those requests.

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

  1. Create a ByteMatchSet. For more information, see CreateByteMatchSet.

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

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

/// The operation failed because of a system problem, even though the request was valid. /// Retry your request. /// /// The operation failed because you tried to create, update, or delete an object by using /// an invalid account identifier. /// /// 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 an IP address to an IPSet, but the IP address already /// exists in the specified IPSet. /// ///
  • /// /// You tried to add a ByteMatchTuple to a ByteMatchSet, but /// the ByteMatchTuple already exists in the specified WebACL. /// ///
/// /// 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 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, QUERY_STRING, or URI. /// ///
  • /// /// 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. /// ///
/// /// 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. /// /// The operation failed because you tried to add an object to or delete an object from /// another object that doesn't exist. For example: /// ///
  • /// /// You tried to add a Rule to or delete a Rule from a WebACL /// that doesn't exist. /// ///
  • /// /// You tried to add a ByteMatchSet to or delete a ByteMatchSet /// from a Rule that doesn't exist. /// ///
  • /// /// You tried to add an IP address to or delete an IP address from an IPSet /// that doesn't exist. /// ///
  • /// /// You tried to add a ByteMatchTuple to or delete a ByteMatchTuple /// from a ByteMatchSet that doesn't exist. /// ///
/// /// The operation failed because the referenced object doesn't exist. /// /// The operation failed because you tried to create, update, or delete an object by using /// a change token that has already been used. ///
public UpdateByteMatchSet ( UpdateByteMatchSetRequest request ) : UpdateByteMatchSetResponse
request UpdateByteMatchSetRequest Container for the necessary parameters to execute the UpdateByteMatchSet service method.
return UpdateByteMatchSetResponse

UpdateByteMatchSet() public method

Inserts or deletes ByteMatchTuple objects (filters) in a ByteMatchSet. For each ByteMatchTuple object, you specify the following values:
  • Whether to insert or delete the object from the array. If you want to change a ByteMatchSetUpdate object, you delete the existing object and add a new one.

  • The part of a web request that you want AWS WAF to inspect, such as a query string or the value of the User-Agent header.

  • The bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to look for. For more information, including how you specify the values for the AWS WAF API and the AWS CLI or SDKs, see TargetString in the ByteMatchTuple data type.

  • Where to look, such as at the beginning or the end of a query string.

  • Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for the specified string.

For example, you can add a ByteMatchSetUpdate object that matches web requests in which User-Agent headers contain the string BadBot. You can then configure AWS WAF to block those requests.

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

  1. Create a ByteMatchSet. For more information, see CreateByteMatchSet.

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

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

/// The operation failed because of a system problem, even though the request was valid. /// Retry your request. /// /// The operation failed because you tried to create, update, or delete an object by using /// an invalid account identifier. /// /// 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 an IP address to an IPSet, but the IP address already /// exists in the specified IPSet. /// ///
  • /// /// You tried to add a ByteMatchTuple to a ByteMatchSet, but /// the ByteMatchTuple already exists in the specified WebACL. /// ///
/// /// 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 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, QUERY_STRING, or URI. /// ///
  • /// /// 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. /// ///
/// /// 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. /// /// The operation failed because you tried to add an object to or delete an object from /// another object that doesn't exist. For example: /// ///
  • /// /// You tried to add a Rule to or delete a Rule from a WebACL /// that doesn't exist. /// ///
  • /// /// You tried to add a ByteMatchSet to or delete a ByteMatchSet /// from a Rule that doesn't exist. /// ///
  • /// /// You tried to add an IP address to or delete an IP address from an IPSet /// that doesn't exist. /// ///
  • /// /// You tried to add a ByteMatchTuple to or delete a ByteMatchTuple /// from a ByteMatchSet that doesn't exist. /// ///
/// /// The operation failed because the referenced object doesn't exist. /// /// The operation failed because you tried to create, update, or delete an object by using /// a change token that has already been used. ///
public UpdateByteMatchSet ( string byteMatchSetId, List updates, string changeToken ) : UpdateByteMatchSetResponse
byteMatchSetId string The ByteMatchSetId of the ByteMatchSet that you want to update. ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets.
updates List An array of ByteMatchSetUpdate objects that you want to insert into or delete from a ByteMatchSet. For more information, see the applicable data types:
changeToken string The value returned by the most recent call to GetChangeToken.
return UpdateByteMatchSetResponse

UpdateByteMatchSetAsync() public method

Initiates the asynchronous execution of the UpdateByteMatchSet operation.
public UpdateByteMatchSetAsync ( UpdateByteMatchSetRequest request, System cancellationToken = default(CancellationToken) ) : Task
request UpdateByteMatchSetRequest Container for the necessary parameters to execute the UpdateByteMatchSet operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

UpdateByteMatchSetAsync() public method

Inserts or deletes ByteMatchTuple objects (filters) in a ByteMatchSet. For each ByteMatchTuple object, you specify the following values:
  • Whether to insert or delete the object from the array. If you want to change a ByteMatchSetUpdate object, you delete the existing object and add a new one.

  • The part of a web request that you want AWS WAF to inspect, such as a query string or the value of the User-Agent header.

  • The bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to look for. For more information, including how you specify the values for the AWS WAF API and the AWS CLI or SDKs, see TargetString in the ByteMatchTuple data type.

  • Where to look, such as at the beginning or the end of a query string.

  • Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for the specified string.

For example, you can add a ByteMatchSetUpdate object that matches web requests in which User-Agent headers contain the string BadBot. You can then configure AWS WAF to block those requests.

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

  1. Create a ByteMatchSet. For more information, see CreateByteMatchSet.

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

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

/// The operation failed because of a system problem, even though the request was valid. /// Retry your request. /// /// The operation failed because you tried to create, update, or delete an object by using /// an invalid account identifier. /// /// 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 an IP address to an IPSet, but the IP address already /// exists in the specified IPSet. /// ///
  • /// /// You tried to add a ByteMatchTuple to a ByteMatchSet, but /// the ByteMatchTuple already exists in the specified WebACL. /// ///
/// /// 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 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, QUERY_STRING, or URI. /// ///
  • /// /// 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. /// ///
/// /// 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. /// /// The operation failed because you tried to add an object to or delete an object from /// another object that doesn't exist. For example: /// ///
  • /// /// You tried to add a Rule to or delete a Rule from a WebACL /// that doesn't exist. /// ///
  • /// /// You tried to add a ByteMatchSet to or delete a ByteMatchSet /// from a Rule that doesn't exist. /// ///
  • /// /// You tried to add an IP address to or delete an IP address from an IPSet /// that doesn't exist. /// ///
  • /// /// You tried to add a ByteMatchTuple to or delete a ByteMatchTuple /// from a ByteMatchSet that doesn't exist. /// ///
/// /// The operation failed because the referenced object doesn't exist. /// /// The operation failed because you tried to create, update, or delete an object by using /// a change token that has already been used. ///
public UpdateByteMatchSetAsync ( string byteMatchSetId, List updates, string changeToken, System cancellationToken = default(CancellationToken) ) : Task
byteMatchSetId string The ByteMatchSetId of the ByteMatchSet that you want to update. ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets.
updates List An array of ByteMatchSetUpdate objects that you want to insert into or delete from a ByteMatchSet. For more information, see the applicable data types:
changeToken string The value returned by the most recent call to GetChangeToken.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

UpdateIPSet() public method

Inserts or deletes IPSetDescriptor objects in an IPSet. For each IPSetDescriptor object, you specify the following values:
  • Whether to insert or delete the object from the array. If you want to change an IPSetDescriptor object, you delete the existing object and add a new one.

  • The IP address version, IPv4 or IPv6.

  • The IP address in CIDR notation, for example, 192.0.2.0/24 (for the range of IP addresses from 192.0.2.0 to 192.0.2.255) or 192.0.2.44/32 (for the individual IP address 192.0.2.44).

AWS WAF supports /8, /16, /24, and /32 IP address ranges for IPv4, and /24, /32, /48, /56, /64 and /128 for IPv6. For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.

IPv6 addresses can be represented using any of the following formats:

  • 1111:0000:0000:0000:0000:0000:0000:0111/128

  • 1111:0:0:0:0:0:0:0111/128

  • 1111::0111/128

  • 1111::111/128

You use an IPSet to specify which web requests you want to allow or block based on the IP addresses that the requests originated from. For example, if you're receiving a lot of requests from one or a small number of IP addresses and you want to block the requests, you can create an IPSet that specifies those IP addresses, and then configure AWS WAF to block the requests.

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

  1. Submit a CreateIPSet request.

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

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

When you update an IPSet, you specify the IP addresses that you want to add and/or the IP addresses that you want to delete. If you want to change an IP address, you delete the existing IP address and add the new one.

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

/// The operation failed because of a system problem, even though the request was valid. /// Retry your request. /// /// The operation failed because you tried to create, update, or delete an object by using /// an invalid account identifier. /// /// 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 an IP address to an IPSet, but the IP address already /// exists in the specified IPSet. /// ///
  • /// /// You tried to add a ByteMatchTuple to a ByteMatchSet, but /// the ByteMatchTuple already exists in the specified WebACL. /// ///
/// /// 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 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, QUERY_STRING, or URI. /// ///
  • /// /// 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. /// ///
/// /// 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. /// /// The operation failed because you tried to add an object to or delete an object from /// another object that doesn't exist. For example: /// ///
  • /// /// You tried to add a Rule to or delete a Rule from a WebACL /// that doesn't exist. /// ///
  • /// /// You tried to add a ByteMatchSet to or delete a ByteMatchSet /// from a Rule that doesn't exist. /// ///
  • /// /// You tried to add an IP address to or delete an IP address from an IPSet /// that doesn't exist. /// ///
  • /// /// You tried to add a ByteMatchTuple to or delete a ByteMatchTuple /// from a ByteMatchSet that doesn't exist. /// ///
/// /// The operation failed because the referenced object doesn't exist. /// /// 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. /// ///
/// /// The operation failed because you tried to create, update, or delete an object by using /// a change token that has already been used. ///
public UpdateIPSet ( UpdateIPSetRequest request ) : UpdateIPSetResponse
request UpdateIPSetRequest Container for the necessary parameters to execute the UpdateIPSet service method.
return UpdateIPSetResponse

UpdateIPSet() public method

Inserts or deletes IPSetDescriptor objects in an IPSet. For each IPSetDescriptor object, you specify the following values:
  • Whether to insert or delete the object from the array. If you want to change an IPSetDescriptor object, you delete the existing object and add a new one.

  • The IP address version, IPv4 or IPv6.

  • The IP address in CIDR notation, for example, 192.0.2.0/24 (for the range of IP addresses from 192.0.2.0 to 192.0.2.255) or 192.0.2.44/32 (for the individual IP address 192.0.2.44).

AWS WAF supports /8, /16, /24, and /32 IP address ranges for IPv4, and /24, /32, /48, /56, /64 and /128 for IPv6. For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.

IPv6 addresses can be represented using any of the following formats:

  • 1111:0000:0000:0000:0000:0000:0000:0111/128

  • 1111:0:0:0:0:0:0:0111/128

  • 1111::0111/128

  • 1111::111/128

You use an IPSet to specify which web requests you want to allow or block based on the IP addresses that the requests originated from. For example, if you're receiving a lot of requests from one or a small number of IP addresses and you want to block the requests, you can create an IPSet that specifies those IP addresses, and then configure AWS WAF to block the requests.

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

  1. Submit a CreateIPSet request.

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

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

When you update an IPSet, you specify the IP addresses that you want to add and/or the IP addresses that you want to delete. If you want to change an IP address, you delete the existing IP address and add the new one.

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

/// The operation failed because of a system problem, even though the request was valid. /// Retry your request. /// /// The operation failed because you tried to create, update, or delete an object by using /// an invalid account identifier. /// /// 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 an IP address to an IPSet, but the IP address already /// exists in the specified IPSet. /// ///
  • /// /// You tried to add a ByteMatchTuple to a ByteMatchSet, but /// the ByteMatchTuple already exists in the specified WebACL. /// ///
/// /// 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 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, QUERY_STRING, or URI. /// ///
  • /// /// 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. /// ///
/// /// 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. /// /// The operation failed because you tried to add an object to or delete an object from /// another object that doesn't exist. For example: /// ///
  • /// /// You tried to add a Rule to or delete a Rule from a WebACL /// that doesn't exist. /// ///
  • /// /// You tried to add a ByteMatchSet to or delete a ByteMatchSet /// from a Rule that doesn't exist. /// ///
  • /// /// You tried to add an IP address to or delete an IP address from an IPSet /// that doesn't exist. /// ///
  • /// /// You tried to add a ByteMatchTuple to or delete a ByteMatchTuple /// from a ByteMatchSet that doesn't exist. /// ///
/// /// The operation failed because the referenced object doesn't exist. /// /// 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. /// ///
/// /// The operation failed because you tried to create, update, or delete an object by using /// a change token that has already been used. ///
public UpdateIPSet ( string ipSetId, List updates, string changeToken ) : UpdateIPSetResponse
ipSetId string The IPSetId of the IPSet that you want to update. IPSetId is returned by CreateIPSet and by ListIPSets.
updates List An array of IPSetUpdate objects that you want to insert into or delete from an IPSet. For more information, see the applicable data types:
changeToken string The value returned by the most recent call to GetChangeToken.
return UpdateIPSetResponse

UpdateIPSetAsync() public method

Initiates the asynchronous execution of the UpdateIPSet operation.
public UpdateIPSetAsync ( UpdateIPSetRequest request, System cancellationToken = default(CancellationToken) ) : Task
request UpdateIPSetRequest Container for the necessary parameters to execute the UpdateIPSet operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

UpdateIPSetAsync() public method

Inserts or deletes IPSetDescriptor objects in an IPSet. For each IPSetDescriptor object, you specify the following values:
  • Whether to insert or delete the object from the array. If you want to change an IPSetDescriptor object, you delete the existing object and add a new one.

  • The IP address version, IPv4 or IPv6.

  • The IP address in CIDR notation, for example, 192.0.2.0/24 (for the range of IP addresses from 192.0.2.0 to 192.0.2.255) or 192.0.2.44/32 (for the individual IP address 192.0.2.44).

AWS WAF supports /8, /16, /24, and /32 IP address ranges for IPv4, and /24, /32, /48, /56, /64 and /128 for IPv6. For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.

IPv6 addresses can be represented using any of the following formats:

  • 1111:0000:0000:0000:0000:0000:0000:0111/128

  • 1111:0:0:0:0:0:0:0111/128

  • 1111::0111/128

  • 1111::111/128

You use an IPSet to specify which web requests you want to allow or block based on the IP addresses that the requests originated from. For example, if you're receiving a lot of requests from one or a small number of IP addresses and you want to block the requests, you can create an IPSet that specifies those IP addresses, and then configure AWS WAF to block the requests.

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

  1. Submit a CreateIPSet request.

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

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

When you update an IPSet, you specify the IP addresses that you want to add and/or the IP addresses that you want to delete. If you want to change an IP address, you delete the existing IP address and add the new one.

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

/// The operation failed because of a system problem, even though the request was valid. /// Retry your request. /// /// The operation failed because you tried to create, update, or delete an object by using /// an invalid account identifier. /// /// 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 an IP address to an IPSet, but the IP address already /// exists in the specified IPSet. /// ///
  • /// /// You tried to add a ByteMatchTuple to a ByteMatchSet, but /// the ByteMatchTuple already exists in the specified WebACL. /// ///
/// /// 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 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, QUERY_STRING, or URI. /// ///
  • /// /// 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. /// ///
/// /// 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. /// /// The operation failed because you tried to add an object to or delete an object from /// another object that doesn't exist. For example: /// ///
  • /// /// You tried to add a Rule to or delete a Rule from a WebACL /// that doesn't exist. /// ///
  • /// /// You tried to add a ByteMatchSet to or delete a ByteMatchSet /// from a Rule that doesn't exist. /// ///
  • /// /// You tried to add an IP address to or delete an IP address from an IPSet /// that doesn't exist. /// ///
  • /// /// You tried to add a ByteMatchTuple to or delete a ByteMatchTuple /// from a ByteMatchSet that doesn't exist. /// ///
/// /// The operation failed because the referenced object doesn't exist. /// /// 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. /// ///
/// /// The operation failed because you tried to create, update, or delete an object by using /// a change token that has already been used. ///
public UpdateIPSetAsync ( string ipSetId, List updates, string changeToken, System cancellationToken = default(CancellationToken) ) : Task
ipSetId string The IPSetId of the IPSet that you want to update. IPSetId is returned by CreateIPSet and by ListIPSets.
updates List An array of IPSetUpdate objects that you want to insert into or delete from an IPSet. For more information, see the applicable data types:
changeToken string The value returned by the most recent call to GetChangeToken.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

UpdateRule() public method

Inserts or deletes Predicate objects in a Rule. Each Predicate object identifies a predicate, such as a ByteMatchSet or an IPSet, that specifies the web requests that you want to allow, block, or count. If you add more than one predicate to a Rule, a request must match all of the specifications to be allowed, blocked, or counted. For example, suppose you add the following to a Rule:
  • A ByteMatchSet that matches the value BadBot in the User-Agent header

  • An IPSet that matches the IP address 192.0.2.44

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

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

  1. Create and update the predicates that you want to include in the Rule.

  2. Create the Rule. See CreateRule.

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

  4. Submit an UpdateRule request to add predicates to the Rule.

  5. Create and update a WebACL that contains the Rule. See CreateWebACL.

If you want to replace one ByteMatchSet or IPSet with another, you delete the existing one and add the new one.

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

/// The operation failed because of a system problem, even though the request was valid. /// Retry your request. /// /// The operation failed because you tried to create, update, or delete an object by using /// an invalid account identifier. /// /// 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 an IP address to an IPSet, but the IP address already /// exists in the specified IPSet. /// ///
  • /// /// You tried to add a ByteMatchTuple to a ByteMatchSet, but /// the ByteMatchTuple already exists in the specified WebACL. /// ///
/// /// 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 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, QUERY_STRING, or URI. /// ///
  • /// /// 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. /// ///
/// /// 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. /// /// The operation failed because you tried to add an object to or delete an object from /// another object that doesn't exist. For example: /// ///
  • /// /// You tried to add a Rule to or delete a Rule from a WebACL /// that doesn't exist. /// ///
  • /// /// You tried to add a ByteMatchSet to or delete a ByteMatchSet /// from a Rule that doesn't exist. /// ///
  • /// /// You tried to add an IP address to or delete an IP address from an IPSet /// that doesn't exist. /// ///
  • /// /// You tried to add a ByteMatchTuple to or delete a ByteMatchTuple /// from a ByteMatchSet that doesn't exist. /// ///
/// /// The operation failed because the referenced object doesn't exist. /// /// 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. /// ///
/// /// The operation failed because you tried to create, update, or delete an object by using /// a change token that has already been used. ///
public UpdateRule ( UpdateRuleRequest request ) : UpdateRuleResponse
request UpdateRuleRequest Container for the necessary parameters to execute the UpdateRule service method.
return UpdateRuleResponse

UpdateRule() public method

Inserts or deletes Predicate objects in a Rule. Each Predicate object identifies a predicate, such as a ByteMatchSet or an IPSet, that specifies the web requests that you want to allow, block, or count. If you add more than one predicate to a Rule, a request must match all of the specifications to be allowed, blocked, or counted. For example, suppose you add the following to a Rule:
  • A ByteMatchSet that matches the value BadBot in the User-Agent header

  • An IPSet that matches the IP address 192.0.2.44

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

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

  1. Create and update the predicates that you want to include in the Rule.

  2. Create the Rule. See CreateRule.

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

  4. Submit an UpdateRule request to add predicates to the Rule.

  5. Create and update a WebACL that contains the Rule. See CreateWebACL.

If you want to replace one ByteMatchSet or IPSet with another, you delete the existing one and add the new one.

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

/// The operation failed because of a system problem, even though the request was valid. /// Retry your request. /// /// The operation failed because you tried to create, update, or delete an object by using /// an invalid account identifier. /// /// 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 an IP address to an IPSet, but the IP address already /// exists in the specified IPSet. /// ///
  • /// /// You tried to add a ByteMatchTuple to a ByteMatchSet, but /// the ByteMatchTuple already exists in the specified WebACL. /// ///
/// /// 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 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, QUERY_STRING, or URI. /// ///
  • /// /// 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. /// ///
/// /// 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. /// /// The operation failed because you tried to add an object to or delete an object from /// another object that doesn't exist. For example: /// ///
  • /// /// You tried to add a Rule to or delete a Rule from a WebACL /// that doesn't exist. /// ///
  • /// /// You tried to add a ByteMatchSet to or delete a ByteMatchSet /// from a Rule that doesn't exist. /// ///
  • /// /// You tried to add an IP address to or delete an IP address from an IPSet /// that doesn't exist. /// ///
  • /// /// You tried to add a ByteMatchTuple to or delete a ByteMatchTuple /// from a ByteMatchSet that doesn't exist. /// ///
/// /// The operation failed because the referenced object doesn't exist. /// /// 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. /// ///
/// /// The operation failed because you tried to create, update, or delete an object by using /// a change token that has already been used. ///
public UpdateRule ( string ruleId, List updates, string changeToken ) : UpdateRuleResponse
ruleId string The RuleId of the Rule that you want to update. RuleId is returned by CreateRule and by ListRules.
updates List An array of RuleUpdate objects that you want to insert into or delete from a Rule. For more information, see the applicable data types:
changeToken string The value returned by the most recent call to GetChangeToken.
return UpdateRuleResponse

UpdateRuleAsync() public method

Initiates the asynchronous execution of the UpdateRule operation.
public UpdateRuleAsync ( UpdateRuleRequest request, System cancellationToken = default(CancellationToken) ) : Task
request UpdateRuleRequest Container for the necessary parameters to execute the UpdateRule operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

UpdateRuleAsync() public method

Inserts or deletes Predicate objects in a Rule. Each Predicate object identifies a predicate, such as a ByteMatchSet or an IPSet, that specifies the web requests that you want to allow, block, or count. If you add more than one predicate to a Rule, a request must match all of the specifications to be allowed, blocked, or counted. For example, suppose you add the following to a Rule:
  • A ByteMatchSet that matches the value BadBot in the User-Agent header

  • An IPSet that matches the IP address 192.0.2.44

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

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

  1. Create and update the predicates that you want to include in the Rule.

  2. Create the Rule. See CreateRule.

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

  4. Submit an UpdateRule request to add predicates to the Rule.

  5. Create and update a WebACL that contains the Rule. See CreateWebACL.

If you want to replace one ByteMatchSet or IPSet with another, you delete the existing one and add the new one.

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

/// The operation failed because of a system problem, even though the request was valid. /// Retry your request. /// /// The operation failed because you tried to create, update, or delete an object by using /// an invalid account identifier. /// /// 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 an IP address to an IPSet, but the IP address already /// exists in the specified IPSet. /// ///
  • /// /// You tried to add a ByteMatchTuple to a ByteMatchSet, but /// the ByteMatchTuple already exists in the specified WebACL. /// ///
/// /// 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 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, QUERY_STRING, or URI. /// ///
  • /// /// 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. /// ///
/// /// 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. /// /// The operation failed because you tried to add an object to or delete an object from /// another object that doesn't exist. For example: /// ///
  • /// /// You tried to add a Rule to or delete a Rule from a WebACL /// that doesn't exist. /// ///
  • /// /// You tried to add a ByteMatchSet to or delete a ByteMatchSet /// from a Rule that doesn't exist. /// ///
  • /// /// You tried to add an IP address to or delete an IP address from an IPSet /// that doesn't exist. /// ///
  • /// /// You tried to add a ByteMatchTuple to or delete a ByteMatchTuple /// from a ByteMatchSet that doesn't exist. /// ///
/// /// The operation failed because the referenced object doesn't exist. /// /// 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. /// ///
/// /// The operation failed because you tried to create, update, or delete an object by using /// a change token that has already been used. ///
public UpdateRuleAsync ( string ruleId, List updates, string changeToken, System cancellationToken = default(CancellationToken) ) : Task
ruleId string The RuleId of the Rule that you want to update. RuleId is returned by CreateRule and by ListRules.
updates List An array of RuleUpdate objects that you want to insert into or delete from a Rule. For more information, see the applicable data types:
changeToken string The value returned by the most recent call to GetChangeToken.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

UpdateSizeConstraintSet() public method

Inserts or deletes SizeConstraint objects (filters) in a SizeConstraintSet. For each SizeConstraint object, you specify the following values:
  • Whether to insert or delete the object from the array. If you want to change a SizeConstraintSetUpdate object, you delete the existing object and add a new one.

  • The part of a web request that you want AWS WAF to evaluate, such as the length of a query string or the length of the User-Agent header.

  • Whether to perform any transformations on the request, such as converting it to lowercase, before checking its length. Note that transformations of the request body are not supported because the AWS resource forwards only the first 8192 bytes of your request to AWS WAF.

  • A ComparisonOperator used for evaluating the selected part of the request against the specified Size, such as equals, greater than, less than, and so on.

  • The length, in bytes, that you want AWS WAF to watch for in selected part of the request. The length is computed after applying the transformation.

For example, you can add a SizeConstraintSetUpdate object that matches web requests in which the length of the User-Agent header is greater than 100 bytes. You can then configure AWS WAF to block those requests.

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

  1. Create a SizeConstraintSet. For more information, see CreateSizeConstraintSet.

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

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

/// The operation failed because of a system problem, even though the request was valid. /// Retry your request. /// /// The operation failed because you tried to create, update, or delete an object by using /// an invalid account identifier. /// /// 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 an IP address to an IPSet, but the IP address already /// exists in the specified IPSet. /// ///
  • /// /// You tried to add a ByteMatchTuple to a ByteMatchSet, but /// the ByteMatchTuple already exists in the specified WebACL. /// ///
/// /// 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 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, QUERY_STRING, or URI. /// ///
  • /// /// 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. /// ///
/// /// 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. /// /// The operation failed because you tried to add an object to or delete an object from /// another object that doesn't exist. For example: /// ///
  • /// /// You tried to add a Rule to or delete a Rule from a WebACL /// that doesn't exist. /// ///
  • /// /// You tried to add a ByteMatchSet to or delete a ByteMatchSet /// from a Rule that doesn't exist. /// ///
  • /// /// You tried to add an IP address to or delete an IP address from an IPSet /// that doesn't exist. /// ///
  • /// /// You tried to add a ByteMatchTuple to or delete a ByteMatchTuple /// from a ByteMatchSet that doesn't exist. /// ///
/// /// The operation failed because the referenced object doesn't exist. /// /// 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. /// ///
/// /// The operation failed because you tried to create, update, or delete an object by using /// a change token that has already been used. ///
public UpdateSizeConstraintSet ( UpdateSizeConstraintSetRequest request ) : UpdateSizeConstraintSetResponse
request UpdateSizeConstraintSetRequest Container for the necessary parameters to execute the UpdateSizeConstraintSet service method.
return UpdateSizeConstraintSetResponse

UpdateSizeConstraintSetAsync() public method

Initiates the asynchronous execution of the UpdateSizeConstraintSet operation.
public UpdateSizeConstraintSetAsync ( UpdateSizeConstraintSetRequest request, System cancellationToken = default(CancellationToken) ) : Task
request UpdateSizeConstraintSetRequest Container for the necessary parameters to execute the UpdateSizeConstraintSet operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

UpdateSqlInjectionMatchSet() public method

Inserts or deletes SqlInjectionMatchTuple objects (filters) in a SqlInjectionMatchSet. For each SqlInjectionMatchTuple object, you specify the following values:
  • Action: Whether to insert the object into or delete the object from the array. To change a SqlInjectionMatchTuple, you delete the existing object and add a new one.

  • FieldToMatch: The part of web requests that you want AWS WAF to inspect and, if you want AWS WAF to inspect a header, the name of the header.

  • TextTransformation: Which text transformation, if any, to perform on the web request before inspecting the request for snippets of malicious SQL code.

You use SqlInjectionMatchSet objects to specify which CloudFront requests you want to allow, block, or count. For example, if you're receiving requests that contain snippets of SQL code in the query string and you want to block the requests, you can create a SqlInjectionMatchSet with the applicable settings, and then configure AWS WAF to block the requests.

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

  1. Submit a CreateSqlInjectionMatchSet request.

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

  3. Submit an UpdateSqlInjectionMatchSet request to specify the parts of web requests that you want AWS WAF to inspect for snippets of 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.

/// The operation failed because of a system problem, even though the request was valid. /// Retry your request. /// /// The operation failed because you tried to create, update, or delete an object by using /// an invalid account identifier. /// /// 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 an IP address to an IPSet, but the IP address already /// exists in the specified IPSet. /// ///
  • /// /// You tried to add a ByteMatchTuple to a ByteMatchSet, but /// the ByteMatchTuple already exists in the specified WebACL. /// ///
/// /// 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 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, QUERY_STRING, or URI. /// ///
  • /// /// 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. /// ///
/// /// 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. /// /// The operation failed because you tried to add an object to or delete an object from /// another object that doesn't exist. For example: /// ///
  • /// /// You tried to add a Rule to or delete a Rule from a WebACL /// that doesn't exist. /// ///
  • /// /// You tried to add a ByteMatchSet to or delete a ByteMatchSet /// from a Rule that doesn't exist. /// ///
  • /// /// You tried to add an IP address to or delete an IP address from an IPSet /// that doesn't exist. /// ///
  • /// /// You tried to add a ByteMatchTuple to or delete a ByteMatchTuple /// from a ByteMatchSet that doesn't exist. /// ///
/// /// The operation failed because the referenced object doesn't exist. /// /// The operation failed because you tried to create, update, or delete an object by using /// a change token that has already been used. ///
public UpdateSqlInjectionMatchSet ( UpdateSqlInjectionMatchSetRequest request ) : UpdateSqlInjectionMatchSetResponse
request UpdateSqlInjectionMatchSetRequest Container for the necessary parameters to execute the UpdateSqlInjectionMatchSet service method.
return UpdateSqlInjectionMatchSetResponse

UpdateSqlInjectionMatchSet() public method

Inserts or deletes SqlInjectionMatchTuple objects (filters) in a SqlInjectionMatchSet. For each SqlInjectionMatchTuple object, you specify the following values:
  • Action: Whether to insert the object into or delete the object from the array. To change a SqlInjectionMatchTuple, you delete the existing object and add a new one.

  • FieldToMatch: The part of web requests that you want AWS WAF to inspect and, if you want AWS WAF to inspect a header, the name of the header.

  • TextTransformation: Which text transformation, if any, to perform on the web request before inspecting the request for snippets of malicious SQL code.

You use SqlInjectionMatchSet objects to specify which CloudFront requests you want to allow, block, or count. For example, if you're receiving requests that contain snippets of SQL code in the query string and you want to block the requests, you can create a SqlInjectionMatchSet with the applicable settings, and then configure AWS WAF to block the requests.

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

  1. Submit a CreateSqlInjectionMatchSet request.

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

  3. Submit an UpdateSqlInjectionMatchSet request to specify the parts of web requests that you want AWS WAF to inspect for snippets of 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.

/// The operation failed because of a system problem, even though the request was valid. /// Retry your request. /// /// The operation failed because you tried to create, update, or delete an object by using /// an invalid account identifier. /// /// 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 an IP address to an IPSet, but the IP address already /// exists in the specified IPSet. /// ///
  • /// /// You tried to add a ByteMatchTuple to a ByteMatchSet, but /// the ByteMatchTuple already exists in the specified WebACL. /// ///
/// /// 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 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, QUERY_STRING, or URI. /// ///
  • /// /// 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. /// ///
/// /// 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. /// /// The operation failed because you tried to add an object to or delete an object from /// another object that doesn't exist. For example: /// ///
  • /// /// You tried to add a Rule to or delete a Rule from a WebACL /// that doesn't exist. /// ///
  • /// /// You tried to add a ByteMatchSet to or delete a ByteMatchSet /// from a Rule that doesn't exist. /// ///
  • /// /// You tried to add an IP address to or delete an IP address from an IPSet /// that doesn't exist. /// ///
  • /// /// You tried to add a ByteMatchTuple to or delete a ByteMatchTuple /// from a ByteMatchSet that doesn't exist. /// ///
/// /// The operation failed because the referenced object doesn't exist. /// /// The operation failed because you tried to create, update, or delete an object by using /// a change token that has already been used. ///
public UpdateSqlInjectionMatchSet ( string sqlInjectionMatchSetId, List updates, string changeToken ) : UpdateSqlInjectionMatchSetResponse
sqlInjectionMatchSetId string The SqlInjectionMatchSetId of the SqlInjectionMatchSet that you want to update. SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by ListSqlInjectionMatchSets.
updates List An array of SqlInjectionMatchSetUpdate objects that you want to insert into or delete from a SqlInjectionMatchSet. For more information, see the applicable data types:
changeToken string The value returned by the most recent call to GetChangeToken.
return UpdateSqlInjectionMatchSetResponse

UpdateSqlInjectionMatchSetAsync() public method

Initiates the asynchronous execution of the UpdateSqlInjectionMatchSet operation.
public UpdateSqlInjectionMatchSetAsync ( UpdateSqlInjectionMatchSetRequest request, System cancellationToken = default(CancellationToken) ) : Task
request UpdateSqlInjectionMatchSetRequest Container for the necessary parameters to execute the UpdateSqlInjectionMatchSet operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

UpdateSqlInjectionMatchSetAsync() public method

Inserts or deletes SqlInjectionMatchTuple objects (filters) in a SqlInjectionMatchSet. For each SqlInjectionMatchTuple object, you specify the following values:
  • Action: Whether to insert the object into or delete the object from the array. To change a SqlInjectionMatchTuple, you delete the existing object and add a new one.

  • FieldToMatch: The part of web requests that you want AWS WAF to inspect and, if you want AWS WAF to inspect a header, the name of the header.

  • TextTransformation: Which text transformation, if any, to perform on the web request before inspecting the request for snippets of malicious SQL code.

You use SqlInjectionMatchSet objects to specify which CloudFront requests you want to allow, block, or count. For example, if you're receiving requests that contain snippets of SQL code in the query string and you want to block the requests, you can create a SqlInjectionMatchSet with the applicable settings, and then configure AWS WAF to block the requests.

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

  1. Submit a CreateSqlInjectionMatchSet request.

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

  3. Submit an UpdateSqlInjectionMatchSet request to specify the parts of web requests that you want AWS WAF to inspect for snippets of 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.

/// The operation failed because of a system problem, even though the request was valid. /// Retry your request. /// /// The operation failed because you tried to create, update, or delete an object by using /// an invalid account identifier. /// /// 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 an IP address to an IPSet, but the IP address already /// exists in the specified IPSet. /// ///
  • /// /// You tried to add a ByteMatchTuple to a ByteMatchSet, but /// the ByteMatchTuple already exists in the specified WebACL. /// ///
/// /// 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 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, QUERY_STRING, or URI. /// ///
  • /// /// 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. /// ///
/// /// 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. /// /// The operation failed because you tried to add an object to or delete an object from /// another object that doesn't exist. For example: /// ///
  • /// /// You tried to add a Rule to or delete a Rule from a WebACL /// that doesn't exist. /// ///
  • /// /// You tried to add a ByteMatchSet to or delete a ByteMatchSet /// from a Rule that doesn't exist. /// ///
  • /// /// You tried to add an IP address to or delete an IP address from an IPSet /// that doesn't exist. /// ///
  • /// /// You tried to add a ByteMatchTuple to or delete a ByteMatchTuple /// from a ByteMatchSet that doesn't exist. /// ///
/// /// The operation failed because the referenced object doesn't exist. /// /// The operation failed because you tried to create, update, or delete an object by using /// a change token that has already been used. ///
public UpdateSqlInjectionMatchSetAsync ( string sqlInjectionMatchSetId, List updates, string changeToken, System cancellationToken = default(CancellationToken) ) : Task
sqlInjectionMatchSetId string The SqlInjectionMatchSetId of the SqlInjectionMatchSet that you want to update. SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by ListSqlInjectionMatchSets.
updates List An array of SqlInjectionMatchSetUpdate objects that you want to insert into or delete from a SqlInjectionMatchSet. For more information, see the applicable data types:
changeToken string The value returned by the most recent call to GetChangeToken.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

UpdateWebACL() public method

Inserts or deletes ActivatedRule objects in a WebACL. Each Rule identifies web requests that you want to allow, block, or count. When you update a WebACL, you specify the following values:
  • A default action for the WebACL, either ALLOW or BLOCK. AWS WAF performs the default action if a request doesn't match the criteria in any of the Rules in a WebACL.

  • The Rules that you want to add and/or delete. If you want to replace one Rule with another, you delete the existing Rule and add the new one.

  • For each Rule, whether you want AWS WAF to allow requests, block requests, or count requests that match the conditions in the Rule.

  • The order in which you want AWS WAF to evaluate the Rules in a WebACL. If you add more than one Rule to a WebACL, AWS WAF evaluates each request against the Rules in order based on the value of Priority. (The Rule that has the lowest value for Priority is evaluated first.) When a web request matches all of the predicates (such as ByteMatchSets and IPSets) in a Rule, AWS WAF immediately takes the corresponding action, allow or block, and doesn't evaluate the request against the remaining Rules in the WebACL, if any.

  • The CloudFront distribution that you want to associate with the WebACL.

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

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

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

  3. Create a WebACL. See CreateWebACL.

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

  5. 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 to allow or block HTTP requests, see the AWS WAF Developer Guide.

/// The operation failed because of a system problem, even though the request was valid. /// Retry your request. /// /// The operation failed because you tried to create, update, or delete an object by using /// an invalid account identifier. /// /// 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 an IP address to an IPSet, but the IP address already /// exists in the specified IPSet. /// ///
  • /// /// You tried to add a ByteMatchTuple to a ByteMatchSet, but /// the ByteMatchTuple already exists in the specified WebACL. /// ///
/// /// 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 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, QUERY_STRING, or URI. /// ///
  • /// /// 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. /// ///
/// /// 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. /// /// The operation failed because you tried to add an object to or delete an object from /// another object that doesn't exist. For example: /// ///
  • /// /// You tried to add a Rule to or delete a Rule from a WebACL /// that doesn't exist. /// ///
  • /// /// You tried to add a ByteMatchSet to or delete a ByteMatchSet /// from a Rule that doesn't exist. /// ///
  • /// /// You tried to add an IP address to or delete an IP address from an IPSet /// that doesn't exist. /// ///
  • /// /// You tried to add a ByteMatchTuple to or delete a ByteMatchTuple /// from a ByteMatchSet that doesn't exist. /// ///
/// /// The operation failed because the referenced object doesn't exist. /// /// 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. /// ///
/// /// The operation failed because you tried to create, update, or delete an object by using /// a change token that has already been used. ///
public UpdateWebACL ( UpdateWebACLRequest request ) : UpdateWebACLResponse
request UpdateWebACLRequest Container for the necessary parameters to execute the UpdateWebACL service method.
return UpdateWebACLResponse

UpdateWebACLAsync() public method

Initiates the asynchronous execution of the UpdateWebACL operation.
public UpdateWebACLAsync ( UpdateWebACLRequest request, System cancellationToken = default(CancellationToken) ) : Task
request UpdateWebACLRequest Container for the necessary parameters to execute the UpdateWebACL operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

UpdateXssMatchSet() public method

Inserts or deletes XssMatchTuple objects (filters) in an XssMatchSet. For each XssMatchTuple object, you specify the following values:
  • Action: Whether to insert the object into or delete the object from the array. To change a XssMatchTuple, you delete the existing object and add a new one.

  • FieldToMatch: The part of web requests that you want AWS WAF to inspect and, if you want AWS WAF to inspect a header, the name of the header.

  • TextTransformation: Which text transformation, if any, to perform on the web request before inspecting the request for cross-site scripting attacks.

You use XssMatchSet objects to specify which CloudFront requests you want to allow, block, or count. For example, if you're receiving requests that contain cross-site scripting attacks in the request body and you want to block the requests, you can create an XssMatchSet with the applicable settings, and then configure AWS WAF to block the requests.

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

  1. Submit a CreateXssMatchSet request.

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

  3. Submit an UpdateXssMatchSet request to specify the parts of web requests that you want AWS WAF to inspect for 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.

/// The operation failed because of a system problem, even though the request was valid. /// Retry your request. /// /// The operation failed because you tried to create, update, or delete an object by using /// an invalid account identifier. /// /// 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 an IP address to an IPSet, but the IP address already /// exists in the specified IPSet. /// ///
  • /// /// You tried to add a ByteMatchTuple to a ByteMatchSet, but /// the ByteMatchTuple already exists in the specified WebACL. /// ///
/// /// 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 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, QUERY_STRING, or URI. /// ///
  • /// /// 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. /// ///
/// /// 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. /// /// The operation failed because you tried to add an object to or delete an object from /// another object that doesn't exist. For example: /// ///
  • /// /// You tried to add a Rule to or delete a Rule from a WebACL /// that doesn't exist. /// ///
  • /// /// You tried to add a ByteMatchSet to or delete a ByteMatchSet /// from a Rule that doesn't exist. /// ///
  • /// /// You tried to add an IP address to or delete an IP address from an IPSet /// that doesn't exist. /// ///
  • /// /// You tried to add a ByteMatchTuple to or delete a ByteMatchTuple /// from a ByteMatchSet that doesn't exist. /// ///
/// /// The operation failed because the referenced object doesn't exist. /// /// The operation failed because you tried to create, update, or delete an object by using /// a change token that has already been used. ///
public UpdateXssMatchSet ( UpdateXssMatchSetRequest request ) : UpdateXssMatchSetResponse
request UpdateXssMatchSetRequest Container for the necessary parameters to execute the UpdateXssMatchSet service method.
return UpdateXssMatchSetResponse

UpdateXssMatchSetAsync() public method

Initiates the asynchronous execution of the UpdateXssMatchSet operation.
public UpdateXssMatchSetAsync ( UpdateXssMatchSetRequest request, System cancellationToken = default(CancellationToken) ) : Task
request UpdateXssMatchSetRequest Container for the necessary parameters to execute the UpdateXssMatchSet operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task