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 a Firewall Manager default administrator account.
AssociateThirdPartyFirewall ( array $params = [] ): Sets the Firewall Manager policy administrator as a tenant administrator of a third-party firewall service.
BatchAssociateResource ( array $params = [] ): Associate resources to a Firewall Manager resource set.
BatchDisassociateResource ( array $params = [] ): Disassociates resources from a Firewall Manager resource set.
DeleteAppsList ( array $params = [] ): Permanently deletes an Firewall Manager applications list.
DeleteNotificationChannel ( array $params = [] ): Deletes an Firewall Manager association with the IAM role and the Amazon Simple Notification Service (SNS) topic that is used to record Firewall Manager SNS logs.
DeletePolicy ( array $params = [] ): Permanently deletes an Firewall Manager policy.
DeleteProtocolsList ( array $params = [] ): Permanently deletes an Firewall Manager protocols list.
DeleteResourceSet ( array $params = [] ): Deletes the specified ResourceSet.
DisassociateAdminAccount ( array $params = [] ): Disassociates an Firewall Manager administrator account.
DisassociateThirdPartyFirewall ( array $params = [] ): Disassociates a Firewall Manager policy administrator from a third-party firewall tenant.
GetAdminAccount ( array $params = [] ): Returns the Organizations account that is associated with Firewall Manager as the Firewall Manager default administrator.
GetAdminScope ( array $params = [] ): Returns information about the specified account's administrative scope.
GetAppsList ( array $params = [] ): Returns information about the specified Firewall Manager applications list.
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 Firewall Manager SNS logs.
GetPolicy ( array $params = [] ): Returns information about the specified 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.
GetProtocolsList ( array $params = [] ): Returns information about the specified Firewall Manager protocols list.
GetResourceSet ( array $params = [] ): Gets information about a specific resource set.
GetThirdPartyFirewallAssociationStatus ( array $params = [] ): The onboarding status of a Firewall Manager admin account to third-party firewall vendor tenant.
GetViolationDetails ( array $params = [] ): Retrieves violations for a resource based on the specified Firewall Manager policy and Amazon Web Services account.
ListAdminAccountsForOrganization ( array $params = [] ): Returns a AdminAccounts object that lists the Firewall Manager administrators within the organization that are onboarded to Firewall Manager by AssociateAdminAccount.
ListAdminsManagingAccount ( array $params = [] ): Lists the accounts that are managing the specified Organizations member account.
ListAppsLists ( array $params = [] ): Returns an array of AppsListDataSummary objects.
ListComplianceStatus ( array $params = [] ): Returns an array of PolicyComplianceStatus objects.
ListDiscoveredResources ( array $params = [] ): Returns an array of resources in the organization's accounts that are available to be associated with a resource set.
ListMemberAccounts ( array $params = [] ): Returns a MemberAccounts object that lists the member accounts in the administrator's Amazon Web Services organization.
ListPolicies ( array $params = [] ): Returns an array of PolicySummary objects.
ListProtocolsLists ( array $params = [] ): Returns an array of ProtocolsListDataSummary objects.
ListResourceSetResources ( array $params = [] ): Returns an array of resources that are currently associated to a resource set.
ListResourceSets ( array $params = [] ): Returns an array of ResourceSetSummary objects.
ListTagsForResource ( array $params = [] ): Retrieves the list of tags for the specified Amazon Web Services resource.
ListThirdPartyFirewallFirewallPolicies ( array $params = [] ): Retrieves a list of all of the third-party firewall policies that are associated with the third-party firewall administrator's account.
PutAdminAccount ( array $params = [] ): Creates or updates an Firewall Manager administrator account.
PutAppsList ( array $params = [] ): Creates an Firewall Manager applications list.
PutNotificationChannel ( array $params = [] ): Designates the IAM role and Amazon Simple Notification Service (SNS) topic that Firewall Manager uses to record SNS logs.
PutPolicy ( array $params = [] ): Creates an Firewall Manager policy.
PutProtocolsList ( array $params = [] ): Creates an Firewall Manager protocols list.
PutResourceSet ( array $params = [] ): Creates the resource set.
TagResource ( array $params = [] ): Adds one or more tags to an Amazon Web Services resource.
UntagResource ( array $params = [] ): Removes one or more tags from an Amazon Web Services resource.

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:

ListAdminAccountsForOrganization
ListAdminsManagingAccount
ListAppsLists
ListComplianceStatus
ListMemberAccounts
ListPolicies
ListProtocolsLists
ListThirdPartyFirewallFirewallPolicies

Operations

AssociateAdminAccount

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

Sets a Firewall Manager default administrator account. The Firewall Manager default administrator account can manage third-party firewalls and has full administrative scope that allows administration of all policy types, accounts, organizational units, and Regions. This account must be a member account of the organization in Organizations whose resources you want to protect.

For information about working with Firewall Manager administrator accounts, see Managing Firewall Manager administrators in the Firewall Manager Developer Guide.

Parameter Syntax

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

Parameter Details

Members

AdminAccount

Required: Yes
Type: string

The Amazon Web Services account ID to associate with Firewall Manager as the Firewall Manager default administrator account. This account must be a member account of the organization in Organizations whose resources you want to protect. For more information about Organizations, see Managing the Amazon Web Services 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 or the operation wasn't possible. For example, you might have submitted an AssociateAdminAccount request for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it.
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.
LimitExceededException:
The operation exceeds a resource limit, for example, the maximum number of policy objects that you can create for an Amazon Web Services account. For more information, see Firewall Manager Limits in the WAF Developer Guide.

AssociateThirdPartyFirewall

$result = $client->associateThirdPartyFirewall([/* ... */]);
$promise = $client->associateThirdPartyFirewallAsync([/* ... */]);

Sets the Firewall Manager policy administrator as a tenant administrator of a third-party firewall service. A tenant is an instance of the third-party firewall service that's associated with your Amazon Web Services customer account.

Parameter Syntax

$result = $client->associateThirdPartyFirewall([
    'ThirdPartyFirewall' => 'PALO_ALTO_NETWORKS_CLOUD_NGFW|FORTIGATE_CLOUD_NATIVE_FIREWALL', // REQUIRED
]);

Parameter Details

Members

ThirdPartyFirewall

Required: Yes
Type: string

The name of the third-party firewall vendor.

Result Syntax

[
    'ThirdPartyFirewallStatus' => 'ONBOARDING|ONBOARD_COMPLETE|OFFBOARDING|OFFBOARD_COMPLETE|NOT_EXIST',
]

Result Details

Members

ThirdPartyFirewallStatus

Type: string

The current status for setting a Firewall Manager policy administrator's account as an administrator of the third-party firewall tenant.

ONBOARDING - The Firewall Manager policy administrator is being designated as a tenant administrator.
ONBOARD_COMPLETE - The Firewall Manager policy administrator is designated as a tenant administrator.
OFFBOARDING - The Firewall Manager policy administrator is being removed as a tenant administrator.
OFFBOARD_COMPLETE - The Firewall Manager policy administrator has been removed as a tenant administrator.
NOT_EXIST - The Firewall Manager policy administrator doesn't exist as a tenant administrator.

Errors

InvalidOperationException:
The operation failed because there was nothing to do or the operation wasn't possible. For example, you might have submitted an AssociateAdminAccount request for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it.
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.

BatchAssociateResource

$result = $client->batchAssociateResource([/* ... */]);
$promise = $client->batchAssociateResourceAsync([/* ... */]);

Associate resources to a Firewall Manager resource set.

Parameter Syntax

