NetworkFirewall / Client / describe_firewall

describe_firewall#

NetworkFirewall.Client.describe_firewall(**kwargs)#

Returns the data objects for the specified firewall.

Request Syntax

response = client.describe_firewall(
    FirewallName='string',
    FirewallArn='string'
)

Parameters:

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

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

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

Return type:

dict

Returns:

Response Syntax

{
    'UpdateToken': 'string',
    'Firewall': {
        'FirewallName': 'string',
        'FirewallArn': 'string',
        'FirewallPolicyArn': 'string',
        'VpcId': 'string',
        'SubnetMappings': [
            {
                'SubnetId': 'string',
                'IPAddressType': 'DUALSTACK'|'IPV4'
            },
        ],
        'DeleteProtection': True|False,
        'SubnetChangeProtection': True|False,
        'FirewallPolicyChangeProtection': True|False,
        'Description': 'string',
        'FirewallId': 'string',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'EncryptionConfiguration': {
            'KeyId': 'string',
            'Type': 'CUSTOMER_KMS'|'AWS_OWNED_KMS_KEY'
        }
    },
    'FirewallStatus': {
        'Status': 'PROVISIONING'|'DELETING'|'READY',
        'ConfigurationSyncStateSummary': 'PENDING'|'IN_SYNC'|'CAPACITY_CONSTRAINED',
        'SyncStates': {
            'string': {
                'Attachment': {
                    'SubnetId': 'string',
                    'EndpointId': 'string',
                    'Status': 'CREATING'|'DELETING'|'SCALING'|'READY',
                    'StatusMessage': 'string'
                },
                'Config': {
                    'string': {
                        'SyncStatus': 'PENDING'|'IN_SYNC'|'CAPACITY_CONSTRAINED',
                        'UpdateToken': 'string'
                    }
                }
            }
        },
        'CapacityUsageSummary': {
            'CIDRs': {
                'AvailableCIDRCount': 123,
                'UtilizedCIDRCount': 123,
                'IPSetReferences': {
                    'string': {
                        'ResolvedCIDRCount': 123
                    }
                }
            }
        }
    }
}

Response Structure

(dict) –
- UpdateToken (string) –
  
  An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.
  
  To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.
  
  To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn’t changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.
