aws_sdk_costoptimizationhub/client/
get_recommendation.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`GetRecommendation`](crate::operation::get_recommendation::builders::GetRecommendationFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`recommendation_id(impl Into<String>)`](crate::operation::get_recommendation::builders::GetRecommendationFluentBuilder::recommendation_id) / [`set_recommendation_id(Option<String>)`](crate::operation::get_recommendation::builders::GetRecommendationFluentBuilder::set_recommendation_id):<br>required: **true**<br><p>The ID for the recommendation.</p><br>
    /// - On success, responds with [`GetRecommendationOutput`](crate::operation::get_recommendation::GetRecommendationOutput) with field(s):
    ///   - [`recommendation_id(Option<String>)`](crate::operation::get_recommendation::GetRecommendationOutput::recommendation_id): <p>The ID for the recommendation.</p>
    ///   - [`resource_id(Option<String>)`](crate::operation::get_recommendation::GetRecommendationOutput::resource_id): <p>The unique identifier for the resource. This is the same as the Amazon Resource Name (ARN), if available.</p>
    ///   - [`resource_arn(Option<String>)`](crate::operation::get_recommendation::GetRecommendationOutput::resource_arn): <p>The Amazon Resource Name (ARN) of the resource.</p>
    ///   - [`account_id(Option<String>)`](crate::operation::get_recommendation::GetRecommendationOutput::account_id): <p>The account that the recommendation is for.</p>
    ///   - [`currency_code(Option<String>)`](crate::operation::get_recommendation::GetRecommendationOutput::currency_code): <p>The currency code used for the recommendation.</p>
    ///   - [`recommendation_lookback_period_in_days(Option<i32>)`](crate::operation::get_recommendation::GetRecommendationOutput::recommendation_lookback_period_in_days): <p>The lookback period that's used to generate the recommendation.</p>
    ///   - [`cost_calculation_lookback_period_in_days(Option<i32>)`](crate::operation::get_recommendation::GetRecommendationOutput::cost_calculation_lookback_period_in_days): <p>The lookback period used to calculate cost impact for a recommendation.</p>
    ///   - [`estimated_savings_percentage(Option<f64>)`](crate::operation::get_recommendation::GetRecommendationOutput::estimated_savings_percentage): <p>The estimated savings percentage relative to the total cost over the cost calculation lookback period.</p>
    ///   - [`estimated_savings_over_cost_calculation_lookback_period(Option<f64>)`](crate::operation::get_recommendation::GetRecommendationOutput::estimated_savings_over_cost_calculation_lookback_period): <p>The estimated savings amount over the lookback period used to calculate cost impact for a recommendation.</p>
    ///   - [`current_resource_type(Option<ResourceType>)`](crate::operation::get_recommendation::GetRecommendationOutput::current_resource_type): <p>The type of resource.</p>
    ///   - [`recommended_resource_type(Option<ResourceType>)`](crate::operation::get_recommendation::GetRecommendationOutput::recommended_resource_type): <p>The resource type of the recommendation.</p>
    ///   - [`region(Option<String>)`](crate::operation::get_recommendation::GetRecommendationOutput::region): <p>The Amazon Web Services Region of the resource.</p>
    ///   - [`source(Option<Source>)`](crate::operation::get_recommendation::GetRecommendationOutput::source): <p>The source of the recommendation.</p>
    ///   - [`last_refresh_timestamp(Option<DateTime>)`](crate::operation::get_recommendation::GetRecommendationOutput::last_refresh_timestamp): <p>The time when the recommendation was last generated.</p>
    ///   - [`estimated_monthly_savings(Option<f64>)`](crate::operation::get_recommendation::GetRecommendationOutput::estimated_monthly_savings): <p>The estimated monthly savings amount for the recommendation.</p>
    ///   - [`estimated_monthly_cost(Option<f64>)`](crate::operation::get_recommendation::GetRecommendationOutput::estimated_monthly_cost): <p>The estimated monthly cost of the current resource. For Reserved Instances and Savings Plans, it refers to the cost for eligible usage.</p>
    ///   - [`implementation_effort(Option<ImplementationEffort>)`](crate::operation::get_recommendation::GetRecommendationOutput::implementation_effort): <p>The effort required to implement the recommendation.</p>
    ///   - [`restart_needed(Option<bool>)`](crate::operation::get_recommendation::GetRecommendationOutput::restart_needed): <p>Whether or not implementing the recommendation requires a restart.</p>
    ///   - [`action_type(Option<ActionType>)`](crate::operation::get_recommendation::GetRecommendationOutput::action_type): <p>The type of action you can take by adopting the recommendation.</p>
    ///   - [`rollback_possible(Option<bool>)`](crate::operation::get_recommendation::GetRecommendationOutput::rollback_possible): <p>Whether or not implementing the recommendation can be rolled back.</p>
    ///   - [`current_resource_details(Option<ResourceDetails>)`](crate::operation::get_recommendation::GetRecommendationOutput::current_resource_details): <p>The details for the resource.</p>
    ///   - [`recommended_resource_details(Option<ResourceDetails>)`](crate::operation::get_recommendation::GetRecommendationOutput::recommended_resource_details): <p>The details about the recommended resource.</p>
    ///   - [`tags(Option<Vec::<Tag>>)`](crate::operation::get_recommendation::GetRecommendationOutput::tags): <p>A list of tags associated with the resource for which the recommendation exists.</p>
    /// - On failure, responds with [`SdkError<GetRecommendationError>`](crate::operation::get_recommendation::GetRecommendationError)
    pub fn get_recommendation(&self) -> crate::operation::get_recommendation::builders::GetRecommendationFluentBuilder {
        crate::operation::get_recommendation::builders::GetRecommendationFluentBuilder::new(self.handle.clone())
    }
}