aws_sdk_computeoptimizer/operation/get_recommendation_preferences/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::get_recommendation_preferences::_get_recommendation_preferences_output::GetRecommendationPreferencesOutputBuilder;
3
4pub use crate::operation::get_recommendation_preferences::_get_recommendation_preferences_input::GetRecommendationPreferencesInputBuilder;
5
6impl crate::operation::get_recommendation_preferences::builders::GetRecommendationPreferencesInputBuilder {
7    /// Sends a request with this input using the given client.
8    pub async fn send_with(
9        self,
10        client: &crate::Client,
11    ) -> ::std::result::Result<
12        crate::operation::get_recommendation_preferences::GetRecommendationPreferencesOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::get_recommendation_preferences::GetRecommendationPreferencesError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.get_recommendation_preferences();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `GetRecommendationPreferences`.
24///
25/// <p>Returns existing recommendation preferences, such as enhanced infrastructure metrics.</p>
26/// <p>Use the <code>scope</code> parameter to specify which preferences to return. You can specify to return preferences for an organization, a specific account ID, or a specific EC2 instance or Auto Scaling group Amazon Resource Name (ARN).</p>
27/// <p>For more information, see <a href="https://docs.aws.amazon.com/compute-optimizer/latest/ug/enhanced-infrastructure-metrics.html">Activating enhanced infrastructure metrics</a> in the <i>Compute Optimizer User Guide</i>.</p>
28#[derive(::std::clone::Clone, ::std::fmt::Debug)]
29pub struct GetRecommendationPreferencesFluentBuilder {
30    handle: ::std::sync::Arc<crate::client::Handle>,
31    inner: crate::operation::get_recommendation_preferences::builders::GetRecommendationPreferencesInputBuilder,
32    config_override: ::std::option::Option<crate::config::Builder>,
33}
34impl
35    crate::client::customize::internal::CustomizableSend<
36        crate::operation::get_recommendation_preferences::GetRecommendationPreferencesOutput,
37        crate::operation::get_recommendation_preferences::GetRecommendationPreferencesError,
38    > for GetRecommendationPreferencesFluentBuilder
39{
40    fn send(
41        self,
42        config_override: crate::config::Builder,
43    ) -> crate::client::customize::internal::BoxFuture<
44        crate::client::customize::internal::SendResult<
45            crate::operation::get_recommendation_preferences::GetRecommendationPreferencesOutput,
46            crate::operation::get_recommendation_preferences::GetRecommendationPreferencesError,
47        >,
48    > {
49        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
50    }
51}
52impl GetRecommendationPreferencesFluentBuilder {
53    /// Creates a new `GetRecommendationPreferencesFluentBuilder`.
54    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
55        Self {
56            handle,
57            inner: ::std::default::Default::default(),
58            config_override: ::std::option::Option::None,
59        }
60    }
61    /// Access the GetRecommendationPreferences as a reference.
62    pub fn as_input(&self) -> &crate::operation::get_recommendation_preferences::builders::GetRecommendationPreferencesInputBuilder {
63        &self.inner
64    }
65    /// Sends the request and returns the response.
66    ///
67    /// If an error occurs, an `SdkError` will be returned with additional details that
68    /// can be matched against.
69    ///
70    /// By default, any retryable failures will be retried twice. Retry behavior
71    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
72    /// set when configuring the client.
73    pub async fn send(
74        self,
75    ) -> ::std::result::Result<
76        crate::operation::get_recommendation_preferences::GetRecommendationPreferencesOutput,
77        ::aws_smithy_runtime_api::client::result::SdkError<
78            crate::operation::get_recommendation_preferences::GetRecommendationPreferencesError,
79            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
80        >,
81    > {
82        let input = self
83            .inner
84            .build()
85            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
86        let runtime_plugins = crate::operation::get_recommendation_preferences::GetRecommendationPreferences::operation_runtime_plugins(
87            self.handle.runtime_plugins.clone(),
88            &self.handle.conf,
89            self.config_override,
90        );
91        crate::operation::get_recommendation_preferences::GetRecommendationPreferences::orchestrate(&runtime_plugins, input).await
92    }
93
94    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
95    pub fn customize(
96        self,
97    ) -> crate::client::customize::CustomizableOperation<
98        crate::operation::get_recommendation_preferences::GetRecommendationPreferencesOutput,
99        crate::operation::get_recommendation_preferences::GetRecommendationPreferencesError,
100        Self,
101    > {
102        crate::client::customize::CustomizableOperation::new(self)
103    }
104    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
105        self.set_config_override(::std::option::Option::Some(config_override.into()));
106        self
107    }
108
109    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
110        self.config_override = config_override;
111        self
112    }
113    /// Create a paginator for this request
114    ///
115    /// Paginators are used by calling [`send().await`](crate::operation::get_recommendation_preferences::paginator::GetRecommendationPreferencesPaginator::send) which returns a [`PaginationStream`](aws_smithy_async::future::pagination_stream::PaginationStream).
116    pub fn into_paginator(self) -> crate::operation::get_recommendation_preferences::paginator::GetRecommendationPreferencesPaginator {
117        crate::operation::get_recommendation_preferences::paginator::GetRecommendationPreferencesPaginator::new(self.handle, self.inner)
118    }
119    /// <p>The target resource type of the recommendation preference for which to return preferences.</p>
120    /// <p>The <code>Ec2Instance</code> option encompasses standalone instances and instances that are part of Auto Scaling groups. The <code>AutoScalingGroup</code> option encompasses only instances that are part of an Auto Scaling group.</p>
121    pub fn resource_type(mut self, input: crate::types::ResourceType) -> Self {
122        self.inner = self.inner.resource_type(input);
123        self
124    }
125    /// <p>The target resource type of the recommendation preference for which to return preferences.</p>
126    /// <p>The <code>Ec2Instance</code> option encompasses standalone instances and instances that are part of Auto Scaling groups. The <code>AutoScalingGroup</code> option encompasses only instances that are part of an Auto Scaling group.</p>
127    pub fn set_resource_type(mut self, input: ::std::option::Option<crate::types::ResourceType>) -> Self {
128        self.inner = self.inner.set_resource_type(input);
129        self
130    }
131    /// <p>The target resource type of the recommendation preference for which to return preferences.</p>
132    /// <p>The <code>Ec2Instance</code> option encompasses standalone instances and instances that are part of Auto Scaling groups. The <code>AutoScalingGroup</code> option encompasses only instances that are part of an Auto Scaling group.</p>
133    pub fn get_resource_type(&self) -> &::std::option::Option<crate::types::ResourceType> {
134        self.inner.get_resource_type()
135    }
136    /// <p>An object that describes the scope of the recommendation preference to return.</p>
137    /// <p>You can return recommendation preferences that are created at the organization level (for management accounts of an organization only), account level, and resource level. For more information, see <a href="https://docs.aws.amazon.com/compute-optimizer/latest/ug/enhanced-infrastructure-metrics.html">Activating enhanced infrastructure metrics</a> in the <i>Compute Optimizer User Guide</i>.</p>
138    pub fn scope(mut self, input: crate::types::Scope) -> Self {
139        self.inner = self.inner.scope(input);
140        self
141    }
142    /// <p>An object that describes the scope of the recommendation preference to return.</p>
143    /// <p>You can return recommendation preferences that are created at the organization level (for management accounts of an organization only), account level, and resource level. For more information, see <a href="https://docs.aws.amazon.com/compute-optimizer/latest/ug/enhanced-infrastructure-metrics.html">Activating enhanced infrastructure metrics</a> in the <i>Compute Optimizer User Guide</i>.</p>
144    pub fn set_scope(mut self, input: ::std::option::Option<crate::types::Scope>) -> Self {
145        self.inner = self.inner.set_scope(input);
146        self
147    }
148    /// <p>An object that describes the scope of the recommendation preference to return.</p>
149    /// <p>You can return recommendation preferences that are created at the organization level (for management accounts of an organization only), account level, and resource level. For more information, see <a href="https://docs.aws.amazon.com/compute-optimizer/latest/ug/enhanced-infrastructure-metrics.html">Activating enhanced infrastructure metrics</a> in the <i>Compute Optimizer User Guide</i>.</p>
150    pub fn get_scope(&self) -> &::std::option::Option<crate::types::Scope> {
151        self.inner.get_scope()
152    }
153    /// <p>The token to advance to the next page of recommendation preferences.</p>
154    pub fn next_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
155        self.inner = self.inner.next_token(input.into());
156        self
157    }
158    /// <p>The token to advance to the next page of recommendation preferences.</p>
159    pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
160        self.inner = self.inner.set_next_token(input);
161        self
162    }
163    /// <p>The token to advance to the next page of recommendation preferences.</p>
164    pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
165        self.inner.get_next_token()
166    }
167    /// <p>The maximum number of recommendation preferences to return with a single request.</p>
168    /// <p>To retrieve the remaining results, make another request with the returned <code>nextToken</code> value.</p>
169    pub fn max_results(mut self, input: i32) -> Self {
170        self.inner = self.inner.max_results(input);
171        self
172    }
173    /// <p>The maximum number of recommendation preferences to return with a single request.</p>
174    /// <p>To retrieve the remaining results, make another request with the returned <code>nextToken</code> value.</p>
175    pub fn set_max_results(mut self, input: ::std::option::Option<i32>) -> Self {
176        self.inner = self.inner.set_max_results(input);
177        self
178    }
179    /// <p>The maximum number of recommendation preferences to return with a single request.</p>
180    /// <p>To retrieve the remaining results, make another request with the returned <code>nextToken</code> value.</p>
181    pub fn get_max_results(&self) -> &::std::option::Option<i32> {
182        self.inner.get_max_results()
183    }
184}