Skip to content

CreateAutomationRuleResponse

Source code in docs_src/capo_compute_optimizer_automation/types/create_automation_rule_response.py
class CreateAutomationRuleResponse(TypedDict, closed=True):
    rule_arn: NotRequired["capo_compute_optimizer_automation.types.rule_arn.RuleArn"]
    """<p> The Amazon Resource Name (ARN) of the created rule. </p>"""
    rule_id: NotRequired["capo_compute_optimizer_automation.types.rule_id.RuleId"]
    """<p> The unique identifier of the created rule. </p>"""
    name: NotRequired["capo_compute_optimizer_automation.types.rule_name.RuleName"]
    """<p>The name of the automation rule. Must be 1-128 characters long and contain only alphanumeric characters, underscores, and hyphens.</p>"""
    description: NotRequired["str"]
    """<p>A 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 type of automation rule. Can be either OrganizationRule for organization-wide rules or AccountRule for account-specific rules.</p>"""
    rule_revision: NotRequired["int"]
    """<p>The revision number of the automation rule. This is incremented each time the rule is updated.</p>"""
    organization_configuration: NotRequired[
        "capo_compute_optimizer_automation.types.organization_configuration.OrganizationConfiguration"
    ]
    """<p>Configuration settings for organization-wide rules, including rule application order and target account IDs.</p>"""
    priority: NotRequired["str"]
    """<p>The 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>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 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 current status of the automation rule. Can be Active or Inactive.</p>"""
    tags: NotRequired["capo_compute_optimizer_automation.types.tag_list.TagList"]
    """<p>A list of key-value pairs used to categorize and organize the automation rule. Maximum of 200 tags allowed.</p>"""
    created_timestamp: NotRequired["datetime.datetime"]
    """<p>The timestamp when the automation rule was created.</p>"""

created_timestamp instance-attribute

created_timestamp: NotRequired[datetime]

The timestamp when the automation rule was created.

criteria instance-attribute

criteria: NotRequired[Criteria]

description instance-attribute

description: NotRequired[str]

A 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 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]

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

priority instance-attribute

priority: NotRequired[str]

The 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]

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

rule_arn instance-attribute

rule_arn: NotRequired[RuleArn]

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

rule_id instance-attribute

rule_id: NotRequired[RuleId]

The unique identifier of the created rule.

rule_revision instance-attribute

rule_revision: NotRequired[int]

The revision number of the automation rule. This is incremented each time the rule is updated.

rule_type instance-attribute

rule_type: NotRequired[RuleType]

The 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 schedule configuration for when the automation rule should execute, including cron expression, timezone, and execution window.

status instance-attribute

status: NotRequired[RuleStatus]

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

tags instance-attribute

tags: NotRequired[TagList]

A list of key-value pairs used to categorize and organize the automation rule. Maximum of 200 tags allowed.