❤
npm
Sign UpSign In

@datafire/amazonaws_waf

5.0.0 • Public • Published

@datafire/amazonaws_waf

Client library for AWS WAF

Installation and Usage

npm install --save @datafire/amazonaws_waf
let amazonaws_waf = require('@datafire/amazonaws_waf').create({
  accessKeyId: "",
  secretAccessKey: "",
  region: ""
});

amazonaws_waf.CreateByteMatchSet({
  "Name": "",
  "ChangeToken": ""
}).then(data => {
  console.log(data);
});

Description

This is the AWS WAF API Reference for using AWS WAF with Amazon CloudFront. The AWS WAF actions and data types listed in the reference are available for protecting Amazon CloudFront distributions. You can use these actions and data types via the endpoint waf.amazonaws.com. This guide is for developers who need detailed information about the AWS WAF API actions, data types, and errors. For detailed information about AWS WAF features and an overview of how to use the AWS WAF API, see the AWS WAF Developer Guide.

Actions

CreateByteMatchSet

amazonaws_waf.CreateByteMatchSet({
  "Name": "",
  "ChangeToken": ""
}, context)

Input

Output

CreateGeoMatchSet

amazonaws_waf.CreateGeoMatchSet({
  "Name": "",
  "ChangeToken": ""
}, context)

Input

Output

CreateIPSet

amazonaws_waf.CreateIPSet({
  "Name": "",
  "ChangeToken": ""
}, context)

Input

Output

CreateRateBasedRule

amazonaws_waf.CreateRateBasedRule({
  "Name": "",
  "MetricName": "",
  "RateKey": "",
  "RateLimit": 0,
  "ChangeToken": ""
}, context)

Input

Output

CreateRegexMatchSet

amazonaws_waf.CreateRegexMatchSet({
  "Name": "",
  "ChangeToken": ""
}, context)

Input

Output

CreateRegexPatternSet

amazonaws_waf.CreateRegexPatternSet({
  "Name": "",
  "ChangeToken": ""
}, context)

Input

Output

CreateRule

amazonaws_waf.CreateRule({
  "Name": "",
  "MetricName": "",
  "ChangeToken": ""
}, context)

Input

Output

CreateRuleGroup

amazonaws_waf.CreateRuleGroup({
  "Name": "",
  "MetricName": "",
  "ChangeToken": ""
}, context)

Input

Output

CreateSizeConstraintSet

amazonaws_waf.CreateSizeConstraintSet({
  "Name": "",
  "ChangeToken": ""
}, context)

Input

Output

CreateSqlInjectionMatchSet

amazonaws_waf.CreateSqlInjectionMatchSet({
  "Name": "",
  "ChangeToken": ""
}, context)

Input

Output

CreateWebACL

amazonaws_waf.CreateWebACL({
  "Name": "",
  "MetricName": "",
  "DefaultAction": {
    "Type": ""
  },
  "ChangeToken": ""
}, context)

Input

Output

CreateXssMatchSet

amazonaws_waf.CreateXssMatchSet({
  "Name": "",
  "ChangeToken": ""
}, context)

Input

Output

DeleteByteMatchSet

amazonaws_waf.DeleteByteMatchSet({
  "ByteMatchSetId": "",
  "ChangeToken": ""
}, context)

Input

Output

DeleteGeoMatchSet

amazonaws_waf.DeleteGeoMatchSet({
  "GeoMatchSetId": "",
  "ChangeToken": ""
}, context)

Input

Output

DeleteIPSet

amazonaws_waf.DeleteIPSet({
  "IPSetId": "",
  "ChangeToken": ""
}, context)

Input

Output

DeleteRateBasedRule

amazonaws_waf.DeleteRateBasedRule({
  "RuleId": "",
  "ChangeToken": ""
}, context)

Input

Output

DeleteRegexMatchSet

amazonaws_waf.DeleteRegexMatchSet({
  "RegexMatchSetId": "",
  "ChangeToken": ""
}, context)

Input

Output

DeleteRegexPatternSet

amazonaws_waf.DeleteRegexPatternSet({
  "RegexPatternSetId": "",
  "ChangeToken": ""
}, context)

Input

Output

DeleteRule

amazonaws_waf.DeleteRule({
  "RuleId": "",
  "ChangeToken": ""
}, context)

Input

Output

DeleteRuleGroup

amazonaws_waf.DeleteRuleGroup({
  "RuleGroupId": "",
  "ChangeToken": ""
}, context)

Input

Output

DeleteSizeConstraintSet

amazonaws_waf.DeleteSizeConstraintSet({
  "SizeConstraintSetId": "",
  "ChangeToken": ""
}, context)

Input

Output

DeleteSqlInjectionMatchSet

