NetworkFirewall / Client / describe_firewall_metadata
describe_firewall_metadata¶
- NetworkFirewall.Client.describe_firewall_metadata(**kwargs)¶
Returns the high-level information about a firewall, including the Availability Zones where the Firewall is currently in use.
See also: AWS API Documentation
Request Syntax
response = client.describe_firewall_metadata( FirewallArn='string' )
- Parameters:
FirewallArn (string) – The Amazon Resource Name (ARN) of the firewall.
- Return type:
dict
- Returns:
Response Syntax
{ 'FirewallArn': 'string', 'FirewallPolicyArn': 'string', 'Description': 'string', 'Status': 'PROVISIONING'|'DELETING'|'READY', 'SupportedAvailabilityZones': { 'string': { 'IPAddressType': 'DUALSTACK'|'IPV4'|'IPV6' } } }
Response Structure
(dict) –
FirewallArn (string) –
The Amazon Resource Name (ARN) of the firewall.
FirewallPolicyArn (string) –
The Amazon Resource Name (ARN) of the firewall policy.
Description (string) –
A description of the firewall.
Status (string) –
The readiness of the configured firewall to handle network traffic across all of the Availability Zones where you have it configured. This setting is
READY
only when theConfigurationSyncStateSummary
value isIN_SYNC
and theAttachment
Status
values for all of the configured subnets areREADY
.SupportedAvailabilityZones (dict) –
The Availability Zones that the firewall currently supports. This includes all Availability Zones for which the firewall has a subnet defined.
(string) –
(dict) –
High-level information about an Availability Zone where the firewall has an endpoint defined.
IPAddressType (string) –
The IP address type of the Firewall subnet in the Availability Zone. You can’t change the IP address type after you create the subnet.
Exceptions