amazonaws.com – wafv2

Tools (53)

Extracted live via the executor SDK.

• xAmzTargetAwswaf20190729AssociateWebAcl.associateWebAcl

  Associates a web ACL with a regional application resource, to protect the resource. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, or an App Runner service.

  For Amazon CloudFront, don't use this call. Instead, use your CloudFront distribution configuration. To associate a web ACL, in the CloudFront call UpdateDistribution, set the web ACL ID to the Amazon Resource Name (ARN) of the web ACL. For information, see UpdateDistribution in the Amazon CloudFront Developer Guide.

  When you make changes to web ACLs or web ACL components, like rules and rule groups, WAF propagates the changes everywhere that the web ACL and its components are stored and used. Your changes are applied within seconds, but there might be a brief period of inconsistency when the changes have arrived in some places and not in others. So, for example, if you change a rule action setting, the action might be the old action in one area and the new action in another area. Or if you add an IP address to an IP set used in a blocking rule, the new address might briefly be blocked in one area while still allowed in another. This temporary inconsistency can occur when you first associate a web ACL with an Amazon Web Services resource and when you change a web ACL that is already associated with a resource. Generally, any inconsistencies of this type last only a few seconds.

• xAmzTargetAwswaf20190729CheckCapacity.checkCapacity

  Returns the web ACL capacity unit (WCU) requirements for a specified scope and set of rules. You can use this to check the capacity requirements for the rules you want to use in a RuleGroup [blocked] or WebACL [blocked].

  WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. For more information, see WAF web ACL capacity units (WCU) in the WAF Developer Guide.

• xAmzTargetAwswaf20190729CreateApiKey.createApiKey

  Creates an API key for use in the integration of the CAPTCHA API in your JavaScript client applications. The integration lets you customize the placement and characteristics of the CAPTCHA puzzle for your end users. For more information about the CAPTCHA JavaScript integration, see WAF client application integration in the WAF Developer Guide.

  The CAPTCHA API requires a key that authorizes CAPTCHA use from the client application domain. You can use a single key for up to 5 domains. After you generate a key, you can copy it for use in your JavaScript integration.

• xAmzTargetAwswaf20190729CreateIpSet.createIpSet

  Creates an IPSet [blocked], which you use to identify web requests that originate from specific IP addresses or ranges of IP addresses. For example, if you're receiving a lot of requests from a ranges of IP addresses, you can configure WAF to block them using an IPSet that lists those IP addresses.

• xAmzTargetAwswaf20190729CreateRegexPatternSet.createRegexPatternSet

  Creates a RegexPatternSet [blocked], which you reference in a RegexPatternSetReferenceStatement [blocked], to have WAF inspect a web request component for the specified patterns.

• xAmzTargetAwswaf20190729CreateRuleGroup.createRuleGroup

  Creates a RuleGroup [blocked] per the specifications provided.

  A rule group defines a collection of rules to inspect and control web requests that you can use in a WebACL [blocked]. When you create a rule group, you define an immutable capacity limit. If you update a rule group, you must stay within the capacity. This allows others to reuse the rule group with confidence in its capacity requirements.

• xAmzTargetAwswaf20190729CreateWebAcl.createWebAcl

  Creates a WebACL [blocked] per the specifications provided.

  A web ACL defines a collection of rules to use to inspect and control web requests. Each rule has an action defined (allow, block, or count) for requests that match the statement of the rule. In the web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a web ACL can be a combination of the types Rule [blocked], RuleGroup [blocked], and managed rule group. You can associate a web ACL with one or more Amazon Web Services resources to protect. The resources can be an Amazon CloudFront distribution, an Amazon API Gateway REST API, an Application Load Balancer, an AppSync GraphQL API, an Amazon Cognito user pool, or an App Runner service.

• xAmzTargetAwswaf20190729DeleteFirewallManagerRuleGroups.deleteFirewallManagerRuleGroups

  Deletes all rule groups that are managed by Firewall Manager for the specified web ACL.

  You can only use this if ManagedByFirewallManager is false in the specified WebACL [blocked].

• xAmzTargetAwswaf20190729DeleteIpSet.deleteIpSet

  Deletes the specified IPSet [blocked].

• xAmzTargetAwswaf20190729DeleteLoggingConfiguration.deleteLoggingConfiguration

  Deletes the LoggingConfiguration [blocked] from the specified web ACL.

