aws_sdk_computeoptimizer/client/
get_idle_recommendations.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 [`GetIdleRecommendations`](crate::operation::get_idle_recommendations::builders::GetIdleRecommendationsFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`resource_arns(impl Into<String>)`](crate::operation::get_idle_recommendations::builders::GetIdleRecommendationsFluentBuilder::resource_arns) / [`set_resource_arns(Option<Vec::<String>>)`](crate::operation::get_idle_recommendations::builders::GetIdleRecommendationsFluentBuilder::set_resource_arns):<br>required: **false**<br><p>The ARN that identifies the idle resource.</p><br>
7    ///   - [`next_token(impl Into<String>)`](crate::operation::get_idle_recommendations::builders::GetIdleRecommendationsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::get_idle_recommendations::builders::GetIdleRecommendationsFluentBuilder::set_next_token):<br>required: **false**<br><p>The token to advance to the next page of idle resource recommendations.</p><br>
8    ///   - [`max_results(i32)`](crate::operation::get_idle_recommendations::builders::GetIdleRecommendationsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::get_idle_recommendations::builders::GetIdleRecommendationsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of idle resource recommendations to return with a single request.</p> <p>To retrieve the remaining results, make another request with the returned <code>nextToken</code> value.</p><br>
9    ///   - [`filters(IdleRecommendationFilter)`](crate::operation::get_idle_recommendations::builders::GetIdleRecommendationsFluentBuilder::filters) / [`set_filters(Option<Vec::<IdleRecommendationFilter>>)`](crate::operation::get_idle_recommendations::builders::GetIdleRecommendationsFluentBuilder::set_filters):<br>required: **false**<br><p>An array of objects to specify a filter that returns a more specific list of idle resource recommendations.</p><br>
10    ///   - [`account_ids(impl Into<String>)`](crate::operation::get_idle_recommendations::builders::GetIdleRecommendationsFluentBuilder::account_ids) / [`set_account_ids(Option<Vec::<String>>)`](crate::operation::get_idle_recommendations::builders::GetIdleRecommendationsFluentBuilder::set_account_ids):<br>required: **false**<br><p>Return the idle resource recommendations to the specified Amazon Web Services account IDs.</p> <p>If your account is the management account or the delegated administrator of an organization, use this parameter to return the idle resource recommendations to specific member accounts.</p> <p>You can only specify one account ID per request.</p><br>
11    ///   - [`order_by(OrderBy)`](crate::operation::get_idle_recommendations::builders::GetIdleRecommendationsFluentBuilder::order_by) / [`set_order_by(Option<OrderBy>)`](crate::operation::get_idle_recommendations::builders::GetIdleRecommendationsFluentBuilder::set_order_by):<br>required: **false**<br><p>The order to sort the idle resource recommendations.</p><br>
12    /// - On success, responds with [`GetIdleRecommendationsOutput`](crate::operation::get_idle_recommendations::GetIdleRecommendationsOutput) with field(s):
13    ///   - [`next_token(Option<String>)`](crate::operation::get_idle_recommendations::GetIdleRecommendationsOutput::next_token): <p>The token to advance to the next page of idle resource recommendations.</p>
14    ///   - [`idle_recommendations(Option<Vec::<IdleRecommendation>>)`](crate::operation::get_idle_recommendations::GetIdleRecommendationsOutput::idle_recommendations): <p>An array of objects that describe the idle resource recommendations.</p>
15    ///   - [`errors(Option<Vec::<IdleRecommendationError>>)`](crate::operation::get_idle_recommendations::GetIdleRecommendationsOutput::errors): <p>An array of objects that describe errors of the request.</p>
16    /// - On failure, responds with [`SdkError<GetIdleRecommendationsError>`](crate::operation::get_idle_recommendations::GetIdleRecommendationsError)
17    pub fn get_idle_recommendations(&self) -> crate::operation::get_idle_recommendations::builders::GetIdleRecommendationsFluentBuilder {
18        crate::operation::get_idle_recommendations::builders::GetIdleRecommendationsFluentBuilder::new(self.handle.clone())
19    }
20}