FMS

Table of Contents

Client

class FMS.Client

A low-level client representing Firewall Management Service (FMS)

This is the Firewall Manager API Reference . This guide is for developers who need detailed information about the Firewall Manager API actions, data types, and errors. For detailed information about Firewall Manager features, see the 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:

associate_admin_account(**kwargs)

Sets the Firewall Manager administrator account. The account must be a member of the organization in Organizations whose resources you want to protect. Firewall Manager sets the permissions that allow the account to administer your Firewall Manager policies.

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

See also: AWS API Documentation

Request Syntax

response = client.associate_admin_account(
    AdminAccount='string'
)
Parameters
AdminAccount (string) --

[REQUIRED]

The Amazon Web Services account ID to associate with Firewall Manager as the Firewall Manager administrator account. This must be an Organizations member account. For more information about Organizations, see Managing the Amazon Web Services Accounts in Your Organization .

Returns
None

Exceptions

  • FMS.Client.exceptions.InvalidOperationException
  • FMS.Client.exceptions.InvalidInputException
  • FMS.Client.exceptions.ResourceNotFoundException
  • FMS.Client.exceptions.InternalErrorException
  • FMS.Client.exceptions.LimitExceededException
can_paginate(operation_name)

Check if an operation can be paginated.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Returns
True if the operation can be paginated, False otherwise.
delete_apps_list(**kwargs)

Permanently deletes an Firewall Manager applications list.

See also: AWS API Documentation

Request Syntax

response = client.delete_apps_list(
    ListId='string'
)
Parameters
ListId (string) --

[REQUIRED]

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

Returns
None

Exceptions

  • FMS.Client.exceptions.ResourceNotFoundException
  • FMS.Client.exceptions.InvalidOperationException
  • FMS.Client.exceptions.InternalErrorException
delete_notification_channel()

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

See also: AWS API Documentation

Request Syntax

response = client.delete_notification_channel()
Returns
None

Exceptions

  • FMS.Client.exceptions.ResourceNotFoundException
  • FMS.Client.exceptions.InvalidOperationException
  • FMS.Client.exceptions.InternalErrorException
delete_policy(**kwargs)

Permanently deletes an Firewall Manager policy.

See also: AWS API Documentation

Request Syntax

response = client.delete_policy(
    PolicyId='string',
    DeleteAllPolicyResources=True|False
)
Parameters
  • PolicyId (string) --

    [REQUIRED]

    The ID of the policy that you want to delete. You can retrieve this ID from PutPolicy and ListPolicies .

  • DeleteAllPolicyResources (boolean) --

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

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

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

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

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

    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.

Returns

None

Exceptions

  • FMS.Client.exceptions.ResourceNotFoundException
  • FMS.Client.exceptions.InvalidOperationException
  • FMS.Client.exceptions.InternalErrorException
  • FMS.Client.exceptions.InvalidInputException
  • FMS.Client.exceptions.LimitExceededException
delete_protocols_list(**kwargs)

Permanently deletes an Firewall Manager protocols list.

See also: AWS API Documentation

Request Syntax

response = client.delete_protocols_list(
    ListId='string'
)
Parameters
ListId (string) --

[REQUIRED]

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

Returns
None

Exceptions

  • FMS.Client.exceptions.ResourceNotFoundException
  • FMS.Client.exceptions.InvalidOperationException
  • FMS.Client.exceptions.InternalErrorException
disassociate_admin_account()

Disassociates the account that has been set as the 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()
Returns
None

Exceptions

  • FMS.Client.exceptions.InvalidOperationException
  • FMS.Client.exceptions.ResourceNotFoundException
  • FMS.Client.exceptions.InternalErrorException
get_admin_account()

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

See also: AWS API Documentation

Request Syntax

response = client.get_admin_account()
Return type
dict
Returns
Response Syntax
{
    'AdminAccount': 'string',
    'RoleStatus': 'READY'|'CREATING'|'PENDING_DELETION'|'DELETING'|'DELETED'
}

Response Structure

  • (dict) --
    • AdminAccount (string) --

      The Amazon Web Services account that is set as the Firewall Manager administrator.

    • RoleStatus (string) --

      The status of the Amazon Web Services account that you set as the Firewall Manager administrator.

Exceptions

  • FMS.Client.exceptions.InvalidOperationException
  • FMS.Client.exceptions.ResourceNotFoundException
  • FMS.Client.exceptions.InternalErrorException
get_apps_list(**kwargs)

Returns information about the specified Firewall Manager applications list.

See also: AWS API Documentation

Request Syntax

response = client.get_apps_list(
    ListId='string',
    DefaultList=True|False
)
Parameters
  • ListId (string) --

    [REQUIRED]

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

  • DefaultList (boolean) -- Specifies whether the list to retrieve is a default list owned by Firewall Manager.
Return type

dict

Returns

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 Firewall Manager applications list.

      • ListId (string) --

        The ID of the Firewall Manager applications list.

      • ListName (string) --

        The name of the 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 Firewall Manager applications list was created.

      • LastUpdateTime (datetime) --

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

      • AppsList (list) --

        An array of applications in the Firewall Manager applications list.

        • (dict) --

          An individual 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 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

  • FMS.Client.exceptions.ResourceNotFoundException
  • FMS.Client.exceptions.InvalidOperationException
  • FMS.Client.exceptions.InternalErrorException
get_compliance_detail(**kwargs)

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 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.
  • Resources are considered noncompliant for DNS Firewall policies if a DNS Firewall rule group is missing from the rule group associations for the VPC.

See also: AWS API Documentation

Request Syntax

response = client.get_compliance_detail(
    PolicyId='string',
    MemberAccount='string'
)
Parameters
  • PolicyId (string) --

    [REQUIRED]

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

  • MemberAccount (string) --

    [REQUIRED]

    The Amazon Web Services account that owns the resources that you want to get the details for.

Return type

dict

Returns

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'|'FMS_CREATED_SECURITY_GROUP_EDITED'|'MISSING_FIREWALL'|'MISSING_FIREWALL_SUBNET_IN_AZ'|'MISSING_EXPECTED_ROUTE_TABLE'|'NETWORK_FIREWALL_POLICY_MODIFIED'|'INTERNET_GATEWAY_MISSING_EXPECTED_ROUTE'|'FIREWALL_SUBNET_MISSING_EXPECTED_ROUTE'|'UNEXPECTED_FIREWALL_ROUTES'|'UNEXPECTED_TARGET_GATEWAY_ROUTES'|'TRAFFIC_INSPECTION_CROSSES_AZ_BOUNDARY'|'INVALID_ROUTE_CONFIGURATION'|'MISSING_TARGET_GATEWAY'|'INTERNET_TRAFFIC_NOT_INSPECTED'|'BLACK_HOLE_ROUTE_DETECTED'|'BLACK_HOLE_ROUTE_DETECTED_IN_FIREWALL_SUBNET'|'RESOURCE_MISSING_DNS_FIREWALL',
                '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 Amazon Web Services account that created the Firewall Manager policy.

      • PolicyId (string) --

        The ID of the Firewall Manager policy.

      • MemberAccount (string) --

        The Amazon Web Services account ID.

      • Violators (list) --

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

        • (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 Amazon Web Services 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 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 WAF or Config, and the error message received that indicates the problem with the service.

        • (string) --
          • (string) --

Exceptions

  • FMS.Client.exceptions.ResourceNotFoundException
  • FMS.Client.exceptions.InternalErrorException
  • FMS.Client.exceptions.InvalidInputException
  • FMS.Client.exceptions.InvalidOperationException
get_notification_channel()

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

See also: AWS API Documentation

Request Syntax

response = client.get_notification_channel()
Return type
dict
Returns
Response Syntax
{
    'SnsTopicArn': 'string',
    'SnsRoleName': 'string'
}

Response Structure

  • (dict) --
    • SnsTopicArn (string) --

      The SNS topic that records Firewall Manager activity.

    • SnsRoleName (string) --

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

Exceptions

  • FMS.Client.exceptions.ResourceNotFoundException
  • FMS.Client.exceptions.InvalidOperationException
  • FMS.Client.exceptions.InternalErrorException
get_paginator(operation_name)

Create a paginator for an operation.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Raises OperationNotPageableError
Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type
L{botocore.paginate.Paginator}
Returns
A paginator object.
get_policy(**kwargs)

Returns information about the specified Firewall Manager policy.

See also: AWS API Documentation

Request Syntax

response = client.get_policy(
    PolicyId='string'
)
Parameters
PolicyId (string) --

[REQUIRED]

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

Return type
dict
Returns
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'|'DNS_FIREWALL',
            'ManagedServiceData': 'string'
        },
        'ResourceType': 'string',
        'ResourceTypeList': [
            'string',
        ],
        'ResourceTags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'ExcludeResourceTags': True|False,
        'RemediationEnabled': True|False,
        'DeleteUnusedFMManagedResources': True|False,
        'IncludeMap': {
            'string': [
                'string',
            ]
        },
        'ExcludeMap': {
            'string': [
                'string',
            ]
        }
    },
    'PolicyArn': 'string'
}

