AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

WAFRegional

import "github.com/aws/aws-sdk-go/service/wafregional"

type WAFRegional struct { *client.Client }

WAFRegional provides the API operation methods for making requests to AWS WAF Regional. See this package's package overview docs for details on the service.

WAFRegional methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

Client

Type: *client.Client

Method

AssociateWebACL

func (c *WAFRegional) AssociateWebACL(input *AssociateWebACLInput) (*AssociateWebACLOutput, error)

AssociateWebACL API operation for AWS WAF Regional.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS WAF Regional's API operation AssociateWebACL for usage and error information.

Returned Error Codes:

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

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

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

  • You specified an invalid parameter name.

  • You specified an invalid value.

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

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

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

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

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

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

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

  • ErrCodeWAFNonexistentItemException "WAFNonexistentItemException" The operation failed because the referenced object doesn't exist.

  • ErrCodeWAFUnavailableEntityException "WAFUnavailableEntityException" The operation failed because the entity referenced is temporarily unavailable. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/AssociateWebACL

AssociateWebACLRequest

func (c *WAFRegional) AssociateWebACLRequest(input *AssociateWebACLInput) (req *request.Request, output *AssociateWebACLOutput)

AssociateWebACLRequest generates a "aws/request.Request" representing the client's request for the AssociateWebACL operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See AssociateWebACL for more information on using the AssociateWebACL API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the AssociateWebACLRequest method. req, resp := client.AssociateWebACLRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/AssociateWebACL

AssociateWebACLWithContext

func (c *WAFRegional) AssociateWebACLWithContext(ctx aws.Context, input *AssociateWebACLInput, opts ...request.Option) (*AssociateWebACLOutput, error)

AssociateWebACLWithContext is the same as AssociateWebACL with the addition of the ability to pass a context and additional request options.

See AssociateWebACL for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

CreateByteMatchSet

func (c *WAFRegional) CreateByteMatchSet(input *waf.CreateByteMatchSetInput) (*waf.CreateByteMatchSetOutput, error)

CreateByteMatchSet API operation for AWS WAF Regional.

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

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

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

Submit a CreateByteMatchSet request.

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

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

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS WAF Regional's API operation CreateByteMatchSet for usage and error information.

