aws_sdk_elasticsearch/client/

get_upgrade_status.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`GetUpgradeStatus`](crate::operation::get_upgrade_status::builders::GetUpgradeStatusFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`domain_name(impl Into<String>)`](crate::operation::get_upgrade_status::builders::GetUpgradeStatusFluentBuilder::domain_name) / [`set_domain_name(Option<String>)`](crate::operation::get_upgrade_status::builders::GetUpgradeStatusFluentBuilder::set_domain_name):<br>required: **true**<br><p>The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).</p><br>
    /// - On success, responds with [`GetUpgradeStatusOutput`](crate::operation::get_upgrade_status::GetUpgradeStatusOutput) with field(s):
    ///   - [`upgrade_step(Option<UpgradeStep>)`](crate::operation::get_upgrade_status::GetUpgradeStatusOutput::upgrade_step): <p>Represents one of 3 steps that an Upgrade or Upgrade Eligibility Check does through:</p> <ul>  <li>PreUpgradeCheck</li>  <li>Snapshot</li>  <li>Upgrade</li> </ul> <p></p>
    ///   - [`step_status(Option<UpgradeStatus>)`](crate::operation::get_upgrade_status::GetUpgradeStatusOutput::step_status): <p>One of 4 statuses that a step can go through returned as part of the <code> <code>GetUpgradeStatusResponse</code> </code> object. The status can take one of the following values:</p> <ul>  <li>In Progress</li>  <li>Succeeded</li>  <li>Succeeded with Issues</li>  <li>Failed</li> </ul> <p></p>
    ///   - [`upgrade_name(Option<String>)`](crate::operation::get_upgrade_status::GetUpgradeStatusOutput::upgrade_name): <p>A string that describes the update briefly</p>
    /// - On failure, responds with [`SdkError<GetUpgradeStatusError>`](crate::operation::get_upgrade_status::GetUpgradeStatusError)
    pub fn get_upgrade_status(&self) -> crate::operation::get_upgrade_status::builders::GetUpgradeStatusFluentBuilder {
        crate::operation::get_upgrade_status::builders::GetUpgradeStatusFluentBuilder::new(self.handle.clone())
    }
}