aws-sdk-computeoptimizer 1.102.0

AWS SDK for AWS Compute Optimizer
Documentation
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
#[allow(missing_docs)] // documentation missing in model
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct GetRecommendationPreferencesInput {
    /// <p>The target resource type of the recommendation preference for which to return preferences.</p>
    /// <p>The <code>Ec2Instance</code> option encompasses standalone instances and instances that are part of Amazon EC2 Auto Scaling groups. The <code>AutoScalingGroup</code> option encompasses only instances that are part of an Amazon EC2 Auto Scaling group.</p>
    pub resource_type: ::std::option::Option<crate::types::ResourceType>,
    /// <p>An object that describes the scope of the recommendation preference to return.</p>
    /// <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>
    pub scope: ::std::option::Option<crate::types::Scope>,
    /// <p>The token to advance to the next page of recommendation preferences.</p>
    pub next_token: ::std::option::Option<::std::string::String>,
    /// <p>The maximum number of recommendation preferences to return with a single request.</p>
    /// <p>To retrieve the remaining results, make another request with the returned <code>nextToken</code> value.</p>
    pub max_results: ::std::option::Option<i32>,
}
impl GetRecommendationPreferencesInput {
    /// <p>The target resource type of the recommendation preference for which to return preferences.</p>
    /// <p>The <code>Ec2Instance</code> option encompasses standalone instances and instances that are part of Amazon EC2 Auto Scaling groups. The <code>AutoScalingGroup</code> option encompasses only instances that are part of an Amazon EC2 Auto Scaling group.</p>
    pub fn resource_type(&self) -> ::std::option::Option<&crate::types::ResourceType> {
        self.resource_type.as_ref()
    }
    /// <p>An object that describes the scope of the recommendation preference to return.</p>
    /// <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>
    pub fn scope(&self) -> ::std::option::Option<&crate::types::Scope> {
        self.scope.as_ref()
    }
    /// <p>The token to advance to the next page of recommendation preferences.</p>
    pub fn next_token(&self) -> ::std::option::Option<&str> {
        self.next_token.as_deref()
    }
    /// <p>The maximum number of recommendation preferences to return with a single request.</p>
    /// <p>To retrieve the remaining results, make another request with the returned <code>nextToken</code> value.</p>
    pub fn max_results(&self) -> ::std::option::Option<i32> {
        self.max_results
    }
}
impl GetRecommendationPreferencesInput {
    /// Creates a new builder-style object to manufacture [`GetRecommendationPreferencesInput`](crate::operation::get_recommendation_preferences::GetRecommendationPreferencesInput).
    pub fn builder() -> crate::operation::get_recommendation_preferences::builders::GetRecommendationPreferencesInputBuilder {
        crate::operation::get_recommendation_preferences::builders::GetRecommendationPreferencesInputBuilder::default()
    }
}

/// A builder for [`GetRecommendationPreferencesInput`](crate::operation::get_recommendation_preferences::GetRecommendationPreferencesInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct GetRecommendationPreferencesInputBuilder {
    pub(crate) resource_type: ::std::option::Option<crate::types::ResourceType>,
    pub(crate) scope: ::std::option::Option<crate::types::Scope>,
    pub(crate) next_token: ::std::option::Option<::std::string::String>,
    pub(crate) max_results: ::std::option::Option<i32>,
}
impl GetRecommendationPreferencesInputBuilder {
    /// <p>The target resource type of the recommendation preference for which to return preferences.</p>
    /// <p>The <code>Ec2Instance</code> option encompasses standalone instances and instances that are part of Amazon EC2 Auto Scaling groups. The <code>AutoScalingGroup</code> option encompasses only instances that are part of an Amazon EC2 Auto Scaling group.</p>
    /// This field is required.
    pub fn resource_type(mut self, input: crate::types::ResourceType) -> Self {
        self.resource_type = ::std::option::Option::Some(input);
        self
    }
    /// <p>The target resource type of the recommendation preference for which to return preferences.</p>
    /// <p>The <code>Ec2Instance</code> option encompasses standalone instances and instances that are part of Amazon EC2 Auto Scaling groups. The <code>AutoScalingGroup</code> option encompasses only instances that are part of an Amazon EC2 Auto Scaling group.</p>
    pub fn set_resource_type(mut self, input: ::std::option::Option<crate::types::ResourceType>) -> Self {
        self.resource_type = input;
        self
    }
    /// <p>The target resource type of the recommendation preference for which to return preferences.</p>
    /// <p>The <code>Ec2Instance</code> option encompasses standalone instances and instances that are part of Amazon EC2 Auto Scaling groups. The <code>AutoScalingGroup</code> option encompasses only instances that are part of an Amazon EC2 Auto Scaling group.</p>
    pub fn get_resource_type(&self) -> &::std::option::Option<crate::types::ResourceType> {
        &self.resource_type
    }
    /// <p>An object that describes the scope of the recommendation preference to return.</p>
    /// <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>
    pub fn scope(mut self, input: crate::types::Scope) -> Self {
        self.scope = ::std::option::Option::Some(input);
        self
    }
    /// <p>An object that describes the scope of the recommendation preference to return.</p>
    /// <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>
    pub fn set_scope(mut self, input: ::std::option::Option<crate::types::Scope>) -> Self {
        self.scope = input;
        self
    }
    /// <p>An object that describes the scope of the recommendation preference to return.</p>
    /// <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>
    pub fn get_scope(&self) -> &::std::option::Option<crate::types::Scope> {
        &self.scope
    }
    /// <p>The token to advance to the next page of recommendation preferences.</p>
    pub fn next_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.next_token = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The token to advance to the next page of recommendation preferences.</p>
    pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.next_token = input;
        self
    }
    /// <p>The token to advance to the next page of recommendation preferences.</p>
    pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
        &self.next_token
    }
    /// <p>The maximum number of recommendation preferences to return with a single request.</p>
    /// <p>To retrieve the remaining results, make another request with the returned <code>nextToken</code> value.</p>
    pub fn max_results(mut self, input: i32) -> Self {
        self.max_results = ::std::option::Option::Some(input);
        self
    }
    /// <p>The maximum number of recommendation preferences to return with a single request.</p>
    /// <p>To retrieve the remaining results, make another request with the returned <code>nextToken</code> value.</p>
    pub fn set_max_results(mut self, input: ::std::option::Option<i32>) -> Self {
        self.max_results = input;
        self
    }
    /// <p>The maximum number of recommendation preferences to return with a single request.</p>
    /// <p>To retrieve the remaining results, make another request with the returned <code>nextToken</code> value.</p>
    pub fn get_max_results(&self) -> &::std::option::Option<i32> {
        &self.max_results
    }
    /// Consumes the builder and constructs a [`GetRecommendationPreferencesInput`](crate::operation::get_recommendation_preferences::GetRecommendationPreferencesInput).
    pub fn build(
        self,
    ) -> ::std::result::Result<
        crate::operation::get_recommendation_preferences::GetRecommendationPreferencesInput,
        ::aws_smithy_types::error::operation::BuildError,
    > {
        ::std::result::Result::Ok(crate::operation::get_recommendation_preferences::GetRecommendationPreferencesInput {
            resource_type: self.resource_type,
            scope: self.scope,
            next_token: self.next_token,
            max_results: self.max_results,
        })
    }
}