SecurityHub / Client / batch_delete_automation_rules

batch_delete_automation_rules#

SecurityHub.Client.batch_delete_automation_rules(**kwargs)#

Deletes one or more automation rules.

See also: AWS API Documentation

Request Syntax

response = client.batch_delete_automation_rules(
    AutomationRulesArns=[
        'string',
    ]
)
Parameters:

AutomationRulesArns (list) –

[REQUIRED]

A list of Amazon Resource Names (ARNs) for the rules that are to be deleted.

  • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'ProcessedAutomationRules': [
        'string',
    ],
    'UnprocessedAutomationRules': [
        {
            'RuleArn': 'string',
            'ErrorCode': 123,
            'ErrorMessage': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    • ProcessedAutomationRules (list) –

      A list of properly processed rule ARNs.

      • (string) –

    • UnprocessedAutomationRules (list) –

      A list of objects containing RuleArn, ErrorCode, and ErrorMessage. This parameter tells you which automation rules the request didn’t delete and why.

      • (dict) –

        A list of objects containing RuleArn, ErrorCode, and ErrorMessage. This parameter tells you which automation rules the request didn’t process and why.

        • RuleArn (string) –

          The Amazon Resource Name (ARN) for the unprocessed automation rule.

        • ErrorCode (integer) –

          The error code associated with the unprocessed automation rule.

        • ErrorMessage (string) –

          An error message describing why a request didn’t process a specific rule.

Exceptions

  • SecurityHub.Client.exceptions.InternalException

  • SecurityHub.Client.exceptions.InvalidAccessException

  • SecurityHub.Client.exceptions.InvalidInputException

  • SecurityHub.Client.exceptions.LimitExceededException

  • SecurityHub.Client.exceptions.ResourceNotFoundException