amazonaws_waf.DeleteSqlInjectionMatchSet({
  "SqlInjectionMatchSetId": "",
  "ChangeToken": ""
}, context)

Input

Output

DeleteWebACL

amazonaws_waf.DeleteWebACL({
  "WebACLId": "",
  "ChangeToken": ""
}, context)

Input

Output

DeleteXssMatchSet

amazonaws_waf.DeleteXssMatchSet({
  "XssMatchSetId": "",
  "ChangeToken": ""
}, context)

Input

Output

GetByteMatchSet

amazonaws_waf.GetByteMatchSet({
  "ByteMatchSetId": ""
}, context)

Input

Output

GetChangeToken

amazonaws_waf.GetChangeToken({}, context)

Input

  • input object

Output

GetChangeTokenStatus

amazonaws_waf.GetChangeTokenStatus({
  "ChangeToken": ""
}, context)

Input

Output

GetGeoMatchSet

amazonaws_waf.GetGeoMatchSet({
  "GeoMatchSetId": ""
}, context)

Input

Output

GetIPSet

amazonaws_waf.GetIPSet({
  "IPSetId": ""
}, context)

Input

Output

GetRateBasedRule

amazonaws_waf.GetRateBasedRule({
  "RuleId": ""
}, context)

Input

Output

GetRateBasedRuleManagedKeys

amazonaws_waf.GetRateBasedRuleManagedKeys({
  "RuleId": ""
}, context)

Input

Output

GetRegexMatchSet

amazonaws_waf.GetRegexMatchSet({
  "RegexMatchSetId": ""
}, context)

Input

  • input object

Output

GetRegexPatternSet

amazonaws_waf.GetRegexPatternSet({
  "RegexPatternSetId": ""
}, context)

Input

  • input object

Output

GetRule

amazonaws_waf.GetRule({
  "RuleId": ""
}, context)

Input

Output

GetRuleGroup

amazonaws_waf.GetRuleGroup({
  "RuleGroupId": ""
}, context)

Input

Output

GetSampledRequests

amazonaws_waf.GetSampledRequests({
  "WebAclId": "",
  "RuleId": "",
  "TimeWindow": {
    "StartTime": "",
    "EndTime": ""
  },
  "MaxItems": 0
}, context)

Input

Output

GetSizeConstraintSet

amazonaws_waf.GetSizeConstraintSet({
  "SizeConstraintSetId": ""
}, context)

Input

  • input object

Output

GetSqlInjectionMatchSet

amazonaws_waf.GetSqlInjectionMatchSet({
  "SqlInjectionMatchSetId": ""
}, context)

Input

  • input object

Output

GetWebACL

amazonaws_waf.GetWebACL({
  "WebACLId": ""
}, context)

Input

Output

GetXssMatchSet

amazonaws_waf.GetXssMatchSet({
  "XssMatchSetId": ""
}, context)

Input

Output

ListActivatedRulesInRuleGroup

amazonaws_waf.ListActivatedRulesInRuleGroup({}, context)

Input

Output

ListByteMatchSets

amazonaws_waf.ListByteMatchSets({}, context)

Input

Output

ListGeoMatchSets

amazonaws_waf.ListGeoMatchSets({}, context)

Input

Output

ListIPSets

amazonaws_waf.ListIPSets({}, context)

Input

Output

ListRateBasedRules

amazonaws_waf.ListRateBasedRules({}, context)

Input

Output

ListRegexMatchSets

amazonaws_waf.ListRegexMatchSets({}, context)

Input

Output

ListRegexPatternSets

amazonaws_waf.ListRegexPatternSets({}, context)

Input

Output

ListRuleGroups

amazonaws_waf.ListRuleGroups({}, context)

Input

Output

ListRules

amazonaws_waf.ListRules({}, context)

Input

Output

ListSizeConstraintSets

amazonaws_waf.ListSizeConstraintSets({}, context)

Input

Output

ListSqlInjectionMatchSets

amazonaws_waf.ListSqlInjectionMatchSets({}, context)

Input

Output

ListSubscribedRuleGroups

amazonaws_waf.ListSubscribedRuleGroups({}, context)

Input

Output

ListWebACLs

amazonaws_waf.ListWebACLs({}, context)

Input

Output

ListXssMatchSets

amazonaws_waf.ListXssMatchSets({}, context)

Input

Output

UpdateByteMatchSet

amazonaws_waf.UpdateByteMatchSet({
  "ByteMatchSetId": "",
  "ChangeToken": "",
  "Updates": []
}, context)

Input

Output

UpdateGeoMatchSet

amazonaws_waf.UpdateGeoMatchSet({
  "GeoMatchSetId": "",
  "ChangeToken": "",
  "Updates": []
}, context)

Input

Output

