Skip to content

RecommendedAction

Source code in docs_src/capo_rds/types/recommended_action.py
class RecommendedAction(TypedDict, closed=True):
    action_id: NotRequired["capo_rds.types.string.String"]
    """<p>The unique identifier of the recommended action.</p>"""
    title: NotRequired["capo_rds.types.string.String"]
    """<p>A short description to summarize the action. The description might contain markdown.</p>"""
    description: NotRequired["capo_rds.types.string.String"]
    """<p>A detailed description of the action. The description might contain markdown.</p>"""
    operation: NotRequired["capo_rds.types.string.String"]
    """<p>An API operation for the action.</p>"""
    parameters: NotRequired[
        "capo_rds.types.recommended_action_parameter_list.RecommendedActionParameterList"
    ]
    """<p>The parameters for the API operation.</p>"""
    apply_modes: NotRequired["capo_rds.types.string_list.StringList"]
    """<p>The methods to apply the recommended action.</p> <p>Valid values:</p> <ul> <li> <p> <code>manual</code> - The action requires you to resolve the recommendation manually.</p> </li> <li> <p> <code>immediately</code> - The action is applied immediately.</p> </li> <li> <p> <code>next-maintainance-window</code> - The action is applied during the next scheduled maintainance.</p> </li> </ul>"""
    status: NotRequired["capo_rds.types.string.String"]
    """<p>The status of the action.</p> <ul> <li> <p> <code>ready</code> </p> </li> <li> <p> <code>applied</code> </p> </li> <li> <p> <code>scheduled</code> </p> </li> <li> <p> <code>resolved</code> </p> </li> </ul>"""
    issue_details: NotRequired["capo_rds.types.issue_details.IssueDetails"]
    """<p>The details of the issue.</p>"""
    context_attributes: NotRequired[
        "capo_rds.types.context_attribute_list.ContextAttributeList"
    ]
    """<p>The supporting attributes to explain the recommended action.</p>"""

action_id instance-attribute

action_id: NotRequired[String]

The unique identifier of the recommended action.

apply_modes instance-attribute

apply_modes: NotRequired[StringList]

The methods to apply the recommended action.

Valid values:

  • manual - The action requires you to resolve the recommendation manually.

  • immediately - The action is applied immediately.

  • next-maintainance-window - The action is applied during the next scheduled maintainance.

context_attributes instance-attribute

context_attributes: NotRequired[ContextAttributeList]

The supporting attributes to explain the recommended action.

description instance-attribute

description: NotRequired[String]

A detailed description of the action. The description might contain markdown.

issue_details instance-attribute

issue_details: NotRequired[IssueDetails]

The details of the issue.

operation instance-attribute

operation: NotRequired[String]

An API operation for the action.

parameters instance-attribute

parameters: NotRequired[RecommendedActionParameterList]

The parameters for the API operation.

status instance-attribute

status: NotRequired[String]

The status of the action.

  • ready

  • applied

  • scheduled

  • resolved

title instance-attribute

title: NotRequired[String]

A short description to summarize the action. The description might contain markdown.