AWS SDK for PHP 3.x

Service ID: fms

Version: 2018-01-01

This page describes the parameters and results for the operations of the Firewall Management Service (2018-01-01), and shows how to use the Aws\FMS\FMSClient object to call the described operations. This documentation is specific to the 2018-01-01 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

AssociateAdminAccount ( array $params = [] )
Sets the AWS Firewall Manager administrator account.
DeleteNotificationChannel ( array $params = [] )
Deletes an AWS Firewall Manager association with the IAM role and the Amazon Simple Notification Service (SNS) topic that is used to record AWS Firewall Manager SNS logs.
DeletePolicy ( array $params = [] )
Permanently deletes an AWS Firewall Manager policy.
DisassociateAdminAccount ( array $params = [] )
Disassociates the account that has been set as the AWS Firewall Manager administrator account.
GetAdminAccount ( array $params = [] )
Returns the AWS Organizations master account that is associated with AWS Firewall Manager as the AWS Firewall Manager administrator.
GetComplianceDetail ( array $params = [] )
Returns detailed compliance information about the specified member account.
GetNotificationChannel ( array $params = [] )
Information about the Amazon Simple Notification Service (SNS) topic that is used to record AWS Firewall Manager SNS logs.
GetPolicy ( array $params = [] )
Returns information about the specified AWS Firewall Manager policy.
GetProtectionStatus ( array $params = [] )
If you created a Shield Advanced policy, returns policy-level attack summary information in the event of a potential DDoS attack.
ListComplianceStatus ( array $params = [] )
Returns an array of PolicyComplianceStatus objects in the response.
ListMemberAccounts ( array $params = [] )
Returns a MemberAccounts object that lists the member accounts in the administrator's AWS organization.
ListPolicies ( array $params = [] )
Returns an array of PolicySummary objects in the response.
PutNotificationChannel ( array $params = [] )
Designates the IAM role and Amazon Simple Notification Service (SNS) topic that AWS Firewall Manager uses to record SNS logs.
PutPolicy ( array $params = [] )
Creates an AWS Firewall Manager policy.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

ListComplianceStatus
ListMemberAccounts
ListPolicies

Operations

AssociateAdminAccount

$result = $client->associateAdminAccount([/* ... */]);
$promise = $client->associateAdminAccountAsync([/* ... */]);

Sets the AWS Firewall Manager administrator account. AWS Firewall Manager must be associated with the master account of your AWS organization or associated with a member account that has the appropriate permissions. If the account ID that you submit is not an AWS Organizations master account, AWS Firewall Manager will set the appropriate permissions for the given member account.

The account that you associate with AWS Firewall Manager is called the AWS Firewall Manager administrator account.

Parameter Syntax

$result = $client->associateAdminAccount([
    'AdminAccount' => '<string>', // REQUIRED
]);

Parameter Details

Members

AdminAccount

Required: Yes
Type: string

The AWS account ID to associate with AWS Firewall Manager as the AWS Firewall Manager administrator account. This can be an AWS Organizations master account or a member account. For more information about AWS Organizations and master accounts, see Managing the AWS Accounts in Your Organization.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

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.
InvalidInputException:
The parameters of the request were invalid.
ResourceNotFoundException:
The specified resource was not found.
InternalErrorException:
The operation failed because of a system problem, even though the request was valid. Retry your request.

DeleteNotificationChannel

$result = $client->deleteNotificationChannel([/* ... */]);
$promise = $client->deleteNotificationChannelAsync([/* ... */]);

Deletes an AWS Firewall Manager association with the IAM role and the Amazon Simple Notification Service (SNS) topic that is used to record AWS Firewall Manager SNS logs.

Parameter Syntax

$result = $client->deleteNotificationChannel([
]);

Parameter Details

Members

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:
The specified resource was not found.
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.
InternalErrorException:
The operation failed because of a system problem, even though the request was valid. Retry your request.

DeletePolicy

$result = $client->deletePolicy([/* ... */]);
$promise = $client->deletePolicyAsync([/* ... */]);

Permanently deletes an AWS Firewall Manager policy.

Parameter Syntax

$result = $client->deletePolicy([
    'DeleteAllPolicyResources' => true || false,
    'PolicyId' => '<string>', // REQUIRED
]);

Parameter Details

Members

DeleteAllPolicyResources

