AutomationRulesMetadata
Metadata for automation rules in the calling account. The response includes rules
with a RuleStatus of ENABLED and DISABLED.
Contents
- CreatedAt
-
A timestamp that indicates when the rule was created.
For more information about the validation and formatting of timestamp fields in AWS Security Hub, see Timestamps.
Type: Timestamp
Required: No
- CreatedBy
-
The principal that created a rule.
Type: String
Pattern:
.*\S.*Required: No
- Description
-
A description of the rule.
Type: String
Pattern:
.*\S.*Required: No
- IsTerminal
-
Specifies whether a rule is the last to be applied with respect to a finding that matches the rule criteria. This is useful when a finding matches the criteria for multiple rules, and each rule has different actions. If a rule is terminal, Security Hub applies the rule action to a finding that matches the rule criteria and doesn't evaluate other rules for the finding. By default, a rule isn't terminal.
Type: Boolean
Required: No
- RuleArn
-
The Amazon Resource Name (ARN) for the rule.
Type: String
Pattern:
.*\S.*Required: No
- RuleName
-
The name of the rule.
Type: String
Pattern:
.*\S.*Required: No
- RuleOrder
-
An integer ranging from 1 to 1000 that represents the order in which the rule action is applied to findings. Security Hub applies rules with lower values for this parameter first.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 1000.
Required: No
- RuleStatus
-
Whether the rule is active after it is created. If this parameter is equal to
ENABLED, Security Hub starts applying the rule to findings and finding updates after the rule is created. To change the value of this parameter after creating a rule, useBatchUpdateAutomationRules.Type: String
Valid Values:
ENABLED | DISABLEDRequired: No
- UpdatedAt
-
A timestamp that indicates when the rule was most recently updated.
For more information about the validation and formatting of timestamp fields in AWS Security Hub, see Timestamps.
Type: Timestamp
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: