Skip to content

CreateAutomationRuleRequest

Source code in docs_src/capo_compute_optimizer_automation/types/create_automation_rule_request.py
class CreateAutomationRuleRequest(TypedDict, closed=True):
    name: "capo_compute_optimizer_automation.types.rule_name.RuleName"
    """<p> The name of the automation rule. </p>"""
    description: NotRequired[
        "capo_compute_optimizer_automation.types.rule_description.RuleDescription"
    ]
    """<p> A description of the automation rule. </p>"""
    rule_type: "capo_compute_optimizer_automation.types.rule_type.RuleType"
    """<p> The type of rule. </p> <note> <p>Only the management account or a delegated administrator can set the ruleType to be OrganizationRule.</p> </note>"""
    organization_configuration: NotRequired[
        "capo_compute_optimizer_automation.types.organization_configuration.OrganizationConfiguration"
    ]
    """<p> Configuration for organization-level rules. Required for OrganizationRule type. </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: "capo_compute_optimizer_automation.types.recommended_action_type_list.RecommendedActionTypeList"
    """<p> The types of recommended actions this rule will automate. </p>"""
    criteria: NotRequired["capo_compute_optimizer_automation.types.criteria.Criteria"]
    """<p>A set of conditions that specify which recommended action qualify for implementation. When a rule is active and a recommended action matches these criteria, Compute Optimizer implements the action at the scheduled run time. </p>"""
    schedule: "capo_compute_optimizer_automation.types.schedule.Schedule"
    """<p> The schedule for when the rule should run. </p>"""
    status: "capo_compute_optimizer_automation.types.rule_status.RuleStatus"
    """<p>The status of the rule </p>"""
    tags: NotRequired["capo_compute_optimizer_automation.types.tag_list.TagList"]
    """<p> The tags to associate with the rule. </p>"""
    client_token: NotRequired[
        "capo_compute_optimizer_automation.types.client_token.ClientToken"
    ]
    """<p> A unique identifier to ensure idempotency of the request. </p>"""

client_token instance-attribute

client_token: NotRequired[ClientToken]

A unique identifier to ensure idempotency of the request.

criteria instance-attribute

criteria: NotRequired[Criteria]

A set of conditions that specify which recommended action qualify for implementation. When a rule is active and a recommended action matches these criteria, Compute Optimizer implements the action at the scheduled run time.

description instance-attribute

description: NotRequired[RuleDescription]

A description of the automation rule.

name instance-attribute

name: RuleName

The name of the automation rule.

organization_configuration instance-attribute

organization_configuration: NotRequired[OrganizationConfiguration]

Configuration for organization-level rules. Required for OrganizationRule type.

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: RecommendedActionTypeList

The types of recommended actions this rule will automate.

rule_type instance-attribute

rule_type: RuleType

The type of rule.

Only the management account or a delegated administrator can set the ruleType to be OrganizationRule.

schedule instance-attribute

schedule: Schedule

The schedule for when the rule should run.

status instance-attribute

status: RuleStatus

The status of the rule

tags instance-attribute

tags: NotRequired[TagList]

The tags to associate with the rule.