aws_sdk_bcmpricingcalculator/client/
get_workload_estimate.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 [`GetWorkloadEstimate`](crate::operation::get_workload_estimate::builders::GetWorkloadEstimateFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`identifier(impl Into<String>)`](crate::operation::get_workload_estimate::builders::GetWorkloadEstimateFluentBuilder::identifier) / [`set_identifier(Option<String>)`](crate::operation::get_workload_estimate::builders::GetWorkloadEstimateFluentBuilder::set_identifier):<br>required: **true**<br><p>The unique identifier of the workload estimate to retrieve.</p><br>
7    /// - On success, responds with [`GetWorkloadEstimateOutput`](crate::operation::get_workload_estimate::GetWorkloadEstimateOutput) with field(s):
8    ///   - [`id(String)`](crate::operation::get_workload_estimate::GetWorkloadEstimateOutput::id): <p>The unique identifier of the retrieved workload estimate.</p>
9    ///   - [`name(Option<String>)`](crate::operation::get_workload_estimate::GetWorkloadEstimateOutput::name): <p>The name of the retrieved workload estimate.</p>
10    ///   - [`created_at(Option<DateTime>)`](crate::operation::get_workload_estimate::GetWorkloadEstimateOutput::created_at): <p>The timestamp when the workload estimate was created.</p>
11    ///   - [`expires_at(Option<DateTime>)`](crate::operation::get_workload_estimate::GetWorkloadEstimateOutput::expires_at): <p>The timestamp when the workload estimate will expire.</p>
12    ///   - [`rate_type(Option<WorkloadEstimateRateType>)`](crate::operation::get_workload_estimate::GetWorkloadEstimateOutput::rate_type): <p>The type of pricing rates used for the estimate.</p>
13    ///   - [`rate_timestamp(Option<DateTime>)`](crate::operation::get_workload_estimate::GetWorkloadEstimateOutput::rate_timestamp): <p>The timestamp of the pricing rates used for the estimate.</p>
14    ///   - [`status(Option<WorkloadEstimateStatus>)`](crate::operation::get_workload_estimate::GetWorkloadEstimateOutput::status): <p>The current status of the workload estimate.</p>
15    ///   - [`total_cost(Option<f64>)`](crate::operation::get_workload_estimate::GetWorkloadEstimateOutput::total_cost): <p>The total estimated cost for the workload.</p>
16    ///   - [`cost_currency(Option<CurrencyCode>)`](crate::operation::get_workload_estimate::GetWorkloadEstimateOutput::cost_currency): <p>The currency of the estimated cost.</p>
17    ///   - [`failure_message(Option<String>)`](crate::operation::get_workload_estimate::GetWorkloadEstimateOutput::failure_message): <p>An error message if the workload estimate retrieval failed.</p>
18    /// - On failure, responds with [`SdkError<GetWorkloadEstimateError>`](crate::operation::get_workload_estimate::GetWorkloadEstimateError)
19    pub fn get_workload_estimate(&self) -> crate::operation::get_workload_estimate::builders::GetWorkloadEstimateFluentBuilder {
20        crate::operation::get_workload_estimate::builders::GetWorkloadEstimateFluentBuilder::new(self.handle.clone())
21    }
22}