UpdateIPSet

amazonaws_waf.UpdateIPSet({
  "IPSetId": "",
  "ChangeToken": "",
  "Updates": []
}, context)

Input

Output

UpdateRateBasedRule

amazonaws_waf.UpdateRateBasedRule({
  "RuleId": "",
  "ChangeToken": "",
  "Updates": [],
  "RateLimit": 0
}, context)

Input

Output

UpdateRegexMatchSet

amazonaws_waf.UpdateRegexMatchSet({
  "RegexMatchSetId": "",
  "Updates": [],
  "ChangeToken": ""
}, context)

Input

Output

UpdateRegexPatternSet

amazonaws_waf.UpdateRegexPatternSet({
  "RegexPatternSetId": "",
  "Updates": [],
  "ChangeToken": ""
}, context)

Input

Output

UpdateRule

amazonaws_waf.UpdateRule({
  "RuleId": "",
  "ChangeToken": "",
  "Updates": []
}, context)

Input

Output

UpdateRuleGroup

amazonaws_waf.UpdateRuleGroup({
  "RuleGroupId": "",
  "Updates": [],
  "ChangeToken": ""
}, context)

Input

Output

UpdateSizeConstraintSet

amazonaws_waf.UpdateSizeConstraintSet({
  "SizeConstraintSetId": "",
  "ChangeToken": "",
  "Updates": []
}, context)

Input

Output

UpdateSqlInjectionMatchSet

amazonaws_waf.UpdateSqlInjectionMatchSet({
  "SqlInjectionMatchSetId": "",
  "ChangeToken": "",
  "Updates": []
}, context)

Input

Output

UpdateWebACL

amazonaws_waf.UpdateWebACL({
  "WebACLId": "",
  "ChangeToken": ""
}, context)

Input

Output

UpdateXssMatchSet

amazonaws_waf.UpdateXssMatchSet({
  "XssMatchSetId": "",
  "ChangeToken": "",
  "Updates": []
}, context)

Input

Output

Definitions

Action

  • Action string

ActivatedRule

  • ActivatedRule object:

    The ActivatedRule object in an UpdateWebACL request specifies a Rule that you want to insert or delete, the priority of the Rule in the WebACL, and the action that you want AWS WAF to take when a web request matches the Rule (ALLOW, BLOCK, or COUNT).

    To specify whether to insert or delete a Rule, use the Action parameter in the WebACLUpdate data type.

ActivatedRules

ByteMatchSet

  • ByteMatchSet object:

    In a GetByteMatchSet request, ByteMatchSet is a complex type that contains the ByteMatchSetId and Name of a ByteMatchSet, and the values that you specified when you updated the ByteMatchSet.

    A complex type that contains ByteMatchTuple objects, which specify the parts of web requests that you want AWS WAF to inspect and the values that you want AWS WAF to search for. If a ByteMatchSet contains more than one ByteMatchTuple object, a request needs to match the settings in only one ByteMatchTuple to be considered a match.

ByteMatchSetSummaries

ByteMatchSetSummary

  • ByteMatchSetSummary object: Returned by ListByteMatchSets. Each ByteMatchSetSummary object includes the Name and ByteMatchSetId for one ByteMatchSet.

ByteMatchSetUpdate

  • ByteMatchSetUpdate object: In an UpdateByteMatchSet request, ByteMatchSetUpdate specifies whether to insert or delete a ByteMatchTuple and includes the settings for the ByteMatchTuple.

ByteMatchSetUpdates

ByteMatchTargetString

  • ByteMatchTargetString string

ByteMatchTuple

  • ByteMatchTuple object: The bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to search for in web requests, the location in requests that you want AWS WAF to search, and other settings.

ByteMatchTuples

ChangeAction

  • ChangeAction string (values: INSERT, DELETE)

ChangeToken

  • ChangeToken string

ChangeTokenStatus

  • ChangeTokenStatus string (values: PROVISIONED, PENDING, INSYNC)

ComparisonOperator

  • ComparisonOperator string (values: EQ, NE, LE, LT, GE, GT)

Country

  • Country string

CreateByteMatchSetRequest

CreateByteMatchSetResponse

CreateGeoMatchSetRequest

CreateGeoMatchSetResponse

CreateIPSetRequest

CreateIPSetResponse

CreateRateBasedRuleRequest

CreateRateBasedRuleResponse

CreateRegexMatchSetRequest

CreateRegexMatchSetResponse

CreateRegexPatternSetRequest

CreateRegexPatternSetResponse

CreateRuleGroupRequest

CreateRuleGroupResponse

CreateRuleRequest

CreateRuleResponse

CreateSizeConstraintSetRequest

CreateSizeConstraintSetResponse