Response Structure

  • (dict) --
    • Policy (dict) --

      Information about the specified Firewall Manager policy.

      • PolicyId (string) --

        The ID of the Firewall Manager policy.

      • PolicyName (string) --

        The name of the 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 WAF policy, a Shield Advanced policy, or a security group policy. For security group policies, Firewall Manager supports one security group for each common policy and for each content audit policy. This is an adjustable limit that you can increase by contacting Amazon Web Services Support.

        • ManagedServiceData (string) --

          Details about the service that are specific to the service type, in JSON format.

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

          Note

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

          • 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\"]} }"
          • Specification for SHIELD_ADVANCED for Amazon CloudFront distributions "{\"type\":\"SHIELD_ADVANCED\",\"automaticResponseConfiguration\": {\"automaticResponseStatus\":\"ENABLED|IGNORED|DISABLED\", \"automaticResponseAction\":\"BLOCK|COUNT\"}, \"overrideCustomerWebaclClassic\":true|false}" For example: "{\"type\":\"SHIELD_ADVANCED\",\"automaticResponseConfiguration\": {\"automaticResponseStatus\":\"ENABLED\", \"automaticResponseAction\":\"COUNT\"}}" The default value for automaticResponseStatus is IGNORED . The value for automaticResponseAction is only required when automaticResponseStatus is set to ENABLED . The default value for overrideCustomerWebaclClassic is false . For other resource types that you can protect with a Shield Advanced policy, this ManagedServiceData configuration is an empty string.
          • Example: WAFV2 "{\"type\":\"WAFV2\",\"preProcessRuleGroups\":[{\"ruleGroupArn\":null,\"overrideAction\":{\"type\":\"NONE\"},\"managedRuleGroupIdentifier\":{\"version\":null,\"vendorName\":\"AWS\",\"managedRuleGroupName\":\"AWSManagedRulesAmazonIpReputationList\"},\"ruleGroupType\":\"ManagedRuleGroup\",\"excludeRules\":[{\"name\":\"NoUserAgent_HEADER\"}]}],\"postProcessRuleGroups\":[],\"defaultAction\":{\"type\":\"ALLOW\"},\"overrideCustomerWebACLAssociation\":false,\"loggingConfiguration\":{\"logDestinationConfigs\":[\"arn:aws:firehose:us-west-2:12345678912:deliverystream/aws-waf-logs-fms-admin-destination\"],\"redactedFields\":[{\"redactedFieldType\":\"SingleHeader\",\"redactedFieldValue\":\"Cookies\"},{\"redactedFieldType\":\"Method\"}]}}" In the loggingConfiguration , you can specify one logDestinationConfigs , you can optionally provide up to 20 redactedFields , and the RedactedFieldType must be one of URI , QUERY_STRING , HEADER , or METHOD .
          • Example: WAF Classic "{\"type\": \"WAF\", \"ruleGroups\": [{\"id\":\"12345678-1bcd-9012-efga-0987654321ab\", \"overrideAction\" : {\"type\": \"COUNT\"}}], \"defaultAction\": {\"type\": \"BLOCK\"}}"
          • Example: SECURITY_GROUPS_COMMON "{\"type\":\"SECURITY_GROUPS_COMMON\",\"revertManualSecurityGroupChanges\":false,\"exclusiveResourceSecurityGroupManagement\":false, \"applyToAllEC2InstanceENIs\":false,\"securityGroups\":[{\"id\":\" sg-000e55995d61a06bd\"}]}"
          • Example: Shared VPCs. Apply the preceding policy to resources in shared VPCs as well as to those in VPCs that the account owns "{\"type\":\"SECURITY_GROUPS_COMMON\",\"revertManualSecurityGroupChanges\":false,\"exclusiveResourceSecurityGroupManagement\":false, \"applyToAllEC2InstanceENIs\":false,\"includeSharedVPC\":true,\"securityGroups\":[{\"id\":\" sg-000e55995d61a06bd\"}]}"
          • Example: SECURITY_GROUPS_CONTENT_AUDIT "{\"type\":\"SECURITY_GROUPS_CONTENT_AUDIT\",\"securityGroups\":[{\"id\":\"sg-000e55995d61a06bd\"}],\"securityGroupAction\":{\"type\":\"ALLOW\"}}" The security group action for content audit can be ALLOW or DENY . For ALLOW , all in-scope security group rules must be within the allowed range of the policy's security group rules. For DENY , all in-scope security group rules must not contain a value or a range that matches a rule value or range in the policy security group.
          • Example: SECURITY_GROUPS_USAGE_AUDIT "{\"type\":\"SECURITY_GROUPS_USAGE_AUDIT\",\"deleteUnusedSecurityGroups\":true,\"coalesceRedundantSecurityGroups\":true}"
      • ResourceType (string) --

        The type of resource protected by or in scope of the policy. This is in the format shown in the Amazon Web Services Resource Types Reference . To apply this policy to multiple resource types, specify a resource type of ResourceTypeList and then specify the resource types in a ResourceTypeList .

        For WAF and Shield Advanced, resource types include AWS::ElasticLoadBalancingV2::LoadBalancer , AWS::ElasticLoadBalancing::LoadBalancer , AWS::EC2::EIP , 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 Network Firewall policy or DNS Firewall policy, the value is AWS::EC2::VPC .

      • ResourceTypeList (list) --

        An array of ResourceType objects. Use this only to specify multiple resource types. To specify a single resource type, use ResourceType .

        • (string) --
      • ResourceTags (list) --

        An array of ResourceTag objects.

        • (dict) --

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

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

      • DeleteUnusedFMManagedResources (boolean) --

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

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

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

      • IncludeMap (dict) --

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

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

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

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

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

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

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

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

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

Exceptions

  • FMS.Client.exceptions.ResourceNotFoundException
  • FMS.Client.exceptions.InvalidOperationException
  • FMS.Client.exceptions.InternalErrorException
  • FMS.Client.exceptions.InvalidTypeException
get_protection_status(**kwargs)

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
)
Parameters
  • PolicyId (string) --

    [REQUIRED]

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

  • MemberAccountId (string) -- The Amazon Web Services account that is in scope of the policy that you want to get the details for.
  • StartTime (datetime) -- The start of the time period to query for the attacks. This is a timestamp type. The request syntax listing indicates a number type because the default used by Firewall Manager is Unix time in seconds. However, any valid timestamp format is allowed.
  • EndTime (datetime) -- The end of the time period to query for the attacks. This is a timestamp type. The request syntax listing indicates a number type because the default used by Firewall Manager is Unix time in seconds. However, any valid timestamp format is allowed.
  • NextToken (string) -- If you specify a value for MaxResults and you have more objects than the number that you specify for MaxResults , Firewall Manager returns a NextToken value in the response, which you can use to retrieve another group of objects. For the second and subsequent GetProtectionStatus requests, specify the value of NextToken from the previous response to get information about another batch of objects.
  • MaxResults (integer) -- Specifies the number of objects that you want Firewall Manager to return for this request. If you have more objects than the number that you specify for MaxResults , the response includes a NextToken value that you can use to get another batch of objects.
Return type

dict

Returns

Response Syntax

