aws_sdk_opensearch/client/describe_dry_run_progress.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 [`DescribeDryRunProgress`](crate::operation::describe_dry_run_progress::builders::DescribeDryRunProgressFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`domain_name(impl Into<String>)`](crate::operation::describe_dry_run_progress::builders::DescribeDryRunProgressFluentBuilder::domain_name) / [`set_domain_name(Option<String>)`](crate::operation::describe_dry_run_progress::builders::DescribeDryRunProgressFluentBuilder::set_domain_name):<br>required: **true**<br><p>The name of the domain.</p><br>
7 /// - [`dry_run_id(impl Into<String>)`](crate::operation::describe_dry_run_progress::builders::DescribeDryRunProgressFluentBuilder::dry_run_id) / [`set_dry_run_id(Option<String>)`](crate::operation::describe_dry_run_progress::builders::DescribeDryRunProgressFluentBuilder::set_dry_run_id):<br>required: **false**<br><p>The unique identifier of the dry run.</p><br>
8 /// - [`load_dry_run_config(bool)`](crate::operation::describe_dry_run_progress::builders::DescribeDryRunProgressFluentBuilder::load_dry_run_config) / [`set_load_dry_run_config(Option<bool>)`](crate::operation::describe_dry_run_progress::builders::DescribeDryRunProgressFluentBuilder::set_load_dry_run_config):<br>required: **false**<br><p>Whether to include the configuration of the dry run in the response. The configuration specifies the updates that you're planning to make on the domain.</p><br>
9 /// - On success, responds with [`DescribeDryRunProgressOutput`](crate::operation::describe_dry_run_progress::DescribeDryRunProgressOutput) with field(s):
10 /// - [`dry_run_progress_status(Option<DryRunProgressStatus>)`](crate::operation::describe_dry_run_progress::DescribeDryRunProgressOutput::dry_run_progress_status): <p>The current status of the dry run, including any validation errors.</p>
11 /// - [`dry_run_config(Option<DomainStatus>)`](crate::operation::describe_dry_run_progress::DescribeDryRunProgressOutput::dry_run_config): <p>Details about the changes you're planning to make on the domain.</p>
12 /// - [`dry_run_results(Option<DryRunResults>)`](crate::operation::describe_dry_run_progress::DescribeDryRunProgressOutput::dry_run_results): <p>The results of the dry run.</p>
13 /// - On failure, responds with [`SdkError<DescribeDryRunProgressError>`](crate::operation::describe_dry_run_progress::DescribeDryRunProgressError)
14 pub fn describe_dry_run_progress(&self) -> crate::operation::describe_dry_run_progress::builders::DescribeDryRunProgressFluentBuilder {
15 crate::operation::describe_dry_run_progress::builders::DescribeDryRunProgressFluentBuilder::new(self.handle.clone())
16 }
17}