Struct aws_sdk_costexplorer::Client

source · [−]

pub struct Client { /* private fields */ }

Expand description

Client for AWS Cost Explorer Service

Client for invoking operations on AWS Cost Explorer Service. Each operation on AWS Cost Explorer Service is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Examples

Constructing a client and invoking an operation

    // create a shared configuration. This can be used & shared between multiple service clients.
    let shared_config = aws_config::load_from_env().await;
    let client = aws_sdk_costexplorer::Client::new(&shared_config);
    // invoke an operation
    /* let rsp = client
        .<operation_name>().
        .<param>("some value")
        .send().await; */

Constructing a client with custom configuration

use aws_config::RetryConfig;
    let shared_config = aws_config::load_from_env().await;
    let config = aws_sdk_costexplorer::config::Builder::from(&shared_config)
        .retry_config(RetryConfig::disabled())
        .build();
    let client = aws_sdk_costexplorer::Client::from_conf(config);

Implementations

source

impl Client

source

pub fn with_config(
client: Client<DynConnector, DynMiddleware<DynConnector>>,
conf: Config
) -> Self

Creates a client with the given service configuration.

source

pub fn conf(&self) -> &Config

Returns the client’s configuration.

source

impl Client

source

pub fn create_anomaly_monitor(&self) -> CreateAnomalyMonitor

Constructs a fluent builder for the CreateAnomalyMonitor operation.

The fluent builder is configurable:
- anomaly_monitor(AnomalyMonitor) / set_anomaly_monitor(Option<AnomalyMonitor>):
 The cost anomaly detection monitor object that you want to create.
On success, responds with CreateAnomalyMonitorOutput with field(s):
- monitor_arn(Option<String>):
 The unique identifier of your newly created cost anomaly detection monitor.
On failure, responds with SdkError<CreateAnomalyMonitorError>

source

pub fn create_anomaly_subscription(&self) -> CreateAnomalySubscription

Constructs a fluent builder for the CreateAnomalySubscription operation.

The fluent builder is configurable:
- anomaly_subscription(AnomalySubscription) / set_anomaly_subscription(Option<AnomalySubscription>):
 The cost anomaly subscription object that you want to create.
On success, responds with CreateAnomalySubscriptionOutput with field(s):
- subscription_arn(Option<String>):
 The unique identifier of your newly created cost anomaly subscription.
On failure, responds with SdkError<CreateAnomalySubscriptionError>

source

pub fn create_cost_category_definition(&self) -> CreateCostCategoryDefinition

Constructs a fluent builder for the CreateCostCategoryDefinition operation.

The fluent builder is configurable:
- name(impl Into<String>) / set_name(Option<String>):
 The unique name of the Cost Category.
- rule_version(CostCategoryRuleVersion) / set_rule_version(Option<CostCategoryRuleVersion>):
 The rule schema version in this particular Cost Category.
- rules(Vec<CostCategoryRule>) / set_rules(Option<Vec<CostCategoryRule>>):
 The Cost Category rules used to categorize costs. For more information, see CostCategoryRule.
- default_value(impl Into<String>) / set_default_value(Option<String>):
 The default value for the cost category.
- split_charge_rules(Vec<CostCategorySplitChargeRule>) / set_split_charge_rules(Option<Vec<CostCategorySplitChargeRule>>):
 The split charge rules used to allocate your charges between your Cost Category values.
On success, responds with CreateCostCategoryDefinitionOutput with field(s):
- cost_category_arn(Option<String>):
 The unique identifier for your newly created Cost Category.
- effective_start(Option<String>):
 The Cost Category’s effective start date.
On failure, responds with SdkError<CreateCostCategoryDefinitionError>

source

pub fn delete_anomaly_monitor(&self) -> DeleteAnomalyMonitor

Constructs a fluent builder for the DeleteAnomalyMonitor operation.

The fluent builder is configurable:
- monitor_arn(impl Into<String>) / set_monitor_arn(Option<String>):
 The unique identifier of the cost anomaly monitor that you want to delete.
On success, responds with DeleteAnomalyMonitorOutput
On failure, responds with SdkError<DeleteAnomalyMonitorError>

source

pub fn delete_anomaly_subscription(&self) -> DeleteAnomalySubscription

Constructs a fluent builder for the DeleteAnomalySubscription operation.

The fluent builder is configurable:
- subscription_arn(impl Into<String>) / set_subscription_arn(Option<String>):
 The unique identifier of the cost anomaly subscription that you want to delete.
On success, responds with DeleteAnomalySubscriptionOutput
On failure, responds with SdkError<DeleteAnomalySubscriptionError>

source

pub fn delete_cost_category_definition(&self) -> DeleteCostCategoryDefinition

Constructs a fluent builder for the DeleteCostCategoryDefinition operation.

The fluent builder is configurable:
- cost_category_arn(impl Into<String>) / set_cost_category_arn(Option<String>):
 The unique identifier for your Cost Category.
On success, responds with DeleteCostCategoryDefinitionOutput with field(s):
- cost_category_arn(Option<String>):
 The unique identifier for your Cost Category.
- effective_end(Option<String>):
 The effective end date of the Cost Category as a result of deleting it. No costs after this date will be categorized by the deleted Cost Category.
On failure, responds with SdkError<DeleteCostCategoryDefinitionError>

source

pub fn describe_cost_category_definition(
&self
) -> DescribeCostCategoryDefinition

Constructs a fluent builder for the DescribeCostCategoryDefinition operation.

The fluent builder is configurable:
- cost_category_arn(impl Into<String>) / set_cost_category_arn(Option<String>):
 The unique identifier for your Cost Category.
- effective_on(impl Into<String>) / set_effective_on(Option<String>):
 The date when the Cost Category was effective.
On success, responds with DescribeCostCategoryDefinitionOutput with field(s):
- cost_category(Option<CostCategory>):
 The structure of Cost Categories. This includes detailed metadata and the set of rules for the CostCategory object.
On failure, responds with SdkError<DescribeCostCategoryDefinitionError>

source

pub fn get_anomalies(&self) -> GetAnomalies

Constructs a fluent builder for the GetAnomalies operation.

The fluent builder is configurable:
- monitor_arn(impl Into<String>) / set_monitor_arn(Option<String>):
 Retrieves all of the cost anomalies detected for a specific cost anomaly monitor Amazon Resource Name (ARN).
- date_interval(AnomalyDateInterval) / set_date_interval(Option<AnomalyDateInterval>):
 Assigns the start and end dates for retrieving cost anomalies. The returned anomaly object will have an AnomalyEndDate in the specified time range.
- feedback(AnomalyFeedbackType) / set_feedback(Option<AnomalyFeedbackType>):
 Filters anomaly results by the feedback field on the anomaly object.
- total_impact(TotalImpactFilter) / set_total_impact(Option<TotalImpactFilter>):
 Filters anomaly results by the total impact field on the anomaly object. For example, you can filter anomalies GREATER_THAN 200.00 to retrieve anomalies, with an estimated dollar impact greater than 200.
- next_page_token(impl Into<String>) / set_next_page_token(Option<String>):
 The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.
- max_results(i32) / set_max_results(Option<i32>):
 The number of entries a paginated response contains.
On success, responds with GetAnomaliesOutput with field(s):
- anomalies(Option<Vec<Anomaly>>):
 A list of cost anomalies.
- next_page_token(Option<String>):
 The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.
