aws_sdk_opensearch/client/
start_service_software_update.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 [`StartServiceSoftwareUpdate`](crate::operation::start_service_software_update::builders::StartServiceSoftwareUpdateFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`domain_name(impl Into<String>)`](crate::operation::start_service_software_update::builders::StartServiceSoftwareUpdateFluentBuilder::domain_name) / [`set_domain_name(Option<String>)`](crate::operation::start_service_software_update::builders::StartServiceSoftwareUpdateFluentBuilder::set_domain_name):<br>required: **true**<br><p>The name of the domain that you want to update to the latest service software.</p><br>
7    ///   - [`schedule_at(ScheduleAt)`](crate::operation::start_service_software_update::builders::StartServiceSoftwareUpdateFluentBuilder::schedule_at) / [`set_schedule_at(Option<ScheduleAt>)`](crate::operation::start_service_software_update::builders::StartServiceSoftwareUpdateFluentBuilder::set_schedule_at):<br>required: **false**<br><p>When to start the service software update.</p> <ul>  <li>   <p><code>NOW</code> - Immediately schedules the update to happen in the current hour if there's capacity available.</p></li>  <li>   <p><code>TIMESTAMP</code> - Lets you specify a custom date and time to apply the update. If you specify this value, you must also provide a value for <code>DesiredStartTime</code>.</p></li>  <li>   <p><code>OFF_PEAK_WINDOW</code> - Marks the update to be picked up during an upcoming off-peak window. There's no guarantee that the update will happen during the next immediate window. Depending on capacity, it might happen in subsequent days.</p></li> </ul> <p>Default: <code>NOW</code> if you don't specify a value for <code>DesiredStartTime</code>, and <code>TIMESTAMP</code> if you do.</p><br>
8    ///   - [`desired_start_time(i64)`](crate::operation::start_service_software_update::builders::StartServiceSoftwareUpdateFluentBuilder::desired_start_time) / [`set_desired_start_time(Option<i64>)`](crate::operation::start_service_software_update::builders::StartServiceSoftwareUpdateFluentBuilder::set_desired_start_time):<br>required: **false**<br><p>The Epoch timestamp when you want the service software update to start. You only need to specify this parameter if you set <code>ScheduleAt</code> to <code>TIMESTAMP</code>.</p><br>
9    /// - On success, responds with [`StartServiceSoftwareUpdateOutput`](crate::operation::start_service_software_update::StartServiceSoftwareUpdateOutput) with field(s):
10    ///   - [`service_software_options(Option<ServiceSoftwareOptions>)`](crate::operation::start_service_software_update::StartServiceSoftwareUpdateOutput::service_software_options): <p>The current status of the OpenSearch Service software update.</p>
11    /// - On failure, responds with [`SdkError<StartServiceSoftwareUpdateError>`](crate::operation::start_service_software_update::StartServiceSoftwareUpdateError)
12    pub fn start_service_software_update(
13        &self,
14    ) -> crate::operation::start_service_software_update::builders::StartServiceSoftwareUpdateFluentBuilder {
15        crate::operation::start_service_software_update::builders::StartServiceSoftwareUpdateFluentBuilder::new(self.handle.clone())
16    }
17}
aws_sdk_opensearch/client/start_service_software_update.rs

aws_sdk_opensearch/client/
start_service_software_update.rs
