Skip to content

AutomationRule

Source code in docs_src/capo_compute_optimizer_automation/types/automation_rule.py
class AutomationRule(TypedDict, closed=True):
    rule_arn: NotRequired["capo_compute_optimizer_automation.types.rule_arn.RuleArn"]
    """<p>The Amazon Resource Name (ARN) of the automation rule.</p>"""
    rule_id: NotRequired["capo_compute_optimizer_automation.types.rule_id.RuleId"]
    """<p>The unique identifier of the automation rule.</p>"""
    name: NotRequired["capo_compute_optimizer_automation.types.rule_name.RuleName"]
    """<p>The name of the automation rule.</p>"""
    description: NotRequired["str"]
    """<p>A description of the automation rule.</p>"""
    rule_type: NotRequired["capo_compute_optimizer_automation.types.rule_type.RuleType"]
    """<p>The type of automation rule (OrganizationRule or AccountRule).</p>"""
    rule_revision: NotRequired["int"]
    """<p>The revision number of the automation rule.</p>"""
    account_id: NotRequired[
        "capo_compute_optimizer_automation.types.account_id.AccountId"
    ]
    """<p>The 12-digit Amazon Web Services account ID that owns this automation rule.</p>"""
    organization_configuration: NotRequired[
        "capo_compute_optimizer_automation.types.organization_configuration.OrganizationConfiguration"
    ]
    """<p>Configuration settings for organization-wide rules.</p>"""
    priority: NotRequired["str"]
    """<p>A string representation of a decimal number between 0 and 1 (having up to 30 digits after the decimal point) that determines the priority of the rule. When multiple rules match the same recommended action, Compute Optimizer assigns the action to the rule with the lowest priority value (highest priority), even if that rule is scheduled to run later than other matching rules.</p>"""
    recommended_action_types: NotRequired[
        "capo_compute_optimizer_automation.types.recommended_action_type_list.RecommendedActionTypeList"
    ]
    """<p>List of recommended action types that this rule can execute.</p>"""
    schedule: NotRequired["capo_compute_optimizer_automation.types.schedule.Schedule"]
    """<p>The schedule configuration for when the automation rule should execute.</p>"""
    status: NotRequired[
        "capo_compute_optimizer_automation.types.rule_status.RuleStatus"
    ]
    """<p>The current status of the automation rule (Active or Inactive).</p>"""
    created_timestamp: NotRequired["datetime.datetime"]
    """<p>The timestamp when the automation rule was created.</p>"""
    last_updated_timestamp: NotRequired["datetime.datetime"]
    """<p>The timestamp when the automation rule was last updated.</p>"""

account_id instance-attribute

account_id: NotRequired[AccountId]

The 12-digit Amazon Web Services account ID that owns this automation rule.

created_timestamp instance-attribute

created_timestamp: NotRequired[datetime]

The timestamp when the automation rule was created.

description instance-attribute

description: NotRequired[str]

A description of the automation rule.

last_updated_timestamp instance-attribute

last_updated_timestamp: NotRequired[datetime]

The timestamp when the automation rule was last updated.

name instance-attribute

name: NotRequired[RuleName]

The name of the automation rule.

organization_configuration instance-attribute

organization_configuration: NotRequired[OrganizationConfiguration]

Configuration settings for organization-wide rules.

priority instance-attribute

priority: NotRequired[str]

A string representation of a decimal number between 0 and 1 (having up to 30 digits after the decimal point) that determines the priority of the rule. When multiple rules match the same recommended action, Compute Optimizer assigns the action to the rule with the lowest priority value (highest priority), even if that rule is scheduled to run later than other matching rules.

recommended_action_types instance-attribute

recommended_action_types: NotRequired[RecommendedActionTypeList]

List of recommended action types that this rule can execute.

rule_arn instance-attribute

rule_arn: NotRequired[RuleArn]

The Amazon Resource Name (ARN) of the automation rule.

rule_id instance-attribute

rule_id: NotRequired[RuleId]

The unique identifier of the automation rule.

rule_revision instance-attribute

rule_revision: NotRequired[int]

The revision number of the automation rule.

rule_type instance-attribute

rule_type: NotRequired[RuleType]

The type of automation rule (OrganizationRule or AccountRule).

schedule instance-attribute

schedule: NotRequired[Schedule]

The schedule configuration for when the automation rule should execute.

status instance-attribute

status: NotRequired[RuleStatus]

The current status of the automation rule (Active or Inactive).