On failure, responds with SdkError<GetAnomaliesError>

source

pub fn get_anomaly_monitors(&self) -> GetAnomalyMonitors

Constructs a fluent builder for the GetAnomalyMonitors operation.

The fluent builder is configurable:
- monitor_arn_list(Vec<String>) / set_monitor_arn_list(Option<Vec<String>>):
 A list of cost anomaly monitor ARNs.
- next_page_token(impl Into<String>) / set_next_page_token(Option<String>):
 The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.
- max_results(i32) / set_max_results(Option<i32>):
 The number of entries that a paginated response contains.
On success, responds with GetAnomalyMonitorsOutput with field(s):
- anomaly_monitors(Option<Vec<AnomalyMonitor>>):
 A list of cost anomaly monitors that includes the detailed metadata for each monitor.
- next_page_token(Option<String>):
 The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.
On failure, responds with SdkError<GetAnomalyMonitorsError>

source

pub fn get_anomaly_subscriptions(&self) -> GetAnomalySubscriptions

Constructs a fluent builder for the GetAnomalySubscriptions operation.

The fluent builder is configurable:
- subscription_arn_list(Vec<String>) / set_subscription_arn_list(Option<Vec<String>>):
 A list of cost anomaly subscription ARNs.
- monitor_arn(impl Into<String>) / set_monitor_arn(Option<String>):
 Cost anomaly monitor ARNs.
- next_page_token(impl Into<String>) / set_next_page_token(Option<String>):
 The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.
- max_results(i32) / set_max_results(Option<i32>):
 The number of entries a paginated response contains.
On success, responds with GetAnomalySubscriptionsOutput with field(s):
- anomaly_subscriptions(Option<Vec<AnomalySubscription>>):
 A list of cost anomaly subscriptions that includes the detailed metadata for each one.
- next_page_token(Option<String>):
 The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.
On failure, responds with SdkError<GetAnomalySubscriptionsError>

source

pub fn get_cost_and_usage(&self) -> GetCostAndUsage

Constructs a fluent builder for the GetCostAndUsage operation.

The fluent builder is configurable:
- time_period(DateInterval) / set_time_period(Option<DateInterval>):
 Sets the start date and end date for retrieving Amazon Web Services costs. The start date is inclusive, but the end date is exclusive. For example, if start is 2017-01-01 and end is 2017-05-01, then the cost and usage data is retrieved from 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01.
- granularity(Granularity) / set_granularity(Option<Granularity>):
 Sets the Amazon Web Services cost granularity to MONTHLY or DAILY, or HOURLY. If Granularity isn’t set, the response object doesn’t include the Granularity, either MONTHLY or DAILY, or HOURLY.
- filter(Expression) / set_filter(Option<Expression>):
 Filters Amazon Web Services costs by different dimensions. For example, you can specify SERVICE and LINKED_ACCOUNT and get the costs that are associated with that account’s usage of that service. You can nest Expression objects to define any combination of dimension filters. For more information, see Expression.
 
 Valid values for MatchOptions for CostCategories and Tags are EQUALS, ABSENT, and CASE_SENSITIVE.
 
 The default values are EQUALS and CASE_SENSITIVE. Valid values for MatchOptions for Dimensions are EQUALS and CASE_SENSITIVE.
- metrics(Vec<String>) / set_metrics(Option<Vec<String>>):
 Which metrics are returned in the query. For more information about blended and unblended rates, see Why does the “blended” annotation appear on some line items in my bill?.
 
 Valid values are AmortizedCost, BlendedCost, NetAmortizedCost, NetUnblendedCost, NormalizedUsageAmount, UnblendedCost, and UsageQuantity.
 
 If you return the UsageQuantity metric, the service aggregates all usage numbers without taking into account the units. For example, if you aggregate usageQuantity across all of Amazon EC2, the results aren’t meaningful because Amazon EC2 compute hours and data transfer are measured in different units (for example, hours and GB). To get more meaningful UsageQuantity metrics, filter by UsageType or UsageTypeGroups.
 
 Metrics is required for GetCostAndUsage requests.
- group_by(Vec<GroupDefinition>) / set_group_by(Option<Vec<GroupDefinition>>):
 You can group Amazon Web Services costs using up to two different groups, either dimensions, tag keys, cost categories, or any two group by types.
 
 Valid values for the DIMENSION type are AZ, INSTANCE_TYPE, LEGAL_ENTITY_NAME, INVOICING_ENTITY, LINKED_ACCOUNT, OPERATION, PLATFORM, PURCHASE_TYPE, SERVICE, TENANCY, RECORD_TYPE, and USAGE_TYPE.
 
 When you group by the TAG type and include a valid tag key, you get all tag values, including empty strings.
- next_page_token(impl Into<String>) / set_next_page_token(Option<String>):
 The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.
On success, responds with GetCostAndUsageOutput with field(s):
- next_page_token(Option<String>):
 The token for the next set of retrievable results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.
- group_definitions(Option<Vec<GroupDefinition>>):
 The groups that are specified by the Filter or GroupBy parameters in the request.
- results_by_time(Option<Vec<ResultByTime>>):
 The time period that’s covered by the results in the response.
- dimension_value_attributes(Option<Vec<DimensionValuesWithAttributes>>):
 The attributes that apply to a specific dimension value. For example, if the value is a linked account, the attribute is that account name.
On failure, responds with SdkError<GetCostAndUsageError>

source

pub fn get_cost_and_usage_with_resources(&self) -> GetCostAndUsageWithResources

Constructs a fluent builder for the GetCostAndUsageWithResources operation.

The fluent builder is configurable:
- time_period(DateInterval) / set_time_period(Option<DateInterval>):
 Sets the start and end dates for retrieving Amazon Web Services costs. The range must be within the last 14 days (the start date cannot be earlier than 14 days ago). The start date is inclusive, but the end date is exclusive. For example, if start is 2017-01-01 and end is 2017-05-01, then the cost and usage data is retrieved from 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01.
- granularity(Granularity) / set_granularity(Option<Granularity>):
 Sets the Amazon Web Services cost granularity to MONTHLY, DAILY, or HOURLY. If Granularity isn’t set, the response object doesn’t include the Granularity, MONTHLY, DAILY, or HOURLY.
- filter(Expression) / set_filter(Option<Expression>):
 Filters Amazon Web Services costs by different dimensions. For example, you can specify SERVICE and LINKED_ACCOUNT and get the costs that are associated with that account’s usage of that service. You can nest Expression objects to define any combination of dimension filters. For more information, see Expression.
 
 The GetCostAndUsageWithResources operation requires that you either group by or filter by a ResourceId. It requires the Expression “SERVICE = Amazon Elastic Compute Cloud - Compute” in the filter.
 
 Valid values for MatchOptions for CostCategories and Tags are EQUALS, ABSENT, and CASE_SENSITIVE.
 
 The default values are EQUALS and CASE_SENSITIVE. Valid values for MatchOptions for Dimensions are EQUALS and CASE_SENSITIVE.