CreateSqlInjectionMatchSetRequest

  • CreateSqlInjectionMatchSetRequest object: A request to create a SqlInjectionMatchSet.

CreateSqlInjectionMatchSetResponse

  • CreateSqlInjectionMatchSetResponse object: The response to a CreateSqlInjectionMatchSet request.

CreateWebACLRequest

CreateWebACLResponse

CreateXssMatchSetRequest

  • CreateXssMatchSetRequest object: A request to create an XssMatchSet.

CreateXssMatchSetResponse

  • CreateXssMatchSetResponse object: The response to a CreateXssMatchSet request.

DeleteByteMatchSetRequest

DeleteByteMatchSetResponse

  • DeleteByteMatchSetResponse object

DeleteGeoMatchSetRequest

DeleteGeoMatchSetResponse

  • DeleteGeoMatchSetResponse object

DeleteIPSetRequest

DeleteIPSetResponse

DeleteRateBasedRuleRequest

DeleteRateBasedRuleResponse

  • DeleteRateBasedRuleResponse object

DeleteRegexMatchSetRequest

DeleteRegexMatchSetResponse

  • DeleteRegexMatchSetResponse object

DeleteRegexPatternSetRequest

  • DeleteRegexPatternSetRequest object

DeleteRegexPatternSetResponse

  • DeleteRegexPatternSetResponse object

DeleteRuleGroupRequest

DeleteRuleGroupResponse

  • DeleteRuleGroupResponse object

DeleteRuleRequest

DeleteRuleResponse

DeleteSizeConstraintSetRequest

  • DeleteSizeConstraintSetRequest object

DeleteSizeConstraintSetResponse

  • DeleteSizeConstraintSetResponse object

DeleteSqlInjectionMatchSetRequest

  • DeleteSqlInjectionMatchSetRequest object: A request to delete a SqlInjectionMatchSet from AWS WAF.

DeleteSqlInjectionMatchSetResponse

  • DeleteSqlInjectionMatchSetResponse object: The response to a request to delete a SqlInjectionMatchSet from AWS WAF.

DeleteWebACLRequest

DeleteWebACLResponse

DeleteXssMatchSetRequest

  • DeleteXssMatchSetRequest object: A request to delete an XssMatchSet from AWS WAF.

DeleteXssMatchSetResponse

  • DeleteXssMatchSetResponse object: The response to a request to delete an XssMatchSet from AWS WAF.

FieldToMatch

GeoMatchConstraint

GeoMatchConstraintType

  • GeoMatchConstraintType string (values: Country)

GeoMatchConstraintValue

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

GeoMatchConstraints

GeoMatchSet

GeoMatchSetSummaries

GeoMatchSetSummary

  • GeoMatchSetSummary object: Contains the identifier and the name of the GeoMatchSet.

GeoMatchSetUpdate

  • GeoMatchSetUpdate object: Specifies the type of update to perform to an GeoMatchSet with UpdateGeoMatchSet.

GeoMatchSetUpdates

GetByteMatchSetRequest

  • GetByteMatchSetRequest object

GetByteMatchSetResponse

GetChangeTokenRequest

  • GetChangeTokenRequest object

GetChangeTokenResponse

  • GetChangeTokenResponse object

GetChangeTokenStatusRequest

  • GetChangeTokenStatusRequest object

GetChangeTokenStatusResponse

GetGeoMatchSetRequest

  • GetGeoMatchSetRequest object

GetGeoMatchSetResponse

  • GetGeoMatchSetResponse object

GetIPSetRequest

  • GetIPSetRequest object

GetIPSetResponse

  • GetIPSetResponse object

GetRateBasedRuleManagedKeysRequest

GetRateBasedRuleManagedKeysResponse

GetRateBasedRuleRequest

  • GetRateBasedRuleRequest object

GetRateBasedRuleResponse

GetRegexMatchSetRequest

  • GetRegexMatchSetRequest object

GetRegexMatchSetResponse

GetRegexPatternSetRequest

  • GetRegexPatternSetRequest object

GetRegexPatternSetResponse

GetRuleGroupRequest

  • GetRuleGroupRequest object

GetRuleGroupResponse

  • GetRuleGroupResponse object

GetRuleRequest

  • GetRuleRequest object

GetRuleResponse

  • GetRuleResponse object

GetSampledRequestsMaxItems

  • GetSampledRequestsMaxItems integer

GetSampledRequestsRequest

GetSampledRequestsResponse

GetSizeConstraintSetRequest

  • GetSizeConstraintSetRequest object

GetSizeConstraintSetResponse

GetSqlInjectionMatchSetRequest

  • GetSqlInjectionMatchSetRequest object: A request to get a SqlInjectionMatchSet.

