1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`DescribeWhatIfAnalysis`](crate::operation::describe_what_if_analysis::builders::DescribeWhatIfAnalysisFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`what_if_analysis_arn(impl Into<String>)`](crate::operation::describe_what_if_analysis::builders::DescribeWhatIfAnalysisFluentBuilder::what_if_analysis_arn) / [`set_what_if_analysis_arn(Option<String>)`](crate::operation::describe_what_if_analysis::builders::DescribeWhatIfAnalysisFluentBuilder::set_what_if_analysis_arn):<br>required: **true**<br><p>The Amazon Resource Name (ARN) of the what-if analysis that you are interested in.</p><br>
    /// - On success, responds with [`DescribeWhatIfAnalysisOutput`](crate::operation::describe_what_if_analysis::DescribeWhatIfAnalysisOutput) with field(s):
    ///   - [`what_if_analysis_name(Option<String>)`](crate::operation::describe_what_if_analysis::DescribeWhatIfAnalysisOutput::what_if_analysis_name): <p>The name of the what-if analysis.</p>
    ///   - [`what_if_analysis_arn(Option<String>)`](crate::operation::describe_what_if_analysis::DescribeWhatIfAnalysisOutput::what_if_analysis_arn): <p>The Amazon Resource Name (ARN) of the what-if analysis.</p>
    ///   - [`forecast_arn(Option<String>)`](crate::operation::describe_what_if_analysis::DescribeWhatIfAnalysisOutput::forecast_arn): <p>The Amazon Resource Name (ARN) of the what-if forecast.</p>
    ///   - [`estimated_time_remaining_in_minutes(Option<i64>)`](crate::operation::describe_what_if_analysis::DescribeWhatIfAnalysisOutput::estimated_time_remaining_in_minutes): <p>The approximate time remaining to complete the what-if analysis, in minutes.</p>
    ///   - [`status(Option<String>)`](crate::operation::describe_what_if_analysis::DescribeWhatIfAnalysisOutput::status): <p>The status of the what-if analysis. States include:</p> <ul>  <li>   <p><code>ACTIVE</code></p></li>  <li>   <p><code>CREATE_PENDING</code>, <code>CREATE_IN_PROGRESS</code>, <code>CREATE_FAILED</code></p></li>  <li>   <p><code>CREATE_STOPPING</code>, <code>CREATE_STOPPED</code></p></li>  <li>   <p><code>DELETE_PENDING</code>, <code>DELETE_IN_PROGRESS</code>, <code>DELETE_FAILED</code></p></li> </ul><note>  <p>The <code>Status</code> of the what-if analysis must be <code>ACTIVE</code> before you can access the analysis.</p> </note>
    ///   - [`message(Option<String>)`](crate::operation::describe_what_if_analysis::DescribeWhatIfAnalysisOutput::message): <p>If an error occurred, an informational message about the error.</p>
    ///   - [`creation_time(Option<DateTime>)`](crate::operation::describe_what_if_analysis::DescribeWhatIfAnalysisOutput::creation_time): <p>When the what-if analysis was created.</p>
    ///   - [`last_modification_time(Option<DateTime>)`](crate::operation::describe_what_if_analysis::DescribeWhatIfAnalysisOutput::last_modification_time): <p>The last time the resource was modified. The timestamp depends on the status of the job:</p> <ul>  <li>   <p><code>CREATE_PENDING</code> - The <code>CreationTime</code>.</p></li>  <li>   <p><code>CREATE_IN_PROGRESS</code> - The current timestamp.</p></li>  <li>   <p><code>CREATE_STOPPING</code> - The current timestamp.</p></li>  <li>   <p><code>CREATE_STOPPED</code> - When the job stopped.</p></li>  <li>   <p><code>ACTIVE</code> or <code>CREATE_FAILED</code> - When the job finished or failed.</p></li> </ul>
    ///   - [`time_series_selector(Option<TimeSeriesSelector>)`](crate::operation::describe_what_if_analysis::DescribeWhatIfAnalysisOutput::time_series_selector): <p>Defines the set of time series that are used to create the forecasts in a <code>TimeSeriesIdentifiers</code> object.</p> <p>The <code>TimeSeriesIdentifiers</code> object needs the following information:</p> <ul>  <li>   <p><code>DataSource</code></p></li>  <li>   <p><code>Format</code></p></li>  <li>   <p><code>Schema</code></p></li> </ul>
    /// - On failure, responds with [`SdkError<DescribeWhatIfAnalysisError>`](crate::operation::describe_what_if_analysis::DescribeWhatIfAnalysisError)
    pub fn describe_what_if_analysis(&self) -> crate::operation::describe_what_if_analysis::builders::DescribeWhatIfAnalysisFluentBuilder {
        crate::operation::describe_what_if_analysis::builders::DescribeWhatIfAnalysisFluentBuilder::new(self.handle.clone())
    }
}