Type: boolean

If True, the request performs cleanup according to the policy type.

For AWS WAF and Shield Advanced policies, the cleanup does the following:

Deletes rule groups created by AWS Firewall Manager
Removes web ACLs from in-scope resources
Deletes web ACLs that contain no rules or rule groups

For security group policies, the cleanup does the following for each security group in the policy:

Disassociates the security group from in-scope resources
Deletes the security group if it was created through Firewall Manager and if it's no longer associated with any resources through another policy

After the cleanup, in-scope resources are no longer protected by web ACLs in this policy. Protection of out-of-scope resources remains unchanged. Scope is determined by tags that you create and accounts that you associate with the policy. When creating the policy, if you specify that only resources in specific accounts or with specific tags are in scope of the policy, those accounts and resources are handled by the policy. All others are out of scope. If you don't specify tags or accounts, all resources are in scope.

PolicyId

Required: Yes
Type: string

The ID of the policy that you want to delete. PolicyId is returned by PutPolicy and by ListPolicies.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:
The specified resource was not found.
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.
InternalErrorException:
The operation failed because of a system problem, even though the request was valid. Retry your request.

DisassociateAdminAccount

$result = $client->disassociateAdminAccount([/* ... */]);
$promise = $client->disassociateAdminAccountAsync([/* ... */]);

Disassociates the account that has been set as the AWS Firewall Manager administrator account. To set a different account as the administrator account, you must submit an AssociateAdminAccount request.

Parameter Syntax

$result = $client->disassociateAdminAccount([
]);

Parameter Details

Members

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

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.
ResourceNotFoundException:
The specified resource was not found.
InternalErrorException:
The operation failed because of a system problem, even though the request was valid. Retry your request.

GetAdminAccount

$result = $client->getAdminAccount([/* ... */]);
$promise = $client->getAdminAccountAsync([/* ... */]);

Returns the AWS Organizations master account that is associated with AWS Firewall Manager as the AWS Firewall Manager administrator.

Parameter Syntax

$result = $client->getAdminAccount([
]);

Parameter Details

Members

Result Syntax

[
    'AdminAccount' => '<string>',
    'RoleStatus' => 'READY|CREATING|PENDING_DELETION|DELETING|DELETED',
]

Result Details

Members

AdminAccount

Type: string

The AWS account that is set as the AWS Firewall Manager administrator.

RoleStatus

Type: string

The status of the AWS account that you set as the AWS Firewall Manager administrator.

Errors

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.
ResourceNotFoundException:
The specified resource was not found.
InternalErrorException:
The operation failed because of a system problem, even though the request was valid. Retry your request.

GetComplianceDetail

$result = $client->getComplianceDetail([/* ... */]);
$promise = $client->getComplianceDetailAsync([/* ... */]);

Returns detailed compliance information about the specified member account. Details include resources that are in and out of compliance with the specified policy. Resources are considered noncompliant for AWS WAF and Shield Advanced policies if the specified policy has not been applied to them. Resources are considered noncompliant for security group policies if they are in scope of the policy, they violate one or more of the policy rules, and remediation is disabled or not possible.

Parameter Syntax

$result = $client->getComplianceDetail([
    'MemberAccount' => '<string>', // REQUIRED
    'PolicyId' => '<string>', // REQUIRED
]);

Parameter Details

Members

MemberAccount

Required: Yes
Type: string

The AWS account that owns the resources that you want to get the details for.

PolicyId

Required: Yes
Type: string

The ID of the policy that you want to get the details for. PolicyId is returned by PutPolicy and by ListPolicies.

Result Syntax

[
    'PolicyComplianceDetail' => [
        'EvaluationLimitExceeded' => true || false,
        'ExpiredAt' => <DateTime>,
        'IssueInfoMap' => ['<string>', ...],
        'MemberAccount' => '<string>',
        'PolicyId' => '<string>',
        'PolicyOwner' => '<string>',
        'Violators' => [
            [
                'ResourceId' => '<string>',
                'ResourceType' => '<string>',
                'ViolationReason' => 'WEB_ACL_MISSING_RULE_GROUP|RESOURCE_MISSING_WEB_ACL|RESOURCE_INCORRECT_WEB_ACL|RESOURCE_MISSING_SHIELD_PROTECTION|RESOURCE_MISSING_WEB_ACL_OR_SHIELD_PROTECTION|RESOURCE_MISSING_SECURITY_GROUP|RESOURCE_VIOLATES_AUDIT_SECURITY_GROUP|SECURITY_GROUP_UNUSED|SECURITY_GROUP_REDUNDANT',
            ],
            // ...
        ],
    ],
]