• xAmzTargetAwswaf20190729DeletePermissionPolicy.deletePermissionPolicy

  Permanently deletes an IAM policy from the specified rule group.

  You must be the owner of the rule group to perform this operation.

• xAmzTargetAwswaf20190729DeleteRegexPatternSet.deleteRegexPatternSet

  Deletes the specified RegexPatternSet [blocked].

• xAmzTargetAwswaf20190729DeleteRuleGroup.deleteRuleGroup

  Deletes the specified RuleGroup [blocked].

• xAmzTargetAwswaf20190729DeleteWebAcl.deleteWebAcl

  Deletes the specified WebACL [blocked].

  You can only use this if ManagedByFirewallManager is false in the specified WebACL [blocked].

  Before deleting any web ACL, first disassociate it from all resources.

  • To retrieve a list of the resources that are associated with a web ACL, use the following calls:

    • For regional resources, call ListResourcesForWebACL [blocked].

    • For Amazon CloudFront distributions, use the CloudFront call ListDistributionsByWebACLId. For information, see ListDistributionsByWebACLId in the Amazon CloudFront API Reference.

  • To disassociate a resource from a web ACL, use the following calls:

    • For regional resources, call DisassociateWebACL [blocked].

    • For Amazon CloudFront distributions, provide an empty web ACL ID in the CloudFront call UpdateDistribution. For information, see UpdateDistribution in the Amazon CloudFront API Reference.

• xAmzTargetAwswaf20190729DescribeManagedRuleGroup.describeManagedRuleGroup

  Provides high-level information for a managed rule group, including descriptions of the rules.

• xAmzTargetAwswaf20190729DisassociateWebAcl.disassociateWebAcl

  Disassociates the specified regional application resource from any existing web ACL association. A resource can have at most one web ACL association. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, or an App Runner service.

  For Amazon CloudFront, don't use this call. Instead, use your CloudFront distribution configuration. To disassociate a web ACL, provide an empty web ACL ID in the CloudFront call UpdateDistribution. For information, see UpdateDistribution in the Amazon CloudFront API Reference.

• xAmzTargetAwswaf20190729GenerateMobileSdkReleaseUrl.generateMobileSdkReleaseUrl

  Generates a presigned download URL for the specified release of the mobile SDK.

  The mobile SDK is not generally available. Customers who have access to the mobile SDK can use it to establish and manage WAF tokens for use in HTTP(S) requests from a mobile device to WAF. For more information, see WAF client application integration in the WAF Developer Guide.

• xAmzTargetAwswaf20190729GetDecryptedApiKey.getDecryptedApiKey

  Returns your API key in decrypted form. Use this to check the token domains that you have defined for the key.

• xAmzTargetAwswaf20190729GetIpSet.getIpSet

  Retrieves the specified IPSet [blocked].

• xAmzTargetAwswaf20190729GetLoggingConfiguration.getLoggingConfiguration

  Returns the LoggingConfiguration [blocked] for the specified web ACL.

• xAmzTargetAwswaf20190729GetManagedRuleSet.getManagedRuleSet

  Retrieves the specified managed rule set.

  This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.

  Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate.

• xAmzTargetAwswaf20190729GetMobileSdkRelease.getMobileSdkRelease

  Retrieves information for the specified mobile SDK release, including release notes and tags.

  The mobile SDK is not generally available. Customers who have access to the mobile SDK can use it to establish and manage WAF tokens for use in HTTP(S) requests from a mobile device to WAF. For more information, see WAF client application integration in the WAF Developer Guide.

• xAmzTargetAwswaf20190729GetPermissionPolicy.getPermissionPolicy

  Returns the IAM policy that is attached to the specified rule group.

  You must be the owner of the rule group to perform this operation.

• xAmzTargetAwswaf20190729GetRateBasedStatementManagedKeys.getRateBasedStatementManagedKeys

  Retrieves the keys that are currently blocked by a rate-based rule instance. The maximum number of managed keys that can be blocked for a single rate-based rule instance is 10,000. If more than 10,000 addresses exceed the rate limit, those with the highest rates are blocked.

  For a rate-based rule that you've defined inside a rule group, provide the name of the rule group reference statement in your request, in addition to the rate-based rule name and the web ACL name.

  WAF monitors web requests and manages keys independently for each unique combination of web ACL, optional rule group, and rate-based rule. For example, if you define a rate-based rule inside a rule group, and then use the rule group in a web ACL, WAF monitors web requests and manages keys for that web ACL, rule group reference statement, and rate-based rule instance. If you use the same rule group in a second web ACL, WAF monitors web requests and manages keys for this second usage completely independent of your first.

