aws-sdk-forecast 1.101.0

AWS SDK for Amazon Forecast Service
Documentation
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`DescribeWhatIfForecastExport`](crate::operation::describe_what_if_forecast_export::builders::DescribeWhatIfForecastExportFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`what_if_forecast_export_arn(impl Into<String>)`](crate::operation::describe_what_if_forecast_export::builders::DescribeWhatIfForecastExportFluentBuilder::what_if_forecast_export_arn) / [`set_what_if_forecast_export_arn(Option<String>)`](crate::operation::describe_what_if_forecast_export::builders::DescribeWhatIfForecastExportFluentBuilder::set_what_if_forecast_export_arn):<br>required: **true**<br><p>The Amazon Resource Name (ARN) of the what-if forecast export that you are interested in.</p><br>
    /// - On success, responds with [`DescribeWhatIfForecastExportOutput`](crate::operation::describe_what_if_forecast_export::DescribeWhatIfForecastExportOutput) with field(s):
    ///   - [`what_if_forecast_export_arn(Option<String>)`](crate::operation::describe_what_if_forecast_export::DescribeWhatIfForecastExportOutput::what_if_forecast_export_arn): <p>The Amazon Resource Name (ARN) of the what-if forecast export.</p>
    ///   - [`what_if_forecast_export_name(Option<String>)`](crate::operation::describe_what_if_forecast_export::DescribeWhatIfForecastExportOutput::what_if_forecast_export_name): <p>The name of the what-if forecast export.</p>
    ///   - [`what_if_forecast_arns(Option<Vec::<String>>)`](crate::operation::describe_what_if_forecast_export::DescribeWhatIfForecastExportOutput::what_if_forecast_arns): <p>An array of Amazon Resource Names (ARNs) that represent all of the what-if forecasts exported in this resource.</p>
    ///   - [`destination(Option<DataDestination>)`](crate::operation::describe_what_if_forecast_export::DescribeWhatIfForecastExportOutput::destination): <p>The destination for an export job. Provide an S3 path, an Identity and Access Management (IAM) role that allows Amazon Forecast to access the location, and an Key Management Service (KMS) key (optional).</p>
    ///   - [`message(Option<String>)`](crate::operation::describe_what_if_forecast_export::DescribeWhatIfForecastExportOutput::message): <p>If an error occurred, an informational message about the error.</p>
    ///   - [`status(Option<String>)`](crate::operation::describe_what_if_forecast_export::DescribeWhatIfForecastExportOutput::status): <p>The status of the what-if forecast. 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 forecast export must be <code>ACTIVE</code> before you can access the forecast export.</p> </note>
    ///   - [`creation_time(Option<DateTime>)`](crate::operation::describe_what_if_forecast_export::DescribeWhatIfForecastExportOutput::creation_time): <p>When the what-if forecast export was created.</p>
    ///   - [`estimated_time_remaining_in_minutes(Option<i64>)`](crate::operation::describe_what_if_forecast_export::DescribeWhatIfForecastExportOutput::estimated_time_remaining_in_minutes): <p>The approximate time remaining to complete the what-if forecast export, in minutes.</p>
    ///   - [`last_modification_time(Option<DateTime>)`](crate::operation::describe_what_if_forecast_export::DescribeWhatIfForecastExportOutput::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>
    ///   - [`format(Option<String>)`](crate::operation::describe_what_if_forecast_export::DescribeWhatIfForecastExportOutput::format): <p>The format of the exported data, CSV or PARQUET.</p>
    /// - On failure, responds with [`SdkError<DescribeWhatIfForecastExportError>`](crate::operation::describe_what_if_forecast_export::DescribeWhatIfForecastExportError)
    pub fn describe_what_if_forecast_export(
        &self,
    ) -> crate::operation::describe_what_if_forecast_export::builders::DescribeWhatIfForecastExportFluentBuilder {
        crate::operation::describe_what_if_forecast_export::builders::DescribeWhatIfForecastExportFluentBuilder::new(self.handle.clone())
    }
}