- metrics(Vec<String>) / set_metrics(Option<Vec<String>>):
 Which metrics are returned in the query. For more information about blended and unblended rates, see Why does the “blended” annotation appear on some line items in my bill?.
 
 Valid values are AmortizedCost, BlendedCost, NetAmortizedCost, NetUnblendedCost, NormalizedUsageAmount, UnblendedCost, and UsageQuantity.
 
 If you return the UsageQuantity metric, the service aggregates all usage numbers without taking the units into account. For example, if you aggregate usageQuantity across all of Amazon EC2, the results aren’t meaningful because Amazon EC2 compute hours and data transfer are measured in different units (for example, hours vs. GB). To get more meaningful UsageQuantity metrics, filter by UsageType or UsageTypeGroups.
 
 Metrics is required for GetCostAndUsageWithResources requests.
- group_by(Vec<GroupDefinition>) / set_group_by(Option<Vec<GroupDefinition>>):
 You can group Amazon Web Services costs using up to two different groups: DIMENSION, TAG, COST_CATEGORY.
- next_page_token(impl Into<String>) / set_next_page_token(Option<String>):
 The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.
On success, responds with GetCostAndUsageWithResourcesOutput with field(s):
- next_page_token(Option<String>):
 The token for the next set of retrievable results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.
- group_definitions(Option<Vec<GroupDefinition>>):
 The groups that are specified by the Filter or GroupBy parameters in the request.
- results_by_time(Option<Vec<ResultByTime>>):
 The time period that is covered by the results in the response.
- dimension_value_attributes(Option<Vec<DimensionValuesWithAttributes>>):
 The attributes that apply to a specific dimension value. For example, if the value is a linked account, the attribute is that account name.
On failure, responds with SdkError<GetCostAndUsageWithResourcesError>

source

pub fn get_cost_categories(&self) -> GetCostCategories

Constructs a fluent builder for the GetCostCategories operation.

The fluent builder is configurable:
- search_string(impl Into<String>) / set_search_string(Option<String>):
 The value that you want to search the filter values for.
 
 If you do not specify a CostCategoryName, SearchString will be used to filter Cost Category names that match the SearchString pattern. If you do specifiy a CostCategoryName, SearchString will be used to filter Cost Category values that match the SearchString pattern.
- time_period(DateInterval) / set_time_period(Option<DateInterval>):
 The time period of the request.
- cost_category_name(impl Into<String>) / set_cost_category_name(Option<String>):
 The unique name of the Cost Category.
- filter(Expression) / set_filter(Option<Expression>):
 Use Expression to filter by cost or by usage. There are two patterns:
 - Simple dimension values - 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 Expression example is as follows:
 
 { “Dimensions”: { “Key”: “REGION”, “Values”: [ “us-east-1”, “us-west-1” ] } }
 
 The list of dimension values are OR’d together to retrieve cost or usage data. You can create Expression and DimensionValues objects using either with* methods or set* methods in multiple lines.
 - Compound dimension values 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 on more advanced options. For example, you can filter on ((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer). The Expression for that 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”: [ … ], “DimensionValues”: { “Dimension”: “USAGE_TYPE”, “Values”: [ “DataTransfer” ] } }
 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.
- sort_by(Vec<SortDefinition>) / set_sort_by(Option<Vec<SortDefinition>>):
 The value by which you want to sort the data.
 
 The key represents cost and usage metrics. The following values are supported:
 - BlendedCost
 - UnblendedCost
 - AmortizedCost
 - NetAmortizedCost
 - NetUnblendedCost
 - UsageQuantity
 - NormalizedUsageAmount
 Supported values for SortOrder are ASCENDING or DESCENDING.
 
 When using SortBy, NextPageToken and SearchString are not supported.
- max_results(i32) / set_max_results(i32):
 This field is only used when SortBy is provided in the request.
 
 The maximum number of objects that to be returned for this request. If MaxResults is not specified with SortBy, the request will return 1000 results as the default value for this parameter.
 
 For GetCostCategories, MaxResults has an upper limit of 1000.
- next_page_token(impl Into<String>) / set_next_page_token(Option<String>):
 If the number of objects that are still available for retrieval exceeds the limit, Amazon Web Services returns a NextPageToken value in the response. To retrieve the next batch of objects, provide the NextPageToken from the prior call in your next request.
On success, responds with GetCostCategoriesOutput with field(s):
- next_page_token(Option<String>):
 If the number of objects that are still available for retrieval exceeds the limit, Amazon Web Services returns a NextPageToken value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
- cost_category_names(Option<Vec<String>>):
 The names of the Cost Categories.
- cost_category_values(Option<Vec<String>>):
 The Cost Category values.
 
 CostCategoryValues are not returned if CostCategoryName is not specified in the request.
- return_size(Option<i32>):
 The number of objects returned.
- total_size(Option<i32>):
 The total number of objects.
On failure, responds with SdkError<GetCostCategoriesError>

source

pub fn get_cost_forecast(&self) -> GetCostForecast

Constructs a fluent builder for the GetCostForecast operation.

The fluent builder is configurable:
- time_period(DateInterval) / set_time_period(Option<DateInterval>):
 The period of time that you want the forecast to cover. The start date must be equal to or no later than the current date to avoid a validation error.
- metric(Metric) / set_metric(Option<Metric>):
 Which metric Cost Explorer uses to create your forecast. For more information about blended and unblended rates, see Why does the “blended” annotation appear on some line items in my bill?.
 
 Valid values for a GetCostForecast call are the following:
 - AMORTIZED_COST
 - BLENDED_COST
 - NET_AMORTIZED_COST
 - NET_UNBLENDED_COST
 - UNBLENDED_COST
- granularity(Granularity) / set_granularity(Option<Granularity>):
 How granular you want the forecast to be. You can get 3 months of DAILY forecasts or 12 months of MONTHLY forecasts.
 
 The GetCostForecast operation supports only DAILY and MONTHLY granularities.
- filter(Expression) / set_filter(Option<Expression>):
 The filters that you want to use to filter your forecast. The GetCostForecast API supports filtering by the following dimensions:
 - AZ
 - INSTANCE_TYPE
 - LINKED_ACCOUNT
 - LINKED_ACCOUNT_NAME
 - OPERATION
 - PURCHASE_TYPE
 - REGION
 - SERVICE
 - USAGE_TYPE
 - USAGE_TYPE_GROUP
 - RECORD_TYPE
 - OPERATING_SYSTEM
 - TENANCY
 - SCOPE
 - PLATFORM
 - SUBSCRIPTION_ID
 - LEGAL_ENTITY_NAME
 - DEPLOYMENT_OPTION
 - DATABASE_ENGINE
 - INSTANCE_TYPE_FAMILY
 - BILLING_ENTITY
 - RESERVATION_ID
 - SAVINGS_PLAN_ARN
- prediction_interval_level(i32) / set_prediction_interval_level(Option<i32>):
 Cost Explorer always returns the mean forecast as a single point. You can request a prediction interval around the mean by specifying a confidence level. The higher the confidence level, the more confident Cost Explorer is about the actual value falling in the prediction interval. Higher confidence levels result in wider prediction intervals.
On success, responds with GetCostForecastOutput with field(s):
- total(Option<MetricValue>):
 How much you are forecasted to spend over the forecast period, in USD.
- forecast_results_by_time(Option<Vec<ForecastResult>>):
 The forecasts for your query, in order. For DAILY forecasts, this is a list of days. For MONTHLY forecasts, this is a list of months.
On failure, responds with SdkError<GetCostForecastError>

source

pub fn get_dimension_values(&self) -> GetDimensionValues

Constructs a fluent builder for the GetDimensionValues operation.

The fluent builder is configurable:
- search_string(impl Into<String>) / set_search_string(Option<String>):
 The value that you want to search the filter values for.