• xAmzTargetAwswaf20190729GetRegexPatternSet.getRegexPatternSet

  Retrieves the specified RegexPatternSet [blocked].

• xAmzTargetAwswaf20190729GetRuleGroup.getRuleGroup

  Retrieves the specified RuleGroup [blocked].

• xAmzTargetAwswaf20190729GetSampledRequests.getSampledRequests

  Gets detailed information about a specified number of requests--a sample--that WAF randomly selects from among the first 5,000 requests that your Amazon Web Services 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 WAF selected the requests in the sample.

• xAmzTargetAwswaf20190729GetWebAcl.getWebAcl

  Retrieves the specified WebACL [blocked].

• xAmzTargetAwswaf20190729GetWebAclForResource.getWebAclForResource

  Retrieves the WebACL [blocked] for the specified resource.

• xAmzTargetAwswaf20190729ListApiKeys.listApiKeys

  Retrieves a list of the API keys that you've defined for the specified scope.

• xAmzTargetAwswaf20190729ListAvailableManagedRuleGroups.listAvailableManagedRuleGroups

  Retrieves an array of managed rule groups that are available for you to use. This list includes all Amazon Web Services Managed Rules rule groups and all of the Amazon Web Services Marketplace managed rule groups that you're subscribed to.

• xAmzTargetAwswaf20190729ListAvailableManagedRuleGroupVersions.listAvailableManagedRuleGroupVersions

  Returns a list of the available versions for the specified managed rule group.

• xAmzTargetAwswaf20190729ListIpSets.listIpSets

  Retrieves an array of IPSetSummary [blocked] objects for the IP sets that you manage.

• xAmzTargetAwswaf20190729ListLoggingConfigurations.listLoggingConfigurations

  Retrieves an array of your LoggingConfiguration [blocked] objects.

• xAmzTargetAwswaf20190729ListManagedRuleSets.listManagedRuleSets

  Retrieves the managed rule sets that you own.

  This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.

  Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate.

• xAmzTargetAwswaf20190729ListMobileSdkReleases.listMobileSdkReleases

  Retrieves a list of the available releases for the mobile SDK and the specified device platform.

  The mobile SDK is not generally available. Customers who have access to the mobile SDK can use it to establish and manage WAF tokens for use in HTTP(S) requests from a mobile device to WAF. For more information, see WAF client application integration in the WAF Developer Guide.

• xAmzTargetAwswaf20190729ListRegexPatternSets.listRegexPatternSets

  Retrieves an array of RegexPatternSetSummary [blocked] objects for the regex pattern sets that you manage.

• xAmzTargetAwswaf20190729ListResourcesForWebAcl.listResourcesForWebAcl

  Retrieves an array of the Amazon Resource Names (ARNs) for the regional resources that are associated with the specified web ACL. If you want the list of Amazon CloudFront resources, use the CloudFront call ListDistributionsByWebACLId.

• xAmzTargetAwswaf20190729ListRuleGroups.listRuleGroups

  Retrieves an array of RuleGroupSummary [blocked] objects for the rule groups that you manage.

• xAmzTargetAwswaf20190729ListTagsForResource.listTagsForResource

  Retrieves the TagInfoForResource [blocked] for the specified resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a resource.

  You can tag the Amazon Web Services resources that you manage through WAF: web ACLs, rule groups, IP sets, and regex pattern sets. You can't manage or view tags through the WAF console.

• xAmzTargetAwswaf20190729ListWebAcLs.listWebAcLs

  Retrieves an array of WebACLSummary [blocked] objects for the web ACLs that you manage.