Returned Error Codes:

  • ErrCodeWAFDisallowedNameException "WAFDisallowedNameException" The name specified is invalid.

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

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

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

  • You specified an invalid parameter name.

  • You specified an invalid value.

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

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

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

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

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

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

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

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

  • ErrCodeWAFLimitsExceededException "WAFLimitsExceededException" The operation exceeds a resource limit, for example, the maximum number of WebACL objects that you can create for an AWS account. For more information, see Limits (https://docs.aws.amazon.com/waf/latest/developerguide/limits.html) in the AWS WAF Developer Guide.

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/CreateByteMatchSet

CreateByteMatchSetRequest

func (c *WAFRegional) CreateByteMatchSetRequest(input *waf.CreateByteMatchSetInput) (req *request.Request, output *waf.CreateByteMatchSetOutput)

CreateByteMatchSetRequest generates a "aws/request.Request" representing the client's request for the CreateByteMatchSet operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateByteMatchSet for more information on using the CreateByteMatchSet API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateByteMatchSetRequest method. req, resp := client.CreateByteMatchSetRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/CreateByteMatchSet

CreateByteMatchSetWithContext

func (c *WAFRegional) CreateByteMatchSetWithContext(ctx aws.Context, input *waf.CreateByteMatchSetInput, opts ...request.Option) (*waf.CreateByteMatchSetOutput, error)

CreateByteMatchSetWithContext is the same as CreateByteMatchSet with the addition of the ability to pass a context and additional request options.

See CreateByteMatchSet for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

CreateGeoMatchSet

func (c *WAFRegional) CreateGeoMatchSet(input *waf.CreateGeoMatchSetInput) (*waf.CreateGeoMatchSetOutput, error)

CreateGeoMatchSet API operation for AWS WAF Regional.

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

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

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

Submit a CreateGeoMatchSet request.

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

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

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS WAF Regional's API operation CreateGeoMatchSet for usage and error information.

Returned Error Codes:

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

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

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

  • ErrCodeWAFDisallowedNameException "WAFDisallowedNameException" The name specified is invalid.

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

  • You specified an invalid parameter name.

  • You specified an invalid value.

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

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

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

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

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

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

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

  • ErrCodeWAFLimitsExceededException "WAFLimitsExceededException" The operation exceeds a resource limit, for example, the maximum number of WebACL objects that you can create for an AWS account. For more information, see Limits (https://docs.aws.amazon.com/waf/latest/developerguide/limits.html) in the AWS WAF Developer Guide.

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/CreateGeoMatchSet

CreateGeoMatchSetRequest

func (c *WAFRegional) CreateGeoMatchSetRequest(input *waf.CreateGeoMatchSetInput) (req *request.Request, output *waf.CreateGeoMatchSetOutput)

CreateGeoMatchSetRequest generates a "aws/request.Request" representing the client's request for the CreateGeoMatchSet operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateGeoMatchSet for more information on using the CreateGeoMatchSet API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateGeoMatchSetRequest method. req, resp := client.CreateGeoMatchSetRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/CreateGeoMatchSet

CreateGeoMatchSetWithContext

func (c *WAFRegional) CreateGeoMatchSetWithContext(ctx aws.Context, input *waf.CreateGeoMatchSetInput, opts ...request.Option) (*waf.CreateGeoMatchSetOutput, error)

CreateGeoMatchSetWithContext is the same as CreateGeoMatchSet with the addition of the ability to pass a context and additional request options.

See CreateGeoMatchSet for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

CreateIPSet

func (c *WAFRegional) CreateIPSet(input *waf.CreateIPSetInput) (*waf.CreateIPSetOutput, error)

CreateIPSet API operation for AWS WAF Regional.

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

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

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

Submit a CreateIPSet request.

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

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

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS WAF Regional's API operation CreateIPSet for usage and error information.

Returned Error Codes:

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

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

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

  • ErrCodeWAFDisallowedNameException "WAFDisallowedNameException" The name specified is invalid.

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

  • You specified an invalid parameter name.

  • You specified an invalid value.

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

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

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

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

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

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

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

  • ErrCodeWAFLimitsExceededException "WAFLimitsExceededException" The operation exceeds a resource limit, for example, the maximum number of WebACL objects that you can create for an AWS account. For more information, see Limits (https://docs.aws.amazon.com/waf/latest/developerguide/limits.html) in the AWS WAF Developer Guide.

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/CreateIPSet

Example

WAFRegional CreateIPSet shared00

To create an IP set

The following example creates an IP match set named MyIPSetFriendlyName.

{ svc := wafregional.New(session.New()) input := &waf.CreateIPSetInput{ ChangeToken: aws.String("abcd12f2-46da-4fdb-b8d5-fbd4c466928f"), Name: aws.String("MyIPSetFriendlyName"), } result, err := svc.CreateIPSet(input) if err != nil { if aerr, ok := err.(awserr.Error); ok { switch aerr.Code() { case wafregional.ErrCodeWAFStaleDataException: fmt.Println(wafregional.ErrCodeWAFStaleDataException, aerr.Error()) case wafregional.ErrCodeWAFInternalErrorException: fmt.Println(wafregional.ErrCodeWAFInternalErrorException, aerr.Error()) case wafregional.ErrCodeWAFInvalidAccountException: fmt.Println(wafregional.ErrCodeWAFInvalidAccountException, aerr.Error()) case wafregional.ErrCodeWAFDisallowedNameException: fmt.Println(wafregional.ErrCodeWAFDisallowedNameException, aerr.Error()) case wafregional.ErrCodeWAFInvalidParameterException: fmt.Println(wafregional.ErrCodeWAFInvalidParameterException, aerr.Error()) case wafregional.ErrCodeWAFLimitsExceededException: fmt.Println(wafregional.ErrCodeWAFLimitsExceededException, aerr.Error()) default: fmt.Println(aerr.Error()) } } else { fmt.Println(err.Error()) } return } fmt.Println(result) }

CreateIPSetRequest

func (c *WAFRegional) CreateIPSetRequest(input *waf.CreateIPSetInput) (req *request.Request, output *waf.CreateIPSetOutput)

CreateIPSetRequest generates a "aws/request.Request" representing the client's request for the CreateIPSet operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateIPSet for more information on using the CreateIPSet API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateIPSetRequest method. req, resp := client.CreateIPSetRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/CreateIPSet

CreateIPSetWithContext

func (c *WAFRegional) CreateIPSetWithContext(ctx aws.Context, input *waf.CreateIPSetInput, opts ...request.Option) (*waf.CreateIPSetOutput, error)

CreateIPSetWithContext is the same as CreateIPSet with the addition of the ability to pass a context and additional request options.

See CreateIPSet for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

CreateRateBasedRule

func (c *WAFRegional) CreateRateBasedRule(input *waf.CreateRateBasedRuleInput) (*waf.CreateRateBasedRuleOutput, error)

CreateRateBasedRule API operation for AWS WAF Regional.

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

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

  • An IPSet that matches the IP address 192.0.2.44/32

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

Further, you specify a RateLimit of 15,000.

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

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

  • A ByteMatchSet with FieldToMatch of URI

  • A PositionalConstraint of STARTS_WITH

  • A TargetString of login

Further, you specify a RateLimit of 15,000.

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

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

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

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

Submit a CreateRateBasedRule request.

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

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

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

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS WAF Regional's API operation CreateRateBasedRule for usage and error information.

Returned Error Codes:

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

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

  • ErrCodeWAFDisallowedNameException "WAFDisallowedNameException" The name specified is invalid.

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

  • You specified an invalid parameter name.

  • You specified an invalid value.

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

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

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

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

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

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

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

  • ErrCodeWAFLimitsExceededException "WAFLimitsExceededException" The operation exceeds a resource limit, for example, the maximum number of WebACL objects that you can create for an AWS account. For more information, see Limits (https://docs.aws.amazon.com/waf/latest/developerguide/limits.html) in the AWS WAF Developer Guide.

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/CreateRateBasedRule

CreateRateBasedRuleRequest

func (c *WAFRegional) CreateRateBasedRuleRequest(input *waf.CreateRateBasedRuleInput) (req *request.Request, output *waf.CreateRateBasedRuleOutput)

CreateRateBasedRuleRequest generates a "aws/request.Request" representing the client's request for the CreateRateBasedRule operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateRateBasedRule for more information on using the CreateRateBasedRule API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateRateBasedRuleRequest method. req, resp := client.CreateRateBasedRuleRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/CreateRateBasedRule

CreateRateBasedRuleWithContext

func (c *WAFRegional) CreateRateBasedRuleWithContext(ctx aws.Context, input *waf.CreateRateBasedRuleInput, opts ...request.Option) (*waf.CreateRateBasedRuleOutput, error)

CreateRateBasedRuleWithContext is the same as CreateRateBasedRule with the addition of the ability to pass a context and additional request options.

See CreateRateBasedRule for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

CreateRegexMatchSet

func (c *WAFRegional) CreateRegexMatchSet(input *waf.CreateRegexMatchSetInput) (*waf.CreateRegexMatchSetOutput, error)

CreateRegexMatchSet API operation for AWS WAF Regional.

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

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

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

Submit a CreateRegexMatchSet request.

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

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

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS WAF Regional's API operation CreateRegexMatchSet for usage and error information.

Returned Error Codes:

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

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

  • ErrCodeWAFDisallowedNameException "WAFDisallowedNameException" The name specified is invalid.

  • ErrCodeWAFLimitsExceededException "WAFLimitsExceededException" The operation exceeds a resource limit, for example, the maximum number of WebACL objects that you can create for an AWS account. For more information, see Limits (https://docs.aws.amazon.com/waf/latest/developerguide/limits.html) in the AWS WAF Developer Guide.

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/CreateRegexMatchSet

CreateRegexMatchSetRequest

func (c *WAFRegional) CreateRegexMatchSetRequest(input *waf.CreateRegexMatchSetInput) (req *request.Request, output *waf.CreateRegexMatchSetOutput)

CreateRegexMatchSetRequest generates a "aws/request.Request" representing the client's request for the CreateRegexMatchSet operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateRegexMatchSet for more information on using the CreateRegexMatchSet API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateRegexMatchSetRequest method. req, resp := client.CreateRegexMatchSetRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/CreateRegexMatchSet

CreateRegexMatchSetWithContext

func (c *WAFRegional) CreateRegexMatchSetWithContext(ctx aws.Context, input *waf.CreateRegexMatchSetInput, opts ...request.Option) (*waf.CreateRegexMatchSetOutput, error)

CreateRegexMatchSetWithContext is the same as CreateRegexMatchSet with the addition of the ability to pass a context and additional request options.

See CreateRegexMatchSet for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

CreateRegexPatternSet

func (c *WAFRegional) CreateRegexPatternSet(input *waf.CreateRegexPatternSetInput) (*waf.CreateRegexPatternSetOutput, error)

CreateRegexPatternSet API operation for AWS WAF Regional.

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

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

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

Submit a CreateRegexPatternSet request.

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

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

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS WAF Regional's API operation CreateRegexPatternSet for usage and error information.

Returned Error Codes:

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

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

  • ErrCodeWAFDisallowedNameException "WAFDisallowedNameException" The name specified is invalid.

  • ErrCodeWAFLimitsExceededException "WAFLimitsExceededException" The operation exceeds a resource limit, for example, the maximum number of WebACL objects that you can create for an AWS account. For more information, see Limits (https://docs.aws.amazon.com/waf/latest/developerguide/limits.html) in the AWS WAF Developer Guide.

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/CreateRegexPatternSet

CreateRegexPatternSetRequest

func (c *WAFRegional) CreateRegexPatternSetRequest(input *waf.CreateRegexPatternSetInput) (req *request.Request, output *waf.CreateRegexPatternSetOutput)

CreateRegexPatternSetRequest generates a "aws/request.Request" representing the client's request for the CreateRegexPatternSet operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateRegexPatternSet for more information on using the CreateRegexPatternSet API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateRegexPatternSetRequest method. req, resp := client.CreateRegexPatternSetRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/CreateRegexPatternSet

CreateRegexPatternSetWithContext

func (c *WAFRegional) CreateRegexPatternSetWithContext(ctx aws.Context, input *waf.CreateRegexPatternSetInput, opts ...request.Option) (*waf.CreateRegexPatternSetOutput, error)

CreateRegexPatternSetWithContext is the same as CreateRegexPatternSet with the addition of the ability to pass a context and additional request options.

See CreateRegexPatternSet for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

CreateRule

func (c *WAFRegional) CreateRule(input *waf.CreateRuleInput) (*waf.CreateRuleOutput, error)

CreateRule API operation for AWS WAF Regional.

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

  • An IPSet that matches the IP address 192.0.2.44/32

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

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

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

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

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

Submit a CreateRule request.

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

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

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

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS WAF Regional's API operation CreateRule for usage and error information.

Returned Error Codes:

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

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

  • ErrCodeWAFDisallowedNameException "WAFDisallowedNameException" The name specified is invalid.

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

  • You specified an invalid parameter name.

  • You specified an invalid value.

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

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

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

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

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

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

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

  • ErrCodeWAFLimitsExceededException "WAFLimitsExceededException" The operation exceeds a resource limit, for example, the maximum number of WebACL objects that you can create for an AWS account. For more information, see Limits (https://docs.aws.amazon.com/waf/latest/developerguide/limits.html) in the AWS WAF Developer Guide.

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/CreateRule

Example

WAFRegional CreateRule shared00

To create a rule

The following example creates a rule named WAFByteHeaderRule.

{ svc := wafregional.New(session.New()) input := &waf.CreateRuleInput{ ChangeToken: aws.String("abcd12f2-46da-4fdb-b8d5-fbd4c466928f"), MetricName: aws.String("WAFByteHeaderRule"), Name: aws.String("WAFByteHeaderRule"), } result, err := svc.CreateRule(input) if err != nil { if aerr, ok := err.(awserr.Error); ok { switch aerr.Code() { case wafregional.ErrCodeWAFStaleDataException: fmt.Println(wafregional.ErrCodeWAFStaleDataException, aerr.Error()) case wafregional.ErrCodeWAFInternalErrorException: fmt.Println(wafregional.ErrCodeWAFInternalErrorException, aerr.Error()) case wafregional.ErrCodeWAFDisallowedNameException: fmt.Println(wafregional.ErrCodeWAFDisallowedNameException, aerr.Error()) case wafregional.ErrCodeWAFInvalidParameterException: fmt.Println(wafregional.ErrCodeWAFInvalidParameterException, aerr.Error()) case wafregional.ErrCodeWAFLimitsExceededException: fmt.Println(wafregional.ErrCodeWAFLimitsExceededException, aerr.Error()) default: fmt.Println(aerr.Error()) } } else { fmt.Println(err.Error()) } return } fmt.Println(result) }

CreateRuleGroup

func (c *WAFRegional) CreateRuleGroup(input *waf.CreateRuleGroupInput) (*waf.CreateRuleGroupOutput, error)

CreateRuleGroup API operation for AWS WAF Regional.

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

Rule groups are subject to the following limits:

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

  • One rule group per web ACL.

  • Ten rules per rule group.

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS WAF Regional's API operation CreateRuleGroup for usage and error information.

Returned Error Codes:

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

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

  • ErrCodeWAFDisallowedNameException "WAFDisallowedNameException" The name specified is invalid.

  • ErrCodeWAFLimitsExceededException "WAFLimitsExceededException" The operation exceeds a resource limit, for example, the maximum number of WebACL objects that you can create for an AWS account. For more information, see Limits (https://docs.aws.amazon.com/waf/latest/developerguide/limits.html) in the AWS WAF Developer Guide.

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/CreateRuleGroup

CreateRuleGroupRequest

func (c *WAFRegional) CreateRuleGroupRequest(input *waf.CreateRuleGroupInput) (req *request.Request, output *waf.CreateRuleGroupOutput)

CreateRuleGroupRequest generates a "aws/request.Request" representing the client's request for the CreateRuleGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateRuleGroup for more information on using the CreateRuleGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateRuleGroupRequest method. req, resp := client.CreateRuleGroupRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/CreateRuleGroup

CreateRuleGroupWithContext

func (c *WAFRegional) CreateRuleGroupWithContext(ctx aws.Context, input *waf.CreateRuleGroupInput, opts ...request.Option) (*waf.CreateRuleGroupOutput, error)

CreateRuleGroupWithContext is the same as CreateRuleGroup with the addition of the ability to pass a context and additional request options.

See CreateRuleGroup for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

CreateRuleRequest

func (c *WAFRegional) CreateRuleRequest(input *waf.CreateRuleInput) (req *request.Request, output *waf.CreateRuleOutput)

CreateRuleRequest generates a "aws/request.Request" representing the client's request for the CreateRule operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateRule for more information on using the CreateRule API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateRuleRequest method. req, resp := client.CreateRuleRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/CreateRule

CreateRuleWithContext

func (c *WAFRegional) CreateRuleWithContext(ctx aws.Context, input *waf.CreateRuleInput, opts ...request.Option) (*waf.CreateRuleOutput, error)

CreateRuleWithContext is the same as CreateRule with the addition of the ability to pass a context and additional request options.

See CreateRule for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

CreateSizeConstraintSet

func (c *WAFRegional) CreateSizeConstraintSet(input *waf.CreateSizeConstraintSetInput) (*waf.CreateSizeConstraintSetOutput, error)

CreateSizeConstraintSet API operation for AWS WAF Regional.

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

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

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

Submit a CreateSizeConstraintSet request.

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

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

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS WAF Regional's API operation CreateSizeConstraintSet for usage and error information.

Returned Error Codes:

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

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

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

  • ErrCodeWAFDisallowedNameException "WAFDisallowedNameException" The name specified is invalid.

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

  • You specified an invalid parameter name.

  • You specified an invalid value.

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

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

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

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

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

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

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

  • ErrCodeWAFLimitsExceededException "WAFLimitsExceededException" The operation exceeds a resource limit, for example, the maximum number of WebACL objects that you can create for an AWS account. For more information, see Limits (https://docs.aws.amazon.com/waf/latest/developerguide/limits.html) in the AWS WAF Developer Guide.

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/CreateSizeConstraintSet

Example

WAFRegional CreateSizeConstraintSet shared00

To create a size constraint

The following example creates size constraint set named MySampleSizeConstraintSet.

{ svc := wafregional.New(session.New()) input := &waf.CreateSizeConstraintSetInput{ ChangeToken: aws.String("abcd12f2-46da-4fdb-b8d5-fbd4c466928f"), Name: aws.String("MySampleSizeConstraintSet"), } result, err := svc.CreateSizeConstraintSet(input) if err != nil { if aerr, ok := err.(awserr.Error); ok { switch aerr.Code() { case wafregional.ErrCodeWAFStaleDataException: fmt.Println(wafregional.ErrCodeWAFStaleDataException, aerr.Error()) case wafregional.ErrCodeWAFInternalErrorException: fmt.Println(wafregional.ErrCodeWAFInternalErrorException, aerr.Error()) case wafregional.ErrCodeWAFInvalidAccountException: fmt.Println(wafregional.ErrCodeWAFInvalidAccountException, aerr.Error()) case wafregional.ErrCodeWAFDisallowedNameException: fmt.Println(wafregional.ErrCodeWAFDisallowedNameException, aerr.Error()) case wafregional.ErrCodeWAFInvalidParameterException: fmt.Println(wafregional.ErrCodeWAFInvalidParameterException, aerr.Error()) case wafregional.ErrCodeWAFLimitsExceededException: fmt.Println(wafregional.ErrCodeWAFLimitsExceededException, aerr.Error()) default: fmt.Println(aerr.Error()) } } else { fmt.Println(err.Error()) } return } fmt.Println(result) }

CreateSizeConstraintSetRequest

func (c *WAFRegional) CreateSizeConstraintSetRequest(input *waf.CreateSizeConstraintSetInput) (req *request.Request, output *waf.CreateSizeConstraintSetOutput)

CreateSizeConstraintSetRequest generates a "aws/request.Request" representing the client's request for the CreateSizeConstraintSet operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateSizeConstraintSet for more information on using the CreateSizeConstraintSet API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateSizeConstraintSetRequest method. req, resp := client.CreateSizeConstraintSetRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/CreateSizeConstraintSet

CreateSizeConstraintSetWithContext

func (c *WAFRegional) CreateSizeConstraintSetWithContext(ctx aws.Context, input *waf.CreateSizeConstraintSetInput, opts ...request.Option) (*waf.CreateSizeConstraintSetOutput, error)

CreateSizeConstraintSetWithContext is the same as CreateSizeConstraintSet with the addition of the ability to pass a context and additional request options.

See CreateSizeConstraintSet for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

CreateSqlInjectionMatchSet

func (c *WAFRegional) CreateSqlInjectionMatchSet(input *waf.CreateSqlInjectionMatchSetInput) (*waf.CreateSqlInjectionMatchSetOutput, error)

CreateSqlInjectionMatchSet API operation for AWS WAF Regional.

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

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

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

Submit a CreateSqlInjectionMatchSet request.

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

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

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS WAF Regional's API operation CreateSqlInjectionMatchSet for usage and error information.

Returned Error Codes:

  • ErrCodeWAFDisallowedNameException "WAFDisallowedNameException" The name specified is invalid.

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

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

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

  • You specified an invalid parameter name.

  • You specified an invalid value.

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

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

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

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

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

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

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

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

  • ErrCodeWAFLimitsExceededException "WAFLimitsExceededException" The operation exceeds a resource limit, for example, the maximum number of WebACL objects that you can create for an AWS account. For more information, see Limits (https://docs.aws.amazon.com/waf/latest/developerguide/limits.html) in the AWS WAF Developer Guide.

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/CreateSqlInjectionMatchSet

Example

WAFRegional CreateSqlInjectionMatchSet shared00

To create a SQL injection match set

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

{ svc := wafregional.New(session.New()) input := &waf.CreateSqlInjectionMatchSetInput{ ChangeToken: aws.String("abcd12f2-46da-4fdb-b8d5-fbd4c466928f"), Name: aws.String("MySQLInjectionMatchSet"), } result, err := svc.CreateSqlInjectionMatchSet(input) if err != nil { if aerr, ok := err.(awserr.Error); ok { switch aerr.Code() { case wafregional.ErrCodeWAFDisallowedNameException: fmt.Println(wafregional.ErrCodeWAFDisallowedNameException, aerr.Error()) case wafregional.ErrCodeWAFInternalErrorException: fmt.Println(wafregional.ErrCodeWAFInternalErrorException, aerr.Error()) case wafregional.ErrCodeWAFInvalidAccountException: fmt.Println(wafregional.ErrCodeWAFInvalidAccountException, aerr.Error()) case wafregional.ErrCodeWAFInvalidParameterException: fmt.Println(wafregional.ErrCodeWAFInvalidParameterException, aerr.Error()) case wafregional.ErrCodeWAFStaleDataException: fmt.Println(wafregional.ErrCodeWAFStaleDataException, aerr.Error()) case wafregional.ErrCodeWAFLimitsExceededException: fmt.Println(wafregional.ErrCodeWAFLimitsExceededException, aerr.Error()) default: fmt.Println(aerr.Error()) } } else { fmt.Println(err.Error()) } return } fmt.Println(result) }

CreateSqlInjectionMatchSetRequest

func (c *WAFRegional) CreateSqlInjectionMatchSetRequest(input *waf.CreateSqlInjectionMatchSetInput) (req *request.Request, output *waf.CreateSqlInjectionMatchSetOutput)

CreateSqlInjectionMatchSetRequest generates a "aws/request.Request" representing the client's request for the CreateSqlInjectionMatchSet operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateSqlInjectionMatchSet for more information on using the CreateSqlInjectionMatchSet API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateSqlInjectionMatchSetRequest method. req, resp := client.CreateSqlInjectionMatchSetRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/CreateSqlInjectionMatchSet

CreateSqlInjectionMatchSetWithContext

func (c *WAFRegional) CreateSqlInjectionMatchSetWithContext(ctx aws.Context, input *waf.CreateSqlInjectionMatchSetInput, opts ...request.Option) (*waf.CreateSqlInjectionMatchSetOutput, error)

CreateSqlInjectionMatchSetWithContext is the same as CreateSqlInjectionMatchSet with the addition of the ability to pass a context and additional request options.

See CreateSqlInjectionMatchSet for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

CreateWebACL

func (c *WAFRegional) CreateWebACL(input *waf.CreateWebACLInput) (*waf.CreateWebACLOutput, error)

CreateWebACL API operation for AWS WAF Regional.

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

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

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

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

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

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

Submit a CreateWebACL request.

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

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

For more information about how to use the AWS WAF API, see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS WAF Regional's API operation CreateWebACL for usage and error information.

Returned Error Codes:

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

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

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

  • ErrCodeWAFDisallowedNameException "WAFDisallowedNameException" The name specified is invalid.

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

  • You specified an invalid parameter name.

  • You specified an invalid value.

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

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

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

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

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

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

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

  • ErrCodeWAFLimitsExceededException "WAFLimitsExceededException" The operation exceeds a resource limit, for example, the maximum number of WebACL objects that you can create for an AWS account. For more information, see Limits (https://docs.aws.amazon.com/waf/latest/developerguide/limits.html) in the AWS WAF Developer Guide.

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/CreateWebACL

Example

WAFRegional CreateWebACL shared00

To create a web ACL

The following example creates a web ACL named CreateExample.

{ svc := wafregional.New(session.New()) input := &waf.CreateWebACLInput{ ChangeToken: aws.String("abcd12f2-46da-4fdb-b8d5-fbd4c466928f"), DefaultAction: &waf.WafAction{ Type: aws.String("ALLOW"), }, MetricName: aws.String("CreateExample"), Name: aws.String("CreateExample"), } result, err := svc.CreateWebACL(input) if err != nil { if aerr, ok := err.(awserr.Error); ok { switch aerr.Code() { case wafregional.ErrCodeWAFStaleDataException: fmt.Println(wafregional.ErrCodeWAFStaleDataException, aerr.Error()) case wafregional.ErrCodeWAFInternalErrorException: fmt.Println(wafregional.ErrCodeWAFInternalErrorException, aerr.Error()) case wafregional.ErrCodeWAFInvalidAccountException: fmt.Println(wafregional.ErrCodeWAFInvalidAccountException, aerr.Error()) case wafregional.ErrCodeWAFDisallowedNameException: fmt.Println(wafregional.ErrCodeWAFDisallowedNameException, aerr.Error()) case wafregional.ErrCodeWAFInvalidParameterException: fmt.Println(wafregional.ErrCodeWAFInvalidParameterException, aerr.Error()) case wafregional.ErrCodeWAFLimitsExceededException: fmt.Println(wafregional.ErrCodeWAFLimitsExceededException, aerr.Error()) default: fmt.Println(aerr.Error()) } } else { fmt.Println(err.Error()) } return } fmt.Println(result) }

CreateWebACLRequest

func (c *WAFRegional) CreateWebACLRequest(input *waf.CreateWebACLInput) (req *request.Request, output *waf.CreateWebACLOutput)

CreateWebACLRequest generates a "aws/request.Request" representing the client's request for the CreateWebACL operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateWebACL for more information on using the CreateWebACL API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateWebACLRequest method. req, resp := client.CreateWebACLRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/CreateWebACL

CreateWebACLWithContext

func (c *WAFRegional) CreateWebACLWithContext(ctx aws.Context, input *waf.CreateWebACLInput, opts ...request.Option) (*waf.CreateWebACLOutput, error)

CreateWebACLWithContext is the same as CreateWebACL with the addition of the ability to pass a context and additional request options.

See CreateWebACL for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

CreateXssMatchSet

func (c *WAFRegional) CreateXssMatchSet(input *waf.CreateXssMatchSetInput) (*waf.CreateXssMatchSetOutput, error)

CreateXssMatchSet API operation for AWS WAF Regional.

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

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

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

Submit a CreateXssMatchSet request.

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

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

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS WAF Regional's API operation CreateXssMatchSet for usage and error information.

Returned Error Codes:

  • ErrCodeWAFDisallowedNameException "WAFDisallowedNameException" The name specified is invalid.

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

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

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

  • You specified an invalid parameter name.

  • You specified an invalid value.

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

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

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

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

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

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

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

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

  • ErrCodeWAFLimitsExceededException "WAFLimitsExceededException" The operation exceeds a resource limit, for example, the maximum number of WebACL objects that you can create for an AWS account. For more information, see Limits (https://docs.aws.amazon.com/waf/latest/developerguide/limits.html) in the AWS WAF Developer Guide.

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/CreateXssMatchSet

Example

WAFRegional CreateXssMatchSet shared00

To create an XSS match set

The following example creates an XSS match set named MySampleXssMatchSet.

{ svc := wafregional.New(session.New()) input := &waf.CreateXssMatchSetInput{ ChangeToken: aws.String("abcd12f2-46da-4fdb-b8d5-fbd4c466928f"), Name: aws.String("MySampleXssMatchSet"), } result, err := svc.CreateXssMatchSet(input) if err != nil { if aerr, ok := err.(awserr.Error); ok { switch aerr.Code() { case wafregional.ErrCodeWAFDisallowedNameException: fmt.Println(wafregional.ErrCodeWAFDisallowedNameException, aerr.Error()) case wafregional.ErrCodeWAFInternalErrorException: fmt.Println(wafregional.ErrCodeWAFInternalErrorException, aerr.Error()) case wafregional.ErrCodeWAFInvalidAccountException: fmt.Println(wafregional.ErrCodeWAFInvalidAccountException, aerr.Error()) case wafregional.ErrCodeWAFInvalidParameterException: fmt.Println(wafregional.ErrCodeWAFInvalidParameterException, aerr.Error()) case wafregional.ErrCodeWAFStaleDataException: fmt.Println(wafregional.ErrCodeWAFStaleDataException, aerr.Error()) case wafregional.ErrCodeWAFLimitsExceededException: fmt.Println(wafregional.ErrCodeWAFLimitsExceededException, aerr.Error()) default: fmt.Println(aerr.Error()) } } else { fmt.Println(err.Error()) } return } fmt.Println(result) }

CreateXssMatchSetRequest

func (c *WAFRegional) CreateXssMatchSetRequest(input *waf.CreateXssMatchSetInput) (req *request.Request, output *waf.CreateXssMatchSetOutput)

CreateXssMatchSetRequest generates a "aws/request.Request" representing the client's request for the CreateXssMatchSet operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateXssMatchSet for more information on using the CreateXssMatchSet API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateXssMatchSetRequest method. req, resp := client.CreateXssMatchSetRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/CreateXssMatchSet

CreateXssMatchSetWithContext

func (c *WAFRegional) CreateXssMatchSetWithContext(ctx aws.Context, input *waf.CreateXssMatchSetInput, opts ...request.Option) (*waf.CreateXssMatchSetOutput, error)

CreateXssMatchSetWithContext is the same as CreateXssMatchSet with the addition of the ability to pass a context and additional request options.

See CreateXssMatchSet for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

DeleteByteMatchSet

func (c *WAFRegional) DeleteByteMatchSet(input *waf.DeleteByteMatchSetInput) (*waf.DeleteByteMatchSetOutput, error)

DeleteByteMatchSet API operation for AWS WAF Regional.

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

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

To permanently delete a ByteMatchSet, perform the following steps:

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

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

Submit a DeleteByteMatchSet request.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS WAF Regional's API operation DeleteByteMatchSet for usage and error information.

Returned Error Codes:

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

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

  • ErrCodeWAFNonexistentItemException "WAFNonexistentItemException" The operation failed because the referenced object doesn't exist.

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

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

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

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

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

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/DeleteByteMatchSet

Example

WAFRegional DeleteByteMatchSet shared00

To delete a byte match set

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

{ svc := wafregional.New(session.New()) input := &waf.DeleteByteMatchSetInput{ ByteMatchSetId: aws.String("exampleIDs3t-46da-4fdb-b8d5-abc321j569j5"), ChangeToken: aws.String("abcd12f2-46da-4fdb-b8d5-fbd4c466928f"), } result, err := svc.DeleteByteMatchSet(input) if err != nil { if aerr, ok := err.(awserr.Error); ok { switch aerr.Code() { case wafregional.ErrCodeWAFInternalErrorException: fmt.Println(wafregional.ErrCodeWAFInternalErrorException, aerr.Error()) case wafregional.ErrCodeWAFInvalidAccountException: fmt.Println(wafregional.ErrCodeWAFInvalidAccountException, aerr.Error()) case wafregional.ErrCodeWAFNonexistentItemException: fmt.Println(wafregional.ErrCodeWAFNonexistentItemException, aerr.Error()) case wafregional.ErrCodeWAFReferencedItemException: fmt.Println(wafregional.ErrCodeWAFReferencedItemException, aerr.Error()) case wafregional.ErrCodeWAFStaleDataException: fmt.Println(wafregional.ErrCodeWAFStaleDataException, aerr.Error()) case wafregional.ErrCodeWAFNonEmptyEntityException: fmt.Println(wafregional.ErrCodeWAFNonEmptyEntityException, aerr.Error()) default: fmt.Println(aerr.Error()) } } else { fmt.Println(err.Error()) } return } fmt.Println(result) }

DeleteByteMatchSetRequest

func (c *WAFRegional) DeleteByteMatchSetRequest(input *waf.DeleteByteMatchSetInput) (req *request.Request, output *waf.DeleteByteMatchSetOutput)

DeleteByteMatchSetRequest generates a "aws/request.Request" representing the client's request for the DeleteByteMatchSet operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteByteMatchSet for more information on using the DeleteByteMatchSet API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteByteMatchSetRequest method. req, resp := client.DeleteByteMatchSetRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/DeleteByteMatchSet

DeleteByteMatchSetWithContext

func (c *WAFRegional) DeleteByteMatchSetWithContext(ctx aws.Context, input *waf.DeleteByteMatchSetInput, opts ...request.Option) (*waf.DeleteByteMatchSetOutput, error)

DeleteByteMatchSetWithContext is the same as DeleteByteMatchSet with the addition of the ability to pass a context and additional request options.

See DeleteByteMatchSet for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

DeleteGeoMatchSet

func (c *WAFRegional) DeleteGeoMatchSet(input *waf.DeleteGeoMatchSetInput) (*waf.DeleteGeoMatchSetOutput, error)

DeleteGeoMatchSet API operation for AWS WAF Regional.

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

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

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

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

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

Submit a DeleteGeoMatchSet request.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS WAF Regional's API operation DeleteGeoMatchSet for usage and error information.

Returned Error Codes:

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

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

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

  • ErrCodeWAFNonexistentItemException "WAFNonexistentItemException" The operation failed because the referenced object doesn't exist.

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

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

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

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

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/DeleteGeoMatchSet

DeleteGeoMatchSetRequest

func (c *WAFRegional) DeleteGeoMatchSetRequest(input *waf.DeleteGeoMatchSetInput) (req *request.Request, output *waf.DeleteGeoMatchSetOutput)

DeleteGeoMatchSetRequest generates a "aws/request.Request" representing the client's request for the DeleteGeoMatchSet operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteGeoMatchSet for more information on using the DeleteGeoMatchSet API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteGeoMatchSetRequest method. req, resp := client.DeleteGeoMatchSetRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/DeleteGeoMatchSet

DeleteGeoMatchSetWithContext

func (c *WAFRegional) DeleteGeoMatchSetWithContext(ctx aws.Context, input *waf.DeleteGeoMatchSetInput, opts ...request.Option) (*waf.DeleteGeoMatchSetOutput, error)

DeleteGeoMatchSetWithContext is the same as DeleteGeoMatchSet with the addition of the ability to pass a context and additional request options.

See DeleteGeoMatchSet for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

DeleteIPSet

func (c *WAFRegional) DeleteIPSet(input *waf.DeleteIPSetInput) (*waf.DeleteIPSetOutput, error)

DeleteIPSet API operation for AWS WAF Regional.

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

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

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

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

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

Submit a DeleteIPSet request.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS WAF Regional's API operation DeleteIPSet for usage and error information.

Returned Error Codes:

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

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

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

  • ErrCodeWAFNonexistentItemException "WAFNonexistentItemException" The operation failed because the referenced object doesn't exist.

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

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

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

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

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/DeleteIPSet

Example

WAFRegional DeleteIPSet shared00

To delete an IP set

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

{ svc := wafregional.New(session.New()) input := &waf.DeleteIPSetInput{ ChangeToken: aws.String("abcd12f2-46da-4fdb-b8d5-fbd4c466928f"), IPSetId: aws.String("example1ds3t-46da-4fdb-b8d5-abc321j569j5"), } result, err := svc.DeleteIPSet(input) if err != nil { if aerr, ok := err.(awserr.Error); ok { switch aerr.Code() { case wafregional.ErrCodeWAFStaleDataException: fmt.Println(wafregional.ErrCodeWAFStaleDataException, aerr.Error()) case wafregional.ErrCodeWAFInternalErrorException: fmt.Println(wafregional.ErrCodeWAFInternalErrorException, aerr.Error()) case wafregional.ErrCodeWAFInvalidAccountException: fmt.Println(wafregional.ErrCodeWAFInvalidAccountException, aerr.Error()) case wafregional.ErrCodeWAFNonexistentItemException: fmt.Println(wafregional.ErrCodeWAFNonexistentItemException, aerr.Error()) case wafregional.ErrCodeWAFReferencedItemException: fmt.Println(wafregional.ErrCodeWAFReferencedItemException, aerr.Error()) case wafregional.ErrCodeWAFNonEmptyEntityException: fmt.Println(wafregional.ErrCodeWAFNonEmptyEntityException, aerr.Error()) default: fmt.Println(aerr.Error()) } } else { fmt.Println(err.Error()) } return } fmt.Println(result) }

DeleteIPSetRequest

func (c *WAFRegional) DeleteIPSetRequest(input *waf.DeleteIPSetInput) (req *request.Request, output *waf.DeleteIPSetOutput)

DeleteIPSetRequest generates a "aws/request.Request" representing the client's request for the DeleteIPSet operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteIPSet for more information on using the DeleteIPSet API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteIPSetRequest method. req, resp := client.DeleteIPSetRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/DeleteIPSet

DeleteIPSetWithContext

func (c *WAFRegional) DeleteIPSetWithContext(ctx aws.Context, input *waf.DeleteIPSetInput, opts ...request.Option) (*waf.DeleteIPSetOutput, error)

DeleteIPSetWithContext is the same as DeleteIPSet with the addition of the ability to pass a context and additional request options.

See DeleteIPSet for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

DeleteLoggingConfiguration

func (c *WAFRegional) DeleteLoggingConfiguration(input *waf.DeleteLoggingConfigurationInput) (*waf.DeleteLoggingConfigurationOutput, error)

DeleteLoggingConfiguration API operation for AWS WAF Regional.

Permanently deletes the LoggingConfiguration from the specified web ACL.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS WAF Regional's API operation DeleteLoggingConfiguration for usage and error information.

Returned Error Codes:

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

  • ErrCodeWAFNonexistentItemException "WAFNonexistentItemException" The operation failed because the referenced object doesn't exist.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/DeleteLoggingConfiguration

DeleteLoggingConfigurationRequest

func (c *WAFRegional) DeleteLoggingConfigurationRequest(input *waf.DeleteLoggingConfigurationInput) (req *request.Request, output *waf.DeleteLoggingConfigurationOutput)

DeleteLoggingConfigurationRequest generates a "aws/request.Request" representing the client's request for the DeleteLoggingConfiguration operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteLoggingConfiguration for more information on using the DeleteLoggingConfiguration API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteLoggingConfigurationRequest method. req, resp := client.DeleteLoggingConfigurationRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/DeleteLoggingConfiguration

DeleteLoggingConfigurationWithContext

func (c *WAFRegional) DeleteLoggingConfigurationWithContext(ctx aws.Context, input *waf.DeleteLoggingConfigurationInput, opts ...request.Option) (*waf.DeleteLoggingConfigurationOutput, error)

DeleteLoggingConfigurationWithContext is the same as DeleteLoggingConfiguration with the addition of the ability to pass a context and additional request options.

See DeleteLoggingConfiguration for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

DeletePermissionPolicy

func (c *WAFRegional) DeletePermissionPolicy(input *waf.DeletePermissionPolicyInput) (*waf.DeletePermissionPolicyOutput, error)

DeletePermissionPolicy API operation for AWS WAF Regional.

Permanently deletes an IAM policy from the specified RuleGroup.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS WAF Regional's API operation DeletePermissionPolicy for usage and error information.

Returned Error Codes:

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

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

  • ErrCodeWAFNonexistentItemException "WAFNonexistentItemException" The operation failed because the referenced object doesn't exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/DeletePermissionPolicy

DeletePermissionPolicyRequest

func (c *WAFRegional) DeletePermissionPolicyRequest(input *waf.DeletePermissionPolicyInput) (req *request.Request, output *waf.DeletePermissionPolicyOutput)

DeletePermissionPolicyRequest generates a "aws/request.Request" representing the client's request for the DeletePermissionPolicy operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeletePermissionPolicy for more information on using the DeletePermissionPolicy API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeletePermissionPolicyRequest method. req, resp := client.DeletePermissionPolicyRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/DeletePermissionPolicy

DeletePermissionPolicyWithContext

func (c *WAFRegional) DeletePermissionPolicyWithContext(ctx aws.Context, input *waf.DeletePermissionPolicyInput, opts ...request.Option) (*waf.DeletePermissionPolicyOutput, error)

DeletePermissionPolicyWithContext is the same as DeletePermissionPolicy with the addition of the ability to pass a context and additional request options.

See DeletePermissionPolicy for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

DeleteRateBasedRule

func (c *WAFRegional) DeleteRateBasedRule(input *waf.DeleteRateBasedRuleInput) (*waf.DeleteRateBasedRuleOutput, error)

DeleteRateBasedRule API operation for AWS WAF Regional.

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

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

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

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

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

Submit a DeleteRateBasedRule request.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS WAF Regional's API operation DeleteRateBasedRule for usage and error information.

Returned Error Codes:

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

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

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

  • ErrCodeWAFNonexistentItemException "WAFNonexistentItemException" The operation failed because the referenced object doesn't exist.

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

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

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

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

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/DeleteRateBasedRule

DeleteRateBasedRuleRequest

func (c *WAFRegional) DeleteRateBasedRuleRequest(input *waf.DeleteRateBasedRuleInput) (req *request.Request, output *waf.DeleteRateBasedRuleOutput)

DeleteRateBasedRuleRequest generates a "aws/request.Request" representing the client's request for the DeleteRateBasedRule operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteRateBasedRule for more information on using the DeleteRateBasedRule API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteRateBasedRuleRequest method. req, resp := client.DeleteRateBasedRuleRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/DeleteRateBasedRule

DeleteRateBasedRuleWithContext

func (c *WAFRegional) DeleteRateBasedRuleWithContext(ctx aws.Context, input *waf.DeleteRateBasedRuleInput, opts ...request.Option) (*waf.DeleteRateBasedRuleOutput, error)

DeleteRateBasedRuleWithContext is the same as DeleteRateBasedRule with the addition of the ability to pass a context and additional request options.

See DeleteRateBasedRule for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

DeleteRegexMatchSet

func (c *WAFRegional) DeleteRegexMatchSet(input *waf.DeleteRegexMatchSetInput) (*waf.DeleteRegexMatchSetOutput, error)

DeleteRegexMatchSet API operation for AWS WAF Regional.

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

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

To permanently delete a RegexMatchSet, perform the following steps:

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

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

Submit a DeleteRegexMatchSet request.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS WAF Regional's API operation DeleteRegexMatchSet for usage and error information.

Returned Error Codes:

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

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

  • ErrCodeWAFNonexistentItemException "WAFNonexistentItemException" The operation failed because the referenced object doesn't exist.

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

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

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

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

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

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/DeleteRegexMatchSet

DeleteRegexMatchSetRequest

func (c *WAFRegional) DeleteRegexMatchSetRequest(input *waf.DeleteRegexMatchSetInput) (req *request.Request, output *waf.DeleteRegexMatchSetOutput)

DeleteRegexMatchSetRequest generates a "aws/request.Request" representing the client's request for the DeleteRegexMatchSet operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteRegexMatchSet for more information on using the DeleteRegexMatchSet API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteRegexMatchSetRequest method. req, resp := client.DeleteRegexMatchSetRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/DeleteRegexMatchSet

DeleteRegexMatchSetWithContext

func (c *WAFRegional) DeleteRegexMatchSetWithContext(ctx aws.Context, input *waf.DeleteRegexMatchSetInput, opts ...request.Option) (*waf.DeleteRegexMatchSetOutput, error)

DeleteRegexMatchSetWithContext is the same as DeleteRegexMatchSet with the addition of the ability to pass a context and additional request options.

See DeleteRegexMatchSet for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

DeleteRegexPatternSet

func (c *WAFRegional) DeleteRegexPatternSet(input *waf.DeleteRegexPatternSetInput) (*waf.DeleteRegexPatternSetOutput, error)

DeleteRegexPatternSet API operation for AWS WAF Regional.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS WAF Regional's API operation DeleteRegexPatternSet for usage and error information.

Returned Error Codes:

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

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

  • ErrCodeWAFNonexistentItemException "WAFNonexistentItemException" The operation failed because the referenced object doesn't exist.

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

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

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

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

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

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/DeleteRegexPatternSet

DeleteRegexPatternSetRequest

func (c *WAFRegional) DeleteRegexPatternSetRequest(input *waf.DeleteRegexPatternSetInput) (req *request.Request, output *waf.DeleteRegexPatternSetOutput)

DeleteRegexPatternSetRequest generates a "aws/request.Request" representing the client's request for the DeleteRegexPatternSet operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteRegexPatternSet for more information on using the DeleteRegexPatternSet API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteRegexPatternSetRequest method. req, resp := client.DeleteRegexPatternSetRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/DeleteRegexPatternSet

DeleteRegexPatternSetWithContext

func (c *WAFRegional) DeleteRegexPatternSetWithContext(ctx aws.Context, input *waf.DeleteRegexPatternSetInput, opts ...request.Option) (*waf.DeleteRegexPatternSetOutput, error)

DeleteRegexPatternSetWithContext is the same as DeleteRegexPatternSet with the addition of the ability to pass a context and additional request options.

See DeleteRegexPatternSet for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

DeleteRule

func (c *WAFRegional) DeleteRule(input *waf.DeleteRuleInput) (*waf.DeleteRuleOutput, error)

DeleteRule API operation for AWS WAF Regional.

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

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

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

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

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

Submit a DeleteRule request.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS WAF Regional's API operation DeleteRule for usage and error information.

Returned Error Codes:

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

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

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

  • ErrCodeWAFNonexistentItemException "WAFNonexistentItemException" The operation failed because the referenced object doesn't exist.

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

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

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

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

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/DeleteRule

Example

WAFRegional DeleteRule shared00

To delete a rule

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

{ svc := wafregional.New(session.New()) input := &waf.DeleteRuleInput{ ChangeToken: aws.String("abcd12f2-46da-4fdb-b8d5-fbd4c466928f"), RuleId: aws.String("WAFRule-1-Example"), } result, err := svc.DeleteRule(input) if err != nil { if aerr, ok := err.(awserr.Error); ok { switch aerr.Code() { case wafregional.ErrCodeWAFStaleDataException: fmt.Println(wafregional.ErrCodeWAFStaleDataException, aerr.Error()) case wafregional.ErrCodeWAFInternalErrorException: fmt.Println(wafregional.ErrCodeWAFInternalErrorException, aerr.Error()) case wafregional.ErrCodeWAFInvalidAccountException: fmt.Println(wafregional.ErrCodeWAFInvalidAccountException, aerr.Error()) case wafregional.ErrCodeWAFNonexistentItemException: fmt.Println(wafregional.ErrCodeWAFNonexistentItemException, aerr.Error()) case wafregional.ErrCodeWAFReferencedItemException: fmt.Println(wafregional.ErrCodeWAFReferencedItemException, aerr.Error()) case wafregional.ErrCodeWAFNonEmptyEntityException: fmt.Println(wafregional.ErrCodeWAFNonEmptyEntityException, aerr.Error()) default: fmt.Println(aerr.Error()) } } else { fmt.Println(err.Error()) } return } fmt.Println(result) }

DeleteRuleGroup

func (c *WAFRegional) DeleteRuleGroup(input *waf.DeleteRuleGroupInput) (*waf.DeleteRuleGroupOutput, error)

DeleteRuleGroup API operation for AWS WAF Regional.

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

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

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

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

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

Submit a DeleteRuleGroup request.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS WAF Regional's API operation DeleteRuleGroup for usage and error information.

Returned Error Codes:

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

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

  • ErrCodeWAFNonexistentItemException "WAFNonexistentItemException" The operation failed because the referenced object doesn't exist.

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

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

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

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

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

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

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

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

  • ErrCodeWAFInvalidOperationException "WAFInvalidOperationException" The operation failed because there was nothing to do. For example:

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

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/DeleteRuleGroup

DeleteRuleGroupRequest

func (c *WAFRegional) DeleteRuleGroupRequest(input *waf.DeleteRuleGroupInput) (req *request.Request, output *waf.DeleteRuleGroupOutput)

DeleteRuleGroupRequest generates a "aws/request.Request" representing the client's request for the DeleteRuleGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteRuleGroup for more information on using the DeleteRuleGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteRuleGroupRequest method. req, resp := client.DeleteRuleGroupRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/DeleteRuleGroup

DeleteRuleGroupWithContext

func (c *WAFRegional) DeleteRuleGroupWithContext(ctx aws.Context, input *waf.DeleteRuleGroupInput, opts ...request.Option) (*waf.DeleteRuleGroupOutput, error)

DeleteRuleGroupWithContext is the same as DeleteRuleGroup with the addition of the ability to pass a context and additional request options.

See DeleteRuleGroup for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

DeleteRuleRequest

func (c *WAFRegional) DeleteRuleRequest(input *waf.DeleteRuleInput) (req *request.Request, output *waf.DeleteRuleOutput)

DeleteRuleRequest generates a "aws/request.Request" representing the client's request for the DeleteRule operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteRule for more information on using the DeleteRule API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteRuleRequest method. req, resp := client.DeleteRuleRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/DeleteRule

DeleteRuleWithContext

func (c *WAFRegional) DeleteRuleWithContext(ctx aws.Context, input *waf.DeleteRuleInput, opts ...request.Option) (*waf.DeleteRuleOutput, error)

DeleteRuleWithContext is the same as DeleteRule with the addition of the ability to pass a context and additional request options.

See DeleteRule for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

DeleteSizeConstraintSet

func (c *WAFRegional) DeleteSizeConstraintSet(input *waf.DeleteSizeConstraintSetInput) (*waf.DeleteSizeConstraintSetOutput, error)

DeleteSizeConstraintSet API operation for AWS WAF Regional.

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

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

To permanently delete a SizeConstraintSet, perform the following steps:

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

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

Submit a DeleteSizeConstraintSet request.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS WAF Regional's API operation DeleteSizeConstraintSet for usage and error information.

Returned Error Codes:

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

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

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

  • ErrCodeWAFNonexistentItemException "WAFNonexistentItemException" The operation failed because the referenced object doesn't exist.

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

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

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

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

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/DeleteSizeConstraintSet

Example

WAFRegional DeleteSizeConstraintSet shared00

To delete a size constraint set

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

{ svc := wafregional.New(session.New()) input := &waf.DeleteSizeConstraintSetInput{ ChangeToken: aws.String("abcd12f2-46da-4fdb-b8d5-fbd4c466928f"), SizeConstraintSetId: aws.String("example1ds3t-46da-4fdb-b8d5-abc321j569j5"), } result, err := svc.DeleteSizeConstraintSet(input) if err != nil { if aerr, ok := err.(awserr.Error); ok { switch aerr.Code() { case wafregional.ErrCodeWAFStaleDataException: fmt.Println(wafregional.ErrCodeWAFStaleDataException, aerr.Error()) case wafregional.ErrCodeWAFInternalErrorException: fmt.Println(wafregional.ErrCodeWAFInternalErrorException, aerr.Error()) case wafregional.ErrCodeWAFInvalidAccountException: fmt.Println(wafregional.ErrCodeWAFInvalidAccountException, aerr.Error()) case wafregional.ErrCodeWAFNonexistentItemException: fmt.Println(wafregional.ErrCodeWAFNonexistentItemException, aerr.Error()) case wafregional.ErrCodeWAFReferencedItemException: fmt.Println(wafregional.ErrCodeWAFReferencedItemException, aerr.Error()) case wafregional.ErrCodeWAFNonEmptyEntityException: fmt.Println(wafregional.ErrCodeWAFNonEmptyEntityException, aerr.Error()) default: fmt.Println(aerr.Error()) } } else { fmt.Println(err.Error()) } return } fmt.Println(result) }

DeleteSizeConstraintSetRequest

func (c *WAFRegional) DeleteSizeConstraintSetRequest(input *waf.DeleteSizeConstraintSetInput) (req *request.Request, output *waf.DeleteSizeConstraintSetOutput)

DeleteSizeConstraintSetRequest generates a "aws/request.Request" representing the client's request for the DeleteSizeConstraintSet operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteSizeConstraintSet for more information on using the DeleteSizeConstraintSet API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteSizeConstraintSetRequest method. req, resp := client.DeleteSizeConstraintSetRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/DeleteSizeConstraintSet

DeleteSizeConstraintSetWithContext

func (c *WAFRegional) DeleteSizeConstraintSetWithContext(ctx aws.Context, input *waf.DeleteSizeConstraintSetInput, opts ...request.Option) (*waf.DeleteSizeConstraintSetOutput, error)

DeleteSizeConstraintSetWithContext is the same as DeleteSizeConstraintSet with the addition of the ability to pass a context and additional request options.

See DeleteSizeConstraintSet for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

DeleteSqlInjectionMatchSet

func (c *WAFRegional) DeleteSqlInjectionMatchSet(input *waf.DeleteSqlInjectionMatchSetInput) (*waf.DeleteSqlInjectionMatchSetOutput, error)

DeleteSqlInjectionMatchSet API operation for AWS WAF Regional.

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

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

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

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

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

Submit a DeleteSqlInjectionMatchSet request.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS WAF Regional's API operation DeleteSqlInjectionMatchSet for usage and error information.

Returned Error Codes:

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

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

  • ErrCodeWAFNonexistentItemException "WAFNonexistentItemException" The operation failed because the referenced object doesn't exist.

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

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

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

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

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

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/DeleteSqlInjectionMatchSet

Example

WAFRegional DeleteSqlInjectionMatchSet shared00

To delete a SQL injection match set

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

{ svc := wafregional.New(session.New()) input := &waf.DeleteSqlInjectionMatchSetInput{ ChangeToken: aws.String("abcd12f2-46da-4fdb-b8d5-fbd4c466928f"), SqlInjectionMatchSetId: aws.String("example1ds3t-46da-4fdb-b8d5-abc321j569j5"), } result, err := svc.DeleteSqlInjectionMatchSet(input) if err != nil { if aerr, ok := err.(awserr.Error); ok { switch aerr.Code() { case wafregional.ErrCodeWAFInternalErrorException: fmt.Println(wafregional.ErrCodeWAFInternalErrorException, aerr.Error()) case wafregional.ErrCodeWAFInvalidAccountException: fmt.Println(wafregional.ErrCodeWAFInvalidAccountException, aerr.Error()) case wafregional.ErrCodeWAFNonexistentItemException: fmt.Println(wafregional.ErrCodeWAFNonexistentItemException, aerr.Error()) case wafregional.ErrCodeWAFReferencedItemException: fmt.Println(wafregional.ErrCodeWAFReferencedItemException, aerr.Error()) case wafregional.ErrCodeWAFStaleDataException: fmt.Println(wafregional.ErrCodeWAFStaleDataException, aerr.Error()) case wafregional.ErrCodeWAFNonEmptyEntityException: fmt.Println(wafregional.ErrCodeWAFNonEmptyEntityException, aerr.Error()) default: fmt.Println(aerr.Error()) } } else { fmt.Println(err.Error()) } return } fmt.Println(result) }

DeleteSqlInjectionMatchSetRequest

func (c *WAFRegional) DeleteSqlInjectionMatchSetRequest(input *waf.DeleteSqlInjectionMatchSetInput) (req *request.Request, output *waf.DeleteSqlInjectionMatchSetOutput)

DeleteSqlInjectionMatchSetRequest generates a "aws/request.Request" representing the client's request for the DeleteSqlInjectionMatchSet operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteSqlInjectionMatchSet for more information on using the DeleteSqlInjectionMatchSet API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteSqlInjectionMatchSetRequest method. req, resp := client.DeleteSqlInjectionMatchSetRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/DeleteSqlInjectionMatchSet

DeleteSqlInjectionMatchSetWithContext

func (c *WAFRegional) DeleteSqlInjectionMatchSetWithContext(ctx aws.Context, input *waf.DeleteSqlInjectionMatchSetInput, opts ...request.Option) (*waf.DeleteSqlInjectionMatchSetOutput, error)

DeleteSqlInjectionMatchSetWithContext is the same as DeleteSqlInjectionMatchSet with the addition of the ability to pass a context and additional request options.

See DeleteSqlInjectionMatchSet for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

DeleteWebACL

func (c *WAFRegional) DeleteWebACL(input *waf.DeleteWebACLInput) (*waf.DeleteWebACLOutput, error)

DeleteWebACL API operation for AWS WAF Regional.

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

To delete a WebACL, perform the following steps:

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

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

Submit a DeleteWebACL request.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS WAF Regional's API operation DeleteWebACL for usage and error information.

Returned Error Codes:

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

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

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

  • ErrCodeWAFNonexistentItemException "WAFNonexistentItemException" The operation failed because the referenced object doesn't exist.

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

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

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

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

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/DeleteWebACL

Example

WAFRegional DeleteWebACL shared00

To delete a web ACL

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

{ svc := wafregional.New(session.New()) input := &waf.DeleteWebACLInput{ ChangeToken: aws.String("abcd12f2-46da-4fdb-b8d5-fbd4c466928f"), WebACLId: aws.String("example-46da-4444-5555-example"), } result, err := svc.DeleteWebACL(input) if err != nil { if aerr, ok := err.(awserr.Error); ok { switch aerr.Code() { case wafregional.ErrCodeWAFStaleDataException: fmt.Println(wafregional.ErrCodeWAFStaleDataException, aerr.Error()) case wafregional.ErrCodeWAFInternalErrorException: fmt.Println(wafregional.ErrCodeWAFInternalErrorException, aerr.Error()) case wafregional.ErrCodeWAFInvalidAccountException: fmt.Println(wafregional.ErrCodeWAFInvalidAccountException, aerr.Error()) case wafregional.ErrCodeWAFNonexistentItemException: fmt.Println(wafregional.ErrCodeWAFNonexistentItemException, aerr.Error()) case wafregional.ErrCodeWAFReferencedItemException: fmt.Println(wafregional.ErrCodeWAFReferencedItemException, aerr.Error()) case wafregional.ErrCodeWAFNonEmptyEntityException: fmt.Println(wafregional.ErrCodeWAFNonEmptyEntityException, aerr.Error()) default: fmt.Println(aerr.Error()) } } else { fmt.Println(err.Error()) } return } fmt.Println(result) }

DeleteWebACLRequest

func (c *WAFRegional) DeleteWebACLRequest(input *waf.DeleteWebACLInput) (req *request.Request, output *waf.DeleteWebACLOutput)

DeleteWebACLRequest generates a "aws/request.Request" representing the client's request for the DeleteWebACL operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteWebACL for more information on using the DeleteWebACL API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteWebACLRequest method. req, resp := client.DeleteWebACLRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/DeleteWebACL

DeleteWebACLWithContext

func (c *WAFRegional) DeleteWebACLWithContext(ctx aws.Context, input *waf.DeleteWebACLInput, opts ...request.Option) (*waf.DeleteWebACLOutput, error)

DeleteWebACLWithContext is the same as DeleteWebACL with the addition of the ability to pass a context and additional request options.

See DeleteWebACL for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

DeleteXssMatchSet

func (c *WAFRegional) DeleteXssMatchSet(input *waf.DeleteXssMatchSetInput) (*waf.DeleteXssMatchSetOutput, error)

DeleteXssMatchSet API operation for AWS WAF Regional.

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

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

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

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

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

Submit a DeleteXssMatchSet request.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS WAF Regional's API operation DeleteXssMatchSet for usage and error information.

Returned Error Codes:

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

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

  • ErrCodeWAFNonexistentItemException "WAFNonexistentItemException" The operation failed because the referenced object doesn't exist.

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

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

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

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

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

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/DeleteXssMatchSet

Example

WAFRegional DeleteXssMatchSet shared00

To delete an XSS match set

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

{ svc := wafregional.New(session.New()) input := &waf.DeleteXssMatchSetInput{ ChangeToken: aws.String("abcd12f2-46da-4fdb-b8d5-fbd4c466928f"), XssMatchSetId: aws.String("example1ds3t-46da-4fdb-b8d5-abc321j569j5"), } result, err := svc.DeleteXssMatchSet(input) if err != nil { if aerr, ok := err.(awserr.Error); ok { switch aerr.Code() { case wafregional.ErrCodeWAFInternalErrorException: fmt.Println(wafregional.ErrCodeWAFInternalErrorException, aerr.Error()) case wafregional.ErrCodeWAFInvalidAccountException: fmt.Println(wafregional.ErrCodeWAFInvalidAccountException, aerr.Error()) case wafregional.ErrCodeWAFNonexistentItemException: fmt.Println(wafregional.ErrCodeWAFNonexistentItemException, aerr.Error()) case wafregional.ErrCodeWAFReferencedItemException: fmt.Println(wafregional.ErrCodeWAFReferencedItemException, aerr.Error()) case wafregional.ErrCodeWAFStaleDataException: fmt.Println(wafregional.ErrCodeWAFStaleDataException, aerr.Error()) case wafregional.ErrCodeWAFNonEmptyEntityException: fmt.Println(wafregional.ErrCodeWAFNonEmptyEntityException, aerr.Error()) default: fmt.Println(aerr.Error()) } } else { fmt.Println(err.Error()) } return } fmt.Println(result) }

DeleteXssMatchSetRequest

func (c *WAFRegional) DeleteXssMatchSetRequest(input *waf.DeleteXssMatchSetInput) (req *request.Request, output *waf.DeleteXssMatchSetOutput)

DeleteXssMatchSetRequest generates a "aws/request.Request" representing the client's request for the DeleteXssMatchSet operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteXssMatchSet for more information on using the DeleteXssMatchSet API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteXssMatchSetRequest method. req, resp := client.DeleteXssMatchSetRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/DeleteXssMatchSet

DeleteXssMatchSetWithContext

func (c *WAFRegional) DeleteXssMatchSetWithContext(ctx aws.Context, input *waf.DeleteXssMatchSetInput, opts ...request.Option) (*waf.DeleteXssMatchSetOutput, error)

DeleteXssMatchSetWithContext is the same as DeleteXssMatchSet with the addition of the ability to pass a context and additional request options.

See DeleteXssMatchSet for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

DisassociateWebACL

func (c *WAFRegional) DisassociateWebACL(input *DisassociateWebACLInput) (*DisassociateWebACLOutput, error)

DisassociateWebACL API operation for AWS WAF Regional.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS WAF Regional's API operation DisassociateWebACL for usage and error information.

Returned Error Codes:

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

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

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

  • You specified an invalid parameter name.

  • You specified an invalid value.

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

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

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

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

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

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

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

  • ErrCodeWAFNonexistentItemException "WAFNonexistentItemException" The operation failed because the referenced object doesn't exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/DisassociateWebACL

DisassociateWebACLRequest

func (c *WAFRegional) DisassociateWebACLRequest(input *DisassociateWebACLInput) (req *request.Request, output *DisassociateWebACLOutput)

DisassociateWebACLRequest generates a "aws/request.Request" representing the client's request for the DisassociateWebACL operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DisassociateWebACL for more information on using the DisassociateWebACL API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DisassociateWebACLRequest method. req, resp := client.DisassociateWebACLRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/DisassociateWebACL

DisassociateWebACLWithContext

func (c *WAFRegional) DisassociateWebACLWithContext(ctx aws.Context, input *DisassociateWebACLInput, opts ...request.Option) (*DisassociateWebACLOutput, error)

DisassociateWebACLWithContext is the same as DisassociateWebACL with the addition of the ability to pass a context and additional request options.

See DisassociateWebACL for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

GetByteMatchSet

func (c *WAFRegional) GetByteMatchSet(input *waf.GetByteMatchSetInput) (*waf.GetByteMatchSetOutput, error)

GetByteMatchSet API operation for AWS WAF Regional.

Returns the ByteMatchSet specified by ByteMatchSetId.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS WAF Regional's API operation GetByteMatchSet for usage and error information.

Returned Error Codes:

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

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

  • ErrCodeWAFNonexistentItemException "WAFNonexistentItemException" The operation failed because the referenced object doesn't exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/GetByteMatchSet

Example

WAFRegional GetByteMatchSet shared00

To get a byte match set

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

{ svc := wafregional.New(session.New()) input := &waf.GetByteMatchSetInput{ ByteMatchSetId: aws.String("exampleIDs3t-46da-4fdb-b8d5-abc321j569j5"), } result, err := svc.GetByteMatchSet(input) if err != nil { if aerr, ok := err.(awserr.Error); ok { switch aerr.Code() { case wafregional.ErrCodeWAFInternalErrorException: fmt.Println(wafregional.ErrCodeWAFInternalErrorException, aerr.Error()) case wafregional.ErrCodeWAFInvalidAccountException: fmt.Println(wafregional.ErrCodeWAFInvalidAccountException, aerr.Error()) case wafregional.ErrCodeWAFNonexistentItemException: fmt.Println(wafregional.ErrCodeWAFNonexistentItemException, aerr.Error()) default: fmt.Println(aerr.Error()) } } else { fmt.Println(err.Error()) } return } fmt.Println(result) }

GetByteMatchSetRequest

func (c *WAFRegional) GetByteMatchSetRequest(input *waf.GetByteMatchSetInput) (req *request.Request, output *waf.GetByteMatchSetOutput)

GetByteMatchSetRequest generates a "aws/request.Request" representing the client's request for the GetByteMatchSet operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetByteMatchSet for more information on using the GetByteMatchSet API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetByteMatchSetRequest method. req, resp := client.GetByteMatchSetRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/GetByteMatchSet

GetByteMatchSetWithContext

func (c *WAFRegional) GetByteMatchSetWithContext(ctx aws.Context, input *waf.GetByteMatchSetInput, opts ...request.Option) (*waf.GetByteMatchSetOutput, error)

GetByteMatchSetWithContext is the same as GetByteMatchSet with the addition of the ability to pass a context and additional request options.

See GetByteMatchSet for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

GetChangeToken

func (c *WAFRegional) GetChangeToken(input *waf.GetChangeTokenInput) (*waf.GetChangeTokenOutput, error)

GetChangeToken API operation for AWS WAF Regional.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS WAF Regional's API operation GetChangeToken for usage and error information.

Returned Error Codes:

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

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/GetChangeToken

Example

WAFRegional GetChangeToken shared00

To get a change token

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

{ svc := wafregional.New(session.New()) input := &waf.GetChangeTokenInput{} result, err := svc.GetChangeToken(input) if err != nil { if aerr, ok := err.(awserr.Error); ok { switch aerr.Code() { case wafregional.ErrCodeWAFInternalErrorException: fmt.Println(wafregional.ErrCodeWAFInternalErrorException, aerr.Error()) default: fmt.Println(aerr.Error()) } } else { fmt.Println(err.Error()) } return } fmt.Println(result) }

GetChangeTokenRequest

func (c *WAFRegional) GetChangeTokenRequest(input *waf.GetChangeTokenInput) (req *request.Request, output *waf.GetChangeTokenOutput)

GetChangeTokenRequest generates a "aws/request.Request" representing the client's request for the GetChangeToken operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetChangeToken for more information on using the GetChangeToken API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetChangeTokenRequest method. req, resp := client.GetChangeTokenRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/GetChangeToken

GetChangeTokenStatus

func (c *WAFRegional) GetChangeTokenStatus(input *waf.GetChangeTokenStatusInput) (*waf.GetChangeTokenStatusOutput, error)

GetChangeTokenStatus API operation for AWS WAF Regional.

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

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

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

  • INSYNC: Propagation is complete.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS WAF Regional's API operation GetChangeTokenStatus for usage and error information.

Returned Error Codes:

  • ErrCodeWAFNonexistentItemException "WAFNonexistentItemException" The operation failed because the referenced object doesn't exist.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/GetChangeTokenStatus

Example

WAFRegional GetChangeTokenStatus shared00

To get the change token status

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

{ svc := wafregional.New(session.New()) input := &waf.GetChangeTokenStatusInput{ ChangeToken: aws.String("abcd12f2-46da-4fdb-b8d5-fbd4c466928f"), } result, err := svc.GetChangeTokenStatus(input) if err != nil { if aerr, ok := err.(awserr.Error); ok { switch aerr.Code() { case wafregional.ErrCodeWAFNonexistentItemException: fmt.Println(wafregional.ErrCodeWAFNonexistentItemException, aerr.Error()) case wafregional.ErrCodeWAFInternalErrorException: fmt.Println(wafregional.ErrCodeWAFInternalErrorException, aerr.Error()) default: fmt.Println(aerr.Error()) } } else { fmt.Println(err.Error()) } return } fmt.Println(result) }

GetChangeTokenStatusRequest

func (c *WAFRegional) GetChangeTokenStatusRequest(input *waf.GetChangeTokenStatusInput) (req *request.Request, output *waf.GetChangeTokenStatusOutput)

GetChangeTokenStatusRequest generates a "aws/request.Request" representing the client's request for the GetChangeTokenStatus operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetChangeTokenStatus for more information on using the GetChangeTokenStatus API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetChangeTokenStatusRequest method. req, resp := client.GetChangeTokenStatusRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/GetChangeTokenStatus

GetChangeTokenStatusWithContext

func (c *WAFRegional) GetChangeTokenStatusWithContext(ctx aws.Context, input *waf.GetChangeTokenStatusInput, opts ...request.Option) (*waf.GetChangeTokenStatusOutput, error)

GetChangeTokenStatusWithContext is the same as GetChangeTokenStatus with the addition of the ability to pass a context and additional request options.

See GetChangeTokenStatus for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

GetChangeTokenWithContext

func (c *WAFRegional) GetChangeTokenWithContext(ctx aws.Context, input *waf.GetChangeTokenInput, opts ...request.Option) (*waf.GetChangeTokenOutput, error)

GetChangeTokenWithContext is the same as GetChangeToken with the addition of the ability to pass a context and additional request options.

See GetChangeToken for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

GetGeoMatchSet

func (c *WAFRegional) GetGeoMatchSet(input *waf.GetGeoMatchSetInput) (*waf.GetGeoMatchSetOutput, error)

GetGeoMatchSet API operation for AWS WAF Regional.

Returns the GeoMatchSet that is specified by GeoMatchSetId.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS WAF Regional's API operation GetGeoMatchSet for usage and error information.

Returned Error Codes:

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

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

  • ErrCodeWAFNonexistentItemException "WAFNonexistentItemException" The operation failed because the referenced object doesn't exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/GetGeoMatchSet

GetGeoMatchSetRequest

func (c *WAFRegional) GetGeoMatchSetRequest(input *waf.GetGeoMatchSetInput) (req *request.Request, output *waf.GetGeoMatchSetOutput)

GetGeoMatchSetRequest generates a "aws/request.Request" representing the client's request for the GetGeoMatchSet operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetGeoMatchSet for more information on using the GetGeoMatchSet API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetGeoMatchSetRequest method. req, resp := client.GetGeoMatchSetRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/GetGeoMatchSet

GetGeoMatchSetWithContext

func (c *WAFRegional) GetGeoMatchSetWithContext(ctx aws.Context, input *waf.GetGeoMatchSetInput, opts ...request.Option) (*waf.GetGeoMatchSetOutput, error)

GetGeoMatchSetWithContext is the same as GetGeoMatchSet with the addition of the ability to pass a context and additional request options.

See GetGeoMatchSet for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

GetIPSet

func (c *WAFRegional) GetIPSet(input *waf.GetIPSetInput) (*waf.GetIPSetOutput, error)

GetIPSet API operation for AWS WAF Regional.

Returns the IPSet that is specified by IPSetId.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS WAF Regional's API operation GetIPSet for usage and error information.

Returned Error Codes:

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

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

  • ErrCodeWAFNonexistentItemException "WAFNonexistentItemException" The operation failed because the referenced object doesn't exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/GetIPSet

Example

WAFRegional GetIPSet shared00

To get an IP set

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

{ svc := wafregional.New(session.New()) input := &waf.GetIPSetInput{ IPSetId: aws.String("example1ds3t-46da-4fdb-b8d5-abc321j569j5"), } result, err := svc.GetIPSet(input) if err != nil { if aerr, ok := err.(awserr.Error); ok { switch aerr.Code() { case wafregional.ErrCodeWAFInternalErrorException: fmt.Println(wafregional.ErrCodeWAFInternalErrorException, aerr.Error()) case wafregional.ErrCodeWAFInvalidAccountException: fmt.Println(wafregional.ErrCodeWAFInvalidAccountException, aerr.Error()) case wafregional.ErrCodeWAFNonexistentItemException: fmt.Println(wafregional.ErrCodeWAFNonexistentItemException, aerr.Error()) default: fmt.Println(aerr.Error()) } } else { fmt.Println(err.Error()) } return } fmt.Println(result) }

GetIPSetRequest

func (c *WAFRegional) GetIPSetRequest(input *waf.GetIPSetInput) (req *request.Request, output *waf.GetIPSetOutput)

GetIPSetRequest generates a "aws/request.Request" representing the client's request for the GetIPSet operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetIPSet for more information on using the GetIPSet API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetIPSetRequest method. req, resp := client.GetIPSetRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/GetIPSet

GetIPSetWithContext

func (c *WAFRegional) GetIPSetWithContext(ctx aws.Context, input *waf.GetIPSetInput, opts ...request.Option) (*waf.GetIPSetOutput, error)

GetIPSetWithContext is the same as GetIPSet with the addition of the ability to pass a context and additional request options.

See GetIPSet for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

GetLoggingConfiguration

func (c *WAFRegional) GetLoggingConfiguration(input *waf.GetLoggingConfigurationInput) (*waf.GetLoggingConfigurationOutput, error)

GetLoggingConfiguration API operation for AWS WAF Regional.

Returns the LoggingConfiguration for the specified web ACL.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS WAF Regional's API operation GetLoggingConfiguration for usage and error information.

Returned Error Codes:

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

  • ErrCodeWAFNonexistentItemException "WAFNonexistentItemException" The operation failed because the referenced object doesn't exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/GetLoggingConfiguration

GetLoggingConfigurationRequest

func (c *WAFRegional) GetLoggingConfigurationRequest(input *waf.GetLoggingConfigurationInput) (req *request.Request, output *waf.GetLoggingConfigurationOutput)

GetLoggingConfigurationRequest generates a "aws/request.Request" representing the client's request for the GetLoggingConfiguration operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetLoggingConfiguration for more information on using the GetLoggingConfiguration API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetLoggingConfigurationRequest method. req, resp := client.GetLoggingConfigurationRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/GetLoggingConfiguration

GetLoggingConfigurationWithContext

func (c *WAFRegional) GetLoggingConfigurationWithContext(ctx aws.Context, input *waf.GetLoggingConfigurationInput, opts ...request.Option) (*waf.GetLoggingConfigurationOutput, error)

GetLoggingConfigurationWithContext is the same as GetLoggingConfiguration with the addition of the ability to pass a context and additional request options.

See GetLoggingConfiguration for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

GetPermissionPolicy

func (c *WAFRegional) GetPermissionPolicy(input *waf.GetPermissionPolicyInput) (*waf.GetPermissionPolicyOutput, error)

GetPermissionPolicy API operation for AWS WAF Regional.

Returns the IAM policy attached to the RuleGroup.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS WAF Regional's API operation GetPermissionPolicy for usage and error information.

Returned Error Codes:

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

  • ErrCodeWAFNonexistentItemException "WAFNonexistentItemException" The operation failed because the referenced object doesn't exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/GetPermissionPolicy

GetPermissionPolicyRequest

func (c *WAFRegional) GetPermissionPolicyRequest(input *waf.GetPermissionPolicyInput) (req *request.Request, output *waf.GetPermissionPolicyOutput)

GetPermissionPolicyRequest generates a "aws/request.Request" representing the client's request for the GetPermissionPolicy operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetPermissionPolicy for more information on using the GetPermissionPolicy API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetPermissionPolicyRequest method. req, resp := client.GetPermissionPolicyRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/GetPermissionPolicy

GetPermissionPolicyWithContext

func (c *WAFRegional) GetPermissionPolicyWithContext(ctx aws.Context, input *waf.GetPermissionPolicyInput, opts ...request.Option) (*waf.GetPermissionPolicyOutput, error)

GetPermissionPolicyWithContext is the same as GetPermissionPolicy with the addition of the ability to pass a context and additional request options.

See GetPermissionPolicy for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

GetRateBasedRule

func (c *WAFRegional) GetRateBasedRule(input *waf.GetRateBasedRuleInput) (*waf.GetRateBasedRuleOutput, error)

GetRateBasedRule API operation for AWS WAF Regional.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS WAF Regional's API operation GetRateBasedRule for usage and error information.

Returned Error Codes:

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

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

  • ErrCodeWAFNonexistentItemException "WAFNonexistentItemException" The operation failed because the referenced object doesn't exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/GetRateBasedRule

GetRateBasedRuleManagedKeys

func (c *WAFRegional) GetRateBasedRuleManagedKeys(input *waf.GetRateBasedRuleManagedKeysInput) (*waf.GetRateBasedRuleManagedKeysOutput, error)

GetRateBasedRuleManagedKeys API operation for AWS WAF Regional.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS WAF Regional's API operation GetRateBasedRuleManagedKeys for usage and error information.

Returned Error Codes:

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

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

  • ErrCodeWAFNonexistentItemException "WAFNonexistentItemException" The operation failed because the referenced object doesn't exist.

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

  • You specified an invalid parameter name.

  • You specified an invalid value.

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

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

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

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/GetRateBasedRuleManagedKeys

GetRateBasedRuleManagedKeysRequest

func (c *WAFRegional) GetRateBasedRuleManagedKeysRequest(input *waf.GetRateBasedRuleManagedKeysInput) (req *request.Request, output *waf.GetRateBasedRuleManagedKeysOutput)

GetRateBasedRuleManagedKeysRequest generates a "aws/request.Request" representing the client's request for the GetRateBasedRuleManagedKeys operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetRateBasedRuleManagedKeys for more information on using the GetRateBasedRuleManagedKeys API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetRateBasedRuleManagedKeysRequest method. req, resp := client.GetRateBasedRuleManagedKeysRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/GetRateBasedRuleManagedKeys

GetRateBasedRuleManagedKeysWithContext

func (c *WAFRegional) GetRateBasedRuleManagedKeysWithContext(ctx aws.Context, input *waf.GetRateBasedRuleManagedKeysInput, opts ...request.Option) (*waf.GetRateBasedRuleManagedKeysOutput, error)

GetRateBasedRuleManagedKeysWithContext is the same as GetRateBasedRuleManagedKeys with the addition of the ability to pass a context and additional request options.

See GetRateBasedRuleManagedKeys for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

GetRateBasedRuleRequest

func (c *WAFRegional) GetRateBasedRuleRequest(input *waf.GetRateBasedRuleInput) (req *request.Request, output *waf.GetRateBasedRuleOutput)

GetRateBasedRuleRequest generates a "aws/request.Request" representing the client's request for the GetRateBasedRule operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetRateBasedRule for more information on using the GetRateBasedRule API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetRateBasedRuleRequest method. req, resp := client.GetRateBasedRuleRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/GetRateBasedRule

GetRateBasedRuleWithContext

func (c *WAFRegional) GetRateBasedRuleWithContext(ctx aws.Context, input *waf.GetRateBasedRuleInput, opts ...request.Option) (*waf.GetRateBasedRuleOutput, error)

GetRateBasedRuleWithContext is the same as GetRateBasedRule with the addition of the ability to pass a context and additional request options.

See GetRateBasedRule for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

GetRegexMatchSet

func (c *WAFRegional) GetRegexMatchSet(input *waf.GetRegexMatchSetInput) (*waf.GetRegexMatchSetOutput, error)

GetRegexMatchSet API operation for AWS WAF Regional.

Returns the RegexMatchSet specified by RegexMatchSetId.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS WAF Regional's API operation GetRegexMatchSet for usage and error information.

Returned Error Codes:

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

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

  • ErrCodeWAFNonexistentItemException "WAFNonexistentItemException" The operation failed because the referenced object doesn't exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/GetRegexMatchSet

GetRegexMatchSetRequest

func (c *WAFRegional) GetRegexMatchSetRequest(input *waf.GetRegexMatchSetInput) (req *request.Request, output *waf.GetRegexMatchSetOutput)

GetRegexMatchSetRequest generates a "aws/request.Request" representing the client's request for the GetRegexMatchSet operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetRegexMatchSet for more information on using the GetRegexMatchSet API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetRegexMatchSetRequest method. req, resp := client.GetRegexMatchSetRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/GetRegexMatchSet

GetRegexMatchSetWithContext

func (c *WAFRegional) GetRegexMatchSetWithContext(ctx aws.Context, input *waf.GetRegexMatchSetInput, opts ...request.Option) (*waf.GetRegexMatchSetOutput, error)

GetRegexMatchSetWithContext is the same as GetRegexMatchSet with the addition of the ability to pass a context and additional request options.

See GetRegexMatchSet for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

GetRegexPatternSet

func (c *WAFRegional) GetRegexPatternSet(input *waf.GetRegexPatternSetInput) (*waf.GetRegexPatternSetOutput, error)

GetRegexPatternSet API operation for AWS WAF Regional.

Returns the RegexPatternSet specified by RegexPatternSetId.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS WAF Regional's API operation GetRegexPatternSet for usage and error information.

Returned Error Codes:

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

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

  • ErrCodeWAFNonexistentItemException "WAFNonexistentItemException" The operation failed because the referenced object doesn't exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/GetRegexPatternSet

GetRegexPatternSetRequest

func (c *WAFRegional) GetRegexPatternSetRequest(input *waf.GetRegexPatternSetInput) (req *request.Request, output *waf.GetRegexPatternSetOutput)

GetRegexPatternSetRequest generates a "aws/request.Request" representing the client's request for the GetRegexPatternSet operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetRegexPatternSet for more information on using the GetRegexPatternSet API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetRegexPatternSetRequest method. req, resp := client.GetRegexPatternSetRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/GetRegexPatternSet

GetRegexPatternSetWithContext

func (c *WAFRegional) GetRegexPatternSetWithContext(ctx aws.Context, input *waf.GetRegexPatternSetInput, opts ...request.Option) (*waf.GetRegexPatternSetOutput, error)

GetRegexPatternSetWithContext is the same as GetRegexPatternSet with the addition of the ability to pass a context and additional request options.

See GetRegexPatternSet for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

GetRule

func (c *WAFRegional) GetRule(input *waf.GetRuleInput) (*waf.GetRuleOutput, error)

GetRule API operation for AWS WAF Regional.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS WAF Regional's API operation GetRule for usage and error information.

Returned Error Codes:

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

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

  • ErrCodeWAFNonexistentItemException "WAFNonexistentItemException" The operation failed because the referenced object doesn't exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/GetRule

Example

WAFRegional GetRule shared00

To get a rule

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

{ svc := wafregional.New(session.New()) input := &waf.GetRuleInput{ RuleId: aws.String("example1ds3t-46da-4fdb-b8d5-abc321j569j5"), } result, err := svc.GetRule(input) if err != nil { if aerr, ok := err.(awserr.Error); ok { switch aerr.Code() { case wafregional.ErrCodeWAFInternalErrorException: fmt.Println(wafregional.ErrCodeWAFInternalErrorException, aerr.Error()) case wafregional.ErrCodeWAFInvalidAccountException: fmt.Println(wafregional.ErrCodeWAFInvalidAccountException, aerr.Error()) case wafregional.ErrCodeWAFNonexistentItemException: fmt.Println(wafregional.ErrCodeWAFNonexistentItemException, aerr.Error()) default: fmt.Println(aerr.Error()) } } else { fmt.Println(err.Error()) } return } fmt.Println(result) }

GetRuleGroup

func (c *WAFRegional) GetRuleGroup(input *waf.GetRuleGroupInput) (*waf.GetRuleGroupOutput, error)

GetRuleGroup API operation for AWS WAF Regional.

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

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS WAF Regional's API operation GetRuleGroup for usage and error information.

Returned Error Codes:

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

  • ErrCodeWAFNonexistentItemException "WAFNonexistentItemException" The operation failed because the referenced object doesn't exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/GetRuleGroup

GetRuleGroupRequest

func (c *WAFRegional) GetRuleGroupRequest(input *waf.GetRuleGroupInput) (req *request.Request, output *waf.GetRuleGroupOutput)

GetRuleGroupRequest generates a "aws/request.Request" representing the client's request for the GetRuleGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetRuleGroup for more information on using the GetRuleGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetRuleGroupRequest method. req, resp := client.GetRuleGroupRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/GetRuleGroup

GetRuleGroupWithContext

func (c *WAFRegional) GetRuleGroupWithContext(ctx aws.Context, input *waf.GetRuleGroupInput, opts ...request.Option) (*waf.GetRuleGroupOutput, error)

GetRuleGroupWithContext is the same as GetRuleGroup with the addition of the ability to pass a context and additional request options.

See GetRuleGroup for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

GetRuleRequest

func (c *WAFRegional) GetRuleRequest(input *waf.GetRuleInput) (req *request.Request, output *waf.GetRuleOutput)

GetRuleRequest generates a "aws/request.Request" representing the client's request for the GetRule operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetRule for more information on using the GetRule API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetRuleRequest method. req, resp := client.GetRuleRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/GetRule

GetRuleWithContext

func (c *WAFRegional) GetRuleWithContext(ctx aws.Context, input *waf.GetRuleInput, opts ...request.Option) (*waf.GetRuleOutput, error)

GetRuleWithContext is the same as GetRule with the addition of the ability to pass a context and additional request options.

See GetRule for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

GetSampledRequests

func (c *WAFRegional) GetSampledRequests(input *waf.GetSampledRequestsInput) (*waf.GetSampledRequestsOutput, error)

GetSampledRequests API operation for AWS WAF Regional.

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

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS WAF Regional's API operation GetSampledRequests for usage and error information.

Returned Error Codes:

  • ErrCodeWAFNonexistentItemException "WAFNonexistentItemException" The operation failed because the referenced object doesn't exist.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/GetSampledRequests

Example

WAFRegional GetSampledRequests shared00

To get a sampled requests

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

{ svc := wafregional.New(session.New()) input := &waf.GetSampledRequestsInput{ MaxItems: aws.Int64(100), RuleId: aws.String("WAFRule-1-Example"), TimeWindow: &waf.TimeWindow{ EndTime: parseTime("2006-01-02T15:04:05Z", "2016-09-27T15:50Z"), StartTime: parseTime("2006-01-02T15:04:05Z", "2016-09-27T15:50Z"), }, WebAclId: aws.String("createwebacl-1472061481310"), } result, err := svc.GetSampledRequests(input) if err != nil { if aerr, ok := err.(awserr.Error); ok { switch aerr.Code() { case wafregional.ErrCodeWAFNonexistentItemException: fmt.Println(wafregional.ErrCodeWAFNonexistentItemException, aerr.Error()) case wafregional.ErrCodeWAFInternalErrorException: fmt.Println(wafregional.ErrCodeWAFInternalErrorException, aerr.Error()) default: fmt.Println(aerr.Error()) } } else { fmt.Println(err.Error()) } return } fmt.Println(result) }

GetSampledRequestsRequest

func (c *WAFRegional) GetSampledRequestsRequest(input *waf.GetSampledRequestsInput) (req *request.Request, output *waf.GetSampledRequestsOutput)

GetSampledRequestsRequest generates a "aws/request.Request" representing the client's request for the GetSampledRequests operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetSampledRequests for more information on using the GetSampledRequests API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetSampledRequestsRequest method. req, resp := client.GetSampledRequestsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/GetSampledRequests

GetSampledRequestsWithContext

func (c *WAFRegional) GetSampledRequestsWithContext(ctx aws.Context, input *waf.GetSampledRequestsInput, opts ...request.Option) (*waf.GetSampledRequestsOutput, error)

GetSampledRequestsWithContext is the same as GetSampledRequests with the addition of the ability to pass a context and additional request options.

See GetSampledRequests for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

GetSizeConstraintSet

func (c *WAFRegional) GetSizeConstraintSet(input *waf.GetSizeConstraintSetInput) (*waf.GetSizeConstraintSetOutput, error)

GetSizeConstraintSet API operation for AWS WAF Regional.

Returns the SizeConstraintSet specified by SizeConstraintSetId.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS WAF Regional's API operation GetSizeConstraintSet for usage and error information.

Returned Error Codes:

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

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

  • ErrCodeWAFNonexistentItemException "WAFNonexistentItemException" The operation failed because the referenced object doesn't exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/GetSizeConstraintSet

Example

WAFRegional GetSizeConstraintSet shared00

To get a size constraint set

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

{ svc := wafregional.New(session.New()) input := &waf.GetSizeConstraintSetInput{ SizeConstraintSetId: aws.String("example1ds3t-46da-4fdb-b8d5-abc321j569j5"), } result, err := svc.GetSizeConstraintSet(input) if err != nil { if aerr, ok := err.(awserr.Error); ok { switch aerr.Code() { case wafregional.ErrCodeWAFInternalErrorException: fmt.Println(wafregional.ErrCodeWAFInternalErrorException, aerr.Error()) case wafregional.ErrCodeWAFInvalidAccountException: fmt.Println(wafregional.ErrCodeWAFInvalidAccountException, aerr.Error()) case wafregional.ErrCodeWAFNonexistentItemException: fmt.Println(wafregional.ErrCodeWAFNonexistentItemException, aerr.Error()) default: fmt.Println(aerr.Error()) } } else { fmt.Println(err.Error()) } return } fmt.Println(result) }

GetSizeConstraintSetRequest

func (c *WAFRegional) GetSizeConstraintSetRequest(input *waf.GetSizeConstraintSetInput) (req *request.Request, output *waf.GetSizeConstraintSetOutput)

GetSizeConstraintSetRequest generates a "aws/request.Request" representing the client's request for the GetSizeConstraintSet operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetSizeConstraintSet for more information on using the GetSizeConstraintSet API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetSizeConstraintSetRequest method. req, resp := client.GetSizeConstraintSetRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/GetSizeConstraintSet

GetSizeConstraintSetWithContext

func (c *WAFRegional) GetSizeConstraintSetWithContext(ctx aws.Context, input *waf.GetSizeConstraintSetInput, opts ...request.Option) (*waf.GetSizeConstraintSetOutput, error)

GetSizeConstraintSetWithContext is the same as GetSizeConstraintSet with the addition of the ability to pass a context and additional request options.

See GetSizeConstraintSet for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

GetSqlInjectionMatchSet

func (c *WAFRegional) GetSqlInjectionMatchSet(input *waf.GetSqlInjectionMatchSetInput) (*waf.GetSqlInjectionMatchSetOutput, error)

GetSqlInjectionMatchSet API operation for AWS WAF Regional.

Returns the SqlInjectionMatchSet that is specified by SqlInjectionMatchSetId.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS WAF Regional's API operation GetSqlInjectionMatchSet for usage and error information.

Returned Error Codes:

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

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

  • ErrCodeWAFNonexistentItemException "WAFNonexistentItemException" The operation failed because the referenced object doesn't exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/GetSqlInjectionMatchSet

Example

WAFRegional GetSqlInjectionMatchSet shared00

To get a SQL injection match set

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

{ svc := wafregional.New(session.New()) input := &waf.GetSqlInjectionMatchSetInput{ SqlInjectionMatchSetId: aws.String("example1ds3t-46da-4fdb-b8d5-abc321j569j5"), } result, err := svc.GetSqlInjectionMatchSet(input) if err != nil { if aerr, ok := err.(awserr.Error); ok { switch aerr.Code() { case wafregional.ErrCodeWAFInternalErrorException: fmt.Println(wafregional.ErrCodeWAFInternalErrorException, aerr.Error()) case wafregional.ErrCodeWAFInvalidAccountException: fmt.Println(wafregional.ErrCodeWAFInvalidAccountException, aerr.Error()) case wafregional.ErrCodeWAFNonexistentItemException: fmt.Println(wafregional.ErrCodeWAFNonexistentItemException, aerr.Error()) default: fmt.Println(aerr.Error()) } } else { fmt.Println(err.Error()) } return } fmt.Println(result) }

GetSqlInjectionMatchSetRequest

func (c *WAFRegional) GetSqlInjectionMatchSetRequest(input *waf.GetSqlInjectionMatchSetInput) (req *request.Request, output *waf.GetSqlInjectionMatchSetOutput)

GetSqlInjectionMatchSetRequest generates a "aws/request.Request" representing the client's request for the GetSqlInjectionMatchSet operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetSqlInjectionMatchSet for more information on using the GetSqlInjectionMatchSet API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetSqlInjectionMatchSetRequest method. req, resp := client.GetSqlInjectionMatchSetRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/GetSqlInjectionMatchSet

GetSqlInjectionMatchSetWithContext

func (c *WAFRegional) GetSqlInjectionMatchSetWithContext(ctx aws.Context, input *waf.GetSqlInjectionMatchSetInput, opts ...request.Option) (*waf.GetSqlInjectionMatchSetOutput, error)

GetSqlInjectionMatchSetWithContext is the same as GetSqlInjectionMatchSet with the addition of the ability to pass a context and additional request options.

See GetSqlInjectionMatchSet for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

GetWebACL

func (c *WAFRegional) GetWebACL(input *waf.GetWebACLInput) (*waf.GetWebACLOutput, error)

GetWebACL API operation for AWS WAF Regional.

Returns the WebACL that is specified by WebACLId.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS WAF Regional's API operation GetWebACL for usage and error information.

Returned Error Codes:

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

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

  • ErrCodeWAFNonexistentItemException "WAFNonexistentItemException" The operation failed because the referenced object doesn't exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/GetWebACL

Example

WAFRegional GetWebACL shared00

To get a web ACL

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

{ svc := wafregional.New(session.New()) input := &waf.GetWebACLInput{ WebACLId: aws.String("createwebacl-1472061481310"), } result, err := svc.GetWebACL(input) if err != nil { if aerr, ok := err.(awserr.Error); ok { switch aerr.Code() { case wafregional.ErrCodeWAFInternalErrorException: fmt.Println(wafregional.ErrCodeWAFInternalErrorException, aerr.Error()) case wafregional.ErrCodeWAFInvalidAccountException: fmt.Println(wafregional.ErrCodeWAFInvalidAccountException, aerr.Error()) case wafregional.ErrCodeWAFNonexistentItemException: fmt.Println(wafregional.ErrCodeWAFNonexistentItemException, aerr.Error()) default: fmt.Println(aerr.Error()) } } else { fmt.Println(err.Error()) } return } fmt.Println(result) }

GetWebACLForResource

func (c *WAFRegional) GetWebACLForResource(input *GetWebACLForResourceInput) (*GetWebACLForResourceOutput, error)

GetWebACLForResource API operation for AWS WAF Regional.

Returns the web ACL for the specified resource, either an application load balancer or Amazon API Gateway stage.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS WAF Regional's API operation GetWebACLForResource for usage and error information.

Returned Error Codes:

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

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

  • ErrCodeWAFNonexistentItemException "WAFNonexistentItemException" The operation failed because the referenced object doesn't exist.

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

  • You specified an invalid parameter name.

  • You specified an invalid value.

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

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

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

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

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

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

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

  • ErrCodeWAFUnavailableEntityException "WAFUnavailableEntityException" The operation failed because the entity referenced is temporarily unavailable. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/GetWebACLForResource

GetWebACLForResourceRequest

func (c *WAFRegional) GetWebACLForResourceRequest(input *GetWebACLForResourceInput) (req *request.Request, output *GetWebACLForResourceOutput)

GetWebACLForResourceRequest generates a "aws/request.Request" representing the client's request for the GetWebACLForResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetWebACLForResource for more information on using the GetWebACLForResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetWebACLForResourceRequest method. req, resp := client.GetWebACLForResourceRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/GetWebACLForResource

GetWebACLForResourceWithContext

func (c *WAFRegional) GetWebACLForResourceWithContext(ctx aws.Context, input *GetWebACLForResourceInput, opts ...request.Option) (*GetWebACLForResourceOutput, error)

GetWebACLForResourceWithContext is the same as GetWebACLForResource with the addition of the ability to pass a context and additional request options.

See GetWebACLForResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

GetWebACLRequest

func (c *WAFRegional) GetWebACLRequest(input *waf.GetWebACLInput) (req *request.Request, output *waf.GetWebACLOutput)

GetWebACLRequest generates a "aws/request.Request" representing the client's request for the GetWebACL operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetWebACL for more information on using the GetWebACL API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetWebACLRequest method. req, resp := client.GetWebACLRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/GetWebACL

GetWebACLWithContext

func (c *WAFRegional) GetWebACLWithContext(ctx aws.Context, input *waf.GetWebACLInput, opts ...request.Option) (*waf.GetWebACLOutput, error)

GetWebACLWithContext is the same as GetWebACL with the addition of the ability to pass a context and additional request options.

See GetWebACL for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

GetXssMatchSet

func (c *WAFRegional) GetXssMatchSet(input *waf.GetXssMatchSetInput) (*waf.GetXssMatchSetOutput, error)

GetXssMatchSet API operation for AWS WAF Regional.

Returns the XssMatchSet that is specified by XssMatchSetId.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS WAF Regional's API operation GetXssMatchSet for usage and error information.

Returned Error Codes:

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

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

  • ErrCodeWAFNonexistentItemException "WAFNonexistentItemException" The operation failed because the referenced object doesn't exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/GetXssMatchSet

Example

WAFRegional GetXssMatchSet shared00

To get an XSS match set

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

{ svc := wafregional.New(session.New()) input := &waf.GetXssMatchSetInput{ XssMatchSetId: aws.String("example1ds3t-46da-4fdb-b8d5-abc321j569j5"), } result, err := svc.GetXssMatchSet(input) if err != nil { if aerr, ok := err.(awserr.Error); ok { switch aerr.Code() { case wafregional.ErrCodeWAFInternalErrorException: fmt.Println(wafregional.ErrCodeWAFInternalErrorException, aerr.Error()) case wafregional.ErrCodeWAFInvalidAccountException: fmt.Println(wafregional.ErrCodeWAFInvalidAccountException, aerr.Error()) case wafregional.ErrCodeWAFNonexistentItemException: fmt.Println(wafregional.ErrCodeWAFNonexistentItemException, aerr.Error()) default: fmt.Println(aerr.Error()) } } else { fmt.Println(err.Error()) } return } fmt.Println(result) }

GetXssMatchSetRequest

func (c *WAFRegional) GetXssMatchSetRequest(input *waf.GetXssMatchSetInput) (req *request.Request, output *waf.GetXssMatchSetOutput)

GetXssMatchSetRequest generates a "aws/request.Request" representing the client's request for the GetXssMatchSet operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetXssMatchSet for more information on using the GetXssMatchSet API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetXssMatchSetRequest method. req, resp := client.GetXssMatchSetRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/GetXssMatchSet

GetXssMatchSetWithContext

func (c *WAFRegional) GetXssMatchSetWithContext(ctx aws.Context, input *waf.GetXssMatchSetInput, opts ...request.Option) (*waf.GetXssMatchSetOutput, error)

GetXssMatchSetWithContext is the same as GetXssMatchSet with the addition of the ability to pass a context and additional request options.

See GetXssMatchSet for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

ListActivatedRulesInRuleGroup

func (c *WAFRegional) ListActivatedRulesInRuleGroup(input *waf.ListActivatedRulesInRuleGroupInput) (*waf.ListActivatedRulesInRuleGroupOutput, error)

ListActivatedRulesInRuleGroup API operation for AWS WAF Regional.

Returns an array of ActivatedRule objects.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS WAF Regional's API operation ListActivatedRulesInRuleGroup for usage and error information.

Returned Error Codes:

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

  • ErrCodeWAFNonexistentItemException "WAFNonexistentItemException" The operation failed because the referenced object doesn't exist.

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

  • You specified an invalid parameter name.

  • You specified an invalid value.

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

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

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

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/ListActivatedRulesInRuleGroup

ListActivatedRulesInRuleGroupRequest

func (c *WAFRegional) ListActivatedRulesInRuleGroupRequest(input *waf.ListActivatedRulesInRuleGroupInput) (req *request.Request, output *waf.ListActivatedRulesInRuleGroupOutput)

ListActivatedRulesInRuleGroupRequest generates a "aws/request.Request" representing the client's request for the ListActivatedRulesInRuleGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListActivatedRulesInRuleGroup for more information on using the ListActivatedRulesInRuleGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListActivatedRulesInRuleGroupRequest method. req, resp := client.ListActivatedRulesInRuleGroupRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/ListActivatedRulesInRuleGroup

ListActivatedRulesInRuleGroupWithContext

func (c *WAFRegional) ListActivatedRulesInRuleGroupWithContext(ctx aws.Context, input *waf.ListActivatedRulesInRuleGroupInput, opts ...request.Option) (*waf.ListActivatedRulesInRuleGroupOutput, error)

ListActivatedRulesInRuleGroupWithContext is the same as ListActivatedRulesInRuleGroup with the addition of the ability to pass a context and additional request options.

See ListActivatedRulesInRuleGroup for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

ListByteMatchSets

func (c *WAFRegional) ListByteMatchSets(input *waf.ListByteMatchSetsInput) (*waf.ListByteMatchSetsOutput, error)

ListByteMatchSets API operation for AWS WAF Regional.

Returns an array of ByteMatchSetSummary objects.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS WAF Regional's API operation ListByteMatchSets for usage and error information.

Returned Error Codes:

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/ListByteMatchSets

ListByteMatchSetsRequest

func (c *WAFRegional) ListByteMatchSetsRequest(input *waf.ListByteMatchSetsInput) (req *request.Request, output *waf.ListByteMatchSetsOutput)

ListByteMatchSetsRequest generates a "aws/request.Request" representing the client's request for the ListByteMatchSets operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListByteMatchSets for more information on using the ListByteMatchSets API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListByteMatchSetsRequest method. req, resp := client.ListByteMatchSetsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/ListByteMatchSets

ListByteMatchSetsWithContext

func (c *WAFRegional) ListByteMatchSetsWithContext(ctx aws.Context, input *waf.ListByteMatchSetsInput, opts ...request.Option) (*waf.ListByteMatchSetsOutput, error)

ListByteMatchSetsWithContext is the same as ListByteMatchSets with the addition of the ability to pass a context and additional request options.

See ListByteMatchSets for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

ListGeoMatchSets

func (c *WAFRegional) ListGeoMatchSets(input *waf.ListGeoMatchSetsInput) (*waf.ListGeoMatchSetsOutput, error)

ListGeoMatchSets API operation for AWS WAF Regional.

Returns an array of GeoMatchSetSummary objects in the response.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS WAF Regional's API operation ListGeoMatchSets for usage and error information.

Returned Error Codes:

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/ListGeoMatchSets

ListGeoMatchSetsRequest

func (c *WAFRegional) ListGeoMatchSetsRequest(input *waf.ListGeoMatchSetsInput) (req *request.Request, output *waf.ListGeoMatchSetsOutput)

ListGeoMatchSetsRequest generates a "aws/request.Request" representing the client's request for the ListGeoMatchSets operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListGeoMatchSets for more information on using the ListGeoMatchSets API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListGeoMatchSetsRequest method. req, resp := client.ListGeoMatchSetsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/ListGeoMatchSets

ListGeoMatchSetsWithContext

func (c *WAFRegional) ListGeoMatchSetsWithContext(ctx aws.Context, input *waf.ListGeoMatchSetsInput, opts ...request.Option) (*waf.ListGeoMatchSetsOutput, error)

ListGeoMatchSetsWithContext is the same as ListGeoMatchSets with the addition of the ability to pass a context and additional request options.

See ListGeoMatchSets for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

ListIPSets

func (c *WAFRegional) ListIPSets(input *waf.ListIPSetsInput) (*waf.ListIPSetsOutput, error)

ListIPSets API operation for AWS WAF Regional.

Returns an array of IPSetSummary objects in the response.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS WAF Regional's API operation ListIPSets for usage and error information.

Returned Error Codes:

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/ListIPSets

Example

WAFRegional ListIPSets shared00

To list IP sets

The following example returns an array of up to 100 IP match sets.

{ svc := wafregional.New(session.New()) input := &waf.ListIPSetsInput{ Limit: aws.Int64(100), } result, err := svc.ListIPSets(input) if err != nil { if aerr, ok := err.(awserr.Error); ok { switch aerr.Code() { case wafregional.ErrCodeWAFInternalErrorException: fmt.Println(wafregional.ErrCodeWAFInternalErrorException, aerr.Error()) case wafregional.ErrCodeWAFInvalidAccountException: fmt.Println(wafregional.ErrCodeWAFInvalidAccountException, aerr.Error()) default: fmt.Println(aerr.Error()) } } else { fmt.Println(err.Error()) } return } fmt.Println(result) }

ListIPSetsRequest

func (c *WAFRegional) ListIPSetsRequest(input *waf.ListIPSetsInput) (req *request.Request, output *waf.ListIPSetsOutput)

ListIPSetsRequest generates a "aws/request.Request" representing the client's request for the ListIPSets operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListIPSets for more information on using the ListIPSets API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListIPSetsRequest method. req, resp := client.ListIPSetsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/ListIPSets

ListIPSetsWithContext

func (c *WAFRegional) ListIPSetsWithContext(ctx aws.Context, input *waf.ListIPSetsInput, opts ...request.Option) (*waf.ListIPSetsOutput, error)

ListIPSetsWithContext is the same as ListIPSets with the addition of the ability to pass a context and additional request options.

See ListIPSets for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

ListLoggingConfigurations

func (c *WAFRegional) ListLoggingConfigurations(input *waf.ListLoggingConfigurationsInput) (*waf.ListLoggingConfigurationsOutput, error)

ListLoggingConfigurations API operation for AWS WAF Regional.

Returns an array of LoggingConfiguration objects.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS WAF Regional's API operation ListLoggingConfigurations for usage and error information.

Returned Error Codes:

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

  • ErrCodeWAFNonexistentItemException "WAFNonexistentItemException" The operation failed because the referenced object doesn't exist.

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

  • You specified an invalid parameter name.

  • You specified an invalid value.

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

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

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

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/ListLoggingConfigurations

ListLoggingConfigurationsRequest

func (c *WAFRegional) ListLoggingConfigurationsRequest(input *waf.ListLoggingConfigurationsInput) (req *request.Request, output *waf.ListLoggingConfigurationsOutput)

ListLoggingConfigurationsRequest generates a "aws/request.Request" representing the client's request for the ListLoggingConfigurations operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListLoggingConfigurations for more information on using the ListLoggingConfigurations API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListLoggingConfigurationsRequest method. req, resp := client.ListLoggingConfigurationsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/ListLoggingConfigurations

ListLoggingConfigurationsWithContext

func (c *WAFRegional) ListLoggingConfigurationsWithContext(ctx aws.Context, input *waf.ListLoggingConfigurationsInput, opts ...request.Option) (*waf.ListLoggingConfigurationsOutput, error)

ListLoggingConfigurationsWithContext is the same as ListLoggingConfigurations with the addition of the ability to pass a context and additional request options.

See ListLoggingConfigurations for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

ListRateBasedRules

func (c *WAFRegional) ListRateBasedRules(input *waf.ListRateBasedRulesInput) (*waf.ListRateBasedRulesOutput, error)

ListRateBasedRules API operation for AWS WAF Regional.

Returns an array of RuleSummary objects.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS WAF Regional's API operation ListRateBasedRules for usage and error information.

Returned Error Codes:

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/ListRateBasedRules

ListRateBasedRulesRequest

func (c *WAFRegional) ListRateBasedRulesRequest(input *waf.ListRateBasedRulesInput) (req *request.Request, output *waf.ListRateBasedRulesOutput)

ListRateBasedRulesRequest generates a "aws/request.Request" representing the client's request for the ListRateBasedRules operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListRateBasedRules for more information on using the ListRateBasedRules API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListRateBasedRulesRequest method. req, resp := client.ListRateBasedRulesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/ListRateBasedRules

ListRateBasedRulesWithContext

func (c *WAFRegional) ListRateBasedRulesWithContext(ctx aws.Context, input *waf.ListRateBasedRulesInput, opts ...request.Option) (*waf.ListRateBasedRulesOutput, error)

ListRateBasedRulesWithContext is the same as ListRateBasedRules with the addition of the ability to pass a context and additional request options.

See ListRateBasedRules for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

ListRegexMatchSets

func (c *WAFRegional) ListRegexMatchSets(input *waf.ListRegexMatchSetsInput) (*waf.ListRegexMatchSetsOutput, error)

ListRegexMatchSets API operation for AWS WAF Regional.

Returns an array of RegexMatchSetSummary objects.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS WAF Regional's API operation ListRegexMatchSets for usage and error information.

Returned Error Codes:

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/ListRegexMatchSets

ListRegexMatchSetsRequest

func (c *WAFRegional) ListRegexMatchSetsRequest(input *waf.ListRegexMatchSetsInput) (req *request.Request, output *waf.ListRegexMatchSetsOutput)

ListRegexMatchSetsRequest generates a "aws/request.Request" representing the client's request for the ListRegexMatchSets operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListRegexMatchSets for more information on using the ListRegexMatchSets API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListRegexMatchSetsRequest method. req, resp := client.ListRegexMatchSetsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/ListRegexMatchSets

ListRegexMatchSetsWithContext

func (c *WAFRegional) ListRegexMatchSetsWithContext(ctx aws.Context, input *waf.ListRegexMatchSetsInput, opts ...request.Option) (*waf.ListRegexMatchSetsOutput, error)

ListRegexMatchSetsWithContext is the same as ListRegexMatchSets with the addition of the ability to pass a context and additional request options.

See ListRegexMatchSets for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

ListRegexPatternSets

func (c *WAFRegional) ListRegexPatternSets(input *waf.ListRegexPatternSetsInput) (*waf.ListRegexPatternSetsOutput, error)

ListRegexPatternSets API operation for AWS WAF Regional.

Returns an array of RegexPatternSetSummary objects.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS WAF Regional's API operation ListRegexPatternSets for usage and error information.

Returned Error Codes:

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/ListRegexPatternSets

ListRegexPatternSetsRequest

func (c *WAFRegional) ListRegexPatternSetsRequest(input *waf.ListRegexPatternSetsInput) (req *request.Request, output *waf.ListRegexPatternSetsOutput)

ListRegexPatternSetsRequest generates a "aws/request.Request" representing the client's request for the ListRegexPatternSets operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListRegexPatternSets for more information on using the ListRegexPatternSets API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListRegexPatternSetsRequest method. req, resp := client.ListRegexPatternSetsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/ListRegexPatternSets

ListRegexPatternSetsWithContext

func (c *WAFRegional) ListRegexPatternSetsWithContext(ctx aws.Context, input *waf.ListRegexPatternSetsInput, opts ...request.Option) (*waf.ListRegexPatternSetsOutput, error)

ListRegexPatternSetsWithContext is the same as ListRegexPatternSets with the addition of the ability to pass a context and additional request options.

See ListRegexPatternSets for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

ListResourcesForWebACL

func (c *WAFRegional) ListResourcesForWebACL(input *ListResourcesForWebACLInput) (*ListResourcesForWebACLOutput, error)

ListResourcesForWebACL API operation for AWS WAF Regional.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS WAF Regional's API operation ListResourcesForWebACL for usage and error information.

Returned Error Codes:

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

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

  • ErrCodeWAFNonexistentItemException "WAFNonexistentItemException" The operation failed because the referenced object doesn't exist.

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

  • You specified an invalid parameter name.

  • You specified an invalid value.

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

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

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

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/ListResourcesForWebACL

ListResourcesForWebACLRequest

func (c *WAFRegional) ListResourcesForWebACLRequest(input *ListResourcesForWebACLInput) (req *request.Request, output *ListResourcesForWebACLOutput)

ListResourcesForWebACLRequest generates a "aws/request.Request" representing the client's request for the ListResourcesForWebACL operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListResourcesForWebACL for more information on using the ListResourcesForWebACL API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListResourcesForWebACLRequest method. req, resp := client.ListResourcesForWebACLRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/ListResourcesForWebACL

ListResourcesForWebACLWithContext

func (c *WAFRegional) ListResourcesForWebACLWithContext(ctx aws.Context, input *ListResourcesForWebACLInput, opts ...request.Option) (*ListResourcesForWebACLOutput, error)

ListResourcesForWebACLWithContext is the same as ListResourcesForWebACL with the addition of the ability to pass a context and additional request options.

See ListResourcesForWebACL for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

ListRuleGroups

func (c *WAFRegional) ListRuleGroups(input *waf.ListRuleGroupsInput) (*waf.ListRuleGroupsOutput, error)

ListRuleGroups API operation for AWS WAF Regional.

Returns an array of RuleGroup objects.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS WAF Regional's API operation ListRuleGroups for usage and error information.

Returned Error Codes:

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

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/ListRuleGroups

ListRuleGroupsRequest

func (c *WAFRegional) ListRuleGroupsRequest(input *waf.ListRuleGroupsInput) (req *request.Request, output *waf.ListRuleGroupsOutput)

ListRuleGroupsRequest generates a "aws/request.Request" representing the client's request for the ListRuleGroups operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListRuleGroups for more information on using the ListRuleGroups API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListRuleGroupsRequest method. req, resp := client.ListRuleGroupsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/ListRuleGroups

ListRuleGroupsWithContext

func (c *WAFRegional) ListRuleGroupsWithContext(ctx aws.Context, input *waf.ListRuleGroupsInput, opts ...request.Option) (*waf.ListRuleGroupsOutput, error)

ListRuleGroupsWithContext is the same as ListRuleGroups with the addition of the ability to pass a context and additional request options.

See ListRuleGroups for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

ListRules

func (c *WAFRegional) ListRules(input *waf.ListRulesInput) (*waf.ListRulesOutput, error)

ListRules API operation for AWS WAF Regional.

Returns an array of RuleSummary objects.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS WAF Regional's API operation ListRules for usage and error information.

Returned Error Codes:

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/ListRules

Example

WAFRegional ListRules shared00

To list rules

The following example returns an array of up to 100 rules.

{ svc := wafregional.New(session.New()) input := &waf.ListRulesInput{ Limit: aws.Int64(100), } result, err := svc.ListRules(input) if err != nil { if aerr, ok := err.(awserr.Error); ok { switch aerr.Code() { case wafregional.ErrCodeWAFInternalErrorException: fmt.Println(wafregional.ErrCodeWAFInternalErrorException, aerr.Error()) case wafregional.ErrCodeWAFInvalidAccountException: fmt.Println(wafregional.ErrCodeWAFInvalidAccountException, aerr.Error()) default: fmt.Println(aerr.Error()) } } else { fmt.Println(err.Error()) } return } fmt.Println(result) }

ListRulesRequest

func (c *WAFRegional) ListRulesRequest(input *waf.ListRulesInput) (req *request.Request, output *waf.ListRulesOutput)

ListRulesRequest generates a "aws/request.Request" representing the client's request for the ListRules operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListRules for more information on using the ListRules API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListRulesRequest method. req, resp := client.ListRulesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/ListRules

ListRulesWithContext

func (c *WAFRegional) ListRulesWithContext(ctx aws.Context, input *waf.ListRulesInput, opts ...request.Option) (*waf.ListRulesOutput, error)

ListRulesWithContext is the same as ListRules with the addition of the ability to pass a context and additional request options.

See ListRules for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

ListSizeConstraintSets

func (c *WAFRegional) ListSizeConstraintSets(input *waf.ListSizeConstraintSetsInput) (*waf.ListSizeConstraintSetsOutput, error)

ListSizeConstraintSets API operation for AWS WAF Regional.

Returns an array of SizeConstraintSetSummary objects.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS WAF Regional's API operation ListSizeConstraintSets for usage and error information.

Returned Error Codes:

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/ListSizeConstraintSets

Example

WAFRegional ListSizeConstraintSets shared00

To list a size constraint sets

The following example returns an array of up to 100 size contraint match sets.

{ svc := wafregional.New(session.New()) input := &waf.ListSizeConstraintSetsInput{ Limit: aws.Int64(100), } result, err := svc.ListSizeConstraintSets(input) if err != nil { if aerr, ok := err.(awserr.Error); ok { switch aerr.Code() { case wafregional.ErrCodeWAFInternalErrorException: fmt.Println(wafregional.ErrCodeWAFInternalErrorException, aerr.Error()) case wafregional.ErrCodeWAFInvalidAccountException: fmt.Println(wafregional.ErrCodeWAFInvalidAccountException, aerr.Error()) default: fmt.Println(aerr.Error()) } } else { fmt.Println(err.Error()) } return } fmt.Println(result) }

ListSizeConstraintSetsRequest

func (c *WAFRegional) ListSizeConstraintSetsRequest(input *waf.ListSizeConstraintSetsInput) (req *request.Request, output *waf.ListSizeConstraintSetsOutput)

ListSizeConstraintSetsRequest generates a "aws/request.Request" representing the client's request for the ListSizeConstraintSets operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListSizeConstraintSets for more information on using the ListSizeConstraintSets API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListSizeConstraintSetsRequest method. req, resp := client.ListSizeConstraintSetsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/ListSizeConstraintSets

ListSizeConstraintSetsWithContext

func (c *WAFRegional) ListSizeConstraintSetsWithContext(ctx aws.Context, input *waf.ListSizeConstraintSetsInput, opts ...request.Option) (*waf.ListSizeConstraintSetsOutput, error)

ListSizeConstraintSetsWithContext is the same as ListSizeConstraintSets with the addition of the ability to pass a context and additional request options.

See ListSizeConstraintSets for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

ListSqlInjectionMatchSets

func (c *WAFRegional) ListSqlInjectionMatchSets(input *waf.ListSqlInjectionMatchSetsInput) (*waf.ListSqlInjectionMatchSetsOutput, error)

ListSqlInjectionMatchSets API operation for AWS WAF Regional.

Returns an array of SqlInjectionMatchSet objects.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS WAF Regional's API operation ListSqlInjectionMatchSets for usage and error information.

Returned Error Codes:

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/ListSqlInjectionMatchSets

Example

WAFRegional ListSqlInjectionMatchSets shared00

To list SQL injection match sets

The following example returns an array of up to 100 SQL injection match sets.

{ svc := wafregional.New(session.New()) input := &waf.ListSqlInjectionMatchSetsInput{ Limit: aws.Int64(100), } result, err := svc.ListSqlInjectionMatchSets(input) if err != nil { if aerr, ok := err.(awserr.Error); ok { switch aerr.Code() { case wafregional.ErrCodeWAFInternalErrorException: fmt.Println(wafregional.ErrCodeWAFInternalErrorException, aerr.Error()) case wafregional.ErrCodeWAFInvalidAccountException: fmt.Println(wafregional.ErrCodeWAFInvalidAccountException, aerr.Error()) default: fmt.Println(aerr.Error()) } } else { fmt.Println(err.Error()) } return } fmt.Println(result) }

ListSqlInjectionMatchSetsRequest

func (c *WAFRegional) ListSqlInjectionMatchSetsRequest(input *waf.ListSqlInjectionMatchSetsInput) (req *request.Request, output *waf.ListSqlInjectionMatchSetsOutput)

ListSqlInjectionMatchSetsRequest generates a "aws/request.Request" representing the client's request for the ListSqlInjectionMatchSets operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListSqlInjectionMatchSets for more information on using the ListSqlInjectionMatchSets API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListSqlInjectionMatchSetsRequest method. req, resp := client.ListSqlInjectionMatchSetsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/ListSqlInjectionMatchSets

ListSqlInjectionMatchSetsWithContext

func (c *WAFRegional) ListSqlInjectionMatchSetsWithContext(ctx aws.Context, input *waf.ListSqlInjectionMatchSetsInput, opts ...request.Option) (*waf.ListSqlInjectionMatchSetsOutput, error)

ListSqlInjectionMatchSetsWithContext is the same as ListSqlInjectionMatchSets with the addition of the ability to pass a context and additional request options.

See ListSqlInjectionMatchSets for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

ListSubscribedRuleGroups

func (c *WAFRegional) ListSubscribedRuleGroups(input *waf.ListSubscribedRuleGroupsInput) (*waf.ListSubscribedRuleGroupsOutput, error)

ListSubscribedRuleGroups API operation for AWS WAF Regional.

Returns an array of RuleGroup objects that you are subscribed to.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS WAF Regional's API operation ListSubscribedRuleGroups for usage and error information.

Returned Error Codes:

  • ErrCodeWAFNonexistentItemException "WAFNonexistentItemException" The operation failed because the referenced object doesn't exist.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/ListSubscribedRuleGroups

ListSubscribedRuleGroupsRequest

func (c *WAFRegional) ListSubscribedRuleGroupsRequest(input *waf.ListSubscribedRuleGroupsInput) (req *request.Request, output *waf.ListSubscribedRuleGroupsOutput)

ListSubscribedRuleGroupsRequest generates a "aws/request.Request" representing the client's request for the ListSubscribedRuleGroups operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListSubscribedRuleGroups for more information on using the ListSubscribedRuleGroups API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListSubscribedRuleGroupsRequest method. req, resp := client.ListSubscribedRuleGroupsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/ListSubscribedRuleGroups

ListSubscribedRuleGroupsWithContext

func (c *WAFRegional) ListSubscribedRuleGroupsWithContext(ctx aws.Context, input *waf.ListSubscribedRuleGroupsInput, opts ...request.Option) (*waf.ListSubscribedRuleGroupsOutput, error)

ListSubscribedRuleGroupsWithContext is the same as ListSubscribedRuleGroups with the addition of the ability to pass a context and additional request options.

See ListSubscribedRuleGroups for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

ListWebACLs

func (c *WAFRegional) ListWebACLs(input *waf.ListWebACLsInput) (*waf.ListWebACLsOutput, error)

ListWebACLs API operation for AWS WAF Regional.

Returns an array of WebACLSummary objects in the response.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS WAF Regional's API operation ListWebACLs for usage and error information.

Returned Error Codes:

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/ListWebACLs

Example

WAFRegional ListWebACLs shared00

To list Web ACLs

The following example returns an array of up to 100 web ACLs.

{ svc := wafregional.New(session.New()) input := &waf.ListWebACLsInput{ Limit: aws.Int64(100), } result, err := svc.ListWebACLs(input) if err != nil { if aerr, ok := err.(awserr.Error); ok { switch aerr.Code() { case wafregional.ErrCodeWAFInternalErrorException: fmt.Println(wafregional.ErrCodeWAFInternalErrorException, aerr.Error()) case wafregional.ErrCodeWAFInvalidAccountException: fmt.Println(wafregional.ErrCodeWAFInvalidAccountException, aerr.Error()) default: fmt.Println(aerr.Error()) } } else { fmt.Println(err.Error()) } return } fmt.Println(result) }

ListWebACLsRequest

func (c *WAFRegional) ListWebACLsRequest(input *waf.ListWebACLsInput) (req *request.Request, output *waf.ListWebACLsOutput)

ListWebACLsRequest generates a "aws/request.Request" representing the client's request for the ListWebACLs operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListWebACLs for more information on using the ListWebACLs API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListWebACLsRequest method. req, resp := client.ListWebACLsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/ListWebACLs

ListWebACLsWithContext

func (c *WAFRegional) ListWebACLsWithContext(ctx aws.Context, input *waf.ListWebACLsInput, opts ...request.Option) (*waf.ListWebACLsOutput, error)

ListWebACLsWithContext is the same as ListWebACLs with the addition of the ability to pass a context and additional request options.

See ListWebACLs for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

ListXssMatchSets

func (c *WAFRegional) ListXssMatchSets(input *waf.ListXssMatchSetsInput) (*waf.ListXssMatchSetsOutput, error)

ListXssMatchSets API operation for AWS WAF Regional.

Returns an array of XssMatchSet objects.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS WAF Regional's API operation ListXssMatchSets for usage and error information.

Returned Error Codes:

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/ListXssMatchSets

Example

WAFRegional ListXssMatchSets shared00

To list XSS match sets

The following example returns an array of up to 100 XSS match sets.

{ svc := wafregional.New(session.New()) input := &waf.ListXssMatchSetsInput{ Limit: aws.Int64(100), } result, err := svc.ListXssMatchSets(input) if err != nil { if aerr, ok := err.(awserr.Error); ok { switch aerr.Code() { case wafregional.ErrCodeWAFInternalErrorException: fmt.Println(wafregional.ErrCodeWAFInternalErrorException, aerr.Error()) case wafregional.ErrCodeWAFInvalidAccountException: fmt.Println(wafregional.ErrCodeWAFInvalidAccountException, aerr.Error()) default: fmt.Println(aerr.Error()) } } else { fmt.Println(err.Error()) } return } fmt.Println(result) }

ListXssMatchSetsRequest

func (c *WAFRegional) ListXssMatchSetsRequest(input *waf.ListXssMatchSetsInput) (req *request.Request, output *waf.ListXssMatchSetsOutput)

ListXssMatchSetsRequest generates a "aws/request.Request" representing the client's request for the ListXssMatchSets operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListXssMatchSets for more information on using the ListXssMatchSets API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListXssMatchSetsRequest method. req, resp := client.ListXssMatchSetsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/ListXssMatchSets

ListXssMatchSetsWithContext

func (c *WAFRegional) ListXssMatchSetsWithContext(ctx aws.Context, input *waf.ListXssMatchSetsInput, opts ...request.Option) (*waf.ListXssMatchSetsOutput, error)

ListXssMatchSetsWithContext is the same as ListXssMatchSets with the addition of the ability to pass a context and additional request options.

See ListXssMatchSets for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

PutLoggingConfiguration

func (c *WAFRegional) PutLoggingConfiguration(input *waf.PutLoggingConfigurationInput) (*waf.PutLoggingConfigurationOutput, error)

PutLoggingConfiguration API operation for AWS WAF Regional.

Associates a LoggingConfiguration with a specified web ACL.

You can access information about all traffic that AWS WAF inspects using the following steps:

Create an Amazon Kinesis Data Firehose .

Create the data firehose with a PUT source and in the region that you are operating. However, if you are capturing logs for Amazon CloudFront, always create the firehose in US East (N. Virginia).

Associate that firehose to your web ACL using a PutLoggingConfiguration request.

When you successfully enable logging using a PutLoggingConfiguration request, AWS WAF will create a service linked role with the necessary permissions to write logs to the Amazon Kinesis Data Firehose. For more information, see Logging Web ACL Traffic Information (https://docs.aws.amazon.com/waf/latest/developerguide/logging.html) in the AWS WAF Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS WAF Regional's API operation PutLoggingConfiguration for usage and error information.

Returned Error Codes:

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

  • ErrCodeWAFNonexistentItemException "WAFNonexistentItemException" The operation failed because the referenced object doesn't exist.

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/PutLoggingConfiguration

PutLoggingConfigurationRequest

func (c *WAFRegional) PutLoggingConfigurationRequest(input *waf.PutLoggingConfigurationInput) (req *request.Request, output *waf.PutLoggingConfigurationOutput)

PutLoggingConfigurationRequest generates a "aws/request.Request" representing the client's request for the PutLoggingConfiguration operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PutLoggingConfiguration for more information on using the PutLoggingConfiguration API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the PutLoggingConfigurationRequest method. req, resp := client.PutLoggingConfigurationRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/PutLoggingConfiguration

PutLoggingConfigurationWithContext

func (c *WAFRegional) PutLoggingConfigurationWithContext(ctx aws.Context, input *waf.PutLoggingConfigurationInput, opts ...request.Option) (*waf.PutLoggingConfigurationOutput, error)

PutLoggingConfigurationWithContext is the same as PutLoggingConfiguration with the addition of the ability to pass a context and additional request options.

See PutLoggingConfiguration for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

PutPermissionPolicy

func (c *WAFRegional) PutPermissionPolicy(input *waf.PutPermissionPolicyInput) (*waf.PutPermissionPolicyOutput, error)

PutPermissionPolicy API operation for AWS WAF Regional.

Attaches a IAM policy to the specified resource. The only supported use for this action is to share a RuleGroup across accounts.

The PutPermissionPolicy is subject to the following restrictions:

  • You can attach only one policy with each PutPermissionPolicy request.

  • The policy must include an Effect, Action and Principal.

  • Effect must specify Allow.

  • The Action in the policy must be waf:UpdateWebACL, waf-regional:UpdateWebACL, waf:GetRuleGroup and waf-regional:GetRuleGroup . Any extra or wildcard actions in the policy will be rejected.

  • The policy cannot include a Resource parameter.

  • The ARN in the request must be a valid WAF RuleGroup ARN and the RuleGroup must exist in the same region.

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

  • Your policy must be composed using IAM Policy version 2012-10-17.

For more information, see IAM Policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html).

An example of a valid policy parameter is shown in the Examples section below.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS WAF Regional's API operation PutPermissionPolicy for usage and error information.

Returned Error Codes:

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

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

  • ErrCodeWAFNonexistentItemException "WAFNonexistentItemException" The operation failed because the referenced object doesn't exist.

  • ErrCodeWAFInvalidPermissionPolicyException "WAFInvalidPermissionPolicyException" The operation failed because the specified policy is not in the proper format.

The policy is subject to the following restrictions:
  • You can attach only one policy with each PutPermissionPolicy request.

  • The policy must include an Effect, Action and Principal.

  • Effect must specify Allow.

  • The Action in the policy must be waf:UpdateWebACL, waf-regional:UpdateWebACL, waf:GetRuleGroup and waf-regional:GetRuleGroup . Any extra or wildcard actions in the policy will be rejected.

  • The policy cannot include a Resource parameter.

  • The ARN in the request must be a valid WAF RuleGroup ARN and the RuleGroup must exist in the same region.

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

  • Your policy must be composed using IAM Policy version 2012-10-17.

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/PutPermissionPolicy

PutPermissionPolicyRequest

func (c *WAFRegional) PutPermissionPolicyRequest(input *waf.PutPermissionPolicyInput) (req *request.Request, output *waf.PutPermissionPolicyOutput)

PutPermissionPolicyRequest generates a "aws/request.Request" representing the client's request for the PutPermissionPolicy operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PutPermissionPolicy for more information on using the PutPermissionPolicy API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the PutPermissionPolicyRequest method. req, resp := client.PutPermissionPolicyRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/PutPermissionPolicy

PutPermissionPolicyWithContext

func (c *WAFRegional) PutPermissionPolicyWithContext(ctx aws.Context, input *waf.PutPermissionPolicyInput, opts ...request.Option) (*waf.PutPermissionPolicyOutput, error)

PutPermissionPolicyWithContext is the same as PutPermissionPolicy with the addition of the ability to pass a context and additional request options.

See PutPermissionPolicy for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

UpdateByteMatchSet

func (c *WAFRegional) UpdateByteMatchSet(input *waf.UpdateByteMatchSetInput) (*waf.UpdateByteMatchSetOutput, error)

UpdateByteMatchSet API operation for AWS WAF Regional.

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:

Create a ByteMatchSet. For more information, see CreateByteMatchSet.

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

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

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS WAF Regional's API operation UpdateByteMatchSet for usage and error information.

Returned Error Codes:

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

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

  • ErrCodeWAFInvalidOperationException "WAFInvalidOperationException" The operation failed because there was nothing to do. For example:

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

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

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

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

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

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

  • You specified an invalid parameter name.

  • You specified an invalid value.

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

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

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

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

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

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

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

  • ErrCodeWAFNonexistentContainerException "WAFNonexistentContainerException" 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.

  • ErrCodeWAFNonexistentItemException "WAFNonexistentItemException" The operation failed because the referenced object doesn't exist.

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

  • ErrCodeWAFLimitsExceededException "WAFLimitsExceededException" The operation exceeds a resource limit, for example, the maximum number of WebACL objects that you can create for an AWS account. For more information, see Limits (https://docs.aws.amazon.com/waf/latest/developerguide/limits.html) in the AWS WAF Developer Guide.

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/UpdateByteMatchSet

Example

WAFRegional UpdateByteMatchSet shared00

To update a byte match set

The following example deletes a ByteMatchTuple object (filters) in an byte match set with the ID exampleIDs3t-46da-4fdb-b8d5-abc321j569j5.

{ svc := wafregional.New(session.New()) input := &waf.UpdateByteMatchSetInput{ ByteMatchSetId: aws.String("exampleIDs3t-46da-4fdb-b8d5-abc321j569j5"), ChangeToken: aws.String("abcd12f2-46da-4fdb-b8d5-fbd4c466928f"), Updates: []*waf.ByteMatchSetUpdate{ { Action: aws.String("DELETE"), ByteMatchTuple: &waf.ByteMatchTuple{ FieldToMatch: &waf.FieldToMatch{ Data: aws.String("referer"), Type: aws.String("HEADER"), }, PositionalConstraint: aws.String("CONTAINS"), TargetString: []byte("badrefer1"), TextTransformation: aws.String("NONE"), }, }, }, } result, err := svc.UpdateByteMatchSet(input) if err != nil { if aerr, ok := err.(awserr.Error); ok { switch aerr.Code() { case wafregional.ErrCodeWAFInternalErrorException: fmt.Println(wafregional.ErrCodeWAFInternalErrorException, aerr.Error()) case wafregional.ErrCodeWAFInvalidAccountException: fmt.Println(wafregional.ErrCodeWAFInvalidAccountException, aerr.Error()) case wafregional.ErrCodeWAFInvalidOperationException: fmt.Println(wafregional.ErrCodeWAFInvalidOperationException, aerr.Error()) case wafregional.ErrCodeWAFInvalidParameterException: fmt.Println(wafregional.ErrCodeWAFInvalidParameterException, aerr.Error()) case wafregional.ErrCodeWAFNonexistentContainerException: fmt.Println(wafregional.ErrCodeWAFNonexistentContainerException, aerr.Error()) case wafregional.ErrCodeWAFNonexistentItemException: fmt.Println(wafregional.ErrCodeWAFNonexistentItemException, aerr.Error()) case wafregional.ErrCodeWAFStaleDataException: fmt.Println(wafregional.ErrCodeWAFStaleDataException, aerr.Error()) case wafregional.ErrCodeWAFLimitsExceededException: fmt.Println(wafregional.ErrCodeWAFLimitsExceededException, aerr.Error()) default: fmt.Println(aerr.Error()) } } else { fmt.Println(err.Error()) } return } fmt.Println(result) }

UpdateByteMatchSetRequest

func (c *WAFRegional) UpdateByteMatchSetRequest(input *waf.UpdateByteMatchSetInput) (req *request.Request, output *waf.UpdateByteMatchSetOutput)

UpdateByteMatchSetRequest generates a "aws/request.Request" representing the client's request for the UpdateByteMatchSet operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateByteMatchSet for more information on using the UpdateByteMatchSet API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateByteMatchSetRequest method. req, resp := client.UpdateByteMatchSetRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/UpdateByteMatchSet

UpdateByteMatchSetWithContext

func (c *WAFRegional) UpdateByteMatchSetWithContext(ctx aws.Context, input *waf.UpdateByteMatchSetInput, opts ...request.Option) (*waf.UpdateByteMatchSetOutput, error)

UpdateByteMatchSetWithContext is the same as UpdateByteMatchSet with the addition of the ability to pass a context and additional request options.

See UpdateByteMatchSet for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

UpdateGeoMatchSet

func (c *WAFRegional) UpdateGeoMatchSet(input *waf.UpdateGeoMatchSetInput) (*waf.UpdateGeoMatchSetOutput, error)

UpdateGeoMatchSet API operation for AWS WAF Regional.

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

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

  • The Type. The only valid value for Type is Country.

  • The Value, which is a two character code for the country to add to the GeoMatchConstraint object. Valid codes are listed in GeoMatchConstraint$Value.

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

Submit a CreateGeoMatchSet request.

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

Submit an UpdateGeoMatchSet request to specify the country that you want AWS WAF to watch for.

When you update an GeoMatchSet, you specify the country that you want to add and/or the country that you want to delete. If you want to change a country, you delete the existing country 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 (https://docs.aws.amazon.com/waf/latest/developerguide/).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS WAF Regional's API operation UpdateGeoMatchSet for usage and error information.

Returned Error Codes:

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

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

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

  • ErrCodeWAFInvalidOperationException "WAFInvalidOperationException" The operation failed because there was nothing to do. For example:

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

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

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

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

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

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

  • You specified an invalid parameter name.

  • You specified an invalid value.

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

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

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

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

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

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

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

  • ErrCodeWAFNonexistentContainerException "WAFNonexistentContainerException" 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.

  • ErrCodeWAFNonexistentItemException "WAFNonexistentItemException" The operation failed because the referenced object doesn't exist.

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

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

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

  • ErrCodeWAFLimitsExceededException "WAFLimitsExceededException" The operation exceeds a resource limit, for example, the maximum number of WebACL objects that you can create for an AWS account. For more information, see Limits (https://docs.aws.amazon.com/waf/latest/developerguide/limits.html) in the AWS WAF Developer Guide.

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/UpdateGeoMatchSet

UpdateGeoMatchSetRequest

func (c *WAFRegional) UpdateGeoMatchSetRequest(input *waf.UpdateGeoMatchSetInput) (req *request.Request, output *waf.UpdateGeoMatchSetOutput)

UpdateGeoMatchSetRequest generates a "aws/request.Request" representing the client's request for the UpdateGeoMatchSet operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateGeoMatchSet for more information on using the UpdateGeoMatchSet API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateGeoMatchSetRequest method. req, resp := client.UpdateGeoMatchSetRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/UpdateGeoMatchSet

UpdateGeoMatchSetWithContext

func (c *WAFRegional) UpdateGeoMatchSetWithContext(ctx aws.Context, input *waf.UpdateGeoMatchSetInput, opts ...request.Option) (*waf.UpdateGeoMatchSetOutput, error)

UpdateGeoMatchSetWithContext is the same as UpdateGeoMatchSet with the addition of the ability to pass a context and additional request options.

See UpdateGeoMatchSet for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

UpdateIPSet

func (c *WAFRegional) UpdateIPSet(input *waf.UpdateIPSetInput) (*waf.UpdateIPSetOutput, error)

UpdateIPSet API operation for AWS WAF Regional.

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 IPv4 address ranges: /8 and any range between /16 through /32. AWS WAF supports IPv6 address ranges: /24, /32, /48, /56, /64, and /128. For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing (https://en.wikipedia.org/wiki/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:

Submit a CreateIPSet request.

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

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

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.

You can insert a maximum of 1000 addresses in a single request.

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS WAF Regional's API operation UpdateIPSet for usage and error information.

Returned Error Codes:

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

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

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

  • ErrCodeWAFInvalidOperationException "WAFInvalidOperationException" The operation failed because there was nothing to do. For example:

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

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

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

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

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

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

  • You specified an invalid parameter name.

  • You specified an invalid value.

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

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

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

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

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

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

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

  • ErrCodeWAFNonexistentContainerException "WAFNonexistentContainerException" 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.

  • ErrCodeWAFNonexistentItemException "WAFNonexistentItemException" The operation failed because the referenced object doesn't exist.

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

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

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

  • ErrCodeWAFLimitsExceededException "WAFLimitsExceededException" The operation exceeds a resource limit, for example, the maximum number of WebACL objects that you can create for an AWS account. For more information, see Limits (https://docs.aws.amazon.com/waf/latest/developerguide/limits.html) in the AWS WAF Developer Guide.

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/UpdateIPSet

Example

WAFRegional UpdateIPSet shared00

To update an IP set

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

{ svc := wafregional.New(session.New()) input := &waf.UpdateIPSetInput{ ChangeToken: aws.String("abcd12f2-46da-4fdb-b8d5-fbd4c466928f"), IPSetId: aws.String("example1ds3t-46da-4fdb-b8d5-abc321j569j5"), Updates: []*waf.IPSetUpdate{ { Action: aws.String("DELETE"), IPSetDescriptor: &waf.IPSetDescriptor{ Type: aws.String("IPV4"), Value: aws.String("192.0.2.44/32"), }, }, }, } result, err := svc.UpdateIPSet(input) if err != nil { if aerr, ok := err.(awserr.Error); ok { switch aerr.Code() { case wafregional.ErrCodeWAFStaleDataException: fmt.Println(wafregional.ErrCodeWAFStaleDataException, aerr.Error()) case wafregional.ErrCodeWAFInternalErrorException: fmt.Println(wafregional.ErrCodeWAFInternalErrorException, aerr.Error()) case wafregional.ErrCodeWAFInvalidAccountException: fmt.Println(wafregional.ErrCodeWAFInvalidAccountException, aerr.Error()) case wafregional.ErrCodeWAFInvalidOperationException: fmt.Println(wafregional.ErrCodeWAFInvalidOperationException, aerr.Error()) case wafregional.ErrCodeWAFInvalidParameterException: fmt.Println(wafregional.ErrCodeWAFInvalidParameterException, aerr.Error()) case wafregional.ErrCodeWAFNonexistentContainerException: fmt.Println(wafregional.ErrCodeWAFNonexistentContainerException, aerr.Error()) case wafregional.ErrCodeWAFNonexistentItemException: fmt.Println(wafregional.ErrCodeWAFNonexistentItemException, aerr.Error()) case wafregional.ErrCodeWAFReferencedItemException: fmt.Println(wafregional.ErrCodeWAFReferencedItemException, aerr.Error()) case wafregional.ErrCodeWAFLimitsExceededException: fmt.Println(wafregional.ErrCodeWAFLimitsExceededException, aerr.Error()) default: fmt.Println(aerr.Error()) } } else { fmt.Println(err.Error()) } return } fmt.Println(result) }

UpdateIPSetRequest

func (c *WAFRegional) UpdateIPSetRequest(input *waf.UpdateIPSetInput) (req *request.Request, output *waf.UpdateIPSetOutput)

UpdateIPSetRequest generates a "aws/request.Request" representing the client's request for the UpdateIPSet operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateIPSet for more information on using the UpdateIPSet API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateIPSetRequest method. req, resp := client.UpdateIPSetRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/UpdateIPSet

UpdateIPSetWithContext

func (c *WAFRegional) UpdateIPSetWithContext(ctx aws.Context, input *waf.UpdateIPSetInput, opts ...request.Option) (*waf.UpdateIPSetOutput, error)

UpdateIPSetWithContext is the same as UpdateIPSet with the addition of the ability to pass a context and additional request options.

See UpdateIPSet for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

UpdateRateBasedRule

func (c *WAFRegional) UpdateRateBasedRule(input *waf.UpdateRateBasedRuleInput) (*waf.UpdateRateBasedRuleOutput, error)

UpdateRateBasedRule API operation for AWS WAF Regional.

Inserts or deletes Predicate objects in a rule and updates the RateLimit in the rule.

Each Predicate object identifies a predicate, such as a ByteMatchSet or an IPSet, that specifies the web requests that you want to block or count. The RateLimit specifies the number of requests every five minutes that triggers the rule.

If you add more than one predicate to a RateBasedRule, a request must match all the predicates and exceed the RateLimit to be counted or blocked. For example, suppose you add the following to a RateBasedRule:

  • An IPSet that matches the IP address 192.0.2.44/32

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

Further, you specify a RateLimit of 15,000.

You then add the RateBasedRule to a WebACL and specify that you want to block 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. Further, requests that match these two conditions much be received at a rate of more than 15,000 every five minutes. If the rate drops below this limit, AWS WAF no longer blocks the requests.

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

  • A ByteMatchSet with FieldToMatch of URI

  • A PositionalConstraint of STARTS_WITH

  • A TargetString of login

Further, you specify a RateLimit of 15,000.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS WAF Regional's API operation UpdateRateBasedRule for usage and error information.

Returned Error Codes:

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

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

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

  • ErrCodeWAFInvalidOperationException "WAFInvalidOperationException" The operation failed because there was nothing to do. For example:

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

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

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

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

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

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

  • You specified an invalid parameter name.

  • You specified an invalid value.

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

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

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

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

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

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

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

  • ErrCodeWAFNonexistentContainerException "WAFNonexistentContainerException" 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.

  • ErrCodeWAFNonexistentItemException "WAFNonexistentItemException" The operation failed because the referenced object doesn't exist.

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

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

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

  • ErrCodeWAFLimitsExceededException "WAFLimitsExceededException" The operation exceeds a resource limit, for example, the maximum number of WebACL objects that you can create for an AWS account. For more information, see Limits (https://docs.aws.amazon.com/waf/latest/developerguide/limits.html) in the AWS WAF Developer Guide.

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/UpdateRateBasedRule

UpdateRateBasedRuleRequest

func (c *WAFRegional) UpdateRateBasedRuleRequest(input *waf.UpdateRateBasedRuleInput) (req *request.Request, output *waf.UpdateRateBasedRuleOutput)

UpdateRateBasedRuleRequest generates a "aws/request.Request" representing the client's request for the UpdateRateBasedRule operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateRateBasedRule for more information on using the UpdateRateBasedRule API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateRateBasedRuleRequest method. req, resp := client.UpdateRateBasedRuleRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/UpdateRateBasedRule

UpdateRateBasedRuleWithContext

func (c *WAFRegional) UpdateRateBasedRuleWithContext(ctx aws.Context, input *waf.UpdateRateBasedRuleInput, opts ...request.Option) (*waf.UpdateRateBasedRuleOutput, error)

UpdateRateBasedRuleWithContext is the same as UpdateRateBasedRule with the addition of the ability to pass a context and additional request options.

See UpdateRateBasedRule for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

UpdateRegexMatchSet

func (c *WAFRegional) UpdateRegexMatchSet(input *waf.UpdateRegexMatchSetInput) (*waf.UpdateRegexMatchSetOutput, error)

UpdateRegexMatchSet API operation for AWS WAF Regional.

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

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

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

  • The identifier of the pattern (a regular expression) that you want AWS WAF to look for. For more information, see RegexPatternSet.

  • 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 create a RegexPatternSet that matches any requests with User-Agent headers that contain the string B[a@]dB[o0]t. You can then configure AWS WAF to reject those requests.

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

Create a RegexMatchSet. For more information, see CreateRegexMatchSet.

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

Submit an UpdateRegexMatchSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the identifier of the RegexPatternSet that contain the regular expression patters 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 (https://docs.aws.amazon.com/waf/latest/developerguide/).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS WAF Regional's API operation UpdateRegexMatchSet for usage and error information.

Returned Error Codes:

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

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

  • ErrCodeWAFDisallowedNameException "WAFDisallowedNameException" The name specified is invalid.

  • ErrCodeWAFLimitsExceededException "WAFLimitsExceededException" The operation exceeds a resource limit, for example, the maximum number of WebACL objects that you can create for an AWS account. For more information, see Limits (https://docs.aws.amazon.com/waf/latest/developerguide/limits.html) in the AWS WAF Developer Guide.

  • ErrCodeWAFNonexistentItemException "WAFNonexistentItemException" The operation failed because the referenced object doesn't exist.

  • ErrCodeWAFNonexistentContainerException "WAFNonexistentContainerException" 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.

  • ErrCodeWAFInvalidOperationException "WAFInvalidOperationException" The operation failed because there was nothing to do. For example:

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

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

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/UpdateRegexMatchSet

UpdateRegexMatchSetRequest

func (c *WAFRegional) UpdateRegexMatchSetRequest(input *waf.UpdateRegexMatchSetInput) (req *request.Request, output *waf.UpdateRegexMatchSetOutput)

UpdateRegexMatchSetRequest generates a "aws/request.Request" representing the client's request for the UpdateRegexMatchSet operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateRegexMatchSet for more information on using the UpdateRegexMatchSet API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateRegexMatchSetRequest method. req, resp := client.UpdateRegexMatchSetRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/UpdateRegexMatchSet

UpdateRegexMatchSetWithContext

func (c *WAFRegional) UpdateRegexMatchSetWithContext(ctx aws.Context, input *waf.UpdateRegexMatchSetInput, opts ...request.Option) (*waf.UpdateRegexMatchSetOutput, error)

UpdateRegexMatchSetWithContext is the same as UpdateRegexMatchSet with the addition of the ability to pass a context and additional request options.

See UpdateRegexMatchSet for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

UpdateRegexPatternSet

func (c *WAFRegional) UpdateRegexPatternSet(input *waf.UpdateRegexPatternSetInput) (*waf.UpdateRegexPatternSetOutput, error)

UpdateRegexPatternSet API operation for AWS WAF Regional.

Inserts or deletes RegexPatternString objects in a RegexPatternSet. For each RegexPatternString object, you specify the following values:

  • Whether to insert or delete the RegexPatternString.

  • The regular expression pattern that you want to insert or delete. For more information, see RegexPatternSet.

For example, you can create a RegexPatternString such as B[a@]dB[o0]t. AWS WAF will match this RegexPatternString to:

  • BadBot

  • BadB0t

  • B@dBot

  • B@dB0t

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

Create a RegexPatternSet. For more information, see CreateRegexPatternSet.

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

Submit an UpdateRegexPatternSet request to specify the regular expression pattern 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 (https://docs.aws.amazon.com/waf/latest/developerguide/).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS WAF Regional's API operation UpdateRegexPatternSet for usage and error information.

Returned Error Codes:

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

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

  • ErrCodeWAFLimitsExceededException "WAFLimitsExceededException" The operation exceeds a resource limit, for example, the maximum number of WebACL objects that you can create for an AWS account. For more information, see Limits (https://docs.aws.amazon.com/waf/latest/developerguide/limits.html) in the AWS WAF Developer Guide.

  • ErrCodeWAFNonexistentItemException "WAFNonexistentItemException" The operation failed because the referenced object doesn't exist.

  • ErrCodeWAFNonexistentContainerException "WAFNonexistentContainerException" 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.

  • ErrCodeWAFInvalidOperationException "WAFInvalidOperationException" The operation failed because there was nothing to do. For example:

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

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

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

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

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

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

  • ErrCodeWAFInvalidRegexPatternException "WAFInvalidRegexPatternException" The regular expression (regex) you specified in RegexPatternString is invalid.

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/UpdateRegexPatternSet

UpdateRegexPatternSetRequest

func (c *WAFRegional) UpdateRegexPatternSetRequest(input *waf.UpdateRegexPatternSetInput) (req *request.Request, output *waf.UpdateRegexPatternSetOutput)

UpdateRegexPatternSetRequest generates a "aws/request.Request" representing the client's request for the UpdateRegexPatternSet operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateRegexPatternSet for more information on using the UpdateRegexPatternSet API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateRegexPatternSetRequest method. req, resp := client.UpdateRegexPatternSetRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/UpdateRegexPatternSet

UpdateRegexPatternSetWithContext

func (c *WAFRegional) UpdateRegexPatternSetWithContext(ctx aws.Context, input *waf.UpdateRegexPatternSetInput, opts ...request.Option) (*waf.UpdateRegexPatternSetOutput, error)

UpdateRegexPatternSetWithContext is the same as UpdateRegexPatternSet with the addition of the ability to pass a context and additional request options.

See UpdateRegexPatternSet for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

UpdateRule

func (c *WAFRegional) UpdateRule(input *waf.UpdateRuleInput) (*waf.UpdateRuleOutput, error)

UpdateRule API operation for AWS WAF Regional.

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 that 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 BadBotand the request must originate from the IP address 192.0.2.44.

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

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

Create the Rule. See CreateRule.

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

Submit an UpdateRule request to add predicates to the Rule.

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 (https://docs.aws.amazon.com/waf/latest/developerguide/).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS WAF Regional's API operation UpdateRule for usage and error information.

Returned Error Codes:

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

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

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

  • ErrCodeWAFInvalidOperationException "WAFInvalidOperationException" The operation failed because there was nothing to do. For example:

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

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

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

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

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

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

  • You specified an invalid parameter name.

  • You specified an invalid value.

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

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

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

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

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

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

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

  • ErrCodeWAFNonexistentContainerException "WAFNonexistentContainerException" 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.

  • ErrCodeWAFNonexistentItemException "WAFNonexistentItemException" The operation failed because the referenced object doesn't exist.

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

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

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

  • ErrCodeWAFLimitsExceededException "WAFLimitsExceededException" The operation exceeds a resource limit, for example, the maximum number of WebACL objects that you can create for an AWS account. For more information, see Limits (https://docs.aws.amazon.com/waf/latest/developerguide/limits.html) in the AWS WAF Developer Guide.

See also, https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/UpdateRule

Example

WAFRegional UpdateRule shared00

To update a rule

The following example deletes a Predicate object in a rule with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.

{ svc := wafregional.New(session.New()) input := &waf.UpdateRuleInput{ ChangeToken: aws.String("abcd12f2-46da-4fdb-b8d5-fbd4c466928f"), RuleId: aws.String("example1ds3t-46da-4fdb-b8d5-abc321j569j5"), Updates: []*waf.RuleUpdate{ { Action: aws.String("DELETE"), Predicate: &waf.Predicate{ DataId: aws.String("MyByteMatchSetID"), Negated: aws.Bool(false), Type: aws.String("ByteMatch"), }, }, }, } result, err := svc.UpdateRule(input) if err != nil { if aerr, ok := err.(awserr.Error); ok { switch aerr.Code() { case wafregional.ErrCodeWAFStaleDataException: fmt.Println(wafregional.ErrCodeWAFStaleDataException, aerr.Error()) case wafregional.ErrCodeWAFInternalErrorException: fmt.Println(wafregional.ErrCodeWAFInternalErrorException, aerr.Error()) case wafregional.ErrCodeWAFInvalidAccountException: fmt.Println(wafregional.ErrCodeWAFInvalidAccountException, aerr.Error()) case wafregional.ErrCodeWAFInvalidOperationException: fmt.Println(wafregional.ErrCodeWAFInvalidOperationException, aerr.Error()) case wafregional.ErrCodeWAFInvalidParameterException: fmt.Println(wafregional.ErrCodeWAFInvalidParameterException, aerr.Error()) case wafregional.ErrCodeWAFNonexistentContainerException: fmt.Println(wafregional.ErrCodeWAFNonexistentContainerException, aerr.Error()) case wafregional.ErrCodeWAFNonexistentItemException: fmt.Println(wafregional.ErrCodeWAFNonexistentItemException, aerr.Error()) case wafregional.ErrCodeWAFReferencedItemException: fmt.Println(wafregional.ErrCodeWAFReferencedItemException, aerr.Error()) case wafregional.ErrCodeWAFLimitsExceededException: fmt.Println(wafregional.ErrCodeWAFLimitsExceededException, aerr.Error()) default: fmt.Println(aerr.Error()) } } else { fmt.Println(err.Error()) } return } fmt.Println(result) }

UpdateRuleGroup

func (c *WAFRegional) UpdateRuleGroup(input *waf.UpdateRuleGroupInput) (*waf.UpdateRuleGroupOutput, error)

UpdateRuleGroup API operation for AWS WAF Regional.

Inserts or deletes ActivatedRule objects in a RuleGroup.

You can only insert REGULAR rules into a rule group.

You can have a maximum of ten rules per rule group.

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

Create and update the Rules that you want to include in the RuleGroup. See CreateRule.

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

Submit an UpdateRuleGroup request to add Rules to the RuleGroup.

Create and update a WebACL that contains the RuleGroup. See CreateWebACL.

If you want to replace one Rule 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 (https://docs.aws.amazon.com/waf/latest/developerguide/).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS WAF Regional's API operation UpdateRuleGroup for usage and error information.

Returned Error Codes:

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

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