{
    'AdminAccountId': 'string',
    'ServiceType': 'WAF'|'WAFV2'|'SHIELD_ADVANCED'|'SECURITY_GROUPS_COMMON'|'SECURITY_GROUPS_CONTENT_AUDIT'|'SECURITY_GROUPS_USAGE_AUDIT'|'NETWORK_FIREWALL'|'DNS_FIREWALL',
    'Data': 'string',
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • AdminAccountId (string) --

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

      • 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 (string) --

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

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

Exceptions

  • FMS.Client.exceptions.InvalidInputException
  • FMS.Client.exceptions.ResourceNotFoundException
  • FMS.Client.exceptions.InternalErrorException
get_protocols_list(**kwargs)

Returns information about the specified Firewall Manager protocols list.

See also: AWS API Documentation

Request Syntax

response = client.get_protocols_list(
    ListId='string',
    DefaultList=True|False
)
Parameters
  • ListId (string) --

    [REQUIRED]

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

  • DefaultList (boolean) -- Specifies whether the list to retrieve is a default list owned by Firewall Manager.
Return type

dict

Returns

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 Firewall Manager protocols list.

      • ListId (string) --

        The ID of the Firewall Manager protocols list.

      • ListName (string) --

        The name of the 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 Firewall Manager protocols list was created.

      • LastUpdateTime (datetime) --

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

      • ProtocolsList (list) --

        An array of protocols in the Firewall Manager protocols list.

        • (string) --
      • PreviousProtocolsList (dict) --

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

        • (string) --
          • (list) --
            • (string) --
    • ProtocolsListArn (string) --

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

Exceptions

  • FMS.Client.exceptions.ResourceNotFoundException
  • FMS.Client.exceptions.InvalidOperationException
  • FMS.Client.exceptions.InternalErrorException
get_violation_details(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.get_violation_details(
    PolicyId='string',
    MemberAccount='string',
    ResourceId='string',
    ResourceType='string'
)
Parameters
  • PolicyId (string) --

    [REQUIRED]

    The ID of the Firewall Manager policy that you want the details for. This currently only supports security group content audit policies.

  • MemberAccount (string) --

    [REQUIRED]

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

  • ResourceId (string) --

    [REQUIRED]

    The ID of the resource that has violations.

  • ResourceType (string) --

    [REQUIRED]

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

Return type

dict

Returns

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'
                            },
                        ]
                    }
                },
                'NetworkFirewallInternetTrafficNotInspectedViolation': {
                    'SubnetId': 'string',
                    'SubnetAvailabilityZone': 'string',
                    'RouteTableId': 'string',
                    'ViolatingRoutes': [
                        {
                            'DestinationType': 'IPV4'|'IPV6'|'PREFIX_LIST',
                            'TargetType': 'GATEWAY'|'CARRIER_GATEWAY'|'INSTANCE'|'LOCAL_GATEWAY'|'NAT_GATEWAY'|'NETWORK_INTERFACE'|'VPC_ENDPOINT'|'VPC_PEERING_CONNECTION'|'EGRESS_ONLY_INTERNET_GATEWAY'|'TRANSIT_GATEWAY',
                            'Destination': 'string',
                            'Target': 'string'
                        },
                    ],
                    'IsRouteTableUsedInDifferentAZ': True|False,
                    'CurrentFirewallSubnetRouteTable': 'string',
                    'ExpectedFirewallEndpoint': 'string',
                    'FirewallSubnetId': 'string',
                    'ExpectedFirewallSubnetRoutes': [
                        {
                            'IpV4Cidr': 'string',
                            'PrefixListId': 'string',
                            'IpV6Cidr': 'string',
                            'ContributingSubnets': [
                                'string',
                            ],
                            'AllowedTargets': [
                                'string',
                            ],
                            'RouteTableId': 'string'
                        },
                    ],
                    'ActualFirewallSubnetRoutes': [
                        {
                            'DestinationType': 'IPV4'|'IPV6'|'PREFIX_LIST',
                            'TargetType': 'GATEWAY'|'CARRIER_GATEWAY'|'INSTANCE'|'LOCAL_GATEWAY'|'NAT_GATEWAY'|'NETWORK_INTERFACE'|'VPC_ENDPOINT'|'VPC_PEERING_CONNECTION'|'EGRESS_ONLY_INTERNET_GATEWAY'|'TRANSIT_GATEWAY',
                            'Destination': 'string',
                            'Target': 'string'
                        },
                    ],
                    'InternetGatewayId': 'string',
                    'CurrentInternetGatewayRouteTable': 'string',
                    'ExpectedInternetGatewayRoutes': [
                        {
                            'IpV4Cidr': 'string',
                            'PrefixListId': 'string',
                            'IpV6Cidr': 'string',
                            'ContributingSubnets': [
                                'string',
                            ],
                            'AllowedTargets': [
                                'string',
                            ],
                            'RouteTableId': 'string'
                        },
                    ],
                    'ActualInternetGatewayRoutes': [
                        {
                            'DestinationType': 'IPV4'|'IPV6'|'PREFIX_LIST',
                            'TargetType': 'GATEWAY'|'CARRIER_GATEWAY'|'INSTANCE'|'LOCAL_GATEWAY'|'NAT_GATEWAY'|'NETWORK_INTERFACE'|'VPC_ENDPOINT'|'VPC_PEERING_CONNECTION'|'EGRESS_ONLY_INTERNET_GATEWAY'|'TRANSIT_GATEWAY',
                            'Destination': 'string',
                            'Target': 'string'
                        },
                    ],
                    'VpcId': 'string'
                },
                'NetworkFirewallInvalidRouteConfigurationViolation': {
                    'AffectedSubnets': [
                        'string',
                    ],
                    'RouteTableId': 'string',
                    'IsRouteTableUsedInDifferentAZ': True|False,
                    'ViolatingRoute': {
                        'DestinationType': 'IPV4'|'IPV6'|'PREFIX_LIST',
                        'TargetType': 'GATEWAY'|'CARRIER_GATEWAY'|'INSTANCE'|'LOCAL_GATEWAY'|'NAT_GATEWAY'|'NETWORK_INTERFACE'|'VPC_ENDPOINT'|'VPC_PEERING_CONNECTION'|'EGRESS_ONLY_INTERNET_GATEWAY'|'TRANSIT_GATEWAY',
                        'Destination': 'string',
                        'Target': 'string'
                    },
                    'CurrentFirewallSubnetRouteTable': 'string',
                    'ExpectedFirewallEndpoint': 'string',
                    'ActualFirewallEndpoint': 'string',
                    'ExpectedFirewallSubnetId': 'string',
                    'ActualFirewallSubnetId': 'string',
                    'ExpectedFirewallSubnetRoutes': [
                        {
                            'IpV4Cidr': 'string',
                            'PrefixListId': 'string',
                            'IpV6Cidr': 'string',
                            'ContributingSubnets': [
                                'string',
                            ],
                            'AllowedTargets': [
                                'string',
                            ],
                            'RouteTableId': 'string'
                        },
                    ],
                    'ActualFirewallSubnetRoutes': [
                        {
                            'DestinationType': 'IPV4'|'IPV6'|'PREFIX_LIST',
                            'TargetType': 'GATEWAY'|'CARRIER_GATEWAY'|'INSTANCE'|'LOCAL_GATEWAY'|'NAT_GATEWAY'|'NETWORK_INTERFACE'|'VPC_ENDPOINT'|'VPC_PEERING_CONNECTION'|'EGRESS_ONLY_INTERNET_GATEWAY'|'TRANSIT_GATEWAY',
                            'Destination': 'string',
                            'Target': 'string'
                        },
                    ],
                    'InternetGatewayId': 'string',
                    'CurrentInternetGatewayRouteTable': 'string',
                    'ExpectedInternetGatewayRoutes': [
                        {
                            'IpV4Cidr': 'string',
                            'PrefixListId': 'string',
                            'IpV6Cidr': 'string',
                            'ContributingSubnets': [
                                'string',
                            ],
                            'AllowedTargets': [
                                'string',
                            ],
                            'RouteTableId': 'string'
                        },
                    ],
                    'ActualInternetGatewayRoutes': [
                        {
                            'DestinationType': 'IPV4'|'IPV6'|'PREFIX_LIST',
                            'TargetType': 'GATEWAY'|'CARRIER_GATEWAY'|'INSTANCE'|'LOCAL_GATEWAY'|'NAT_GATEWAY'|'NETWORK_INTERFACE'|'VPC_ENDPOINT'|'VPC_PEERING_CONNECTION'|'EGRESS_ONLY_INTERNET_GATEWAY'|'TRANSIT_GATEWAY',
                            'Destination': 'string',
                            'Target': 'string'
                        },
                    ],
                    'VpcId': 'string'
                },
                'NetworkFirewallBlackHoleRouteDetectedViolation': {
                    'ViolationTarget': 'string',
                    'RouteTableId': 'string',
                    'VpcId': 'string',
                    'ViolatingRoutes': [
                        {
                            'DestinationType': 'IPV4'|'IPV6'|'PREFIX_LIST',
                            'TargetType': 'GATEWAY'|'CARRIER_GATEWAY'|'INSTANCE'|'LOCAL_GATEWAY'|'NAT_GATEWAY'|'NETWORK_INTERFACE'|'VPC_ENDPOINT'|'VPC_PEERING_CONNECTION'|'EGRESS_ONLY_INTERNET_GATEWAY'|'TRANSIT_GATEWAY',
                            'Destination': 'string',
                            'Target': 'string'
                        },
                    ]
                },
                'NetworkFirewallUnexpectedFirewallRoutesViolation': {
                    'FirewallSubnetId': 'string',
                    'ViolatingRoutes': [
                        {
                            'DestinationType': 'IPV4'|'IPV6'|'PREFIX_LIST',
                            'TargetType': 'GATEWAY'|'CARRIER_GATEWAY'|'INSTANCE'|'LOCAL_GATEWAY'|'NAT_GATEWAY'|'NETWORK_INTERFACE'|'VPC_ENDPOINT'|'VPC_PEERING_CONNECTION'|'EGRESS_ONLY_INTERNET_GATEWAY'|'TRANSIT_GATEWAY',
                            'Destination': 'string',
                            'Target': 'string'
                        },
                    ],
                    'RouteTableId': 'string',
                    'FirewallEndpoint': 'string',
                    'VpcId': 'string'
                },
                'NetworkFirewallUnexpectedGatewayRoutesViolation': {
                    'GatewayId': 'string',
                    'ViolatingRoutes': [
                        {
                            'DestinationType': 'IPV4'|'IPV6'|'PREFIX_LIST',
                            'TargetType': 'GATEWAY'|'CARRIER_GATEWAY'|'INSTANCE'|'LOCAL_GATEWAY'|'NAT_GATEWAY'|'NETWORK_INTERFACE'|'VPC_ENDPOINT'|'VPC_PEERING_CONNECTION'|'EGRESS_ONLY_INTERNET_GATEWAY'|'TRANSIT_GATEWAY',
                            'Destination': 'string',
                            'Target': 'string'
                        },
                    ],
                    'RouteTableId': 'string',
                    'VpcId': 'string'
                },
                'NetworkFirewallMissingExpectedRoutesViolation': {
                    'ViolationTarget': 'string',
                    'ExpectedRoutes': [
                        {
                            'IpV4Cidr': 'string',
                            'PrefixListId': 'string',
                            'IpV6Cidr': 'string',
                            'ContributingSubnets': [
                                'string',
                            ],
                            'AllowedTargets': [
                                'string',
                            ],
                            'RouteTableId': 'string'
                        },
                    ],
                    'VpcId': 'string'
                },
                'DnsRuleGroupPriorityConflictViolation': {
                    'ViolationTarget': 'string',
                    'ViolationTargetDescription': 'string',
                    'ConflictingPriority': 123,
                    'ConflictingPolicyId': 'string',
                    'UnavailablePriorities': [
                        123,
                    ]
                },
                'DnsDuplicateRuleGroupViolation': {
                    'ViolationTarget': 'string',
                    'ViolationTargetDescription': 'string'
                },
                'DnsRuleGroupLimitExceededViolation': {
                    'ViolationTarget': 'string',
                    'ViolationTargetDescription': 'string',
                    'NumberOfRuleGroupsAlreadyAssociated': 123
                },
                'PossibleRemediationActions': {
                    'Description': 'string',
                    'Actions': [
                        {
                            'Description': 'string',
                            'OrderedRemediationActions': [
                                {
                                    'RemediationAction': {
                                        'Description': 'string',
                                        'EC2CreateRouteAction': {
                                            'Description': 'string',
                                            'DestinationCidrBlock': 'string',
                                            'DestinationPrefixListId': 'string',
                                            'DestinationIpv6CidrBlock': 'string',
                                            'VpcEndpointId': {
                                                'ResourceId': 'string',
                                                'Description': 'string'
                                            },
                                            'GatewayId': {
                                                'ResourceId': 'string',
                                                'Description': 'string'
                                            },
                                            'RouteTableId': {
                                                'ResourceId': 'string',
                                                'Description': 'string'
                                            }
                                        },
                                        'EC2ReplaceRouteAction': {
                                            'Description': 'string',
                                            'DestinationCidrBlock': 'string',
                                            'DestinationPrefixListId': 'string',
                                            'DestinationIpv6CidrBlock': 'string',
                                            'GatewayId': {
                                                'ResourceId': 'string',
                                                'Description': 'string'
                                            },
                                            'RouteTableId': {
                                                'ResourceId': 'string',
                                                'Description': 'string'
                                            }
                                        },
                                        'EC2DeleteRouteAction': {
                                            'Description': 'string',
                                            'DestinationCidrBlock': 'string',
                                            'DestinationPrefixListId': 'string',
                                            'DestinationIpv6CidrBlock': 'string',
                                            'RouteTableId': {
                                                'ResourceId': 'string',
                                                'Description': 'string'
                                            }
                                        },
                                        'EC2CopyRouteTableAction': {
                                            'Description': 'string',
                                            'VpcId': {
                                                'ResourceId': 'string',
                                                'Description': 'string'
                                            },
                                            'RouteTableId': {
                                                'ResourceId': 'string',
                                                'Description': 'string'
                                            }
                                        },
                                        'EC2ReplaceRouteTableAssociationAction': {
                                            'Description': 'string',
                                            'AssociationId': {
                                                'ResourceId': 'string',
                                                'Description': 'string'
                                            },
                                            'RouteTableId': {
                                                'ResourceId': 'string',
                                                'Description': 'string'
                                            }
                                        },
                                        'EC2AssociateRouteTableAction': {
                                            'Description': 'string',
                                            'RouteTableId': {
                                                'ResourceId': 'string',
                                                'Description': 'string'
                                            },
                                            'SubnetId': {
                                                'ResourceId': 'string',
                                                'Description': 'string'
                                            },
                                            'GatewayId': {
                                                'ResourceId': 'string',
                                                'Description': 'string'
                                            }
                                        },
                                        'EC2CreateRouteTableAction': {
                                            'Description': 'string',
                                            'VpcId': {
                                                'ResourceId': 'string',
                                                'Description': 'string'
                                            }
                                        }
                                    },
                                    'Order': 123
                                },
                            ],
                            'IsDefaultAction': True|False
                        },
                    ]
                }
            },
        ],
        'ResourceTags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'ResourceDescription': 'string'
    }
}