GetSqlInjectionMatchSetResponse

  • GetSqlInjectionMatchSetResponse object: The response to a GetSqlInjectionMatchSet request.

GetWebACLRequest

  • GetWebACLRequest object

GetWebACLResponse

  • GetWebACLResponse object

GetXssMatchSetRequest

  • GetXssMatchSetRequest object: A request to get an XssMatchSet.

GetXssMatchSetResponse

  • GetXssMatchSetResponse object: The response to a GetXssMatchSet request.

HTTPHeader

  • HTTPHeader object: The response from a GetSampledRequests request includes an HTTPHeader complex type that appears as Headers in the response syntax. HTTPHeader contains the names and values of all of the headers that appear in one of the web requests that were returned by GetSampledRequests.

HTTPHeaders

HTTPMethod

  • HTTPMethod string

HTTPRequest

  • HTTPRequest object: The response from a GetSampledRequests request includes an HTTPRequest complex type that appears as Request in the response syntax. HTTPRequest contains information about one of the web requests that were returned by GetSampledRequests.

HTTPVersion

  • HTTPVersion string

HeaderName

  • HeaderName string

HeaderValue

  • HeaderValue string

IPSet

  • IPSet object:

    Contains one or more IP addresses or blocks of IP addresses specified in Classless Inter-Domain Routing (CIDR) notation. AWS WAF supports /8, /16, /24, and /32 IP address ranges for IPv4, and /24, /32, /48, /56, /64 and /128 for IPv6.

    To specify an individual IP address, you specify the four-part IP address followed by a /32, for example, 192.0.2.0/31. To block a range of IP addresses, you can specify a /128, /64, /56, /48, /32, /24, /16, or /8 CIDR. For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.

IPSetDescriptor

  • IPSetDescriptor object: Specifies the IP address type (IPV4 or IPV6) and the IP address range (in CIDR format) that web requests originate from.

IPSetDescriptorType

  • IPSetDescriptorType string (values: IPV4, IPV6)

IPSetDescriptorValue

  • IPSetDescriptorValue string

IPSetDescriptors

IPSetSummaries

IPSetSummary

  • IPSetSummary object: Contains the identifier and the name of the IPSet.

IPSetUpdate

  • IPSetUpdate object: Specifies the type of update to perform to an IPSet with UpdateIPSet.

IPSetUpdates

IPString

  • IPString string

ListActivatedRulesInRuleGroupRequest

ListActivatedRulesInRuleGroupResponse

ListByteMatchSetsRequest

ListByteMatchSetsResponse

ListGeoMatchSetsRequest

ListGeoMatchSetsResponse

ListIPSetsRequest

ListIPSetsResponse

ListRateBasedRulesRequest

ListRateBasedRulesResponse

ListRegexMatchSetsRequest

ListRegexMatchSetsResponse

ListRegexPatternSetsRequest

ListRegexPatternSetsResponse

ListRuleGroupsRequest

ListRuleGroupsResponse

ListRulesRequest

ListRulesResponse

ListSizeConstraintSetsRequest

ListSizeConstraintSetsResponse

ListSqlInjectionMatchSetsRequest

  • ListSqlInjectionMatchSetsRequest object: A request to list the SqlInjectionMatchSet objects created by the current AWS account.

ListSqlInjectionMatchSetsResponse

ListSubscribedRuleGroupsRequest

ListSubscribedRuleGroupsResponse

ListWebACLsRequest

ListWebACLsResponse

ListXssMatchSetsRequest

  • ListXssMatchSetsRequest object: A request to list the XssMatchSet objects created by the current AWS account.

ListXssMatchSetsResponse

ManagedKey

  • ManagedKey string

ManagedKeys

MatchFieldData

  • MatchFieldData string

MatchFieldType

  • MatchFieldType string (values: URI, QUERY_STRING, HEADER, METHOD, BODY)

MetricName

  • MetricName string

Negated

  • Negated boolean

NextMarker

  • NextMarker string

PaginationLimit

  • PaginationLimit integer

ParameterExceptionField

  • ParameterExceptionField string (values: CHANGE_ACTION, WAF_ACTION, WAF_OVERRIDE_ACTION, PREDICATE_TYPE, IPSET_TYPE, BYTE_MATCH_FIELD_TYPE, SQL_INJECTION_MATCH_FIELD_TYPE, BYTE_MATCH_TEXT_TRANSFORMATION, BYTE_MATCH_POSITIONAL_CONSTRAINT, SIZE_CONSTRAINT_COMPARISON_OPERATOR, GEO_MATCH_LOCATION_TYPE, GEO_MATCH_LOCATION_VALUE, RATE_KEY, RULE_TYPE, NEXT_MARKER)

ParameterExceptionParameter

  • ParameterExceptionParameter string