- time_period(DateInterval) / set_time_period(Option<DateInterval>):
 The start date and end date for retrieving the dimension values. The start date is inclusive, but the end date is exclusive. For example, if start is 2017-01-01 and end is 2017-05-01, then the cost and usage data is retrieved from 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01.
- dimension(Dimension) / set_dimension(Option<Dimension>):
 The name of the dimension. Each Dimension is available for a different Context. For more information, see Context.
- context(Context) / set_context(Option<Context>):
 The context for the call to GetDimensionValues. This can be RESERVATIONS or COST_AND_USAGE. The default value is COST_AND_USAGE. If the context is set to RESERVATIONS, the resulting dimension values can be used in the GetReservationUtilization operation. If the context is set to COST_AND_USAGE, the resulting dimension values can be used in the GetCostAndUsage operation.
 
 If you set the context to COST_AND_USAGE, you can use the following dimensions for searching:
 - AZ - The Availability Zone. An example is us-east-1a.
 - BILLING_ENTITY - The Amazon Web Services seller that your account is with. Possible values are the following:
 
 - Amazon Web Services(Amazon Web Services): The entity that sells Amazon Web Services services.
 
 - AISPL (Amazon Internet Services Pvt. Ltd.): The local Indian entity that is an acting reseller for Amazon Web Services services in India.
 
 - Amazon Web Services Marketplace: The entity that supports the sale of solutions built on Amazon Web Services by third-party software providers.
 - CACHE_ENGINE - The Amazon ElastiCache operating system. Examples are Windows or Linux.
 - DEPLOYMENT_OPTION - The scope of Amazon Relational Database Service deployments. Valid values are SingleAZ and MultiAZ.
 - DATABASE_ENGINE - The Amazon Relational Database Service database. Examples are Aurora or MySQL.
 - INSTANCE_TYPE - The type of Amazon EC2 instance. An example is m4.xlarge.
 - INSTANCE_TYPE_FAMILY - A family of instance types optimized to fit different use cases. Examples are Compute Optimized (C4, C5, C6g, C7g etc.), Memory Optimization (R4, R5n, R5b, R6g etc).
 - INVOICING_ENTITY - The name of the entity issuing the Amazon Web Services invoice.
 - LEGAL_ENTITY_NAME - The name of the organization that sells you Amazon Web Services services, such as Amazon Web Services.
 - LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value field contains the Amazon Web Services ID of the member account.
 - OPERATING_SYSTEM - The operating system. Examples are Windows or Linux.
 - OPERATION - The action performed. Examples include RunInstance and CreateBucket.
 - PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux.
 - PURCHASE_TYPE - The reservation type of the purchase to which this usage is related. Examples include On-Demand Instances and Standard Reserved Instances.
 - RESERVATION_ID - The unique identifier for an Amazon Web Services Reservation Instance.
 - SAVINGS_PLAN_ARN - The unique identifier for your Savings Plans.
 - SAVINGS_PLANS_TYPE - Type of Savings Plans (EC2 Instance or Compute).
 - SERVICE - The Amazon Web Services service such as Amazon DynamoDB.
 - TENANCY - The tenancy of a resource. Examples are shared or dedicated.
 - USAGE_TYPE - The type of usage. An example is DataTransfer-In-Bytes. The response for the GetDimensionValues operation includes a unit attribute. Examples include GB and Hrs.
 - USAGE_TYPE_GROUP - The grouping of common usage types. An example is Amazon EC2: CloudWatch – Alarms. The response for this operation includes a unit attribute.
 - REGION - The Amazon Web Services Region.
 - RECORD_TYPE - The different types of charges such as RI fees, usage costs, tax refunds, and credits.
 - RESOURCE_ID - The unique identifier of the resource. ResourceId is an opt-in feature only available for last 14 days for EC2-Compute Service.
 If you set the context to RESERVATIONS, you can use the following dimensions for searching:
 - AZ - The Availability Zone. An example is us-east-1a.
 - CACHE_ENGINE - The Amazon ElastiCache operating system. Examples are Windows or Linux.
 - DEPLOYMENT_OPTION - The scope of Amazon Relational Database Service deployments. Valid values are SingleAZ and MultiAZ.
 - INSTANCE_TYPE - The type of Amazon EC2 instance. An example is m4.xlarge.
 - LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value field contains the Amazon Web Services ID of the member account.
 - PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux.
 - REGION - The Amazon Web Services Region.
 - SCOPE (Utilization only) - The scope of a Reserved Instance (RI). Values are regional or a single Availability Zone.
 - TAG (Coverage only) - The tags that are associated with a Reserved Instance (RI).
 - TENANCY - The tenancy of a resource. Examples are shared or dedicated.
 If you set the context to SAVINGS_PLANS, you can use the following dimensions for searching:
 - SAVINGS_PLANS_TYPE - Type of Savings Plans (EC2 Instance or Compute)
 - PAYMENT_OPTION - Payment option for the given Savings Plans (for example, All Upfront)
 - REGION - The Amazon Web Services Region.
 - INSTANCE_TYPE_FAMILY - The family of instances (For example, m5)
 - LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value field contains the Amazon Web Services ID of the member account.
 - SAVINGS_PLAN_ARN - The unique identifier for your Savings Plans.
- filter(Expression) / set_filter(Option<Expression>):
 Use Expression to filter by cost or by usage. There are two patterns:
 - Simple dimension values - 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 Expression example is as follows:
 
 { “Dimensions”: { “Key”: “REGION”, “Values”: [ “us-east-1”, “us-west-1” ] } }
 
 The list of dimension values are OR’d together to retrieve cost or usage data. You can create Expression and DimensionValues objects using either with* methods or set* methods in multiple lines.
 - Compound dimension values 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 on more advanced options. For example, you can filter on ((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer). The Expression for that 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”: [ … ], “DimensionValues”: { “Dimension”: “USAGE_TYPE”, “Values”: [ “DataTransfer” ] } }
 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.
- sort_by(Vec<SortDefinition>) / set_sort_by(Option<Vec<SortDefinition>>):
 The value by which you want to sort the data.
 
 The key represents cost and usage metrics. The following values are supported:
 - BlendedCost
 - UnblendedCost
 - AmortizedCost
 - NetAmortizedCost
 - NetUnblendedCost
 - UsageQuantity
 - NormalizedUsageAmount
 Supported values for SortOrder are ASCENDING or DESCENDING.
 
 When you specify a SortBy paramater, the context must be COST_AND_USAGE. Further, when using SortBy, NextPageToken and SearchString are not supported.
- max_results(i32) / set_max_results(i32):
 This field is only used when SortBy is provided in the request. The maximum number of objects that to be returned for this request. If MaxResults is not specified with SortBy, the request will return 1000 results as the default value for this parameter.
 
 For GetDimensionValues, MaxResults has an upper limit of 1000.
- next_page_token(impl Into<String>) / set_next_page_token(Option<String>):
 The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.