Response Structure

  • (dict) --

    • ViolationDetail (dict) --

      Violation detail for a resource.

      • PolicyId (string) --

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

      • MemberAccount (string) --

        The Amazon Web Services 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 detail 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 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 primary security group of the Firewall Manager policy.

                • TargetViolationReasons (list) --

                  The violation reason.

                  • (string) --
            • 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 detail for a network interface.

            • ViolationTarget (string) --

              The resource ID of the network interface.

            • ViolatingSecurityGroups (list) --

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

              • (string) --
          • AwsEc2InstanceViolation (dict) --

            Violation detail for an EC2 instance.

            • ViolationTarget (string) --

              The resource ID of the EC2 instance.

            • AwsEc2NetworkInterfaceViolations (list) --

              Violation detail for network interfaces associated with the EC2 instance.

              • (dict) --

                Violation detail 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 primary security group of the Firewall Manager policy.

                  • (string) --
          • 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 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 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 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 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) --

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

                • (string) --
              • StatelessFragmentDefaultActions (list) --

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

                • (string) --
              • StatelessCustomActions (list) --

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

                • (string) --
              • StatefulRuleGroups (list) --

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

                • (dict) --

                  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) --

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

                • (string) --
              • StatelessFragmentDefaultActions (list) --

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

                • (string) --
              • StatelessCustomActions (list) --

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

                • (string) --
              • StatefulRuleGroups (list) --

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

                • (dict) --

                  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.

          • NetworkFirewallInternetTrafficNotInspectedViolation (dict) --

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

            • SubnetId (string) --

              The subnet ID.

            • SubnetAvailabilityZone (string) --

              The subnet Availability Zone.

            • RouteTableId (string) --

              Information about the route table ID.

            • ViolatingRoutes (list) --

              The route or routes that are in violation.

              • (dict) --

                Describes a route in a route table.

                • DestinationType (string) --

                  The type of destination for the route.

                • TargetType (string) --

                  The type of target for the route.

                • Destination (string) --

                  The destination of the route.

                • Target (string) --

                  The route's target.

            • IsRouteTableUsedInDifferentAZ (boolean) --

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

            • CurrentFirewallSubnetRouteTable (string) --

              Information about the subnet route table for the current firewall.

            • ExpectedFirewallEndpoint (string) --

              The expected endpoint for the current firewall.

            • FirewallSubnetId (string) --

              The firewall subnet ID.

            • ExpectedFirewallSubnetRoutes (list) --

              The firewall subnet routes that are expected.

              • (dict) --

                Information about the expected route in the route table.

                • IpV4Cidr (string) --

                  Information about the IPv4 CIDR block.

                • PrefixListId (string) --

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

                • IpV6Cidr (string) --

                  Information about the IPv6 CIDR block.

                • ContributingSubnets (list) --

                  Information about the contributing subnets.

                  • (string) --
                • AllowedTargets (list) --

                  Information about the allowed targets.

                  • (string) --
                • RouteTableId (string) --

                  Information about the route table ID.

            • ActualFirewallSubnetRoutes (list) --

              The actual firewall subnet routes.

              • (dict) --

                Describes a route in a route table.

                • DestinationType (string) --

                  The type of destination for the route.

                • TargetType (string) --

                  The type of target for the route.

                • Destination (string) --

                  The destination of the route.

                • Target (string) --

                  The route's target.

            • InternetGatewayId (string) --

              The internet gateway ID.

            • CurrentInternetGatewayRouteTable (string) --

              The current route table for the internet gateway.

            • ExpectedInternetGatewayRoutes (list) --

              The internet gateway routes that are expected.

              • (dict) --

                Information about the expected route in the route table.

                • IpV4Cidr (string) --

                  Information about the IPv4 CIDR block.

                • PrefixListId (string) --

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

                • IpV6Cidr (string) --

                  Information about the IPv6 CIDR block.

                • ContributingSubnets (list) --

                  Information about the contributing subnets.

                  • (string) --
                • AllowedTargets (list) --

                  Information about the allowed targets.

                  • (string) --
                • RouteTableId (string) --

                  Information about the route table ID.

            • ActualInternetGatewayRoutes (list) --

              The actual internet gateway routes.

              • (dict) --

                Describes a route in a route table.

                • DestinationType (string) --

                  The type of destination for the route.

                • TargetType (string) --

                  The type of target for the route.

                • Destination (string) --

                  The destination of the route.

                • Target (string) --

                  The route's target.

            • VpcId (string) --

              Information about the VPC ID.

          • NetworkFirewallInvalidRouteConfigurationViolation (dict) --

            The route configuration is invalid.

            • AffectedSubnets (list) --

              The subnets that are affected.

              • (string) --
            • RouteTableId (string) --

              The route table ID.

            • IsRouteTableUsedInDifferentAZ (boolean) --

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

            • ViolatingRoute (dict) --

              The route that's in violation.

              • DestinationType (string) --

                The type of destination for the route.

              • TargetType (string) --

                The type of target for the route.

              • Destination (string) --

                The destination of the route.

              • Target (string) --

                The route's target.

            • CurrentFirewallSubnetRouteTable (string) --

              The subnet route table for the current firewall.

            • ExpectedFirewallEndpoint (string) --

              The firewall endpoint that's expected.

            • ActualFirewallEndpoint (string) --

              The actual firewall endpoint.

            • ExpectedFirewallSubnetId (string) --

              The expected subnet ID for the firewall.

            • ActualFirewallSubnetId (string) --

              The actual subnet ID for the firewall.

            • ExpectedFirewallSubnetRoutes (list) --

              The firewall subnet routes that are expected.

              • (dict) --

                Information about the expected route in the route table.

                • IpV4Cidr (string) --

                  Information about the IPv4 CIDR block.

                • PrefixListId (string) --

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

                • IpV6Cidr (string) --

                  Information about the IPv6 CIDR block.

                • ContributingSubnets (list) --

                  Information about the contributing subnets.

                  • (string) --
                • AllowedTargets (list) --

                  Information about the allowed targets.

                  • (string) --
                • RouteTableId (string) --

                  Information about the route table ID.

            • ActualFirewallSubnetRoutes (list) --

              The actual firewall subnet routes that are expected.

              • (dict) --

                Describes a route in a route table.

                • DestinationType (string) --

                  The type of destination for the route.

                • TargetType (string) --

                  The type of target for the route.

                • Destination (string) --

                  The destination of the route.

                • Target (string) --

                  The route's target.

            • InternetGatewayId (string) --

              The internet gateway ID.

            • CurrentInternetGatewayRouteTable (string) --

              The route table for the current internet gateway.

            • ExpectedInternetGatewayRoutes (list) --

              The expected routes for the internet gateway.

              • (dict) --

                Information about the expected route in the route table.

                • IpV4Cidr (string) --

                  Information about the IPv4 CIDR block.

                • PrefixListId (string) --

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

                • IpV6Cidr (string) --

                  Information about the IPv6 CIDR block.

                • ContributingSubnets (list) --

                  Information about the contributing subnets.

                  • (string) --
                • AllowedTargets (list) --

                  Information about the allowed targets.

                  • (string) --
                • RouteTableId (string) --

                  Information about the route table ID.

            • ActualInternetGatewayRoutes (list) --

              The actual internet gateway routes.

              • (dict) --

                Describes a route in a route table.

                • DestinationType (string) --

                  The type of destination for the route.

                • TargetType (string) --

                  The type of target for the route.

                • Destination (string) --

                  The destination of the route.

                • Target (string) --

                  The route's target.

            • VpcId (string) --

              Information about the VPC ID.

          • NetworkFirewallBlackHoleRouteDetectedViolation (dict) --

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

            • ViolationTarget (string) --

              The subnet that has an inactive state.

            • RouteTableId (string) --

              Information about the route table ID.

            • VpcId (string) --

              Information about the VPC ID.

            • ViolatingRoutes (list) --

              Information about the route or routes that are in violation.

              • (dict) --

                Describes a route in a route table.

                • DestinationType (string) --

                  The type of destination for the route.

                • TargetType (string) --

                  The type of target for the route.

                • Destination (string) --

                  The destination of the route.

                • Target (string) --

                  The route's target.

          • NetworkFirewallUnexpectedFirewallRoutesViolation (dict) --

            There's an unexpected firewall route.

            • FirewallSubnetId (string) --

              The subnet ID for the firewall.

            • ViolatingRoutes (list) --

              The routes that are in violation.

              • (dict) --

                Describes a route in a route table.

                • DestinationType (string) --

                  The type of destination for the route.

                • TargetType (string) --

                  The type of target for the route.

                • Destination (string) --

                  The destination of the route.

                • Target (string) --

                  The route's target.

            • RouteTableId (string) --

              The ID of the route table.

            • FirewallEndpoint (string) --

              The endpoint of the firewall.

            • VpcId (string) --

              Information about the VPC ID.

          • NetworkFirewallUnexpectedGatewayRoutesViolation (dict) --

            There's an unexpected gateway route.

            • GatewayId (string) --

              Information about the gateway ID.

            • ViolatingRoutes (list) --

              The routes that are in violation.

              • (dict) --

                Describes a route in a route table.

                • DestinationType (string) --

                  The type of destination for the route.

                • TargetType (string) --

                  The type of target for the route.

                • Destination (string) --

                  The destination of the route.

                • Target (string) --

                  The route's target.

            • RouteTableId (string) --

              Information about the route table.

            • VpcId (string) --

              Information about the VPC ID.

          • NetworkFirewallMissingExpectedRoutesViolation (dict) --

            Expected routes are missing from Network Firewall.

            • ViolationTarget (string) --

              The target of the violation.

            • ExpectedRoutes (list) --

              The expected routes.

              • (dict) --

                Information about the expected route in the route table.

                • IpV4Cidr (string) --

                  Information about the IPv4 CIDR block.

                • PrefixListId (string) --

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

                • IpV6Cidr (string) --

                  Information about the IPv6 CIDR block.

                • ContributingSubnets (list) --

                  Information about the contributing subnets.

                  • (string) --
                • AllowedTargets (list) --

                  Information about the allowed targets.

                  • (string) --
                • RouteTableId (string) --

                  Information about the route table ID.

            • VpcId (string) --

              Information about the VPC ID.

          • DnsRuleGroupPriorityConflictViolation (dict) --

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

            • ViolationTarget (string) --

              Information about the VPC ID.

            • ViolationTargetDescription (string) --

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

            • ConflictingPriority (integer) --

              The priority setting of the two conflicting rule groups.

            • ConflictingPolicyId (string) --

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

            • UnavailablePriorities (list) --

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

              • (integer) --
          • DnsDuplicateRuleGroupViolation (dict) --

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

            • ViolationTarget (string) --

              Information about the VPC ID.

            • ViolationTargetDescription (string) --

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

          • DnsRuleGroupLimitExceededViolation (dict) --

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

            • ViolationTarget (string) --

              Information about the VPC ID.

            • ViolationTargetDescription (string) --

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

            • NumberOfRuleGroupsAlreadyAssociated (integer) --

              The number of rule groups currently associated with the VPC.

          • PossibleRemediationActions (dict) --

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

            • Description (string) --

              A description of the possible remediation actions list.

            • Actions (list) --

              Information about the actions.

              • (dict) --

                A list of remediation actions.

                • Description (string) --

                  A description of the list of remediation actions.

                • OrderedRemediationActions (list) --

                  The ordered list of remediation actions.

                  • (dict) --

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

                    • RemediationAction (dict) --

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

                      • Description (string) --

                        A description of a remediation action.

                      • EC2CreateRouteAction (dict) --

                        Information about the CreateRoute action in the Amazon EC2 API.

                        • Description (string) --

                          A description of CreateRoute action in Amazon EC2.

                        • DestinationCidrBlock (string) --

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

                        • DestinationPrefixListId (string) --

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

                        • DestinationIpv6CidrBlock (string) --

                          Information about the IPv6 CIDR block destination.

                        • VpcEndpointId (dict) --

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

                          • ResourceId (string) --

                            The ID of the remediation target.

                          • Description (string) --

                            A description of the remediation action target.

                        • GatewayId (dict) --

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

                          • ResourceId (string) --

                            The ID of the remediation target.

                          • Description (string) --

                            A description of the remediation action target.

                        • RouteTableId (dict) --

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

                          • ResourceId (string) --

                            The ID of the remediation target.

                          • Description (string) --

                            A description of the remediation action target.

                      • EC2ReplaceRouteAction (dict) --

                        Information about the ReplaceRoute action in the Amazon EC2 API.

                        • Description (string) --

                          A description of the ReplaceRoute action in Amazon EC2.

                        • DestinationCidrBlock (string) --

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

                        • DestinationPrefixListId (string) --

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

                        • DestinationIpv6CidrBlock (string) --

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

                        • GatewayId (dict) --

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

                          • ResourceId (string) --

                            The ID of the remediation target.

                          • Description (string) --

                            A description of the remediation action target.

                        • RouteTableId (dict) --

                          Information about the ID of the route table.

                          • ResourceId (string) --

                            The ID of the remediation target.

                          • Description (string) --

                            A description of the remediation action target.

                      • EC2DeleteRouteAction (dict) --

                        Information about the DeleteRoute action in the Amazon EC2 API.

                        • Description (string) --

                          A description of the DeleteRoute action.

                        • DestinationCidrBlock (string) --

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

                        • DestinationPrefixListId (string) --

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

                        • DestinationIpv6CidrBlock (string) --

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

                        • RouteTableId (dict) --

                          Information about the ID of the route table.

                          • ResourceId (string) --

                            The ID of the remediation target.

                          • Description (string) --

                            A description of the remediation action target.

                      • EC2CopyRouteTableAction (dict) --

                        Information about the CopyRouteTable action in the Amazon EC2 API.

                        • Description (string) --

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

                        • VpcId (dict) --

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

                          • ResourceId (string) --

                            The ID of the remediation target.

                          • Description (string) --

                            A description of the remediation action target.

                        • RouteTableId (dict) --

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

                          • ResourceId (string) --

                            The ID of the remediation target.

                          • Description (string) --

                            A description of the remediation action target.

                      • EC2ReplaceRouteTableAssociationAction (dict) --

                        Information about the ReplaceRouteTableAssociation action in the Amazon EC2 API.

                        • Description (string) --

                          A description of the ReplaceRouteTableAssociation action in Amazon EC2.

                        • AssociationId (dict) --

                          Information about the association ID.

                          • ResourceId (string) --

                            The ID of the remediation target.

                          • Description (string) --

                            A description of the remediation action target.

                        • RouteTableId (dict) --

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

                          • ResourceId (string) --

                            The ID of the remediation target.

                          • Description (string) --

                            A description of the remediation action target.

                      • EC2AssociateRouteTableAction (dict) --

                        Information about the AssociateRouteTable action in the Amazon EC2 API.

                        • Description (string) --

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

                        • RouteTableId (dict) --

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

                          • ResourceId (string) --

                            The ID of the remediation target.

                          • Description (string) --

                            A description of the remediation action target.

                        • SubnetId (dict) --

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

                          • ResourceId (string) --

                            The ID of the remediation target.

                          • Description (string) --

                            A description of the remediation action target.

                        • GatewayId (dict) --

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

                          • ResourceId (string) --

                            The ID of the remediation target.

                          • Description (string) --

                            A description of the remediation action target.

                      • EC2CreateRouteTableAction (dict) --

                        Information about the CreateRouteTable action in the Amazon EC2 API.

                        • Description (string) --

                          A description of the CreateRouteTable action.

                        • VpcId (dict) --

                          Information about the ID of a VPC.

                          • ResourceId (string) --

                            The ID of the remediation target.

                          • Description (string) --

                            A description of the remediation action target.

                    • Order (integer) --

                      The order of the remediation actions in the list.

                • IsDefaultAction (boolean) --

                  Information about whether an action is taken by default.

      • ResourceTags (list) --

        The ResourceTag objects associated with the resource.

        • (dict) --

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

          • 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

  • FMS.Client.exceptions.ResourceNotFoundException
  • FMS.Client.exceptions.InvalidInputException
  • FMS.Client.exceptions.InternalErrorException
