Skip to content

UpdateAutomationRuleRequest

Source code in docs_src/capo_compute_optimizer_automation/types/update_automation_rule_request.py
class UpdateAutomationRuleRequest(TypedDict, closed=True):
    rule_arn: "capo_compute_optimizer_automation.types.rule_arn.RuleArn"
    """<p> The ARN of the rule to update. </p>"""
    rule_revision: "int"
    """<p> The revision number of the rule to update. </p>"""
    name: NotRequired["capo_compute_optimizer_automation.types.rule_name.RuleName"]
    """<p>The updated name of the automation rule. Must be 1-128 characters long and contain only alphanumeric characters, underscores, and hyphens.</p>"""
    description: NotRequired[
        "capo_compute_optimizer_automation.types.rule_description.RuleDescription"
    ]
    """<p>The updated description of the automation rule. Can be up to 1024 characters long and contain alphanumeric characters, underscores, hyphens, spaces, and certain special characters.</p>"""
    rule_type: NotRequired["capo_compute_optimizer_automation.types.rule_type.RuleType"]
    """<p>The updated type of automation rule. Can be either OrganizationRule for organization-wide rules or AccountRule for account-specific rules.</p>"""
    organization_configuration: NotRequired[
        "capo_compute_optimizer_automation.types.organization_configuration.OrganizationConfiguration"
    ]
    """<p>Updated configuration settings for organization-wide rules, including rule application order and target account IDs.</p>"""
    priority: NotRequired["str"]
    """<p>The updated priority level of the automation rule, used to determine execution order when multiple rules apply to the same resource.</p>"""
    recommended_action_types: NotRequired[
        "capo_compute_optimizer_automation.types.recommended_action_type_list.RecommendedActionTypeList"
    ]
    """<p>Updated list of recommended action types that this rule can execute, such as SnapshotAndDeleteUnattachedEbsVolume or UpgradeEbsVolumeType.</p>"""
    criteria: NotRequired["capo_compute_optimizer_automation.types.criteria.Criteria"]
    schedule: NotRequired["capo_compute_optimizer_automation.types.schedule.Schedule"]
    """<p>The updated schedule configuration for when the automation rule should execute, including cron expression, timezone, and execution window.</p>"""
    status: NotRequired[
        "capo_compute_optimizer_automation.types.rule_status.RuleStatus"
    ]
    """<p>The updated status of the automation rule. Can be Active or Inactive.</p>"""
    client_token: NotRequired[
        "capo_compute_optimizer_automation.types.client_token.ClientToken"
    ]
    """<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Must be 1-64 characters long and contain only alphanumeric characters, underscores, and hyphens.</p>"""

client_token instance-attribute

client_token: NotRequired[ClientToken]

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Must be 1-64 characters long and contain only alphanumeric characters, underscores, and hyphens.

criteria instance-attribute

criteria: NotRequired[Criteria]

description instance-attribute

description: NotRequired[RuleDescription]

The updated description of the automation rule. Can be up to 1024 characters long and contain alphanumeric characters, underscores, hyphens, spaces, and certain special characters.

name instance-attribute

name: NotRequired[RuleName]

The updated name of the automation rule. Must be 1-128 characters long and contain only alphanumeric characters, underscores, and hyphens.

organization_configuration instance-attribute

organization_configuration: NotRequired[OrganizationConfiguration]

Updated configuration settings for organization-wide rules, including rule application order and target account IDs.

priority instance-attribute

priority: NotRequired[str]

The updated priority level of the automation rule, used to determine execution order when multiple rules apply to the same resource.

recommended_action_types instance-attribute

recommended_action_types: NotRequired[RecommendedActionTypeList]

Updated list of recommended action types that this rule can execute, such as SnapshotAndDeleteUnattachedEbsVolume or UpgradeEbsVolumeType.

rule_arn instance-attribute

rule_arn: RuleArn

The ARN of the rule to update.

rule_revision instance-attribute

rule_revision: int

The revision number of the rule to update.

rule_type instance-attribute

rule_type: NotRequired[RuleType]

The updated type of automation rule. Can be either OrganizationRule for organization-wide rules or AccountRule for account-specific rules.

schedule instance-attribute

schedule: NotRequired[Schedule]

The updated schedule configuration for when the automation rule should execute, including cron expression, timezone, and execution window.

status instance-attribute

status: NotRequired[RuleStatus]

The updated status of the automation rule. Can be Active or Inactive.