aws_sdk_computeoptimizer/client/
get_ec2_instance_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 [`GetEC2InstanceRecommendations`](crate::operation::get_ec2_instance_recommendations::builders::GetEC2InstanceRecommendationsFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`instance_arns(impl Into<String>)`](crate::operation::get_ec2_instance_recommendations::builders::GetEC2InstanceRecommendationsFluentBuilder::instance_arns) / [`set_instance_arns(Option<Vec::<String>>)`](crate::operation::get_ec2_instance_recommendations::builders::GetEC2InstanceRecommendationsFluentBuilder::set_instance_arns):<br>required: **false**<br><p>The Amazon Resource Name (ARN) of the instances for which to return recommendations.</p><br>
7    ///   - [`next_token(impl Into<String>)`](crate::operation::get_ec2_instance_recommendations::builders::GetEC2InstanceRecommendationsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::get_ec2_instance_recommendations::builders::GetEC2InstanceRecommendationsFluentBuilder::set_next_token):<br>required: **false**<br><p>The token to advance to the next page of instance recommendations.</p><br>
8    ///   - [`max_results(i32)`](crate::operation::get_ec2_instance_recommendations::builders::GetEC2InstanceRecommendationsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::get_ec2_instance_recommendations::builders::GetEC2InstanceRecommendationsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of instance 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(Filter)`](crate::operation::get_ec2_instance_recommendations::builders::GetEC2InstanceRecommendationsFluentBuilder::filters) / [`set_filters(Option<Vec::<Filter>>)`](crate::operation::get_ec2_instance_recommendations::builders::GetEC2InstanceRecommendationsFluentBuilder::set_filters):<br>required: **false**<br><p>An array of objects to specify a filter that returns a more specific list of instance recommendations.</p><br>
10    ///   - [`account_ids(impl Into<String>)`](crate::operation::get_ec2_instance_recommendations::builders::GetEC2InstanceRecommendationsFluentBuilder::account_ids) / [`set_account_ids(Option<Vec::<String>>)`](crate::operation::get_ec2_instance_recommendations::builders::GetEC2InstanceRecommendationsFluentBuilder::set_account_ids):<br>required: **false**<br><p>The ID of the Amazon Web Services account for which to return instance recommendations.</p> <p>If your account is the management account of an organization, use this parameter to specify the member account for which you want to return instance recommendations.</p> <p>Only one account ID can be specified per request.</p><br>
11    ///   - [`recommendation_preferences(RecommendationPreferences)`](crate::operation::get_ec2_instance_recommendations::builders::GetEC2InstanceRecommendationsFluentBuilder::recommendation_preferences) / [`set_recommendation_preferences(Option<RecommendationPreferences>)`](crate::operation::get_ec2_instance_recommendations::builders::GetEC2InstanceRecommendationsFluentBuilder::set_recommendation_preferences):<br>required: **false**<br><p>An object to specify the preferences for the Amazon EC2 instance recommendations to return in the response.</p><br>
12    /// - On success, responds with [`GetEc2InstanceRecommendationsOutput`](crate::operation::get_ec2_instance_recommendations::GetEc2InstanceRecommendationsOutput) with field(s):
13    ///   - [`next_token(Option<String>)`](crate::operation::get_ec2_instance_recommendations::GetEc2InstanceRecommendationsOutput::next_token): <p>The token to use to advance to the next page of instance recommendations.</p> <p>This value is null when there are no more pages of instance recommendations to return.</p>
14    ///   - [`instance_recommendations(Option<Vec::<InstanceRecommendation>>)`](crate::operation::get_ec2_instance_recommendations::GetEc2InstanceRecommendationsOutput::instance_recommendations): <p>An array of objects that describe instance recommendations.</p>
15    ///   - [`errors(Option<Vec::<GetRecommendationError>>)`](crate::operation::get_ec2_instance_recommendations::GetEc2InstanceRecommendationsOutput::errors): <p>An array of objects that describe errors of the request.</p> <p>For example, an error is returned if you request recommendations for an instance of an unsupported instance family.</p>
16    /// - On failure, responds with [`SdkError<GetEC2InstanceRecommendationsError>`](crate::operation::get_ec2_instance_recommendations::GetEC2InstanceRecommendationsError)
17    pub fn get_ec2_instance_recommendations(
18        &self,
19    ) -> crate::operation::get_ec2_instance_recommendations::builders::GetEC2InstanceRecommendationsFluentBuilder {
20        crate::operation::get_ec2_instance_recommendations::builders::GetEC2InstanceRecommendationsFluentBuilder::new(self.handle.clone())
21    }
22}
aws_sdk_computeoptimizer/client/get_ec2_instance_recommendations.rs

aws_sdk_computeoptimizer/client/
get_ec2_instance_recommendations.rs