get_waiter(waiter_name)

Returns an object that can wait for some condition.

Parameters
waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
Returns
The specified waiter object.
Return type
botocore.waiter.Waiter
list_apps_lists(**kwargs)

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
)
Parameters
  • DefaultLists (boolean) -- Specifies whether the lists to retrieve are default lists owned by Firewall Manager.
  • NextToken (string) -- If you specify a value for MaxResults in your list request, and you have more objects than the maximum, Firewall Manager returns this token in the response. For all but the first request, you provide the token returned by the prior request in the request parameters, to retrieve the next batch of objects.
  • MaxResults (integer) --

    [REQUIRED]

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

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

Return type

dict

Returns

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 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 Firewall Manager applications list.

          • (dict) --

            An individual 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, Firewall Manager returns this token in the response. You can use this token in subsequent requests to retrieve the next batch of objects.

Exceptions

  • FMS.Client.exceptions.ResourceNotFoundException
  • FMS.Client.exceptions.InvalidOperationException
  • FMS.Client.exceptions.LimitExceededException
  • FMS.Client.exceptions.InternalErrorException
list_compliance_status(**kwargs)

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
)
Parameters
  • PolicyId (string) --

    [REQUIRED]

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

  • NextToken (string) -- If you specify a value for MaxResults and you have more PolicyComplianceStatus objects than the number that you specify for MaxResults , Firewall Manager returns a NextToken value in the response that allows you to list another group of PolicyComplianceStatus objects. For the second and subsequent ListComplianceStatus requests, specify the value of NextToken from the previous response to get information about another batch of PolicyComplianceStatus objects.
  • MaxResults (integer) -- Specifies the number of PolicyComplianceStatus objects that you want Firewall Manager to return for this request. If you have more PolicyComplianceStatus objects than the number that you specify for MaxResults , the response includes a NextToken value that you can use to get another batch of PolicyComplianceStatus objects.