ParameterExceptionReason

  • ParameterExceptionReason string (values: INVALID_OPTION, ILLEGAL_COMBINATION)

PopulationSize

  • PopulationSize integer

PositionalConstraint

  • PositionalConstraint string (values: EXACTLY, STARTS_WITH, ENDS_WITH, CONTAINS, CONTAINS_WORD)

Predicate

  • Predicate object: Specifies the ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet, GeoMatchSet, and SizeConstraintSet objects that you want to add to a Rule and, for each object, indicates whether you want to negate the settings, for example, requests that do NOT originate from the IP address 192.0.2.44.

PredicateType

  • PredicateType string (values: IPMatch, ByteMatch, SqlInjectionMatch, GeoMatch, SizeConstraint, XssMatch, RegexMatch)

Predicates

RateBasedRule

  • RateBasedRule object:

    A RateBasedRule is identical to a regular Rule, with one addition: a RateBasedRule counts the number of requests that arrive from a specified IP address every five minutes. For example, based on recent requests that you've seen from an attacker, you might create a RateBasedRule that includes the following conditions:

    • The requests come from 192.0.2.44.

    • They contain the value BadBot in the User-Agent header.

    In the rule, you also define the rate limit as 15,000.

    Requests that meet both of these conditions and exceed 15,000 requests every five minutes trigger the rule's action (block or count), which is defined in the web ACL.

RateKey

  • RateKey string (values: IP)

RateLimit

  • RateLimit integer

RegexMatchSet

  • RegexMatchSet object:

    In a GetRegexMatchSet request, RegexMatchSet is a complex type that contains the RegexMatchSetId and Name of a RegexMatchSet, and the values that you specified when you updated the RegexMatchSet.

    The values are contained in a RegexMatchTuple object, which specify the parts of web requests that you want AWS WAF to inspect and the values that you want AWS WAF to search for. If a RegexMatchSet contains more than one RegexMatchTuple object, a request needs to match the settings in only one ByteMatchTuple to be considered a match.

RegexMatchSetSummaries

RegexMatchSetSummary

  • RegexMatchSetSummary object: Returned by ListRegexMatchSets. Each RegexMatchSetSummary object includes the Name and RegexMatchSetId for one RegexMatchSet.

RegexMatchSetUpdate

  • RegexMatchSetUpdate object: In an UpdateRegexMatchSet request, RegexMatchSetUpdate specifies whether to insert or delete a RegexMatchTuple and includes the settings for the RegexMatchTuple.

RegexMatchSetUpdates

RegexMatchTuple

  • RegexMatchTuple object:

    The regular expression pattern that you want AWS WAF to search for in web requests, the location in requests that you want AWS WAF to search, and other settings. Each RegexMatchTuple object contains:

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

RegexMatchTuples

RegexPatternSet

  • RegexPatternSet object: The RegexPatternSet specifies 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.

RegexPatternSetSummaries

RegexPatternSetSummary

  • RegexPatternSetSummary object: Returned by ListRegexPatternSets. Each RegexPatternSetSummary object includes the Name and RegexPatternSetId for one RegexPatternSet.

RegexPatternSetUpdate

  • RegexPatternSetUpdate object: In an UpdateRegexPatternSet request, RegexPatternSetUpdate specifies whether to insert or delete a RegexPatternString and includes the settings for the RegexPatternString.

RegexPatternSetUpdates

RegexPatternString

  • RegexPatternString string

RegexPatternStrings

ResourceId

  • ResourceId string

ResourceName

  • ResourceName string

Rule

  • Rule object:

    A combination of ByteMatchSet, IPSet, and/or SqlInjectionMatchSet objects that identify the web requests that you want to allow, block, or count. For example, you might create a Rule that includes the following predicates:

    • An IPSet that causes AWS WAF to search for web requests that originate from the IP address 192.0.2.44

    • A ByteMatchSet that causes AWS WAF to search for web requests for which the value of the User-Agent header is BadBot.

    To match the settings in this Rule, a request must originate from 192.0.2.44 AND include a User-Agent header for which the value is BadBot.

RuleGroup

  • RuleGroup object:

    A collection of predefined rules that you can add to a web ACL.

    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.

RuleGroupSummaries

RuleGroupSummary

  • RuleGroupSummary object: Contains the identifier and the friendly name or description of the RuleGroup.

RuleGroupUpdate

  • RuleGroupUpdate object: Specifies an ActivatedRule and indicates whether you want to add it to a RuleGroup or delete it from a RuleGroup.

RuleGroupUpdates

RulePriority

  • RulePriority integer

RuleSummaries

RuleSummary

  • RuleSummary object: Contains the identifier and the friendly name or description of the Rule.