Result Details

Members

PolicyComplianceDetail

Type: PolicyComplianceDetail structure

Information about the resources and the policy that you specified in the GetComplianceDetail request.

Errors

ResourceNotFoundException:
The specified resource was not found.
InternalErrorException:
The operation failed because of a system problem, even though the request was valid. Retry your request.

GetNotificationChannel

$result = $client->getNotificationChannel([/* ... */]);
$promise = $client->getNotificationChannelAsync([/* ... */]);

Information about the Amazon Simple Notification Service (SNS) topic that is used to record AWS Firewall Manager SNS logs.

Parameter Syntax

$result = $client->getNotificationChannel([
]);

Parameter Details

Members

Result Syntax

[
    'SnsRoleName' => '<string>',
    'SnsTopicArn' => '<string>',
]

Result Details

Members

SnsRoleName

Type: string

The IAM role that is used by AWS Firewall Manager to record activity to SNS.

SnsTopicArn

Type: string

The SNS topic that records AWS Firewall Manager activity.

Errors

ResourceNotFoundException:
The specified resource was not found.
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.
InternalErrorException:
The operation failed because of a system problem, even though the request was valid. Retry your request.

GetPolicy

$result = $client->getPolicy([/* ... */]);
$promise = $client->getPolicyAsync([/* ... */]);

Returns information about the specified AWS Firewall Manager policy.

Parameter Syntax

$result = $client->getPolicy([
    'PolicyId' => '<string>', // REQUIRED
]);

Parameter Details

Members

PolicyId

Required: Yes
Type: string

The ID of the AWS Firewall Manager policy that you want the details for.

Result Syntax

[
    'Policy' => [
        'ExcludeMap' => [
            '<CustomerPolicyScopeIdType>' => ['<string>', ...],
            // ...
        ],
        'ExcludeResourceTags' => true || false,
        'IncludeMap' => [
            '<CustomerPolicyScopeIdType>' => ['<string>', ...],
            // ...
        ],
        'PolicyId' => '<string>',
        'PolicyName' => '<string>',
        'PolicyUpdateToken' => '<string>',
        'RemediationEnabled' => true || false,
        'ResourceTags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceType' => '<string>',
        'ResourceTypeList' => ['<string>', ...],
        'SecurityServicePolicyData' => [
            'ManagedServiceData' => '<string>',
            'Type' => 'WAF|SHIELD_ADVANCED|SECURITY_GROUPS_COMMON|SECURITY_GROUPS_CONTENT_AUDIT|SECURITY_GROUPS_USAGE_AUDIT',
        ],
    ],
    'PolicyArn' => '<string>',
]

Result Details

Members

Policy

Type: Policy structure

Information about the specified AWS Firewall Manager policy.

PolicyArn

Type: string

The Amazon Resource Name (ARN) of the specified policy.

Errors

ResourceNotFoundException:
The specified resource was not found.
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.
InternalErrorException:
The operation failed because of a system problem, even though the request was valid. Retry your request.
InvalidTypeException:
The value of the Type parameter is invalid.

GetProtectionStatus

$result = $client->getProtectionStatus([/* ... */]);
$promise = $client->getProtectionStatusAsync([/* ... */]);

If you created a Shield Advanced policy, returns policy-level attack summary information in the event of a potential DDoS attack. Other policy types are currently unsupported.

Parameter Syntax

$result = $client->getProtectionStatus([
    'EndTime' => <integer || string || DateTime>,
    'MaxResults' => <integer>,
    'MemberAccountId' => '<string>',
    'NextToken' => '<string>',
    'PolicyId' => '<string>', // REQUIRED
    'StartTime' => <integer || string || DateTime>,
]);

Parameter Details

Members

EndTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The end of the time period to query for the attacks. This is a timestamp type. The request syntax listing indicates a number type because the default used by AWS Firewall Manager is Unix time in seconds. However, any valid timestamp format is allowed.

MaxResults

Type: int