On success, responds with GetDimensionValuesOutput with field(s):
- dimension_values(Option<Vec<DimensionValuesWithAttributes>>):
 The filters that you used to filter your request. Some dimensions are available only for a specific context.
 
 If you set the context to COST_AND_USAGE, you can use the following dimensions for searching:
 - AZ - The Availability Zone. An example is us-east-1a.
 - DATABASE_ENGINE - The Amazon Relational Database Service database. Examples are Aurora or MySQL.
 - INSTANCE_TYPE - The type of Amazon EC2 instance. An example is m4.xlarge.
 - LEGAL_ENTITY_NAME - The name of the organization that sells you Amazon Web Services services, such as Amazon Web Services.
 - LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value field contains the Amazon Web Services ID of the member account.
 - OPERATING_SYSTEM - The operating system. Examples are Windows or Linux.
 - OPERATION - The action performed. Examples include RunInstance and CreateBucket.
 - PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux.
 - PURCHASE_TYPE - The reservation type of the purchase to which this usage is related. Examples include On-Demand Instances and Standard Reserved Instances.
 - SERVICE - The Amazon Web Services service such as Amazon DynamoDB.
 - USAGE_TYPE - The type of usage. An example is DataTransfer-In-Bytes. The response for the GetDimensionValues operation includes a unit attribute. Examples include GB and Hrs.
 - USAGE_TYPE_GROUP - The grouping of common usage types. An example is Amazon EC2: CloudWatch – Alarms. The response for this operation includes a unit attribute.
 - RECORD_TYPE - The different types of charges such as RI fees, usage costs, tax refunds, and credits.
 - RESOURCE_ID - The unique identifier of the resource. ResourceId is an opt-in feature only available for last 14 days for EC2-Compute Service.
 If you set the context to RESERVATIONS, you can use the following dimensions for searching:
 - AZ - The Availability Zone. An example is us-east-1a.
 - CACHE_ENGINE - The Amazon ElastiCache operating system. Examples are Windows or Linux.
 - DEPLOYMENT_OPTION - The scope of Amazon Relational Database Service deployments. Valid values are SingleAZ and MultiAZ.
 - INSTANCE_TYPE - The type of Amazon EC2 instance. An example is m4.xlarge.
 - LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value field contains the Amazon Web Services ID of the member account.
 - PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux.
 - REGION - The Amazon Web Services Region.
 - SCOPE (Utilization only) - The scope of a Reserved Instance (RI). Values are regional or a single Availability Zone.
 - TAG (Coverage only) - The tags that are associated with a Reserved Instance (RI).
 - TENANCY - The tenancy of a resource. Examples are shared or dedicated.
 If you set the context to SAVINGS_PLANS, you can use the following dimensions for searching:
 - SAVINGS_PLANS_TYPE - Type of Savings Plans (EC2 Instance or Compute)
 - PAYMENT_OPTION - Payment option for the given Savings Plans (for example, All Upfront)
 - REGION - The Amazon Web Services Region.
 - INSTANCE_TYPE_FAMILY - The family of instances (For example, m5)
 - LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value field contains the Amazon Web Services ID of the member account.
 - SAVINGS_PLAN_ARN - The unique identifier for your Savings Plan
- return_size(Option<i32>):
 The number of results that Amazon Web Services returned at one time.
- total_size(Option<i32>):
 The total number of search results.
- next_page_token(Option<String>):
 The token for the next set of retrievable results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.
On failure, responds with SdkError<GetDimensionValuesError>

source

pub fn get_reservation_coverage(&self) -> GetReservationCoverage

Constructs a fluent builder for the GetReservationCoverage operation.

The fluent builder is configurable:
- time_period(DateInterval) / set_time_period(Option<DateInterval>):
 The start and end dates of the period that you want to retrieve data about reservation coverage for. You can retrieve data for a maximum of 13 months: the last 12 months and the current month. The start date is inclusive, but the end date is exclusive. For example, if start is 2017-01-01 and end is 2017-05-01, then the cost and usage data is retrieved from 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01.
- group_by(Vec<GroupDefinition>) / set_group_by(Option<Vec<GroupDefinition>>):
 You can group the data by the following attributes:
 - AZ
 - CACHE_ENGINE
 - DATABASE_ENGINE
 - DEPLOYMENT_OPTION
 - INSTANCE_TYPE
 - INVOICING_ENTITY
 - LINKED_ACCOUNT
 - OPERATING_SYSTEM
 - PLATFORM
 - REGION
 - TENANCY
- granularity(Granularity) / set_granularity(Option<Granularity>):
 The granularity of the Amazon Web Services cost data for the reservation. Valid values are MONTHLY and DAILY.
 
 If GroupBy is set, Granularity can’t be set. If Granularity isn’t set, the response object doesn’t include Granularity, either MONTHLY or DAILY.
 
 The GetReservationCoverage operation supports only DAILY and MONTHLY granularities.
- filter(Expression) / set_filter(Option<Expression>):
 Filters utilization data by dimensions. You can filter by the following dimensions:
 - AZ
 - CACHE_ENGINE
 - DATABASE_ENGINE
 - DEPLOYMENT_OPTION
 - INSTANCE_TYPE
 - LINKED_ACCOUNT
 - OPERATING_SYSTEM
 - PLATFORM
 - REGION
 - SERVICE
 - TAG
 - TENANCY
 GetReservationCoverage uses the same Expression object as the other operations, but only AND is supported among each dimension. You can nest only one level deep. If there are multiple values for a dimension, they are OR’d together.
 
 If you don’t provide a SERVICE filter, Cost Explorer defaults to EC2.
 
 Cost category is also supported.
- metrics(Vec<String>) / set_metrics(Option<Vec<String>>):
 The measurement that you want your reservation coverage reported in.
 
 Valid values are Hour, Unit, and Cost. You can use multiple values in a request.
- next_page_token(impl Into<String>) / set_next_page_token(Option<String>):
 The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.
- sort_by(SortDefinition) / set_sort_by(Option<SortDefinition>):
 The value by which you want to sort the data.
 
 The following values are supported for Key:
 - OnDemandCost
 - CoverageHoursPercentage
 - OnDemandHours
 - ReservedHours
 - TotalRunningHours
 - CoverageNormalizedUnitsPercentage
 - OnDemandNormalizedUnits
 - ReservedNormalizedUnits
 - TotalRunningNormalizedUnits
 - Time
 Supported values for SortOrder are ASCENDING or DESCENDING.
- max_results(i32) / set_max_results(Option<i32>):
 The maximum number of objects that you returned for this request. If more objects are available, in the response, Amazon Web Services provides a NextPageToken value that you can use in a subsequent call to get the next batch of objects.
On success, responds with GetReservationCoverageOutput with field(s):
- coverages_by_time(Option<Vec<CoverageByTime>>):
 The amount of time that your reservations covered.
- total(Option<Coverage>):
 The total amount of instance usage that a reservation covered.
- next_page_token(Option<String>):
 The token for the next set of retrievable results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.
On failure, responds with SdkError<GetReservationCoverageError>

source

pub fn get_reservation_purchase_recommendation(
&self
) -> GetReservationPurchaseRecommendation

Constructs a fluent builder for the GetReservationPurchaseRecommendation operation.

The fluent builder is configurable:
- account_id(impl Into<String>) / set_account_id(Option<String>):
 The account ID that is associated with the recommendation.
- service(impl Into<String>) / set_service(Option<String>):
 The specific service that you want recommendations for.
