Skip to content

DBRecommendation

Source code in docs_src/capo_rds/types/db_recommendation.py
class DBRecommendation(TypedDict, closed=True):
    recommendation_id: NotRequired["capo_rds.types.string.String"]
    """<p>The unique identifier of the recommendation.</p>"""
    type_id: NotRequired["capo_rds.types.string.String"]
    """<p>A value that indicates the type of recommendation. This value determines how the description is rendered.</p>"""
    severity: NotRequired["capo_rds.types.string.String"]
    """<p>The severity level of the recommendation. The severity level can help you decide the urgency with which to address the recommendation.</p> <p>Valid values:</p> <ul> <li> <p> <code>high</code> </p> </li> <li> <p> <code>medium</code> </p> </li> <li> <p> <code>low</code> </p> </li> <li> <p> <code>informational</code> </p> </li> </ul>"""
    resource_arn: NotRequired["capo_rds.types.string.String"]
    """<p>The Amazon Resource Name (ARN) of the RDS resource associated with the recommendation.</p>"""
    status: NotRequired["capo_rds.types.string.String"]
    """<p>The current status of the recommendation.</p> <p>Valid values:</p> <ul> <li> <p> <code>active</code> - The recommendations which are ready for you to apply.</p> </li> <li> <p> <code>pending</code> - The applied or scheduled recommendations which are in progress.</p> </li> <li> <p> <code>resolved</code> - The recommendations which are completed.</p> </li> <li> <p> <code>dismissed</code> - The recommendations that you dismissed.</p> </li> </ul>"""
    created_time: NotRequired["capo_rds.types.t_stamp.TStamp"]
    """<p>The time when the recommendation was created. For example, <code>2023-09-28T01:13:53.931000+00:00</code>.</p>"""
    updated_time: NotRequired["capo_rds.types.t_stamp.TStamp"]
    """<p>The time when the recommendation was last updated.</p>"""
    detection: NotRequired["capo_rds.types.string.String"]
    """<p>A short description of the issue identified for this recommendation. The description might contain markdown.</p>"""
    recommendation: NotRequired["capo_rds.types.string.String"]
    """<p>A short description of the recommendation to resolve an issue. The description might contain markdown.</p>"""
    description: NotRequired["capo_rds.types.string.String"]
    """<p>A detailed description of the recommendation. The description might contain markdown.</p>"""
    reason: NotRequired["capo_rds.types.string.String"]
    """<p>The reason why this recommendation was created. The information might contain markdown.</p>"""
    recommended_actions: NotRequired[
        "capo_rds.types.recommended_action_list.RecommendedActionList"
    ]
    """<p>A list of recommended actions.</p>"""
    category: NotRequired["capo_rds.types.string.String"]
    """<p>The category of the recommendation.</p> <p>Valid values:</p> <ul> <li> <p> <code>performance efficiency</code> </p> </li> <li> <p> <code>security</code> </p> </li> <li> <p> <code>reliability</code> </p> </li> <li> <p> <code>cost optimization</code> </p> </li> <li> <p> <code>operational excellence</code> </p> </li> <li> <p> <code>sustainability</code> </p> </li> </ul>"""
    source: NotRequired["capo_rds.types.string.String"]
    """<p>The Amazon Web Services service that generated the recommendations.</p>"""
    type_detection: NotRequired["capo_rds.types.string.String"]
    """<p>A short description of the recommendation type. The description might contain markdown.</p>"""
    type_recommendation: NotRequired["capo_rds.types.string.String"]
    """<p>A short description that summarizes the recommendation to fix all the issues of the recommendation type. The description might contain markdown.</p>"""
    impact: NotRequired["capo_rds.types.string.String"]
    """<p>A short description that explains the possible impact of an issue.</p>"""
    additional_info: NotRequired["capo_rds.types.string.String"]
    """<p>Additional information about the recommendation. The information might contain markdown.</p>"""
    links: NotRequired["capo_rds.types.doc_link_list.DocLinkList"]
    """<p>A link to documentation that provides additional information about the recommendation.</p>"""
    issue_details: NotRequired["capo_rds.types.issue_details.IssueDetails"]
    """<p>Details of the issue that caused the recommendation.</p>"""

additional_info instance-attribute

additional_info: NotRequired[String]

Additional information about the recommendation. The information might contain markdown.

category instance-attribute

category: NotRequired[String]

The category of the recommendation.

Valid values:

  • performance efficiency

  • security

  • reliability

  • cost optimization

  • operational excellence

  • sustainability

created_time instance-attribute

created_time: NotRequired[TStamp]

The time when the recommendation was created. For example, 2023-09-28T01:13:53.931000+00:00.

description instance-attribute

description: NotRequired[String]

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

detection instance-attribute

detection: NotRequired[String]

A short description of the issue identified for this recommendation. The description might contain markdown.

impact instance-attribute

impact: NotRequired[String]

A short description that explains the possible impact of an issue.

issue_details instance-attribute

issue_details: NotRequired[IssueDetails]

Details of the issue that caused the recommendation.

links: NotRequired[DocLinkList]

A link to documentation that provides additional information about the recommendation.

reason instance-attribute

reason: NotRequired[String]

The reason why this recommendation was created. The information might contain markdown.

recommendation instance-attribute

recommendation: NotRequired[String]

A short description of the recommendation to resolve an issue. The description might contain markdown.

recommendation_id instance-attribute

recommendation_id: NotRequired[String]

The unique identifier of the recommendation.

recommended_actions instance-attribute

recommended_actions: NotRequired[RecommendedActionList]

A list of recommended actions.

resource_arn instance-attribute

resource_arn: NotRequired[String]

The Amazon Resource Name (ARN) of the RDS resource associated with the recommendation.

severity instance-attribute

severity: NotRequired[String]

The severity level of the recommendation. The severity level can help you decide the urgency with which to address the recommendation.

Valid values:

  • high

  • medium

  • low

  • informational

source instance-attribute

source: NotRequired[String]

The Amazon Web Services service that generated the recommendations.

status instance-attribute

status: NotRequired[String]

The current status of the recommendation.

Valid values:

  • active - The recommendations which are ready for you to apply.

  • pending - The applied or scheduled recommendations which are in progress.

  • resolved - The recommendations which are completed.

  • dismissed - The recommendations that you dismissed.

type_detection instance-attribute

type_detection: NotRequired[String]

A short description of the recommendation type. The description might contain markdown.

type_id instance-attribute

type_id: NotRequired[String]

A value that indicates the type of recommendation. This value determines how the description is rendered.

type_recommendation instance-attribute

type_recommendation: NotRequired[String]

A short description that summarizes the recommendation to fix all the issues of the recommendation type. The description might contain markdown.

updated_time instance-attribute

updated_time: NotRequired[TStamp]

The time when the recommendation was last updated.