NetworkFirewall / Client / delete_firewall_policy_v2

delete_firewall_policy_v2

NetworkFirewall.Client.delete_firewall_policy_v2(**kwargs)

Deletes the specified FirewallPolicyV2.

See also: AWS API Documentation

Request Syntax

response = client.delete_firewall_policy_v2(
    FirewallPolicyV2Arn='string',
    FirewallPolicyV2Name='string'
)
Parameters:

  • FirewallPolicyV2Arn (string) –

    The Amazon Resource Name (ARN) of the Next Generation policy.

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

  • FirewallPolicyV2Name (string) –

    The descriptive name of the Next Generation 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.

Return type:

dict

Returns:

Response Syntax

{
    'FirewallPolicyV2Response': {
        'FirewallPolicyV2Name': 'string',
        'FirewallPolicyV2Arn': 'string',
        'FirewallPolicyV2Id': 'string',
        'Description': 'string',
        'FirewallPolicyV2Status': 'ACTIVE'|'DELETING'|'ERROR'|'UPDATING',
        'StatusMessage': 'string',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'ConsumedFirewallRuleCapacity': 123,
        'ConsumedIpsRuleCapacity': 123,
        'ConsumedIpsDomainCapacity': 123,
        'NumberOfAssociations': 123,
        'EncryptionConfiguration': {
            'KeyId': 'string',
            'Type': 'CUSTOMER_KMS'|'AWS_OWNED_KMS_KEY'
        },
        'Errors': [
            {
                'Code': 'DNS_FIREWALL_RULE_GROUP_UNAVAILABLE'|'ROUTE53_RESOLVED_IP_VALIDATION_MISSING',
                'Message': 'string',
                'ResourceId': 'string'
            },
        ],
        'LastModifiedTime': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) –

    • FirewallPolicyV2Response (dict) –

      The high-level properties of the Next Generation policy that you asked to delete.

      • FirewallPolicyV2Name (string) –

        The descriptive name of the Next Generation policy. You can’t change the name of a firewall policy after you create it.

      • FirewallPolicyV2Arn (string) –

        The Amazon Resource Name (ARN) of the Next Generation policy.

      • FirewallPolicyV2Id (string) –

        The unique identifier of the Next Generation policy. Network Firewall assigns this identifier when you create the policy.

      • Description (string) –

        A description of the Next Generation policy.

      • FirewallPolicyV2Status (string) –

        The current status of the Next Generation policy. A policy must be in the ACTIVE state before you can use it in a firewall.

      • StatusMessage (string) –

        Additional information about the current status of the Next Generation policy.

      • Tags (list) –

        The key-value tag pairs that are associated with the Next Generation policy.

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

      • ConsumedFirewallRuleCapacity (integer) –

        The number of firewall engine rule capacity units that the policy’s firewall section currently consumes.

      • ConsumedIpsRuleCapacity (integer) –

        The number of IPS engine rule capacity units that the policy’s IPS section currently consumes.

      • ConsumedIpsDomainCapacity (integer) –

        The number of IPS domain list capacity units that the policy’s IPS section currently consumes.

      • NumberOfAssociations (integer) –

        The number of firewalls that are associated with the Next Generation policy.

      • EncryptionConfiguration (dict) –

        A complex type that contains the Amazon Web Services KMS encryption configuration settings for your Next Generation 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.

      • Errors (list) –

        Any configuration errors that apply to the Next Generation policy. Network Firewall detects these errors asynchronously, after you create or update the policy, so an error can appear after the request that caused it has already succeeded. Each entry describes the problem and how to resolve it, and Network Firewall clears it automatically after you resolve the problem.

        • (dict) –

          A configuration error that Network Firewall detected for a firewall policy.

          • Code (string) –

            The error code identifies the type of error. Valid values are the following:

            • DNS_FIREWALL_RULE_GROUP_UNAVAILABLE – The Amazon Route 53 Resolver DNS Firewall rule group that resolved IP validation references is unavailable, for example, because it was deleted or is no longer accessible from your account. Update the rule group ID or remove the resolved IP validation configuration.

            • ROUTE53_RESOLVED_IP_VALIDATION_MISSING – An associated stateful rule group uses the aws_route_53_resolved_domain keyword, but the policy doesn’t have resolved IP validation configured. The affected rules are inactive until you add resolved IP validation to the policy or remove the keyword rules.

          • Message (string) –

            A description of the error and how to resolve it.

          • ResourceId (string) –

            The ID of the resource that the error relates to, when applicable. For example, for DNS_FIREWALL_RULE_GROUP_UNAVAILABLE this is the Amazon Route 53 Resolver DNS Firewall rule group ID.

      • LastModifiedTime (datetime) –

        The last time that the Next Generation policy was changed.

Exceptions