NetworkFirewall / Client / describe_firewall_policy

describe_firewall_policy#

NetworkFirewall.Client.describe_firewall_policy(**kwargs)#

Returns the data objects for the specified firewall policy.

Request Syntax

response = client.describe_firewall_policy(
    FirewallPolicyName='string',
    FirewallPolicyArn='string'
)

Parameters:

FirewallPolicyName (string) –
The descriptive name of the firewall policy. You can’t change the name of a firewall policy after you create it.

You must specify the ARN or the name, and you can specify both.
FirewallPolicyArn (string) –
The Amazon Resource Name (ARN) of the firewall policy.

You must specify the ARN or the name, and you can specify both.

Return type:

dict

Returns:

Response Syntax

{
    'UpdateToken': 'string',
    'FirewallPolicyResponse': {
        'FirewallPolicyName': 'string',
        'FirewallPolicyArn': 'string',
        'FirewallPolicyId': 'string',
        'Description': 'string',
        'FirewallPolicyStatus': 'ACTIVE'|'DELETING'|'ERROR',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'ConsumedStatelessRuleCapacity': 123,
        'ConsumedStatefulRuleCapacity': 123,
        'NumberOfAssociations': 123,
        'EncryptionConfiguration': {
            'KeyId': 'string',
            'Type': 'CUSTOMER_KMS'|'AWS_OWNED_KMS_KEY'
        },
        'LastModifiedTime': datetime(2015, 1, 1)
    },
    'FirewallPolicy': {
        'StatelessRuleGroupReferences': [
            {
                'ResourceArn': 'string',
                'Priority': 123
            },
        ],
        'StatelessDefaultActions': [
            'string',
        ],
        'StatelessFragmentDefaultActions': [
            'string',
        ],
        'StatelessCustomActions': [
            {
                'ActionName': 'string',
                'ActionDefinition': {
                    'PublishMetricAction': {
                        'Dimensions': [
                            {
                                'Value': 'string'
                            },
                        ]
                    }
                }
            },
        ],
        'StatefulRuleGroupReferences': [
            {
                'ResourceArn': 'string',
                'Priority': 123,
                'Override': {
                    'Action': 'DROP_TO_ALERT'
                }
            },
        ],
        'StatefulDefaultActions': [
            'string',
        ],
        'StatefulEngineOptions': {
            'RuleOrder': 'DEFAULT_ACTION_ORDER'|'STRICT_ORDER',
            'StreamExceptionPolicy': 'DROP'|'CONTINUE'|'REJECT',
            'FlowTimeouts': {
                'TcpIdleTimeoutSeconds': 123
            }
        },
        'TLSInspectionConfigurationArn': 'string',
        'PolicyVariables': {
            'RuleVariables': {
                'string': {
                    'Definition': [
                        'string',
                    ]
                }
            }
        }
    }
}

Response Structure

(dict) –
- UpdateToken (string) –
  
  A token used for optimistic locking. Network Firewall returns a token to your requests that access the firewall policy. The token marks the state of the policy resource at the time of the request.
  
  To make changes to the policy, you provide the token in your request. Network Firewall uses the token to ensure that the policy hasn’t changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall policy again to get a current copy of it with current token. Reapply your changes as needed, then try the operation again using the new token.
- FirewallPolicyResponse (dict) –
  
  The high-level properties of a firewall policy. This, along with the FirewallPolicy, define the policy. You can retrieve all objects for a firewall policy by calling DescribeFirewallPolicy.
  - FirewallPolicyName (string) –
    
    The descriptive name of the firewall policy. You can’t change the name of a firewall policy after you create it.
  - FirewallPolicyArn (string) –
    
    The Amazon Resource Name (ARN) of the firewall policy.
    
    Note
    If this response is for a create request that had DryRun set to TRUE, then this ARN is a placeholder that isn’t attached to a valid resource.
  - FirewallPolicyId (string) –
    
    The unique identifier for the firewall policy.
  - Description (string) –
    
    A description of the firewall policy.
  - FirewallPolicyStatus (string) –
    
    The current status of the firewall policy. You can retrieve this for a firewall policy by calling DescribeFirewallPolicy and providing the firewall policy’s name or ARN.
  - Tags (list) –
    
    The key:value pairs to associate with the resource.
    - (dict) –
      
      A key:value pair 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) –
        
        The 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) –
        
        The 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.
  - ConsumedStatelessRuleCapacity (integer) –
    
    The number of capacity units currently consumed by the policy’s stateless rules.
  - ConsumedStatefulRuleCapacity (integer) –
    
    The number of capacity units currently consumed by the policy’s stateful rules.
  - NumberOfAssociations (integer) –
    
    The number of firewalls that are associated with this firewall policy.
  - EncryptionConfiguration (dict) –
    
    A complex type that contains the Amazon Web Services KMS encryption configuration settings for your firewall policy.
    - KeyId (string) –
      
      The ID of the Amazon Web Services Key Management Service (KMS) customer managed key. You can use any of the key identifiers that KMS supports, unless you’re using a key that’s managed by another account. If you’re using a key managed by another account, then specify the key ARN. For more information, see Key ID in the Amazon Web Services KMS Developer Guide.
    - Type (string) –
      
      The type of Amazon Web Services KMS key to use for encryption of your Network Firewall resources.
  - LastModifiedTime (datetime) –
    
    The last time that the firewall policy was changed.