Return type

dict

Returns

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 WAF and Shield Advanced policies, or that are noncompliant with the policy, for security group policies.

        • PolicyOwner (string) --

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

        • PolicyId (string) --

          The ID of the Firewall Manager policy.

        • PolicyName (string) --

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

            • ViolatorCount (integer) --

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

            • EvaluationLimitExceeded (boolean) --

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

        • LastUpdated (datetime) --

          Timestamp of the last update to the EvaluationResult objects.

        • IssueInfoMap (dict) --

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

          • (string) --
            • (string) --
    • 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

  • FMS.Client.exceptions.ResourceNotFoundException
  • FMS.Client.exceptions.InternalErrorException
list_member_accounts(**kwargs)

Returns a MemberAccounts object that lists the member accounts in the administrator's Amazon Web Services organization.

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

See also: AWS API Documentation

Request Syntax

response = client.list_member_accounts(
    NextToken='string',
    MaxResults=123
)
Parameters
  • NextToken (string) -- If you specify a value for MaxResults and you have more account IDs than the number that you specify for MaxResults , Firewall Manager returns a NextToken value in the response that allows you to list another group of IDs. For the second and subsequent ListMemberAccountsRequest requests, specify the value of NextToken from the previous response to get information about another batch of member account IDs.
  • MaxResults (integer) -- Specifies the number of member account IDs that you want Firewall Manager to return for this request. If you have more IDs than the number that you specify for MaxResults , the response includes a NextToken value that you can use to get another batch of member account IDs.
Return type

dict

Returns

Response Syntax

{
    'MemberAccounts': [
        'string',
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • MemberAccounts (list) --

      An array of account IDs.

      • (string) --
    • 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

  • FMS.Client.exceptions.ResourceNotFoundException
  • FMS.Client.exceptions.InternalErrorException
list_policies(**kwargs)

Returns an array of PolicySummary objects.

See also: AWS API Documentation

Request Syntax

response = client.list_policies(
    NextToken='string',
    MaxResults=123
)
Parameters
  • NextToken (string) -- If you specify a value for MaxResults and you have more PolicySummary objects than the number that you specify for MaxResults , Firewall Manager returns a NextToken value in the response that allows you to list another group of PolicySummary objects. For the second and subsequent ListPolicies requests, specify the value of NextToken from the previous response to get information about another batch of PolicySummary objects.
  • MaxResults (integer) -- Specifies the number of PolicySummary objects that you want Firewall Manager to return for this request. If you have more PolicySummary objects than the number that you specify for MaxResults , the response includes a NextToken value that you can use to get another batch of PolicySummary objects.
Return type

dict

Returns

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'|'DNS_FIREWALL',
            'RemediationEnabled': True|False,
            'DeleteUnusedFMManagedResources': True|False
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • PolicyList (list) --

      An array of PolicySummary objects.

      • (dict) --

        Details of the 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 Amazon Web Services Resource Types Reference . For 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 Network Firewall policy or DNS 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 WAF policy, a Shield Advanced policy, or a security group policy.

        • RemediationEnabled (boolean) --

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

        • DeleteUnusedFMManagedResources (boolean) --

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

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

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

    • 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

  • FMS.Client.exceptions.ResourceNotFoundException
  • FMS.Client.exceptions.InvalidOperationException
  • FMS.Client.exceptions.LimitExceededException
  • FMS.Client.exceptions.InternalErrorException
list_protocols_lists(**kwargs)

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
)
Parameters
  • DefaultLists (boolean) -- Specifies whether the lists to retrieve are default lists owned by Firewall Manager.
  • NextToken (string) -- If you specify a value for MaxResults in your list request, and you have more objects than the maximum, Firewall Manager returns this token in the response. For all but the first request, you provide the token returned by the prior request in the request parameters, to retrieve the next batch of objects.
  • MaxResults (integer) --

    [REQUIRED]

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

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

Return type

dict

Returns

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 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 Firewall Manager protocols list.

          • (string) --
    • NextToken (string) --

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

Exceptions

  • FMS.Client.exceptions.ResourceNotFoundException
  • FMS.Client.exceptions.InvalidOperationException
  • FMS.Client.exceptions.InternalErrorException
list_tags_for_resource(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.list_tags_for_resource(
    ResourceArn='string'
)
Parameters
ResourceArn (string) --

[REQUIRED]

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

Return type
dict
Returns
Response Syntax
{
    'TagList': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
}

Response Structure

  • (dict) --
    • TagList (list) --

      The tags associated with the resource.

      • (dict) --

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

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

Exceptions

  • FMS.Client.exceptions.ResourceNotFoundException
  • FMS.Client.exceptions.InvalidOperationException
  • FMS.Client.exceptions.InternalErrorException
  • FMS.Client.exceptions.InvalidInputException
put_apps_list(**kwargs)

Creates an 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'
        },
    ]
)
Parameters
  • AppsList (dict) --

    [REQUIRED]

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

    • ListId (string) --

      The ID of the Firewall Manager applications list.

    • ListName (string) -- [REQUIRED]

      The name of the 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 Firewall Manager applications list was created.

    • LastUpdateTime (datetime) --

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

    • AppsList (list) -- [REQUIRED]

      An array of applications in the Firewall Manager applications list.

      • (dict) --

        An individual Firewall Manager application.

        • AppName (string) -- [REQUIRED]

          The application's name.

        • Protocol (string) -- [REQUIRED]

          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) -- [REQUIRED]

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

            • AppName (string) -- [REQUIRED]

              The application's name.

            • Protocol (string) -- [REQUIRED]

              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) -- [REQUIRED]

              The application's port number, for example 80 .

  • TagList (list) --

    The tags associated with the resource.

    • (dict) --

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

      • Key (string) -- [REQUIRED]

        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) -- [REQUIRED]

        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.

Return type

dict

Returns

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 Firewall Manager applications list.

      • ListId (string) --

        The ID of the Firewall Manager applications list.

      • ListName (string) --

        The name of the 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 Firewall Manager applications list was created.

      • LastUpdateTime (datetime) --

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

      • AppsList (list) --

        An array of applications in the Firewall Manager applications list.

        • (dict) --

          An individual 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 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

  • FMS.Client.exceptions.ResourceNotFoundException
  • FMS.Client.exceptions.InvalidOperationException
  • FMS.Client.exceptions.InvalidInputException
  • FMS.Client.exceptions.LimitExceededException
  • FMS.Client.exceptions.InternalErrorException
put_notification_channel(**kwargs)

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

To perform this action outside of the console, you must 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 Firewall Manager Developer Guide .

See also: AWS API Documentation

Request Syntax

response = client.put_notification_channel(
    SnsTopicArn='string',
    SnsRoleName='string'
)
Parameters
  • SnsTopicArn (string) --

    [REQUIRED]

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

  • SnsRoleName (string) --

    [REQUIRED]

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

Returns

None

Exceptions

  • FMS.Client.exceptions.ResourceNotFoundException
  • FMS.Client.exceptions.InvalidOperationException
  • FMS.Client.exceptions.InternalErrorException
put_policy(**kwargs)

Creates an Firewall Manager policy.

