The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

PutPolicy

Creates an AWS Firewall Manager policy.

Firewall Manager provides the following types of policies:

A Shield Advanced policy, which applies Shield Advanced protection to specified accounts and resources
An AWS WAF policy, which contains a rule group and defines which resources are to be protected by that rule group
A security group policy, which manages VPC security groups across your AWS organization.

Each policy is specific to one of the three types. If you want to enforce more than one policy type across accounts, you can create multiple policies. You can create multiple policies for each type.

You must be subscribed to Shield Advanced to create a Shield Advanced policy. For more information about subscribing to Shield Advanced, see CreateSubscription.

Request Syntax


{
   "Policy": { 
      "ExcludeMap": { 
         "string" : [ "string" ]
      },
      "ExcludeResourceTags": boolean,
      "IncludeMap": { 
         "string" : [ "string" ]
      },
      "PolicyId": "string",
      "PolicyName": "string",
      "PolicyUpdateToken": "string",
      "RemediationEnabled": boolean,
      "ResourceTags": [ 
         { 
            "Key": "string",
            "Value": "string"
         }
      ],
      "ResourceType": "string",
      "ResourceTypeList": [ "string" ],
      "SecurityServicePolicyData": { 
         "ManagedServiceData": "string",
         "Type": "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 details of the AWS Firewall Manager policy to be created.

Type: Policy object

Required: Yes

Response Syntax


{
   "Policy": { 
      "ExcludeMap": { 
         "string" : [ "string" ]
      },
      "ExcludeResourceTags": boolean,
      "IncludeMap": { 
         "string" : [ "string" ]
      },
      "PolicyId": "string",
      "PolicyName": "string",
      "PolicyUpdateToken": "string",
      "RemediationEnabled": boolean,
      "ResourceTags": [ 
         { 
            "Key": "string",
            "Value": "string"
         }
      ],
      "ResourceType": "string",
      "ResourceTypeList": [ "string" ],
      "SecurityServicePolicyData": { 
         "ManagedServiceData": "string",
         "Type": "string"
      }
   },
   "PolicyArn": "string"
}

Response Elements

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

The following data is returned in JSON format by the service.

Policy

The details of the AWS Firewall Manager policy that was created.

Type: Policy object

PolicyArn

The Amazon Resource Name (ARN) of the policy that was created.

Type: String

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

Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$

Errors

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

InternalErrorException

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

HTTP Status Code: 400

InvalidInputException

The parameters of the request were invalid.

HTTP Status Code: 400

InvalidOperationException

The operation failed because there was nothing to do. For example, you might have submitted an AssociateAdminAccount request, but the account ID that you submitted was already set as the AWS Firewall Manager administrator.

HTTP Status Code: 400

InvalidTypeException

The value of the Type parameter is invalid.

HTTP Status Code: 400

LimitExceededException

The operation exceeds a resource limit, for example, the maximum number of policy objects that you can create for an AWS account. For more information, see Firewall Manager Limits in the AWS WAF Developer Guide.

HTTP Status Code: 400

ResourceNotFoundException

The specified resource was not found.

HTTP Status Code: 400

PutPolicy

Request Syntax

Request Parameters

Response Syntax

Response Elements

Errors

See Also