aws_sdk_opensearch/client/
get_upgrade_status.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`GetUpgradeStatus`](crate::operation::get_upgrade_status::builders::GetUpgradeStatusFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`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 domain of the domain to get upgrade status information for.</p><br>
7    /// - On success, responds with [`GetUpgradeStatusOutput`](crate::operation::get_upgrade_status::GetUpgradeStatusOutput) with field(s):
8    ///   - [`upgrade_step(Option<UpgradeStep>)`](crate::operation::get_upgrade_status::GetUpgradeStatusOutput::upgrade_step): <p>One of three steps that an upgrade or upgrade eligibility check goes through.</p>
9    ///   - [`step_status(Option<UpgradeStatus>)`](crate::operation::get_upgrade_status::GetUpgradeStatusOutput::step_status): <p>The status of the current step that an upgrade is on.</p>
10    ///   - [`upgrade_name(Option<String>)`](crate::operation::get_upgrade_status::GetUpgradeStatusOutput::upgrade_name): <p>A string that describes the update.</p>
11    /// - On failure, responds with [`SdkError<GetUpgradeStatusError>`](crate::operation::get_upgrade_status::GetUpgradeStatusError)
12    pub fn get_upgrade_status(&self) -> crate::operation::get_upgrade_status::builders::GetUpgradeStatusFluentBuilder {
13        crate::operation::get_upgrade_status::builders::GetUpgradeStatusFluentBuilder::new(self.handle.clone())
14    }
15}