Firewall Manager provides the following types of policies:

  • An WAF policy (type WAFV2), which defines rule groups to run first in the corresponding WAF web ACL and rule groups to run last in the web ACL.
  • An 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 Amazon Web Services organization.
  • An Network Firewall policy, which provides firewall rules to filter network traffic in specified Amazon VPCs.
  • A DNS Firewall policy, which provides Route 53 Resolver DNS Firewall rules to filter DNS queries for specified 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 .

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'|'DNS_FIREWALL',
            'ManagedServiceData': 'string'
        },
        'ResourceType': 'string',
        'ResourceTypeList': [
            'string',
        ],
        'ResourceTags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'ExcludeResourceTags': True|False,
        'RemediationEnabled': True|False,
        'DeleteUnusedFMManagedResources': True|False,
        'IncludeMap': {
            'string': [
                'string',
            ]
        },
        'ExcludeMap': {
            'string': [
                'string',
            ]
        }
    },
    TagList=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters
  • Policy (dict) --

    [REQUIRED]

    The details of the Firewall Manager policy to be created.

    • PolicyId (string) --

      The ID of the Firewall Manager policy.

    • PolicyName (string) -- [REQUIRED]

      The name of the 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) -- [REQUIRED]

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

      • Type (string) -- [REQUIRED]

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

      • ManagedServiceData (string) --

        Details about the service that are specific to the service type, in JSON format.

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

        Note

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

        • 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\"]} }"
        • Specification for SHIELD_ADVANCED for Amazon CloudFront distributions "{\"type\":\"SHIELD_ADVANCED\",\"automaticResponseConfiguration\": {\"automaticResponseStatus\":\"ENABLED|IGNORED|DISABLED\", \"automaticResponseAction\":\"BLOCK|COUNT\"}, \"overrideCustomerWebaclClassic\":true|false}" For example: "{\"type\":\"SHIELD_ADVANCED\",\"automaticResponseConfiguration\": {\"automaticResponseStatus\":\"ENABLED\", \"automaticResponseAction\":\"COUNT\"}}" The default value for automaticResponseStatus is IGNORED . The value for automaticResponseAction is only required when automaticResponseStatus is set to ENABLED . The default value for overrideCustomerWebaclClassic is false . For other resource types that you can protect with a Shield Advanced policy, this ManagedServiceData configuration is an empty string.
        • Example: WAFV2 "{\"type\":\"WAFV2\",\"preProcessRuleGroups\":[{\"ruleGroupArn\":null,\"overrideAction\":{\"type\":\"NONE\"},\"managedRuleGroupIdentifier\":{\"version\":null,\"vendorName\":\"AWS\",\"managedRuleGroupName\":\"AWSManagedRulesAmazonIpReputationList\"},\"ruleGroupType\":\"ManagedRuleGroup\",\"excludeRules\":[{\"name\":\"NoUserAgent_HEADER\"}]}],\"postProcessRuleGroups\":[],\"defaultAction\":{\"type\":\"ALLOW\"},\"overrideCustomerWebACLAssociation\":false,\"loggingConfiguration\":{\"logDestinationConfigs\":[\"arn:aws:firehose:us-west-2:12345678912:deliverystream/aws-waf-logs-fms-admin-destination\"],\"redactedFields\":[{\"redactedFieldType\":\"SingleHeader\",\"redactedFieldValue\":\"Cookies\"},{\"redactedFieldType\":\"Method\"}]}}" In the loggingConfiguration , you can specify one logDestinationConfigs , you can optionally provide up to 20 redactedFields , and the RedactedFieldType must be one of URI , QUERY_STRING , HEADER , or METHOD .
        • Example: WAF Classic "{\"type\": \"WAF\", \"ruleGroups\": [{\"id\":\"12345678-1bcd-9012-efga-0987654321ab\", \"overrideAction\" : {\"type\": \"COUNT\"}}], \"defaultAction\": {\"type\": \"BLOCK\"}}"
        • Example: SECURITY_GROUPS_COMMON "{\"type\":\"SECURITY_GROUPS_COMMON\",\"revertManualSecurityGroupChanges\":false,\"exclusiveResourceSecurityGroupManagement\":false, \"applyToAllEC2InstanceENIs\":false,\"securityGroups\":[{\"id\":\" sg-000e55995d61a06bd\"}]}"
        • Example: Shared VPCs. Apply the preceding policy to resources in shared VPCs as well as to those in VPCs that the account owns "{\"type\":\"SECURITY_GROUPS_COMMON\",\"revertManualSecurityGroupChanges\":false,\"exclusiveResourceSecurityGroupManagement\":false, \"applyToAllEC2InstanceENIs\":false,\"includeSharedVPC\":true,\"securityGroups\":[{\"id\":\" sg-000e55995d61a06bd\"}]}"
        • Example: SECURITY_GROUPS_CONTENT_AUDIT "{\"type\":\"SECURITY_GROUPS_CONTENT_AUDIT\",\"securityGroups\":[{\"id\":\"sg-000e55995d61a06bd\"}],\"securityGroupAction\":{\"type\":\"ALLOW\"}}" The security group action for content audit can be ALLOW or DENY . For ALLOW , all in-scope security group rules must be within the allowed range of the policy's security group rules. For DENY , all in-scope security group rules must not contain a value or a range that matches a rule value or range in the policy security group.
        • Example: SECURITY_GROUPS_USAGE_AUDIT "{\"type\":\"SECURITY_GROUPS_USAGE_AUDIT\",\"deleteUnusedSecurityGroups\":true,\"coalesceRedundantSecurityGroups\":true}"
    • ResourceType (string) -- [REQUIRED]

      The type of resource protected by or in scope of the policy. This is in the format shown in the Amazon Web Services Resource Types Reference . To apply this policy to multiple resource types, specify a resource type of ResourceTypeList and then specify the resource types in a ResourceTypeList .

      For WAF and Shield Advanced, resource types include AWS::ElasticLoadBalancingV2::LoadBalancer , AWS::ElasticLoadBalancing::LoadBalancer , AWS::EC2::EIP , 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 Network Firewall policy or DNS Firewall policy, the value is AWS::EC2::VPC .

    • ResourceTypeList (list) --

      An array of ResourceType objects. Use this only to specify multiple resource types. To specify a single resource type, use ResourceType .

      • (string) --
    • ResourceTags (list) --

      An array of ResourceTag objects.

      • (dict) --

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

        • Key (string) -- [REQUIRED]

          The resource tag key.

        • Value (string) --

          The resource tag value.

    • ExcludeResourceTags (boolean) -- [REQUIRED]

      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) -- [REQUIRED]

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

    • DeleteUnusedFMManagedResources (boolean) --

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

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

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

    • IncludeMap (dict) --

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

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

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

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

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

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

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

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

    The tags to add to the Amazon Web Services resource.

    • (dict) --

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

      • Key (string) -- [REQUIRED]

        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) -- [REQUIRED]

        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.

Return type

dict

Returns

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'|'DNS_FIREWALL',
            'ManagedServiceData': 'string'
        },
        'ResourceType': 'string',
        'ResourceTypeList': [
            'string',
        ],
        'ResourceTags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'ExcludeResourceTags': True|False,
        'RemediationEnabled': True|False,
        'DeleteUnusedFMManagedResources': True|False,
        'IncludeMap': {
            'string': [
                'string',
            ]
        },
        'ExcludeMap': {
            'string': [
                'string',
            ]
        }
    },
    'PolicyArn': 'string'
}

Response Structure

  • (dict) --

    • Policy (dict) --

      The details of the Firewall Manager policy.

      • PolicyId (string) --

        The ID of the Firewall Manager policy.

      • PolicyName (string) --

        The name of the 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 WAF policy, a Shield Advanced policy, or a security group policy. For security group policies, Firewall Manager supports one security group for each common policy and for each content audit policy. This is an adjustable limit that you can increase by contacting Amazon Web Services Support.

        • ManagedServiceData (string) --

          Details about the service that are specific to the service type, in JSON format.

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

          Note

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

          • 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\"]} }"
          • Specification for SHIELD_ADVANCED for Amazon CloudFront distributions "{\"type\":\"SHIELD_ADVANCED\",\"automaticResponseConfiguration\": {\"automaticResponseStatus\":\"ENABLED|IGNORED|DISABLED\", \"automaticResponseAction\":\"BLOCK|COUNT\"}, \"overrideCustomerWebaclClassic\":true|false}" For example: "{\"type\":\"SHIELD_ADVANCED\",\"automaticResponseConfiguration\": {\"automaticResponseStatus\":\"ENABLED\", \"automaticResponseAction\":\"COUNT\"}}" The default value for automaticResponseStatus is IGNORED . The value for automaticResponseAction is only required when automaticResponseStatus is set to ENABLED . The default value for overrideCustomerWebaclClassic is false . For other resource types that you can protect with a Shield Advanced policy, this ManagedServiceData configuration is an empty string.
          • Example: WAFV2 "{\"type\":\"WAFV2\",\"preProcessRuleGroups\":[{\"ruleGroupArn\":null,\"overrideAction\":{\"type\":\"NONE\"},\"managedRuleGroupIdentifier\":{\"version\":null,\"vendorName\":\"AWS\",\"managedRuleGroupName\":\"AWSManagedRulesAmazonIpReputationList\"},\"ruleGroupType\":\"ManagedRuleGroup\",\"excludeRules\":[{\"name\":\"NoUserAgent_HEADER\"}]}],\"postProcessRuleGroups\":[],\"defaultAction\":{\"type\":\"ALLOW\"},\"overrideCustomerWebACLAssociation\":false,\"loggingConfiguration\":{\"logDestinationConfigs\":[\"arn:aws:firehose:us-west-2:12345678912:deliverystream/aws-waf-logs-fms-admin-destination\"],\"redactedFields\":[{\"redactedFieldType\":\"SingleHeader\",\"redactedFieldValue\":\"Cookies\"},{\"redactedFieldType\":\"Method\"}]}}" In the loggingConfiguration , you can specify one logDestinationConfigs , you can optionally provide up to 20 redactedFields , and the RedactedFieldType must be one of URI , QUERY_STRING , HEADER , or METHOD .
          • Example: WAF Classic "{\"type\": \"WAF\", \"ruleGroups\": [{\"id\":\"12345678-1bcd-9012-efga-0987654321ab\", \"overrideAction\" : {\"type\": \"COUNT\"}}], \"defaultAction\": {\"type\": \"BLOCK\"}}"
          • Example: SECURITY_GROUPS_COMMON "{\"type\":\"SECURITY_GROUPS_COMMON\",\"revertManualSecurityGroupChanges\":false,\"exclusiveResourceSecurityGroupManagement\":false, \"applyToAllEC2InstanceENIs\":false,\"securityGroups\":[{\"id\":\" sg-000e55995d61a06bd\"}]}"
          • Example: Shared VPCs. Apply the preceding policy to resources in shared VPCs as well as to those in VPCs that the account owns "{\"type\":\"SECURITY_GROUPS_COMMON\",\"revertManualSecurityGroupChanges\":false,\"exclusiveResourceSecurityGroupManagement\":false, \"applyToAllEC2InstanceENIs\":false,\"includeSharedVPC\":true,\"securityGroups\":[{\"id\":\" sg-000e55995d61a06bd\"}]}"
          • Example: SECURITY_GROUPS_CONTENT_AUDIT "{\"type\":\"SECURITY_GROUPS_CONTENT_AUDIT\",\"securityGroups\":[{\"id\":\"sg-000e55995d61a06bd\"}],\"securityGroupAction\":{\"type\":\"ALLOW\"}}" The security group action for content audit can be ALLOW or DENY . For ALLOW , all in-scope security group rules must be within the allowed range of the policy's security group rules. For DENY , all in-scope security group rules must not contain a value or a range that matches a rule value or range in the policy security group.
          • Example: SECURITY_GROUPS_USAGE_AUDIT "{\"type\":\"SECURITY_GROUPS_USAGE_AUDIT\",\"deleteUnusedSecurityGroups\":true,\"coalesceRedundantSecurityGroups\":true}"
      • ResourceType (string) --

        The type of resource protected by or in scope of the policy. This is in the format shown in the Amazon Web Services Resource Types Reference . To apply this policy to multiple resource types, specify a resource type of ResourceTypeList and then specify the resource types in a ResourceTypeList .

        For WAF and Shield Advanced, resource types include AWS::ElasticLoadBalancingV2::LoadBalancer , AWS::ElasticLoadBalancing::LoadBalancer , AWS::EC2::EIP , 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 Network Firewall policy or DNS Firewall policy, the value is AWS::EC2::VPC .

      • ResourceTypeList (list) --

        An array of ResourceType objects. Use this only to specify multiple resource types. To specify a single resource type, use ResourceType .

        • (string) --
      • ResourceTags (list) --

        An array of ResourceTag objects.

        • (dict) --

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

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

      • DeleteUnusedFMManagedResources (boolean) --

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

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

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

      • IncludeMap (dict) --

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

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

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

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

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

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

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

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

      The Amazon Resource Name (ARN) of the policy.