- Firewall (dict) –
  
  The configuration settings for the firewall. These settings include the firewall policy and the subnets in your VPC to use for the firewall endpoints.
  - FirewallName (string) –
    
    The descriptive name of the firewall. You can’t change the name of a firewall after you create it.
  - FirewallArn (string) –
    
    The Amazon Resource Name (ARN) of the firewall.
  - FirewallPolicyArn (string) –
    
    The Amazon Resource Name (ARN) of the firewall policy.
    
    The relationship of firewall to firewall policy is many to one. Each firewall requires one firewall policy association, and you can use the same firewall policy for multiple firewalls.
  - VpcId (string) –
    
    The unique identifier of the VPC where the firewall is in use.
  - SubnetMappings (list) –
    
    The public subnets that Network Firewall is using for the firewall. Each subnet must belong to a different Availability Zone.
    - (dict) –
      
      The ID for a subnet that you want to associate with the firewall. This is used with CreateFirewall and AssociateSubnets. Network Firewall creates an instance of the associated firewall in each subnet that you specify, to filter traffic in the subnet’s Availability Zone.
      - SubnetId (string) –
        
        The unique identifier for the subnet.
      - IPAddressType (string) –
        
        The subnet’s IP address type. You can’t change the IP address type after you create the subnet.
  - DeleteProtection (boolean) –
    
    A flag indicating whether it is possible to delete the firewall. A setting of TRUE indicates that the firewall is protected against deletion. Use this setting to protect against accidentally deleting a firewall that is in use. When you create a firewall, the operation initializes this flag to TRUE.
  - SubnetChangeProtection (boolean) –
    
    A setting indicating whether the firewall is protected against changes to the subnet associations. Use this setting to protect against accidentally modifying the subnet associations for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE.
  - FirewallPolicyChangeProtection (boolean) –
    
    A setting indicating whether the firewall is protected against a change to the firewall policy association. Use this setting to protect against accidentally modifying the firewall policy for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE.
  - Description (string) –
    
    A description of the firewall.
  - FirewallId (string) –
    
    The unique identifier for the firewall.
  - Tags (list) –
    - (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.
  - EncryptionConfiguration (dict) –
    
    A complex type that contains the Amazon Web Services KMS encryption configuration settings for your firewall.
    - 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.
- FirewallStatus (dict) –
  
  Detailed information about the current status of a Firewall. You can retrieve this for a firewall by calling DescribeFirewall and providing the firewall name and ARN.
  - Status (string) –
    
    The readiness of the configured firewall to handle network traffic across all of the Availability Zones where you’ve configured it. This setting is READY only when the ConfigurationSyncStateSummary value is IN_SYNC and the Attachment Status values for all of the configured subnets are READY.
  - ConfigurationSyncStateSummary (string) –
    
    The configuration sync state for the firewall. This summarizes the sync states reported in the Config settings for all of the Availability Zones where you have configured the firewall.
    
    When you create a firewall or update its configuration, for example by adding a rule group to its firewall policy, Network Firewall distributes the configuration changes to all zones where the firewall is in use. This summary indicates whether the configuration changes have been applied everywhere.
    
    This status must be IN_SYNC for the firewall to be ready for use, but it doesn’t indicate that the firewall is ready. The Status setting indicates firewall readiness.
  - SyncStates (dict) –
    
    The subnets that you’ve configured for use by the Network Firewall firewall. This contains one array element per Availability Zone where you’ve configured a subnet. These objects provide details of the information that is summarized in the ConfigurationSyncStateSummary and Status, broken down by zone and configuration object.
    - (string) –
      - (dict) –
        
        The status of the firewall endpoint and firewall policy configuration for a single VPC subnet.
        
        For each VPC subnet that you associate with a firewall, Network Firewall does the following:
        
        Instantiates a firewall endpoint in the subnet, ready to take traffic.
        
        Configures the endpoint with the current firewall policy settings, to provide the filtering behavior for the endpoint.
        
        When you update a firewall, for example to add a subnet association or change a rule group in the firewall policy, the affected sync states reflect out-of-sync or not ready status until the changes are complete.
        
        Attachment (dict) –
        
        The attachment status of the firewall’s association with a single VPC subnet. For each configured subnet, Network Firewall creates the attachment by instantiating the firewall endpoint in the subnet so that it’s ready to take traffic. This is part of the FirewallStatus.
        
        SubnetId (string) –
        
        The unique identifier of the subnet that you’ve specified to be used for a firewall endpoint.
        
        EndpointId (string) –
        
        The identifier of the firewall endpoint that Network Firewall has instantiated in the subnet. You use this to identify the firewall endpoint in the VPC route tables, when you redirect the VPC traffic through the endpoint.
        
        Status (string) –
        
        The current status of the firewall endpoint in the subnet. This value reflects both the instantiation of the endpoint in the VPC subnet and the sync states that are reported in the Config settings. When this value is READY, the endpoint is available and configured properly to handle network traffic. When the endpoint isn’t available for traffic, this value will reflect its state, for example CREATING or DELETING.
        
        StatusMessage (string) –
        
        If Network Firewall fails to create or delete the firewall endpoint in the subnet, it populates this with the reason for the failure and how to resolve it. Depending on the error, it can take as many as 15 minutes to populate this field. For more information about the errors and solutions available for this field, see Troubleshooting firewall endpoint failures in the Network Firewall Developer Guide.
        
        Config (dict) –
        
        The configuration status of the firewall endpoint in a single VPC subnet. Network Firewall provides each endpoint with the rules that are configured in the firewall policy. Each time you add a subnet or modify the associated firewall policy, Network Firewall synchronizes the rules in the endpoint, so it can properly filter network traffic. This is part of the FirewallStatus.
        
        (string) –
        
        (dict) –
        
        Provides configuration status for a single policy or rule group that is used for a firewall endpoint. Network Firewall provides each endpoint with the rules that are configured in the firewall policy. Each time you add a subnet or modify the associated firewall policy, Network Firewall synchronizes the rules in the endpoint, so it can properly filter network traffic. This is part of a SyncState for a firewall.
        
        SyncStatus (string) –
        
        Indicates whether this object is in sync with the version indicated in the update token.
        
        UpdateToken (string) –
        
        The current version of the object that is either in sync or pending synchronization.
  - CapacityUsageSummary (dict) –
    
    Describes the capacity usage of the resources contained in a firewall’s reference sets. Network Firewall calclulates the capacity usage by taking an aggregated count of all of the resources used by all of the reference sets in a firewall.
    - CIDRs (dict) –
      
      Describes the capacity usage of the CIDR blocks used by the IP set references in a firewall.
      - AvailableCIDRCount (integer) –
        
        The number of CIDR blocks available for use by the IP set references in a firewall.
      - UtilizedCIDRCount (integer) –
        
        The number of CIDR blocks used by the IP set references in a firewall.
      - IPSetReferences (dict) –
        
        The list of the IP set references used by a firewall.
        
        (string) –
        
        (dict) –
        
        General information about the IP set.
        
        ResolvedCIDRCount (integer) –
        
        Describes the total number of CIDR blocks currently in use by the IP set references in a firewall. To determine how many CIDR blocks are available for you to use in a firewall, you can call AvailableCIDRCount.

Exceptions

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