Skip to content

GetUpgradeStatusResponse

Source code in docs_src/capo_elasticsearch_service/types/get_upgrade_status_response.py
class GetUpgradeStatusResponse(TypedDict, closed=True):
    upgrade_step: NotRequired[
        "capo_elasticsearch_service.types.upgrade_step.UpgradeStep"
    ]
    """<p> Represents one of 3 steps that an Upgrade or Upgrade Eligibility Check does through: <ul> <li>PreUpgradeCheck</li> <li>Snapshot</li> <li>Upgrade</li> </ul> </p>"""
    step_status: NotRequired[
        "capo_elasticsearch_service.types.upgrade_status.UpgradeStatus"
    ]
    """<p> One of 4 statuses that a step can go through returned as part of the <code> <a>GetUpgradeStatusResponse</a> </code> object. The status can take one of the following values: <ul> <li>In Progress</li> <li>Succeeded</li> <li>Succeeded with Issues</li> <li>Failed</li> </ul> </p>"""
    upgrade_name: NotRequired[
        "capo_elasticsearch_service.types.upgrade_name.UpgradeName"
    ]
    """<p>A string that describes the update briefly</p>"""

step_status instance-attribute

step_status: NotRequired[UpgradeStatus]

One of 4 statuses that a step can go through returned as part of the GetUpgradeStatusResponse object. The status can take one of the following values:

  • In Progress
  • Succeeded
  • Succeeded with Issues
  • Failed

upgrade_name instance-attribute

upgrade_name: NotRequired[UpgradeName]

A string that describes the update briefly

upgrade_step instance-attribute

upgrade_step: NotRequired[UpgradeStep]

Represents one of 3 steps that an Upgrade or Upgrade Eligibility Check does through:

  • PreUpgradeCheck
  • Snapshot
  • Upgrade