Specifies the number of objects that you want AWS Firewall Manager to return for this request. If you have more objects than the number that you specify for MaxResults, the response includes a NextToken value that you can use to get another batch of objects.

MemberAccountId

Type: string

The AWS account that is in scope of the policy that you want to get the details for.

NextToken

Type: string

If you specify a value for MaxResults and you have more objects than the number that you specify for MaxResults, AWS Firewall Manager returns a NextToken value in the response, which you can use to retrieve another group of objects. For the second and subsequent GetProtectionStatus requests, specify the value of NextToken from the previous response to get information about another batch of objects.

PolicyId

Required: Yes
Type: string

The ID of the policy for which you want to get the attack information.

StartTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The start of the time period to query for the attacks. This is a timestamp type. The request syntax listing indicates a number type because the default used by AWS Firewall Manager is Unix time in seconds. However, any valid timestamp format is allowed.

Result Syntax

[
    'AdminAccountId' => '<string>',
    'Data' => '<string>',
    'NextToken' => '<string>',
    'ServiceType' => 'WAF|SHIELD_ADVANCED|SECURITY_GROUPS_COMMON|SECURITY_GROUPS_CONTENT_AUDIT|SECURITY_GROUPS_USAGE_AUDIT',
]

Result Details

Members

AdminAccountId

Type: string

The ID of the AWS Firewall administrator account for this policy.

Data

Type: string

Details about the attack, including the following:

Attack type
Account ID
ARN of the resource attacked
Start time of the attack
End time of the attack (ongoing attacks will not have an end time)

The details are in JSON format.

NextToken

Type: string

If you have more objects than the number that you specified for MaxResults in the request, the response includes a NextToken value. To list more objects, submit another GetProtectionStatus request, and specify the NextToken value from the response in the NextToken value in the next request.

AWS SDKs provide auto-pagination that identify NextToken in a response and make subsequent request calls automatically on your behalf. However, this feature is not supported by GetProtectionStatus. You must submit subsequent requests with NextToken using your own processes.

ServiceType

Type: string

The service type that is protected by the policy. Currently, this is always SHIELD_ADVANCED.

Errors

InvalidInputException:
The parameters of the request were invalid.
ResourceNotFoundException:
The specified resource was not found.
InternalErrorException:
The operation failed because of a system problem, even though the request was valid. Retry your request.

ListComplianceStatus

$result = $client->listComplianceStatus([/* ... */]);
$promise = $client->listComplianceStatusAsync([/* ... */]);

Returns an array of PolicyComplianceStatus objects in the response. Use PolicyComplianceStatus to get a summary of which member accounts are protected by the specified policy.

Parameter Syntax

$result = $client->listComplianceStatus([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'PolicyId' => '<string>', // REQUIRED
]);

Parameter Details

Members

MaxResults

Type: int

Specifies the number of PolicyComplianceStatus objects that you want AWS Firewall Manager to return for this request. If you have more PolicyComplianceStatus objects than the number that you specify for MaxResults, the response includes a NextToken value that you can use to get another batch of PolicyComplianceStatus objects.

NextToken

Type: string

If you specify a value for MaxResults and you have more PolicyComplianceStatus objects than the number that you specify for MaxResults, AWS Firewall Manager returns a NextToken value in the response that allows you to list another group of PolicyComplianceStatus objects. For the second and subsequent ListComplianceStatus requests, specify the value of NextToken from the previous response to get information about another batch of PolicyComplianceStatus objects.

PolicyId

Required: Yes
Type: string

The ID of the AWS Firewall Manager policy that you want the details for.

Result Syntax

