Struct GetReservationPurchaseRecommendationInput

#[non_exhaustive]
pub struct GetReservationPurchaseRecommendationInput {
    pub account_id: Option<String>,
    pub service: Option<String>,
    pub filter: Option<Expression>,
    pub account_scope: Option<AccountScope>,
    pub lookback_period_in_days: Option<LookbackPeriodInDays>,
    pub term_in_years: Option<TermInYears>,
    pub payment_option: Option<PaymentOption>,
    pub service_specification: Option<ServiceSpecification>,
    pub page_size: Option<i32>,
    pub next_page_token: Option<String>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

account_id: Option<String>

The account ID that's associated with the recommendation.

service: Option<String>

The specific service that you want recommendations for.

filter: Option<Expression>

Use Expression to filter in various Cost Explorer APIs.

Not all Expression types are supported in each API. Refer to the documentation for each specific API to see what is supported.

There are two patterns:

• Simple dimension values.

  • There are three types of simple dimension values: CostCategories, Tags, and Dimensions.

    • Specify the CostCategories field to define a filter that acts on Cost Categories.

    • Specify the Tags field to define a filter that acts on Cost Allocation Tags.

    • Specify the Dimensions field to define a filter that acts on the DimensionValues .

  • For each filter type, you can set the dimension name and values for the filters that you plan to use.

