Table of Contents
A low-level client representing Firewall Management Service (FMS)
This is the AWS Firewall Manager API Reference . This guide is for developers who need detailed information about the AWS Firewall Manager API actions, data types, and errors. For detailed information about AWS Firewall Manager features, see the AWS Firewall Manager Developer Guide .
Some API actions require explicit resource permissions. For information, see the developer guide topic Firewall Manager required permissions for API actions .
import boto3
client = boto3.client('fms')
These are the available methods:
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.
See also: AWS API Documentation
Request Syntax
response = client.associate_admin_account(
AdminAccount='string'
)
[REQUIRED]
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 .
Exceptions
Check if an operation can be paginated.
Permanently deletes an AWS Firewall Manager applications list.
See also: AWS API Documentation
Request Syntax
response = client.delete_apps_list(
ListId='string'
)
[REQUIRED]
The ID of the applications list that you want to delete. You can retrieve this ID from PutAppsList , ListAppsLists , and GetAppsList .
Exceptions
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.
See also: AWS API Documentation
Request Syntax
response = client.delete_notification_channel()
Exceptions
Permanently deletes an AWS Firewall Manager policy.
See also: AWS API Documentation
Request Syntax
response = client.delete_policy(
PolicyId='string',
DeleteAllPolicyResources=True|False
)
[REQUIRED]
The ID of the policy that you want to delete. You can retrieve this ID from PutPolicy and ListPolicies .
If True , the request performs cleanup according to the policy type.
For AWS WAF and Shield Advanced policies, the cleanup does the following:
For security group policies, the cleanup does the following for each security group in the 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.
None
Exceptions
Permanently deletes an AWS Firewall Manager protocols list.
See also: AWS API Documentation
Request Syntax
response = client.delete_protocols_list(
ListId='string'
)
[REQUIRED]
The ID of the protocols list that you want to delete. You can retrieve this ID from PutProtocolsList , ListProtocolsLists , and GetProtocolsLost .
Exceptions
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.
See also: AWS API Documentation
Request Syntax
response = client.disassociate_admin_account()
Exceptions
Generate a presigned url given a client, its method, and arguments
The presigned url
Returns the AWS Organizations master account that is associated with AWS Firewall Manager as the AWS Firewall Manager administrator.
See also: AWS API Documentation
Request Syntax
response = client.get_admin_account()
{
'AdminAccount': 'string',
'RoleStatus': 'READY'|'CREATING'|'PENDING_DELETION'|'DELETING'|'DELETED'
}
Response Structure
The AWS account that is set as the AWS Firewall Manager administrator.
The status of the AWS account that you set as the AWS Firewall Manager administrator.
Exceptions
Returns information about the specified AWS Firewall Manager applications list.
See also: AWS API Documentation
Request Syntax
response = client.get_apps_list(
ListId='string',
DefaultList=True|False
)
[REQUIRED]
The ID of the AWS Firewall Manager applications list that you want the details for.
dict
Response Syntax
{
'AppsList': {
'ListId': 'string',
'ListName': 'string',
'ListUpdateToken': 'string',
'CreateTime': datetime(2015, 1, 1),
'LastUpdateTime': datetime(2015, 1, 1),
'AppsList': [
{
'AppName': 'string',
'Protocol': 'string',
'Port': 123
},
],
'PreviousAppsList': {
'string': [
{
'AppName': 'string',
'Protocol': 'string',
'Port': 123
},
]
}
},
'AppsListArn': 'string'
}
Response Structure
(dict) --
AppsList (dict) --
Information about the specified AWS Firewall Manager applications list.
ListId (string) --
The ID of the AWS Firewall Manager applications list.
ListName (string) --
The name of the AWS Firewall Manager applications list.
ListUpdateToken (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.
CreateTime (datetime) --
The time that the AWS Firewall Manager applications list was created.
LastUpdateTime (datetime) --
The time that the AWS Firewall Manager applications list was last updated.
AppsList (list) --
An array of applications in the AWS Firewall Manager applications list.
(dict) --
An individual AWS Firewall Manager application.
AppName (string) --
The application's name.
Protocol (string) --
The IP protocol name or number. The name can be one of tcp , udp , or icmp . For information on possible numbers, see Protocol Numbers .
Port (integer) --
The application's port number, for example 80 .
PreviousAppsList (dict) --
A map of previous version numbers to their corresponding App object arrays.
(string) --
(list) --
(dict) --
An individual AWS Firewall Manager application.
AppName (string) --
The application's name.
Protocol (string) --
The IP protocol name or number. The name can be one of tcp , udp , or icmp . For information on possible numbers, see Protocol Numbers .
Port (integer) --
The application's port number, for example 80 .
AppsListArn (string) --
The Amazon Resource Name (ARN) of the applications list.
Exceptions
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.
See also: AWS API Documentation
Request Syntax
response = client.get_compliance_detail(
PolicyId='string',
MemberAccount='string'
)
[REQUIRED]
The ID of the policy that you want to get the details for. PolicyId is returned by PutPolicy and by ListPolicies .
[REQUIRED]
The AWS account that owns the resources that you want to get the details for.
dict
Response Syntax
{
'PolicyComplianceDetail': {
'PolicyOwner': 'string',
'PolicyId': 'string',
'MemberAccount': 'string',
'Violators': [
{
'ResourceId': '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',
'ResourceType': 'string'
},
],
'EvaluationLimitExceeded': True|False,
'ExpiredAt': datetime(2015, 1, 1),
'IssueInfoMap': {
'string': 'string'
}
}
}
Response Structure
(dict) --
PolicyComplianceDetail (dict) --
Information about the resources and the policy that you specified in the GetComplianceDetail request.
PolicyOwner (string) --
The AWS account that created the AWS Firewall Manager policy.
PolicyId (string) --
The ID of the AWS Firewall Manager policy.
MemberAccount (string) --
The AWS account ID.
Violators (list) --
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.
(dict) --
Details of the resource that is not protected by the policy.
ResourceId (string) --
The resource ID.
ViolationReason (string) --
The reason that the resource is not protected by the policy.
ResourceType (string) --
The resource type. This is in the format shown in the AWS Resource Types Reference . For example: AWS::ElasticLoadBalancingV2::LoadBalancer , AWS::CloudFront::Distribution , or AWS::NetworkFirewall::FirewallPolicy .
EvaluationLimitExceeded (boolean) --
Indicates if over 100 resources are noncompliant with the AWS Firewall Manager policy.
ExpiredAt (datetime) --
A timestamp that indicates when the returned information should be considered out of date.
IssueInfoMap (dict) --
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.
Exceptions
Information about the Amazon Simple Notification Service (SNS) topic that is used to record AWS Firewall Manager SNS logs.
See also: AWS API Documentation
Request Syntax
response = client.get_notification_channel()
{
'SnsTopicArn': 'string',
'SnsRoleName': 'string'
}
Response Structure
The SNS topic that records AWS Firewall Manager activity.
The IAM role that is used by AWS Firewall Manager to record activity to SNS.
Exceptions
Create a paginator for an operation.
Returns information about the specified AWS Firewall Manager policy.
See also: AWS API Documentation
Request Syntax
response = client.get_policy(
PolicyId='string'
)
[REQUIRED]
The ID of the AWS Firewall Manager policy that you want the details for.
{
'Policy': {
'PolicyId': 'string',
'PolicyName': 'string',
'PolicyUpdateToken': 'string',
'SecurityServicePolicyData': {
'Type': 'WAF'|'WAFV2'|'SHIELD_ADVANCED'|'SECURITY_GROUPS_COMMON'|'SECURITY_GROUPS_CONTENT_AUDIT'|'SECURITY_GROUPS_USAGE_AUDIT'|'NETWORK_FIREWALL',
'ManagedServiceData': 'string'
},
'ResourceType': 'string',
'ResourceTypeList': [
'string',
],
'ResourceTags': [
{
'Key': 'string',
'Value': 'string'
},
],
'ExcludeResourceTags': True|False,
'RemediationEnabled': True|False,
'IncludeMap': {
'string': [
'string',
]
},
'ExcludeMap': {
'string': [
'string',
]
}
},
'PolicyArn': 'string'
}
Response Structure
Information about the specified AWS Firewall Manager policy.
The ID of the AWS Firewall Manager policy.
The name of the AWS Firewall Manager policy.
A unique identifier for each update to the policy. When issuing a PutPolicy request, the PolicyUpdateToken in the request must match the PolicyUpdateToken of the current policy version. To get the PolicyUpdateToken of the current policy version, use a GetPolicy request.
Details about the security service that is being used to protect the resources.
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.
Details about the service that are specific to the service type, in JSON format. For service type SHIELD_ADVANCED , this is an empty string.
The type of resource protected by or in scope of the policy. This is in the format shown in the AWS Resource Types Reference . For AWS WAF and Shield Advanced, examples include AWS::ElasticLoadBalancingV2::LoadBalancer and AWS::CloudFront::Distribution . For a security group common policy, valid values are AWS::EC2::NetworkInterface and AWS::EC2::Instance . For a security group content audit policy, valid values are AWS::EC2::SecurityGroup , AWS::EC2::NetworkInterface , and AWS::EC2::Instance . For a security group usage audit policy, the value is AWS::EC2::SecurityGroup . For an AWS Network Firewall policy, the value is AWS::EC2::VPC .
An array of ResourceType .
An array of ResourceTag objects.
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 .
The resource tag key.
The resource tag value.
If set to True , resources with the tags that are specified in the ResourceTag array are not in scope of the policy. If set to False , and the ResourceTag array is not null, only resources with the specified tags are in scope of the policy.
Indicates if the policy should be automatically applied to new resources.
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 the IncludeMap , and does not evaluate any ExcludeMap specifications. If you do not specify an IncludeMap , then Firewall Manager applies the policy to all accounts except for those specified by the ExcludeMap .
You can specify account IDs, OUs, or a combination:
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 the IncludeMap , and does not evaluate any ExcludeMap specifications. If you do not specify an IncludeMap , then Firewall Manager applies the policy to all accounts except for those specified by the ExcludeMap .
You can specify account IDs, OUs, or a combination:
The Amazon Resource Name (ARN) of the specified policy.
Exceptions
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.
See also: AWS API Documentation
Request Syntax
response = client.get_protection_status(
PolicyId='string',
MemberAccountId='string',
StartTime=datetime(2015, 1, 1),
EndTime=datetime(2015, 1, 1),
NextToken='string',
MaxResults=123
)
[REQUIRED]
The ID of the policy for which you want to get the attack information.
dict
Response Syntax
{
'AdminAccountId': 'string',
'ServiceType': 'WAF'|'WAFV2'|'SHIELD_ADVANCED'|'SECURITY_GROUPS_COMMON'|'SECURITY_GROUPS_CONTENT_AUDIT'|'SECURITY_GROUPS_USAGE_AUDIT'|'NETWORK_FIREWALL',
'Data': 'string',
'NextToken': 'string'
}
Response Structure
(dict) --
AdminAccountId (string) --
The ID of the AWS Firewall administrator account for this policy.
ServiceType (string) --
The service type that is protected by the policy. Currently, this is always SHIELD_ADVANCED .
Data (string) --
Details about the attack, including the following:
The details are in JSON format.
NextToken (string) --
If you have more objects than the number that you specified for MaxResults in the request, the response includes a NextToken value. To list more objects, submit another GetProtectionStatus request, and specify the NextToken value from the response in the NextToken value in the next request.
AWS SDKs provide auto-pagination that identify NextToken in a response and make subsequent request calls automatically on your behalf. However, this feature is not supported by GetProtectionStatus . You must submit subsequent requests with NextToken using your own processes.
Exceptions
Returns information about the specified AWS Firewall Manager protocols list.
See also: AWS API Documentation
Request Syntax
response = client.get_protocols_list(
ListId='string',
DefaultList=True|False
)
[REQUIRED]
The ID of the AWS Firewall Manager protocols list that you want the details for.
dict
Response Syntax
{
'ProtocolsList': {
'ListId': 'string',
'ListName': 'string',
'ListUpdateToken': 'string',
'CreateTime': datetime(2015, 1, 1),
'LastUpdateTime': datetime(2015, 1, 1),
'ProtocolsList': [
'string',
],
'PreviousProtocolsList': {
'string': [
'string',
]
}
},
'ProtocolsListArn': 'string'
}
Response Structure
(dict) --
ProtocolsList (dict) --
Information about the specified AWS Firewall Manager protocols list.
ListId (string) --
The ID of the AWS Firewall Manager protocols list.
ListName (string) --
The name of the AWS Firewall Manager protocols list.
ListUpdateToken (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.
CreateTime (datetime) --
The time that the AWS Firewall Manager protocols list was created.
LastUpdateTime (datetime) --
The time that the AWS Firewall Manager protocols list was last updated.
ProtocolsList (list) --
An array of protocols in the AWS Firewall Manager protocols list.
PreviousProtocolsList (dict) --
A map of previous version numbers to their corresponding protocol arrays.
ProtocolsListArn (string) --
The Amazon Resource Name (ARN) of the specified protocols list.
Exceptions
Retrieves violations for a resource based on the specified AWS Firewall Manager policy and AWS account.
See also: AWS API Documentation
Request Syntax
response = client.get_violation_details(
PolicyId='string',
MemberAccount='string',
ResourceId='string',
ResourceType='string'
)
[REQUIRED]
The ID of the AWS Firewall Manager policy that you want the details for. This currently only supports security group content audit policies.
[REQUIRED]
The AWS account ID that you want the details for.
[REQUIRED]
The ID of the resource that has violations.
[REQUIRED]
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 , and AWS::EC2::Subnet .
dict
Response Syntax
{
'ViolationDetail': {
'PolicyId': 'string',
'MemberAccount': 'string',
'ResourceId': 'string',
'ResourceType': 'string',
'ResourceViolations': [
{
'AwsVPCSecurityGroupViolation': {
'ViolationTarget': 'string',
'ViolationTargetDescription': 'string',
'PartialMatches': [
{
'Reference': 'string',
'TargetViolationReasons': [
'string',
]
},
],
'PossibleSecurityGroupRemediationActions': [
{
'RemediationActionType': 'REMOVE'|'MODIFY',
'Description': 'string',
'RemediationResult': {
'IPV4Range': 'string',
'IPV6Range': 'string',
'PrefixListId': 'string',
'Protocol': 'string',
'FromPort': 123,
'ToPort': 123
},
'IsDefaultAction': True|False
},
]
},
'AwsEc2NetworkInterfaceViolation': {
'ViolationTarget': 'string',
'ViolatingSecurityGroups': [
'string',
]
},
'AwsEc2InstanceViolation': {
'ViolationTarget': 'string',
'AwsEc2NetworkInterfaceViolations': [
{
'ViolationTarget': 'string',
'ViolatingSecurityGroups': [
'string',
]
},
]
},
'NetworkFirewallMissingFirewallViolation': {
'ViolationTarget': 'string',
'VPC': 'string',
'AvailabilityZone': 'string',
'TargetViolationReason': 'string'
},
'NetworkFirewallMissingSubnetViolation': {
'ViolationTarget': 'string',
'VPC': 'string',
'AvailabilityZone': 'string',
'TargetViolationReason': 'string'
},
'NetworkFirewallMissingExpectedRTViolation': {
'ViolationTarget': 'string',
'VPC': 'string',
'AvailabilityZone': 'string',
'CurrentRouteTable': 'string',
'ExpectedRouteTable': 'string'
},
'NetworkFirewallPolicyModifiedViolation': {
'ViolationTarget': 'string',
'CurrentPolicyDescription': {
'StatelessRuleGroups': [
{
'RuleGroupName': 'string',
'ResourceId': 'string',
'Priority': 123
},
],
'StatelessDefaultActions': [
'string',
],
'StatelessFragmentDefaultActions': [
'string',
],
'StatelessCustomActions': [
'string',
],
'StatefulRuleGroups': [
{
'RuleGroupName': 'string',
'ResourceId': 'string'
},
]
},
'ExpectedPolicyDescription': {
'StatelessRuleGroups': [
{
'RuleGroupName': 'string',
'ResourceId': 'string',
'Priority': 123
},
],
'StatelessDefaultActions': [
'string',
],
'StatelessFragmentDefaultActions': [
'string',
],
'StatelessCustomActions': [
'string',
],
'StatefulRuleGroups': [
{
'RuleGroupName': 'string',
'ResourceId': 'string'
},
]
}
}
},
],
'ResourceTags': [
{
'Key': 'string',
'Value': 'string'
},
],
'ResourceDescription': 'string'
}
}
Response Structure
(dict) --
ViolationDetail (dict) --
Violation detail for a resource.
PolicyId (string) --
The ID of the AWS Firewall Manager policy that the violation details were requested for.
MemberAccount (string) --
The AWS account that the violation details were requested for.
ResourceId (string) --
The resource ID that the violation details were requested for.
ResourceType (string) --
The resource type that the violation details were requested for.
ResourceViolations (list) --
List of violations for the requested resource.
(dict) --
Violation detail based on resource type.
AwsVPCSecurityGroupViolation (dict) --
Violation details for security groups.
ViolationTarget (string) --
The security group rule that is being evaluated.
ViolationTargetDescription (string) --
A description of the security group that violates the policy.
PartialMatches (list) --
List of rules specified in the security group of the AWS Firewall Manager policy that partially match the ViolationTarget rule.
(dict) --
The reference rule that partially matches the ViolationTarget rule and violation reason.
Reference (string) --
The reference rule from the master security group of the AWS Firewall Manager policy.
TargetViolationReasons (list) --
The violation reason.
PossibleSecurityGroupRemediationActions (list) --
Remediation options for the rule specified in the ViolationTarget .
(dict) --
Remediation option for the rule specified in the ViolationTarget .
RemediationActionType (string) --
The remediation action that will be performed.
Description (string) --
Brief description of the action that will be performed.
RemediationResult (dict) --
The final state of the rule specified in the ViolationTarget after it is remediated.
IPV4Range (string) --
The IPv4 ranges for the security group rule.
IPV6Range (string) --
The IPv6 ranges for the security group rule.
PrefixListId (string) --
The ID of the prefix list for the security group rule.
Protocol (string) --
The IP protocol name (tcp , udp , icmp , icmpv6 ) or number.
FromPort (integer) --
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.
ToPort (integer) --
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.
IsDefaultAction (boolean) --
Indicates if the current action is the default action.
AwsEc2NetworkInterfaceViolation (dict) --
Violation details for network interface.
ViolationTarget (string) --
The resource ID of the network interface.
ViolatingSecurityGroups (list) --
List of security groups that violate the rules specified in the master security group of the AWS Firewall Manager policy.
AwsEc2InstanceViolation (dict) --
Violation details for an EC2 instance.
ViolationTarget (string) --
The resource ID of the EC2 instance.
AwsEc2NetworkInterfaceViolations (list) --
Violations for network interfaces associated with the EC2 instance.
(dict) --
Violations for network interfaces associated with an EC2 instance.
ViolationTarget (string) --
The resource ID of the network interface.
ViolatingSecurityGroups (list) --
List of security groups that violate the rules specified in the master security group of the AWS Firewall Manager policy.
NetworkFirewallMissingFirewallViolation (dict) --
Violation detail for an Network Firewall policy that indicates that a subnet has no Firewall Manager managed firewall in its VPC.
ViolationTarget (string) --
The ID of the AWS Network Firewall or VPC resource that's in violation.
VPC (string) --
The resource ID of the VPC associated with a violating subnet.
AvailabilityZone (string) --
The Availability Zone of a violating subnet.
TargetViolationReason (string) --
The reason the resource has this violation, if one is available.
NetworkFirewallMissingSubnetViolation (dict) --
Violation detail for an Network Firewall policy that indicates that an Availability Zone is missing the expected Firewall Manager managed subnet.
ViolationTarget (string) --
The ID of the AWS Network Firewall or VPC resource that's in violation.
VPC (string) --
The resource ID of the VPC associated with a violating subnet.
AvailabilityZone (string) --
The Availability Zone of a violating subnet.
TargetViolationReason (string) --
The reason the resource has this violation, if one is available.
NetworkFirewallMissingExpectedRTViolation (dict) --
Violation detail for an Network Firewall policy that indicates that a subnet is not associated with the expected Firewall Manager managed route table.
ViolationTarget (string) --
The ID of the AWS Network Firewall or VPC resource that's in violation.
VPC (string) --
The resource ID of the VPC associated with a violating subnet.
AvailabilityZone (string) --
The Availability Zone of a violating subnet.
CurrentRouteTable (string) --
The resource ID of the current route table that's associated with the subnet, if one is available.
ExpectedRouteTable (string) --
The resource ID of the route table that should be associated with the subnet.
NetworkFirewallPolicyModifiedViolation (dict) --
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.
ViolationTarget (string) --
The ID of the AWS Network Firewall or VPC resource that's in violation.
CurrentPolicyDescription (dict) --
The policy that's currently in use in the individual account.
StatelessRuleGroups (list) --
The stateless rule groups that are used in the Network Firewall firewall policy.
(dict) --
AWS Network Firewall stateless rule group, used in a NetworkFirewallPolicyDescription .
RuleGroupName (string) --
The name of the rule group.
ResourceId (string) --
The resource ID of the rule group.
Priority (integer) --
The priority of the rule group. AWS Network Firewall evaluates the stateless rule groups in a firewall policy starting from the lowest priority setting.
StatelessDefaultActions (list) --
The actions to take on packets that don't match any of the stateless rule groups.
StatelessFragmentDefaultActions (list) --
The actions to take on packet fragments that don't match any of the stateless rule groups.
StatelessCustomActions (list) --
Names of custom actions that are available for use in the stateless default actions settings.
StatefulRuleGroups (list) --
The stateful rule groups that are used in the Network Firewall firewall policy.
(dict) --
AWS Network Firewall stateful rule group, used in a NetworkFirewallPolicyDescription .
RuleGroupName (string) --
The name of the rule group.
ResourceId (string) --
The resource ID of the rule group.
ExpectedPolicyDescription (dict) --
The policy that should be in use in the individual account in order to be compliant.
StatelessRuleGroups (list) --
The stateless rule groups that are used in the Network Firewall firewall policy.
(dict) --
AWS Network Firewall stateless rule group, used in a NetworkFirewallPolicyDescription .
RuleGroupName (string) --
The name of the rule group.
ResourceId (string) --
The resource ID of the rule group.
Priority (integer) --
The priority of the rule group. AWS Network Firewall evaluates the stateless rule groups in a firewall policy starting from the lowest priority setting.
StatelessDefaultActions (list) --
The actions to take on packets that don't match any of the stateless rule groups.
StatelessFragmentDefaultActions (list) --
The actions to take on packet fragments that don't match any of the stateless rule groups.
StatelessCustomActions (list) --
Names of custom actions that are available for use in the stateless default actions settings.
StatefulRuleGroups (list) --
The stateful rule groups that are used in the Network Firewall firewall policy.
(dict) --
AWS Network Firewall stateful rule group, used in a NetworkFirewallPolicyDescription .
RuleGroupName (string) --
The name of the rule group.
ResourceId (string) --
The resource ID of the rule group.
ResourceTags (list) --
The ResourceTag objects associated with the resource.
(dict) --
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.
Key (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 (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.
ResourceDescription (string) --
Brief description for the requested resource.
Exceptions
Returns an object that can wait for some condition.
Returns an array of AppsListDataSummary objects.
See also: AWS API Documentation
Request Syntax
response = client.list_apps_lists(
DefaultLists=True|False,
NextToken='string',
MaxResults=123
)
[REQUIRED]
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.
dict
Response Syntax
{
'AppsLists': [
{
'ListArn': 'string',
'ListId': 'string',
'ListName': 'string',
'AppsList': [
{
'AppName': 'string',
'Protocol': 'string',
'Port': 123
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
AppsLists (list) --
An array of AppsListDataSummary objects.
(dict) --
Details of the AWS Firewall Manager applications list.
ListArn (string) --
The Amazon Resource Name (ARN) of the applications list.
ListId (string) --
The ID of the applications list.
ListName (string) --
The name of the applications list.
AppsList (list) --
An array of App objects in the AWS Firewall Manager applications list.
(dict) --
An individual AWS Firewall Manager application.
AppName (string) --
The application's name.
Protocol (string) --
The IP protocol name or number. The name can be one of tcp , udp , or icmp . For information on possible numbers, see Protocol Numbers .
Port (integer) --
The application's port number, for example 80 .
NextToken (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.
Exceptions
Returns an array of PolicyComplianceStatus objects. Use PolicyComplianceStatus to get a summary of which member accounts are protected by the specified policy.
See also: AWS API Documentation
Request Syntax
response = client.list_compliance_status(
PolicyId='string',
NextToken='string',
MaxResults=123
)
[REQUIRED]
The ID of the AWS Firewall Manager policy that you want the details for.
dict
Response Syntax
{
'PolicyComplianceStatusList': [
{
'PolicyOwner': 'string',
'PolicyId': 'string',
'PolicyName': 'string',
'MemberAccount': 'string',
'EvaluationResults': [
{
'ComplianceStatus': 'COMPLIANT'|'NON_COMPLIANT',
'ViolatorCount': 123,
'EvaluationLimitExceeded': True|False
},
],
'LastUpdated': datetime(2015, 1, 1),
'IssueInfoMap': {
'string': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
PolicyComplianceStatusList (list) --
An array of PolicyComplianceStatus objects.
(dict) --
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.
PolicyOwner (string) --
The AWS account that created the AWS Firewall Manager policy.
PolicyId (string) --
The ID of the AWS Firewall Manager policy.
PolicyName (string) --
The name of the AWS Firewall Manager policy.
MemberAccount (string) --
The member account ID.
EvaluationResults (list) --
An array of EvaluationResult objects.
(dict) --
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.
ComplianceStatus (string) --
Describes an AWS account's compliance with the AWS Firewall Manager policy.
ViolatorCount (integer) --
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.
EvaluationLimitExceeded (boolean) --
Indicates that over 100 resources are noncompliant with the AWS Firewall Manager policy.
LastUpdated (datetime) --
Timestamp of the last update to the EvaluationResult objects.
IssueInfoMap (dict) --
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.
NextToken (string) --
If you have more PolicyComplianceStatus objects than the number that you specified for MaxResults in the request, the response includes a NextToken value. To list more PolicyComplianceStatus objects, submit another ListComplianceStatus request, and specify the NextToken value from the response in the NextToken value in the next request.
Exceptions
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.
See also: AWS API Documentation
Request Syntax
response = client.list_member_accounts(
NextToken='string',
MaxResults=123
)
dict
Response Syntax
{
'MemberAccounts': [
'string',
],
'NextToken': 'string'
}
Response Structure
(dict) --
MemberAccounts (list) --
An array of account IDs.
NextToken (string) --
If you have more member account IDs than the number that you specified for MaxResults in the request, the response includes a NextToken value. To list more IDs, submit another ListMemberAccounts request, and specify the NextToken value from the response in the NextToken value in the next request.
Exceptions
Returns an array of PolicySummary objects.
See also: AWS API Documentation
Request Syntax
response = client.list_policies(
NextToken='string',
MaxResults=123
)
dict
Response Syntax
{
'PolicyList': [
{
'PolicyArn': 'string',
'PolicyId': 'string',
'PolicyName': 'string',
'ResourceType': 'string',
'SecurityServiceType': 'WAF'|'WAFV2'|'SHIELD_ADVANCED'|'SECURITY_GROUPS_COMMON'|'SECURITY_GROUPS_CONTENT_AUDIT'|'SECURITY_GROUPS_USAGE_AUDIT'|'NETWORK_FIREWALL',
'RemediationEnabled': True|False
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
PolicyList (list) --
An array of PolicySummary objects.
(dict) --
Details of the AWS Firewall Manager policy.
PolicyArn (string) --
The Amazon Resource Name (ARN) of the specified policy.
PolicyId (string) --
The ID of the specified policy.
PolicyName (string) --
The name of the specified policy.
ResourceType (string) --
The type of resource protected by or in scope of the policy. This is in the format shown in the AWS Resource Types Reference . For AWS WAF and Shield Advanced, examples include AWS::ElasticLoadBalancingV2::LoadBalancer and AWS::CloudFront::Distribution . For a security group common policy, valid values are AWS::EC2::NetworkInterface and AWS::EC2::Instance . For a security group content audit policy, valid values are AWS::EC2::SecurityGroup , AWS::EC2::NetworkInterface , and AWS::EC2::Instance . For a security group usage audit policy, the value is AWS::EC2::SecurityGroup . For an AWS Network Firewall policy, the value is AWS::EC2::VPC .
SecurityServiceType (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.
RemediationEnabled (boolean) --
Indicates if the policy should be automatically applied to new resources.
NextToken (string) --
If you have more PolicySummary objects than the number that you specified for MaxResults in the request, the response includes a NextToken value. To list more PolicySummary objects, submit another ListPolicies request, and specify the NextToken value from the response in the NextToken value in the next request.
Exceptions
Returns an array of ProtocolsListDataSummary objects.
See also: AWS API Documentation
Request Syntax
response = client.list_protocols_lists(
DefaultLists=True|False,
NextToken='string',
MaxResults=123
)
[REQUIRED]
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.
dict
Response Syntax
{
'ProtocolsLists': [
{
'ListArn': 'string',
'ListId': 'string',
'ListName': 'string',
'ProtocolsList': [
'string',
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ProtocolsLists (list) --
An array of ProtocolsListDataSummary objects.
(dict) --
Details of the AWS Firewall Manager protocols list.
ListArn (string) --
The Amazon Resource Name (ARN) of the specified protocols list.
ListId (string) --
The ID of the specified protocols list.
ListName (string) --
The name of the specified protocols list.
ProtocolsList (list) --
An array of protocols in the AWS Firewall Manager protocols list.
NextToken (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.
Exceptions
Retrieves the list of tags for the specified AWS resource.
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_resource(
ResourceArn='string'
)
[REQUIRED]
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': [
{
'Key': 'string',
'Value': 'string'
},
]
}
Response Structure
The tags associated with the resource.
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.
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.
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.
Exceptions
Creates an AWS Firewall Manager applications list.
See also: AWS API Documentation
Request Syntax
response = client.put_apps_list(
AppsList={
'ListId': 'string',
'ListName': 'string',
'ListUpdateToken': 'string',
'CreateTime': datetime(2015, 1, 1),
'LastUpdateTime': datetime(2015, 1, 1),
'AppsList': [
{
'AppName': 'string',
'Protocol': 'string',
'Port': 123
},
],
'PreviousAppsList': {
'string': [
{
'AppName': 'string',
'Protocol': 'string',
'Port': 123
},
]
}
},
TagList=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The details of the AWS Firewall Manager applications list to be created.
The ID of the AWS Firewall Manager applications list.
The name of the AWS Firewall Manager applications list.
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.
The time that the AWS Firewall Manager applications list was created.
The time that the AWS Firewall Manager applications list was last updated.
An array of applications in the AWS Firewall Manager applications list.
An individual AWS Firewall Manager application.
The application's name.
The IP protocol name or number. The name can be one of tcp , udp , or icmp . For information on possible numbers, see Protocol Numbers .
The application's port number, for example 80 .
A map of previous version numbers to their corresponding App object arrays.
An individual AWS Firewall Manager application.
The application's name.
The IP protocol name or number. The name can be one of tcp , udp , or icmp . For information on possible numbers, see Protocol Numbers .
The application's port number, for example 80 .
The tags associated with the resource.
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.
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.
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.
dict
Response Syntax
{
'AppsList': {
'ListId': 'string',
'ListName': 'string',
'ListUpdateToken': 'string',
'CreateTime': datetime(2015, 1, 1),
'LastUpdateTime': datetime(2015, 1, 1),
'AppsList': [
{
'AppName': 'string',
'Protocol': 'string',
'Port': 123
},
],
'PreviousAppsList': {
'string': [
{
'AppName': 'string',
'Protocol': 'string',
'Port': 123
},
]
}
},
'AppsListArn': 'string'
}
Response Structure
(dict) --
AppsList (dict) --
The details of the AWS Firewall Manager applications list.
ListId (string) --
The ID of the AWS Firewall Manager applications list.
ListName (string) --
The name of the AWS Firewall Manager applications list.
ListUpdateToken (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.
CreateTime (datetime) --
The time that the AWS Firewall Manager applications list was created.
LastUpdateTime (datetime) --
The time that the AWS Firewall Manager applications list was last updated.
AppsList (list) --
An array of applications in the AWS Firewall Manager applications list.
(dict) --
An individual AWS Firewall Manager application.
AppName (string) --
The application's name.
Protocol (string) --
The IP protocol name or number. The name can be one of tcp , udp , or icmp . For information on possible numbers, see Protocol Numbers .
Port (integer) --
The application's port number, for example 80 .
PreviousAppsList (dict) --
A map of previous version numbers to their corresponding App object arrays.
(string) --
(list) --
(dict) --
An individual AWS Firewall Manager application.
AppName (string) --
The application's name.
Protocol (string) --
The IP protocol name or number. The name can be one of tcp , udp , or icmp . For information on possible numbers, see Protocol Numbers .
Port (integer) --
The application's port number, for example 80 .
AppsListArn (string) --
The Amazon Resource Name (ARN) of the applications list.
Exceptions
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 .
See also: AWS API Documentation
Request Syntax
response = client.put_notification_channel(
SnsTopicArn='string',
SnsRoleName='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the SNS topic that collects notifications from AWS Firewall Manager.
[REQUIRED]
The Amazon Resource Name (ARN) of the IAM role that allows Amazon SNS to record AWS Firewall Manager activity.
None
Exceptions
Creates an AWS Firewall Manager policy.
Firewall Manager provides the following types of policies:
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 .
See also: AWS API Documentation
Request Syntax
response = client.put_policy(
Policy={
'PolicyId': 'string',
'PolicyName': 'string',
'PolicyUpdateToken': 'string',
'SecurityServicePolicyData': {
'Type': 'WAF'|'WAFV2'|'SHIELD_ADVANCED'|'SECURITY_GROUPS_COMMON'|'SECURITY_GROUPS_CONTENT_AUDIT'|'SECURITY_GROUPS_USAGE_AUDIT'|'NETWORK_FIREWALL',
'ManagedServiceData': 'string'
},
'ResourceType': 'string',
'ResourceTypeList': [
'string',
],
'ResourceTags': [
{
'Key': 'string',
'Value': 'string'
},
],
'ExcludeResourceTags': True|False,
'RemediationEnabled': True|False,
'IncludeMap': {
'string': [
'string',
]
},
'ExcludeMap': {
'string': [
'string',
]
}
},
TagList=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The details of the AWS Firewall Manager policy to be created.
The ID of the AWS Firewall Manager policy.
The name of the AWS Firewall Manager policy.
A unique identifier for each update to the policy. When issuing a PutPolicy request, the PolicyUpdateToken in the request must match the PolicyUpdateToken of the current policy version. To get the PolicyUpdateToken of the current policy version, use a GetPolicy request.
Details about the security service that is being used to protect the resources.
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.
Details about the service that are specific to the service type, in JSON format. For service type SHIELD_ADVANCED , this is an empty string.
The type of resource protected by or in scope of the policy. This is in the format shown in the AWS Resource Types Reference . For AWS WAF and Shield Advanced, examples include AWS::ElasticLoadBalancingV2::LoadBalancer and AWS::CloudFront::Distribution . For a security group common policy, valid values are AWS::EC2::NetworkInterface and AWS::EC2::Instance . For a security group content audit policy, valid values are AWS::EC2::SecurityGroup , AWS::EC2::NetworkInterface , and AWS::EC2::Instance . For a security group usage audit policy, the value is AWS::EC2::SecurityGroup . For an AWS Network Firewall policy, the value is AWS::EC2::VPC .
An array of ResourceType .
An array of ResourceTag objects.
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 .
The resource tag key.
The resource tag value.
If set to True , resources with the tags that are specified in the ResourceTag array are not in scope of the policy. If set to False , and the ResourceTag array is not null, only resources with the specified tags are in scope of the policy.
Indicates if the policy should be automatically applied to new resources.
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 the IncludeMap , and does not evaluate any ExcludeMap specifications. If you do not specify an IncludeMap , then Firewall Manager applies the policy to all accounts except for those specified by the ExcludeMap .
You can specify account IDs, OUs, or a combination:
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 the IncludeMap , and does not evaluate any ExcludeMap specifications. If you do not specify an IncludeMap , then Firewall Manager applies the policy to all accounts except for those specified by the ExcludeMap .
You can specify account IDs, OUs, or a combination:
The tags to add to the AWS resource.
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.
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.
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.
dict
Response Syntax
{
'Policy': {
'PolicyId': 'string',
'PolicyName': 'string',
'PolicyUpdateToken': 'string',
'SecurityServicePolicyData': {
'Type': 'WAF'|'WAFV2'|'SHIELD_ADVANCED'|'SECURITY_GROUPS_COMMON'|'SECURITY_GROUPS_CONTENT_AUDIT'|'SECURITY_GROUPS_USAGE_AUDIT'|'NETWORK_FIREWALL',
'ManagedServiceData': 'string'
},
'ResourceType': 'string',
'ResourceTypeList': [
'string',
],
'ResourceTags': [
{
'Key': 'string',
'Value': 'string'
},
],
'ExcludeResourceTags': True|False,
'RemediationEnabled': True|False,
'IncludeMap': {
'string': [
'string',
]
},
'ExcludeMap': {
'string': [
'string',
]
}
},
'PolicyArn': 'string'
}
Response Structure
(dict) --
Policy (dict) --
The details of the AWS Firewall Manager policy.
PolicyId (string) --
The ID of the AWS Firewall Manager policy.
PolicyName (string) --
The name of the AWS Firewall Manager policy.
PolicyUpdateToken (string) --
A unique identifier for each update to the policy. When issuing a PutPolicy request, the PolicyUpdateToken in the request must match the PolicyUpdateToken of the current policy version. To get the PolicyUpdateToken of the current policy version, use a GetPolicy request.
SecurityServicePolicyData (dict) --
Details about the security service that is being used to protect the resources.
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.
ManagedServiceData (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.
ResourceType (string) --
The type of resource protected by or in scope of the policy. This is in the format shown in the AWS Resource Types Reference . For AWS WAF and Shield Advanced, examples include AWS::ElasticLoadBalancingV2::LoadBalancer and AWS::CloudFront::Distribution . For a security group common policy, valid values are AWS::EC2::NetworkInterface and AWS::EC2::Instance . For a security group content audit policy, valid values are AWS::EC2::SecurityGroup , AWS::EC2::NetworkInterface , and AWS::EC2::Instance . For a security group usage audit policy, the value is AWS::EC2::SecurityGroup . For an AWS Network Firewall policy, the value is AWS::EC2::VPC .
ResourceTypeList (list) --
An array of ResourceType .
ResourceTags (list) --
An array of ResourceTag objects.
(dict) --
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 .
Key (string) --
The resource tag key.
Value (string) --
The resource tag value.
ExcludeResourceTags (boolean) --
If set to True , resources with the tags that are specified in the ResourceTag array are not in scope of the policy. If set to False , and the ResourceTag array is not null, only resources with the specified tags are in scope of the policy.
RemediationEnabled (boolean) --
Indicates if the policy should be automatically applied to new resources.
IncludeMap (dict) --
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 the IncludeMap , and does not evaluate any ExcludeMap specifications. If you do not specify an IncludeMap , then Firewall Manager applies the policy to all accounts except for those specified by the ExcludeMap .
You can specify account IDs, OUs, or a combination:
ExcludeMap (dict) --
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 the IncludeMap , and does not evaluate any ExcludeMap specifications. If you do not specify an IncludeMap , then Firewall Manager applies the policy to all accounts except for those specified by the ExcludeMap .
You can specify account IDs, OUs, or a combination:
PolicyArn (string) --
The Amazon Resource Name (ARN) of the policy.
Exceptions
Creates an AWS Firewall Manager protocols list.
See also: AWS API Documentation
Request Syntax
response = client.put_protocols_list(
ProtocolsList={
'ListId': 'string',
'ListName': 'string',
'ListUpdateToken': 'string',
'CreateTime': datetime(2015, 1, 1),
'LastUpdateTime': datetime(2015, 1, 1),
'ProtocolsList': [
'string',
],
'PreviousProtocolsList': {
'string': [
'string',
]
}
},
TagList=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The details of the AWS Firewall Manager protocols list to be created.
The ID of the AWS Firewall Manager protocols list.
The name of the AWS Firewall Manager protocols list.
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.
The time that the AWS Firewall Manager protocols list was created.
The time that the AWS Firewall Manager protocols list was last updated.
An array of protocols in the AWS Firewall Manager protocols list.
A map of previous version numbers to their corresponding protocol arrays.
The tags associated with the resource.
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.
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.
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.
dict
Response Syntax
{
'ProtocolsList': {
'ListId': 'string',
'ListName': 'string',
'ListUpdateToken': 'string',
'CreateTime': datetime(2015, 1, 1),
'LastUpdateTime': datetime(2015, 1, 1),
'ProtocolsList': [
'string',
],
'PreviousProtocolsList': {
'string': [
'string',
]
}
},
'ProtocolsListArn': 'string'
}
Response Structure
(dict) --
ProtocolsList (dict) --
The details of the AWS Firewall Manager protocols list.
ListId (string) --
The ID of the AWS Firewall Manager protocols list.
ListName (string) --
The name of the AWS Firewall Manager protocols list.
ListUpdateToken (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.
CreateTime (datetime) --
The time that the AWS Firewall Manager protocols list was created.
LastUpdateTime (datetime) --
The time that the AWS Firewall Manager protocols list was last updated.
ProtocolsList (list) --
An array of protocols in the AWS Firewall Manager protocols list.
PreviousProtocolsList (dict) --
A map of previous version numbers to their corresponding protocol arrays.
ProtocolsListArn (string) --
The Amazon Resource Name (ARN) of the protocols list.
Exceptions
Adds one or more tags to an AWS resource.
See also: AWS API Documentation
Request Syntax
response = client.tag_resource(
ResourceArn='string',
TagList=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
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.
[REQUIRED]
The tags to add to the resource.
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.
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.
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.
dict
Response Syntax
{}
Response Structure
Exceptions
Removes one or more tags from an AWS resource.
See also: AWS API Documentation
Request Syntax
response = client.untag_resource(
ResourceArn='string',
TagKeys=[
'string',
]
)
[REQUIRED]
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.
[REQUIRED]
The keys of the tags to remove from the resource.
dict
Response Syntax
{}
Response Structure
Exceptions
The available paginators are:
paginator = client.get_paginator('list_compliance_status')
Creates an iterator that will paginate through responses from FMS.Client.list_compliance_status().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PolicyId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The ID of the AWS Firewall Manager policy that you want the details for.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'PolicyComplianceStatusList': [
{
'PolicyOwner': 'string',
'PolicyId': 'string',
'PolicyName': 'string',
'MemberAccount': 'string',
'EvaluationResults': [
{
'ComplianceStatus': 'COMPLIANT'|'NON_COMPLIANT',
'ViolatorCount': 123,
'EvaluationLimitExceeded': True|False
},
],
'LastUpdated': datetime(2015, 1, 1),
'IssueInfoMap': {
'string': 'string'
}
},
],
}
Response Structure
(dict) --
PolicyComplianceStatusList (list) --
An array of PolicyComplianceStatus objects.
(dict) --
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.
PolicyOwner (string) --
The AWS account that created the AWS Firewall Manager policy.
PolicyId (string) --
The ID of the AWS Firewall Manager policy.
PolicyName (string) --
The name of the AWS Firewall Manager policy.
MemberAccount (string) --
The member account ID.
EvaluationResults (list) --
An array of EvaluationResult objects.
(dict) --
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.
ComplianceStatus (string) --
Describes an AWS account's compliance with the AWS Firewall Manager policy.
ViolatorCount (integer) --
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.
EvaluationLimitExceeded (boolean) --
Indicates that over 100 resources are noncompliant with the AWS Firewall Manager policy.
LastUpdated (datetime) --
Timestamp of the last update to the EvaluationResult objects.
IssueInfoMap (dict) --
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.
paginator = client.get_paginator('list_member_accounts')
Creates an iterator that will paginate through responses from FMS.Client.list_member_accounts().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'MemberAccounts': [
'string',
],
}
Response Structure
An array of account IDs.
paginator = client.get_paginator('list_policies')
Creates an iterator that will paginate through responses from FMS.Client.list_policies().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'PolicyList': [
{
'PolicyArn': 'string',
'PolicyId': 'string',
'PolicyName': 'string',
'ResourceType': 'string',
'SecurityServiceType': 'WAF'|'WAFV2'|'SHIELD_ADVANCED'|'SECURITY_GROUPS_COMMON'|'SECURITY_GROUPS_CONTENT_AUDIT'|'SECURITY_GROUPS_USAGE_AUDIT'|'NETWORK_FIREWALL',
'RemediationEnabled': True|False
},
],
}
Response Structure
An array of PolicySummary objects.
Details of the AWS Firewall Manager policy.
The Amazon Resource Name (ARN) of the specified policy.
The ID of the specified policy.
The name of the specified policy.
The type of resource protected by or in scope of the policy. This is in the format shown in the AWS Resource Types Reference . For AWS WAF and Shield Advanced, examples include AWS::ElasticLoadBalancingV2::LoadBalancer and AWS::CloudFront::Distribution . For a security group common policy, valid values are AWS::EC2::NetworkInterface and AWS::EC2::Instance . For a security group content audit policy, valid values are AWS::EC2::SecurityGroup , AWS::EC2::NetworkInterface , and AWS::EC2::Instance . For a security group usage audit policy, the value is AWS::EC2::SecurityGroup . For an AWS Network Firewall policy, the value is AWS::EC2::VPC .
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.
Indicates if the policy should be automatically applied to new resources.