Request Syntax Request Parameters Response Elements Errors Examples See Also

PutPermissionPolicy

Note

AWS WAF Classic support will end on September 30, 2025.

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF , use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Attaches an 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 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 Policies and permissions in IAM.

An example of a valid policy parameter is shown in the Examples section below.

Request Syntax


{
   "Policy": "string",
   "ResourceArn": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Policy

The policy to attach to the specified RuleGroup.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 395000.

Pattern: .*\S.*

Required: Yes

ResourceArn

The Amazon Resource Name (ARN) of the RuleGroup to which you want to attach the policy.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1224.

Pattern: .*\S.*

Required: Yes

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors.

WAFInternalErrorException

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

HTTP Status Code: 500

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.

HTTP Status Code: 400

WAFNonexistentItemException

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

HTTP Status Code: 400

WAFStaleDataException

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

HTTP Status Code: 400

Examples

Example policy parameter - No escape characters

This example illustrates one usage of PutPermissionPolicy.


{
   "Version": "2012-10-17",
    "Statement": [
        {
          "Effect": "Allow",
          "Principal": {
          "AWS": "arn:aws:iam::111111111111:user/MyUserName"
                       },
           "Action": [
               "waf:UpdateWebACL",
               "waf-regional:UpdateWebACL",
               "waf:GetRuleGroup",
               "waf-regional:GetRuleGroup"

                     ]
         }
                  ]
}

Example policy parameter - ()

This example illustrates one usage of PutPermissionPolicy.


{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"arn:aws:iam::111111111111:user\/MyUserName\"},\"Action\":[\"waf:UpdateWebACL\",\"waf-regional:UpdateWebACL\",\"waf:GetRuleGroup\",\"waf-regional:GetRuleGroup\"]}]}