• xAmzTargetAwswaf20190729PutLoggingConfiguration.putLoggingConfiguration

  Enables the specified LoggingConfiguration [blocked], to start logging from a web ACL, according to the configuration provided.

  This operation completely replaces any mutable specifications that you already have for a logging configuration with the ones that you provide to this call.

  To modify an existing logging configuration, do the following:

  1. Retrieve it by calling GetLoggingConfiguration [blocked]

  2. Update its settings as needed

  3. Provide the complete logging configuration specification to this call

  You can define one logging destination per web ACL.

  You can access information about the traffic that WAF inspects using the following steps:

  1. Create your logging destination. You can use an Amazon CloudWatch Logs log group, an Amazon Simple Storage Service (Amazon S3) bucket, or an Amazon Kinesis Data Firehose.

     The name that you give the destination must start with aws-waf-logs-. Depending on the type of destination, you might need to configure additional settings or permissions.

     For configuration requirements and pricing information for each destination type, see Logging web ACL traffic in the WAF Developer Guide.

  2. Associate your logging destination to your web ACL using a PutLoggingConfiguration request.

  When you successfully enable logging using a PutLoggingConfiguration request, WAF creates an additional role or policy that is required to write logs to the logging destination. For an Amazon CloudWatch Logs log group, WAF creates a resource policy on the log group. For an Amazon S3 bucket, WAF creates a bucket policy. For an Amazon Kinesis Data Firehose, WAF creates a service-linked role.

  For additional information about web ACL logging, see Logging web ACL traffic information in the WAF Developer Guide.

• xAmzTargetAwswaf20190729PutManagedRuleSetVersions.putManagedRuleSetVersions

  Defines the versions of your managed rule set that you are offering to the customers. Customers see your offerings as managed rule groups with versioning.

  This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.

  Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate.

  Customers retrieve their managed rule group list by calling ListAvailableManagedRuleGroups [blocked]. The name that you provide here for your managed rule set is the name the customer sees for the corresponding managed rule group. Customers can retrieve the available versions for a managed rule group by calling ListAvailableManagedRuleGroupVersions [blocked]. You provide a rule group specification for each version. For each managed rule set, you must specify a version that you recommend using.

  To initiate the expiration of a managed rule group version, use UpdateManagedRuleSetVersionExpiryDate [blocked].

• xAmzTargetAwswaf20190729PutPermissionPolicy.putPermissionPolicy

  Attaches an IAM policy to the specified resource. Use this to share a rule group across accounts.

  You must be the owner of the rule group to perform this operation.

  This action is subject to the following restrictions:

  • You can attach only one policy with each PutPermissionPolicy request.

  • The ARN in the request must be a valid WAF RuleGroup [blocked] ARN and the rule group must exist in the same Region.

  • The user making the request must be the owner of the rule group.

• xAmzTargetAwswaf20190729TagResource.tagResource

  Associates tags with the specified Amazon Web Services resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a resource.

  You can tag the Amazon Web Services resources that you manage through WAF: web ACLs, rule groups, IP sets, and regex pattern sets. You can't manage or view tags through the WAF console.

• xAmzTargetAwswaf20190729UntagResource.untagResource

  Disassociates tags from an Amazon Web Services resource. Tags are key:value pairs that you can associate with Amazon Web Services resources. For example, the tag key might be "customer" and the tag value might be "companyA." You can specify one or more tags to add to each container. You can add up to 50 tags to each Amazon Web Services resource.

• xAmzTargetAwswaf20190729UpdateIpSet.updateIpSet

  Updates the specified IPSet [blocked].

  This operation completely replaces the mutable specifications that you already have for the IP set with the ones that you provide to this call.

  To modify an IP set, do the following:

  1. Retrieve it by calling GetIPSet [blocked]

  2. Update its settings as needed

  3. Provide the complete IP set specification to this call

  When you make changes to web ACLs or web ACL components, like rules and rule groups, WAF propagates the changes everywhere that the web ACL and its components are stored and used. Your changes are applied within seconds, but there might be a brief period of inconsistency when the changes have arrived in some places and not in others. So, for example, if you change a rule action setting, the action might be the old action in one area and the new action in another area. Or if you add an IP address to an IP set used in a blocking rule, the new address might briefly be blocked in one area while still allowed in another. This temporary inconsistency can occur when you first associate a web ACL with an Amazon Web Services resource and when you change a web ACL that is already associated with a resource. Generally, any inconsistencies of this type last only a few seconds.

• xAmzTargetAwswaf20190729UpdateManagedRuleSetVersionExpiryDate.updateManagedRuleSetVersionExpiryDate

  Updates the expiration information for your managed rule set. Use this to initiate the expiration of a managed rule group version. After you initiate expiration for a version, WAF excludes it from the response to ListAvailableManagedRuleGroupVersions [blocked] for the managed rule group.

  This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.

  Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate.