- FirewallPolicy (dict) –
  
  The policy for the specified firewall policy.
  - StatelessRuleGroupReferences (list) –
    
    References to the stateless rule groups that are used in the policy. These define the matching criteria in stateless rules.
    - (dict) –
      
      Identifier for a single stateless rule group, used in a firewall policy to refer to the rule group.
      - ResourceArn (string) –
        
        The Amazon Resource Name (ARN) of the stateless rule group.
      - Priority (integer) –
        
        An integer setting that indicates the order in which to run the stateless rule groups in a single FirewallPolicy. Network Firewall applies each stateless rule group to a packet starting with the group that has the lowest priority setting. You must ensure that the priority settings are unique within each policy.
  - StatelessDefaultActions (list) –
    
    The actions to take on a packet if it doesn’t match any of the stateless rules in the policy. If you want non-matching packets to be forwarded for stateful inspection, specify aws:forward_to_sfe.
    
    You must specify one of the standard actions: aws:pass, aws:drop, or aws:forward_to_sfe. In addition, you can specify custom actions that are compatible with your standard section choice.
    
    For example, you could specify ["aws:pass"] or you could specify ["aws:pass", “customActionName”]. For information about compatibility, see the custom action descriptions under CustomAction.
    - (string) –
  - StatelessFragmentDefaultActions (list) –
    
    The actions to take on a fragmented UDP packet if it doesn’t match any of the stateless rules in the policy. Network Firewall only manages UDP packet fragments and silently drops packet fragments for other protocols. If you want non-matching fragmented UDP packets to be forwarded for stateful inspection, specify aws:forward_to_sfe.
    
    You must specify one of the standard actions: aws:pass, aws:drop, or aws:forward_to_sfe. In addition, you can specify custom actions that are compatible with your standard section choice.
    
    For example, you could specify ["aws:pass"] or you could specify ["aws:pass", “customActionName”]. For information about compatibility, see the custom action descriptions under CustomAction.
    - (string) –
  - StatelessCustomActions (list) –
    
    The custom action definitions that are available for use in the firewall policy’s StatelessDefaultActions setting. You name each custom action that you define, and then you can use it by name in your default actions specifications.
    - (dict) –
      
      An optional, non-standard action to use for stateless packet handling. You can define this in addition to the standard action that you must specify.
      
      You define and name the custom actions that you want to be able to use, and then you reference them by name in your actions settings.
      
      You can use custom actions in the following places:
      - In a rule group’s StatelessRulesAndCustomActions specification. The custom actions are available for use by name inside the StatelessRulesAndCustomActions where you define them. You can use them for your stateless rule actions to specify what to do with a packet that matches the rule’s match attributes.
      - In a FirewallPolicy specification, in StatelessCustomActions. The custom actions are available for use inside the policy where you define them. You can use them for the policy’s default stateless actions settings to specify what to do with packets that don’t match any of the policy’s stateless rules.
      - ActionName (string) –
        
        The descriptive name of the custom action. You can’t change the name of a custom action after you create it.
      - ActionDefinition (dict) –
        
        The custom action associated with the action name.
        
        PublishMetricAction (dict) –
        
        Stateless inspection criteria that publishes the specified metrics to Amazon CloudWatch for the matching packet. This setting defines a CloudWatch dimension value to be published.
        
        You can pair this custom action with any of the standard stateless rule actions. For example, you could pair this in a rule action with the standard action that forwards the packet for stateful inspection. Then, when a packet matches the rule, Network Firewall publishes metrics for the packet and forwards it.
        
        Dimensions (list) –
        
        (dict) –
        
        The value to use in an Amazon CloudWatch custom metric dimension. This is used in the PublishMetrics CustomAction. A CloudWatch custom metric dimension is a name/value pair that’s part of the identity of a metric.
        
        Network Firewall sets the dimension name to CustomAction and you provide the dimension value.
        
        For more information about CloudWatch custom metric dimensions, see Publishing Custom Metrics in the Amazon CloudWatch User Guide.
        
        Value (string) –
        
        The value to use in the custom metric dimension.
  - StatefulRuleGroupReferences (list) –
    
    References to the stateful rule groups that are used in the policy. These define the inspection criteria in stateful rules.
    - (dict) –
      
      Identifier for a single stateful rule group, used in a firewall policy to refer to a rule group.
      - ResourceArn (string) –
        
        The Amazon Resource Name (ARN) of the stateful rule group.
      - Priority (integer) –
        
        An integer setting that indicates the order in which to run the stateful rule groups in a single FirewallPolicy. This setting only applies to firewall policies that specify the STRICT_ORDER rule order in the stateful engine options settings.
        
        Network Firewall evalutes each stateful rule group against a packet starting with the group that has the lowest priority setting. You must ensure that the priority settings are unique within each policy.
        
        You can change the priority settings of your rule groups at any time. To make it easier to insert rule groups later, number them so there’s a wide range in between, for example use 100, 200, and so on.
      - Override (dict) –
        
        The action that allows the policy owner to override the behavior of the rule group within a policy.
        
        Action (string) –
        
        The action that changes the rule group from DROP to ALERT. This only applies to managed rule groups.
  - StatefulDefaultActions (list) –
    
    The default actions to take on a packet that doesn’t match any stateful rules. The stateful default action is optional, and is only valid when using the strict rule order.
    
    Valid values of the stateful default action:
    - aws:drop_strict
    - aws:drop_established
    - aws:alert_strict
    - aws:alert_established
    For more information, see Strict evaluation order in the Network Firewall Developer Guide.
    - (string) –
  - StatefulEngineOptions (dict) –
    
    Additional options governing how Network Firewall handles stateful rules. The stateful rule groups that you use in your policy must have stateful rule options settings that are compatible with these settings.
    - RuleOrder (string) –
      
      Indicates how to manage the order of stateful rule evaluation for the policy. STRICT_ORDER is the default and recommended option. With STRICT_ORDER, provide your rules in the order that you want them to be evaluated. You can then choose one or more default actions for packets that don’t match any rules. Choose STRICT_ORDER to have the stateful rules engine determine the evaluation order of your rules. The default action for this rule order is PASS, followed by DROP, REJECT, and ALERT actions. Stateful rules are provided to the rule engine as Suricata compatible strings, and Suricata evaluates them based on your settings. For more information, see Evaluation order for stateful rules in the Network Firewall Developer Guide.
    - StreamExceptionPolicy (string) –
      
      Configures how Network Firewall processes traffic when a network connection breaks midstream. Network connections can break due to disruptions in external networks or within the firewall itself.
      - DROP - Network Firewall fails closed and drops all subsequent traffic going to the firewall. This is the default behavior.
      - CONTINUE - Network Firewall continues to apply rules to the subsequent traffic without context from traffic before the break. This impacts the behavior of rules that depend on this context. For example, if you have a stateful rule to drop http traffic, Network Firewall won’t match the traffic for this rule because the service won’t have the context from session initialization defining the application layer protocol as HTTP. However, this behavior is rule dependent—a TCP-layer rule using a flow:stateless rule would still match, as would the aws:drop_strict default action.
      - REJECT - Network Firewall fails closed and drops all subsequent traffic going to the firewall. Network Firewall also sends a TCP reject packet back to your client so that the client can immediately establish a new session. Network Firewall will have context about the new session and will apply rules to the subsequent traffic.
    - FlowTimeouts (dict) –
      
      Configures the amount of time that can pass without any traffic sent through the firewall before the firewall determines that the connection is idle.
      - TcpIdleTimeoutSeconds (integer) –
        
        The number of seconds that can pass without any TCP traffic sent through the firewall before the firewall determines that the connection is idle. After the idle timeout passes, data packets are dropped, however, the next TCP SYN packet is considered a new flow and is processed by the firewall. Clients or targets can use TCP keepalive packets to reset the idle timeout.
        
        You can define the TcpIdleTimeoutSeconds value to be between 60 and 6000 seconds. If no value is provided, it defaults to 350 seconds.
  - TLSInspectionConfigurationArn (string) –
    
    The Amazon Resource Name (ARN) of the TLS inspection configuration.
  - PolicyVariables (dict) –
    
    Contains variables that you can use to override default Suricata settings in your firewall policy.
    - RuleVariables (dict) –
      
      The IPv4 or IPv6 addresses in CIDR notation to use for the Suricata HOME_NET variable. If your firewall uses an inspection VPC, you might want to override the HOME_NET variable with the CIDRs of your home networks. If you don’t override HOME_NET with your own CIDRs, Network Firewall by default uses the CIDR of your inspection VPC.
      - (string) –
        
        (dict) –
        
        A list of IP addresses and address ranges, in CIDR notation. This is part of a RuleVariables.
        
        Definition (list) –
        
        The list of IP addresses and address ranges, in CIDR notation.
        
        (string) –

Exceptions

NetworkFirewall.Client.exceptions.InvalidRequestException
NetworkFirewall.Client.exceptions.ResourceNotFoundException
NetworkFirewall.Client.exceptions.ThrottlingException
NetworkFirewall.Client.exceptions.InternalServerError