[
    'NextToken' => '<string>',
    'PolicyComplianceStatusList' => [
        [
            'EvaluationResults' => [
                [
                    'ComplianceStatus' => 'COMPLIANT|NON_COMPLIANT',
                    'EvaluationLimitExceeded' => true || false,
                    'ViolatorCount' => <integer>,
                ],
                // ...
            ],
            'IssueInfoMap' => ['<string>', ...],
            'LastUpdated' => <DateTime>,
            'MemberAccount' => '<string>',
            'PolicyId' => '<string>',
            'PolicyName' => '<string>',
            'PolicyOwner' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: string

If you have more PolicyComplianceStatus objects than the number that you specified for MaxResults in the request, the response includes a NextToken value. To list more PolicyComplianceStatus objects, submit another ListComplianceStatus request, and specify the NextToken value from the response in the NextToken value in the next request.

PolicyComplianceStatusList

Type: Array of PolicyComplianceStatus structures

An array of PolicyComplianceStatus objects.

Errors

ResourceNotFoundException:
The specified resource was not found.
InternalErrorException:
The operation failed because of a system problem, even though the request was valid. Retry your request.

ListMemberAccounts

$result = $client->listMemberAccounts([/* ... */]);
$promise = $client->listMemberAccountsAsync([/* ... */]);

Returns a MemberAccounts object that lists the member accounts in the administrator's AWS organization.

The ListMemberAccounts must be submitted by the account that is set as the AWS Firewall Manager administrator.

Parameter Syntax

$result = $client->listMemberAccounts([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

MaxResults

Type: int

Specifies the number of member account IDs that you want AWS Firewall Manager to return for this request. If you have more IDs than the number that you specify for MaxResults, the response includes a NextToken value that you can use to get another batch of member account IDs.

NextToken

Type: string

If you specify a value for MaxResults and you have more account IDs than the number that you specify for MaxResults, AWS Firewall Manager returns a NextToken value in the response that allows you to list another group of IDs. For the second and subsequent ListMemberAccountsRequest requests, specify the value of NextToken from the previous response to get information about another batch of member account IDs.

Result Syntax

[
    'MemberAccounts' => ['<string>', ...],
    'NextToken' => '<string>',
]

Result Details

Members

MemberAccounts

Type: Array of strings

An array of account IDs.

NextToken

Type: string

If you have more member account IDs than the number that you specified for MaxResults in the request, the response includes a NextToken value. To list more IDs, submit another ListMemberAccounts request, and specify the NextToken value from the response in the NextToken value in the next request.

Errors

ResourceNotFoundException:
The specified resource was not found.
InternalErrorException:
The operation failed because of a system problem, even though the request was valid. Retry your request.

ListPolicies

$result = $client->listPolicies([/* ... */]);
$promise = $client->listPoliciesAsync([/* ... */]);

Returns an array of PolicySummary objects in the response.

Parameter Syntax

$result = $client->listPolicies([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

MaxResults

Type: int

Specifies the number of PolicySummary objects that you want AWS Firewall Manager to return for this request. If you have more PolicySummary objects than the number that you specify for MaxResults, the response includes a NextToken value that you can use to get another batch of PolicySummary objects.

NextToken

Type: string

If you specify a value for MaxResults and you have more PolicySummary objects than the number that you specify for MaxResults, AWS Firewall Manager returns a NextToken value in the response that allows you to list another group of PolicySummary objects. For the second and subsequent ListPolicies requests, specify the value of NextToken from the previous response to get information about another batch of PolicySummary objects.

Result Syntax

[
    'NextToken' => '<string>',
    'PolicyList' => [
        [
            'PolicyArn' => '<string>',
            'PolicyId' => '<string>',
            'PolicyName' => '<string>',
            'RemediationEnabled' => true || false,
            'ResourceType' => '<string>',
            'SecurityServiceType' => 'WAF|SHIELD_ADVANCED|SECURITY_GROUPS_COMMON|SECURITY_GROUPS_CONTENT_AUDIT|SECURITY_GROUPS_USAGE_AUDIT',
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: string

If you have more PolicySummary objects than the number that you specified for MaxResults in the request, the response includes a NextToken value. To list more PolicySummary objects, submit another ListPolicies request, and specify the NextToken value from the response in the NextToken value in the next request.

PolicyList

Type: Array of PolicySummary structures

An array of PolicySummary objects.

Errors

ResourceNotFoundException:
The specified resource was not found.
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.
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.
InternalErrorException:
The operation failed because of a system problem, even though the request was valid. Retry your request.

PutNotificationChannel

$result = $client->putNotificationChannel([/* ... */]);
$promise = $client->putNotificationChannelAsync([/* ... */]);

Designates the IAM role and Amazon Simple Notification Service (SNS) topic that AWS Firewall Manager uses to record SNS logs.

Parameter Syntax

$result = $client->putNotificationChannel([
    'SnsRoleName' => '<string>', // REQUIRED
    'SnsTopicArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

SnsRoleName

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the IAM role that allows Amazon SNS to record AWS Firewall Manager activity.

SnsTopicArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the SNS topic that collects notifications from AWS Firewall Manager.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:
The specified resource was not found.
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.
InternalErrorException:
The operation failed because of a system problem, even though the request was valid. Retry your request.

PutPolicy

$result = $client->putPolicy([/* ... */]);
$promise = $client->putPolicyAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->putPolicy([
    'Policy' => [ // REQUIRED
        'ExcludeMap' => [
            '<CustomerPolicyScopeIdType>' => ['<string>', ...],
            // ...
        ],
        'ExcludeResourceTags' => true || false, // REQUIRED
        'IncludeMap' => [
            '<CustomerPolicyScopeIdType>' => ['<string>', ...],
            // ...
        ],
        'PolicyId' => '<string>',
        'PolicyName' => '<string>', // REQUIRED
        'PolicyUpdateToken' => '<string>',
        'RemediationEnabled' => true || false, // REQUIRED
        'ResourceTags' => [
            [
                'Key' => '<string>', // REQUIRED
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceType' => '<string>', // REQUIRED
        'ResourceTypeList' => ['<string>', ...],
        'SecurityServicePolicyData' => [ // REQUIRED
            'ManagedServiceData' => '<string>',
            'Type' => 'WAF|SHIELD_ADVANCED|SECURITY_GROUPS_COMMON|SECURITY_GROUPS_CONTENT_AUDIT|SECURITY_GROUPS_USAGE_AUDIT', // REQUIRED
        ],
    ],
]);

Parameter Details

Members

Policy

Required: Yes
Type: Policy structure

The details of the AWS Firewall Manager policy to be created.

Result Syntax

[
    'Policy' => [
        'ExcludeMap' => [
            '<CustomerPolicyScopeIdType>' => ['<string>', ...],
            // ...
        ],
        'ExcludeResourceTags' => true || false,
        'IncludeMap' => [
            '<CustomerPolicyScopeIdType>' => ['<string>', ...],
            // ...
        ],
        'PolicyId' => '<string>',
        'PolicyName' => '<string>',
        'PolicyUpdateToken' => '<string>',
        'RemediationEnabled' => true || false,
        'ResourceTags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceType' => '<string>',
        'ResourceTypeList' => ['<string>', ...],
        'SecurityServicePolicyData' => [
            'ManagedServiceData' => '<string>',
            'Type' => 'WAF|SHIELD_ADVANCED|SECURITY_GROUPS_COMMON|SECURITY_GROUPS_CONTENT_AUDIT|SECURITY_GROUPS_USAGE_AUDIT',
        ],
    ],
    'PolicyArn' => '<string>',
]

Result Details

Members

Policy

Type: Policy structure

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

PolicyArn

Type: string

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

Errors

ResourceNotFoundException:
The specified resource was not found.
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.
InvalidInputException:
The parameters of the request were invalid.
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.
InternalErrorException:
The operation failed because of a system problem, even though the request was valid. Retry your request.
InvalidTypeException:
The value of the Type parameter is invalid.

Shapes

ComplianceViolator

Description

Details of the resource that is not protected by the policy.

Members

ResourceId

Type: string

The resource ID.

ResourceType

Type: string

The resource type. This is in the format shown in the AWS Resource Types Reference. For example: AWS::ElasticLoadBalancingV2::LoadBalancer or AWS::CloudFront::Distribution.

ViolationReason

Type: string

The reason that the resource is not protected by the policy.

EvaluationResult

Description

Describes the compliance status for the account. An account is considered noncompliant if it includes resources that are not protected by the specified policy or that don't comply with the policy.

Members

ComplianceStatus

Type: string

Describes an AWS account's compliance with the AWS Firewall Manager policy.

EvaluationLimitExceeded

Type: boolean

Indicates that over 100 resources are noncompliant with the AWS Firewall Manager policy.

ViolatorCount

Type: long (int|float)

Type: Associative array of custom strings keys (CustomerPolicyScopeIdType) to stringss

Specifies the AWS account IDs to exclude from the policy. The IncludeMap values are evaluated first, with all the appropriate account IDs added to the policy. Then the accounts listed in ExcludeMap are removed, resulting in the final list of accounts to add to the policy.

The key to the map is ACCOUNT. For example, a valid ExcludeMap would be {“ACCOUNT” : [“accountID1”, “accountID2”]}.

ExcludeResourceTags

Required: Yes
Type: boolean

If set to True, resources with the tags that are specified in the ResourceTag array are not in scope of the policy. If set to False, and the ResourceTag array is not null, only resources with the specified tags are in scope of the policy.

IncludeMap

Type: Associative array of custom strings keys (CustomerPolicyScopeIdType) to stringss

Specifies the AWS account IDs to include in the policy. If IncludeMap is null, all accounts in the organization in AWS Organizations are included in the policy. If IncludeMap is not null, only values listed in IncludeMap are included in the policy.

The key to the map is ACCOUNT. For example, a valid IncludeMap would be {“ACCOUNT” : [“accountID1”, “accountID2”]}.

PolicyId

Type: string

The ID of the AWS Firewall Manager policy.

PolicyName

Required: Yes
Type: string

The friendly name of the AWS Firewall Manager policy.

PolicyUpdateToken

Type: string

A unique identifier for each update to the policy. When issuing a PutPolicy request, the PolicyUpdateToken in the request must match the PolicyUpdateToken of the current policy version. To get the PolicyUpdateToken of the current policy version, use a GetPolicy request.

RemediationEnabled

Required: Yes
Type: boolean

Indicates if the policy should be automatically applied to new resources.

ResourceTags

Type: Array of ResourceTag structures

An array of ResourceTag objects.

ResourceType

Required: Yes
Type: string

The type of resource protected by or in scope of the policy. This is in the format shown in the AWS Resource Types Reference. For AWS WAF and Shield Advanced, examples include AWS::ElasticLoadBalancingV2::LoadBalancer and AWS::CloudFront::Distribution. For a security group common policy, valid values are AWS::EC2::NetworkInterface and AWS::EC2::Instance. For a security group content audit policy, valid values are AWS::EC2::SecurityGroup, AWS::EC2::NetworkInterface, and AWS::EC2::Instance. For a security group usage audit policy, the value is AWS::EC2::SecurityGroup.

ResourceTypeList

Type: Array of strings

An array of ResourceType.

SecurityServicePolicyData

Required: Yes
Type: SecurityServicePolicyData structure

Details about the security service that is being used to protect the resources.

PolicyComplianceDetail

Description

Describes the noncompliant resources in a member account for a specific AWS Firewall Manager policy. A maximum of 100 entries are displayed. If more than 100 resources are noncompliant, EvaluationLimitExceeded is set to True.

Members

EvaluationLimitExceeded

Type: boolean

Indicates if over 100 resources are noncompliant with the AWS Firewall Manager policy.

ExpiredAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp that indicates when the returned information should be considered out of date.

IssueInfoMap

Type: Associative array of custom strings keys (DependentServiceName) to strings

Details about problems with dependent services, such as AWS WAF or AWS Config, that are causing a resource to be noncompliant. The details include the name of the dependent service and the error message received that indicates the problem with the service.

MemberAccount

Type: string

The AWS account ID.

PolicyId

Type: string

The ID of the AWS Firewall Manager policy.

PolicyOwner

Type: string

The AWS account that created the AWS Firewall Manager policy.

Violators

Type: Array of ComplianceViolator structures

An array of resources that aren't protected by the AWS WAF or Shield Advanced policy or that aren't in compliance with the security group policy.

PolicyComplianceStatus

Description

Indicates whether the account is compliant with the specified policy. An account is considered noncompliant if it includes resources that are not protected by the policy, for AWS WAF and Shield Advanced policies, or that are noncompliant with the policy, for security group policies.

Members

EvaluationResults

Type: Array of EvaluationResult structures

An array of EvaluationResult objects.

IssueInfoMap

Type: Associative array of custom strings keys (DependentServiceName) to strings

LastUpdated

Type: timestamp (string|DateTime or anything parsable by strtotime)

Timestamp of the last update to the EvaluationResult objects.

MemberAccount

Type: string

The member account ID.

PolicyId

Type: string

The ID of the AWS Firewall Manager policy.

PolicyName

Type: string

The friendly name of the AWS Firewall Manager policy.

PolicyOwner

Type: string

The AWS account that created the AWS Firewall Manager policy.

PolicySummary

Description

Details of the AWS Firewall Manager policy.

Members

PolicyArn

Type: string

The Amazon Resource Name (ARN) of the specified policy.

PolicyId

Type: string

The ID of the specified policy.

PolicyName

Type: string

The friendly name of the specified policy.

RemediationEnabled

Type: boolean

Indicates if the policy should be automatically applied to new resources.

ResourceType

Type: string

SecurityServiceType

Type: string

The service that the policy is using to protect the resources. This specifies the type of policy that is created, either an AWS WAF policy, a Shield Advanced policy, or a security group policy.

ResourceNotFoundException

Description

The specified resource was not found.

Members

Message

Type: string

ResourceTag

Description

The resource tags that AWS Firewall Manager uses to determine if a particular resource should be included or excluded from the AWS Firewall Manager policy. Tags enable you to categorize your AWS resources in different ways, for example, by purpose, owner, or environment. Each tag consists of a key and an optional value. Firewall Manager combines the tags with "AND" so that, if you add more than one tag to a policy scope, a resource must have all the specified tags to be included or excluded. For more information, see Working with Tag Editor.

Members

Key

Required: Yes
Type: string

The resource tag key.

Value

Type: string

The resource tag value.

SecurityServicePolicyData

Description

Details about the security service that is being used to protect the resources.

Members

ManagedServiceData

Type: string

Details about the service that are specific to the service type, in JSON format. For service type SHIELD_ADVANCED, this is an empty string.

Example: WAF

ManagedServiceData": "{\"type\": \"WAF\", \"ruleGroups\": [{\"id\": \"12345678-1bcd-9012-efga-0987654321ab\", \"overrideAction\" : {\"type\": \"COUNT\"}}], \"defaultAction\": {\"type\": \"BLOCK\"}}
Example: SECURITY_GROUPS_COMMON

"SecurityServicePolicyData":{"Type":"SECURITY_GROUPS_COMMON","ManagedServiceData":"{\"type\":\"SECURITY_GROUPS_COMMON\",\"revertManualSecurityGroupChanges\":false,\"exclusiveResourceSecurityGroupManagement\":false,\"securityGroups\":[{\"id\":\" sg-000e55995d61a06bd\"}]}"},"RemediationEnabled":false,"ResourceType":"AWS::EC2::NetworkInterface"}
Example: SECURITY_GROUPS_CONTENT_AUDIT

"SecurityServicePolicyData":{"Type":"SECURITY_GROUPS_CONTENT_AUDIT","ManagedServiceData":"{\"type\":\"SECURITY_GROUPS_CONTENT_AUDIT\",\"securityGroups\":[{\"id\":\" sg-000e55995d61a06bd \"}],\"securityGroupAction\":{\"type\":\"ALLOW\"}}"},"RemediationEnabled":false,"ResourceType":"AWS::EC2::NetworkInterface"}

The security group action for content audit can be ALLOW or DENY. For ALLOW, all in-scope security group rules must be within the allowed range of the policy's security group rules. For DENY, all in-scope security group rules must not contain a value or a range that matches a rule value or range in the policy security group.
Example: SECURITY_GROUPS_USAGE_AUDIT

"SecurityServicePolicyData":{"Type":"SECURITY_GROUPS_USAGE_AUDIT","ManagedServiceData":"{\"type\":\"SECURITY_GROUPS_USAGE_AUDIT\",\"deleteUnusedSecurityGroups\":true,\"coalesceRedundantSecurityGroups\":true}"},"RemediationEnabled":false,"Resou rceType":"AWS::EC2::SecurityGroup"}

Type

Required: Yes
Type: string

The service that the policy is using to protect the resources. This specifies the type of policy that is created, either an AWS WAF policy, a Shield Advanced policy, or a security group policy. For security group policies, Firewall Manager supports one security group for each common policy and for each content audit policy. This is an adjustable limit that you can increase by contacting AWS Support.

Namespaces

Classes

Interfaces

Traits

Exceptions

Functions

Firewall Management Service 2018-01-01

Operation Summary

Paginators

Operations

AssociateAdminAccount

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DeleteNotificationChannel

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DeletePolicy

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DisassociateAdminAccount

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

GetAdminAccount

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

GetComplianceDetail

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

GetNotificationChannel

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

GetPolicy

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

GetProtectionStatus

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

ListComplianceStatus

Parameter Syntax