• xAmzTargetAwswaf20190729UpdateRegexPatternSet.updateRegexPatternSet

  Updates the specified RegexPatternSet [blocked].

  This operation completely replaces the mutable specifications that you already have for the regex pattern set with the ones that you provide to this call.

  To modify a regex pattern set, do the following:

  1. Retrieve it by calling GetRegexPatternSet [blocked]

  2. Update its settings as needed

  3. Provide the complete regex pattern set specification to this call

  When you make changes to web ACLs or web ACL components, like rules and rule groups, WAF propagates the changes everywhere that the web ACL and its components are stored and used. Your changes are applied within seconds, but there might be a brief period of inconsistency when the changes have arrived in some places and not in others. So, for example, if you change a rule action setting, the action might be the old action in one area and the new action in another area. Or if you add an IP address to an IP set used in a blocking rule, the new address might briefly be blocked in one area while still allowed in another. This temporary inconsistency can occur when you first associate a web ACL with an Amazon Web Services resource and when you change a web ACL that is already associated with a resource. Generally, any inconsistencies of this type last only a few seconds.

• xAmzTargetAwswaf20190729UpdateRuleGroup.updateRuleGroup

  Updates the specified RuleGroup [blocked].

  This operation completely replaces the mutable specifications that you already have for the rule group with the ones that you provide to this call.

  To modify a rule group, do the following:

  1. Retrieve it by calling GetRuleGroup [blocked]

  2. Update its settings as needed

  3. Provide the complete rule group specification to this call

  When you make changes to web ACLs or web ACL components, like rules and rule groups, WAF propagates the changes everywhere that the web ACL and its components are stored and used. Your changes are applied within seconds, but there might be a brief period of inconsistency when the changes have arrived in some places and not in others. So, for example, if you change a rule action setting, the action might be the old action in one area and the new action in another area. Or if you add an IP address to an IP set used in a blocking rule, the new address might briefly be blocked in one area while still allowed in another. This temporary inconsistency can occur when you first associate a web ACL with an Amazon Web Services resource and when you change a web ACL that is already associated with a resource. Generally, any inconsistencies of this type last only a few seconds.

  A rule group defines a collection of rules to inspect and control web requests that you can use in a WebACL [blocked]. When you create a rule group, you define an immutable capacity limit. If you update a rule group, you must stay within the capacity. This allows others to reuse the rule group with confidence in its capacity requirements.

• xAmzTargetAwswaf20190729UpdateWebAcl.updateWebAcl

  Updates the specified WebACL [blocked]. While updating a web ACL, WAF provides continuous coverage to the resources that you have associated with the web ACL.

  This operation completely replaces the mutable specifications that you already have for the web ACL with the ones that you provide to this call.

  To modify a web ACL, do the following:

  1. Retrieve it by calling GetWebACL [blocked]

  2. Update its settings as needed

  3. Provide the complete web ACL specification to this call

  When you make changes to web ACLs or web ACL components, like rules and rule groups, WAF propagates the changes everywhere that the web ACL and its components are stored and used. Your changes are applied within seconds, but there might be a brief period of inconsistency when the changes have arrived in some places and not in others. So, for example, if you change a rule action setting, the action might be the old action in one area and the new action in another area. Or if you add an IP address to an IP set used in a blocking rule, the new address might briefly be blocked in one area while still allowed in another. This temporary inconsistency can occur when you first associate a web ACL with an Amazon Web Services resource and when you change a web ACL that is already associated with a resource. Generally, any inconsistencies of this type last only a few seconds.

  A web ACL defines a collection of rules to use to inspect and control web requests. Each rule has an action defined (allow, block, or count) for requests that match the statement of the rule. In the web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a web ACL can be a combination of the types Rule [blocked], RuleGroup [blocked], and managed rule group. You can associate a web ACL with one or more Amazon Web Services resources to protect. The resources can be an Amazon CloudFront distribution, an Amazon API Gateway REST API, an Application Load Balancer, an AppSync GraphQL API, an Amazon Cognito user pool, or an App Runner service.

• openapi.previewSpec

  Preview an OpenAPI document before adding it as a source

• openapi.addSource

  Add an OpenAPI source and register its operations as tools