RuleUpdate

  • RuleUpdate object: Specifies a Predicate (such as an IPSet) and indicates whether you want to add it to a Rule or delete it from a Rule.

RuleUpdates

SampleWeight

  • SampleWeight integer

SampledHTTPRequest

  • SampledHTTPRequest object: The response from a GetSampledRequests request includes a SampledHTTPRequests complex type that appears as SampledRequests in the response syntax. SampledHTTPRequests contains one SampledHTTPRequest object for each web request that is returned by GetSampledRequests.

SampledHTTPRequests

Size

  • Size integer

SizeConstraint

  • SizeConstraint object: Specifies a constraint on the size of a part of the web request. AWS WAF uses the Size, ComparisonOperator, and FieldToMatch to build an expression in the form of "Size ComparisonOperator size in bytes of FieldToMatch". If that expression is true, the SizeConstraint is considered to match.

SizeConstraintSet

  • SizeConstraintSet object: A complex type that contains SizeConstraint objects, which specify the parts of web requests that you want AWS WAF to inspect the size of. If a SizeConstraintSet contains more than one SizeConstraint object, a request only needs to match one constraint to be considered a match.

SizeConstraintSetSummaries

SizeConstraintSetSummary

  • SizeConstraintSetSummary object: The Id and Name of a SizeConstraintSet.

SizeConstraintSetUpdate

  • SizeConstraintSetUpdate object: Specifies the part of a web request that you want to inspect the size of and indicates whether you want to add the specification to a SizeConstraintSet or delete it from a SizeConstraintSet.

SizeConstraintSetUpdates

SizeConstraints

SqlInjectionMatchSet

  • SqlInjectionMatchSet object: A complex type that contains SqlInjectionMatchTuple objects, which specify the parts of web requests that you want AWS WAF to inspect for snippets of malicious SQL code and, if you want AWS WAF to inspect a header, the name of the header. If a SqlInjectionMatchSet contains more than one SqlInjectionMatchTuple object, a request needs to include snippets of SQL code in only one of the specified parts of the request to be considered a match.

SqlInjectionMatchSetSummaries

SqlInjectionMatchSetSummary

  • SqlInjectionMatchSetSummary object: The Id and Name of a SqlInjectionMatchSet.

SqlInjectionMatchSetUpdate

  • SqlInjectionMatchSetUpdate object: Specifies the part of a web request that you want to inspect for snippets of malicious SQL code and indicates whether you want to add the specification to a SqlInjectionMatchSet or delete it from a SqlInjectionMatchSet.

SqlInjectionMatchSetUpdates

SqlInjectionMatchTuple

  • SqlInjectionMatchTuple object: Specifies the part of a web request that you want AWS WAF to inspect for snippets of malicious SQL code and, if you want AWS WAF to inspect a header, the name of the header.

SqlInjectionMatchTuples

SubscribedRuleGroupSummaries

SubscribedRuleGroupSummary

  • SubscribedRuleGroupSummary object: A summary of the rule groups you are subscribed to.

TextTransformation

  • TextTransformation string (values: NONE, COMPRESS_WHITE_SPACE, HTML_ENTITY_DECODE, LOWERCASE, CMD_LINE, URL_DECODE)

TimeWindow

  • TimeWindow object:

    In a GetSampledRequests request, the StartTime and EndTime objects specify the time range for which you want AWS WAF to return a sample of web requests.

    In a GetSampledRequests response, the StartTime and EndTime objects specify the time range for which AWS WAF actually returned a sample of web requests. AWS WAF gets the specified number of requests from among the first 5,000 requests that your AWS resource receives during the specified time period. If your resource receives more than 5,000 requests during that period, AWS WAF stops sampling after the 5,000th request. In that case, EndTime is the time that AWS WAF received the 5,000th request.

Timestamp

  • Timestamp string

URIString

  • URIString string

UpdateByteMatchSetRequest

UpdateByteMatchSetResponse

  • UpdateByteMatchSetResponse object

UpdateGeoMatchSetRequest

UpdateGeoMatchSetResponse

  • UpdateGeoMatchSetResponse object

UpdateIPSetRequest

UpdateIPSetResponse

UpdateRateBasedRuleRequest

UpdateRateBasedRuleResponse

  • UpdateRateBasedRuleResponse object

UpdateRegexMatchSetRequest

UpdateRegexMatchSetResponse

  • UpdateRegexMatchSetResponse object

UpdateRegexPatternSetRequest

UpdateRegexPatternSetResponse

  • UpdateRegexPatternSetResponse object

UpdateRuleGroupRequest

UpdateRuleGroupResponse

  • UpdateRuleGroupResponse object

UpdateRuleRequest

UpdateRuleResponse

UpdateSizeConstraintSetRequest

UpdateSizeConstraintSetResponse

  • UpdateSizeConstraintSetResponse object