$result = $client->batchAssociateResource([
    'Items' => ['<string>', ...], // REQUIRED
    'ResourceSetIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Members

Items

Required: Yes
Type: Array of strings

The uniform resource identifiers (URIs) of resources that should be associated to the resource set. The URIs must be Amazon Resource Names (ARNs).

ResourceSetIdentifier

Required: Yes
Type: string

A unique identifier for the resource set, used in a request to refer to the resource set.

Result Syntax

[
    'FailedItems' => [
        [
            'Reason' => 'NOT_VALID_ARN|NOT_VALID_PARTITION|NOT_VALID_REGION|NOT_VALID_SERVICE|NOT_VALID_RESOURCE_TYPE|NOT_VALID_ACCOUNT_ID',
            'URI' => '<string>',
        ],
        // ...
    ],
    'ResourceSetIdentifier' => '<string>',
]

Result Details

Members

FailedItems

Required: Yes
Type: Array of FailedItem structures

The resources that failed to associate to the resource set.

ResourceSetIdentifier

Required: Yes
Type: string

A unique identifier for the resource set, used in a request to refer to the resource set.

Errors

InvalidOperationException:
The operation failed because there was nothing to do or the operation wasn't possible. For example, you might have submitted an AssociateAdminAccount request for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it.
InternalErrorException:
The operation failed because of a system problem, even though the request was valid. Retry your request.
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 Amazon Web Services account. For more information, see Firewall Manager Limits in the WAF Developer Guide.
ResourceNotFoundException:
The specified resource was not found.

BatchDisassociateResource

$result = $client->batchDisassociateResource([/* ... */]);
$promise = $client->batchDisassociateResourceAsync([/* ... */]);

Disassociates resources from a Firewall Manager resource set.

Parameter Syntax

$result = $client->batchDisassociateResource([
    'Items' => ['<string>', ...], // REQUIRED
    'ResourceSetIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Members

Items

Required: Yes
Type: Array of strings

The uniform resource identifiers (URI) of resources that should be disassociated from the resource set. The URIs must be Amazon Resource Names (ARNs).

ResourceSetIdentifier

Required: Yes
Type: string

A unique identifier for the resource set, used in a request to refer to the resource set.

Result Syntax

[
    'FailedItems' => [
        [
            'Reason' => 'NOT_VALID_ARN|NOT_VALID_PARTITION|NOT_VALID_REGION|NOT_VALID_SERVICE|NOT_VALID_RESOURCE_TYPE|NOT_VALID_ACCOUNT_ID',
            'URI' => '<string>',
        ],
        // ...
    ],
    'ResourceSetIdentifier' => '<string>',
]

Result Details

Members

FailedItems

Required: Yes
Type: Array of FailedItem structures

The resources that failed to disassociate from the resource set.

ResourceSetIdentifier

Required: Yes
Type: string

A unique identifier for the resource set, used in a request to refer to the resource set.

Errors

InvalidOperationException:
The operation failed because there was nothing to do or the operation wasn't possible. For example, you might have submitted an AssociateAdminAccount request for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it.
InternalErrorException:
The operation failed because of a system problem, even though the request was valid. Retry your request.
InvalidInputException:
The parameters of the request were invalid.
ResourceNotFoundException:
The specified resource was not found.

DeleteAppsList

$result = $client->deleteAppsList([/* ... */]);
$promise = $client->deleteAppsListAsync([/* ... */]);

Permanently deletes an Firewall Manager applications list.

Parameter Syntax

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

Parameter Details

Members

ListId

Required: Yes
Type: string

The ID of the applications list that you want to delete. You can retrieve this ID from PutAppsList, ListAppsLists, and GetAppsList.

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 or the operation wasn't possible. For example, you might have submitted an AssociateAdminAccount request for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it.
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 Firewall Manager association with the IAM role and the Amazon Simple Notification Service (SNS) topic that is used to record 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 or the operation wasn't possible. For example, you might have submitted an AssociateAdminAccount request for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it.
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 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 WAF and Shield Advanced policies, the cleanup does the following:

Deletes rule groups created by 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

For security group common policies, even if set to False, Firewall Manager deletes all security groups created by Firewall Manager that aren't associated with any other 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. You can retrieve this ID from PutPolicy and 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 or the operation wasn't possible. For example, you might have submitted an AssociateAdminAccount request for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it.
InternalErrorException:
The operation failed because of a system problem, even though the request was valid. Retry your request.
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 Amazon Web Services account. For more information, see Firewall Manager Limits in the WAF Developer Guide.

DeleteProtocolsList

$result = $client->deleteProtocolsList([/* ... */]);
$promise = $client->deleteProtocolsListAsync([/* ... */]);

Permanently deletes an Firewall Manager protocols list.

Parameter Syntax

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

Parameter Details

Members

ListId

Required: Yes
Type: string

The ID of the protocols list that you want to delete. You can retrieve this ID from PutProtocolsList, ListProtocolsLists, and GetProtocolsLost.

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 or the operation wasn't possible. For example, you might have submitted an AssociateAdminAccount request for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it.
InternalErrorException:
The operation failed because of a system problem, even though the request was valid. Retry your request.

DeleteResourceSet

$result = $client->deleteResourceSet([/* ... */]);
$promise = $client->deleteResourceSetAsync([/* ... */]);

Deletes the specified ResourceSet.

Parameter Syntax

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

Parameter Details

Members

Identifier

Required: Yes
Type: string

A unique identifier for the resource set, used in a request to refer to the resource set.

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 or the operation wasn't possible. For example, you might have submitted an AssociateAdminAccount request for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it.
InternalErrorException:
The operation failed because of a system problem, even though the request was valid. Retry your request.
InvalidInputException:
The parameters of the request were invalid.

DisassociateAdminAccount

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

Disassociates an Firewall Manager administrator account. To set a different account as an Firewall Manager administrator, submit a PutAdminAccount request. To set an account as a default administrator account, you must submit an AssociateAdminAccount request.

Disassociation of the default administrator account follows the first in, last out principle. If you are the default administrator, all Firewall Manager administrators within the organization must first disassociate their accounts before you can disassociate your account.

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 or the operation wasn't possible. For example, you might have submitted an AssociateAdminAccount request for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it.
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.

DisassociateThirdPartyFirewall

$result = $client->disassociateThirdPartyFirewall([/* ... */]);
$promise = $client->disassociateThirdPartyFirewallAsync([/* ... */]);

Disassociates a Firewall Manager policy administrator from a third-party firewall tenant. When you call DisassociateThirdPartyFirewall, the third-party firewall vendor deletes all of the firewalls that are associated with the account.

Parameter Syntax

$result = $client->disassociateThirdPartyFirewall([
    'ThirdPartyFirewall' => 'PALO_ALTO_NETWORKS_CLOUD_NGFW|FORTIGATE_CLOUD_NATIVE_FIREWALL', // REQUIRED
]);

Parameter Details

Members

ThirdPartyFirewall

Required: Yes
Type: string

The name of the third-party firewall vendor.

Result Syntax

[
    'ThirdPartyFirewallStatus' => 'ONBOARDING|ONBOARD_COMPLETE|OFFBOARDING|OFFBOARD_COMPLETE|NOT_EXIST',
]

Result Details

Members

ThirdPartyFirewallStatus

Type: string

The current status for the disassociation of a Firewall Manager administrators account with a third-party firewall.

Errors

InvalidOperationException:
The operation failed because there was nothing to do or the operation wasn't possible. For example, you might have submitted an AssociateAdminAccount request for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it.
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.

GetAdminAccount

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

Returns the Organizations account that is associated with Firewall Manager as the Firewall Manager default 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 account that is set as the Firewall Manager default administrator.

RoleStatus

Type: string

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

Errors

InvalidOperationException:
The operation failed because there was nothing to do or the operation wasn't possible. For example, you might have submitted an AssociateAdminAccount request for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it.
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.

GetAdminScope

$result = $client->getAdminScope([/* ... */]);
$promise = $client->getAdminScopeAsync([/* ... */]);

Returns information about the specified account's administrative scope. The administrative scope defines the resources that an Firewall Manager administrator can manage.

Parameter Syntax

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

Parameter Details

Members

AdminAccount

Required: Yes
Type: string

The administrator account that you want to get the details for.

Result Syntax

[
    'AdminScope' => [
        'AccountScope' => [
            'Accounts' => ['<string>', ...],
            'AllAccountsEnabled' => true || false,
            'ExcludeSpecifiedAccounts' => true || false,
        ],
        'OrganizationalUnitScope' => [
            'AllOrganizationalUnitsEnabled' => true || false,
            'ExcludeSpecifiedOrganizationalUnits' => true || false,
            'OrganizationalUnits' => ['<string>', ...],
        ],
        'PolicyTypeScope' => [
            'AllPolicyTypesEnabled' => true || false,
            'PolicyTypes' => ['<string>', ...],
        ],
        'RegionScope' => [
            'AllRegionsEnabled' => true || false,
            'Regions' => ['<string>', ...],
        ],
    ],
    'Status' => 'ONBOARDING|ONBOARDING_COMPLETE|OFFBOARDING|OFFBOARDING_COMPLETE',
]

Result Details

Members

AdminScope

Type: AdminScope structure

Contains details about the administrative scope of the requested account.

Status

Type: string

The current status of the request to onboard a member account as an Firewall Manager administrator.

ONBOARDING - The account is onboarding to Firewall Manager as an administrator.
ONBOARDING_COMPLETE - Firewall Manager The account is onboarded to Firewall Manager as an administrator, and can perform actions on the resources defined in their AdminScope.
OFFBOARDING - The account is being removed as an Firewall Manager administrator.
OFFBOARDING_COMPLETE - The account has been removed as an Firewall Manager administrator.

Errors

InvalidOperationException:
The operation failed because there was nothing to do or the operation wasn't possible. For example, you might have submitted an AssociateAdminAccount request for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it.
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.
LimitExceededException:
The operation exceeds a resource limit, for example, the maximum number of policy objects that you can create for an Amazon Web Services account. For more information, see Firewall Manager Limits in the WAF Developer Guide.

GetAppsList

$result = $client->getAppsList([/* ... */]);
$promise = $client->getAppsListAsync([/* ... */]);

Returns information about the specified Firewall Manager applications list.

Parameter Syntax

$result = $client->getAppsList([
    'DefaultList' => true || false,
    'ListId' => '<string>', // REQUIRED
]);

Parameter Details

Members

DefaultList

Type: boolean

Specifies whether the list to retrieve is a default list owned by Firewall Manager.

ListId

Required: Yes
Type: string

The ID of the Firewall Manager applications list that you want the details for.

Result Syntax

[
    'AppsList' => [
        'AppsList' => [
            [
                'AppName' => '<string>',
                'Port' => <integer>,
                'Protocol' => '<string>',
            ],
            // ...
        ],
        'CreateTime' => <DateTime>,
        'LastUpdateTime' => <DateTime>,
        'ListId' => '<string>',
        'ListName' => '<string>',
        'ListUpdateToken' => '<string>',
        'PreviousAppsList' => [
            '<PreviousListVersion>' => [
                [
                    'AppName' => '<string>',
                    'Port' => <integer>,
                    'Protocol' => '<string>',
                ],
                // ...
            ],
            // ...
        ],
    ],
    'AppsListArn' => '<string>',
]

Result Details

Members

AppsList

Type: AppsListData structure

Information about the specified Firewall Manager applications list.

AppsListArn

Type: string

The Amazon Resource Name (ARN) of the applications list.

Errors

ResourceNotFoundException:
The specified resource was not found.
InvalidOperationException:
The operation failed because there was nothing to do or the operation wasn't possible. For example, you might have submitted an AssociateAdminAccount request for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it.
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.

The reasons for resources being considered compliant depend on the Firewall Manager policy type.

Parameter Syntax

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

Parameter Details

Members

MemberAccount

Required: Yes
Type: string

The Amazon Web Services 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' => [
            [
                'Metadata' => ['<string>', ...],
                '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|FMS_CREATED_SECURITY_GROUP_EDITED|MISSING_FIREWALL|MISSING_FIREWALL_SUBNET_IN_AZ|MISSING_EXPECTED_ROUTE_TABLE|NETWORK_FIREWALL_POLICY_MODIFIED|FIREWALL_SUBNET_IS_OUT_OF_SCOPE|INTERNET_GATEWAY_MISSING_EXPECTED_ROUTE|FIREWALL_SUBNET_MISSING_EXPECTED_ROUTE|UNEXPECTED_FIREWALL_ROUTES|UNEXPECTED_TARGET_GATEWAY_ROUTES|TRAFFIC_INSPECTION_CROSSES_AZ_BOUNDARY|INVALID_ROUTE_CONFIGURATION|MISSING_TARGET_GATEWAY|INTERNET_TRAFFIC_NOT_INSPECTED|BLACK_HOLE_ROUTE_DETECTED|BLACK_HOLE_ROUTE_DETECTED_IN_FIREWALL_SUBNET|RESOURCE_MISSING_DNS_FIREWALL|ROUTE_HAS_OUT_OF_SCOPE_ENDPOINT|FIREWALL_SUBNET_MISSING_VPCE_ENDPOINT|INVALID_NETWORK_ACL_ENTRY',
            ],
            // ...
        ],
    ],
]

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.
InvalidInputException:
The parameters of the request were invalid.
InvalidOperationException:
The operation failed because there was nothing to do or the operation wasn't possible. For example, you might have submitted an AssociateAdminAccount request for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it.

GetNotificationChannel

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

Information about the Amazon Simple Notification Service (SNS) topic that is used to record 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 Firewall Manager to record activity to SNS.

SnsTopicArn

Type: string

The SNS topic that records Firewall Manager activity.

Errors

ResourceNotFoundException:
The specified resource was not found.
InvalidOperationException:
The operation failed because there was nothing to do or the operation wasn't possible. For example, you might have submitted an AssociateAdminAccount request for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it.
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 Firewall Manager policy.

Parameter Syntax

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

Parameter Details

Members

PolicyId

Required: Yes
Type: string

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

Result Syntax

[
    'Policy' => [
        'DeleteUnusedFMManagedResources' => true || false,
        'ExcludeMap' => [
            '<CustomerPolicyScopeIdType>' => ['<string>', ...],
            // ...
        ],
        'ExcludeResourceTags' => true || false,
        'IncludeMap' => [
            '<CustomerPolicyScopeIdType>' => ['<string>', ...],
            // ...
        ],
        'PolicyDescription' => '<string>',
        'PolicyId' => '<string>',
        'PolicyName' => '<string>',
        'PolicyStatus' => 'ACTIVE|OUT_OF_ADMIN_SCOPE',
        'PolicyUpdateToken' => '<string>',
        'RemediationEnabled' => true || false,
        'ResourceSetIds' => ['<string>', ...],
        'ResourceTags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceType' => '<string>',
        'ResourceTypeList' => ['<string>', ...],
        'SecurityServicePolicyData' => [
            'ManagedServiceData' => '<string>',
            'PolicyOption' => [
                'NetworkAclCommonPolicy' => [
                    'NetworkAclEntrySet' => [
                        'FirstEntries' => [
                            [
                                'CidrBlock' => '<string>',
                                'Egress' => true || false,
                                'IcmpTypeCode' => [
                                    'Code' => <integer>,
                                    'Type' => <integer>,
                                ],
                                'Ipv6CidrBlock' => '<string>',
                                'PortRange' => [
                                    'From' => <integer>,
                                    'To' => <integer>,
                                ],
                                'Protocol' => '<string>',
                                'RuleAction' => 'allow|deny',
                            ],
                            // ...
                        ],
                        'ForceRemediateForFirstEntries' => true || false,
                        'ForceRemediateForLastEntries' => true || false,
                        'LastEntries' => [
                            [
                                'CidrBlock' => '<string>',
                                'Egress' => true || false,
                                'IcmpTypeCode' => [
                                    'Code' => <integer>,
                                    'Type' => <integer>,
                                ],
                                'Ipv6CidrBlock' => '<string>',
                                'PortRange' => [
                                    'From' => <integer>,
                                    'To' => <integer>,
                                ],
                                'Protocol' => '<string>',
                                'RuleAction' => 'allow|deny',
                            ],
                            // ...
                        ],
                    ],
                ],
                'NetworkFirewallPolicy' => [
                    'FirewallDeploymentModel' => 'CENTRALIZED|DISTRIBUTED',
                ],
                'ThirdPartyFirewallPolicy' => [
                    'FirewallDeploymentModel' => 'CENTRALIZED|DISTRIBUTED',
                ],
            ],
            'Type' => 'WAF|WAFV2|SHIELD_ADVANCED|SECURITY_GROUPS_COMMON|SECURITY_GROUPS_CONTENT_AUDIT|SECURITY_GROUPS_USAGE_AUDIT|NETWORK_FIREWALL|DNS_FIREWALL|THIRD_PARTY_FIREWALL|IMPORT_NETWORK_FIREWALL|NETWORK_ACL_COMMON',
        ],
    ],
    'PolicyArn' => '<string>',
]

Result Details

Members

Policy

Type: Policy structure

Information about the specified 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 or the operation wasn't possible. For example, you might have submitted an AssociateAdminAccount request for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it.
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 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 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 Amazon Web Services 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, 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 Firewall Manager is Unix time in seconds. However, any valid timestamp format is allowed.

Result Syntax

[
    'AdminAccountId' => '<string>',
    'Data' => '<string>',
    'NextToken' => '<string>',
    'ServiceType' => 'WAF|WAFV2|SHIELD_ADVANCED|SECURITY_GROUPS_COMMON|SECURITY_GROUPS_CONTENT_AUDIT|SECURITY_GROUPS_USAGE_AUDIT|NETWORK_FIREWALL|DNS_FIREWALL|THIRD_PARTY_FIREWALL|IMPORT_NETWORK_FIREWALL|NETWORK_ACL_COMMON',
]

Result Details

Members

AdminAccountId

Type: string

The ID of the Firewall Manager 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.

Amazon Web Services 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.

GetProtocolsList

$result = $client->getProtocolsList([/* ... */]);
$promise = $client->getProtocolsListAsync([/* ... */]);

Returns information about the specified Firewall Manager protocols list.

Parameter Syntax

$result = $client->getProtocolsList([
    'DefaultList' => true || false,
    'ListId' => '<string>', // REQUIRED
]);

Parameter Details

Members

DefaultList

Type: boolean

Specifies whether the list to retrieve is a default list owned by Firewall Manager.

ListId

Required: Yes
Type: string

The ID of the Firewall Manager protocols list that you want the details for.

Result Syntax

[
    'ProtocolsList' => [
        'CreateTime' => <DateTime>,
        'LastUpdateTime' => <DateTime>,
        'ListId' => '<string>',
        'ListName' => '<string>',
        'ListUpdateToken' => '<string>',
        'PreviousProtocolsList' => [
            '<PreviousListVersion>' => ['<string>', ...],
            // ...
        ],
        'ProtocolsList' => ['<string>', ...],
    ],
    'ProtocolsListArn' => '<string>',
]

Result Details

Members

ProtocolsList

Type: ProtocolsListData structure

Information about the specified Firewall Manager protocols list.

ProtocolsListArn

Type: string

The Amazon Resource Name (ARN) of the specified protocols list.

Errors

ResourceNotFoundException:
The specified resource was not found.
InvalidOperationException:
The operation failed because there was nothing to do or the operation wasn't possible. For example, you might have submitted an AssociateAdminAccount request for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it.
InternalErrorException:
The operation failed because of a system problem, even though the request was valid. Retry your request.

GetResourceSet

$result = $client->getResourceSet([/* ... */]);
$promise = $client->getResourceSetAsync([/* ... */]);

Gets information about a specific resource set.

Parameter Syntax

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

Parameter Details

Members

Identifier

Required: Yes
Type: string

A unique identifier for the resource set, used in a request to refer to the resource set.

Result Syntax

[
    'ResourceSet' => [
        'Description' => '<string>',
        'Id' => '<string>',
        'LastUpdateTime' => <DateTime>,
        'Name' => '<string>',
        'ResourceSetStatus' => 'ACTIVE|OUT_OF_ADMIN_SCOPE',
        'ResourceTypeList' => ['<string>', ...],
        'UpdateToken' => '<string>',
    ],
    'ResourceSetArn' => '<string>',
]

Result Details

Members

ResourceSet

Required: Yes
Type: ResourceSet structure

Information about the specified resource set.

ResourceSetArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the resource set.

Errors

InvalidOperationException:
The operation failed because there was nothing to do or the operation wasn't possible. For example, you might have submitted an AssociateAdminAccount request for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it.
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.

GetThirdPartyFirewallAssociationStatus

$result = $client->getThirdPartyFirewallAssociationStatus([/* ... */]);
$promise = $client->getThirdPartyFirewallAssociationStatusAsync([/* ... */]);

The onboarding status of a Firewall Manager admin account to third-party firewall vendor tenant.

Parameter Syntax

$result = $client->getThirdPartyFirewallAssociationStatus([
    'ThirdPartyFirewall' => 'PALO_ALTO_NETWORKS_CLOUD_NGFW|FORTIGATE_CLOUD_NATIVE_FIREWALL', // REQUIRED
]);

Parameter Details

Members

ThirdPartyFirewall

Required: Yes
Type: string

The name of the third-party firewall vendor.

Result Syntax

[
    'MarketplaceOnboardingStatus' => 'NO_SUBSCRIPTION|NOT_COMPLETE|COMPLETE',
    'ThirdPartyFirewallStatus' => 'ONBOARDING|ONBOARD_COMPLETE|OFFBOARDING|OFFBOARD_COMPLETE|NOT_EXIST',
]

Result Details

Members

MarketplaceOnboardingStatus

Type: string

The status for subscribing to the third-party firewall vendor in the Amazon Web Services Marketplace.

NO_SUBSCRIPTION - The Firewall Manager policy administrator isn't subscribed to the third-party firewall service in the Amazon Web Services Marketplace.
NOT_COMPLETE - The Firewall Manager policy administrator is in the process of subscribing to the third-party firewall service in the Amazon Web Services Marketplace, but doesn't yet have an active subscription.
COMPLETE - The Firewall Manager policy administrator has an active subscription to the third-party firewall service in the Amazon Web Services Marketplace.

ThirdPartyFirewallStatus

Type: string

The current status for setting a Firewall Manager policy administrators account as an administrator of the third-party firewall tenant.

ONBOARDING - The Firewall Manager policy administrator is being designated as a tenant administrator.
ONBOARD_COMPLETE - The Firewall Manager policy administrator is designated as a tenant administrator.
OFFBOARDING - The Firewall Manager policy administrator is being removed as a tenant administrator.
OFFBOARD_COMPLETE - The Firewall Manager policy administrator has been removed as a tenant administrator.
NOT_EXIST - The Firewall Manager policy administrator doesn't exist as a tenant administrator.

Errors

InvalidOperationException:
The operation failed because there was nothing to do or the operation wasn't possible. For example, you might have submitted an AssociateAdminAccount request for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it.
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.

GetViolationDetails

$result = $client->getViolationDetails([/* ... */]);
$promise = $client->getViolationDetailsAsync([/* ... */]);

Retrieves violations for a resource based on the specified Firewall Manager policy and Amazon Web Services account.

Parameter Syntax

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

Parameter Details

Members

MemberAccount

Required: Yes
Type: string

The Amazon Web Services account ID that you want the details for.

PolicyId

Required: Yes
Type: string

The ID of the Firewall Manager policy that you want the details for. You can get violation details for the following policy types:

DNS Firewall
Imported Network Firewall
Network Firewall
Security group content audit
Network ACL
Third-party firewall

ResourceId

Required: Yes
Type: string

The ID of the resource that has violations.

ResourceType

Required: Yes
Type: string

The resource type. This is in the format shown in the Amazon Web Services Resource Types Reference. Supported resource types are: AWS::EC2::Instance, AWS::EC2::NetworkInterface, AWS::EC2::SecurityGroup, AWS::NetworkFirewall::FirewallPolicy, and AWS::EC2::Subnet.

Result Syntax

[
    'ViolationDetail' => [
        'MemberAccount' => '<string>',
        'PolicyId' => '<string>',
        'ResourceDescription' => '<string>',
        'ResourceId' => '<string>',
        'ResourceTags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceType' => '<string>',
        'ResourceViolations' => [
            [
                'AwsEc2InstanceViolation' => [
                    'AwsEc2NetworkInterfaceViolations' => [
                        [
                            'ViolatingSecurityGroups' => ['<string>', ...],
                            'ViolationTarget' => '<string>',
                        ],
                        // ...
                    ],
                    'ViolationTarget' => '<string>',
                ],
                'AwsEc2NetworkInterfaceViolation' => [
                    'ViolatingSecurityGroups' => ['<string>', ...],
                    'ViolationTarget' => '<string>',
                ],
                'AwsVPCSecurityGroupViolation' => [
                    'PartialMatches' => [
                        [
                            'Reference' => '<string>',
                            'TargetViolationReasons' => ['<string>', ...],
                        ],
                        // ...
                    ],
                    'PossibleSecurityGroupRemediationActions' => [
                        [
                            'Description' => '<string>',
                            'IsDefaultAction' => true || false,
                            'RemediationActionType' => 'REMOVE|MODIFY',
                            'RemediationResult' => [
                                'FromPort' => <integer>,
                                'IPV4Range' => '<string>',
                                'IPV6Range' => '<string>',
                                'PrefixListId' => '<string>',
                                'Protocol' => '<string>',
                                'ToPort' => <integer>,
                            ],
                        ],
                        // ...
                    ],
                    'ViolationTarget' => '<string>',
                    'ViolationTargetDescription' => '<string>',
                ],
                'DnsDuplicateRuleGroupViolation' => [
                    'ViolationTarget' => '<string>',
                    'ViolationTargetDescription' => '<string>',
                ],
                'DnsRuleGroupLimitExceededViolation' => [
                    'NumberOfRuleGroupsAlreadyAssociated' => <integer>,
                    'ViolationTarget' => '<string>',
                    'ViolationTargetDescription' => '<string>',
                ],
                'DnsRuleGroupPriorityConflictViolation' => [
                    'ConflictingPolicyId' => '<string>',
                    'ConflictingPriority' => <integer>,
                    'UnavailablePriorities' => [<integer>, ...],
                    'ViolationTarget' => '<string>',
                    'ViolationTargetDescription' => '<string>',
                ],
                'FirewallSubnetIsOutOfScopeViolation' => [
                    'FirewallSubnetId' => '<string>',
                    'SubnetAvailabilityZone' => '<string>',
                    'SubnetAvailabilityZoneId' => '<string>',
                    'VpcEndpointId' => '<string>',
                    'VpcId' => '<string>',
                ],
                'FirewallSubnetMissingVPCEndpointViolation' => [
                    'FirewallSubnetId' => '<string>',
                    'SubnetAvailabilityZone' => '<string>',
                    'SubnetAvailabilityZoneId' => '<string>',
                    'VpcId' => '<string>',
                ],
                'InvalidNetworkAclEntriesViolation' => [
                    'CurrentAssociatedNetworkAcl' => '<string>',
                    'EntryViolations' => [
                        [
                            'ActualEvaluationOrder' => '<string>',
                            'EntriesWithConflicts' => [
                                [
                                    'EntryDetail' => [
                                        'CidrBlock' => '<string>',
                                        'Egress' => true || false,
                                        'IcmpTypeCode' => [
                                            'Code' => <integer>,
                                            'Type' => <integer>,
                                        ],
                                        'Ipv6CidrBlock' => '<string>',
                                        'PortRange' => [
                                            'From' => <integer>,
                                            'To' => <integer>,
                                        ],
                                        'Protocol' => '<string>',
                                        'RuleAction' => 'allow|deny',
                                    ],
                                    'EntryRuleNumber' => <integer>,
                                    'EntryType' => 'FMS_MANAGED_FIRST_ENTRY|FMS_MANAGED_LAST_ENTRY|CUSTOM_ENTRY',
                                ],
                                // ...
                            ],
                            'EntryAtExpectedEvaluationOrder' => [
                                'EntryDetail' => [
                                    'CidrBlock' => '<string>',
                                    'Egress' => true || false,
                                    'IcmpTypeCode' => [
                                        'Code' => <integer>,
                                        'Type' => <integer>,
                                    ],
                                    'Ipv6CidrBlock' => '<string>',
                                    'PortRange' => [
                                        'From' => <integer>,
                                        'To' => <integer>,
                                    ],
                                    'Protocol' => '<string>',
                                    'RuleAction' => 'allow|deny',
                                ],
                                'EntryRuleNumber' => <integer>,
                                'EntryType' => 'FMS_MANAGED_FIRST_ENTRY|FMS_MANAGED_LAST_ENTRY|CUSTOM_ENTRY',
                            ],
                            'EntryViolationReasons' => ['<string>', ...],
                            'ExpectedEntry' => [
                                'EntryDetail' => [
                                    'CidrBlock' => '<string>',
                                    'Egress' => true || false,
                                    'IcmpTypeCode' => [
                                        'Code' => <integer>,
                                        'Type' => <integer>,
                                    ],
                                    'Ipv6CidrBlock' => '<string>',
                                    'PortRange' => [
                                        'From' => <integer>,
                                        'To' => <integer>,
                                    ],
                                    'Protocol' => '<string>',
                                    'RuleAction' => 'allow|deny',
                                ],
                                'EntryRuleNumber' => <integer>,
                                'EntryType' => 'FMS_MANAGED_FIRST_ENTRY|FMS_MANAGED_LAST_ENTRY|CUSTOM_ENTRY',
                            ],
                            'ExpectedEvaluationOrder' => '<string>',
                        ],
                        // ...
                    ],
                    'Subnet' => '<string>',
                    'SubnetAvailabilityZone' => '<string>',
                    'Vpc' => '<string>',
                ],
                'NetworkFirewallBlackHoleRouteDetectedViolation' => [
                    'RouteTableId' => '<string>',
                    'ViolatingRoutes' => [
                        [
                            'Destination' => '<string>',
                            'DestinationType' => 'IPV4|IPV6|PREFIX_LIST',
                            'Target' => '<string>',
                            'TargetType' => 'GATEWAY|CARRIER_GATEWAY|INSTANCE|LOCAL_GATEWAY|NAT_GATEWAY|NETWORK_INTERFACE|VPC_ENDPOINT|VPC_PEERING_CONNECTION|EGRESS_ONLY_INTERNET_GATEWAY|TRANSIT_GATEWAY',
                        ],
                        // ...
                    ],
                    'ViolationTarget' => '<string>',
                    'VpcId' => '<string>',
                ],
                'NetworkFirewallInternetTrafficNotInspectedViolation' => [
                    'ActualFirewallSubnetRoutes' => [
                        [
                            'Destination' => '<string>',
                            'DestinationType' => 'IPV4|IPV6|PREFIX_LIST',
                            'Target' => '<string>',
                            'TargetType' => 'GATEWAY|CARRIER_GATEWAY|INSTANCE|LOCAL_GATEWAY|NAT_GATEWAY|NETWORK_INTERFACE|VPC_ENDPOINT|VPC_PEERING_CONNECTION|EGRESS_ONLY_INTERNET_GATEWAY|TRANSIT_GATEWAY',
                        ],
                        // ...
                    ],
                    'ActualInternetGatewayRoutes' => [
                        [
                            'Destination' => '<string>',
                            'DestinationType' => 'IPV4|IPV6|PREFIX_LIST',
                            'Target' => '<string>',
                            'TargetType' => 'GATEWAY|CARRIER_GATEWAY|INSTANCE|LOCAL_GATEWAY|NAT_GATEWAY|NETWORK_INTERFACE|VPC_ENDPOINT|VPC_PEERING_CONNECTION|EGRESS_ONLY_INTERNET_GATEWAY|TRANSIT_GATEWAY',
                        ],
                        // ...
                    ],
                    'CurrentFirewallSubnetRouteTable' => '<string>',
                    'CurrentInternetGatewayRouteTable' => '<string>',
                    'ExpectedFirewallEndpoint' => '<string>',
                    'ExpectedFirewallSubnetRoutes' => [
                        [
                            'AllowedTargets' => ['<string>', ...],
                            'ContributingSubnets' => ['<string>', ...],
                            'IpV4Cidr' => '<string>',
                            'IpV6Cidr' => '<string>',
                            'PrefixListId' => '<string>',
                            'RouteTableId' => '<string>',
                        ],
                        // ...
                    ],
                    'ExpectedInternetGatewayRoutes' => [
                        [
                            'AllowedTargets' => ['<string>', ...],
                            'ContributingSubnets' => ['<string>', ...],
                            'IpV4Cidr' => '<string>',
                            'IpV6Cidr' => '<string>',
                            'PrefixListId' => '<string>',
                            'RouteTableId' => '<string>',
                        ],
                        // ...
                    ],
                    'FirewallSubnetId' => '<string>',
                    'InternetGatewayId' => '<string>',
                    'IsRouteTableUsedInDifferentAZ' => true || false,
                    'RouteTableId' => '<string>',
                    'SubnetAvailabilityZone' => '<string>',
                    'SubnetId' => '<string>',
                    'ViolatingRoutes' => [
                        [
                            'Destination' => '<string>',
                            'DestinationType' => 'IPV4|IPV6|PREFIX_LIST',
                            'Target' => '<string>',
                            'TargetType' => 'GATEWAY|CARRIER_GATEWAY|INSTANCE|LOCAL_GATEWAY|NAT_GATEWAY|NETWORK_INTERFACE|VPC_ENDPOINT|VPC_PEERING_CONNECTION|EGRESS_ONLY_INTERNET_GATEWAY|TRANSIT_GATEWAY',
                        ],
                        // ...
                    ],
                    'VpcId' => '<string>',
                ],
                'NetworkFirewallInvalidRouteConfigurationViolation' => [
                    'ActualFirewallEndpoint' => '<string>',
                    'ActualFirewallSubnetId' => '<string>',
                    'ActualFirewallSubnetRoutes' => [
                        [
                            'Destination' => '<string>',
                            'DestinationType' => 'IPV4|IPV6|PREFIX_LIST',
                            'Target' => '<string>',
                            'TargetType' => 'GATEWAY|CARRIER_GATEWAY|INSTANCE|LOCAL_GATEWAY|NAT_GATEWAY|NETWORK_INTERFACE|VPC_ENDPOINT|VPC_PEERING_CONNECTION|EGRESS_ONLY_INTERNET_GATEWAY|TRANSIT_GATEWAY',
                        ],
                        // ...
                    ],
                    'ActualInternetGatewayRoutes' => [
                        [
                            'Destination' => '<string>',
                            'DestinationType' => 'IPV4|IPV6|PREFIX_LIST',
                            'Target' => '<string>',
                            'TargetType' => 'GATEWAY|CARRIER_GATEWAY|INSTANCE|LOCAL_GATEWAY|NAT_GATEWAY|NETWORK_INTERFACE|VPC_ENDPOINT|VPC_PEERING_CONNECTION|EGRESS_ONLY_INTERNET_GATEWAY|TRANSIT_GATEWAY',
                        ],
                        // ...
                    ],
                    'AffectedSubnets' => ['<string>', ...],
                    'CurrentFirewallSubnetRouteTable' => '<string>',
                    'CurrentInternetGatewayRouteTable' => '<string>',
                    'ExpectedFirewallEndpoint' => '<string>',
                    'ExpectedFirewallSubnetId' => '<string>',
                    'ExpectedFirewallSubnetRoutes' => [
                        [
                            'AllowedTargets' => ['<string>', ...],
                            'ContributingSubnets' => ['<string>', ...],
                            'IpV4Cidr' => '<string>',
                            'IpV6Cidr' => '<string>',
                            'PrefixListId' => '<string>',
                            'RouteTableId' => '<string>',
                        ],
                        // ...
                    ],
                    'ExpectedInternetGatewayRoutes' => [
                        [
                            'AllowedTargets' => ['<string>', ...],
                            'ContributingSubnets' => ['<string>', ...],
                            'IpV4Cidr' => '<string>',
                            'IpV6Cidr' => '<string>',
                            'PrefixListId' => '<string>',
                            'RouteTableId' => '<string>',
                        ],
                        // ...
                    ],
                    'InternetGatewayId' => '<string>',
                    'IsRouteTableUsedInDifferentAZ' => true || false,
                    'RouteTableId' => '<string>',
                    'ViolatingRoute' => [
                        'Destination' => '<string>',
                        'DestinationType' => 'IPV4|IPV6|PREFIX_LIST',
                        'Target' => '<string>',
                        'TargetType' => 'GATEWAY|CARRIER_GATEWAY|INSTANCE|LOCAL_GATEWAY|NAT_GATEWAY|NETWORK_INTERFACE|VPC_ENDPOINT|VPC_PEERING_CONNECTION|EGRESS_ONLY_INTERNET_GATEWAY|TRANSIT_GATEWAY',
                    ],
                    'VpcId' => '<string>',
                ],
                'NetworkFirewallMissingExpectedRTViolation' => [
                    'AvailabilityZone' => '<string>',
                    'CurrentRouteTable' => '<string>',
                    'ExpectedRouteTable' => '<string>',
                    'VPC' => '<string>',
                    'ViolationTarget' => '<string>',
                ],
                'NetworkFirewallMissingExpectedRoutesViolation' => [
                    'ExpectedRoutes' => [
                        [
                            'AllowedTargets' => ['<string>', ...],
                            'ContributingSubnets' => ['<string>', ...],
                            'IpV4Cidr' => '<string>',
                            'IpV6Cidr' => '<string>',
                            'PrefixListId' => '<string>',
                            'RouteTableId' => '<string>',
                        ],
                        // ...
                    ],
                    'ViolationTarget' => '<string>',
                    'VpcId' => '<string>',
                ],
                'NetworkFirewallMissingFirewallViolation' => [
                    'AvailabilityZone' => '<string>',
                    'TargetViolationReason' => '<string>',
                    'VPC' => '<string>',
                    'ViolationTarget' => '<string>',
                ],
                'NetworkFirewallMissingSubnetViolation' => [
                    'AvailabilityZone' => '<string>',
                    'TargetViolationReason' => '<string>',
                    'VPC' => '<string>',
                    'ViolationTarget' => '<string>',
                ],
                'NetworkFirewallPolicyModifiedViolation' => [
                    'CurrentPolicyDescription' => [
                        'StatefulDefaultActions' => ['<string>', ...],
                        'StatefulEngineOptions' => [
                            'RuleOrder' => 'STRICT_ORDER|DEFAULT_ACTION_ORDER',
                            'StreamExceptionPolicy' => 'DROP|CONTINUE|REJECT|FMS_IGNORE',
                        ],
                        'StatefulRuleGroups' => [
                            [
                                'Override' => [
                                    'Action' => 'DROP_TO_ALERT',
                                ],
                                'Priority' => <integer>,
                                'ResourceId' => '<string>',
                                'RuleGroupName' => '<string>',
                            ],
                            // ...
                        ],
                        'StatelessCustomActions' => ['<string>', ...],
                        'StatelessDefaultActions' => ['<string>', ...],
                        'StatelessFragmentDefaultActions' => ['<string>', ...],
                        'StatelessRuleGroups' => [
                            [
                                'Priority' => <integer>,
                                'ResourceId' => '<string>',
                                'RuleGroupName' => '<string>',
                            ],
                            // ...
                        ],
                    ],
                    'ExpectedPolicyDescription' => [
                        'StatefulDefaultActions' => ['<string>', ...],
                        'StatefulEngineOptions' => [
                            'RuleOrder' => 'STRICT_ORDER|DEFAULT_ACTION_ORDER',
                            'StreamExceptionPolicy' => 'DROP|CONTINUE|REJECT|FMS_IGNORE',
                        ],
                        'StatefulRuleGroups' => [
                            [
                                'Override' => [
                                    'Action' => 'DROP_TO_ALERT',
                                ],
                                'Priority' => <integer>,
                                'ResourceId' => '<string>',
                                'RuleGroupName' => '<string>',
                            ],
                            // ...
                        ],
                        'StatelessCustomActions' => ['<string>', ...],
                        'StatelessDefaultActions' => ['<string>', ...],
                        'StatelessFragmentDefaultActions' => ['<string>', ...],
                        'StatelessRuleGroups' => [
                            [
                                'Priority' => <integer>,
                                'ResourceId' => '<string>',
                                'RuleGroupName' => '<string>',
                            ],
                            // ...
                        ],
                    ],
                    'ViolationTarget' => '<string>',
                ],
                'NetworkFirewallUnexpectedFirewallRoutesViolation' => [
                    'FirewallEndpoint' => '<string>',
                    'FirewallSubnetId' => '<string>',
                    'RouteTableId' => '<string>',
                    'ViolatingRoutes' => [
                        [
                            'Destination' => '<string>',
                            'DestinationType' => 'IPV4|IPV6|PREFIX_LIST',
                            'Target' => '<string>',
                            'TargetType' => 'GATEWAY|CARRIER_GATEWAY|INSTANCE|LOCAL_GATEWAY|NAT_GATEWAY|NETWORK_INTERFACE|VPC_ENDPOINT|VPC_PEERING_CONNECTION|EGRESS_ONLY_INTERNET_GATEWAY|TRANSIT_GATEWAY',
                        ],
                        // ...
                    ],
                    'VpcId' => '<string>',
                ],
                'NetworkFirewallUnexpectedGatewayRoutesViolation' => [
                    'GatewayId' => '<string>',
                    'RouteTableId' => '<string>',
                    'ViolatingRoutes' => [
                        [
                            'Destination' => '<string>',
                            'DestinationType' => 'IPV4|IPV6|PREFIX_LIST',
                            'Target' => '<string>',
                            'TargetType' => 'GATEWAY|CARRIER_GATEWAY|INSTANCE|LOCAL_GATEWAY|NAT_GATEWAY|NETWORK_INTERFACE|VPC_ENDPOINT|VPC_PEERING_CONNECTION|EGRESS_ONLY_INTERNET_GATEWAY|TRANSIT_GATEWAY',
                        ],
                        // ...
                    ],
                    'VpcId' => '<string>',
                ],
                'PossibleRemediationActions' => [
                    'Actions' => [
                        [
                            'Description' => '<string>',
                            'IsDefaultAction' => true || false,
                            'OrderedRemediationActions' => [
                                [
                                    'Order' => <integer>,
                                    'RemediationAction' => [
                                        'CreateNetworkAclAction' => [
                                            'Description' => '<string>',
                                            'FMSCanRemediate' => true || false,
                                            'Vpc' => [
                                                'Description' => '<string>',
                                                'ResourceId' => '<string>',
                                            ],
                                        ],
                                        'CreateNetworkAclEntriesAction' => [
                                            'Description' => '<string>',
                                            'FMSCanRemediate' => true || false,
                                            'NetworkAclEntriesToBeCreated' => [
                                                [
                                                    'EntryDetail' => [
                                                        'CidrBlock' => '<string>',
                                                        'Egress' => true || false,
                                                        'IcmpTypeCode' => [
                                                            'Code' => <integer>,
                                                            'Type' => <integer>,
                                                        ],
                                                        'Ipv6CidrBlock' => '<string>',
                                                        'PortRange' => [
                                                            'From' => <integer>,
                                                            'To' => <integer>,
                                                        ],
                                                        'Protocol' => '<string>',
                                                        'RuleAction' => 'allow|deny',
                                                    ],
                                                    'EntryRuleNumber' => <integer>,
                                                    'EntryType' => 'FMS_MANAGED_FIRST_ENTRY|FMS_MANAGED_LAST_ENTRY|CUSTOM_ENTRY',
                                                ],
                                                // ...
                                            ],
                                            'NetworkAclId' => [
                                                'Description' => '<string>',
                                                'ResourceId' => '<string>',
                                            ],
                                        ],
                                        'DeleteNetworkAclEntriesAction' => [
                                            'Description' => '<string>',
                                            'FMSCanRemediate' => true || false,
                                            'NetworkAclEntriesToBeDeleted' => [
                                                [
                                                    'EntryDetail' => [
                                                        'CidrBlock' => '<string>',
                                                        'Egress' => true || false,
                                                        'IcmpTypeCode' => [
                                                            'Code' => <integer>,
                                                            'Type' => <integer>,
                                                        ],
                                                        'Ipv6CidrBlock' => '<string>',
                                                        'PortRange' => [
                                                            'From' => <integer>,
                                                            'To' => <integer>,
                                                        ],
                                                        'Protocol' => '<string>',
                                                        'RuleAction' => 'allow|deny',
                                                    ],
                                                    'EntryRuleNumber' => <integer>,
                                                    'EntryType' => 'FMS_MANAGED_FIRST_ENTRY|FMS_MANAGED_LAST_ENTRY|CUSTOM_ENTRY',
                                                ],
                                                // ...
                                            ],
                                            'NetworkAclId' => [
                                                'Description' => '<string>',
                                                'ResourceId' => '<string>',
                                            ],
                                        ],
                                        'Description' => '<string>',
                                        'EC2AssociateRouteTableAction' => [
                                            'Description' => '<string>',
                                            'GatewayId' => [
                                                'Description' => '<string>',
                                                'ResourceId' => '<string>',
                                            ],
                                            'RouteTableId' => [
                                                'Description' => '<string>',
                                                'ResourceId' => '<string>',
                                            ],
                                            'SubnetId' => [
                                                'Description' => '<string>',
                                                'ResourceId' => '<string>',
                                            ],
                                        ],
                                        'EC2CopyRouteTableAction' => [
                                            'Description' => '<string>',
                                            'RouteTableId' => [
                                                'Description' => '<string>',
                                                'ResourceId' => '<string>',
                                            ],
                                            'VpcId' => [
                                                'Description' => '<string>',
                                                'ResourceId' => '<string>',
                                            ],
                                        ],
                                        'EC2CreateRouteAction' => [
                                            'Description' => '<string>',
                                            'DestinationCidrBlock' => '<string>',
                                            'DestinationIpv6CidrBlock' => '<string>',
                                            'DestinationPrefixListId' => '<string>',
                                            'GatewayId' => [
                                                'Description' => '<string>',
                                                'ResourceId' => '<string>',
                                            ],
                                            'RouteTableId' => [
                                                'Description' => '<string>',
                                                'ResourceId' => '<string>',
                                            ],
                                            'VpcEndpointId' => [
                                                'Description' => '<string>',
                                                'ResourceId' => '<string>',
                                            ],
                                        ],
                                        'EC2CreateRouteTableAction' => [
                                            'Description' => '<string>',
                                            'VpcId' => [
                                                'Description' => '<string>',
                                                'ResourceId' => '<string>',
                                            ],
                                        ],
                                        'EC2DeleteRouteAction' => [
                                            'Description' => '<string>',
                                            'DestinationCidrBlock' => '<string>',
                                            'DestinationIpv6CidrBlock' => '<string>',
                                            'DestinationPrefixListId' => '<string>',
                                            'RouteTableId' => [
                                                'Description' => '<string>',
                                                'ResourceId' => '<string>',
                                            ],
                                        ],
                                        'EC2ReplaceRouteAction' => [
                                            'Description' => '<string>',
                                            'DestinationCidrBlock' => '<string>',
                                            'DestinationIpv6CidrBlock' => '<string>',
                                            'DestinationPrefixListId' => '<string>',
                                            'GatewayId' => [
                                                'Description' => '<string>',
                                                'ResourceId' => '<string>',
                                            ],
                                            'RouteTableId' => [
                                                'Description' => '<string>',
                                                'ResourceId' => '<string>',
                                            ],
                                        ],
                                        'EC2ReplaceRouteTableAssociationAction' => [
                                            'AssociationId' => [
                                                'Description' => '<string>',
                                                'ResourceId' => '<string>',
                                            ],
                                            'Description' => '<string>',
                                            'RouteTableId' => [
                                                'Description' => '<string>',
                                                'ResourceId' => '<string>',
                                            ],
                                        ],
                                        'FMSPolicyUpdateFirewallCreationConfigAction' => [
                                            'Description' => '<string>',
                                            'FirewallCreationConfig' => '<string>',
                                        ],
                                        'ReplaceNetworkAclAssociationAction' => [
                                            'AssociationId' => [
                                                'Description' => '<string>',
                                                'ResourceId' => '<string>',
                                            ],
                                            'Description' => '<string>',
                                            'FMSCanRemediate' => true || false,
                                            'NetworkAclId' => [
                                                'Description' => '<string>',
                                                'ResourceId' => '<string>',
                                            ],
                                        ],
                                    ],
                                ],
                                // ...
                            ],
                        ],
                        // ...
                    ],
                    'Description' => '<string>',
                ],
                'RouteHasOutOfScopeEndpointViolation' => [
                    'CurrentFirewallSubnetRouteTable' => '<string>',
                    'CurrentInternetGatewayRouteTable' => '<string>',
                    'FirewallSubnetId' => '<string>',
                    'FirewallSubnetRoutes' => [
                        [
                            'Destination' => '<string>',
                            'DestinationType' => 'IPV4|IPV6|PREFIX_LIST',
                            'Target' => '<string>',
                            'TargetType' => 'GATEWAY|CARRIER_GATEWAY|INSTANCE|LOCAL_GATEWAY|NAT_GATEWAY|NETWORK_INTERFACE|VPC_ENDPOINT|VPC_PEERING_CONNECTION|EGRESS_ONLY_INTERNET_GATEWAY|TRANSIT_GATEWAY',
                        ],
                        // ...
                    ],
                    'InternetGatewayId' => '<string>',
                    'InternetGatewayRoutes' => [
                        [
                            'Destination' => '<string>',
                            'DestinationType' => 'IPV4|IPV6|PREFIX_LIST',
                            'Target' => '<string>',
                            'TargetType' => 'GATEWAY|CARRIER_GATEWAY|INSTANCE|LOCAL_GATEWAY|NAT_GATEWAY|NETWORK_INTERFACE|VPC_ENDPOINT|VPC_PEERING_CONNECTION|EGRESS_ONLY_INTERNET_GATEWAY|TRANSIT_GATEWAY',
                        ],
                        // ...
                    ],
                    'RouteTableId' => '<string>',
                    'SubnetAvailabilityZone' => '<string>',
                    'SubnetAvailabilityZoneId' => '<string>',
                    'SubnetId' => '<string>',
                    'ViolatingRoutes' => [
                        [
                            'Destination' => '<string>',
                            'DestinationType' => 'IPV4|IPV6|PREFIX_LIST',
                            'Target' => '<string>',
                            'TargetType' => 'GATEWAY|CARRIER_GATEWAY|INSTANCE|LOCAL_GATEWAY|NAT_GATEWAY|NETWORK_INTERFACE|VPC_ENDPOINT|VPC_PEERING_CONNECTION|EGRESS_ONLY_INTERNET_GATEWAY|TRANSIT_GATEWAY',
                        ],
                        // ...
                    ],
                    'VpcId' => '<string>',
                ],
                'ThirdPartyFirewallMissingExpectedRouteTableViolation' => [
                    'AvailabilityZone' => '<string>',
                    'CurrentRouteTable' => '<string>',
                    'ExpectedRouteTable' => '<string>',
                    'VPC' => '<string>',
                    'ViolationTarget' => '<string>',
                ],
                'ThirdPartyFirewallMissingFirewallViolation' => [
                    'AvailabilityZone' => '<string>',
                    'TargetViolationReason' => '<string>',
                    'VPC' => '<string>',
                    'ViolationTarget' => '<string>',
                ],
                'ThirdPartyFirewallMissingSubnetViolation' => [
                    'AvailabilityZone' => '<string>',
                    'TargetViolationReason' => '<string>',
                    'VPC' => '<string>',
                    'ViolationTarget' => '<string>',
                ],
            ],
            // ...
        ],
    ],
]

Result Details

Members

ViolationDetail

Type: ViolationDetail structure

Violation detail for a resource.

Errors

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

ListAdminAccountsForOrganization

$result = $client->listAdminAccountsForOrganization([/* ... */]);
$promise = $client->listAdminAccountsForOrganizationAsync([/* ... */]);

Returns a AdminAccounts object that lists the Firewall Manager administrators within the organization that are onboarded to Firewall Manager by AssociateAdminAccount.

This operation can be called only from the organization's management account.

Parameter Syntax

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

Parameter Details

Members

MaxResults

Type: int

The maximum number of objects that you want Firewall Manager to return for this request. If more objects are available, in the response, Firewall Manager provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

NextToken

Type: string

When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Firewall Manager returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

Result Syntax

[
    'AdminAccounts' => [
        [
            'AdminAccount' => '<string>',
            'DefaultAdmin' => true || false,
            'Status' => 'ONBOARDING|ONBOARDING_COMPLETE|OFFBOARDING|OFFBOARDING_COMPLETE',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

AdminAccounts

Type: Array of AdminAccountSummary structures

A list of Firewall Manager administrator accounts within the organization that were onboarded as administrators by AssociateAdminAccount or PutAdminAccount.

NextToken

Type: string

Errors

InvalidOperationException:
The operation failed because there was nothing to do or the operation wasn't possible. For example, you might have submitted an AssociateAdminAccount request for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it.
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.
LimitExceededException:
The operation exceeds a resource limit, for example, the maximum number of policy objects that you can create for an Amazon Web Services account. For more information, see Firewall Manager Limits in the WAF Developer Guide.

ListAdminsManagingAccount

$result = $client->listAdminsManagingAccount([/* ... */]);
$promise = $client->listAdminsManagingAccountAsync([/* ... */]);

Lists the accounts that are managing the specified Organizations member account. This is useful for any member account so that they can view the accounts who are managing their account. This operation only returns the managing administrators that have the requested account within their AdminScope.

Parameter Syntax

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

Parameter Details

Members

MaxResults

Type: int

NextToken

Type: string

Result Syntax

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

Result Details

Members

AdminAccounts

Type: Array of strings

The list of accounts who manage member accounts within their AdminScope.

NextToken

Type: string

Errors

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

ListAppsLists

$result = $client->listAppsLists([/* ... */]);
$promise = $client->listAppsListsAsync([/* ... */]);

Returns an array of AppsListDataSummary objects.

Parameter Syntax

$result = $client->listAppsLists([
    'DefaultLists' => true || false,
    'MaxResults' => <integer>, // REQUIRED
    'NextToken' => '<string>',
]);

Parameter Details

Members

DefaultLists

Type: boolean

Specifies whether the lists to retrieve are default lists owned by Firewall Manager.

MaxResults

Required: Yes
Type: int

If you don't specify this, Firewall Manager returns all available objects.

NextToken

Type: string

If you specify a value for MaxResults in your list request, and you have more objects than the maximum, Firewall Manager returns this token in the response. For all but the first request, you provide the token returned by the prior request in the request parameters, to retrieve the next batch of objects.

Result Syntax

[
    'AppsLists' => [
        [
            'AppsList' => [
                [
                    'AppName' => '<string>',
                    'Port' => <integer>,
                    'Protocol' => '<string>',
                ],
                // ...
            ],
            'ListArn' => '<string>',
            'ListId' => '<string>',
            'ListName' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

AppsLists

Type: Array of AppsListDataSummary structures

An array of AppsListDataSummary objects.

NextToken

Type: string

If you specify a value for MaxResults in your list request, and you have more objects than the maximum, Firewall Manager returns this token in the response. You can use this token in subsequent requests to retrieve the next batch of objects.

Errors

ResourceNotFoundException:
The specified resource was not found.
InvalidOperationException:
The operation failed because there was nothing to do or the operation wasn't possible. For example, you might have submitted an AssociateAdminAccount request for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it.
LimitExceededException:
The operation exceeds a resource limit, for example, the maximum number of policy objects that you can create for an Amazon Web Services account. For more information, see Firewall Manager Limits in the WAF Developer Guide.
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. 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 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, 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 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.

ListDiscoveredResources

$result = $client->listDiscoveredResources([/* ... */]);
$promise = $client->listDiscoveredResourcesAsync([/* ... */]);

Returns an array of resources in the organization's accounts that are available to be associated with a resource set.

Parameter Syntax

$result = $client->listDiscoveredResources([
    'MaxResults' => <integer>,
    'MemberAccountIds' => ['<string>', ...], // REQUIRED
    'NextToken' => '<string>',
    'ResourceType' => '<string>', // REQUIRED
]);

Parameter Details

Members

MaxResults

Type: int

MemberAccountIds

Required: Yes
Type: Array of strings

The Amazon Web Services account IDs to discover resources in. Only one account is supported per request. The account must be a member of your organization.

NextToken

Type: string

ResourceType

Required: Yes
Type: string

The type of resources to discover.

Result Syntax

[
    'Items' => [
        [
            'AccountId' => '<string>',
            'Name' => '<string>',
            'Type' => '<string>',
            'URI' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

Items

Type: Array of DiscoveredResource structures

Details of the resources that were discovered.

NextToken

Type: string

Errors

InvalidOperationException:
The operation failed because there was nothing to do or the operation wasn't possible. For example, you might have submitted an AssociateAdminAccount request for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it.
InvalidInputException:
The parameters of the request were invalid.
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 Amazon Web Services organization.

Either an Firewall Manager administrator or the organization's management account can make this request.

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

Parameter Syntax

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

Parameter Details

Members

MaxResults

Type: int

Specifies the number of PolicySummary objects that you want 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, 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' => [
        [
            'DeleteUnusedFMManagedResources' => true || false,
            'PolicyArn' => '<string>',
            'PolicyId' => '<string>',
            'PolicyName' => '<string>',
            'PolicyStatus' => 'ACTIVE|OUT_OF_ADMIN_SCOPE',
            'RemediationEnabled' => true || false,
            'ResourceType' => '<string>',
            'SecurityServiceType' => 'WAF|WAFV2|SHIELD_ADVANCED|SECURITY_GROUPS_COMMON|SECURITY_GROUPS_CONTENT_AUDIT|SECURITY_GROUPS_USAGE_AUDIT|NETWORK_FIREWALL|DNS_FIREWALL|THIRD_PARTY_FIREWALL|IMPORT_NETWORK_FIREWALL|NETWORK_ACL_COMMON',
        ],
        // ...
    ],
]

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 or the operation wasn't possible. For example, you might have submitted an AssociateAdminAccount request for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it.
LimitExceededException:
The operation exceeds a resource limit, for example, the maximum number of policy objects that you can create for an Amazon Web Services account. For more information, see Firewall Manager Limits in the WAF Developer Guide.
InternalErrorException:
The operation failed because of a system problem, even though the request was valid. Retry your request.

ListProtocolsLists

$result = $client->listProtocolsLists([/* ... */]);
$promise = $client->listProtocolsListsAsync([/* ... */]);

Returns an array of ProtocolsListDataSummary objects.

Parameter Syntax

$result = $client->listProtocolsLists([
    'DefaultLists' => true || false,
    'MaxResults' => <integer>, // REQUIRED
    'NextToken' => '<string>',
]);

Parameter Details

Members

DefaultLists

Type: boolean

Specifies whether the lists to retrieve are default lists owned by Firewall Manager.

MaxResults

Required: Yes
Type: int

If you don't specify this, Firewall Manager returns all available objects.

NextToken

Type: string

Result Syntax

[
    'NextToken' => '<string>',
    'ProtocolsLists' => [
        [
            'ListArn' => '<string>',
            'ListId' => '<string>',
            'ListName' => '<string>',
            'ProtocolsList' => ['<string>', ...],
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: string

ProtocolsLists

Type: Array of ProtocolsListDataSummary structures

An array of ProtocolsListDataSummary objects.

Errors

ResourceNotFoundException:
The specified resource was not found.
InvalidOperationException:
The operation failed because there was nothing to do or the operation wasn't possible. For example, you might have submitted an AssociateAdminAccount request for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it.
InternalErrorException:
The operation failed because of a system problem, even though the request was valid. Retry your request.

ListResourceSetResources

$result = $client->listResourceSetResources([/* ... */]);
$promise = $client->listResourceSetResourcesAsync([/* ... */]);

Returns an array of resources that are currently associated to a resource set.

Parameter Syntax

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

Parameter Details

Members

Identifier

Required: Yes
Type: string

A unique identifier for the resource set, used in a request to refer to the resource set.

MaxResults

Type: int

NextToken

Type: string

Result Syntax

[
    'Items' => [
        [
            'AccountId' => '<string>',
            'URI' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

Items

Required: Yes
Type: Array of Resource structures

An array of the associated resources' uniform resource identifiers (URI).

NextToken

Type: string

Errors

InvalidOperationException:
The operation failed because there was nothing to do or the operation wasn't possible. For example, you might have submitted an AssociateAdminAccount request for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it.
InternalErrorException:
The operation failed because of a system problem, even though the request was valid. Retry your request.
InvalidInputException:
The parameters of the request were invalid.
ResourceNotFoundException:
The specified resource was not found.

ListResourceSets

$result = $client->listResourceSets([/* ... */]);
$promise = $client->listResourceSetsAsync([/* ... */]);

Returns an array of ResourceSetSummary objects.

Parameter Syntax

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

Parameter Details

Members

MaxResults

Type: int

NextToken

Type: string

Result Syntax

[
    'NextToken' => '<string>',
    'ResourceSets' => [
        [
            'Description' => '<string>',
            'Id' => '<string>',
            'LastUpdateTime' => <DateTime>,
            'Name' => '<string>',
            'ResourceSetStatus' => 'ACTIVE|OUT_OF_ADMIN_SCOPE',
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: string

ResourceSets

Type: Array of ResourceSetSummary structures

An array of ResourceSetSummary objects.

Errors

InvalidOperationException:
The operation failed because there was nothing to do or the operation wasn't possible. For example, you might have submitted an AssociateAdminAccount request for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it.
InvalidInputException:
The parameters of the request were invalid.
InternalErrorException:
The operation failed because of a system problem, even though the request was valid. Retry your request.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Retrieves the list of tags for the specified Amazon Web Services resource.

Parameter Syntax

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

Parameter Details

Members

ResourceArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the resource to return tags for. The Firewall Manager resources that support tagging are policies, applications lists, and protocols lists.

Result Syntax

[
    'TagList' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

TagList

Type: Array of Tag structures

The tags associated with the resource.

Errors

ResourceNotFoundException:
The specified resource was not found.
InvalidOperationException:
The operation failed because there was nothing to do or the operation wasn't possible. For example, you might have submitted an AssociateAdminAccount request for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it.
InternalErrorException:
The operation failed because of a system problem, even though the request was valid. Retry your request.
InvalidInputException:
The parameters of the request were invalid.

ListThirdPartyFirewallFirewallPolicies

$result = $client->listThirdPartyFirewallFirewallPolicies([/* ... */]);
$promise = $client->listThirdPartyFirewallFirewallPoliciesAsync([/* ... */]);

Retrieves a list of all of the third-party firewall policies that are associated with the third-party firewall administrator's account.

Parameter Syntax

$result = $client->listThirdPartyFirewallFirewallPolicies([
    'MaxResults' => <integer>, // REQUIRED
    'NextToken' => '<string>',
    'ThirdPartyFirewall' => 'PALO_ALTO_NETWORKS_CLOUD_NGFW|FORTIGATE_CLOUD_NATIVE_FIREWALL', // REQUIRED
]);

Parameter Details

Members

MaxResults

Required: Yes
Type: int

The maximum number of third-party firewall policies that you want Firewall Manager to return. If the specified third-party firewall vendor is associated with more than MaxResults firewall policies, the response includes a NextToken element. NextToken contains an encrypted token that identifies the first third-party firewall policies that Firewall Manager will return if you submit another request.

NextToken

Type: string

If the previous response included a NextToken element, the specified third-party firewall vendor is associated with more third-party firewall policies. To get more third-party firewall policies, submit another ListThirdPartyFirewallFirewallPoliciesRequest request.

For the value of NextToken, specify the value of NextToken from the previous response. If the previous response didn't include a NextToken element, there are no more third-party firewall policies to get.

ThirdPartyFirewall

Required: Yes
Type: string

The name of the third-party firewall vendor.

Result Syntax

[
    'NextToken' => '<string>',
    'ThirdPartyFirewallFirewallPolicies' => [
        [
            'FirewallPolicyId' => '<string>',
            'FirewallPolicyName' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: string

The value that you will use for NextToken in the next ListThirdPartyFirewallFirewallPolicies request.

ThirdPartyFirewallFirewallPolicies

Type: Array of ThirdPartyFirewallFirewallPolicy structures

A list that contains one ThirdPartyFirewallFirewallPolicies element for each third-party firewall policies that the specified third-party firewall vendor is associated with. Each ThirdPartyFirewallFirewallPolicies element contains the firewall policy name and ID.

Errors

InvalidOperationException:
The operation failed because there was nothing to do or the operation wasn't possible. For example, you might have submitted an AssociateAdminAccount request for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it.
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.

PutAdminAccount

$result = $client->putAdminAccount([/* ... */]);
$promise = $client->putAdminAccountAsync([/* ... */]);

Creates or updates an Firewall Manager administrator account. The account must be a member of the organization that was onboarded to Firewall Manager by AssociateAdminAccount. Only the organization's management account can create an Firewall Manager administrator account. When you create an Firewall Manager administrator account, the service checks to see if the account is already a delegated administrator within Organizations. If the account isn't a delegated administrator, Firewall Manager calls Organizations to delegate the account within Organizations. For more information about administrator accounts within Organizations, see Managing the Amazon Web Services Accounts in Your Organization.

Parameter Syntax

$result = $client->putAdminAccount([
    'AdminAccount' => '<string>', // REQUIRED
    'AdminScope' => [
        'AccountScope' => [
            'Accounts' => ['<string>', ...],
            'AllAccountsEnabled' => true || false,
            'ExcludeSpecifiedAccounts' => true || false,
        ],
        'OrganizationalUnitScope' => [
            'AllOrganizationalUnitsEnabled' => true || false,
            'ExcludeSpecifiedOrganizationalUnits' => true || false,
            'OrganizationalUnits' => ['<string>', ...],
        ],
        'PolicyTypeScope' => [
            'AllPolicyTypesEnabled' => true || false,
            'PolicyTypes' => ['<string>', ...],
        ],
        'RegionScope' => [
            'AllRegionsEnabled' => true || false,
            'Regions' => ['<string>', ...],
        ],
    ],
]);

Parameter Details

Members

AdminAccount

Required: Yes
Type: string

The Amazon Web Services account ID to add as an Firewall Manager administrator account. The account must be a member of the organization that was onboarded to Firewall Manager by AssociateAdminAccount. For more information about Organizations, see Managing the Amazon Web Services Accounts in Your Organization.

AdminScope

Type: AdminScope structure

Configures the resources that the specified Firewall Manager administrator can manage. As a best practice, set the administrative scope according to the principles of least privilege. Only grant the administrator the specific resources or permissions that they need to perform the duties of their role.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidOperationException:
The operation failed because there was nothing to do or the operation wasn't possible. For example, you might have submitted an AssociateAdminAccount request for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it.
InvalidInputException:
The parameters of the request were invalid.
InternalErrorException:
The operation failed because of a system problem, even though the request was valid. Retry your request.
LimitExceededException:
The operation exceeds a resource limit, for example, the maximum number of policy objects that you can create for an Amazon Web Services account. For more information, see Firewall Manager Limits in the WAF Developer Guide.

PutAppsList

$result = $client->putAppsList([/* ... */]);
$promise = $client->putAppsListAsync([/* ... */]);

Creates an Firewall Manager applications list.

Parameter Syntax

$result = $client->putAppsList([
    'AppsList' => [ // REQUIRED
        'AppsList' => [ // REQUIRED
            [
                'AppName' => '<string>', // REQUIRED
                'Port' => <integer>, // REQUIRED
                'Protocol' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'CreateTime' => <integer || string || DateTime>,
        'LastUpdateTime' => <integer || string || DateTime>,
        'ListId' => '<string>',
        'ListName' => '<string>', // REQUIRED
        'ListUpdateToken' => '<string>',
        'PreviousAppsList' => [
            '<PreviousListVersion>' => [
                [
                    'AppName' => '<string>', // REQUIRED
                    'Port' => <integer>, // REQUIRED
                    'Protocol' => '<string>', // REQUIRED
                ],
                // ...
            ],
            // ...
        ],
    ],
    'TagList' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members

AppsList

Required: Yes
Type: AppsListData structure

The details of the Firewall Manager applications list to be created.

TagList

Type: Array of Tag structures

The tags associated with the resource.

Result Syntax

[
    'AppsList' => [
        'AppsList' => [
            [
                'AppName' => '<string>',
                'Port' => <integer>,
                'Protocol' => '<string>',
            ],
            // ...
        ],
        'CreateTime' => <DateTime>,
        'LastUpdateTime' => <DateTime>,
        'ListId' => '<string>',
        'ListName' => '<string>',
        'ListUpdateToken' => '<string>',
        'PreviousAppsList' => [
            '<PreviousListVersion>' => [
                [
                    'AppName' => '<string>',
                    'Port' => <integer>,
                    'Protocol' => '<string>',
                ],
                // ...
            ],
            // ...
        ],
    ],
    'AppsListArn' => '<string>',
]

Result Details

Members

AppsList

Type: AppsListData structure

The details of the Firewall Manager applications list.

AppsListArn

Type: string

The Amazon Resource Name (ARN) of the applications list.

Errors

ResourceNotFoundException:
The specified resource was not found.
InvalidOperationException:
The operation failed because there was nothing to do or the operation wasn't possible. For example, you might have submitted an AssociateAdminAccount request for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it.
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 Amazon Web Services account. For more information, see Firewall Manager Limits in the 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 Firewall Manager uses to record SNS logs.

To perform this action outside of the console, you must first configure the SNS topic's access policy to allow the SnsRoleName to publish SNS logs. If the SnsRoleName provided is a role other than the AWSServiceRoleForFMS service-linked role, this role must have a trust relationship configured to allow the Firewall Manager service principal fms.amazonaws.com to assume this role. For information about configuring an SNS access policy, see Service roles for Firewall Manager in the Firewall Manager Developer Guide.

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 Firewall Manager activity.

SnsTopicArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the SNS topic that collects notifications from 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 or the operation wasn't possible. For example, you might have submitted an AssociateAdminAccount request for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it.
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 Firewall Manager policy.

A Firewall Manager policy is specific to the individual policy type. If you want to enforce multiple policy types across accounts, you can create multiple policies. You can create more than one policy for each type.

If you add a new account to an organization that you created with Organizations, Firewall Manager automatically applies the policy to the resources in that account that are within scope of the policy.

Firewall Manager provides the following types of policies:

WAF policy - This policy applies WAF web ACL protections to specified accounts and resources.
Shield Advanced policy - This policy applies Shield Advanced protection to specified accounts and resources.
Security Groups policy - This type of policy gives you control over security groups that are in use throughout your organization in Organizations and lets you enforce a baseline set of rules across your organization.
Network ACL policy - This type of policy gives you control over the network ACLs that are in use throughout your organization in Organizations and lets you enforce a baseline set of first and last network ACL rules across your organization.
Network Firewall policy - This policy applies Network Firewall protection to your organization's VPCs.
DNS Firewall policy - This policy applies Amazon Route 53 Resolver DNS Firewall protections to your organization's VPCs.
Third-party firewall policy - This policy applies third-party firewall protections. Third-party firewalls are available by subscription through the Amazon Web Services Marketplace console at Amazon Web Services Marketplace.
- Palo Alto Networks Cloud NGFW policy - This policy applies Palo Alto Networks Cloud Next Generation Firewall (NGFW) protections and Palo Alto Networks Cloud NGFW rulestacks to your organization's VPCs.
- Fortigate CNF policy - This policy applies Fortigate Cloud Native Firewall (CNF) protections. Fortigate CNF is a cloud-centered solution that blocks Zero-Day threats and secures cloud infrastructures with industry-leading advanced threat prevention, smart web application firewalls (WAF), and API protection.

Parameter Syntax

$result = $client->putPolicy([
    'Policy' => [ // REQUIRED
        'DeleteUnusedFMManagedResources' => true || false,
        'ExcludeMap' => [
            '<CustomerPolicyScopeIdType>' => ['<string>', ...],
            // ...
        ],
        'ExcludeResourceTags' => true || false, // REQUIRED
        'IncludeMap' => [
            '<CustomerPolicyScopeIdType>' => ['<string>', ...],
            // ...
        ],
        'PolicyDescription' => '<string>',
        'PolicyId' => '<string>',
        'PolicyName' => '<string>', // REQUIRED
        'PolicyStatus' => 'ACTIVE|OUT_OF_ADMIN_SCOPE',
        'PolicyUpdateToken' => '<string>',
        'RemediationEnabled' => true || false, // REQUIRED
        'ResourceSetIds' => ['<string>', ...],
        'ResourceTags' => [
            [
                'Key' => '<string>', // REQUIRED
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceType' => '<string>', // REQUIRED
        'ResourceTypeList' => ['<string>', ...],
        'SecurityServicePolicyData' => [ // REQUIRED
            'ManagedServiceData' => '<string>',
            'PolicyOption' => [
                'NetworkAclCommonPolicy' => [
                    'NetworkAclEntrySet' => [ // REQUIRED
                        'FirstEntries' => [
                            [
                                'CidrBlock' => '<string>',
                                'Egress' => true || false, // REQUIRED
                                'IcmpTypeCode' => [
                                    'Code' => <integer>,
                                    'Type' => <integer>,
                                ],
                                'Ipv6CidrBlock' => '<string>',
                                'PortRange' => [
                                    'From' => <integer>,
                                    'To' => <integer>,
                                ],
                                'Protocol' => '<string>', // REQUIRED
                                'RuleAction' => 'allow|deny', // REQUIRED
                            ],
                            // ...
                        ],
                        'ForceRemediateForFirstEntries' => true || false, // REQUIRED
                        'ForceRemediateForLastEntries' => true || false, // REQUIRED
                        'LastEntries' => [
                            [
                                'CidrBlock' => '<string>',
                                'Egress' => true || false, // REQUIRED
                                'IcmpTypeCode' => [
                                    'Code' => <integer>,
                                    'Type' => <integer>,
                                ],
                                'Ipv6CidrBlock' => '<string>',
                                'PortRange' => [
                                    'From' => <integer>,
                                    'To' => <integer>,
                                ],
                                'Protocol' => '<string>', // REQUIRED
                                'RuleAction' => 'allow|deny', // REQUIRED
                            ],
                            // ...
                        ],
                    ],
                ],
                'NetworkFirewallPolicy' => [
                    'FirewallDeploymentModel' => 'CENTRALIZED|DISTRIBUTED',
                ],
                'ThirdPartyFirewallPolicy' => [
                    'FirewallDeploymentModel' => 'CENTRALIZED|DISTRIBUTED',
                ],
            ],
            'Type' => 'WAF|WAFV2|SHIELD_ADVANCED|SECURITY_GROUPS_COMMON|SECURITY_GROUPS_CONTENT_AUDIT|SECURITY_GROUPS_USAGE_AUDIT|NETWORK_FIREWALL|DNS_FIREWALL|THIRD_PARTY_FIREWALL|IMPORT_NETWORK_FIREWALL|NETWORK_ACL_COMMON', // REQUIRED
        ],
    ],
    'TagList' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members

Policy

Required: Yes
Type: Policy structure

The details of the Firewall Manager policy to be created.

TagList

Type: Array of Tag structures

The tags to add to the Amazon Web Services resource.

Result Syntax

[
    'Policy' => [
        'DeleteUnusedFMManagedResources' => true || false,
        'ExcludeMap' => [
            '<CustomerPolicyScopeIdType>' => ['<string>', ...],
            // ...
        ],
        'ExcludeResourceTags' => true || false,
        'IncludeMap' => [
            '<CustomerPolicyScopeIdType>' => ['<string>', ...],
            // ...
        ],
        'PolicyDescription' => '<string>',
        'PolicyId' => '<string>',
        'PolicyName' => '<string>',
        'PolicyStatus' => 'ACTIVE|OUT_OF_ADMIN_SCOPE',
        'PolicyUpdateToken' => '<string>',
        'RemediationEnabled' => true || false,
        'ResourceSetIds' => ['<string>', ...],
        'ResourceTags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceType' => '<string>',
        'ResourceTypeList' => ['<string>', ...],
        'SecurityServicePolicyData' => [
            'ManagedServiceData' => '<string>',
            'PolicyOption' => [
                'NetworkAclCommonPolicy' => [
                    'NetworkAclEntrySet' => [
                        'FirstEntries' => [
                            [
                                'CidrBlock' => '<string>',
                                'Egress' => true || false,
                                'IcmpTypeCode' => [
                                    'Code' => <integer>,
                                    'Type' => <integer>,
                                ],
                                'Ipv6CidrBlock' => '<string>',
                                'PortRange' => [
                                    'From' => <integer>,
                                    'To' => <integer>,
                                ],
                                'Protocol' => '<string>',
                                'RuleAction' => 'allow|deny',
                            ],
                            // ...
                        ],
                        'ForceRemediateForFirstEntries' => true || false,
                        'ForceRemediateForLastEntries' => true || false,
                        'LastEntries' => [
                            [
                                'CidrBlock' => '<string>',
                                'Egress' => true || false,
                                'IcmpTypeCode' => [
                                    'Code' => <integer>,
                                    'Type' => <integer>,
                                ],
                                'Ipv6CidrBlock' => '<string>',
                                'PortRange' => [
                                    'From' => <integer>,
                                    'To' => <integer>,
                                ],
                                'Protocol' => '<string>',
                                'RuleAction' => 'allow|deny',
                            ],
                            // ...
                        ],
                    ],
                ],
                'NetworkFirewallPolicy' => [
                    'FirewallDeploymentModel' => 'CENTRALIZED|DISTRIBUTED',
                ],
                'ThirdPartyFirewallPolicy' => [
                    'FirewallDeploymentModel' => 'CENTRALIZED|DISTRIBUTED',
                ],
            ],
            'Type' => 'WAF|WAFV2|SHIELD_ADVANCED|SECURITY_GROUPS_COMMON|SECURITY_GROUPS_CONTENT_AUDIT|SECURITY_GROUPS_USAGE_AUDIT|NETWORK_FIREWALL|DNS_FIREWALL|THIRD_PARTY_FIREWALL|IMPORT_NETWORK_FIREWALL|NETWORK_ACL_COMMON',
        ],
    ],
    'PolicyArn' => '<string>',
]

Result Details

Members

Policy

Type: Policy structure

The details of the Firewall Manager policy.

PolicyArn

Type: string

The Amazon Resource Name (ARN) of the policy.

Errors

ResourceNotFoundException:
The specified resource was not found.
InvalidOperationException:
The operation failed because there was nothing to do or the operation wasn't possible. For example, you might have submitted an AssociateAdminAccount request for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it.
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 Amazon Web Services account. For more information, see Firewall Manager Limits in the 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.

PutProtocolsList

$result = $client->putProtocolsList([/* ... */]);
$promise = $client->putProtocolsListAsync([/* ... */]);

Creates an Firewall Manager protocols list.

Parameter Syntax

$result = $client->putProtocolsList([
    'ProtocolsList' => [ // REQUIRED
        'CreateTime' => <integer || string || DateTime>,
        'LastUpdateTime' => <integer || string || DateTime>,
        'ListId' => '<string>',
        'ListName' => '<string>', // REQUIRED
        'ListUpdateToken' => '<string>',
        'PreviousProtocolsList' => [
            '<PreviousListVersion>' => ['<string>', ...],
            // ...
        ],
        'ProtocolsList' => ['<string>', ...], // REQUIRED
    ],
    'TagList' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members

ProtocolsList

Required: Yes
Type: ProtocolsListData structure

The details of the Firewall Manager protocols list to be created.

TagList

Type: Array of Tag structures

The tags associated with the resource.

Result Syntax

[
    'ProtocolsList' => [
        'CreateTime' => <DateTime>,
        'LastUpdateTime' => <DateTime>,
        'ListId' => '<string>',
        'ListName' => '<string>',
        'ListUpdateToken' => '<string>',
        'PreviousProtocolsList' => [
            '<PreviousListVersion>' => ['<string>', ...],
            // ...
        ],
        'ProtocolsList' => ['<string>', ...],
    ],
    'ProtocolsListArn' => '<string>',
]

Result Details

Members

ProtocolsList

Type: ProtocolsListData structure

The details of the Firewall Manager protocols list.

ProtocolsListArn

Type: string

The Amazon Resource Name (ARN) of the protocols list.

Errors

ResourceNotFoundException:
The specified resource was not found.
InvalidOperationException:
The operation failed because there was nothing to do or the operation wasn't possible. For example, you might have submitted an AssociateAdminAccount request for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it.
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 Amazon Web Services account. For more information, see Firewall Manager Limits in the WAF Developer Guide.
InternalErrorException:
The operation failed because of a system problem, even though the request was valid. Retry your request.

PutResourceSet

$result = $client->putResourceSet([/* ... */]);
$promise = $client->putResourceSetAsync([/* ... */]);

Creates the resource set.

An Firewall Manager resource set defines the resources to import into an Firewall Manager policy from another Amazon Web Services service.

Parameter Syntax

$result = $client->putResourceSet([
    'ResourceSet' => [ // REQUIRED
        'Description' => '<string>',
        'Id' => '<string>',
        'LastUpdateTime' => <integer || string || DateTime>,
        'Name' => '<string>', // REQUIRED
        'ResourceSetStatus' => 'ACTIVE|OUT_OF_ADMIN_SCOPE',
        'ResourceTypeList' => ['<string>', ...], // REQUIRED
        'UpdateToken' => '<string>',
    ],
    'TagList' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members

ResourceSet

Required: Yes
Type: ResourceSet structure

Details about the resource set to be created or updated.>

TagList

Type: Array of Tag structures

Retrieves the tags associated with the specified resource set. 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.

Result Syntax

[
    'ResourceSet' => [
        'Description' => '<string>',
        'Id' => '<string>',
        'LastUpdateTime' => <DateTime>,
        'Name' => '<string>',
        'ResourceSetStatus' => 'ACTIVE|OUT_OF_ADMIN_SCOPE',
        'ResourceTypeList' => ['<string>', ...],
        'UpdateToken' => '<string>',
    ],
    'ResourceSetArn' => '<string>',
]

Result Details

Members

ResourceSet

Required: Yes
Type: ResourceSet structure

Details about the resource set.

ResourceSetArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the resource set.

Errors

InvalidOperationException:
The operation failed because there was nothing to do or the operation wasn't possible. For example, you might have submitted an AssociateAdminAccount request for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it.
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 Amazon Web Services account. For more information, see Firewall Manager Limits in the WAF Developer Guide.
InternalErrorException:
The operation failed because of a system problem, even though the request was valid. Retry your request.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Adds one or more tags to an Amazon Web Services resource.

Parameter Syntax

$result = $client->tagResource([
    'ResourceArn' => '<string>', // REQUIRED
    'TagList' => [ // REQUIRED
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members

ResourceArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the resource to return tags for. The Firewall Manager resources that support tagging are policies, applications lists, and protocols lists.

TagList

Required: Yes
Type: Array of Tag structures

The tags to add to the resource.

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 or the operation wasn't possible. For example, you might have submitted an AssociateAdminAccount request for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it.
InternalErrorException:
The operation failed because of a system problem, even though the request was valid. Retry your request.
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 Amazon Web Services account. For more information, see Firewall Manager Limits in the WAF Developer Guide.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Removes one or more tags from an Amazon Web Services resource.

Parameter Syntax

$result = $client->untagResource([
    'ResourceArn' => '<string>', // REQUIRED
    'TagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

ResourceArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the resource to return tags for. The Firewall Manager resources that support tagging are policies, applications lists, and protocols lists.

TagKeys

Required: Yes
Type: Array of strings

The keys of the tags to remove from the resource.

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 or the operation wasn't possible. For example, you might have submitted an AssociateAdminAccount request for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it.
InternalErrorException:
The operation failed because of a system problem, even though the request was valid. Retry your request.
InvalidInputException:
The parameters of the request were invalid.

Shapes

AccountScope

Description

Configures the accounts within the administrator's Organizations organization that the specified Firewall Manager administrator can apply policies to.

Members

Accounts

Type: Array of strings

The list of accounts within the organization that the specified Firewall Manager administrator either can or cannot apply policies to, based on the value of ExcludeSpecifiedAccounts. If ExcludeSpecifiedAccounts is set to true, then the Firewall Manager administrator can apply policies to all members of the organization except for the accounts in this list. If ExcludeSpecifiedAccounts is set to false, then the Firewall Manager administrator can only apply policies to the accounts in this list.

AllAccountsEnabled

Type: boolean

A boolean value that indicates if the administrator can apply policies to all accounts within an organization. If true, the administrator can apply policies to all accounts within the organization. You can either enable management of all accounts through this operation, or you can specify a list of accounts to manage in AccountScope$Accounts. You cannot specify both.

ExcludeSpecifiedAccounts

Type: boolean

A boolean value that excludes the accounts in AccountScope$Accounts from the administrator's scope. If true, the Firewall Manager administrator can apply policies to all members of the organization except for the accounts listed in AccountScope$Accounts. You can either specify a list of accounts to exclude by AccountScope$Accounts, or you can enable management of all accounts by AccountScope$AllAccountsEnabled. You cannot specify both.

ActionTarget

Description

Describes a remediation action target.

Members

Description

Type: string

A description of the remediation action target.

ResourceId

Type: string

The ID of the remediation target.

AdminAccountSummary

Description

Contains high level information about the Firewall Manager administrator account.

Members

AdminAccount

Type: string

The Amazon Web Services account ID of the Firewall Manager administrator's account.

DefaultAdmin

Type: boolean

A boolean value that indicates if the administrator is the default administrator. If true, then this is the default administrator account. The default administrator can manage third-party firewalls and has full administrative scope. There is only one default administrator account per organization. For information about Firewall Manager default administrator accounts, see Managing Firewall Manager administrators in the Firewall Manager Developer Guide.

Status

Type: string

The current status of the request to onboard a member account as an Firewall Manager administrator.

ONBOARDING - The account is onboarding to Firewall Manager as an administrator.
ONBOARDING_COMPLETE - Firewall Manager The account is onboarded to Firewall Manager as an administrator, and can perform actions on the resources defined in their AdminScope.
OFFBOARDING - The account is being removed as an Firewall Manager administrator.
OFFBOARDING_COMPLETE - The account has been removed as an Firewall Manager administrator.

AdminScope

Description

Defines the resources that the Firewall Manager administrator can manage. For more information about administrative scope, see Managing Firewall Manager administrators in the Firewall Manager Developer Guide.

Members

AccountScope

Type: AccountScope structure

Defines the accounts that the specified Firewall Manager administrator can apply policies to.

OrganizationalUnitScope

Type: OrganizationalUnitScope structure

Defines the Organizations organizational units that the specified Firewall Manager administrator can apply policies to. For more information about OUs in Organizations, see Managing organizational units (OUs) in the Organizations User Guide.

PolicyTypeScope

Type: PolicyTypeScope structure

Defines the Firewall Manager policy types that the specified Firewall Manager administrator can create and manage.

RegionScope

Type: RegionScope structure

Defines the Amazon Web Services Regions that the specified Firewall Manager administrator can perform actions in.

App

Description

An individual Firewall Manager application.

Members

AppName

Required: Yes
Type: string

The application's name.

Port

Required: Yes
Type: long (int|float)

The application's port number, for example 80.

Protocol

Required: Yes
Type: string

The IP protocol name or number. The name can be one of tcp, udp, or icmp. For information on possible numbers, see Protocol Numbers.

AppsListData

Description

An Firewall Manager applications list.

Members

AppsList

Required: Yes
Type: Array of App structures

An array of applications in the Firewall Manager applications list.

CreateTime

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

The time that the Firewall Manager applications list was created.

LastUpdateTime

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

The time that the Firewall Manager applications list was last updated.

ListId

Type: string

The ID of the Firewall Manager applications list.

ListName

Required: Yes
Type: string

The name of the Firewall Manager applications list.

ListUpdateToken

Type: string

A unique identifier for each update to the list. When you update the list, the update token must match the token of the current version of the application list. You can retrieve the update token by getting the list.

PreviousAppsList

Type: Associative array of custom strings keys (PreviousListVersion) to App structuress

A map of previous version numbers to their corresponding App object arrays.

AppsListDataSummary

Description

Details of the Firewall Manager applications list.

Members

AppsList

Type: Array of App structures

An array of App objects in the Firewall Manager applications list.

ListArn

Type: string

The Amazon Resource Name (ARN) of the applications list.

ListId

Type: string

The ID of the applications list.

ListName

Type: string

The name of the applications list.

AwsEc2InstanceViolation

Description

Violation detail for an EC2 instance resource.

Members

AwsEc2NetworkInterfaceViolations

Type: Array of AwsEc2NetworkInterfaceViolation structures

Violation detail for network interfaces associated with the EC2 instance.

ViolationTarget

Type: string

The resource ID of the EC2 instance.

AwsEc2NetworkInterfaceViolation

Description

Violation detail for network interfaces associated with an EC2 instance.

Members

ViolatingSecurityGroups

Type: Array of strings

List of security groups that violate the rules specified in the primary security group of the Firewall Manager policy.

ViolationTarget

Type: string

The resource ID of the network interface.

AwsVPCSecurityGroupViolation

Description

Violation detail for the rule violation in a security group when compared to the primary security group of the Firewall Manager policy.

Members

PartialMatches

Type: Array of PartialMatch structures

List of rules specified in the security group of the Firewall Manager policy that partially match the ViolationTarget rule.

PossibleSecurityGroupRemediationActions

Type: Array of SecurityGroupRemediationAction structures

Remediation options for the rule specified in the ViolationTarget.

ViolationTarget

Type: string

The security group rule that is being evaluated.

ViolationTargetDescription

Type: string

A description of the security group that violates the policy.

ComplianceViolator

Description

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

Members

Metadata

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

Metadata about the resource that doesn't comply with the policy scope.

ResourceId

Type: string

The resource ID.

ResourceType

Type: string

The resource type. This is in the format shown in the Amazon Web Services Resource Types Reference. For example: AWS::ElasticLoadBalancingV2::LoadBalancer, AWS::CloudFront::Distribution, or AWS::NetworkFirewall::FirewallPolicy.

ViolationReason

Type: string

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

CreateNetworkAclAction

Description

Information about the CreateNetworkAcl action in Amazon EC2. This is a remediation option in RemediationAction.

Members

Description

Type: string

Brief description of this remediation action.

FMSCanRemediate

Type: boolean

Indicates whether it is possible for Firewall Manager to perform this remediation action. A false value indicates that auto remediation is disabled or Firewall Manager is unable to perform the action due to a conflict of some kind.

Vpc

Type: ActionTarget structure

The VPC that's associated with the remediation action.

CreateNetworkAclEntriesAction

Description

Information about the CreateNetworkAclEntries action in Amazon EC2. This is a remediation option in RemediationAction.

Members

Description

Type: string

Brief description of this remediation action.

FMSCanRemediate

Type: boolean

NetworkAclEntriesToBeCreated

Type: Array of EntryDescription structures

Lists the entries that the remediation action would create.

NetworkAclId

Type: ActionTarget structure

The network ACL that's associated with the remediation action.

DeleteNetworkAclEntriesAction

Description

Information about the DeleteNetworkAclEntries action in Amazon EC2. This is a remediation option in RemediationAction.

Members

Description

Type: string

Brief description of this remediation action.

FMSCanRemediate

Type: boolean

NetworkAclEntriesToBeDeleted

Type: Array of EntryDescription structures

Lists the entries that the remediation action would delete.

NetworkAclId

Type: ActionTarget structure

The network ACL that's associated with the remediation action.

DiscoveredResource

Description

A resource in the organization that's available to be associated with a Firewall Manager resource set.

Members

AccountId

Type: string

The Amazon Web Services account ID associated with the discovered resource.

Name

Type: string

The name of the discovered resource.

Type

Type: string

The type of the discovered resource.

URI

Type: string

The universal resource identifier (URI) of the discovered resource.

DnsDuplicateRuleGroupViolation

Description

A DNS Firewall rule group that Firewall Manager tried to associate with a VPC is already associated with the VPC and can't be associated again.

Members

ViolationTarget

Type: string

Information about the VPC ID.

ViolationTargetDescription

Type: string

A description of the violation that specifies the rule group and VPC.

DnsRuleGroupLimitExceededViolation

Description

The VPC that Firewall Manager was applying a DNS Fireall policy to reached the limit for associated DNS Firewall rule groups. Firewall Manager tried to associate another rule group with the VPC and failed due to the limit.

Members

NumberOfRuleGroupsAlreadyAssociated

Type: int

The number of rule groups currently associated with the VPC.

ViolationTarget

Type: string

Information about the VPC ID.

ViolationTargetDescription

Type: string

A description of the violation that specifies the rule group and VPC.

DnsRuleGroupPriorityConflictViolation

Description

A rule group that Firewall Manager tried to associate with a VPC has the same priority as a rule group that's already associated.

Members

ConflictingPolicyId

Type: string

The ID of the Firewall Manager DNS Firewall policy that was already applied to the VPC. This policy contains the rule group that's already associated with the VPC.

ConflictingPriority

Type: int

The priority setting of the two conflicting rule groups.

UnavailablePriorities

Type: Array of ints

The priorities of rule groups that are already associated with the VPC. To retry your operation, choose priority settings that aren't in this list for the rule groups in your new DNS Firewall policy.

ViolationTarget

Type: string

Information about the VPC ID.

ViolationTargetDescription

Type: string

A description of the violation that specifies the VPC and the rule group that's already associated with it.

EC2AssociateRouteTableAction

Description

The action of associating an EC2 resource, such as a subnet or internet gateway, with a route table.

Members

Description

Type: string

A description of the EC2 route table that is associated with the remediation action.

GatewayId

Type: ActionTarget structure

The ID of the gateway to be used with the EC2 route table that is associated with the remediation action.

RouteTableId

Required: Yes
Type: ActionTarget structure

The ID of the EC2 route table that is associated with the remediation action.

SubnetId

Type: ActionTarget structure

The ID of the subnet for the EC2 route table that is associated with the remediation action.

EC2CopyRouteTableAction

Description

An action that copies the EC2 route table for use in remediation.

Members

Description

Type: string

A description of the copied EC2 route table that is associated with the remediation action.

RouteTableId

Required: Yes
Type: ActionTarget structure

The ID of the copied EC2 route table that is associated with the remediation action.

VpcId

Required: Yes
Type: ActionTarget structure

The VPC ID of the copied EC2 route table that is associated with the remediation action.

EC2CreateRouteAction

Description

Information about the CreateRoute action in Amazon EC2.

Members

Description

Type: string

A description of CreateRoute action in Amazon EC2.

DestinationCidrBlock

Type: string

Information about the IPv4 CIDR address block used for the destination match.

DestinationIpv6CidrBlock

Type: string

Information about the IPv6 CIDR block destination.

DestinationPrefixListId

Type: string

Information about the ID of a prefix list used for the destination match.

GatewayId

Type: ActionTarget structure

Information about the ID of an internet gateway or virtual private gateway attached to your VPC.

RouteTableId

Required: Yes
Type: ActionTarget structure

Information about the ID of the route table for the route.

VpcEndpointId

Type: ActionTarget structure

Information about the ID of a VPC endpoint. Supported for Gateway Load Balancer endpoints only.

EC2CreateRouteTableAction

Description

Information about the CreateRouteTable action in Amazon EC2.

Members

Description

Type: string

A description of the CreateRouteTable action.

VpcId

Required: Yes
Type: ActionTarget structure

Information about the ID of a VPC.

EC2DeleteRouteAction

Description

Information about the DeleteRoute action in Amazon EC2.

Members

Description

Type: string

A description of the DeleteRoute action.

DestinationCidrBlock

Type: string

Information about the IPv4 CIDR range for the route. The value you specify must match the CIDR for the route exactly.

DestinationIpv6CidrBlock

Type: string

Information about the IPv6 CIDR range for the route. The value you specify must match the CIDR for the route exactly.

DestinationPrefixListId

Type: string

Information about the ID of the prefix list for the route.

RouteTableId

Required: Yes
Type: ActionTarget structure

Information about the ID of the route table.

EC2ReplaceRouteAction

Description

Information about the ReplaceRoute action in Amazon EC2.

Members

Description

Type: string

A description of the ReplaceRoute action in Amazon EC2.

DestinationCidrBlock

Type: string

Information about the IPv4 CIDR address block used for the destination match. The value that you provide must match the CIDR of an existing route in the table.

DestinationIpv6CidrBlock

Type: string

Information about the IPv6 CIDR address block used for the destination match. The value that you provide must match the CIDR of an existing route in the table.

DestinationPrefixListId

Type: string

Information about the ID of the prefix list for the route.

GatewayId

Type: ActionTarget structure

Information about the ID of an internet gateway or virtual private gateway.

RouteTableId

Required: Yes
Type: ActionTarget structure

Information about the ID of the route table.

EC2ReplaceRouteTableAssociationAction

Description

Information about the ReplaceRouteTableAssociation action in Amazon EC2.

Members

AssociationId

Required: Yes
Type: ActionTarget structure

Information about the association ID.

Description

Type: string

A description of the ReplaceRouteTableAssociation action in Amazon EC2.

RouteTableId

Required: Yes
Type: ActionTarget structure

Information about the ID of the new route table to associate with the subnet.

EntryDescription

Description

Describes a single rule in a network ACL.

Members

EntryDetail

Type: NetworkAclEntry structure

Describes a rule in a network ACL.

Each network ACL has a set of numbered ingress rules and a separate set of numbered egress rules. When determining whether a packet should be allowed in or out of a subnet associated with the network ACL, Amazon Web Services processes the entries in the network ACL according to the rule numbers, in ascending order.

When you manage an individual network ACL, you explicitly specify the rule numbers. When you specify the network ACL rules in a Firewall Manager policy, you provide the rules to run first, in the order that you want them to run, and the rules to run last, in the order that you want them to run. Firewall Manager assigns the rule numbers for you when you save the network ACL policy specification.

EntryRuleNumber

Type: int

The rule number for the entry. ACL entries are processed in ascending order by rule number. In a Firewall Manager network ACL policy, Firewall Manager assigns rule numbers.

EntryType

Type: string

Specifies whether the entry is managed by Firewall Manager or by a user, and, for Firewall Manager-managed entries, specifies whether the entry is among those that run first in the network ACL or those that run last.

EntryViolation

Description

Detailed information about an entry violation in a network ACL. The violation is against the network ACL specification inside the Firewall Manager network ACL policy. This data object is part of InvalidNetworkAclEntriesViolation.

Members

ActualEvaluationOrder

Type: string

The evaluation location within the ordered list of entries where the ExpectedEntry is currently located.

EntriesWithConflicts

Type: Array of EntryDescription structures

The list of entries that are in conflict with ExpectedEntry.

EntryAtExpectedEvaluationOrder

Type: EntryDescription structure

The entry that's currently in the ExpectedEvaluationOrder location, in place of the expected entry.

EntryViolationReasons

Type: Array of strings

Descriptions of the violations that Firewall Manager found for these entries.

ExpectedEntry

Type: EntryDescription structure

The Firewall Manager-managed network ACL entry that is involved in the entry violation.

ExpectedEvaluationOrder

Type: string

The evaluation location within the ordered list of entries where the ExpectedEntry should be, according to the network ACL policy specifications.

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 Amazon Web Services account's compliance with the Firewall Manager policy.

EvaluationLimitExceeded

Type: boolean

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

ViolatorCount

Type: long (int|float)

The number of resources that are noncompliant with the specified policy. For WAF and Shield Advanced policies, a resource is considered noncompliant if it is not associated with the policy. For security group policies, a resource is considered noncompliant if it doesn't comply with the rules of the policy and remediation is disabled or not possible.

ExpectedRoute

Description

Information about the expected route in the route table.

Members

AllowedTargets

Type: Array of strings

Information about the allowed targets.

ContributingSubnets

Type: Array of strings

Information about the contributing subnets.

IpV4Cidr

Type: string

Information about the IPv4 CIDR block.

IpV6Cidr

Type: string

Information about the IPv6 CIDR block.

PrefixListId

Type: string

Information about the ID of the prefix list for the route.

RouteTableId

Type: string

Information about the route table ID.

FMSPolicyUpdateFirewallCreationConfigAction

Description

Contains information about the actions that you can take to remediate scope violations caused by your policy's FirewallCreationConfig. FirewallCreationConfig is an optional configuration that you can use to choose which Availability Zones Firewall Manager creates Network Firewall endpoints in.

Members

Description

Type: string

Describes the remedial action.

FirewallCreationConfig

Type: string

A FirewallCreationConfig that you can copy into your current policy's SecurityServiceData in order to remedy scope violations.

FailedItem

Description

Details of a resource that failed when trying to update it's association to a resource set.

Members

Reason

Type: string

The reason the resource's association could not be updated.

URI

Type: string

The univeral resource indicator (URI) of the resource that failed.

FirewallSubnetIsOutOfScopeViolation

Description

Contains details about the firewall subnet that violates the policy scope.

Members

FirewallSubnetId

Type: string

The ID of the firewall subnet that violates the policy scope.

SubnetAvailabilityZone

Type: string

The Availability Zone of the firewall subnet that violates the policy scope.

SubnetAvailabilityZoneId

Type: string

The Availability Zone ID of the firewall subnet that violates the policy scope.

VpcEndpointId

Type: string

The VPC endpoint ID of the firewall subnet that violates the policy scope.

VpcId

Type: string

The VPC ID of the firewall subnet that violates the policy scope.

FirewallSubnetMissingVPCEndpointViolation

Description

The violation details for a firewall subnet's VPC endpoint that's deleted or missing.

Members

FirewallSubnetId

Type: string

The ID of the firewall that this VPC endpoint is associated with.

SubnetAvailabilityZone

Type: string

The name of the Availability Zone of the deleted VPC subnet.

SubnetAvailabilityZoneId

Type: string

The ID of the Availability Zone of the deleted VPC subnet.

VpcId

Type: string

The resource ID of the VPC associated with the deleted VPC subnet.

InternalErrorException

Description

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

Members

Message

Type: string

InvalidInputException

Description

The parameters of the request were invalid.

Members

Message

Type: string

InvalidNetworkAclEntriesViolation

Description

Violation detail for the entries in a network ACL resource.

Members

CurrentAssociatedNetworkAcl

Type: string

The network ACL containing the entry violations.

EntryViolations

Type: Array of EntryViolation structures

Detailed information about the entry violations in the network ACL.

Subnet

Type: string

The subnet that's associated with the network ACL.

SubnetAvailabilityZone

Type: string

The Availability Zone where the network ACL is in use.

Vpc

Type: string

The VPC where the violation was found.

InvalidOperationException

Description

The operation failed because there was nothing to do or the operation wasn't possible. For example, you might have submitted an AssociateAdminAccount request for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it.

Members

Message

Type: string

InvalidTypeException

Description

The value of the Type parameter is invalid.

Members

Message

Type: string

LimitExceededException

Description

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

Members

Message

Type: string

NetworkAclCommonPolicy

Description

Defines a Firewall Manager network ACL policy. This is used in the PolicyOption of a SecurityServicePolicyData for a Policy, when the SecurityServicePolicyData type is set to NETWORK_ACL_COMMON.

For information about network ACLs, see Control traffic to subnets using network ACLs in the Amazon Virtual Private Cloud User Guide.

Members

NetworkAclEntrySet

Required: Yes
Type: NetworkAclEntrySet structure

The definition of the first and last rules for the network ACL policy.

NetworkAclEntry

Description

Describes a rule in a network ACL.

Members

CidrBlock

Type: string

The IPv4 network range to allow or deny, in CIDR notation.

Egress

Required: Yes
Type: boolean

Indicates whether the rule is an egress, or outbound, rule (applied to traffic leaving the subnet). If it's not an egress rule, then it's an ingress, or inbound, rule.

IcmpTypeCode

Type: NetworkAclIcmpTypeCode structure

ICMP protocol: The ICMP type and code.

Ipv6CidrBlock

Type: string

The IPv6 network range to allow or deny, in CIDR notation.

PortRange

Type: NetworkAclPortRange structure

TCP or UDP protocols: The range of ports the rule applies to.

Protocol

Required: Yes
Type: string

The protocol number. A value of "-1" means all protocols.

RuleAction

Required: Yes
Type: string

Indicates whether to allow or deny the traffic that matches the rule.

NetworkAclEntrySet

Description

The configuration of the first and last rules for the network ACL policy, and the remediation settings for each.

Members

FirstEntries

Type: Array of NetworkAclEntry structures

The rules that you want to run first in the Firewall Manager managed network ACLs.

Provide these in the order in which you want them to run. Firewall Manager will assign the specific rule numbers for you, in the network ACLs that it creates.

You must specify at least one first entry or one last entry in any network ACL policy.

ForceRemediateForFirstEntries

Required: Yes
Type: boolean

Applies only when remediation is enabled for the policy as a whole. Firewall Manager uses this setting when it finds policy violations that involve conflicts between the custom entries and the policy entries.

If forced remediation is disabled, Firewall Manager marks the network ACL as noncompliant and does not try to remediate. For more information about the remediation behavior, see Remediation for managed network ACLs in the Firewall Manager Developer Guide.

ForceRemediateForLastEntries

Required: Yes
Type: boolean

LastEntries

Type: Array of NetworkAclEntry structures

The rules that you want to run last in the Firewall Manager managed network ACLs.

Provide these in the order in which you want them to run. Firewall Manager will assign the specific rule numbers for you, in the network ACLs that it creates.

You must specify at least one first entry or one last entry in any network ACL policy.

NetworkAclIcmpTypeCode

Description

ICMP protocol: The ICMP type and code.

Members

Code

Type: int

ICMP code.

Type

Type: int

ICMP type.

NetworkAclPortRange

Description

TCP or UDP protocols: The range of ports the rule applies to.

Members

From

Type: int

The beginning port number of the range.

To

Type: int

The ending port number of the range.

NetworkFirewallBlackHoleRouteDetectedViolation

Description

Violation detail for an internet gateway route with an inactive state in the customer subnet route table or Network Firewall subnet route table.

Members

RouteTableId

Type: string

Information about the route table ID.

ViolatingRoutes

Type: Array of Route structures

Information about the route or routes that are in violation.

ViolationTarget

Type: string

The subnet that has an inactive state.

VpcId

Type: string

Information about the VPC ID.

NetworkFirewallInternetTrafficNotInspectedViolation

Description

Violation detail for the subnet for which internet traffic that hasn't been inspected.

Members

ActualFirewallSubnetRoutes

Type: Array of Route structures

The actual firewall subnet routes.

ActualInternetGatewayRoutes

Type: Array of Route structures

The actual internet gateway routes.

CurrentFirewallSubnetRouteTable

Type: string

Information about the subnet route table for the current firewall.

CurrentInternetGatewayRouteTable

Type: string

The current route table for the internet gateway.

ExpectedFirewallEndpoint

Type: string

The expected endpoint for the current firewall.

ExpectedFirewallSubnetRoutes

Type: Array of ExpectedRoute structures

The firewall subnet routes that are expected.

ExpectedInternetGatewayRoutes

Type: Array of ExpectedRoute structures

The internet gateway routes that are expected.

FirewallSubnetId

Type: string

The firewall subnet ID.

InternetGatewayId

Type: string

The internet gateway ID.

IsRouteTableUsedInDifferentAZ

Type: boolean

Information about whether the route table is used in another Availability Zone.

RouteTableId

Type: string

Information about the route table ID.

SubnetAvailabilityZone

Type: string

The subnet Availability Zone.

SubnetId

Type: string

The subnet ID.

ViolatingRoutes

Type: Array of Route structures

The route or routes that are in violation.

VpcId

Type: string

Information about the VPC ID.

NetworkFirewallInvalidRouteConfigurationViolation

Description

Violation detail for the improperly configured subnet route. It's possible there is a missing route table route, or a configuration that causes traffic to cross an Availability Zone boundary.

Members

ActualFirewallEndpoint

Type: string

The actual firewall endpoint.

ActualFirewallSubnetId

Type: string

The actual subnet ID for the firewall.

ActualFirewallSubnetRoutes

Type: Array of Route structures

The actual firewall subnet routes that are expected.

ActualInternetGatewayRoutes

Type: Array of Route structures

The actual internet gateway routes.

AffectedSubnets

Type: Array of strings

The subnets that are affected.

CurrentFirewallSubnetRouteTable

Type: string

The subnet route table for the current firewall.

CurrentInternetGatewayRouteTable

Type: string

The route table for the current internet gateway.

ExpectedFirewallEndpoint

Type: string

The firewall endpoint that's expected.

ExpectedFirewallSubnetId

Type: string

The expected subnet ID for the firewall.

ExpectedFirewallSubnetRoutes

Type: Array of ExpectedRoute structures

The firewall subnet routes that are expected.

ExpectedInternetGatewayRoutes

Type: Array of ExpectedRoute structures

The expected routes for the internet gateway.

InternetGatewayId

Type: string

The internet gateway ID.

IsRouteTableUsedInDifferentAZ

Type: boolean

Information about whether the route table is used in another Availability Zone.

RouteTableId

Type: string

The route table ID.

ViolatingRoute

Type: Route structure

The route that's in violation.

VpcId

Type: string

Information about the VPC ID.

NetworkFirewallMissingExpectedRTViolation

Description

Violation detail for Network Firewall for a subnet that's not associated to the expected Firewall Manager managed route table.

Members

AvailabilityZone

Type: string

The Availability Zone of a violating subnet.

CurrentRouteTable

Type: string

The resource ID of the current route table that's associated with the subnet, if one is available.

ExpectedRouteTable

Type: string

The resource ID of the route table that should be associated with the subnet.

VPC

Type: string

The resource ID of the VPC associated with a violating subnet.

ViolationTarget

Type: string

The ID of the Network Firewall or VPC resource that's in violation.

NetworkFirewallMissingExpectedRoutesViolation

Description

Violation detail for an expected route missing in Network Firewall.

Members

ExpectedRoutes

Type: Array of ExpectedRoute structures

The expected routes.

ViolationTarget

Type: string

The target of the violation.

VpcId

Type: string

Information about the VPC ID.

NetworkFirewallMissingFirewallViolation

Description

Violation detail for Network Firewall for a subnet that doesn't have a Firewall Manager managed firewall in its VPC.

Members

AvailabilityZone

Type: string

The Availability Zone of a violating subnet.

TargetViolationReason

Type: string

The reason the resource has this violation, if one is available.

VPC

Type: string

The resource ID of the VPC associated with a violating subnet.

ViolationTarget

Type: string

The ID of the Network Firewall or VPC resource that's in violation.

NetworkFirewallMissingSubnetViolation

Description

Violation detail for Network Firewall for an Availability Zone that's missing the expected Firewall Manager managed subnet.

Members

AvailabilityZone

Type: string

The Availability Zone of a violating subnet.

TargetViolationReason

Type: string

The reason the resource has this violation, if one is available.

VPC

Type: string

The resource ID of the VPC associated with a violating subnet.

ViolationTarget

Type: string

The ID of the Network Firewall or VPC resource that's in violation.

NetworkFirewallPolicy

Description

Configures the firewall policy deployment model of Network Firewall. For information about Network Firewall deployment models, see Network Firewall example architectures with routing in the Network Firewall Developer Guide.

Members

FirewallDeploymentModel

Type: string

Defines the deployment model to use for the firewall policy. To use a distributed model, set PolicyOption to NULL.

NetworkFirewallPolicyDescription

Description

The definition of the Network Firewall firewall policy.

Members

StatefulDefaultActions

Type: Array of strings

The default actions to take on a packet that doesn't match any stateful rules. The stateful default action is optional, and is only valid when using the strict rule order.

Valid values of the stateful default action:

aws:drop_strict
aws:drop_established
aws:alert_strict
aws:alert_established

StatefulEngineOptions

Type: StatefulEngineOptions structure

Additional options governing how Network Firewall handles stateful rules. The stateful rule groups that you use in your policy must have stateful rule options settings that are compatible with these settings.

StatefulRuleGroups

Type: Array of StatefulRuleGroup structures

The stateful rule groups that are used in the Network Firewall firewall policy.

StatelessCustomActions

Type: Array of strings

Names of custom actions that are available for use in the stateless default actions settings.

StatelessDefaultActions

Type: Array of strings

The actions to take on packets that don't match any of the stateless rule groups.

StatelessFragmentDefaultActions

Type: Array of strings

The actions to take on packet fragments that don't match any of the stateless rule groups.

StatelessRuleGroups

Type: Array of StatelessRuleGroup structures

The stateless rule groups that are used in the Network Firewall firewall policy.

NetworkFirewallPolicyModifiedViolation

Description

Violation detail for Network Firewall for a firewall policy that has a different NetworkFirewallPolicyDescription than is required by the Firewall Manager policy.

Members

CurrentPolicyDescription

Type: NetworkFirewallPolicyDescription structure

The policy that's currently in use in the individual account.

ExpectedPolicyDescription

Type: NetworkFirewallPolicyDescription structure

The policy that should be in use in the individual account in order to be compliant.

ViolationTarget

Type: string

The ID of the Network Firewall or VPC resource that's in violation.

NetworkFirewallStatefulRuleGroupOverride

Description

The setting that allows the policy owner to change the behavior of the rule group within a policy.

Members

Action

Type: string

The action that changes the rule group from DROP to ALERT. This only applies to managed rule groups.

NetworkFirewallUnexpectedFirewallRoutesViolation

Description

Violation detail for an unexpected route that's present in a route table.

Members

FirewallEndpoint

Type: string

The endpoint of the firewall.

FirewallSubnetId

Type: string

The subnet ID for the firewall.

RouteTableId

Type: string

The ID of the route table.

ViolatingRoutes

Type: Array of Route structures

The routes that are in violation.

VpcId

Type: string

Information about the VPC ID.

NetworkFirewallUnexpectedGatewayRoutesViolation

Description

Violation detail for an unexpected gateway route that’s present in a route table.

Members

GatewayId

Type: string

Information about the gateway ID.

RouteTableId

Type: string

Information about the route table.

ViolatingRoutes

Type: Array of Route structures

The routes that are in violation.

VpcId

Type: string

Information about the VPC ID.

OrganizationalUnitScope

Description

Defines the Organizations organizational units (OUs) that the specified Firewall Manager administrator can apply policies to. For more information about OUs in Organizations, see Managing organizational units (OUs) in the Organizations User Guide.

Members

AllOrganizationalUnitsEnabled

Type: boolean

A boolean value that indicates if the administrator can apply policies to all OUs within an organization. If true, the administrator can manage all OUs within the organization. You can either enable management of all OUs through this operation, or you can specify OUs to manage in OrganizationalUnitScope$OrganizationalUnits. You cannot specify both.

ExcludeSpecifiedOrganizationalUnits

Type: boolean

A boolean value that excludes the OUs in OrganizationalUnitScope$OrganizationalUnits from the administrator's scope. If true, the Firewall Manager administrator can apply policies to all OUs in the organization except for the OUs listed in OrganizationalUnitScope$OrganizationalUnits. You can either specify a list of OUs to exclude by OrganizationalUnitScope$OrganizationalUnits, or you can enable management of all OUs by OrganizationalUnitScope$AllOrganizationalUnitsEnabled. You cannot specify both.

OrganizationalUnits

Type: Array of strings

The list of OUs within the organization that the specified Firewall Manager administrator either can or cannot apply policies to, based on the value of OrganizationalUnitScope$ExcludeSpecifiedOrganizationalUnits. If OrganizationalUnitScope$ExcludeSpecifiedOrganizationalUnits is set to true, then the Firewall Manager administrator can apply policies to all OUs in the organization except for the OUs in this list. If OrganizationalUnitScope$ExcludeSpecifiedOrganizationalUnits is set to false, then the Firewall Manager administrator can only apply policies to the OUs in this list.

PartialMatch

Description

The reference rule that partially matches the ViolationTarget rule and violation reason.

Members

Reference

Type: string

The reference rule from the primary security group of the Firewall Manager policy.

TargetViolationReasons

Type: Array of strings

The violation reason.

Policy

Description

An Firewall Manager policy.

Members

DeleteUnusedFMManagedResources

Type: boolean

Indicates whether Firewall Manager should automatically remove protections from resources that leave the policy scope and clean up resources that Firewall Manager is managing for accounts when those accounts leave policy scope. For example, Firewall Manager will disassociate a Firewall Manager managed web ACL from a protected customer resource when the customer resource leaves policy scope.

By default, Firewall Manager doesn't remove protections or delete Firewall Manager managed resources.

This option is not available for Shield Advanced or WAF Classic policies.

ExcludeMap

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

Specifies the Amazon Web Services account IDs and Organizations organizational units (OUs) to exclude from the policy. Specifying an OU is the equivalent of specifying all accounts in the OU and in any of its child OUs, including any child OUs and accounts that are added at a later time.

You can specify inclusions or exclusions, but not both. If you specify an IncludeMap, Firewall Manager applies the policy to all accounts specified by the IncludeMap, and does not evaluate any ExcludeMap specifications. If you do not specify an IncludeMap, then Firewall Manager applies the policy to all accounts except for those specified by the ExcludeMap.

You can specify account IDs, OUs, or a combination:

Specify account IDs by setting the key to ACCOUNT. For example, the following is a valid map: {“ACCOUNT” : [“accountID1”, “accountID2”]}.
Specify OUs by setting the key to ORG_UNIT. For example, the following is a valid map: {“ORG_UNIT” : [“ouid111”, “ouid112”]}.
Specify accounts and OUs together in a single map, separated with a comma. For example, the following is a valid map: {“ACCOUNT” : [“accountID1”, “accountID2”], “ORG_UNIT” : [“ouid111”, “ouid112”]}.

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 Amazon Web Services account IDs and Organizations organizational units (OUs) to include in the policy. Specifying an OU is the equivalent of specifying all accounts in the OU and in any of its child OUs, including any child OUs and accounts that are added at a later time.

You can specify account IDs, OUs, or a combination:

Specify account IDs by setting the key to ACCOUNT. For example, the following is a valid map: {“ACCOUNT” : [“accountID1”, “accountID2”]}.
Specify OUs by setting the key to ORG_UNIT. For example, the following is a valid map: {“ORG_UNIT” : [“ouid111”, “ouid112”]}.
Specify accounts and OUs together in a single map, separated with a comma. For example, the following is a valid map: {“ACCOUNT” : [“accountID1”, “accountID2”], “ORG_UNIT” : [“ouid111”, “ouid112”]}.

PolicyDescription

Type: string

Your description of the Firewall Manager policy.

PolicyId

Type: string

The ID of the Firewall Manager policy.

PolicyName

Required: Yes
Type: string

The name of the Firewall Manager policy.

PolicyStatus

Type: string

Indicates whether the policy is in or out of an admin's policy or Region scope.

ACTIVE - The administrator can manage and delete the policy.
OUT_OF_ADMIN_SCOPE - The administrator can view the policy, but they can't edit or delete the policy. Existing policy protections stay in place. Any new resources that come into scope of the policy won't be protected.

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.

ResourceSetIds

Type: Array of strings

The unique identifiers of the resource sets used by the policy.

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 Amazon Web Services Resource Types Reference. To apply this policy to multiple resource types, specify a resource type of ResourceTypeList and then specify the resource types in a ResourceTypeList.

The following are valid resource types for each Firewall Manager policy type:

Amazon Web Services WAF Classic - AWS::ApiGateway::Stage, AWS::CloudFront::Distribution, and AWS::ElasticLoadBalancingV2::LoadBalancer.
WAF - AWS::ApiGateway::Stage, AWS::ElasticLoadBalancingV2::LoadBalancer, and AWS::CloudFront::Distribution.
Shield Advanced - AWS::ElasticLoadBalancingV2::LoadBalancer, AWS::ElasticLoadBalancing::LoadBalancer, AWS::EC2::EIP, and AWS::CloudFront::Distribution.
Network ACL - AWS::EC2::Subnet.
Security group usage audit - AWS::EC2::SecurityGroup.
Security group content audit - AWS::EC2::SecurityGroup, AWS::EC2::NetworkInterface, and AWS::EC2::Instance.
DNS Firewall, Network Firewall, and third-party firewall - AWS::EC2::VPC.

ResourceTypeList

Type: Array of strings

An array of ResourceType objects. Use this only to specify multiple resource types. To specify a single resource type, use 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 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 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 WAF or Config, and the error message received that indicates the problem with the service.

MemberAccount

Type: string

The Amazon Web Services account ID.

PolicyId

Type: string

The ID of the Firewall Manager policy.

PolicyOwner

Type: string

The Amazon Web Services account that created the Firewall Manager policy.

Violators

Type: Array of ComplianceViolator structures

An array of resources that aren't protected by the 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 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

Details about problems with dependent services, such as WAF or Config, and the error message received that indicates the problem with the service.

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 Firewall Manager policy.

PolicyName

Type: string

The name of the Firewall Manager policy.

PolicyOwner

Type: string

The Amazon Web Services account that created the Firewall Manager policy.

PolicyOption

Description

Contains the settings to configure a network ACL policy, a Network Firewall firewall policy deployment model, or a third-party firewall policy.

Members

NetworkAclCommonPolicy

Type: NetworkAclCommonPolicy structure

Defines a Firewall Manager network ACL policy.

NetworkFirewallPolicy

Type: NetworkFirewallPolicy structure

Defines the deployment model to use for the firewall policy.

ThirdPartyFirewallPolicy

Type: ThirdPartyFirewallPolicy structure

Defines the policy options for a third-party firewall policy.

PolicySummary

Description

Details of the Firewall Manager policy.

Members

DeleteUnusedFMManagedResources

Type: boolean

By default, Firewall Manager doesn't remove protections or delete Firewall Manager managed resources.

This option is not available for Shield Advanced or WAF Classic policies.

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 name of the specified policy.

PolicyStatus

Type: string

Indicates whether the policy is in or out of an admin's policy or Region scope.

ACTIVE - The administrator can manage and delete the policy.
OUT_OF_ADMIN_SCOPE - The administrator can view the policy, but they can't edit or delete the policy. Existing policy protections stay in place. Any new resources that come into scope of the policy won't be protected.

RemediationEnabled

Type: boolean

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

ResourceType

Type: string

The type of resource protected by or in scope of the policy. This is in the format shown in the Amazon Web Services Resource Types Reference.

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 WAF policy, a Shield Advanced policy, or a security group policy.

PolicyTypeScope

Description

Defines the policy types that the specified Firewall Manager administrator can manage.

Members

AllPolicyTypesEnabled

Type: boolean

Allows the specified Firewall Manager administrator to manage all Firewall Manager policy types, except for third-party policy types. Third-party policy types can only be managed by the Firewall Manager default administrator.

PolicyTypes

Type: Array of strings

The list of policy types that the specified Firewall Manager administrator can manage.

PossibleRemediationAction

Description

A list of remediation actions.

Members

Description

Type: string

A description of the list of remediation actions.

IsDefaultAction

Type: boolean

Information about whether an action is taken by default.

OrderedRemediationActions

Required: Yes
Type: Array of RemediationActionWithOrder structures

The ordered list of remediation actions.

PossibleRemediationActions

Description

A list of possible remediation action lists. Each individual possible remediation action is a list of individual remediation actions.

Members

Actions

Type: Array of PossibleRemediationAction structures

Information about the actions.

Description

Type: string

A description of the possible remediation actions list.

ProtocolsListData

Description

An Firewall Manager protocols list.

Members

CreateTime

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

The time that the Firewall Manager protocols list was created.

LastUpdateTime

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

The time that the Firewall Manager protocols list was last updated.

ListId

Type: string

The ID of the Firewall Manager protocols list.

ListName

Required: Yes
Type: string

The name of the Firewall Manager protocols list.

ListUpdateToken

Type: string

PreviousProtocolsList

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

A map of previous version numbers to their corresponding protocol arrays.

ProtocolsList

Required: Yes
Type: Array of strings

An array of protocols in the Firewall Manager protocols list.

ProtocolsListDataSummary

Description

Details of the Firewall Manager protocols list.

Members

ListArn

Type: string

The Amazon Resource Name (ARN) of the specified protocols list.

ListId

Type: string

The ID of the specified protocols list.

ListName

Type: string

The name of the specified protocols list.

ProtocolsList

Type: Array of strings

An array of protocols in the Firewall Manager protocols list.

RegionScope

Description

Defines the Amazon Web Services Regions that the specified Firewall Manager administrator can manage.

Members

AllRegionsEnabled

Type: boolean

Allows the specified Firewall Manager administrator to manage all Amazon Web Services Regions.

Regions

Type: Array of strings

The Amazon Web Services Regions that the specified Firewall Manager administrator can perform actions in.

RemediationAction

Description

Information about an individual action you can take to remediate a violation.

Members

CreateNetworkAclAction

Type: CreateNetworkAclAction structure

Information about the CreateNetworkAcl action in Amazon EC2.

CreateNetworkAclEntriesAction

Type: CreateNetworkAclEntriesAction structure

Information about the CreateNetworkAclEntries action in Amazon EC2.

DeleteNetworkAclEntriesAction

Type: DeleteNetworkAclEntriesAction structure

Information about the DeleteNetworkAclEntries action in Amazon EC2.

Description

Type: string

A description of a remediation action.

EC2AssociateRouteTableAction

Type: EC2AssociateRouteTableAction structure

Information about the AssociateRouteTable action in the Amazon EC2 API.

EC2CopyRouteTableAction

Type: EC2CopyRouteTableAction structure

Information about the CopyRouteTable action in the Amazon EC2 API.

EC2CreateRouteAction

Type: EC2CreateRouteAction structure

Information about the CreateRoute action in the Amazon EC2 API.

EC2CreateRouteTableAction

Type: EC2CreateRouteTableAction structure

Information about the CreateRouteTable action in the Amazon EC2 API.

EC2DeleteRouteAction

Type: EC2DeleteRouteAction structure

Information about the DeleteRoute action in the Amazon EC2 API.

EC2ReplaceRouteAction

Type: EC2ReplaceRouteAction structure

Information about the ReplaceRoute action in the Amazon EC2 API.

EC2ReplaceRouteTableAssociationAction

Type: EC2ReplaceRouteTableAssociationAction structure

Information about the ReplaceRouteTableAssociation action in the Amazon EC2 API.

FMSPolicyUpdateFirewallCreationConfigAction

Type: FMSPolicyUpdateFirewallCreationConfigAction structure

The remedial action to take when updating a firewall configuration.

ReplaceNetworkAclAssociationAction

Type: ReplaceNetworkAclAssociationAction structure

Information about the ReplaceNetworkAclAssociation action in Amazon EC2.

RemediationActionWithOrder

Description

An ordered list of actions you can take to remediate a violation.

Members

Order

Type: int

The order of the remediation actions in the list.

RemediationAction

Type: RemediationAction structure

Information about an action you can take to remediate a violation.

ReplaceNetworkAclAssociationAction

Description

Information about the ReplaceNetworkAclAssociation action in Amazon EC2. This is a remediation option in RemediationAction.

Members

AssociationId

Type: ActionTarget structure

Describes a remediation action target.

Description

Type: string

Brief description of this remediation action.

FMSCanRemediate

Type: boolean

NetworkAclId

Type: ActionTarget structure

The network ACL that's associated with the remediation action.

Resource

Description

Details of a resource that is associated to an Firewall Manager resource set.

Members

AccountId

Type: string

The Amazon Web Services account ID that the associated resource belongs to.

URI

Required: Yes
Type: string

The resource's universal resource indicator (URI).

ResourceNotFoundException

Description

The specified resource was not found.

Members

Message

Type: string

ResourceSet

Description

A set of resources to include in a policy.

Members

Description

Type: string

A description of the resource set.

Id

Type: string

A unique identifier for the resource set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

LastUpdateTime

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

The last time that the resource set was changed.

Name

Required: Yes
Type: string

The descriptive name of the resource set. You can't change the name of a resource set after you create it.

ResourceSetStatus

Type: string

Indicates whether the resource set is in or out of an admin's Region scope.

ACTIVE - The administrator can manage and delete the resource set.
OUT_OF_ADMIN_SCOPE - The administrator can view the resource set, but they can't edit or delete the resource set. Existing protections stay in place. Any new resource that come into scope of the resource set won't be protected.

ResourceTypeList

Required: Yes
Type: Array of strings

Determines the resources that can be associated to the resource set. Depending on your setting for max results and the number of resource sets, a single call might not return the full list.

UpdateToken

Type: string

An optional token that you can use for optimistic locking. Firewall Manager returns a token to your requests that access the resource set. The token marks the state of the resource set resource at the time of the request. Update tokens are not allowed when creating a resource set. After creation, each subsequent update call to the resource set requires the update token.

To make an unconditional change to the resource set, omit the token in your update request. Without the token, Firewall Manager performs your updates regardless of whether the resource set has changed since you last retrieved it.

To make a conditional change to the resource set, provide the token in your update request. Firewall Manager uses the token to ensure that the resource set hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the resource set again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.

ResourceSetSummary

Description

Summarizes the resource sets used in a policy.

Members

Description

Type: string

A description of the resource set.

Id

Type: string

A unique identifier for the resource set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

LastUpdateTime

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

The last time that the resource set was changed.

Name

Type: string

The descriptive name of the resource set. You can't change the name of a resource set after you create it.

ResourceSetStatus

Type: string

Indicates whether the resource set is in or out of an admin's Region scope.

ACTIVE - The administrator can manage and delete the resource set.
OUT_OF_ADMIN_SCOPE - The administrator can view the resource set, but they can't edit or delete the resource set. Existing protections stay in place. Any new resource that come into scope of the resource set won't be protected.

ResourceTag

Description

The resource tags that Firewall Manager uses to determine if a particular resource should be included or excluded from the Firewall Manager policy. Tags enable you to categorize your Amazon Web Services 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.

Every resource tag must have a string value, either a non-empty string or an empty string. If you don't provide a value for a resource tag, Firewall Manager saves the value as an empty string: "". When Firewall Manager compares tags, it only matches two tags if they have the same key and the same value. A tag with an empty string value only matches with tags that also have an empty string value.

Members

Key

Required: Yes
Type: string

The resource tag key.

Value

Type: string

The resource tag value. To specify an empty string value, either don't provide this or specify it as "".

ResourceViolation

Description

Violation detail based on resource type.

Members

AwsEc2InstanceViolation

Type: AwsEc2InstanceViolation structure

Violation detail for an EC2 instance.

AwsEc2NetworkInterfaceViolation

Type: AwsEc2NetworkInterfaceViolation structure

Violation detail for a network interface.

AwsVPCSecurityGroupViolation

Type: AwsVPCSecurityGroupViolation structure

Violation detail for security groups.

DnsDuplicateRuleGroupViolation

Type: DnsDuplicateRuleGroupViolation structure

Violation detail for a DNS Firewall policy that indicates that a rule group that Firewall Manager tried to associate with a VPC is already associated with the VPC and can't be associated again.

DnsRuleGroupLimitExceededViolation

Type: DnsRuleGroupLimitExceededViolation structure

Violation detail for a DNS Firewall policy that indicates that the VPC reached the limit for associated DNS Firewall rule groups. Firewall Manager tried to associate another rule group with the VPC and failed.

DnsRuleGroupPriorityConflictViolation

Type: DnsRuleGroupPriorityConflictViolation structure

Violation detail for a DNS Firewall policy that indicates that a rule group that Firewall Manager tried to associate with a VPC has the same priority as a rule group that's already associated.

FirewallSubnetIsOutOfScopeViolation

Type: FirewallSubnetIsOutOfScopeViolation structure

Contains details about the firewall subnet that violates the policy scope.

FirewallSubnetMissingVPCEndpointViolation

Type: FirewallSubnetMissingVPCEndpointViolation structure

The violation details for a third-party firewall's VPC endpoint subnet that was deleted.

InvalidNetworkAclEntriesViolation

Type: InvalidNetworkAclEntriesViolation structure

Violation detail for the entries in a network ACL resource.

NetworkFirewallBlackHoleRouteDetectedViolation

Type: NetworkFirewallBlackHoleRouteDetectedViolation structure

Violation detail for an internet gateway route with an inactive state in the customer subnet route table or Network Firewall subnet route table.

NetworkFirewallInternetTrafficNotInspectedViolation

Type: NetworkFirewallInternetTrafficNotInspectedViolation structure

Violation detail for the subnet for which internet traffic hasn't been inspected.

NetworkFirewallInvalidRouteConfigurationViolation

Type: NetworkFirewallInvalidRouteConfigurationViolation structure

The route configuration is invalid.

NetworkFirewallMissingExpectedRTViolation

Type: NetworkFirewallMissingExpectedRTViolation structure

Violation detail for an Network Firewall policy that indicates that a subnet is not associated with the expected Firewall Manager managed route table.

NetworkFirewallMissingExpectedRoutesViolation

Type: NetworkFirewallMissingExpectedRoutesViolation structure

Expected routes are missing from Network Firewall.

NetworkFirewallMissingFirewallViolation

Type: NetworkFirewallMissingFirewallViolation structure

Violation detail for an Network Firewall policy that indicates that a subnet has no Firewall Manager managed firewall in its VPC.

NetworkFirewallMissingSubnetViolation

Type: NetworkFirewallMissingSubnetViolation structure

Violation detail for an Network Firewall policy that indicates that an Availability Zone is missing the expected Firewall Manager managed subnet.

NetworkFirewallPolicyModifiedViolation

Type: NetworkFirewallPolicyModifiedViolation structure

Violation detail for an Network Firewall policy that indicates that a firewall policy in an individual account has been modified in a way that makes it noncompliant. For example, the individual account owner might have deleted a rule group, changed the priority of a stateless rule group, or changed a policy default action.

NetworkFirewallUnexpectedFirewallRoutesViolation

Type: NetworkFirewallUnexpectedFirewallRoutesViolation structure

There's an unexpected firewall route.

NetworkFirewallUnexpectedGatewayRoutesViolation

Type: NetworkFirewallUnexpectedGatewayRoutesViolation structure

There's an unexpected gateway route.

PossibleRemediationActions

Type: PossibleRemediationActions structure

A list of possible remediation action lists. Each individual possible remediation action is a list of individual remediation actions.

RouteHasOutOfScopeEndpointViolation

Type: RouteHasOutOfScopeEndpointViolation structure

Contains details about the route endpoint that violates the policy scope.

ThirdPartyFirewallMissingExpectedRouteTableViolation

Type: ThirdPartyFirewallMissingExpectedRouteTableViolation structure

The violation details for a third-party firewall that has the Firewall Manager managed route table that was associated with the third-party firewall has been deleted.

ThirdPartyFirewallMissingFirewallViolation

Type: ThirdPartyFirewallMissingFirewallViolation structure

The violation details for a third-party firewall that's been deleted.

ThirdPartyFirewallMissingSubnetViolation

Type: ThirdPartyFirewallMissingSubnetViolation structure

The violation details for a third-party firewall's subnet that's been deleted.

Route

Description

Describes a route in a route table.

Members

Destination

Type: string

The destination of the route.

DestinationType

Type: string

The type of destination for the route.

Target

Type: string

The route's target.

TargetType

Type: string

The type of target for the route.

RouteHasOutOfScopeEndpointViolation

Description

Contains details about the route endpoint that violates the policy scope.

Members

CurrentFirewallSubnetRouteTable

Type: string

The route table associated with the current firewall subnet.

CurrentInternetGatewayRouteTable

Type: string

The current route table associated with the Internet Gateway.

FirewallSubnetId

Type: string

The ID of the firewall subnet.

FirewallSubnetRoutes

Type: Array of Route structures

The list of firewall subnet routes.

InternetGatewayId

Type: string

The ID of the Internet Gateway.

InternetGatewayRoutes

Type: Array of Route structures

The routes in the route table associated with the Internet Gateway.

RouteTableId

Type: string

The ID of the route table.

SubnetAvailabilityZone

Type: string

The subnet's Availability Zone.

SubnetAvailabilityZoneId

Type: string

The ID of the subnet's Availability Zone.

SubnetId

Type: string

The ID of the subnet associated with the route that violates the policy scope.

ViolatingRoutes

Type: Array of Route structures

The list of routes that violate the route table.

VpcId

Type: string

The VPC ID of the route that violates the policy scope.

SecurityGroupRemediationAction

Description

Remediation option for the rule specified in the ViolationTarget.

Members

Description

Type: string

Brief description of the action that will be performed.

IsDefaultAction

Type: boolean

Indicates if the current action is the default action.

RemediationActionType

Type: string

The remediation action that will be performed.

RemediationResult

Type: SecurityGroupRuleDescription structure

The final state of the rule specified in the ViolationTarget after it is remediated.

SecurityGroupRuleDescription

Description

Describes a set of permissions for a security group rule.

Members

FromPort

Type: long (int|float)

The start of the port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number. A value of -1 indicates all ICMP/ICMPv6 types.

IPV4Range

Type: string

The IPv4 ranges for the security group rule.

IPV6Range

Type: string

The IPv6 ranges for the security group rule.

PrefixListId

Type: string

The ID of the prefix list for the security group rule.

Protocol

Type: string

The IP protocol name (tcp, udp, icmp, icmpv6) or number.

ToPort

Type: long (int|float)

The end of the port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code. A value of -1 indicates all ICMP/ICMPv6 codes.

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.

Example: DNS_FIREWALL

"{\"type\":\"DNS_FIREWALL\",\"preProcessRuleGroups\":[{\"ruleGroupId\":\"rslvr-frg-1\",\"priority\":10}],\"postProcessRuleGroups\":[{\"ruleGroupId\":\"rslvr-frg-2\",\"priority\":9911}]}"

Valid values for preProcessRuleGroups are between 1 and 99. Valid values for postProcessRuleGroups are between 9901 and 10000.
Example: IMPORT_NETWORK_FIREWALL

"{\"type\":\"IMPORT_NETWORK_FIREWALL\",\"awsNetworkFirewallConfig\":{\"networkFirewallStatelessRuleGroupReferences\":[{\"resourceARN\":\"arn:aws:network-firewall:us-west-2:000000000000:stateless-rulegroup\/rg1\",\"priority\":1}],\"networkFirewallStatelessDefaultActions\":[\"aws:drop\"],\"networkFirewallStatelessFragmentDefaultActions\":[\"aws:pass\"],\"networkFirewallStatelessCustomActions\":[],\"networkFirewallStatefulRuleGroupReferences\":[{\"resourceARN\":\"arn:aws:network-firewall:us-west-2:aws-managed:stateful-rulegroup\/ThreatSignaturesEmergingEventsStrictOrder\",\"priority\":8}],\"networkFirewallStatefulEngineOptions\":{\"ruleOrder\":\"STRICT_ORDER\"},\"networkFirewallStatefulDefaultActions\":[\"aws:drop_strict\"]}}"

"{\"type\":\"DNS_FIREWALL\",\"preProcessRuleGroups\":[{\"ruleGroupId\":\"rslvr-frg-1\",\"priority\":10}],\"postProcessRuleGroups\":[{\"ruleGroupId\":\"rslvr-frg-2\",\"priority\":9911}]}"

Valid values for preProcessRuleGroups are between 1 and 99. Valid values for postProcessRuleGroups are between 9901 and 10000.
Example: NETWORK_FIREWALL - Centralized deployment model

"{\"type\":\"NETWORK_FIREWALL\",\"awsNetworkFirewallConfig\":{\"networkFirewallStatelessRuleGroupReferences\":[{\"resourceARN\":\"arn:aws:network-firewall:us-east-1:123456789011:stateless-rulegroup/test\",\"priority\":1}],\"networkFirewallStatelessDefaultActions\":[\"aws:forward_to_sfe\",\"customActionName\"],\"networkFirewallStatelessFragmentDefaultActions\":[\"aws:forward_to_sfe\",\"customActionName\"],\"networkFirewallStatelessCustomActions\":[{\"actionName\":\"customActionName\",\"actionDefinition\":{\"publishMetricAction\":{\"dimensions\":[{\"value\":\"metricdimensionvalue\"}]}}}],\"networkFirewallStatefulRuleGroupReferences\":[{\"resourceARN\":\"arn:aws:network-firewall:us-east-1:123456789011:stateful-rulegroup/test\"}],\"networkFirewallLoggingConfiguration\":{\"logDestinationConfigs\":[{\"logDestinationType\":\"S3\",\"logType\":\"ALERT\",\"logDestination\":{\"bucketName\":\"s3-bucket-name\"}},{\"logDestinationType\":\"S3\",\"logType\":\"FLOW\",\"logDestination\":{\"bucketName\":\"s3-bucket-name\"}}],\"overrideExistingConfig\":true}},\"firewallDeploymentModel\":{\"centralizedFirewallDeploymentModel\":{\"centralizedFirewallOrchestrationConfig\":{\"inspectionVpcIds\":[{\"resourceId\":\"vpc-1234\",\"accountId\":\"123456789011\"}],\"firewallCreationConfig\":{\"endpointLocation\":{\"availabilityZoneConfigList\":[{\"availabilityZoneId\":null,\"availabilityZoneName\":\"us-east-1a\",\"allowedIPV4CidrList\":[\"10.0.0.0/28\"]}]}},\"allowedIPV4CidrList\":[]}}}}"

To use the centralized deployment model, you must set PolicyOption to CENTRALIZED.
Example: NETWORK_FIREWALL - Distributed deployment model with automatic Availability Zone configuration

"{\"type\":\"NETWORK_FIREWALL\",\"networkFirewallStatelessRuleGroupReferences\":[{\"resourceARN\":\"arn:aws:network-firewall:us-east-1:123456789011:stateless-rulegroup/test\",\"priority\":1}],\"networkFirewallStatelessDefaultActions\":[\"aws:forward_to_sfe\",\"customActionName\"],\"networkFirewallStatelessFragmentDefaultActions\":[\"aws:forward_to_sfe\",\"customActionName\"],\"networkFirewallStatelessCustomActions\":[{\"actionName\":\"customActionName\",\"actionDefinition\":{\"publishMetricAction\":{\"dimensions\":[{\"value\":\"metricdimensionvalue\"}]}}}],\"networkFirewallStatefulRuleGroupReferences\":[{\"resourceARN\":\"arn:aws:network-firewall:us-east-1:123456789011:stateful-rulegroup/test\"}],\"networkFirewallOrchestrationConfig\":{\"singleFirewallEndpointPerVPC\":false,\"allowedIPV4CidrList\":[\"10.0.0.0/28\",\"192.168.0.0/28\"],\"routeManagementAction\":\"OFF\"},\"networkFirewallLoggingConfiguration\":{\"logDestinationConfigs\":[{\"logDestinationType\":\"S3\",\"logType\":\"ALERT\",\"logDestination\":{\"bucketName\":\"s3-bucket-name\"}},{\"logDestinationType\":\"S3\",\"logType\":\"FLOW\",\"logDestination\":{\"bucketName\":\"s3-bucket-name\"}}],\"overrideExistingConfig\":true}}"

With automatic Availbility Zone configuration, Firewall Manager chooses which Availability Zones to create the endpoints in. To use the distributed deployment model, you must set PolicyOption to NULL.
Example: NETWORK_FIREWALL - Distributed deployment model with automatic Availability Zone configuration and route management

"{\"type\":\"NETWORK_FIREWALL\",\"networkFirewallStatelessRuleGroupReferences\":[{\"resourceARN\":\"arn:aws:network-firewall:us-east-1:123456789011:stateless-rulegroup/test\",\"priority\":1}],\"networkFirewallStatelessDefaultActions\":[\"aws:forward_to_sfe\",\"customActionName\"],\"networkFirewallStatelessFragmentDefaultActions\":[\"aws:forward_to_sfe\",\"customActionName\"],\"networkFirewallStatelessCustomActions\":[{\"actionName\":\"customActionName\",\"actionDefinition\":{\"publishMetricAction\":{\"dimensions\":[{\"value\":\"metricdimensionvalue\"}]}}}],\"networkFirewallStatefulRuleGroupReferences\":[{\"resourceARN\":\"arn:aws:network-firewall:us-east-1:123456789011:stateful-rulegroup/test\"}],\"networkFirewallOrchestrationConfig\":{\"singleFirewallEndpointPerVPC\":false,\"allowedIPV4CidrList\":[\"10.0.0.0/28\",\"192.168.0.0/28\"],\"routeManagementAction\":\"MONITOR\",\"routeManagementTargetTypes\":[\"InternetGateway\"]},\"networkFirewallLoggingConfiguration\":{\"logDestinationConfigs\":[{\"logDestinationType\":\"S3\",\"logType\":\"ALERT\",\"logDestination\":{\"bucketName\":\"s3-bucket-name\"}},{\"logDestinationType\":\"S3\",\"logType\": \"FLOW\",\"logDestination\":{\"bucketName\":\"s3-bucket-name\"}}],\"overrideExistingConfig\":true}}"

To use the distributed deployment model, you must set PolicyOption to NULL.
Example: NETWORK_FIREWALL - Distributed deployment model with custom Availability Zone configuration

"{\"type\":\"NETWORK_FIREWALL\",\"networkFirewallStatelessRuleGroupReferences\":[{\"resourceARN\":\"arn:aws:network-firewall:us-east-1:123456789011:stateless-rulegroup/test\",\"priority\":1}],\"networkFirewallStatelessDefaultActions\":[\"aws:forward_to_sfe\",\"customActionName\"],\"networkFirewallStatelessFragmentDefaultActions\":[\"aws:forward_to_sfe\",\"fragmentcustomactionname\"],\"networkFirewallStatelessCustomActions\":[{\"actionName\":\"customActionName\", \"actionDefinition\":{\"publishMetricAction\":{\"dimensions\":[{\"value\":\"metricdimensionvalue\"}]}}},{\"actionName\":\"fragmentcustomactionname\",\"actionDefinition\":{\"publishMetricAction\":{\"dimensions\":[{\"value\":\"fragmentmetricdimensionvalue\"}]}}}],\"networkFirewallStatefulRuleGroupReferences\":[{\"resourceARN\":\"arn:aws:network-firewall:us-east-1:123456789011:stateful-rulegroup/test\"}],\"networkFirewallOrchestrationConfig\":{\"firewallCreationConfig\":{ \"endpointLocation\":{\"availabilityZoneConfigList\":[{\"availabilityZoneName\":\"us-east-1a\",\"allowedIPV4CidrList\":[\"10.0.0.0/28\"]},{\"availabilityZoneName\":\"us-east-1b\",\"allowedIPV4CidrList\":[ \"10.0.0.0/28\"]}]} },\"singleFirewallEndpointPerVPC\":false,\"allowedIPV4CidrList\":null,\"routeManagementAction\":\"OFF\",\"networkFirewallLoggingConfiguration\":{\"logDestinationConfigs\":[{\"logDestinationType\":\"S3\",\"logType\":\"ALERT\",\"logDestination\":{\"bucketName\":\"s3-bucket-name\"}},{\"logDestinationType\":\"S3\",\"logType\":\"FLOW\",\"logDestination\":{\"bucketName\":\"s3-bucket-name\"}}],\"overrideExistingConfig\":boolean}}"

With custom Availability Zone configuration, you define which specific Availability Zones to create endpoints in by configuring firewallCreationConfig. To configure the Availability Zones in firewallCreationConfig, specify either the availabilityZoneName or availabilityZoneId parameter, not both parameters.

To use the distributed deployment model, you must set PolicyOption to NULL.
Example: NETWORK_FIREWALL - Distributed deployment model with custom Availability Zone configuration and route management

"{\"type\":\"NETWORK_FIREWALL\",\"networkFirewallStatelessRuleGroupReferences\":[{\"resourceARN\":\"arn:aws:network-firewall:us-east-1:123456789011:stateless-rulegroup/test\",\"priority\":1}],\"networkFirewallStatelessDefaultActions\":[\"aws:forward_to_sfe\",\"customActionName\"],\"networkFirewallStatelessFragmentDefaultActions\":[\"aws:forward_to_sfe\",\"fragmentcustomactionname\"],\"networkFirewallStatelessCustomActions\":[{\"actionName\":\"customActionName\",\"actionDefinition\":{\"publishMetricAction\":{\"dimensions\":[{\"value\":\"metricdimensionvalue\"}]}}},{\"actionName\":\"fragmentcustomactionname\",\"actionDefinition\":{\"publishMetricAction\":{\"dimensions\":[{\"value\":\"fragmentmetricdimensionvalue\"}]}}}],\"networkFirewallStatefulRuleGroupReferences\":[{\"resourceARN\":\"arn:aws:network-firewall:us-east-1:123456789011:stateful-rulegroup/test\"}],\"networkFirewallOrchestrationConfig\":{\"firewallCreationConfig\":{\"endpointLocation\":{\"availabilityZoneConfigList\":[{\"availabilityZoneName\":\"us-east-1a\",\"allowedIPV4CidrList\":[\"10.0.0.0/28\"]},{\"availabilityZoneName\":\"us-east-1b\",\"allowedIPV4CidrList\":[\"10.0.0.0/28\"]}]}},\"singleFirewallEndpointPerVPC\":false,\"allowedIPV4CidrList\":null,\"routeManagementAction\":\"MONITOR\",\"routeManagementTargetTypes\":[\"InternetGateway\"],\"routeManagementConfig\":{\"allowCrossAZTrafficIfNoEndpoint\":true}},\"networkFirewallLoggingConfiguration\":{\"logDestinationConfigs\":[{\"logDestinationType\":\"S3\",\"logType\":\"ALERT\",\"logDestination\":{\"bucketName\":\"s3-bucket-name\"}},{\"logDestinationType\":\"S3\",\"logType\":\"FLOW\",\"logDestination\":{\"bucketName\":\"s3-bucket-name\"}}],\"overrideExistingConfig\":boolean}}"

To use the distributed deployment model, you must set PolicyOption to NULL.
Example: SECURITY_GROUPS_COMMON

"{\"type\":\"SECURITY_GROUPS_COMMON\",\"revertManualSecurityGroupChanges\":false,\"exclusiveResourceSecurityGroupManagement\":false, \"applyToAllEC2InstanceENIs\":false,\"securityGroups\":[{\"id\":\" sg-000e55995d61a06bd\"}]}"
Example: SECURITY_GROUPS_COMMON - Security group tag distribution

""{\"type\":\"SECURITY_GROUPS_COMMON\",\"securityGroups\":[{\"id\":\"sg-000e55995d61a06bd\"}],\"revertManualSecurityGroupChanges\":true,\"exclusiveResourceSecurityGroupManagement\":false,\"applyToAllEC2InstanceENIs\":false,\"includeSharedVPC\":false,\"enableTagDistribution\":true}""

Firewall Manager automatically distributes tags from the primary group to the security groups created by this policy. To use security group tag distribution, you must also set revertManualSecurityGroupChanges to true, otherwise Firewall Manager won't be able to create the policy. When you enable revertManualSecurityGroupChanges, Firewall Manager identifies and reports when the security groups created by this policy become non-compliant.

Firewall Manager won't distribute system tags added by Amazon Web Services services into the replica security groups. System tags begin with the aws: prefix.
Example: Shared VPCs. Apply the preceding policy to resources in shared VPCs as well as to those in VPCs that the account owns

"{\"type\":\"SECURITY_GROUPS_COMMON\",\"revertManualSecurityGroupChanges\":false,\"exclusiveResourceSecurityGroupManagement\":false, \"applyToAllEC2InstanceENIs\":false,\"includeSharedVPC\":true,\"securityGroups\":[{\"id\":\" sg-000e55995d61a06bd\"}]}"
Example: SECURITY_GROUPS_CONTENT_AUDIT

"{\"type\":\"SECURITY_GROUPS_CONTENT_AUDIT\",\"securityGroups\":[{\"id\":\"sg-000e55995d61a06bd\"}],\"securityGroupAction\":{\"type\":\"ALLOW\"}}"

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

"{\"type\":\"SECURITY_GROUPS_USAGE_AUDIT\",\"deleteUnusedSecurityGroups\":true,\"coalesceRedundantSecurityGroups\":true}"
Example: SHIELD_ADVANCED with web ACL management

"{\"type\":\"SHIELD_ADVANCED\",\"optimizeUnassociatedWebACL\":true}"

If you set optimizeUnassociatedWebACL to true, Firewall Manager creates web ACLs in accounts within the policy scope if the web ACLs will be used by at least one resource. Firewall Manager creates web ACLs in the accounts within policy scope only if the web ACLs will be used by at least one resource. If at any time an account comes into policy scope, Firewall Manager automatically creates a web ACL in the account if at least one resource will use the web ACL.

Upon enablement, Firewall Manager performs a one-time cleanup of unused web ACLs in your account. The cleanup process can take several hours. If a resource leaves policy scope after Firewall Manager creates a web ACL, Firewall Manager doesn't disassociate the resource from the web ACL. If you want Firewall Manager to clean up the web ACL, you must first manually disassociate the resources from the web ACL, and then enable the manage unused web ACLs option in your policy.

If you set optimizeUnassociatedWebACL to false, and Firewall Manager automatically creates an empty web ACL in each account that's within policy scope.
Specification for SHIELD_ADVANCED for Amazon CloudFront distributions

"{\"type\":\"SHIELD_ADVANCED\",\"automaticResponseConfiguration\": {\"automaticResponseStatus\":\"ENABLED|IGNORED|DISABLED\", \"automaticResponseAction\":\"BLOCK|COUNT\"}, \"overrideCustomerWebaclClassic\":true|false, \"optimizeUnassociatedWebACL\":true|false}"

For example: "{\"type\":\"SHIELD_ADVANCED\",\"automaticResponseConfiguration\": {\"automaticResponseStatus\":\"ENABLED\", \"automaticResponseAction\":\"COUNT\"}}"

The default value for automaticResponseStatus is IGNORED. The value for automaticResponseAction is only required when automaticResponseStatus is set to ENABLED. The default value for overrideCustomerWebaclClassic is false.

For other resource types that you can protect with a Shield Advanced policy, this ManagedServiceData configuration is an empty string.
Example: THIRD_PARTY_FIREWALL

Replace THIRD_PARTY_FIREWALL_NAME with the name of the third-party firewall.

"{ "type":"THIRD_PARTY_FIREWALL", "thirdPartyFirewall":"THIRD_PARTY_FIREWALL_NAME", "thirdPartyFirewallConfig":{ "thirdPartyFirewallPolicyList":["global-1"] }, "firewallDeploymentModel":{ "distributedFirewallDeploymentModel":{ "distributedFirewallOrchestrationConfig":{ "firewallCreationConfig":{ "endpointLocation":{ "availabilityZoneConfigList":[ { "availabilityZoneName":"${AvailabilityZone}" } ] } }, "allowedIPV4CidrList":[ ] } } } }"
Example: WAFV2 - Account takeover prevention, Bot Control managed rule groups, optimize unassociated web ACL, and rule action override

"{\"type\":\"WAFV2\",\"preProcessRuleGroups\":[{\"ruleGroupArn\":null,\"overrideAction\":{\"type\":\"NONE\"},\"managedRuleGroupIdentifier\":{\"versionEnabled\":null,\"version\":null,\"vendorName\":\"AWS\",\"managedRuleGroupName\":\"AWSManagedRulesATPRuleSet\",\"managedRuleGroupConfigs\":[{\"awsmanagedRulesATPRuleSet\":{\"loginPath\":\"/loginpath\",\"requestInspection\":{\"payloadType\":\"FORM_ENCODED|JSON\",\"usernameField\":{\"identifier\":\"/form/username\"},\"passwordField\":{\"identifier\":\"/form/password\"}}}}]},\"ruleGroupType\":\"ManagedRuleGroup\",\"excludeRules\":[],\"sampledRequestsEnabled\":true},{\"ruleGroupArn\":null,\"overrideAction\":{\"type\":\"NONE\"},\"managedRuleGroupIdentifier\":{\"versionEnabled\":null,\"version\":null,\"vendorName\":\"AWS\",\"managedRuleGroupName\":\"AWSManagedRulesBotControlRuleSet\",\"managedRuleGroupConfigs\":[{\"awsmanagedRulesBotControlRuleSet\":{\"inspectionLevel\":\"TARGETED|COMMON\"}}]},\"ruleGroupType\":\"ManagedRuleGroup\",\"excludeRules\":[],\"sampledRequestsEnabled\":true,\"ruleActionOverrides\":[{\"name\":\"Rule1\",\"actionToUse\":{\"allow|block|count|captcha|challenge\":{}}},{\"name\":\"Rule2\",\"actionToUse\":{\"allow|block|count|captcha|challenge\":{}}}]}],\"postProcessRuleGroups\":[],\"defaultAction\":{\"type\":\"ALLOW\"},\"customRequestHandling\":null,\"customResponse\":null,\"overrideCustomerWebACLAssociation\":false,\"loggingConfiguration\":null,\"sampledRequestsEnabledForDefaultActions\":true,\"optimizeUnassociatedWebACL\":true}"
- Bot Control - For information about AWSManagedRulesBotControlRuleSet managed rule groups, see AWSManagedRulesBotControlRuleSet in the WAF API Reference.
- Fraud Control account takeover prevention (ATP) - For information about the properties available for AWSManagedRulesATPRuleSet managed rule groups, see AWSManagedRulesATPRuleSet in the WAF API Reference.
- Optimize unassociated web ACL - If you set optimizeUnassociatedWebACL to true, Firewall Manager creates web ACLs in accounts within the policy scope if the web ACLs will be used by at least one resource. Firewall Manager creates web ACLs in the accounts within policy scope only if the web ACLs will be used by at least one resource. If at any time an account comes into policy scope, Firewall Manager automatically creates a web ACL in the account if at least one resource will use the web ACL.
  
  Upon enablement, Firewall Manager performs a one-time cleanup of unused web ACLs in your account. The cleanup process can take several hours. If a resource leaves policy scope after Firewall Manager creates a web ACL, Firewall Manager disassociates the resource from the web ACL, but won't clean up the unused web ACL. Firewall Manager only cleans up unused web ACLs when you first enable management of unused web ACLs in a policy.
  
  If you set optimizeUnassociatedWebACL to false Firewall Manager doesn't manage unused web ACLs, and Firewall Manager automatically creates an empty web ACL in each account that's within policy scope.
- Rule action overrides - Firewall Manager supports rule action overrides only for managed rule groups. To configure a RuleActionOverrides add the Name of the rule to override, and ActionToUse, which is the new action to use for the rule. For information about using rule action override, see RuleActionOverride in the WAF API Reference.
Example: WAFV2 - CAPTCHA and Challenge configs

"{\"type\":\"WAFV2\",\"preProcessRuleGroups\":[{\"ruleGroupArn\":null,\"overrideAction\":{\"type\":\"NONE\"},\"managedRuleGroupIdentifier\":{\"versionEnabled\":null,\"version\":null,\"vendorName\":\"AWS\",\"managedRuleGroupName\":\"AWSManagedRulesAdminProtectionRuleSet\"},\"ruleGroupType\":\"ManagedRuleGroup\",\"excludeRules\":[],\"sampledRequestsEnabled\":true}],\"postProcessRuleGroups\":[],\"defaultAction\":{\"type\":\"ALLOW\"},\"customRequestHandling\":null,\"customResponse\":null,\"overrideCustomerWebACLAssociation\":false,\"loggingConfiguration\":null,\"sampledRequestsEnabledForDefaultActions\":true,\"captchaConfig\":{\"immunityTimeProperty\":{\"immunityTime\":500}},\"challengeConfig\":{\"immunityTimeProperty\":{\"immunityTime\":800}},\"tokenDomains\":[\"google.com\",\"amazon.com\"],\"associationConfig\":{\"requestBody\":{\"CLOUDFRONT\":{\"defaultSizeInspectionLimit\":\"KB_16\"}}}}"
- CAPTCHA and Challenge configs - If you update the policy's values for associationConfig, captchaConfig, challengeConfig, or tokenDomains, Firewall Manager will overwrite your local web ACLs to contain the new value(s). However, if you don't update the policy's associationConfig, captchaConfig, challengeConfig, or tokenDomains values, the values in your local web ACLs will remain unchanged. For information about association configs, see AssociationConfig. For information about CAPTCHA and Challenge configs, see CaptchaConfig and ChallengeConfig in the WAF API Reference.
- defaultSizeInspectionLimit - Specifies the maximum size of the web request body component that an associated Amazon CloudFront distribution should send to WAF for inspection. For more information, see DefaultSizeInspectionLimit in the WAF API Reference.
Example: WAFV2 - Firewall Manager support for WAF managed rule group versioning

"{\"type\":\"WAFV2\",\"preProcessRuleGroups\":[{\"ruleGroupArn\":null,\"overrideAction\":{\"type\":\"NONE\"},\"managedRuleGroupIdentifier\":{\"versionEnabled\":true,\"version\":\"Version_2.0\",\"vendorName\":\"AWS\",\"managedRuleGroupName\":\"AWSManagedRulesCommonRuleSet\"},\"ruleGroupType\":\"ManagedRuleGroup\",\"excludeRules\":[{\"name\":\"NoUserAgent_HEADER\"}]}],\"postProcessRuleGroups\":[],\"defaultAction\":{\"type\":\"ALLOW\"},\"overrideCustomerWebACLAssociation\":false,\"loggingConfiguration\":{\"logDestinationConfigs\":[\"arn:aws:firehose:us-west-2:12345678912:deliverystream/aws-waf-logs-fms-admin-destination\"],\"redactedFields\":[{\"redactedFieldType\":\"SingleHeader\",\"redactedFieldValue\":\"Cookies\"},{\"redactedFieldType\":\"Method\"}]}}"

To use a specific version of a WAF managed rule group in your Firewall Manager policy, you must set versionEnabled to true, and set version to the version you'd like to use. If you don't set versionEnabled to true, or if you omit versionEnabled, then Firewall Manager uses the default version of the WAF managed rule group.
Example: WAFV2 - Logging configurations

"{\"type\":\"WAFV2\",\"preProcessRuleGroups\":[{\"ruleGroupArn\":null, \"overrideAction\":{\"type\":\"NONE\"},\"managedRuleGroupIdentifier\": {\"versionEnabled\":null,\"version\":null,\"vendorName\":\"AWS\", \"managedRuleGroupName\":\"AWSManagedRulesAdminProtectionRuleSet\"} ,\"ruleGroupType\":\"ManagedRuleGroup\",\"excludeRules\":[], \"sampledRequestsEnabled\":true}],\"postProcessRuleGroups\":[], \"defaultAction\":{\"type\":\"ALLOW\"},\"customRequestHandling\" :null,\"customResponse\":null,\"overrideCustomerWebACLAssociation\" :false,\"loggingConfiguration\":{\"logDestinationConfigs\": [\"arn:aws:s3:::aws-waf-logs-example-bucket\"] ,\"redactedFields\":[],\"loggingFilterConfigs\":{\"defaultBehavior\":\"KEEP\", \"filters\":[{\"behavior\":\"KEEP\",\"requirement\":\"MEETS_ALL\", \"conditions\":[{\"actionCondition\":\"CAPTCHA\"},{\"actionCondition\": \"CHALLENGE\"}, {\"actionCondition\":\"EXCLUDED_AS_COUNT\"}]}]}},\"sampledRequestsEnabledForDefaultActions\":true}"

Firewall Manager supports Amazon Kinesis Data Firehose and Amazon S3 as the logDestinationConfigs in your loggingConfiguration. For information about WAF logging configurations, see LoggingConfiguration in the WAF API Reference

In the loggingConfiguration, you can specify one logDestinationConfigs. Optionally provide as many as 20 redactedFields. The RedactedFieldType must be one of URI, QUERY_STRING, HEADER, or METHOD.
Example: WAF Classic

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

PolicyOption

Type: PolicyOption structure

Contains the settings to configure a network ACL policy, a Network Firewall firewall policy deployment model, or a third-party firewall policy.

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 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 Amazon Web Services Support.

StatefulEngineOptions

Description

Configuration settings for the handling of the stateful rule groups in a Network Firewall firewall policy.

Members

RuleOrder

Type: string

Indicates how to manage the order of stateful rule evaluation for the policy. Stateful rules are provided to the rule engine as Suricata compatible strings, and Suricata evaluates them based on certain settings. For more information, see Evaluation order for stateful rules in the Network Firewall Developer Guide.

Default: DEFAULT_ACTION_ORDER

StreamExceptionPolicy

Type: string

Indicates how Network Firewall should handle traffic when a network connection breaks midstream.

DROP - Fail closed and drop all subsequent traffic going to the firewall.
CONTINUE - Continue to apply rules to subsequent traffic without context from traffic before the break. This impacts the behavior of rules that depend on context. For example, with a stateful rule that drops HTTP traffic, Network Firewall won't match subsequent traffic because the it won't have the context from session initialization, which defines the application layer protocol as HTTP. However, a TCP-layer rule using a flow:stateless rule would still match, and so would the aws:drop_strict default action.
REJECT - Fail closed and drop all subsequent traffic going to the firewall. With this option, Network Firewall also sends a TCP reject packet back to the client so the client can immediately establish a new session. With the new session, Network Firewall will have context and will apply rules appropriately.

For applications that are reliant on long-lived TCP connections that trigger Gateway Load Balancer idle timeouts, this is the recommended setting.
FMS_IGNORE - Firewall Manager doesn't monitor or modify the Network Firewall stream exception policy settings.

For more information, see Stream exception policy in your firewall policy in the Network Firewall Developer Guide.

Default: FMS_IGNORE

StatefulRuleGroup

Description

Network Firewall stateful rule group, used in a NetworkFirewallPolicyDescription.

Members

Override

Type: NetworkFirewallStatefulRuleGroupOverride structure

The action that allows the policy owner to override the behavior of the rule group within a policy.

Priority

Type: int

An integer setting that indicates the order in which to run the stateful rule groups in a single Network Firewall firewall policy. This setting only applies to firewall policies that specify the STRICT_ORDER rule order in the stateful engine options settings.

Network Firewall evalutes each stateful rule group against a packet starting with the group that has the lowest priority setting. You must ensure that the priority settings are unique within each policy. For information about

You can change the priority settings of your rule groups at any time. To make it easier to insert rule groups later, number them so there's a wide range in between, for example use 100, 200, and so on.

ResourceId

Type: string

The resource ID of the rule group.

RuleGroupName

Type: string

The name of the rule group.

StatelessRuleGroup

Description

Network Firewall stateless rule group, used in a NetworkFirewallPolicyDescription.

Members

Priority

Type: int

The priority of the rule group. Network Firewall evaluates the stateless rule groups in a firewall policy starting from the lowest priority setting.

ResourceId

Type: string

The resource ID of the rule group.

RuleGroupName

Type: string

The name of the rule group.

Tag

Description

A collection of key:value pairs associated with an Amazon Web Services resource. The key:value pair can be anything you define. Typically, the tag key represents a category (such as "environment") and the tag value represents a specific value within that category (such as "test," "development," or "production"). You can add up to 50 tags to each Amazon Web Services resource.

Members

Key

Required: Yes
Type: string

Part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as "customer." Tag keys are case-sensitive.

Value

Required: Yes
Type: string

Part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as "companyA" or "companyB." Tag values are case-sensitive.

ThirdPartyFirewallFirewallPolicy

Description

Configures the third-party firewall's firewall policy.

Members

FirewallPolicyId

Type: string

The ID of the specified firewall policy.

FirewallPolicyName

Type: string

The name of the specified firewall policy.

ThirdPartyFirewallMissingExpectedRouteTableViolation

Description

The violation details for a third-party firewall that's not associated with an Firewall Manager managed route table.

Members

AvailabilityZone

Type: string

The Availability Zone of the firewall subnet that's causing the violation.

CurrentRouteTable

Type: string

The resource ID of the current route table that's associated with the subnet, if one is available.

ExpectedRouteTable

Type: string

The resource ID of the route table that should be associated with the subnet.

VPC

Type: string

The resource ID of the VPC associated with a fireawll subnet that's causing the violation.

ViolationTarget

Type: string

The ID of the third-party firewall or VPC resource that's causing the violation.

ThirdPartyFirewallMissingFirewallViolation

Description

The violation details about a third-party firewall's subnet that doesn't have a Firewall Manager managed firewall in its VPC.

Members

AvailabilityZone

Type: string

The Availability Zone of the third-party firewall that's causing the violation.

TargetViolationReason

Type: string

The reason the resource is causing this violation, if a reason is available.

VPC

Type: string

The resource ID of the VPC associated with a third-party firewall.

ViolationTarget

Type: string

The ID of the third-party firewall that's causing the violation.

ThirdPartyFirewallMissingSubnetViolation

Description

The violation details for a third-party firewall for an Availability Zone that's missing the Firewall Manager managed subnet.

Members

AvailabilityZone

Type: string

The Availability Zone of a subnet that's causing the violation.

TargetViolationReason

Type: string

The reason the resource is causing the violation, if a reason is available.

VPC

Type: string

The resource ID of the VPC associated with a subnet that's causing the violation.

ViolationTarget

Type: string

The ID of the third-party firewall or VPC resource that's causing the violation.

ThirdPartyFirewallPolicy

Description

Configures the deployment model for the third-party firewall.

Members

FirewallDeploymentModel

Type: string

Defines the deployment model to use for the third-party firewall policy.

ViolationDetail

Description

Violations for a resource based on the specified Firewall Manager policy and Amazon Web Services account.

Members

MemberAccount

Required: Yes
Type: string

The Amazon Web Services account that the violation details were requested for.

PolicyId

Required: Yes
Type: string

The ID of the Firewall Manager policy that the violation details were requested for.

ResourceDescription

Type: string

Brief description for the requested resource.

ResourceId

Required: Yes
Type: string

The resource ID that the violation details were requested for.

ResourceTags

Type: Array of Tag structures

The ResourceTag objects associated with the resource.

ResourceType

Required: Yes
Type: string

The resource type that the violation details were requested for.

ResourceViolations

Required: Yes
Type: Array of ResourceViolation structures

List of violations for the requested resource.

Firewall Management Service 2018-01-01

Operation Summary

Paginators

Operations

AssociateAdminAccount

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

AssociateThirdPartyFirewall

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

BatchAssociateResource

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

BatchDisassociateResource

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DeleteAppsList

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

DeleteProtocolsList

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DeleteResourceSet

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DisassociateAdminAccount

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DisassociateThirdPartyFirewall

Parameter Syntax

Parameter Details