- filter(Expression) / set_filter(Option<Expression>):
 Use Expression to filter by cost or by usage. There are two patterns:
 - Simple dimension values - 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 Expression example is as follows:
 
 { “Dimensions”: { “Key”: “REGION”, “Values”: [ “us-east-1”, “us-west-1” ] } }
 
 The list of dimension values are OR’d together to retrieve cost or usage data. You can create Expression and DimensionValues objects using either with* methods or set* methods in multiple lines.
 - Compound dimension values 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 on more advanced options. For example, you can filter on ((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer). The Expression for that 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”: [ … ], “DimensionValues”: { “Dimension”: “USAGE_TYPE”, “Values”: [ “DataTransfer” ] } }
 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(AccountScope) / set_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(LookbackPeriodInDays) / set_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(TermInYears) / set_term_in_years(Option<TermInYears>):
 The reservation term that you want recommendations for.
- payment_option(PaymentOption) / set_payment_option(Option<PaymentOption>):
 The reservation purchase option that you want recommendations for.
- service_specification(ServiceSpecification) / set_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(i32) / set_page_size(i32):
 The number of recommendations that you want returned in a single response object.
- next_page_token(impl Into<String>) / set_next_page_token(Option<String>):
 The pagination token that indicates the next set of results that you want to retrieve.
On success, responds with GetReservationPurchaseRecommendationOutput with field(s):
- metadata(Option<ReservationPurchaseRecommendationMetadata>):
 Information about this specific recommendation call, such as the time stamp for when Cost Explorer generated this recommendation.
- recommendations(Option<Vec<ReservationPurchaseRecommendation>>):
 Recommendations for reservations to purchase.
- next_page_token(Option<String>):
 The pagination token for the next set of retrievable results.
On failure, responds with SdkError<GetReservationPurchaseRecommendationError>

source

pub fn get_reservation_utilization(&self) -> GetReservationUtilization

Constructs a fluent builder for the GetReservationUtilization operation.

The fluent builder is configurable:
- time_period(DateInterval) / set_time_period(Option<DateInterval>):
 Sets the start and end dates for retrieving RI utilization. The start date is inclusive, but the end date is exclusive. For example, if start is 2017-01-01 and end is 2017-05-01, then the cost and usage data is retrieved from 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01.
- group_by(Vec<GroupDefinition>) / set_group_by(Option<Vec<GroupDefinition>>):
 Groups only by SUBSCRIPTION_ID. Metadata is included.
- granularity(Granularity) / set_granularity(Option<Granularity>):
 If GroupBy is set, Granularity can’t be set. If Granularity isn’t set, the response object doesn’t include Granularity, either MONTHLY or DAILY. If both GroupBy and Granularity aren’t set, GetReservationUtilization defaults to DAILY.
 
 The GetReservationUtilization operation supports only DAILY and MONTHLY granularities.
- filter(Expression) / set_filter(Option<Expression>):
 Filters utilization data by dimensions. You can filter by the following dimensions:
 - AZ
 - CACHE_ENGINE
 - DEPLOYMENT_OPTION
 - INSTANCE_TYPE
 - LINKED_ACCOUNT
 - OPERATING_SYSTEM
 - PLATFORM
 - REGION
 - SERVICE
 - SCOPE
 - TENANCY
 GetReservationUtilization uses the same Expression object as the other operations, but only AND is supported among each dimension, and nesting is supported up to only one level deep. If there are multiple values for a dimension, they are OR’d together.
- sort_by(SortDefinition) / set_sort_by(Option<SortDefinition>):
 The value by which you want to sort the data.
 
 The following values are supported for Key:
 - UtilizationPercentage
 - UtilizationPercentageInUnits
 - PurchasedHours
 - PurchasedUnits
 - TotalActualHours
 - TotalActualUnits
 - UnusedHours
 - UnusedUnits
 - OnDemandCostOfRIHoursUsed
 - NetRISavings
 - TotalPotentialRISavings
 - AmortizedUpfrontFee
 - AmortizedRecurringFee
 - TotalAmortizedFee
 - RICostForUnusedHours
 - RealizedSavings
 - UnrealizedSavings
 Supported values for SortOrder are ASCENDING or DESCENDING.
- next_page_token(impl Into<String>) / set_next_page_token(Option<String>):
 The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.
- max_results(i32) / set_max_results(Option<i32>):
 The maximum number of objects that you returned for this request. If more objects are available, in the response, Amazon Web Services provides a NextPageToken value that you can use in a subsequent call to get the next batch of objects.
On success, responds with GetReservationUtilizationOutput with field(s):
- utilizations_by_time(Option<Vec<UtilizationByTime>>):
 The amount of time that you used your RIs.
- total(Option<ReservationAggregates>):
 The total amount of time that you used your RIs.
- next_page_token(Option<String>):
 The token for the next set of retrievable results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.
On failure, responds with SdkError<GetReservationUtilizationError>

source

pub fn get_rightsizing_recommendation(&self) -> GetRightsizingRecommendation

Constructs a fluent builder for the GetRightsizingRecommendation operation.

The fluent builder is configurable:
- filter(Expression) / set_filter(Option<Expression>):
 Use Expression to filter by cost or by usage. There are two patterns:
 - Simple dimension values - 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 Expression example is as follows:
 
 { “Dimensions”: { “Key”: “REGION”, “Values”: [ “us-east-1”, “us-west-1” ] } }
 
 The list of dimension values are OR’d together to retrieve cost or usage data. You can create Expression and DimensionValues objects using either with* methods or set* methods in multiple lines.
 - Compound dimension values 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 on more advanced options. For example, you can filter on ((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer). The Expression for that 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”: [ … ], “DimensionValues”: { “Dimension”: “USAGE_TYPE”, “Values”: [ “DataTransfer” ] } }
 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.
- configuration(RightsizingRecommendationConfiguration) / set_configuration(Option<RightsizingRecommendationConfiguration>):
 Enables you to customize recommendations across two attributes. You can choose to view recommendations for instances within the same instance families or across different instance families. You can also choose to view your estimated savings associated with recommendations with consideration of existing Savings Plans or RI benefits, or neither.
- service(impl Into<String>) / set_service(Option<String>):
 The specific service that you want recommendations for. The only valid value for GetRightsizingRecommendation is “AmazonEC2”.
- page_size(i32) / set_page_size(i32):
 The number of recommendations that you want returned in a single response object.
- next_page_token(impl Into<String>) / set_next_page_token(Option<String>):
 The pagination token that indicates the next set of results that you want to retrieve.
On success, responds with GetRightsizingRecommendationOutput with field(s):
- metadata(Option<RightsizingRecommendationMetadata>):
 Information regarding this specific recommendation set.
- summary(Option<RightsizingRecommendationSummary>):
 Summary of this recommendation set.
- rightsizing_recommendations(Option<Vec<RightsizingRecommendation>>):
 Recommendations to rightsize resources.
- next_page_token(Option<String>):
 The token to retrieve the next set of results.
- configuration(Option<RightsizingRecommendationConfiguration>):
 Enables you to customize recommendations across two attributes. You can choose to view recommendations for instances within the same instance families or across different instance families. You can also choose to view your estimated savings associated with recommendations with consideration of existing Savings Plans or RI benefits, or neither.
On failure, responds with SdkError<GetRightsizingRecommendationError>

source

pub fn get_savings_plans_coverage(&self) -> GetSavingsPlansCoverage

Constructs a fluent builder for the GetSavingsPlansCoverage operation. This operation supports pagination; See into_paginator().

The fluent builder is configurable:
- time_period(DateInterval) / set_time_period(Option<DateInterval>):
 The time period that you want the usage and costs for. The Start date must be within 13 months. The End date must be after the Start date, and before the current date. Future dates can’t be used as an End date.
