NetworkFirewall / Client / delete_firewall_policy

delete_firewall_policy#

NetworkFirewall.Client.delete_firewall_policy(**kwargs)#

Deletes the specified FirewallPolicy.

See also: AWS API Documentation

Request Syntax

response = client.delete_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

{
    '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)
    }
}

Response Structure

  • (dict) –

    • FirewallPolicyResponse (dict) –

      The object containing the definition of the FirewallPolicyResponse that you asked to delete.

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

Exceptions