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

Result Syntax

[]

Result Details

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

Result Syntax

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

Result Details

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

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

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

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

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

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

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

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

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

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|WEB_ACL_CONFIGURATION_OR_SCOPE_OF_USE',
            ],
            // ...
        ],
    ],
]

Result Details

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

Result Syntax

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

Result Details

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

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

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

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

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

Result Syntax

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

Result Details

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

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

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

Result Syntax

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

Result Details

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

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>',
                ],
                'WebACLHasIncompatibleConfigurationViolation' => [
                    'Description' => '<string>',
                    'WebACLArn' => '<string>',
                ],
                'WebACLHasOutOfScopeResourcesViolation' => [
                    'OutOfScopeResourceList' => ['<string>', ...],
                    'WebACLArn' => '<string>',
                ],
            ],
            // ...
        ],
    ],
]

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

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

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

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

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

[]

Result Details

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

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

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

Result Syntax

[]

Result Details

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

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

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

Result Syntax

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

Result Details

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

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

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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.