    • For example, you can filter for REGION==us-east-1 OR REGION==us-west-1. For GetRightsizingRecommendation, the Region is a full name (for example, REGION==US East (N. Virginia).

    • The corresponding Expression for this example is as follows: { "Dimensions": { "Key": "REGION", "Values": \[ "us-east-1", "us-west-1" \] } }

    • As shown in the previous example, lists of dimension values are combined with OR when applying the filter.

  • You can also set different match options to further control how the filter behaves. Not all APIs support match options. Refer to the documentation for each specific API to see what is supported.

    • For example, you can filter for linked account names that start with "a".

    • The corresponding Expression for this example is as follows: { "Dimensions": { "Key": "LINKED_ACCOUNT_NAME", "MatchOptions": \[ "STARTS_WITH" \], "Values": \[ "a" \] } }

• Compound Expression types with logical operations.

  • You can use multiple Expression types and the logical operators AND/OR/NOT to create a list of one or more Expression objects. By doing this, you can filter by more advanced options.

  • For example, you can filter by ((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer).

  • The corresponding Expression for this example is as follows: { "And": \[ {"Or": \[ {"Dimensions": { "Key": "REGION", "Values": \[ "us-east-1", "us-west-1" \] }}, {"Tags": { "Key": "TagName", "Values": \["Value1"\] } } \]}, {"Not": {"Dimensions": { "Key": "USAGE_TYPE", "Values": \["DataTransfer"\] }}} \] }

  Because each Expression can have only one operator, the service returns an error if more than one is specified. The following example shows an Expression object that creates an error: { "And": \[ ... \], "Dimensions": { "Key": "USAGE_TYPE", "Values": \[ "DataTransfer" \] } }

  The following is an example of the corresponding error message: "Expression has more than one roots. Only one root operator is allowed for each expression: And, Or, Not, Dimensions, Tags, CostCategories"

For the GetRightsizingRecommendation action, a combination of OR and NOT isn't supported. OR isn't supported between different dimensions, or dimensions and tags. NOT operators aren't supported. Dimensions are also limited to LINKED_ACCOUNT, REGION, or RIGHTSIZING_TYPE.

For the GetReservationPurchaseRecommendation action, only NOT is supported. AND and OR aren't supported. Dimensions are limited to LINKED_ACCOUNT.

account_scope: Option<AccountScope>

The account scope that you want your recommendations for. Amazon Web Services calculates recommendations including the management account and member accounts if the value is set to PAYER. If the value is LINKED, recommendations are calculated for individual member accounts only.

lookback_period_in_days: Option<LookbackPeriodInDays>

The number of previous days that you want Amazon Web Services to consider when it calculates your recommendations.

term_in_years: Option<TermInYears>

The reservation term that you want recommendations for.

payment_option: Option<PaymentOption>

The reservation purchase option that you want recommendations for.

service_specification: Option<ServiceSpecification>

The hardware specifications for the service instances that you want recommendations for, such as standard or convertible Amazon EC2 instances.

page_size: Option<i32>

The number of recommendations that you want returned in a single response object.

next_page_token: Option<String>

The pagination token that indicates the next set of results that you want to retrieve.

Implementations

impl GetReservationPurchaseRecommendationInput

pub fn account_id(&self) -> Option<&str>

The account ID that's associated with the recommendation.

pub fn service(&self) -> Option<&str>

The specific service that you want recommendations for.

pub fn filter(&self) -> Option<&Expression>

Use Expression to filter in various Cost Explorer APIs.

Not all Expression types are supported in each API. Refer to the documentation for each specific API to see what is supported.

There are two patterns:

• Simple dimension values.

  • There are three types of simple dimension values: CostCategories, Tags, and Dimensions.

    • Specify the CostCategories field to define a filter that acts on Cost Categories.

    • Specify the Tags field to define a filter that acts on Cost Allocation Tags.

    • Specify the Dimensions field to define a filter that acts on the DimensionValues .

  • For each filter type, you can set the dimension name and values for the filters that you plan to use.

    • For example, you can filter for REGION==us-east-1 OR REGION==us-west-1. For GetRightsizingRecommendation, the Region is a full name (for example, REGION==US East (N. Virginia).

    • The corresponding Expression for this example is as follows: { "Dimensions": { "Key": "REGION", "Values": \[ "us-east-1", "us-west-1" \] } }

    • As shown in the previous example, lists of dimension values are combined with OR when applying the filter.

  • You can also set different match options to further control how the filter behaves. Not all APIs support match options. Refer to the documentation for each specific API to see what is supported.

    • For example, you can filter for linked account names that start with "a".

    • The corresponding Expression for this example is as follows: { "Dimensions": { "Key": "LINKED_ACCOUNT_NAME", "MatchOptions": \[ "STARTS_WITH" \], "Values": \[ "a" \] } }

• Compound Expression types with logical operations.

  • You can use multiple Expression types and the logical operators AND/OR/NOT to create a list of one or more Expression objects. By doing this, you can filter by more advanced options.

  • For example, you can filter by ((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer).

  • The corresponding Expression for this example is as follows: { "And": \[ {"Or": \[ {"Dimensions": { "Key": "REGION", "Values": \[ "us-east-1", "us-west-1" \] }}, {"Tags": { "Key": "TagName", "Values": \["Value1"\] } } \]}, {"Not": {"Dimensions": { "Key": "USAGE_TYPE", "Values": \["DataTransfer"\] }}} \] }

  Because each Expression can have only one operator, the service returns an error if more than one is specified. The following example shows an Expression object that creates an error: { "And": \[ ... \], "Dimensions": { "Key": "USAGE_TYPE", "Values": \[ "DataTransfer" \] } }

  The following is an example of the corresponding error message: "Expression has more than one roots. Only one root operator is allowed for each expression: And, Or, Not, Dimensions, Tags, CostCategories"

For the GetRightsizingRecommendation action, a combination of OR and NOT isn't supported. OR isn't supported between different dimensions, or dimensions and tags. NOT operators aren't supported. Dimensions are also limited to LINKED_ACCOUNT, REGION, or RIGHTSIZING_TYPE.

For the GetReservationPurchaseRecommendation action, only NOT is supported. AND and OR aren't supported. Dimensions are limited to LINKED_ACCOUNT.

pub fn account_scope(&self) -> Option<&AccountScope>

The account scope that you want your recommendations for. Amazon Web Services calculates recommendations including the management account and member accounts if the value is set to PAYER. If the value is LINKED, recommendations are calculated for individual member accounts only.

pub fn lookback_period_in_days(&self) -> Option<&LookbackPeriodInDays>

The number of previous days that you want Amazon Web Services to consider when it calculates your recommendations.

pub fn term_in_years(&self) -> Option<&TermInYears>

The reservation term that you want recommendations for.

pub fn payment_option(&self) -> Option<&PaymentOption>

The reservation purchase option that you want recommendations for.

pub fn service_specification(&self) -> Option<&ServiceSpecification>

The hardware specifications for the service instances that you want recommendations for, such as standard or convertible Amazon EC2 instances.

pub fn page_size(&self) -> Option<i32>

The number of recommendations that you want returned in a single response object.

pub fn next_page_token(&self) -> Option<&str>

The pagination token that indicates the next set of results that you want to retrieve.

impl GetReservationPurchaseRecommendationInput

pub fn builder() -> GetReservationPurchaseRecommendationInputBuilder

Creates a new builder-style object to manufacture GetReservationPurchaseRecommendationInput.

Trait Implementations

impl Clone for GetReservationPurchaseRecommendationInput

fn clone(&self) -> GetReservationPurchaseRecommendationInput

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GetReservationPurchaseRecommendationInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for GetReservationPurchaseRecommendationInput

fn eq(&self, other: &GetReservationPurchaseRecommendationInput) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for GetReservationPurchaseRecommendationInput