Firewall Management Service 2018-01-01
- Client: Aws\FMS\FMSClient
- Service ID: fms
- Version: 2018-01-01
This page describes the parameters and results for the operations of the Firewall Management Service (2018-01-01), and shows how to use the Aws\FMS\FMSClient object to call the described operations. This documentation is specific to the 2018-01-01 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName')
, where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */)
.
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */)
.
- AssociateAdminAccount ( array $params = [] )
Sets the AWS Firewall Manager administrator account.
- DeleteAppsList ( array $params = [] )
Permanently deletes an AWS Firewall Manager applications list.
- DeleteNotificationChannel ( array $params = [] )
Deletes an AWS Firewall Manager association with the IAM role and the Amazon Simple Notification Service (SNS) topic that is used to record AWS Firewall Manager SNS logs.
- DeletePolicy ( array $params = [] )
Permanently deletes an AWS Firewall Manager policy.
- DeleteProtocolsList ( array $params = [] )
Permanently deletes an AWS Firewall Manager protocols list.
- DisassociateAdminAccount ( array $params = [] )
Disassociates the account that has been set as the AWS Firewall Manager administrator account.
- GetAdminAccount ( array $params = [] )
Returns the AWS Organizations master account that is associated with AWS Firewall Manager as the AWS Firewall Manager administrator.
- GetAppsList ( array $params = [] )
Returns information about the specified AWS Firewall Manager applications list.
- GetComplianceDetail ( array $params = [] )
Returns detailed compliance information about the specified member account.
- GetNotificationChannel ( array $params = [] )
Information about the Amazon Simple Notification Service (SNS) topic that is used to record AWS Firewall Manager SNS logs.
- GetPolicy ( array $params = [] )
Returns information about the specified AWS Firewall Manager policy.
- GetProtectionStatus ( array $params = [] )
If you created a Shield Advanced policy, returns policy-level attack summary information in the event of a potential DDoS attack.
- GetProtocolsList ( array $params = [] )
Returns information about the specified AWS Firewall Manager protocols list.
- GetViolationDetails ( array $params = [] )
Retrieves violations for a resource based on the specified AWS Firewall Manager policy and AWS account.
- ListAppsLists ( array $params = [] )
Returns an array of AppsListDataSummary objects.
- ListComplianceStatus ( array $params = [] )
Returns an array of PolicyComplianceStatus objects.
- ListMemberAccounts ( array $params = [] )
Returns a MemberAccounts object that lists the member accounts in the administrator's AWS organization.
- ListPolicies ( array $params = [] )
Returns an array of PolicySummary objects.
- ListProtocolsLists ( array $params = [] )
Returns an array of ProtocolsListDataSummary objects.
- ListTagsForResource ( array $params = [] )
Retrieves the list of tags for the specified AWS resource.
- PutAppsList ( array $params = [] )
Creates an AWS Firewall Manager applications list.
- PutNotificationChannel ( array $params = [] )
Designates the IAM role and Amazon Simple Notification Service (SNS) topic that AWS Firewall Manager uses to record SNS logs.
- PutPolicy ( array $params = [] )
Creates an AWS Firewall Manager policy.
- PutProtocolsList ( array $params = [] )
Creates an AWS Firewall Manager protocols list.
- TagResource ( array $params = [] )
Adds one or more tags to an AWS resource.
- UntagResource ( array $params = [] )
Removes one or more tags from an AWS resource.
Paginators
Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:
Operations
AssociateAdminAccount
$result = $client->associateAdminAccount
([/* ... */]); $promise = $client->associateAdminAccountAsync
([/* ... */]);
Sets the AWS Firewall Manager administrator account. AWS Firewall Manager must be associated with the master account of your AWS organization or associated with a member account that has the appropriate permissions. If the account ID that you submit is not an AWS Organizations master account, AWS Firewall Manager will set the appropriate permissions for the given member account.
The account that you associate with AWS Firewall Manager is called the AWS Firewall Manager administrator account.
Parameter Syntax
$result = $client->associateAdminAccount([ 'AdminAccount' => '<string>', // REQUIRED ]);
Parameter Details
Members
- AdminAccount
-
- Required: Yes
- Type: string
The AWS account ID to associate with AWS Firewall Manager as the AWS Firewall Manager administrator account. This can be an AWS Organizations master account or a member account. For more information about AWS Organizations and master accounts, see Managing the AWS Accounts in Your Organization.
Result Syntax
[]
Result Details
Errors
-
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 AWS 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 AWS Organizations before you can access it. -
The parameters of the request were invalid.
-
The specified resource was not found.
-
The operation failed because of a system problem, even though the request was valid. Retry your request.
DeleteAppsList
$result = $client->deleteAppsList
([/* ... */]); $promise = $client->deleteAppsListAsync
([/* ... */]);
Permanently deletes an AWS Firewall Manager applications list.
Parameter Syntax
$result = $client->deleteAppsList([ 'ListId' => '<string>', // REQUIRED ]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
The specified resource was not found.
-
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 AWS 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 AWS Organizations before you can access it. -
The operation failed because of a system problem, even though the request was valid. Retry your request.
DeleteNotificationChannel
$result = $client->deleteNotificationChannel
([/* ... */]); $promise = $client->deleteNotificationChannelAsync
([/* ... */]);
Deletes an AWS Firewall Manager association with the IAM role and the Amazon Simple Notification Service (SNS) topic that is used to record AWS Firewall Manager SNS logs.
Parameter Syntax
$result = $client->deleteNotificationChannel([ ]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
The specified resource was not found.
-
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 AWS 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 AWS Organizations before you can access it. -
The operation failed because of a system problem, even though the request was valid. Retry your request.
DeletePolicy
$result = $client->deletePolicy
([/* ... */]); $promise = $client->deletePolicyAsync
([/* ... */]);
Permanently deletes an AWS Firewall Manager policy.
Parameter Syntax
$result = $client->deletePolicy([ 'DeleteAllPolicyResources' => true || false, 'PolicyId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- DeleteAllPolicyResources
-
- Type: boolean
If
True
, the request performs cleanup according to the policy type.For AWS WAF and Shield Advanced policies, the cleanup does the following:
-
Deletes rule groups created by AWS Firewall Manager
-
Removes web ACLs from in-scope resources
-
Deletes web ACLs that contain no rules or rule groups
For security group policies, the cleanup does the following for each security group in the policy:
-
Disassociates the security group from in-scope resources
-
Deletes the security group if it was created through Firewall Manager and if it's no longer associated with any resources through another policy
After the cleanup, in-scope resources are no longer protected by web ACLs in this policy. Protection of out-of-scope resources remains unchanged. Scope is determined by tags that you create and accounts that you associate with the policy. When creating the policy, if you specify that only resources in specific accounts or with specific tags are in scope of the policy, those accounts and resources are handled by the policy. All others are out of scope. If you don't specify tags or accounts, all resources are in scope.
- PolicyId
-
- Required: Yes
- Type: string
The ID of the policy that you want to delete. You can retrieve this ID from
PutPolicy
andListPolicies
.
Result Syntax
[]
Result Details
Errors
-
The specified resource was not found.
-
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 AWS 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 AWS Organizations before you can access it. -
The operation failed because of a system problem, even though the request was valid. Retry your request.
-
The parameters of the request were invalid.
-
The operation exceeds a resource limit, for example, the maximum number of
policy
objects that you can create for an AWS account. For more information, see Firewall Manager Limits in the AWS WAF Developer Guide.
DeleteProtocolsList
$result = $client->deleteProtocolsList
([/* ... */]); $promise = $client->deleteProtocolsListAsync
([/* ... */]);
Permanently deletes an AWS Firewall Manager protocols list.
Parameter Syntax
$result = $client->deleteProtocolsList([ 'ListId' => '<string>', // REQUIRED ]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
The specified resource was not found.
-
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 AWS 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 AWS Organizations before you can access it. -
The operation failed because of a system problem, even though the request was valid. Retry your request.
DisassociateAdminAccount
$result = $client->disassociateAdminAccount
([/* ... */]); $promise = $client->disassociateAdminAccountAsync
([/* ... */]);
Disassociates the account that has been set as the AWS Firewall Manager administrator account. To set a different account as the administrator account, you must submit an AssociateAdminAccount
request.
Parameter Syntax
$result = $client->disassociateAdminAccount([ ]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
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 AWS 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 AWS Organizations before you can access it. -
The specified resource was not found.
-
The operation failed because of a system problem, even though the request was valid. Retry your request.
GetAdminAccount
$result = $client->getAdminAccount
([/* ... */]); $promise = $client->getAdminAccountAsync
([/* ... */]);
Returns the AWS Organizations master account that is associated with AWS Firewall Manager as the AWS Firewall Manager administrator.
Parameter Syntax
$result = $client->getAdminAccount([ ]);
Parameter Details
Members
Result Syntax
[ 'AdminAccount' => '<string>', 'RoleStatus' => 'READY|CREATING|PENDING_DELETION|DELETING|DELETED', ]
Result Details
Members
Errors
-
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 AWS 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 AWS Organizations before you can access it. -
The specified resource was not found.
-
The operation failed because of a system problem, even though the request was valid. Retry your request.
GetAppsList
$result = $client->getAppsList
([/* ... */]); $promise = $client->getAppsListAsync
([/* ... */]);
Returns information about the specified AWS Firewall Manager applications list.
Parameter Syntax
$result = $client->getAppsList([ 'DefaultList' => true || false, 'ListId' => '<string>', // REQUIRED ]);
Parameter Details
Members
Result Syntax
[ 'AppsList' => [ 'AppsList' => [ [ 'AppName' => '<string>', 'Port' => <integer>, 'Protocol' => '<string>', ], // ... ], 'CreateTime' => <DateTime>, 'LastUpdateTime' => <DateTime>, 'ListId' => '<string>', 'ListName' => '<string>', 'ListUpdateToken' => '<string>', 'PreviousAppsList' => [ '<PreviousListVersion>' => [ [ 'AppName' => '<string>', 'Port' => <integer>, 'Protocol' => '<string>', ], // ... ], // ... ], ], 'AppsListArn' => '<string>', ]
Result Details
Members
- AppsList
-
- Type: AppsListData structure
Information about the specified AWS Firewall Manager applications list.
- AppsListArn
-
- Type: string
The Amazon Resource Name (ARN) of the applications list.
Errors
-
The specified resource was not found.
-
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 AWS 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 AWS Organizations before you can access it. -
The operation failed because of a system problem, even though the request was valid. Retry your request.
GetComplianceDetail
$result = $client->getComplianceDetail
([/* ... */]); $promise = $client->getComplianceDetailAsync
([/* ... */]);
Returns detailed compliance information about the specified member account. Details include resources that are in and out of compliance with the specified policy. Resources are considered noncompliant for AWS WAF and Shield Advanced policies if the specified policy has not been applied to them. Resources are considered noncompliant for security group policies if they are in scope of the policy, they violate one or more of the policy rules, and remediation is disabled or not possible. Resources are considered noncompliant for Network Firewall policies if a firewall is missing in the VPC, if the firewall endpoint isn't set up in an expected Availability Zone and subnet, if a subnet created by the Firewall Manager doesn't have the expected route table, and for modifications to a firewall policy that violate the Firewall Manager policy's rules.
Parameter Syntax
$result = $client->getComplianceDetail([ 'MemberAccount' => '<string>', // REQUIRED 'PolicyId' => '<string>', // REQUIRED ]);
Parameter Details
Members
Result Syntax
[ 'PolicyComplianceDetail' => [ 'EvaluationLimitExceeded' => true || false, 'ExpiredAt' => <DateTime>, 'IssueInfoMap' => ['<string>', ...], 'MemberAccount' => '<string>', 'PolicyId' => '<string>', 'PolicyOwner' => '<string>', 'Violators' => [ [ 'ResourceId' => '<string>', 'ResourceType' => '<string>', 'ViolationReason' => 'WEB_ACL_MISSING_RULE_GROUP|RESOURCE_MISSING_WEB_ACL|RESOURCE_INCORRECT_WEB_ACL|RESOURCE_MISSING_SHIELD_PROTECTION|RESOURCE_MISSING_WEB_ACL_OR_SHIELD_PROTECTION|RESOURCE_MISSING_SECURITY_GROUP|RESOURCE_VIOLATES_AUDIT_SECURITY_GROUP|SECURITY_GROUP_UNUSED|SECURITY_GROUP_REDUNDANT|MISSING_FIREWALL|MISSING_FIREWALL_SUBNET_IN_AZ|MISSING_EXPECTED_ROUTE_TABLE|NETWORK_FIREWALL_POLICY_MODIFIED', ], // ... ], ], ]
Result Details
Members
- PolicyComplianceDetail
-
- Type: PolicyComplianceDetail structure
Information about the resources and the policy that you specified in the
GetComplianceDetail
request.
Errors
-
The specified resource was not found.
-
The operation failed because of a system problem, even though the request was valid. Retry your request.
-
The parameters of the request were invalid.
-
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 AWS 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 AWS 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 AWS Firewall Manager SNS logs.
Parameter Syntax
$result = $client->getNotificationChannel([ ]);
Parameter Details
Members
Result Syntax
[ 'SnsRoleName' => '<string>', 'SnsTopicArn' => '<string>', ]
Result Details
Members
Errors
-
The specified resource was not found.
-
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 AWS 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 AWS Organizations before you can access it. -
The operation failed because of a system problem, even though the request was valid. Retry your request.
GetPolicy
$result = $client->getPolicy
([/* ... */]); $promise = $client->getPolicyAsync
([/* ... */]);
Returns information about the specified AWS Firewall Manager policy.
Parameter Syntax
$result = $client->getPolicy([ 'PolicyId' => '<string>', // REQUIRED ]);
Parameter Details
Members
Result Syntax
[ 'Policy' => [ 'ExcludeMap' => [ '<CustomerPolicyScopeIdType>' => ['<string>', ...], // ... ], 'ExcludeResourceTags' => true || false, 'IncludeMap' => [ '<CustomerPolicyScopeIdType>' => ['<string>', ...], // ... ], 'PolicyId' => '<string>', 'PolicyName' => '<string>', 'PolicyUpdateToken' => '<string>', 'RemediationEnabled' => true || false, 'ResourceTags' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], 'ResourceType' => '<string>', 'ResourceTypeList' => ['<string>', ...], 'SecurityServicePolicyData' => [ 'ManagedServiceData' => '<string>', 'Type' => 'WAF|WAFV2|SHIELD_ADVANCED|SECURITY_GROUPS_COMMON|SECURITY_GROUPS_CONTENT_AUDIT|SECURITY_GROUPS_USAGE_AUDIT|NETWORK_FIREWALL', ], ], 'PolicyArn' => '<string>', ]
Result Details
Members
- Policy
-
- Type: Policy structure
Information about the specified AWS Firewall Manager policy.
- PolicyArn
-
- Type: string
The Amazon Resource Name (ARN) of the specified policy.
Errors
-
The specified resource was not found.
-
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 AWS 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 AWS Organizations before you can access it. -
The operation failed because of a system problem, even though the request was valid. Retry your request.
-
The value of the
Type
parameter is invalid.
GetProtectionStatus
$result = $client->getProtectionStatus
([/* ... */]); $promise = $client->getProtectionStatusAsync
([/* ... */]);
If you created a Shield Advanced policy, returns policy-level attack summary information in the event of a potential DDoS attack. Other policy types are currently unsupported.
Parameter Syntax
$result = $client->getProtectionStatus([ 'EndTime' => <integer || string || DateTime>, 'MaxResults' => <integer>, 'MemberAccountId' => '<string>', 'NextToken' => '<string>', 'PolicyId' => '<string>', // REQUIRED 'StartTime' => <integer || string || DateTime>, ]);
Parameter Details
Members
- EndTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The end of the time period to query for the attacks. This is a
timestamp
type. The request syntax listing indicates anumber
type because the default used by AWS Firewall Manager is Unix time in seconds. However, any validtimestamp
format is allowed. - MaxResults
-
- Type: int
Specifies the number of objects that you want AWS Firewall Manager to return for this request. If you have more objects than the number that you specify for
MaxResults
, the response includes aNextToken
value that you can use to get another batch of objects. - MemberAccountId
-
- Type: string
The AWS account that is in scope of the policy that you want to get the details for.
- NextToken
-
- Type: string
If you specify a value for
MaxResults
and you have more objects than the number that you specify forMaxResults
, AWS Firewall Manager returns aNextToken
value in the response, which you can use to retrieve another group of objects. For the second and subsequentGetProtectionStatus
requests, specify the value ofNextToken
from the previous response to get information about another batch of objects. - PolicyId
-
- Required: Yes
- Type: string
The ID of the policy for which you want to get the attack information.
- StartTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The start of the time period to query for the attacks. This is a
timestamp
type. The request syntax listing indicates anumber
type because the default used by AWS Firewall Manager is Unix time in seconds. However, any validtimestamp
format is allowed.
Result Syntax
[ 'AdminAccountId' => '<string>', 'Data' => '<string>', 'NextToken' => '<string>', 'ServiceType' => 'WAF|WAFV2|SHIELD_ADVANCED|SECURITY_GROUPS_COMMON|SECURITY_GROUPS_CONTENT_AUDIT|SECURITY_GROUPS_USAGE_AUDIT|NETWORK_FIREWALL', ]
Result Details
Members
- AdminAccountId
-
- Type: string
The ID of the AWS Firewall administrator account for this policy.
- Data
-
- Type: string
Details about the attack, including the following:
-
Attack type
-
Account ID
-
ARN of the resource attacked
-
Start time of the attack
-
End time of the attack (ongoing attacks will not have an end time)
The details are in JSON format.
- NextToken
-
- Type: string
If you have more objects than the number that you specified for
MaxResults
in the request, the response includes aNextToken
value. To list more objects, submit anotherGetProtectionStatus
request, and specify theNextToken
value from the response in theNextToken
value in the next request.AWS SDKs provide auto-pagination that identify
NextToken
in a response and make subsequent request calls automatically on your behalf. However, this feature is not supported byGetProtectionStatus
. You must submit subsequent requests withNextToken
using your own processes. - ServiceType
-
- Type: string
The service type that is protected by the policy. Currently, this is always
SHIELD_ADVANCED
.
Errors
-
The parameters of the request were invalid.
-
The specified resource was not found.
-
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 AWS Firewall Manager protocols list.
Parameter Syntax
$result = $client->getProtocolsList([ 'DefaultList' => true || false, 'ListId' => '<string>', // REQUIRED ]);
Parameter Details
Members
Result Syntax
[ 'ProtocolsList' => [ 'CreateTime' => <DateTime>, 'LastUpdateTime' => <DateTime>, 'ListId' => '<string>', 'ListName' => '<string>', 'ListUpdateToken' => '<string>', 'PreviousProtocolsList' => [ '<PreviousListVersion>' => ['<string>', ...], // ... ], 'ProtocolsList' => ['<string>', ...], ], 'ProtocolsListArn' => '<string>', ]
Result Details
Members
- ProtocolsList
-
- Type: ProtocolsListData structure
Information about the specified AWS Firewall Manager protocols list.
- ProtocolsListArn
-
- Type: string
The Amazon Resource Name (ARN) of the specified protocols list.
Errors
-
The specified resource was not found.
-
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 AWS 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 AWS Organizations before you can access it. -
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 AWS Firewall Manager policy and AWS account.
Parameter Syntax
$result = $client->getViolationDetails([ 'MemberAccount' => '<string>', // REQUIRED 'PolicyId' => '<string>', // REQUIRED 'ResourceId' => '<string>', // REQUIRED 'ResourceType' => '<string>', // REQUIRED ]);
Parameter Details
Members
- MemberAccount
-
- Required: Yes
- Type: string
The AWS account ID that you want the details for.
- PolicyId
-
- Required: Yes
- Type: string
The ID of the AWS Firewall Manager policy that you want the details for. This currently only supports security group content audit policies.
- ResourceId
-
- Required: Yes
- Type: string
The ID of the resource that has violations.
- ResourceType
-
- Required: Yes
- Type: string
The resource type. This is in the format shown in the AWS Resource Types Reference. Supported resource types are:
AWS::EC2::Instance
,AWS::EC2::NetworkInterface
,AWS::EC2::SecurityGroup
,AWS::NetworkFirewall::FirewallPolicy
, andAWS::EC2::Subnet
.
Result Syntax
[ 'ViolationDetail' => [ 'MemberAccount' => '<string>', 'PolicyId' => '<string>', 'ResourceDescription' => '<string>', 'ResourceId' => '<string>', 'ResourceTags' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], 'ResourceType' => '<string>', 'ResourceViolations' => [ [ 'AwsEc2InstanceViolation' => [ 'AwsEc2NetworkInterfaceViolations' => [ [ 'ViolatingSecurityGroups' => ['<string>', ...], 'ViolationTarget' => '<string>', ], // ... ], 'ViolationTarget' => '<string>', ], 'AwsEc2NetworkInterfaceViolation' => [ 'ViolatingSecurityGroups' => ['<string>', ...], 'ViolationTarget' => '<string>', ], 'AwsVPCSecurityGroupViolation' => [ 'PartialMatches' => [ [ 'Reference' => '<string>', 'TargetViolationReasons' => ['<string>', ...], ], // ... ], 'PossibleSecurityGroupRemediationActions' => [ [ 'Description' => '<string>', 'IsDefaultAction' => true || false, 'RemediationActionType' => 'REMOVE|MODIFY', 'RemediationResult' => [ 'FromPort' => <integer>, 'IPV4Range' => '<string>', 'IPV6Range' => '<string>', 'PrefixListId' => '<string>', 'Protocol' => '<string>', 'ToPort' => <integer>, ], ], // ... ], 'ViolationTarget' => '<string>', 'ViolationTargetDescription' => '<string>', ], 'NetworkFirewallMissingExpectedRTViolation' => [ 'AvailabilityZone' => '<string>', 'CurrentRouteTable' => '<string>', 'ExpectedRouteTable' => '<string>', 'VPC' => '<string>', 'ViolationTarget' => '<string>', ], 'NetworkFirewallMissingFirewallViolation' => [ 'AvailabilityZone' => '<string>', 'TargetViolationReason' => '<string>', 'VPC' => '<string>', 'ViolationTarget' => '<string>', ], 'NetworkFirewallMissingSubnetViolation' => [ 'AvailabilityZone' => '<string>', 'TargetViolationReason' => '<string>', 'VPC' => '<string>', 'ViolationTarget' => '<string>', ], 'NetworkFirewallPolicyModifiedViolation' => [ 'CurrentPolicyDescription' => [ 'StatefulRuleGroups' => [ [ 'ResourceId' => '<string>', 'RuleGroupName' => '<string>', ], // ... ], 'StatelessCustomActions' => ['<string>', ...], 'StatelessDefaultActions' => ['<string>', ...], 'StatelessFragmentDefaultActions' => ['<string>', ...], 'StatelessRuleGroups' => [ [ 'Priority' => <integer>, 'ResourceId' => '<string>', 'RuleGroupName' => '<string>', ], // ... ], ], 'ExpectedPolicyDescription' => [ 'StatefulRuleGroups' => [ [ 'ResourceId' => '<string>', 'RuleGroupName' => '<string>', ], // ... ], 'StatelessCustomActions' => ['<string>', ...], 'StatelessDefaultActions' => ['<string>', ...], 'StatelessFragmentDefaultActions' => ['<string>', ...], 'StatelessRuleGroups' => [ [ 'Priority' => <integer>, 'ResourceId' => '<string>', 'RuleGroupName' => '<string>', ], // ... ], ], 'ViolationTarget' => '<string>', ], ], // ... ], ], ]
Result Details
Members
- ViolationDetail
-
- Type: ViolationDetail structure
Violation detail for a resource.
Errors
-
The specified resource was not found.
-
The parameters of the request were invalid.
-
The operation failed because of a system problem, even though the request was valid. Retry your request.
ListAppsLists
$result = $client->listAppsLists
([/* ... */]); $promise = $client->listAppsListsAsync
([/* ... */]);
Returns an array of AppsListDataSummary
objects.
Parameter Syntax
$result = $client->listAppsLists([ 'DefaultLists' => true || false, 'MaxResults' => <integer>, // REQUIRED 'NextToken' => '<string>', ]);
Parameter Details
Members
- DefaultLists
-
- Type: boolean
Specifies whether the lists to retrieve are default lists owned by AWS Firewall Manager.
- MaxResults
-
- Required: Yes
- Type: int
The maximum number of objects that you want AWS Firewall Manager to return for this request. If more objects are available, in the response, AWS Firewall Manager provides a
NextToken
value that you can use in a subsequent call to get the next batch of objects.If you don't specify this, AWS Firewall Manager returns all available objects.
- NextToken
-
- Type: string
If you specify a value for
MaxResults
in your list request, and you have more objects than the maximum, AWS Firewall Manager returns this token in the response. For all but the first request, you provide the token returned by the prior request in the request parameters, to retrieve the next batch of objects.
Result Syntax
[ 'AppsLists' => [ [ 'AppsList' => [ [ 'AppName' => '<string>', 'Port' => <integer>, 'Protocol' => '<string>', ], // ... ], 'ListArn' => '<string>', 'ListId' => '<string>', 'ListName' => '<string>', ], // ... ], 'NextToken' => '<string>', ]
Result Details
Members
- AppsLists
-
- Type: Array of AppsListDataSummary structures
An array of
AppsListDataSummary
objects. - NextToken
-
- Type: string
If you specify a value for
MaxResults
in your list request, and you have more objects than the maximum, AWS Firewall Manager returns this token in the response. You can use this token in subsequent requests to retrieve the next batch of objects.
Errors
-
The specified resource was not found.
-
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 AWS 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 AWS Organizations before you can access it. -
The operation exceeds a resource limit, for example, the maximum number of
policy
objects that you can create for an AWS account. For more information, see Firewall Manager Limits in the AWS WAF Developer Guide. -
The operation failed because of a system problem, even though the request was valid. Retry your request.
ListComplianceStatus
$result = $client->listComplianceStatus
([/* ... */]); $promise = $client->listComplianceStatusAsync
([/* ... */]);
Returns an array of PolicyComplianceStatus
objects. Use PolicyComplianceStatus
to get a summary of which member accounts are protected by the specified policy.
Parameter Syntax
$result = $client->listComplianceStatus([ 'MaxResults' => <integer>, 'NextToken' => '<string>', 'PolicyId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- MaxResults
-
- Type: int
Specifies the number of
PolicyComplianceStatus
objects that you want AWS Firewall Manager to return for this request. If you have morePolicyComplianceStatus
objects than the number that you specify forMaxResults
, the response includes aNextToken
value that you can use to get another batch ofPolicyComplianceStatus
objects. - NextToken
-
- Type: string
If you specify a value for
MaxResults
and you have morePolicyComplianceStatus
objects than the number that you specify forMaxResults
, AWS Firewall Manager returns aNextToken
value in the response that allows you to list another group ofPolicyComplianceStatus
objects. For the second and subsequentListComplianceStatus
requests, specify the value ofNextToken
from the previous response to get information about another batch ofPolicyComplianceStatus
objects. - PolicyId
-
- Required: Yes
- Type: string
The ID of the AWS Firewall Manager policy that you want the details for.
Result Syntax
[ 'NextToken' => '<string>', 'PolicyComplianceStatusList' => [ [ 'EvaluationResults' => [ [ 'ComplianceStatus' => 'COMPLIANT|NON_COMPLIANT', 'EvaluationLimitExceeded' => true || false, 'ViolatorCount' => <integer>, ], // ... ], 'IssueInfoMap' => ['<string>', ...], 'LastUpdated' => <DateTime>, 'MemberAccount' => '<string>', 'PolicyId' => '<string>', 'PolicyName' => '<string>', 'PolicyOwner' => '<string>', ], // ... ], ]
Result Details
Members
- NextToken
-
- Type: string
If you have more
PolicyComplianceStatus
objects than the number that you specified forMaxResults
in the request, the response includes aNextToken
value. To list morePolicyComplianceStatus
objects, submit anotherListComplianceStatus
request, and specify theNextToken
value from the response in theNextToken
value in the next request. - PolicyComplianceStatusList
-
- Type: Array of PolicyComplianceStatus structures
An array of
PolicyComplianceStatus
objects.
Errors
-
The specified resource was not found.
-
The operation failed because of a system problem, even though the request was valid. Retry your request.
ListMemberAccounts
$result = $client->listMemberAccounts
([/* ... */]); $promise = $client->listMemberAccountsAsync
([/* ... */]);
Returns a MemberAccounts
object that lists the member accounts in the administrator's AWS organization.
The ListMemberAccounts
must be submitted by the account that is set as the AWS Firewall Manager administrator.
Parameter Syntax
$result = $client->listMemberAccounts([ 'MaxResults' => <integer>, 'NextToken' => '<string>', ]);
Parameter Details
Members
- MaxResults
-
- Type: int
Specifies the number of member account IDs that you want AWS Firewall Manager to return for this request. If you have more IDs than the number that you specify for
MaxResults
, the response includes aNextToken
value that you can use to get another batch of member account IDs. - NextToken
-
- Type: string
If you specify a value for
MaxResults
and you have more account IDs than the number that you specify forMaxResults
, AWS Firewall Manager returns aNextToken
value in the response that allows you to list another group of IDs. For the second and subsequentListMemberAccountsRequest
requests, specify the value ofNextToken
from the previous response to get information about another batch of member account IDs.
Result Syntax
[ 'MemberAccounts' => ['<string>', ...], 'NextToken' => '<string>', ]
Result Details
Members
- MemberAccounts
-
- Type: Array of strings
An array of account IDs.
- NextToken
-
- Type: string
If you have more member account IDs than the number that you specified for
MaxResults
in the request, the response includes aNextToken
value. To list more IDs, submit anotherListMemberAccounts
request, and specify theNextToken
value from the response in theNextToken
value in the next request.
Errors
-
The specified resource was not found.
-
The operation failed because of a system problem, even though the request was valid. Retry your request.
ListPolicies
$result = $client->listPolicies
([/* ... */]); $promise = $client->listPoliciesAsync
([/* ... */]);
Returns an array of PolicySummary
objects.
Parameter Syntax
$result = $client->listPolicies([ 'MaxResults' => <integer>, 'NextToken' => '<string>', ]);
Parameter Details
Members
- MaxResults
-
- Type: int
Specifies the number of
PolicySummary
objects that you want AWS Firewall Manager to return for this request. If you have morePolicySummary
objects than the number that you specify forMaxResults
, the response includes aNextToken
value that you can use to get another batch ofPolicySummary
objects. - NextToken
-
- Type: string
If you specify a value for
MaxResults
and you have morePolicySummary
objects than the number that you specify forMaxResults
, AWS Firewall Manager returns aNextToken
value in the response that allows you to list another group ofPolicySummary
objects. For the second and subsequentListPolicies
requests, specify the value ofNextToken
from the previous response to get information about another batch ofPolicySummary
objects.
Result Syntax
[ 'NextToken' => '<string>', 'PolicyList' => [ [ 'PolicyArn' => '<string>', 'PolicyId' => '<string>', 'PolicyName' => '<string>', 'RemediationEnabled' => true || false, 'ResourceType' => '<string>', 'SecurityServiceType' => 'WAF|WAFV2|SHIELD_ADVANCED|SECURITY_GROUPS_COMMON|SECURITY_GROUPS_CONTENT_AUDIT|SECURITY_GROUPS_USAGE_AUDIT|NETWORK_FIREWALL', ], // ... ], ]
Result Details
Members
- NextToken
-
- Type: string
If you have more
PolicySummary
objects than the number that you specified forMaxResults
in the request, the response includes aNextToken
value. To list morePolicySummary
objects, submit anotherListPolicies
request, and specify theNextToken
value from the response in theNextToken
value in the next request. - PolicyList
-
- Type: Array of PolicySummary structures
An array of
PolicySummary
objects.
Errors
-
The specified resource was not found.
-
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 AWS 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 AWS Organizations before you can access it. -
The operation exceeds a resource limit, for example, the maximum number of
policy
objects that you can create for an AWS account. For more information, see Firewall Manager Limits in the AWS WAF Developer Guide. -
The operation failed because of a system problem, even though the request was valid. Retry your request.
ListProtocolsLists
$result = $client->listProtocolsLists
([/* ... */]); $promise = $client->listProtocolsListsAsync
([/* ... */]);
Returns an array of ProtocolsListDataSummary
objects.
Parameter Syntax
$result = $client->listProtocolsLists([ 'DefaultLists' => true || false, 'MaxResults' => <integer>, // REQUIRED 'NextToken' => '<string>', ]);
Parameter Details
Members
- DefaultLists
-
- Type: boolean
Specifies whether the lists to retrieve are default lists owned by AWS Firewall Manager.
- MaxResults
-
- Required: Yes
- Type: int
The maximum number of objects that you want AWS Firewall Manager to return for this request. If more objects are available, in the response, AWS Firewall Manager provides a
NextToken
value that you can use in a subsequent call to get the next batch of objects.If you don't specify this, AWS Firewall Manager returns all available objects.
- NextToken
-
- Type: string
If you specify a value for
MaxResults
in your list request, and you have more objects than the maximum, AWS Firewall Manager returns this token in the response. For all but the first request, you provide the token returned by the prior request in the request parameters, to retrieve the next batch of objects.
Result Syntax
[ 'NextToken' => '<string>', 'ProtocolsLists' => [ [ 'ListArn' => '<string>', 'ListId' => '<string>', 'ListName' => '<string>', 'ProtocolsList' => ['<string>', ...], ], // ... ], ]
Result Details
Members
- NextToken
-
- Type: string
If you specify a value for
MaxResults
in your list request, and you have more objects than the maximum, AWS Firewall Manager returns this token in the response. You can use this token in subsequent requests to retrieve the next batch of objects. - ProtocolsLists
-
- Type: Array of ProtocolsListDataSummary structures
An array of
ProtocolsListDataSummary
objects.
Errors
-
The specified resource was not found.
-
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 AWS 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 AWS Organizations before you can access it. -
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 AWS resource.
Parameter Syntax
$result = $client->listTagsForResource([ 'ResourceArn' => '<string>', // REQUIRED ]);
Parameter Details
Members
Result Syntax
[ 'TagList' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], ]
Result Details
Members
- TagList
-
- Type: Array of Tag structures
The tags associated with the resource.
Errors
-
The specified resource was not found.
-
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 AWS 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 AWS Organizations before you can access it. -
The operation failed because of a system problem, even though the request was valid. Retry your request.
-
The parameters of the request were invalid.
PutAppsList
$result = $client->putAppsList
([/* ... */]); $promise = $client->putAppsListAsync
([/* ... */]);
Creates an AWS Firewall Manager applications list.
Parameter Syntax
$result = $client->putAppsList([ 'AppsList' => [ // REQUIRED 'AppsList' => [ // REQUIRED [ 'AppName' => '<string>', // REQUIRED 'Port' => <integer>, // REQUIRED 'Protocol' => '<string>', // REQUIRED ], // ... ], 'CreateTime' => <integer || string || DateTime>, 'LastUpdateTime' => <integer || string || DateTime>, 'ListId' => '<string>', 'ListName' => '<string>', // REQUIRED 'ListUpdateToken' => '<string>', 'PreviousAppsList' => [ '<PreviousListVersion>' => [ [ 'AppName' => '<string>', // REQUIRED 'Port' => <integer>, // REQUIRED 'Protocol' => '<string>', // REQUIRED ], // ... ], // ... ], ], 'TagList' => [ [ 'Key' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ]);
Parameter Details
Members
- AppsList
-
- Required: Yes
- Type: AppsListData structure
The details of the AWS Firewall Manager applications list to be created.
- TagList
-
- Type: Array of Tag structures
The tags associated with the resource.
Result Syntax
[ 'AppsList' => [ 'AppsList' => [ [ 'AppName' => '<string>', 'Port' => <integer>, 'Protocol' => '<string>', ], // ... ], 'CreateTime' => <DateTime>, 'LastUpdateTime' => <DateTime>, 'ListId' => '<string>', 'ListName' => '<string>', 'ListUpdateToken' => '<string>', 'PreviousAppsList' => [ '<PreviousListVersion>' => [ [ 'AppName' => '<string>', 'Port' => <integer>, 'Protocol' => '<string>', ], // ... ], // ... ], ], 'AppsListArn' => '<string>', ]
Result Details
Members
- AppsList
-
- Type: AppsListData structure
The details of the AWS Firewall Manager applications list.
- AppsListArn
-
- Type: string
The Amazon Resource Name (ARN) of the applications list.
Errors
-
The specified resource was not found.
-
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 AWS 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 AWS Organizations before you can access it. -
The parameters of the request were invalid.
-
The operation exceeds a resource limit, for example, the maximum number of
policy
objects that you can create for an AWS account. For more information, see Firewall Manager Limits in the AWS WAF Developer Guide. -
The operation failed because of a system problem, even though the request was valid. Retry your request.
PutNotificationChannel
$result = $client->putNotificationChannel
([/* ... */]); $promise = $client->putNotificationChannelAsync
([/* ... */]);
Designates the IAM role and Amazon Simple Notification Service (SNS) topic that AWS Firewall Manager uses to record SNS logs.
To perform this action outside of the console, you must configure the SNS topic to allow the Firewall Manager role AWSServiceRoleForFMS
to publish SNS logs. For more information, see Firewall Manager required permissions for API actions in the AWS Firewall Manager Developer Guide.
Parameter Syntax
$result = $client->putNotificationChannel([ 'SnsRoleName' => '<string>', // REQUIRED 'SnsTopicArn' => '<string>', // REQUIRED ]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
The specified resource was not found.
-
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 AWS 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 AWS Organizations before you can access it. -
The operation failed because of a system problem, even though the request was valid. Retry your request.
PutPolicy
$result = $client->putPolicy
([/* ... */]); $promise = $client->putPolicyAsync
([/* ... */]);
Creates an AWS Firewall Manager policy.
Firewall Manager provides the following types of policies:
-
An AWS WAF policy (type WAFV2), which defines rule groups to run first in the corresponding AWS WAF web ACL and rule groups to run last in the web ACL.
-
An AWS WAF Classic policy (type WAF), which defines a rule group.
-
A Shield Advanced policy, which applies Shield Advanced protection to specified accounts and resources.
-
A security group policy, which manages VPC security groups across your AWS organization.
-
An AWS Network Firewall policy, which provides firewall rules to filter network traffic in specified Amazon VPCs.
Each policy is specific to one of the types. If you want to enforce more than one policy type across accounts, create multiple policies. You can create multiple policies for each type.
You must be subscribed to Shield Advanced to create a Shield Advanced policy. For more information about subscribing to Shield Advanced, see CreateSubscription.
Parameter Syntax
$result = $client->putPolicy([ 'Policy' => [ // REQUIRED 'ExcludeMap' => [ '<CustomerPolicyScopeIdType>' => ['<string>', ...], // ... ], 'ExcludeResourceTags' => true || false, // REQUIRED 'IncludeMap' => [ '<CustomerPolicyScopeIdType>' => ['<string>', ...], // ... ], 'PolicyId' => '<string>', 'PolicyName' => '<string>', // REQUIRED 'PolicyUpdateToken' => '<string>', 'RemediationEnabled' => true || false, // REQUIRED 'ResourceTags' => [ [ 'Key' => '<string>', // REQUIRED 'Value' => '<string>', ], // ... ], 'ResourceType' => '<string>', // REQUIRED 'ResourceTypeList' => ['<string>', ...], 'SecurityServicePolicyData' => [ // REQUIRED 'ManagedServiceData' => '<string>', 'Type' => 'WAF|WAFV2|SHIELD_ADVANCED|SECURITY_GROUPS_COMMON|SECURITY_GROUPS_CONTENT_AUDIT|SECURITY_GROUPS_USAGE_AUDIT|NETWORK_FIREWALL', // REQUIRED ], ], 'TagList' => [ [ 'Key' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ]);
Parameter Details
Members
Result Syntax
[ 'Policy' => [ 'ExcludeMap' => [ '<CustomerPolicyScopeIdType>' => ['<string>', ...], // ... ], 'ExcludeResourceTags' => true || false, 'IncludeMap' => [ '<CustomerPolicyScopeIdType>' => ['<string>', ...], // ... ], 'PolicyId' => '<string>', 'PolicyName' => '<string>', 'PolicyUpdateToken' => '<string>', 'RemediationEnabled' => true || false, 'ResourceTags' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], 'ResourceType' => '<string>', 'ResourceTypeList' => ['<string>', ...], 'SecurityServicePolicyData' => [ 'ManagedServiceData' => '<string>', 'Type' => 'WAF|WAFV2|SHIELD_ADVANCED|SECURITY_GROUPS_COMMON|SECURITY_GROUPS_CONTENT_AUDIT|SECURITY_GROUPS_USAGE_AUDIT|NETWORK_FIREWALL', ], ], 'PolicyArn' => '<string>', ]
Result Details
Members
- Policy
-
- Type: Policy structure
The details of the AWS Firewall Manager policy.
- PolicyArn
-
- Type: string
The Amazon Resource Name (ARN) of the policy.
Errors
-
The specified resource was not found.
-
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 AWS 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 AWS Organizations before you can access it. -
The parameters of the request were invalid.
-
The operation exceeds a resource limit, for example, the maximum number of
policy
objects that you can create for an AWS account. For more information, see Firewall Manager Limits in the AWS WAF Developer Guide. -
The operation failed because of a system problem, even though the request was valid. Retry your request.
-
The value of the
Type
parameter is invalid.
PutProtocolsList
$result = $client->putProtocolsList
([/* ... */]); $promise = $client->putProtocolsListAsync
([/* ... */]);
Creates an AWS Firewall Manager protocols list.
Parameter Syntax
$result = $client->putProtocolsList([ 'ProtocolsList' => [ // REQUIRED 'CreateTime' => <integer || string || DateTime>, 'LastUpdateTime' => <integer || string || DateTime>, 'ListId' => '<string>', 'ListName' => '<string>', // REQUIRED 'ListUpdateToken' => '<string>', 'PreviousProtocolsList' => [ '<PreviousListVersion>' => ['<string>', ...], // ... ], 'ProtocolsList' => ['<string>', ...], // REQUIRED ], 'TagList' => [ [ 'Key' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ]);
Parameter Details
Members
- ProtocolsList
-
- Required: Yes
- Type: ProtocolsListData structure
The details of the AWS Firewall Manager protocols list to be created.
- TagList
-
- Type: Array of Tag structures
The tags associated with the resource.
Result Syntax
[ 'ProtocolsList' => [ 'CreateTime' => <DateTime>, 'LastUpdateTime' => <DateTime>, 'ListId' => '<string>', 'ListName' => '<string>', 'ListUpdateToken' => '<string>', 'PreviousProtocolsList' => [ '<PreviousListVersion>' => ['<string>', ...], // ... ], 'ProtocolsList' => ['<string>', ...], ], 'ProtocolsListArn' => '<string>', ]
Result Details
Members
- ProtocolsList
-
- Type: ProtocolsListData structure
The details of the AWS Firewall Manager protocols list.
- ProtocolsListArn
-
- Type: string
The Amazon Resource Name (ARN) of the protocols list.
Errors
-
The specified resource was not found.
-
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 AWS 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 AWS Organizations before you can access it. -
The parameters of the request were invalid.
-
The operation exceeds a resource limit, for example, the maximum number of
policy
objects that you can create for an AWS account. For more information, see Firewall Manager Limits in the AWS WAF Developer Guide. -
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 AWS resource.
Parameter Syntax
$result = $client->tagResource([ 'ResourceArn' => '<string>', // REQUIRED 'TagList' => [ // REQUIRED [ 'Key' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ]);
Parameter Details
Members
- ResourceArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the resource to return tags for. The AWS Firewall Manager resources that support tagging are policies, applications lists, and protocols lists.
- TagList
-
- Required: Yes
- Type: Array of Tag structures
The tags to add to the resource.
Result Syntax
[]
Result Details
Errors
-
The specified resource was not found.
-
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 AWS 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 AWS Organizations before you can access it. -
The operation failed because of a system problem, even though the request was valid. Retry your request.
-
The parameters of the request were invalid.
-
The operation exceeds a resource limit, for example, the maximum number of
policy
objects that you can create for an AWS account. For more information, see Firewall Manager Limits in the AWS WAF Developer Guide.
UntagResource
$result = $client->untagResource
([/* ... */]); $promise = $client->untagResourceAsync
([/* ... */]);
Removes one or more tags from an AWS resource.
Parameter Syntax
$result = $client->untagResource([ 'ResourceArn' => '<string>', // REQUIRED 'TagKeys' => ['<string>', ...], // REQUIRED ]);
Parameter Details
Members
- ResourceArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the resource to return tags for. The AWS Firewall Manager resources that support tagging are policies, applications lists, and protocols lists.
- TagKeys
-
- Required: Yes
- Type: Array of strings
The keys of the tags to remove from the resource.
Result Syntax
[]
Result Details
Errors
-
The specified resource was not found.
-
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 AWS 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 AWS Organizations before you can access it. -
The operation failed because of a system problem, even though the request was valid. Retry your request.
-
The parameters of the request were invalid.
Shapes
App
Description
An individual AWS Firewall Manager application.
Members
- AppName
-
- Required: Yes
- Type: string
The application's name.
- Port
-
- Required: Yes
- Type: long (int|float)
The application's port number, for example
80
. - Protocol
-
- Required: Yes
- Type: string
The IP protocol name or number. The name can be one of
tcp
,udp
, oricmp
. For information on possible numbers, see Protocol Numbers.
AppsListData
Description
An AWS Firewall Manager applications list.
Members
- AppsList
-
- Required: Yes
- Type: Array of App structures
An array of applications in the AWS Firewall Manager applications list.
- CreateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time that the AWS Firewall Manager applications list was created.
- LastUpdateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time that the AWS Firewall Manager applications list was last updated.
- ListId
-
- Type: string
The ID of the AWS Firewall Manager applications list.
- ListName
-
- Required: Yes
- Type: string
The name of the AWS Firewall Manager applications list.
- ListUpdateToken
-
- Type: string
A unique identifier for each update to the list. When you update the list, the update token must match the token of the current version of the application list. You can retrieve the update token by getting the list.
- PreviousAppsList
-
- Type: Associative array of custom strings keys (PreviousListVersion) to App structuress
A map of previous version numbers to their corresponding
App
object arrays.
AppsListDataSummary
Description
Details of the AWS Firewall Manager applications list.
Members
- AppsList
-
- Type: Array of App structures
An array of
App
objects in the AWS Firewall Manager applications list. - ListArn
-
- Type: string
The Amazon Resource Name (ARN) of the applications list.
- ListId
-
- Type: string
The ID of the applications list.
- ListName
-
- Type: string
The name of the applications list.
AwsEc2InstanceViolation
Description
Violations for an EC2 instance resource.
Members
- AwsEc2NetworkInterfaceViolations
-
- Type: Array of AwsEc2NetworkInterfaceViolation structures
Violations for network interfaces associated with the EC2 instance.
- ViolationTarget
-
- Type: string
The resource ID of the EC2 instance.
AwsEc2NetworkInterfaceViolation
Description
Violations for network interfaces associated with an EC2 instance.
Members
AwsVPCSecurityGroupViolation
Description
Details of the rule violation in a security group when compared to the master security group of the AWS Firewall Manager policy.
Members
- PartialMatches
-
- Type: Array of PartialMatch structures
List of rules specified in the security group of the AWS Firewall Manager policy that partially match the
ViolationTarget
rule. - PossibleSecurityGroupRemediationActions
-
- Type: Array of SecurityGroupRemediationAction structures
Remediation options for the rule specified in the
ViolationTarget
. - ViolationTarget
-
- Type: string
The security group rule that is being evaluated.
- ViolationTargetDescription
-
- Type: string
A description of the security group that violates the policy.
ComplianceViolator
Description
Details of the resource that is not protected by the policy.
Members
- ResourceId
-
- Type: string
The resource ID.
- ResourceType
-
- Type: string
The resource type. This is in the format shown in the AWS Resource Types Reference. For example:
AWS::ElasticLoadBalancingV2::LoadBalancer
,AWS::CloudFront::Distribution
, orAWS::NetworkFirewall::FirewallPolicy
. - ViolationReason
-
- Type: string
The reason that the resource is not protected by the policy.
EvaluationResult
Description
Describes the compliance status for the account. An account is considered noncompliant if it includes resources that are not protected by the specified policy or that don't comply with the policy.
Members
- ComplianceStatus
-
- Type: string
Describes an AWS account's compliance with the AWS Firewall Manager policy.
- EvaluationLimitExceeded
-
- Type: boolean
Indicates that over 100 resources are noncompliant with the AWS Firewall Manager policy.
- ViolatorCount
-
- Type: long (int|float)
The number of resources that are noncompliant with the specified policy. For AWS WAF and Shield Advanced policies, a resource is considered noncompliant if it is not associated with the policy. For security group policies, a resource is considered noncompliant if it doesn't comply with the rules of the policy and remediation is disabled or not possible.
InternalErrorException
Description
The operation failed because of a system problem, even though the request was valid. Retry your request.
Members
InvalidInputException
InvalidOperationException
Description
The operation failed because there was nothing to do or the operation wasn't possible. For example, you might have submitted an AssociateAdminAccount
request for an account ID that was already set as the AWS 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 AWS Organizations before you can access it.
Members
InvalidTypeException
LimitExceededException
Description
The operation exceeds a resource limit, for example, the maximum number of policy
objects that you can create for an AWS account. For more information, see Firewall Manager Limits in the AWS WAF Developer Guide.
Members
NetworkFirewallMissingExpectedRTViolation
Description
Violation details for AWS Network Firewall for a subnet that's not associated to the expected Firewall Manager managed route table.
Members
- AvailabilityZone
-
- Type: string
The Availability Zone of a violating subnet.
- CurrentRouteTable
-
- Type: string
The resource ID of the current route table that's associated with the subnet, if one is available.
- ExpectedRouteTable
-
- Type: string
The resource ID of the route table that should be associated with the subnet.
- VPC
-
- Type: string
The resource ID of the VPC associated with a violating subnet.
- ViolationTarget
-
- Type: string
The ID of the AWS Network Firewall or VPC resource that's in violation.
NetworkFirewallMissingFirewallViolation
Description
Violation details for AWS Network Firewall for a subnet that doesn't have a Firewall Manager managed firewall in its VPC.
Members
- AvailabilityZone
-
- Type: string
The Availability Zone of a violating subnet.
- TargetViolationReason
-
- Type: string
The reason the resource has this violation, if one is available.
- VPC
-
- Type: string
The resource ID of the VPC associated with a violating subnet.
- ViolationTarget
-
- Type: string
The ID of the AWS Network Firewall or VPC resource that's in violation.
NetworkFirewallMissingSubnetViolation
Description
Violation details for AWS Network Firewall for an Availability Zone that's missing the expected Firewall Manager managed subnet.
Members
- AvailabilityZone
-
- Type: string
The Availability Zone of a violating subnet.
- TargetViolationReason
-
- Type: string
The reason the resource has this violation, if one is available.
- VPC
-
- Type: string
The resource ID of the VPC associated with a violating subnet.
- ViolationTarget
-
- Type: string
The ID of the AWS Network Firewall or VPC resource that's in violation.
NetworkFirewallPolicyDescription
Description
The definition of the AWS Network Firewall firewall policy.
Members
- StatefulRuleGroups
-
- Type: Array of StatefulRuleGroup structures
The stateful rule groups that are used in the Network Firewall firewall policy.
- StatelessCustomActions
-
- Type: Array of strings
Names of custom actions that are available for use in the stateless default actions settings.
- StatelessDefaultActions
-
- Type: Array of strings
The actions to take on packets that don't match any of the stateless rule groups.
- StatelessFragmentDefaultActions
-
- Type: Array of strings
The actions to take on packet fragments that don't match any of the stateless rule groups.
- StatelessRuleGroups
-
- Type: Array of StatelessRuleGroup structures
The stateless rule groups that are used in the Network Firewall firewall policy.
NetworkFirewallPolicyModifiedViolation
Description
Violation details for AWS Network Firewall for a firewall policy that has a different NetworkFirewallPolicyDescription than is required by the Firewall Manager policy.
Members
- CurrentPolicyDescription
-
- Type: NetworkFirewallPolicyDescription structure
The policy that's currently in use in the individual account.
- ExpectedPolicyDescription
-
- Type: NetworkFirewallPolicyDescription structure
The policy that should be in use in the individual account in order to be compliant.
- ViolationTarget
-
- Type: string
The ID of the AWS Network Firewall or VPC resource that's in violation.
PartialMatch
Description
The reference rule that partially matches the ViolationTarget
rule and violation reason.
Members
Policy
Description
An AWS Firewall Manager policy.
Members
- ExcludeMap
-
- Type: Associative array of custom strings keys (CustomerPolicyScopeIdType) to stringss
Specifies the AWS account IDs and AWS Organizations organizational units (OUs) to exclude from the policy. Specifying an OU is the equivalent of specifying all accounts in the OU and in any of its child OUs, including any child OUs and accounts that are added at a later time.
You can specify inclusions or exclusions, but not both. If you specify an
IncludeMap
, AWS Firewall Manager applies the policy to all accounts specified by theIncludeMap
, and does not evaluate anyExcludeMap
specifications. If you do not specify anIncludeMap
, then Firewall Manager applies the policy to all accounts except for those specified by theExcludeMap
.You can specify account IDs, OUs, or a combination:
-
Specify account IDs by setting the key to
ACCOUNT
. For example, the following is a valid map:{“ACCOUNT” : [“accountID1”, “accountID2”]}
. -
Specify OUs by setting the key to
ORG_UNIT
. For example, the following is a valid map:{“ORG_UNIT” : [“ouid111”, “ouid112”]}
. -
Specify accounts and OUs together in a single map, separated with a comma. For example, the following is a valid map:
{“ACCOUNT” : [“accountID1”, “accountID2”], “ORG_UNIT” : [“ouid111”, “ouid112”]}
.
- ExcludeResourceTags
-
- Required: Yes
- Type: boolean
If set to
True
, resources with the tags that are specified in theResourceTag
array are not in scope of the policy. If set toFalse
, and theResourceTag
array is not null, only resources with the specified tags are in scope of the policy. - IncludeMap
-
- Type: Associative array of custom strings keys (CustomerPolicyScopeIdType) to stringss
Specifies the AWS account IDs and AWS Organizations organizational units (OUs) to include in the policy. Specifying an OU is the equivalent of specifying all accounts in the OU and in any of its child OUs, including any child OUs and accounts that are added at a later time.
You can specify inclusions or exclusions, but not both. If you specify an
IncludeMap
, AWS Firewall Manager applies the policy to all accounts specified by theIncludeMap
, and does not evaluate anyExcludeMap
specifications. If you do not specify anIncludeMap
, then Firewall Manager applies the policy to all accounts except for those specified by theExcludeMap
.You can specify account IDs, OUs, or a combination:
-
Specify account IDs by setting the key to
ACCOUNT
. For example, the following is a valid map:{“ACCOUNT” : [“accountID1”, “accountID2”]}
. -
Specify OUs by setting the key to
ORG_UNIT
. For example, the following is a valid map:{“ORG_UNIT” : [“ouid111”, “ouid112”]}
. -
Specify accounts and OUs together in a single map, separated with a comma. For example, the following is a valid map:
{“ACCOUNT” : [“accountID1”, “accountID2”], “ORG_UNIT” : [“ouid111”, “ouid112”]}
.
- PolicyId
-
- Type: string
The ID of the AWS Firewall Manager policy.
- PolicyName
-
- Required: Yes
- Type: string
The name of the AWS Firewall Manager policy.
- PolicyUpdateToken
-
- Type: string
A unique identifier for each update to the policy. When issuing a
PutPolicy
request, thePolicyUpdateToken
in the request must match thePolicyUpdateToken
of the current policy version. To get thePolicyUpdateToken
of the current policy version, use aGetPolicy
request. - RemediationEnabled
-
- Required: Yes
- Type: boolean
Indicates if the policy should be automatically applied to new resources.
- ResourceTags
-
- Type: Array of ResourceTag structures
An array of
ResourceTag
objects. - ResourceType
-
- Required: Yes
- Type: string
The type of resource protected by or in scope of the policy. This is in the format shown in the AWS Resource Types Reference. For AWS WAF and Shield Advanced, examples include
AWS::ElasticLoadBalancingV2::LoadBalancer
andAWS::CloudFront::Distribution
. For a security group common policy, valid values areAWS::EC2::NetworkInterface
andAWS::EC2::Instance
. For a security group content audit policy, valid values areAWS::EC2::SecurityGroup
,AWS::EC2::NetworkInterface
, andAWS::EC2::Instance
. For a security group usage audit policy, the value isAWS::EC2::SecurityGroup
. For an AWS Network Firewall policy, the value isAWS::EC2::VPC
. - ResourceTypeList
-
- Type: Array of strings
An array of
ResourceType
. - SecurityServicePolicyData
-
- Required: Yes
- Type: SecurityServicePolicyData structure
Details about the security service that is being used to protect the resources.
PolicyComplianceDetail
Description
Describes the noncompliant resources in a member account for a specific AWS Firewall Manager policy. A maximum of 100 entries are displayed. If more than 100 resources are noncompliant, EvaluationLimitExceeded
is set to True
.
Members
- EvaluationLimitExceeded
-
- Type: boolean
Indicates if over 100 resources are noncompliant with the AWS Firewall Manager policy.
- ExpiredAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A timestamp that indicates when the returned information should be considered out of date.
- IssueInfoMap
-
- Type: Associative array of custom strings keys (DependentServiceName) to strings
Details about problems with dependent services, such as AWS WAF or AWS Config, that are causing a resource to be noncompliant. The details include the name of the dependent service and the error message received that indicates the problem with the service.
- MemberAccount
-
- Type: string
The AWS account ID.
- PolicyId
-
- Type: string
The ID of the AWS Firewall Manager policy.
- PolicyOwner
-
- Type: string
The AWS account that created the AWS Firewall Manager policy.
- Violators
-
- Type: Array of ComplianceViolator structures
An array of resources that aren't protected by the AWS WAF or Shield Advanced policy or that aren't in compliance with the security group policy.
PolicyComplianceStatus
Description
Indicates whether the account is compliant with the specified policy. An account is considered noncompliant if it includes resources that are not protected by the policy, for AWS WAF and Shield Advanced policies, or that are noncompliant with the policy, for security group policies.
Members
- EvaluationResults
-
- Type: Array of EvaluationResult structures
An array of
EvaluationResult
objects. - IssueInfoMap
-
- Type: Associative array of custom strings keys (DependentServiceName) to strings
Details about problems with dependent services, such as AWS WAF or AWS Config, that are causing a resource to be noncompliant. The details include the name of the dependent service and the error message received that indicates the problem with the service.
- LastUpdated
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Timestamp of the last update to the
EvaluationResult
objects. - MemberAccount
-
- Type: string
The member account ID.
- PolicyId
-
- Type: string
The ID of the AWS Firewall Manager policy.
- PolicyName
-
- Type: string
The name of the AWS Firewall Manager policy.
- PolicyOwner
-
- Type: string
The AWS account that created the AWS Firewall Manager policy.
PolicySummary
Description
Details of the AWS Firewall Manager policy.
Members
- PolicyArn
-
- Type: string
The Amazon Resource Name (ARN) of the specified policy.
- PolicyId
-
- Type: string
The ID of the specified policy.
- PolicyName
-
- Type: string
The name of the specified policy.
- RemediationEnabled
-
- Type: boolean
Indicates if the policy should be automatically applied to new resources.
- ResourceType
-
- Type: string
The type of resource protected by or in scope of the policy. This is in the format shown in the AWS Resource Types Reference. For AWS WAF and Shield Advanced, examples include
AWS::ElasticLoadBalancingV2::LoadBalancer
andAWS::CloudFront::Distribution
. For a security group common policy, valid values areAWS::EC2::NetworkInterface
andAWS::EC2::Instance
. For a security group content audit policy, valid values areAWS::EC2::SecurityGroup
,AWS::EC2::NetworkInterface
, andAWS::EC2::Instance
. For a security group usage audit policy, the value isAWS::EC2::SecurityGroup
. For an AWS Network Firewall policy, the value isAWS::EC2::VPC
. - SecurityServiceType
-
- Type: string
The service that the policy is using to protect the resources. This specifies the type of policy that is created, either an AWS WAF policy, a Shield Advanced policy, or a security group policy.
ProtocolsListData
Description
An AWS Firewall Manager protocols list.
Members
- CreateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time that the AWS Firewall Manager protocols list was created.
- LastUpdateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time that the AWS Firewall Manager protocols list was last updated.
- ListId
-
- Type: string
The ID of the AWS Firewall Manager protocols list.
- ListName
-
- Required: Yes
- Type: string
The name of the AWS Firewall Manager protocols list.
- ListUpdateToken
-
- Type: string
A unique identifier for each update to the list. When you update the list, the update token must match the token of the current version of the application list. You can retrieve the update token by getting the list.
- PreviousProtocolsList
-
- Type: Associative array of custom strings keys (PreviousListVersion) to stringss
A map of previous version numbers to their corresponding protocol arrays.
- ProtocolsList
-
- Required: Yes
- Type: Array of strings
An array of protocols in the AWS Firewall Manager protocols list.
ProtocolsListDataSummary
Description
Details of the AWS Firewall Manager protocols list.
Members
- ListArn
-
- Type: string
The Amazon Resource Name (ARN) of the specified protocols list.
- ListId
-
- Type: string
The ID of the specified protocols list.
- ListName
-
- Type: string
The name of the specified protocols list.
- ProtocolsList
-
- Type: Array of strings
An array of protocols in the AWS Firewall Manager protocols list.
ResourceNotFoundException
ResourceTag
Description
The resource tags that AWS Firewall Manager uses to determine if a particular resource should be included or excluded from the AWS Firewall Manager policy. Tags enable you to categorize your AWS resources in different ways, for example, by purpose, owner, or environment. Each tag consists of a key and an optional value. Firewall Manager combines the tags with "AND" so that, if you add more than one tag to a policy scope, a resource must have all the specified tags to be included or excluded. For more information, see Working with Tag Editor.
Members
ResourceViolation
Description
Violation detail based on resource type.
Members
- AwsEc2InstanceViolation
-
- Type: AwsEc2InstanceViolation structure
Violation details for an EC2 instance.
- AwsEc2NetworkInterfaceViolation
-
- Type: AwsEc2NetworkInterfaceViolation structure
Violation details for network interface.
- AwsVPCSecurityGroupViolation
-
- Type: AwsVPCSecurityGroupViolation structure
Violation details for security groups.
- NetworkFirewallMissingExpectedRTViolation
-
- Type: NetworkFirewallMissingExpectedRTViolation structure
Violation detail for an Network Firewall policy that indicates that a subnet is not associated with the expected Firewall Manager managed route table.
- NetworkFirewallMissingFirewallViolation
-
- Type: NetworkFirewallMissingFirewallViolation structure
Violation detail for an Network Firewall policy that indicates that a subnet has no Firewall Manager managed firewall in its VPC.
- NetworkFirewallMissingSubnetViolation
-
- Type: NetworkFirewallMissingSubnetViolation structure
Violation detail for an Network Firewall policy that indicates that an Availability Zone is missing the expected Firewall Manager managed subnet.
- NetworkFirewallPolicyModifiedViolation
-
- Type: NetworkFirewallPolicyModifiedViolation structure
Violation detail for an Network Firewall policy that indicates that a firewall policy in an individual account has been modified in a way that makes it noncompliant. For example, the individual account owner might have deleted a rule group, changed the priority of a stateless rule group, or changed a policy default action.
SecurityGroupRemediationAction
Description
Remediation option for the rule specified in the ViolationTarget
.
Members
- Description
-
- Type: string
Brief description of the action that will be performed.
- IsDefaultAction
-
- Type: boolean
Indicates if the current action is the default action.
- RemediationActionType
-
- Type: string
The remediation action that will be performed.
- RemediationResult
-
- Type: SecurityGroupRuleDescription structure
The final state of the rule specified in the
ViolationTarget
after it is remediated.
SecurityGroupRuleDescription
Description
Describes a set of permissions for a security group rule.
Members
- FromPort
-
- Type: long (int|float)
The start of the port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number. A value of
-1
indicates all ICMP/ICMPv6 types. - IPV4Range
-
- Type: string
The IPv4 ranges for the security group rule.
- IPV6Range
-
- Type: string
The IPv6 ranges for the security group rule.
- PrefixListId
-
- Type: string
The ID of the prefix list for the security group rule.
- Protocol
-
- Type: string
The IP protocol name (
tcp
,udp
,icmp
,icmpv6
) or number. - ToPort
-
- Type: long (int|float)
The end of the port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code. A value of
-1
indicates all ICMP/ICMPv6 codes.
SecurityServicePolicyData
Description
Details about the security service that is being used to protect the resources.
Members
- ManagedServiceData
-
- Type: string
Details about the service that are specific to the service type, in JSON format. For service type
SHIELD_ADVANCED
, this is an empty string.-
Example:
NETWORK_FIREWALL
"{\"type\":\"NETWORK_FIREWALL\",\"networkFirewallStatelessRuleGroupReferences\":[{\"resourceARN\":\"arn:aws:network-firewall:us-west-1:1234567891011:stateless-rulegroup/rulegroup2\",\"priority\":10}],\"networkFirewallStatelessDefaultActions\":[\"aws:pass\",\"custom1\"],\"networkFirewallStatelessFragmentDefaultActions\":[\"custom2\",\"aws:pass\"],\"networkFirewallStatelessCustomActions\":[{\"actionName\":\"custom1\",\"actionDefinition\":{\"publishMetricAction\":{\"dimensions\":[{\"value\":\"dimension1\"}]}}},{\"actionName\":\"custom2\",\"actionDefinition\":{\"publishMetricAction\":{\"dimensions\":[{\"value\":\"dimension2\"}]}}}],\"networkFirewallStatefulRuleGroupReferences\":[{\"resourceARN\":\"arn:aws:network-firewall:us-west-1:1234567891011:stateful-rulegroup/rulegroup1\"}],\"networkFirewallOrchestrationConfig\":{\"singleFirewallEndpointPerVPC\":true,\"allowedIPV4CidrList\":[\"10.24.34.0/28\"]} }"
-
Example:
WAFV2
"{\"type\":\"WAFV2\",\"preProcessRuleGroups\":[{\"ruleGroupArn\":null,\"overrideAction\":{\"type\":\"NONE\"},\"managedRuleGroupIdentifier\":{\"version\":null,\"vendorName\":\"AWS\",\"managedRuleGroupName\":\"AWSManagedRulesAmazonIpReputationList\"},\"ruleGroupType\":\"ManagedRuleGroup\",\"excludeRules\":[]}],\"postProcessRuleGroups\":[],\"defaultAction\":{\"type\":\"ALLOW\"},\"overrideCustomerWebACLAssociation\":false,\"loggingConfiguration\":{\"logDestinationConfigs\":[\"arn:aws:firehose:us-west-2:12345678912:deliverystream/aws-waf-logs-fms-admin-destination\"],\"redactedFields\":[{\"redactedFieldType\":\"SingleHeader\",\"redactedFieldValue\":\"Cookies\"},{\"redactedFieldType\":\"Method\"}]}}"
In the
loggingConfiguration
, you can specify onelogDestinationConfigs
, you can optionally provide up to 20redactedFields
, and theRedactedFieldType
must be one ofURI
,QUERY_STRING
,HEADER
, orMETHOD
. -
Example:
WAF Classic
"{\"type\": \"WAF\", \"ruleGroups\": [{\"id\":\"12345678-1bcd-9012-efga-0987654321ab\", \"overrideAction\" : {\"type\": \"COUNT\"}}], \"defaultAction\": {\"type\": \"BLOCK\"}}"
-
Example:
SECURITY_GROUPS_COMMON
"{\"type\":\"SECURITY_GROUPS_COMMON\",\"revertManualSecurityGroupChanges\":false,\"exclusiveResourceSecurityGroupManagement\":false, \"applyToAllEC2InstanceENIs\":false,\"securityGroups\":[{\"id\":\" sg-000e55995d61a06bd\"}]}"
-
Example:
SECURITY_GROUPS_CONTENT_AUDIT
"{\"type\":\"SECURITY_GROUPS_CONTENT_AUDIT\",\"securityGroups\":[{\"id\":\"sg-000e55995d61a06bd\"}],\"securityGroupAction\":{\"type\":\"ALLOW\"}}"
The security group action for content audit can be
ALLOW
orDENY
. ForALLOW
, all in-scope security group rules must be within the allowed range of the policy's security group rules. ForDENY
, all in-scope security group rules must not contain a value or a range that matches a rule value or range in the policy security group. -
Example:
SECURITY_GROUPS_USAGE_AUDIT
"{\"type\":\"SECURITY_GROUPS_USAGE_AUDIT\",\"deleteUnusedSecurityGroups\":true,\"coalesceRedundantSecurityGroups\":true}"
- Type
-
- Required: Yes
- Type: string
The service that the policy is using to protect the resources. This specifies the type of policy that is created, either an AWS WAF policy, a Shield Advanced policy, or a security group policy. For security group policies, Firewall Manager supports one security group for each common policy and for each content audit policy. This is an adjustable limit that you can increase by contacting AWS Support.
StatefulRuleGroup
Description
AWS Network Firewall stateful rule group, used in a NetworkFirewallPolicyDescription.
Members
StatelessRuleGroup
Description
AWS Network Firewall stateless rule group, used in a NetworkFirewallPolicyDescription.
Members
Tag
Description
A collection of key:value pairs associated with an AWS resource. The key:value pair can be anything you define. Typically, the tag key represents a category (such as "environment") and the tag value represents a specific value within that category (such as "test," "development," or "production"). You can add up to 50 tags to each AWS resource.
Members
- Key
-
- Required: Yes
- Type: string
Part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as "customer." Tag keys are case-sensitive.
- Value
-
- Required: Yes
- Type: string
Part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as "companyA" or "companyB." Tag values are case-sensitive.
ViolationDetail
Description
Violations for a resource based on the specified AWS Firewall Manager policy and AWS account.
Members
- MemberAccount
-
- Required: Yes
- Type: string
The AWS account that the violation details were requested for.
- PolicyId
-
- Required: Yes
- Type: string
The ID of the AWS Firewall Manager policy that the violation details were requested for.
- ResourceDescription
-
- Type: string
Brief description for the requested resource.
- ResourceId
-
- Required: Yes
- Type: string
The resource ID that the violation details were requested for.
- ResourceTags
-
- Type: Array of Tag structures
The
ResourceTag
objects associated with the resource. - ResourceType
-
- Required: Yes
- Type: string
The resource type that the violation details were requested for.
- ResourceViolations
-
- Required: Yes
- Type: Array of ResourceViolation structures
List of violations for the requested resource.