Route53GlobalResolver / Client / batch_delete_firewall_rule

batch_delete_firewall_rule¶

Route53GlobalResolver.Client.batch_delete_firewall_rule(**kwargs)¶

Deletes multiple DNS firewall rules in a single operation. This is more efficient than deleting rules individually.

Request Syntax

response = client.batch_delete_firewall_rule(
    firewallRules=[
        {
            'firewallRuleId': 'string'
        },
    ]
)

Parameters:

firewallRules (list) –

[REQUIRED]

An array of the DNS Firewall IDs to be deleted.

(dict) –

Information about a DNS Firewall rule to delete in a batch operation.
- firewallRuleId (string) – [REQUIRED]
  
  The ID of the DNS Firewall rule to delete.

Return type:

dict

Returns:

Response Syntax

{
    'failures': [
        {
            'firewallRule': {
                'clientToken': 'string',
                'id': 'string',
                'name': 'string',
                'status': 'CREATING'|'OPERATIONAL'|'UPDATING'|'DELETING'
            },
            'code': 123,
            'message': 'string'
        },
    ],
    'successes': [
        {
            'firewallRule': {
                'clientToken': 'string',
                'id': 'string',
                'name': 'string',
                'status': 'CREATING'|'OPERATIONAL'|'UPDATING'|'DELETING'
            },
            'code': 123,
            'message': 'string'
        },
    ]
}

Response Structure

(dict) –
- failures (list) –
  
  High level information about the DNS Firewall rules that failed to delete.
  - (dict) –
    
    The result of deleting a firewall rule in a batch operation.
    - firewallRule (dict) –
      
      The firewall rule that was deleted in the batch operation.
      - clientToken (string) –
        
        The unique string that identified the request and ensured idempotency.
      - id (string) –
        
        The unique identifier of the deleted firewall rule.
      - name (string) –
        
        The name of the deleted firewall rule.
      - status (string) –
        
        The final status of the deleted firewall rule.
    - code (integer) –
      
      The response code for the delete operation.
    - message (string) –
      
      The response message for the delete operation.
- successes (list) –
  
  High level information about the DNS Firewall rules that were deleted successfully.
  - (dict) –
    
    The result of deleting a firewall rule in a batch operation.
    - firewallRule (dict) –
      
      The firewall rule that was deleted in the batch operation.
      - clientToken (string) –
        
        The unique string that identified the request and ensured idempotency.
      - id (string) –
        
        The unique identifier of the deleted firewall rule.
      - name (string) –
        
        The name of the deleted firewall rule.
      - status (string) –
        
        The final status of the deleted firewall rule.
    - code (integer) –
      
      The response code for the delete operation.
    - message (string) –
      
      The response message for the delete operation.

Exceptions

Route53GlobalResolver.Client.exceptions.InternalServerException
Route53GlobalResolver.Client.exceptions.ValidationException
Route53GlobalResolver.Client.exceptions.AccessDeniedException
Route53GlobalResolver.Client.exceptions.ThrottlingException