- group_by(Vec<GroupDefinition>) / set_group_by(Option<Vec<GroupDefinition>>):
 You can group the data using the attributes INSTANCE_FAMILY, REGION, or SERVICE.
- granularity(Granularity) / set_granularity(Option<Granularity>):
 The granularity of the Amazon Web Services cost data for your Savings Plans. Granularity can’t be set if GroupBy is set.
 
 The GetSavingsPlansCoverage operation supports only DAILY and MONTHLY granularities.
- filter(Expression) / set_filter(Option<Expression>):
 Filters Savings Plans coverage data by dimensions. You can filter data for Savings Plans usage with the following dimensions:
 - LINKED_ACCOUNT
 - REGION
 - SERVICE
 - INSTANCE_FAMILY
 GetSavingsPlansCoverage uses the same Expression object as the other operations, but only AND is supported among each dimension. If there are multiple values for a dimension, they are OR’d together.
 
 Cost category is also supported.
- metrics(Vec<String>) / set_metrics(Option<Vec<String>>):
 The measurement that you want your Savings Plans coverage reported in. The only valid value is SpendCoveredBySavingsPlans.
- next_token(impl Into<String>) / set_next_token(Option<String>):
 The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.
- max_results(i32) / set_max_results(Option<i32>):
 The number of items to be returned in a response. The default is 20, with a minimum value of 1.
- sort_by(SortDefinition) / set_sort_by(Option<SortDefinition>):
 The value by which you want to sort the data.
 
 The following values are supported for Key:
 - SpendCoveredBySavingsPlan
 - OnDemandCost
 - CoveragePercentage
 - TotalCost
 - InstanceFamily
 - Region
 - Service
 Supported values for SortOrder are ASCENDING or DESCENDING.
On success, responds with GetSavingsPlansCoverageOutput with field(s):
- savings_plans_coverages(Option<Vec<SavingsPlansCoverage>>):
 The amount of spend that your Savings Plans covered.
- next_token(Option<String>):
 The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.
On failure, responds with SdkError<GetSavingsPlansCoverageError>

source

pub fn get_savings_plans_purchase_recommendation(
&self
) -> GetSavingsPlansPurchaseRecommendation

Constructs a fluent builder for the GetSavingsPlansPurchaseRecommendation operation.

The fluent builder is configurable:
- savings_plans_type(SupportedSavingsPlansType) / set_savings_plans_type(Option<SupportedSavingsPlansType>):
 The Savings Plans recommendation type requested.
- term_in_years(TermInYears) / set_term_in_years(Option<TermInYears>):
 The savings plan recommendation term used to generate these recommendations.
- payment_option(PaymentOption) / set_payment_option(Option<PaymentOption>):
 The payment option used to generate these recommendations.
- account_scope(AccountScope) / set_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.
- next_page_token(impl Into<String>) / set_next_page_token(Option<String>):
 The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.
- page_size(i32) / set_page_size(i32):
 The number of recommendations that you want returned in a single response object.
- lookback_period_in_days(LookbackPeriodInDays) / set_lookback_period_in_days(Option<LookbackPeriodInDays>):
 The lookback period used to generate the recommendation.
- filter(Expression) / set_filter(Option<Expression>):
 You can filter your recommendations by Account ID with the LINKED_ACCOUNT dimension. To filter your recommendations by Account ID, specify Key as LINKED_ACCOUNT and Value as the comma-separated Acount ID(s) for which you want to see Savings Plans purchase recommendations.
 
 For GetSavingsPlansPurchaseRecommendation, the Filter does not include CostCategories or Tags. It only includes Dimensions. With Dimensions, Key must be LINKED_ACCOUNT and Value can be a single Account ID or multiple comma-separated Account IDs for which you want to see Savings Plans Purchase Recommendations. AND and OR operators are not supported.
On success, responds with GetSavingsPlansPurchaseRecommendationOutput with field(s):
- metadata(Option<SavingsPlansPurchaseRecommendationMetadata>):
 Information regarding this specific recommendation set.
- savings_plans_purchase_recommendation(Option<SavingsPlansPurchaseRecommendation>):
 Contains your request parameters, Savings Plan Recommendations Summary, and Details.
- next_page_token(Option<String>):
 The token for the next set of retrievable results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.
On failure, responds with SdkError<GetSavingsPlansPurchaseRecommendationError>

source

pub fn get_savings_plans_utilization(&self) -> GetSavingsPlansUtilization

Constructs a fluent builder for the GetSavingsPlansUtilization operation.

The fluent builder is configurable:
- time_period(DateInterval) / set_time_period(Option<DateInterval>):
 The time period that you want the usage and costs for. The Start date must be within 13 months. The End date must be after the Start date, and before the current date. Future dates can’t be used as an End date.
- granularity(Granularity) / set_granularity(Option<Granularity>):
 The granularity of the Amazon Web Services utillization data for your Savings Plans.
 
 The GetSavingsPlansUtilization operation supports only DAILY and MONTHLY granularities.
- filter(Expression) / set_filter(Option<Expression>):
 Filters Savings Plans utilization coverage data for active Savings Plans dimensions. You can filter data with the following dimensions:
 - LINKED_ACCOUNT
 - SAVINGS_PLAN_ARN
 - SAVINGS_PLANS_TYPE
 - REGION
 - PAYMENT_OPTION
 - INSTANCE_TYPE_FAMILY
 GetSavingsPlansUtilization uses the same Expression object as the other operations, but only AND is supported among each dimension.
- sort_by(SortDefinition) / set_sort_by(Option<SortDefinition>):
 The value by which you want to sort the data.
 
 The following values are supported for Key:
 - UtilizationPercentage
 - TotalCommitment
 - UsedCommitment
 - UnusedCommitment
 - NetSavings
 Supported values for SortOrder are ASCENDING or DESCENDING.
On success, responds with GetSavingsPlansUtilizationOutput with field(s):
- savings_plans_utilizations_by_time(Option<Vec<SavingsPlansUtilizationByTime>>):
 The amount of cost/commitment you used your Savings Plans. This allows you to specify date ranges.
- total(Option<SavingsPlansUtilizationAggregates>):
 The total amount of cost/commitment that you used your Savings Plans, regardless of date ranges.
On failure, responds with SdkError<GetSavingsPlansUtilizationError>

source

pub fn get_savings_plans_utilization_details(
&self
) -> GetSavingsPlansUtilizationDetails

Constructs a fluent builder for the GetSavingsPlansUtilizationDetails operation. This operation supports pagination; See into_paginator().

The fluent builder is configurable:
- time_period(DateInterval) / set_time_period(Option<DateInterval>):
 The time period that you want the usage and costs for. The Start date must be within 13 months. The End date must be after the Start date, and before the current date. Future dates can’t be used as an End date.
- filter(Expression) / set_filter(Option<Expression>):
 Filters Savings Plans utilization coverage data for active Savings Plans dimensions. You can filter data with the following dimensions:
 - LINKED_ACCOUNT
 - SAVINGS_PLAN_ARN
 - REGION
 - PAYMENT_OPTION
 - INSTANCE_TYPE_FAMILY
 GetSavingsPlansUtilizationDetails uses the same Expression object as the other operations, but only AND is supported among each dimension.
- data_type(Vec<SavingsPlansDataType>) / set_data_type(Option<Vec<SavingsPlansDataType>>):
 The data type.
