Struct GetReservationPurchaseRecommendationFluentBuilder

pub struct GetReservationPurchaseRecommendationFluentBuilder { /* private fields */ }

Fluent builder constructing a request to GetReservationPurchaseRecommendation.

Gets recommendations for reservation purchases. These recommendations might help you to reduce your costs. Reservations provide a discounted hourly rate (up to 75%) compared to On-Demand pricing.

Amazon Web Services generates your recommendations by identifying your On-Demand usage during a specific time period and collecting your usage into categories that are eligible for a reservation. After Amazon Web Services has these categories, it simulates every combination of reservations in each category of usage to identify the best number of each type of Reserved Instance (RI) to purchase to maximize your estimated savings.

For example, Amazon Web Services automatically aggregates your Amazon EC2 Linux, shared tenancy, and c4 family usage in the US West (Oregon) Region and recommends that you buy size-flexible regional reservations to apply to the c4 family usage. Amazon Web Services recommends the smallest size instance in an instance family. This makes it easier to purchase a size-flexible Reserved Instance (RI). Amazon Web Services also shows the equal number of normalized units. This way, you can purchase any instance size that you want. For this example, your RI recommendation is for c4.large because that is the smallest size instance in the c4 instance family.

Implementations

impl GetReservationPurchaseRecommendationFluentBuilder

pub fn as_input(&self) -> &GetReservationPurchaseRecommendationInputBuilder

Access the GetReservationPurchaseRecommendation as a reference.

pub async fn send( self, ) -> Result<GetReservationPurchaseRecommendationOutput, SdkError<GetReservationPurchaseRecommendationError, HttpResponse>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn customize( self, ) -> CustomizableOperation<GetReservationPurchaseRecommendationOutput, GetReservationPurchaseRecommendationError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

pub fn account_id(self, input: impl Into<String>) -> Self

The account ID that's associated with the recommendation.

pub fn set_account_id(self, input: Option<String>) -> Self

The account ID that's associated with the recommendation.

pub fn get_account_id(&self) -> &Option<String>

The account ID that's associated with the recommendation.

pub fn service(self, input: impl Into<String>) -> Self

The specific service that you want recommendations for.

pub fn set_service(self, input: Option<String>) -> Self

The specific service that you want recommendations for.

pub fn get_service(&self) -> &Option<String>

The specific service that you want recommendations for.

pub fn filter(self, input: Expression) -> Self

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 set_filter(self, input: Option<Expression>) -> Self

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 get_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, input: AccountScope) -> Self

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 set_account_scope(self, input: Option<AccountScope>) -> Self

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 get_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, input: LookbackPeriodInDays) -> Self

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

pub fn set_lookback_period_in_days( self, input: Option<LookbackPeriodInDays>, ) -> Self

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

pub fn get_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, input: TermInYears) -> Self

The reservation term that you want recommendations for.

pub fn set_term_in_years(self, input: Option<TermInYears>) -> Self

The reservation term that you want recommendations for.

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

The reservation term that you want recommendations for.

pub fn payment_option(self, input: PaymentOption) -> Self

The reservation purchase option that you want recommendations for.

pub fn set_payment_option(self, input: Option<PaymentOption>) -> Self

The reservation purchase option that you want recommendations for.

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

The reservation purchase option that you want recommendations for.

pub fn service_specification(self, input: ServiceSpecification) -> Self

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

pub fn set_service_specification( self, input: Option<ServiceSpecification>, ) -> Self

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

pub fn get_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, input: i32) -> Self

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

pub fn set_page_size(self, input: Option<i32>) -> Self

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

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

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

pub fn next_page_token(self, input: impl Into<String>) -> Self

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

pub fn set_next_page_token(self, input: Option<String>) -> Self

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

pub fn get_next_page_token(&self) -> &Option<String>

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

Trait Implementations

impl Clone for GetReservationPurchaseRecommendationFluentBuilder

fn clone(&self) -> GetReservationPurchaseRecommendationFluentBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GetReservationPurchaseRecommendationFluentBuilder

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

Formats the value using the given formatter.