Skip to content

UpgradeStepItem

Source code in docs_src/capo_opensearch/types/upgrade_step_item.py
class UpgradeStepItem(TypedDict, closed=True):
    upgrade_step: NotRequired["capo_opensearch.types.upgrade_step.UpgradeStep"]
    """<p> One of three steps that an upgrade or upgrade eligibility check goes through: </p> <ul> <li> <p>PreUpgradeCheck</p> </li> <li> <p>Snapshot</p> </li> <li> <p>Upgrade</p> </li> </ul>"""
    upgrade_step_status: NotRequired[
        "capo_opensearch.types.upgrade_status.UpgradeStatus"
    ]
    """<p> The current status of the upgrade. The status can take one of the following values: </p> <ul> <li> <p>In Progress</p> </li> <li> <p>Succeeded</p> </li> <li> <p>Succeeded with Issues</p> </li> <li> <p>Failed</p> </li> </ul>"""
    issues: NotRequired["capo_opensearch.types.issues.Issues"]
    """<p>A list of strings containing detailed information about the errors encountered in a particular step.</p>"""
    progress_percent: NotRequired["capo_opensearch.types.double.Double"]
    """<p>The floating point value representing the progress percentage of a particular step.</p>"""

issues instance-attribute

issues: NotRequired[Issues]

A list of strings containing detailed information about the errors encountered in a particular step.

progress_percent instance-attribute

progress_percent: NotRequired[Double]

The floating point value representing the progress percentage of a particular step.

upgrade_step instance-attribute

upgrade_step: NotRequired[UpgradeStep]

One of three steps that an upgrade or upgrade eligibility check goes through:

  • PreUpgradeCheck

  • Snapshot

  • Upgrade

upgrade_step_status instance-attribute

upgrade_step_status: NotRequired[UpgradeStatus]

The current status of the upgrade. The status can take one of the following values:

  • In Progress

  • Succeeded

  • Succeeded with Issues

  • Failed