UpdateSqlInjectionMatchSetRequest

UpdateSqlInjectionMatchSetResponse

  • UpdateSqlInjectionMatchSetResponse object: The response to an UpdateSqlInjectionMatchSets request.

UpdateWebACLRequest

UpdateWebACLResponse

UpdateXssMatchSetRequest

UpdateXssMatchSetResponse

  • UpdateXssMatchSetResponse object: The response to an UpdateXssMatchSets request.

WAFDisallowedNameException

  • WAFDisallowedNameException object: The name specified is invalid.

WAFInternalErrorException

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

WAFInvalidAccountException

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

WAFInvalidOperationException

  • WAFInvalidOperationException object:

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

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

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

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

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

    • You tried to add an IP address to an IPSet, but the IP address already exists in the specified IPSet.

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

WAFInvalidParameterException

  • WAFInvalidParameterException object:

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

    • You specified an invalid parameter name.

    • You specified an invalid value.

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

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

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

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

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

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

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

WAFInvalidRegexPatternException

  • WAFInvalidRegexPatternException object: The regular expression (regex) you specified in RegexPatternString is invalid.

WAFLimitsExceededException

  • WAFLimitsExceededException object: The operation exceeds a resource limit, for example, the maximum number of WebACL objects that you can create for an AWS account. For more information, see Limits in the AWS WAF Developer Guide.

WAFNonEmptyEntityException

  • WAFNonEmptyEntityException object:

    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.

WAFNonexistentContainerException

  • WAFNonexistentContainerException object:

    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.

WAFNonexistentItemException

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

WAFReferencedItemException

  • WAFReferencedItemException object:

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

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

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

WAFStaleDataException

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

WAFSubscriptionNotFoundException

  • WAFSubscriptionNotFoundException object: The specified subscription does not exist.

WafAction

  • WafAction object: For the action that is associated with a rule in a WebACL, specifies the action that you want AWS WAF to perform when a web request matches all of the conditions in a rule. For the default action in a WebACL, specifies the action that you want AWS WAF to take when a web request doesn't match all of the conditions in any of the rules in a WebACL.

WafActionType

  • WafActionType string (values: BLOCK, ALLOW, COUNT)

WafOverrideAction

  • WafOverrideAction object: The action to take if any rule within the RuleGroup matches a request.

WafOverrideActionType

  • WafOverrideActionType string (values: NONE, COUNT)

WafRuleType

  • WafRuleType string (values: REGULAR, RATE_BASED, GROUP)

WebACL

  • WebACL object: Contains the Rules that identify the requests that you want to allow, block, or count. In a WebACL, you also specify a default action (ALLOW or BLOCK), and the action for each Rule that you add to a WebACL, for example, block requests from specified IP addresses or block requests from specified referrers. You also associate the WebACL with a CloudFront distribution to identify the requests that you want AWS WAF to filter. If you add more than one Rule to a WebACL, a request needs to match only one of the specifications to be allowed, blocked, or counted. For more information, see UpdateWebACL.

WebACLSummaries

WebACLSummary

  • WebACLSummary object: Contains the identifier and the name or description of the WebACL.

WebACLUpdate

  • WebACLUpdate object: Specifies whether to insert a Rule into or delete a Rule from a WebACL.

WebACLUpdates

XssMatchSet

  • XssMatchSet object: A complex type that contains XssMatchTuple objects, which specify the parts of web requests that you want AWS WAF to inspect for cross-site scripting attacks and, if you want AWS WAF to inspect a header, the name of the header. If a XssMatchSet contains more than one XssMatchTuple object, a request needs to include cross-site scripting attacks in only one of the specified parts of the request to be considered a match.

XssMatchSetSummaries

XssMatchSetSummary

  • XssMatchSetSummary object: The Id and Name of an XssMatchSet.

XssMatchSetUpdate

  • XssMatchSetUpdate object: Specifies the part of a web request that you want to inspect for cross-site scripting attacks and indicates whether you want to add the specification to an XssMatchSet or delete it from an XssMatchSet.

XssMatchSetUpdates

XssMatchTuple

  • XssMatchTuple object: Specifies the part of a web request that you want AWS WAF to inspect for cross-site scripting attacks and, if you want AWS WAF to inspect a header, the name of the header.

XssMatchTuples

errorMessage

  • errorMessage string

Readme

Keywords

none

Package Sidebar

Install

npm i @datafire/amazonaws_waf

Repository

github.com/DataFire/integrations

Homepage

github.com/DataFire/integrations#readme

Weekly Downloads

1

Version

5.0.0

License

MIT

Unpacked Size

512 kB

Total Files

5

Last publish

Collaborators

  • datafire
Try on RunKit
Report malware