- next_token(impl Into<String>) / set_next_token(Option<String>):
 The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.
- max_results(i32) / set_max_results(Option<i32>):
 The number of items to be returned in a response. The default is 20, with a minimum value of 1.
- sort_by(SortDefinition) / set_sort_by(Option<SortDefinition>):
 The value by which you want to sort the data.
 
 The following values are supported for Key:
 - UtilizationPercentage
 - TotalCommitment
 - UsedCommitment
 - UnusedCommitment
 - NetSavings
 - AmortizedRecurringCommitment
 - AmortizedUpfrontCommitment
 Supported values for SortOrder are ASCENDING or DESCENDING.
On success, responds with GetSavingsPlansUtilizationDetailsOutput with field(s):
- savings_plans_utilization_details(Option<Vec<SavingsPlansUtilizationDetail>>):
 Retrieves a single daily or monthly Savings Plans utilization rate and details for your account.
- total(Option<SavingsPlansUtilizationAggregates>):
 The total Savings Plans utilization, regardless of time period.
- time_period(Option<DateInterval>):
 The time period of the request.
- next_token(Option<String>):
 The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.
On failure, responds with SdkError<GetSavingsPlansUtilizationDetailsError>

source

pub fn get_tags(&self) -> GetTags

Constructs a fluent builder for the GetTags operation.

The fluent builder is configurable:
- search_string(impl Into<String>) / set_search_string(Option<String>):
 The value that you want to search for.
- time_period(DateInterval) / set_time_period(Option<DateInterval>):
 The start and end dates for retrieving the dimension values. The start date is inclusive, but the end date is exclusive. For example, if start is 2017-01-01 and end is 2017-05-01, then the cost and usage data is retrieved from 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01.
- tag_key(impl Into<String>) / set_tag_key(Option<String>):
 The key of the tag that you want to return values for.
- filter(Expression) / set_filter(Option<Expression>):
 Use Expression to filter by cost or by usage. There are two patterns:
 - Simple dimension values - 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 Expression example is as follows:
 
 { “Dimensions”: { “Key”: “REGION”, “Values”: [ “us-east-1”, “us-west-1” ] } }
 
 The list of dimension values are OR’d together to retrieve cost or usage data. You can create Expression and DimensionValues objects using either with* methods or set* methods in multiple lines.
 - Compound dimension values 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 on more advanced options. For example, you can filter on ((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer). The Expression for that 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”: [ … ], “DimensionValues”: { “Dimension”: “USAGE_TYPE”, “Values”: [ “DataTransfer” ] } }
 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.
- sort_by(Vec<SortDefinition>) / set_sort_by(Option<Vec<SortDefinition>>):
 The value by which you want to sort the data.
 
 The key represents cost and usage metrics. The following values are supported:
 - BlendedCost
 - UnblendedCost
 - AmortizedCost
 - NetAmortizedCost
 - NetUnblendedCost
 - UsageQuantity
 - NormalizedUsageAmount
 Supported values for SortOrder are ASCENDING or DESCENDING.
 
 When using SortBy, NextPageToken and SearchString are not supported.
- max_results(i32) / set_max_results(i32):
 This field is only used when SortBy is provided in the request. The maximum number of objects that to be returned for this request. If MaxResults is not specified with SortBy, the request will return 1000 results as the default value for this parameter.
 
 For GetTags, MaxResults has an upper limit of 1000.
- next_page_token(impl Into<String>) / set_next_page_token(Option<String>):
 The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.
On success, responds with GetTagsOutput with field(s):
- next_page_token(Option<String>):
 The token for the next set of retrievable results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.
- tags(Option<Vec<String>>):
 The tags that match your request.
- return_size(Option<i32>):
 The number of query results that Amazon Web Services returns at a time.
- total_size(Option<i32>):
 The total number of query results.
On failure, responds with SdkError<GetTagsError>

source

pub fn get_usage_forecast(&self) -> GetUsageForecast

Constructs a fluent builder for the GetUsageForecast operation.

The fluent builder is configurable:
- time_period(DateInterval) / set_time_period(Option<DateInterval>):
 The start and end dates of the period that you want to retrieve usage forecast for. The start date is inclusive, but the end date is exclusive. For example, if start is 2017-01-01 and end is 2017-05-01, then the cost and usage data is retrieved from 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01. The start date must be equal to or later than the current date to avoid a validation error.
- metric(Metric) / set_metric(Option<Metric>):
 Which metric Cost Explorer uses to create your forecast.
 
 Valid values for a GetUsageForecast call are the following:
 - USAGE_QUANTITY
 - NORMALIZED_USAGE_AMOUNT
- granularity(Granularity) / set_granularity(Option<Granularity>):
 How granular you want the forecast to be. You can get 3 months of DAILY forecasts or 12 months of MONTHLY forecasts.
 
 The GetUsageForecast operation supports only DAILY and MONTHLY granularities.
- filter(Expression) / set_filter(Option<Expression>):
 The filters that you want to use to filter your forecast. The GetUsageForecast API supports filtering by the following dimensions:
 - AZ
 - INSTANCE_TYPE
 - LINKED_ACCOUNT
 - LINKED_ACCOUNT_NAME
 - OPERATION
 - PURCHASE_TYPE
 - REGION
 - SERVICE
 - USAGE_TYPE
 - USAGE_TYPE_GROUP
 - RECORD_TYPE
 - OPERATING_SYSTEM
 - TENANCY
 - SCOPE
 - PLATFORM
 - SUBSCRIPTION_ID
 - LEGAL_ENTITY_NAME
 - DEPLOYMENT_OPTION
 - DATABASE_ENGINE
 - INSTANCE_TYPE_FAMILY
 - BILLING_ENTITY
 - RESERVATION_ID
 - SAVINGS_PLAN_ARN
- prediction_interval_level(i32) / set_prediction_interval_level(Option<i32>):
 Cost Explorer always returns the mean forecast as a single point. You can request a prediction interval around the mean by specifying a confidence level. The higher the confidence level, the more confident Cost Explorer is about the actual value falling in the prediction interval. Higher confidence levels result in wider prediction intervals.
On success, responds with GetUsageForecastOutput with field(s):
- total(Option<MetricValue>):
 How much you’re forecasted to use over the forecast period.
- forecast_results_by_time(Option<Vec<ForecastResult>>):
 The forecasts for your query, in order. For DAILY forecasts, this is a list of days. For MONTHLY forecasts, this is a list of months.
On failure, responds with SdkError<GetUsageForecastError>

source

pub fn list_cost_category_definitions(&self) -> ListCostCategoryDefinitions

Constructs a fluent builder for the ListCostCategoryDefinitions operation. This operation supports pagination; See into_paginator().

The fluent builder is configurable:
- effective_on(impl Into<String>) / set_effective_on(Option<String>):
 The date when the Cost Category was effective.
- next_token(impl Into<String>) / set_next_token(Option<String>):
 The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.
- max_results(i32) / set_max_results(Option<i32>):
 The number of entries a paginated response contains.
On success, responds with ListCostCategoryDefinitionsOutput with field(s):
- cost_category_references(Option<Vec<CostCategoryReference>>):
 A reference to a Cost Category containing enough information to identify the Cost Category.
- next_token(Option<String>):
 The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.
On failure, responds with SdkError<ListCostCategoryDefinitionsError>