Exceptions

  • FMS.Client.exceptions.ResourceNotFoundException
  • FMS.Client.exceptions.InvalidOperationException
  • FMS.Client.exceptions.InvalidInputException
  • FMS.Client.exceptions.LimitExceededException
  • FMS.Client.exceptions.InternalErrorException
  • FMS.Client.exceptions.InvalidTypeException
put_protocols_list(**kwargs)

Creates an 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'
        },
    ]
)
Parameters
  • ProtocolsList (dict) --

    [REQUIRED]

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

    • ListId (string) --

      The ID of the Firewall Manager protocols list.

    • ListName (string) -- [REQUIRED]

      The name of the 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 Firewall Manager protocols list was created.

    • LastUpdateTime (datetime) --

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

    • ProtocolsList (list) -- [REQUIRED]

      An array of protocols in the Firewall Manager protocols list.

      • (string) --
    • PreviousProtocolsList (dict) --

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

      • (string) --
        • (list) --
          • (string) --
  • TagList (list) --

    The tags associated with the resource.

    • (dict) --

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

      • Key (string) -- [REQUIRED]

        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) -- [REQUIRED]

        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.

Return type

dict

Returns

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 Firewall Manager protocols list.

      • ListId (string) --

        The ID of the Firewall Manager protocols list.

      • ListName (string) --

        The name of the 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 Firewall Manager protocols list was created.

      • LastUpdateTime (datetime) --

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

      • ProtocolsList (list) --

        An array of protocols in the Firewall Manager protocols list.

        • (string) --
      • PreviousProtocolsList (dict) --

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

        • (string) --
          • (list) --
            • (string) --
    • ProtocolsListArn (string) --

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

Exceptions

  • FMS.Client.exceptions.ResourceNotFoundException
  • FMS.Client.exceptions.InvalidOperationException
  • FMS.Client.exceptions.InvalidInputException
  • FMS.Client.exceptions.LimitExceededException
  • FMS.Client.exceptions.InternalErrorException
tag_resource(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.tag_resource(
    ResourceArn='string',
    TagList=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters
  • ResourceArn (string) --

    [REQUIRED]

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

  • TagList (list) --

    [REQUIRED]

    The tags to add to the resource.

    • (dict) --

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

      • Key (string) -- [REQUIRED]

        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) -- [REQUIRED]

        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.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • FMS.Client.exceptions.ResourceNotFoundException
  • FMS.Client.exceptions.InvalidOperationException
  • FMS.Client.exceptions.InternalErrorException
  • FMS.Client.exceptions.InvalidInputException
  • FMS.Client.exceptions.LimitExceededException
untag_resource(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.untag_resource(
    ResourceArn='string',
    TagKeys=[
        'string',
    ]
)
Parameters
  • ResourceArn (string) --

    [REQUIRED]

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

  • TagKeys (list) --

    [REQUIRED]

    The keys of the tags to remove from the resource.

    • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • FMS.Client.exceptions.ResourceNotFoundException
  • FMS.Client.exceptions.InvalidOperationException
  • FMS.Client.exceptions.InternalErrorException
  • FMS.Client.exceptions.InvalidInputException

Paginators

The available paginators are:

class FMS.Paginator.ListAppsLists
paginator = client.get_paginator('list_apps_lists')
paginate(**kwargs)

Creates an iterator that will paginate through responses from FMS.Client.list_apps_lists().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    DefaultLists=True|False,
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • DefaultLists (boolean) -- Specifies whether the lists to retrieve are default lists owned by Firewall Manager.
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      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.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'AppsLists': [
        {
            'ListArn': 'string',
            'ListId': 'string',
            'ListName': 'string',
            'AppsList': [
                {
                    'AppName': 'string',
                    'Protocol': 'string',
                    'Port': 123
                },
            ]
        },
    ],

}

Response Structure

  • (dict) --

    • AppsLists (list) --

      An array of AppsListDataSummary objects.

      • (dict) --

        Details of the 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 Firewall Manager applications list.

          • (dict) --

            An individual 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 .

class FMS.Paginator.ListComplianceStatus
paginator = client.get_paginator('list_compliance_status')
paginate(**kwargs)

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'
    }
)
Parameters
  • PolicyId (string) --

    [REQUIRED]

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

  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      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.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

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 WAF and Shield Advanced policies, or that are noncompliant with the policy, for security group policies.

        • PolicyOwner (string) --

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

        • PolicyId (string) --

          The ID of the Firewall Manager policy.

        • PolicyName (string) --

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

            • ViolatorCount (integer) --

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

            • EvaluationLimitExceeded (boolean) --

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

        • LastUpdated (datetime) --

          Timestamp of the last update to the EvaluationResult objects.

        • IssueInfoMap (dict) --

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

          • (string) --
            • (string) --

class FMS.Paginator.ListMemberAccounts
paginator = client.get_paginator('list_member_accounts')
paginate(**kwargs)

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'
    }
)
Parameters
PaginationConfig (dict) --

A dictionary that provides parameters to control pagination.

  • MaxItems (integer) --

    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.

  • PageSize (integer) --

    The size of each page.

  • StartingToken (string) --

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type
dict
Returns
Response Syntax
{
    'MemberAccounts': [
        'string',
    ],

}

Response Structure

  • (dict) --
    • MemberAccounts (list) --

      An array of account IDs.

      • (string) --
class FMS.Paginator.ListPolicies
paginator = client.get_paginator('list_policies')
paginate(**kwargs)

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'
    }
)
Parameters
PaginationConfig (dict) --

A dictionary that provides parameters to control pagination.

  • MaxItems (integer) --

    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.

  • PageSize (integer) --

    The size of each page.

  • StartingToken (string) --

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type
dict
Returns
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'|'DNS_FIREWALL',
            'RemediationEnabled': True|False,
            'DeleteUnusedFMManagedResources': True|False
        },
    ],

}

Response Structure

  • (dict) --
    • PolicyList (list) --

      An array of PolicySummary objects.

      • (dict) --

        Details of the 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 Amazon Web Services Resource Types Reference . For 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 Network Firewall policy or DNS 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 WAF policy, a Shield Advanced policy, or a security group policy.

        • RemediationEnabled (boolean) --

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

        • DeleteUnusedFMManagedResources (boolean) --

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

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

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

class FMS.Paginator.ListProtocolsLists
paginator = client.get_paginator('list_protocols_lists')
paginate(**kwargs)

Creates an iterator that will paginate through responses from FMS.Client.list_protocols_lists().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    DefaultLists=True|False,
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • DefaultLists (boolean) -- Specifies whether the lists to retrieve are default lists owned by Firewall Manager.
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      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.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'ProtocolsLists': [
        {
            'ListArn': 'string',
            'ListId': 'string',
            'ListName': 'string',
            'ProtocolsList': [
                'string',
            ]
        },
    ],

}

Response Structure

  • (dict) --

    • ProtocolsLists (list) --

      An array of ProtocolsListDataSummary objects.

      • (dict) --

        Details of the 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 Firewall Manager protocols list.

          • (string) --