Class: Aws::CostExplorer::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::CostExplorer::Client
- Includes:
- Aws::ClientStubs
- Defined in:
- gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/client.rb
Overview
An API client for CostExplorer. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::CostExplorer::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#create_anomaly_monitor(params = {}) ⇒ Types::CreateAnomalyMonitorResponse
Creates a new cost anomaly detection monitor with the requested type and monitor specification.
-
#create_anomaly_subscription(params = {}) ⇒ Types::CreateAnomalySubscriptionResponse
Adds an alert subscription to a cost anomaly detection monitor.
-
#create_cost_category_definition(params = {}) ⇒ Types::CreateCostCategoryDefinitionResponse
Creates a new Cost Category with the requested name and rules.
-
#delete_anomaly_monitor(params = {}) ⇒ Struct
Deletes a cost anomaly monitor.
-
#delete_anomaly_subscription(params = {}) ⇒ Struct
Deletes a cost anomaly subscription.
-
#delete_cost_category_definition(params = {}) ⇒ Types::DeleteCostCategoryDefinitionResponse
Deletes a Cost Category.
-
#describe_cost_category_definition(params = {}) ⇒ Types::DescribeCostCategoryDefinitionResponse
Returns the name, Amazon Resource Name (ARN), rules, definition, and effective dates of a Cost Category that's defined in the account.
-
#get_anomalies(params = {}) ⇒ Types::GetAnomaliesResponse
Retrieves all of the cost anomalies detected on your account during the time period that's specified by the
DateInterval
object. -
#get_anomaly_monitors(params = {}) ⇒ Types::GetAnomalyMonitorsResponse
Retrieves the cost anomaly monitor definitions for your account.
-
#get_anomaly_subscriptions(params = {}) ⇒ Types::GetAnomalySubscriptionsResponse
Retrieves the cost anomaly subscription objects for your account.
-
#get_approximate_usage_records(params = {}) ⇒ Types::GetApproximateUsageRecordsResponse
Retrieves estimated usage records for hourly granularity or resource-level data at daily granularity.
-
#get_cost_and_usage(params = {}) ⇒ Types::GetCostAndUsageResponse
Retrieves cost and usage metrics for your account.
-
#get_cost_and_usage_with_resources(params = {}) ⇒ Types::GetCostAndUsageWithResourcesResponse
Retrieves cost and usage metrics with resources for your account.
-
#get_cost_categories(params = {}) ⇒ Types::GetCostCategoriesResponse
Retrieves an array of Cost Category names and values incurred cost.
-
#get_cost_forecast(params = {}) ⇒ Types::GetCostForecastResponse
Retrieves a forecast for how much Amazon Web Services predicts that you will spend over the forecast time period that you select, based on your past costs.
-
#get_dimension_values(params = {}) ⇒ Types::GetDimensionValuesResponse
Retrieves all available filter values for a specified filter over a period of time.
-
#get_reservation_coverage(params = {}) ⇒ Types::GetReservationCoverageResponse
Retrieves the reservation coverage for your account, which you can use to see how much of your Amazon Elastic Compute Cloud, Amazon ElastiCache, Amazon Relational Database Service, or Amazon Redshift usage is covered by a reservation.
-
#get_reservation_purchase_recommendation(params = {}) ⇒ Types::GetReservationPurchaseRecommendationResponse
Gets recommendations for reservation purchases.
-
#get_reservation_utilization(params = {}) ⇒ Types::GetReservationUtilizationResponse
Retrieves the reservation utilization for your account.
-
#get_rightsizing_recommendation(params = {}) ⇒ Types::GetRightsizingRecommendationResponse
Creates recommendations that help you save cost by identifying idle and underutilized Amazon EC2 instances.
-
#get_savings_plan_purchase_recommendation_details(params = {}) ⇒ Types::GetSavingsPlanPurchaseRecommendationDetailsResponse
Retrieves the details for a Savings Plan recommendation.
-
#get_savings_plans_coverage(params = {}) ⇒ Types::GetSavingsPlansCoverageResponse
Retrieves the Savings Plans covered for your account.
-
#get_savings_plans_purchase_recommendation(params = {}) ⇒ Types::GetSavingsPlansPurchaseRecommendationResponse
Retrieves the Savings Plans recommendations for your account.
-
#get_savings_plans_utilization(params = {}) ⇒ Types::GetSavingsPlansUtilizationResponse
Retrieves the Savings Plans utilization for your account across date ranges with daily or monthly granularity.
-
#get_savings_plans_utilization_details(params = {}) ⇒ Types::GetSavingsPlansUtilizationDetailsResponse
Retrieves attribute data along with aggregate utilization and savings data for a given time period.
-
#get_tags(params = {}) ⇒ Types::GetTagsResponse
Queries for available tag keys and tag values for a specified period.
-
#get_usage_forecast(params = {}) ⇒ Types::GetUsageForecastResponse
Retrieves a forecast for how much Amazon Web Services predicts that you will use over the forecast time period that you select, based on your past usage.
-
#list_cost_allocation_tag_backfill_history(params = {}) ⇒ Types::ListCostAllocationTagBackfillHistoryResponse
Retrieves a list of your historical cost allocation tag backfill requests.
-
#list_cost_allocation_tags(params = {}) ⇒ Types::ListCostAllocationTagsResponse
Get a list of cost allocation tags.
-
#list_cost_category_definitions(params = {}) ⇒ Types::ListCostCategoryDefinitionsResponse
Returns the name, Amazon Resource Name (ARN),
NumberOfRules
and effective dates of all Cost Categories defined in the account. -
#list_savings_plans_purchase_recommendation_generation(params = {}) ⇒ Types::ListSavingsPlansPurchaseRecommendationGenerationResponse
Retrieves a list of your historical recommendation generations within the past 30 days.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Returns a list of resource tags associated with the resource specified by the Amazon Resource Name (ARN).
-
#provide_anomaly_feedback(params = {}) ⇒ Types::ProvideAnomalyFeedbackResponse
Modifies the feedback property of a given cost anomaly.
-
#start_cost_allocation_tag_backfill(params = {}) ⇒ Types::StartCostAllocationTagBackfillResponse
Request a cost allocation tag backfill.
-
#start_savings_plans_purchase_recommendation_generation(params = {}) ⇒ Types::StartSavingsPlansPurchaseRecommendationGenerationResponse
Requests a Savings Plans recommendation generation.
-
#tag_resource(params = {}) ⇒ Struct
An API operation for adding one or more tags (key-value pairs) to a resource.
-
#untag_resource(params = {}) ⇒ Struct
Removes one or more tags from a resource.
-
#update_anomaly_monitor(params = {}) ⇒ Types::UpdateAnomalyMonitorResponse
Updates an existing cost anomaly monitor.
-
#update_anomaly_subscription(params = {}) ⇒ Types::UpdateAnomalySubscriptionResponse
Updates an existing cost anomaly subscription.
-
#update_cost_allocation_tags_status(params = {}) ⇒ Types::UpdateCostAllocationTagsStatusResponse
Updates status for cost allocation tags in bulk, with maximum batch size of 20.
-
#update_cost_category_definition(params = {}) ⇒ Types::UpdateCostCategoryDefinitionResponse
Updates an existing Cost Category.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from Aws::ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
395 396 397 |
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/client.rb', line 395 def initialize(*args) super end |
Instance Method Details
#create_anomaly_monitor(params = {}) ⇒ Types::CreateAnomalyMonitorResponse
Creates a new cost anomaly detection monitor with the requested type and monitor specification.
500 501 502 503 |
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/client.rb', line 500 def create_anomaly_monitor(params = {}, = {}) req = build_request(:create_anomaly_monitor, params) req.send_request() end |
#create_anomaly_subscription(params = {}) ⇒ Types::CreateAnomalySubscriptionResponse
Adds an alert subscription to a cost anomaly detection monitor. You can use each subscription to define subscribers with email or SNS notifications. Email subscribers can set an absolute or percentage threshold and a time frequency for receiving notifications.
611 612 613 614 |
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/client.rb', line 611 def create_anomaly_subscription(params = {}, = {}) req = build_request(:create_anomaly_subscription, params) req.send_request() end |
#create_cost_category_definition(params = {}) ⇒ Types::CreateCostCategoryDefinitionResponse
Creates a new Cost Category with the requested name and rules.
757 758 759 760 |
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/client.rb', line 757 def create_cost_category_definition(params = {}, = {}) req = build_request(:create_cost_category_definition, params) req.send_request() end |
#delete_anomaly_monitor(params = {}) ⇒ Struct
Deletes a cost anomaly monitor.
780 781 782 783 |
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/client.rb', line 780 def delete_anomaly_monitor(params = {}, = {}) req = build_request(:delete_anomaly_monitor, params) req.send_request() end |
#delete_anomaly_subscription(params = {}) ⇒ Struct
Deletes a cost anomaly subscription.
803 804 805 806 |
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/client.rb', line 803 def delete_anomaly_subscription(params = {}, = {}) req = build_request(:delete_anomaly_subscription, params) req.send_request() end |
#delete_cost_category_definition(params = {}) ⇒ Types::DeleteCostCategoryDefinitionResponse
Deletes a Cost Category. Expenses from this month going forward will no longer be categorized with this Cost Category.
834 835 836 837 |
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/client.rb', line 834 def delete_cost_category_definition(params = {}, = {}) req = build_request(:delete_cost_category_definition, params) req.send_request() end |
#describe_cost_category_definition(params = {}) ⇒ Types::DescribeCostCategoryDefinitionResponse
Returns the name, Amazon Resource Name (ARN), rules, definition, and effective dates of a Cost Category that's defined in the account.
You have the option to use EffectiveOn
to return a Cost Category
that's active on a specific date. If there's no EffectiveOn
specified, you see a Cost Category that's effective on the current
date. If Cost Category is still effective, EffectiveEnd
is omitted
in the response.
915 916 917 918 |
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/client.rb', line 915 def describe_cost_category_definition(params = {}, = {}) req = build_request(:describe_cost_category_definition, params) req.send_request() end |
#get_anomalies(params = {}) ⇒ Types::GetAnomaliesResponse
Retrieves all of the cost anomalies detected on your account during
the time period that's specified by the DateInterval
object.
Anomalies are available for up to 90 days.
1000 1001 1002 1003 |
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/client.rb', line 1000 def get_anomalies(params = {}, = {}) req = build_request(:get_anomalies, params) req.send_request() end |
#get_anomaly_monitors(params = {}) ⇒ Types::GetAnomalyMonitorsResponse
Retrieves the cost anomaly monitor definitions for your account. You can filter using a list of cost anomaly monitor Amazon Resource Names (ARNs).
1070 1071 1072 1073 |
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/client.rb', line 1070 def get_anomaly_monitors(params = {}, = {}) req = build_request(:get_anomaly_monitors, params) req.send_request() end |
#get_anomaly_subscriptions(params = {}) ⇒ Types::GetAnomalySubscriptionsResponse
Retrieves the cost anomaly subscription objects for your account. You can filter using a list of cost anomaly monitor Amazon Resource Names (ARNs).
1147 1148 1149 1150 |
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/client.rb', line 1147 def get_anomaly_subscriptions(params = {}, = {}) req = build_request(:get_anomaly_subscriptions, params) req.send_request() end |
#get_approximate_usage_records(params = {}) ⇒ Types::GetApproximateUsageRecordsResponse
Retrieves estimated usage records for hourly granularity or resource-level data at daily granularity.
1194 1195 1196 1197 |
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/client.rb', line 1194 def get_approximate_usage_records(params = {}, = {}) req = build_request(:get_approximate_usage_records, params) req.send_request() end |
#get_cost_and_usage(params = {}) ⇒ Types::GetCostAndUsageResponse
Retrieves cost and usage metrics for your account. You can specify
which cost and usage-related metric that you want the request to
return. For example, you can specify BlendedCosts
or
UsageQuantity
. You can also filter and group your data by various
dimensions, such as SERVICE
or AZ
, in a specific time range. For a
complete list of valid dimensions, see the GetDimensionValues
operation. Management account in an organization in Organizations have
access to all member accounts.
For information about filter limitations, see Quotas and restrictions in the Billing and Cost Management User Guide.
1372 1373 1374 1375 |
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/client.rb', line 1372 def get_cost_and_usage(params = {}, = {}) req = build_request(:get_cost_and_usage, params) req.send_request() end |
#get_cost_and_usage_with_resources(params = {}) ⇒ Types::GetCostAndUsageWithResourcesResponse
Retrieves cost and usage metrics with resources for your account. You
can specify which cost and usage-related metric, such as
BlendedCosts
or UsageQuantity
, that you want the request to
return. You can also filter and group your data by various dimensions,
such as SERVICE
or AZ
, in a specific time range. For a complete
list of valid dimensions, see the GetDimensionValues operation.
Management account in an organization in Organizations have access to
all member accounts. This API is currently available for the Amazon
Elastic Compute Cloud – Compute service only.
1552 1553 1554 1555 |
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/client.rb', line 1552 def get_cost_and_usage_with_resources(params = {}, = {}) req = build_request(:get_cost_and_usage_with_resources, params) req.send_request() end |
#get_cost_categories(params = {}) ⇒ Types::GetCostCategoriesResponse
Retrieves an array of Cost Category names and values incurred cost.
1784 1785 1786 1787 |
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/client.rb', line 1784 def get_cost_categories(params = {}, = {}) req = build_request(:get_cost_categories, params) req.send_request() end |
#get_cost_forecast(params = {}) ⇒ Types::GetCostForecastResponse
Retrieves a forecast for how much Amazon Web Services predicts that you will spend over the forecast time period that you select, based on your past costs.
1946 1947 1948 1949 |
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/client.rb', line 1946 def get_cost_forecast(params = {}, = {}) req = build_request(:get_cost_forecast, params) req.send_request() end |
#get_dimension_values(params = {}) ⇒ Types::GetDimensionValuesResponse
Retrieves all available filter values for a specified filter over a period of time. You can search the dimension values for an arbitrary string.
2327 2328 2329 2330 |
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/client.rb', line 2327 def get_dimension_values(params = {}, = {}) req = build_request(:get_dimension_values, params) req.send_request() end |
#get_reservation_coverage(params = {}) ⇒ Types::GetReservationCoverageResponse
Retrieves the reservation coverage for your account, which you can use to see how much of your Amazon Elastic Compute Cloud, Amazon ElastiCache, Amazon Relational Database Service, or Amazon Redshift usage is covered by a reservation. An organization's management account can see the coverage of the associated member accounts. This supports dimensions, Cost Categories, and nested expressions. For any time period, you can filter data about reservation usage by the following dimensions:
AZ
CACHE_ENGINE
DATABASE_ENGINE
DEPLOYMENT_OPTION
INSTANCE_TYPE
LINKED_ACCOUNT
OPERATING_SYSTEM
PLATFORM
REGION
SERVICE
TAG
TENANCY
To determine valid values for a dimension, use the
GetDimensionValues
operation.
2599 2600 2601 2602 |
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/client.rb', line 2599 def get_reservation_coverage(params = {}, = {}) req = build_request(:get_reservation_coverage, params) req.send_request() end |
#get_reservation_purchase_recommendation(params = {}) ⇒ Types::GetReservationPurchaseRecommendationResponse
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.
2886 2887 2888 2889 |
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/client.rb', line 2886 def get_reservation_purchase_recommendation(params = {}, = {}) req = build_request(:get_reservation_purchase_recommendation, params) req.send_request() end |
#get_reservation_utilization(params = {}) ⇒ Types::GetReservationUtilizationResponse
Retrieves the reservation utilization for your account. Management
account in an organization have access to member accounts. You can
filter data by dimensions in a time period. You can use
GetDimensionValues
to determine the possible dimension values.
Currently, you can group only by SUBSCRIPTION_ID
.
3129 3130 3131 3132 |
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/client.rb', line 3129 def get_reservation_utilization(params = {}, = {}) req = build_request(:get_reservation_utilization, params) req.send_request() end |
#get_rightsizing_recommendation(params = {}) ⇒ Types::GetRightsizingRecommendationResponse
Creates recommendations that help you save cost by identifying idle and underutilized Amazon EC2 instances.
Recommendations are generated to either downsize or terminate instances, along with providing savings detail and metrics. For more information about calculation and function, see Optimizing Your Cost with Rightsizing Recommendations in the Billing and Cost Management User Guide.
3404 3405 3406 3407 |
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/client.rb', line 3404 def get_rightsizing_recommendation(params = {}, = {}) req = build_request(:get_rightsizing_recommendation, params) req.send_request() end |
#get_savings_plan_purchase_recommendation_details(params = {}) ⇒ Types::GetSavingsPlanPurchaseRecommendationDetailsResponse
Retrieves the details for a Savings Plan recommendation. These details include the hourly data-points that construct the cost, coverage, and utilization charts.
3469 3470 3471 3472 |
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/client.rb', line 3469 def get_savings_plan_purchase_recommendation_details(params = {}, = {}) req = build_request(:get_savings_plan_purchase_recommendation_details, params) req.send_request() end |
#get_savings_plans_coverage(params = {}) ⇒ Types::GetSavingsPlansCoverageResponse
Retrieves the Savings Plans covered for your account. This enables you to see how much of your cost is covered by a Savings Plan. An organization’s management account can see the coverage of the associated member accounts. This supports dimensions, Cost Categories, and nested expressions. For any time period, you can filter data for Savings Plans usage with the following dimensions:
LINKED_ACCOUNT
REGION
SERVICE
INSTANCE_FAMILY
To determine valid values for a dimension, use the
GetDimensionValues
operation.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3642 3643 3644 3645 |
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/client.rb', line 3642 def get_savings_plans_coverage(params = {}, = {}) req = build_request(:get_savings_plans_coverage, params) req.send_request() end |
#get_savings_plans_purchase_recommendation(params = {}) ⇒ Types::GetSavingsPlansPurchaseRecommendationResponse
Retrieves the Savings Plans recommendations for your account. First
use StartSavingsPlansPurchaseRecommendationGeneration
to generate a
new set of recommendations, and then use
GetSavingsPlansPurchaseRecommendation
to retrieve them.
3790 3791 3792 3793 |
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/client.rb', line 3790 def get_savings_plans_purchase_recommendation(params = {}, = {}) req = build_request(:get_savings_plans_purchase_recommendation, params) req.send_request() end |
#get_savings_plans_utilization(params = {}) ⇒ Types::GetSavingsPlansUtilizationResponse
Retrieves the Savings Plans utilization for your account across date
ranges with daily or monthly granularity. Management account in an
organization have access to member accounts. You can use
GetDimensionValues
in SAVINGS_PLANS
to determine the possible
dimension values.
GetSavingsPlansUtilization
.
3937 3938 3939 3940 |
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/client.rb', line 3937 def get_savings_plans_utilization(params = {}, = {}) req = build_request(:get_savings_plans_utilization, params) req.send_request() end |
#get_savings_plans_utilization_details(params = {}) ⇒ Types::GetSavingsPlansUtilizationDetailsResponse
Retrieves attribute data along with aggregate utilization and savings
data for a given time period. This doesn't support granular or
grouped data (daily/monthly) in response. You can't retrieve data by
dates in a single response similar to GetSavingsPlanUtilization
, but
you have the option to make multiple calls to
GetSavingsPlanUtilizationDetails
by providing individual dates. You
can use GetDimensionValues
in SAVINGS_PLANS
to determine the
possible dimension values.
GetSavingsPlanUtilizationDetails
internally groups data by
SavingsPlansArn
.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4104 4105 4106 4107 |
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/client.rb', line 4104 def get_savings_plans_utilization_details(params = {}, = {}) req = build_request(:get_savings_plans_utilization_details, params) req.send_request() end |
#get_tags(params = {}) ⇒ Types::GetTagsResponse
Queries for available tag keys and tag values for a specified period. You can search the tag values for an arbitrary string.
4324 4325 4326 4327 |
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/client.rb', line 4324 def (params = {}, = {}) req = build_request(:get_tags, params) req.send_request() end |
#get_usage_forecast(params = {}) ⇒ Types::GetUsageForecastResponse
Retrieves a forecast for how much Amazon Web Services predicts that you will use over the forecast time period that you select, based on your past usage.
4478 4479 4480 4481 |
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/client.rb', line 4478 def get_usage_forecast(params = {}, = {}) req = build_request(:get_usage_forecast, params) req.send_request() end |
#list_cost_allocation_tag_backfill_history(params = {}) ⇒ Types::ListCostAllocationTagBackfillHistoryResponse
Retrieves a list of your historical cost allocation tag backfill requests.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4522 4523 4524 4525 |
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/client.rb', line 4522 def list_cost_allocation_tag_backfill_history(params = {}, = {}) req = build_request(:list_cost_allocation_tag_backfill_history, params) req.send_request() end |
#list_cost_allocation_tags(params = {}) ⇒ Types::ListCostAllocationTagsResponse
Get a list of cost allocation tags. All inputs in the API are optional and serve as filters. By default, all cost allocation tags are returned.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4586 4587 4588 4589 |
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/client.rb', line 4586 def (params = {}, = {}) req = build_request(:list_cost_allocation_tags, params) req.send_request() end |
#list_cost_category_definitions(params = {}) ⇒ Types::ListCostCategoryDefinitionsResponse
Returns the name, Amazon Resource Name (ARN), NumberOfRules
and
effective dates of all Cost Categories defined in the account. You
have the option to use EffectiveOn
to return a list of Cost
Categories that were active on a specific date. If there is no
EffectiveOn
specified, you’ll see Cost Categories that are effective
on the current date. If Cost Category is still effective,
EffectiveEnd
is omitted in the response.
ListCostCategoryDefinitions
supports pagination. The request can
have a MaxResults
range up to 100.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4647 4648 4649 4650 |
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/client.rb', line 4647 def list_cost_category_definitions(params = {}, = {}) req = build_request(:list_cost_category_definitions, params) req.send_request() end |
#list_savings_plans_purchase_recommendation_generation(params = {}) ⇒ Types::ListSavingsPlansPurchaseRecommendationGenerationResponse
Retrieves a list of your historical recommendation generations within the past 30 days.
4696 4697 4698 4699 |
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/client.rb', line 4696 def list_savings_plans_purchase_recommendation_generation(params = {}, = {}) req = build_request(:list_savings_plans_purchase_recommendation_generation, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Returns a list of resource tags associated with the resource specified by the Amazon Resource Name (ARN).
4732 4733 4734 4735 |
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/client.rb', line 4732 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#provide_anomaly_feedback(params = {}) ⇒ Types::ProvideAnomalyFeedbackResponse
Modifies the feedback property of a given cost anomaly.
4765 4766 4767 4768 |
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/client.rb', line 4765 def provide_anomaly_feedback(params = {}, = {}) req = build_request(:provide_anomaly_feedback, params) req.send_request() end |
#start_cost_allocation_tag_backfill(params = {}) ⇒ Types::StartCostAllocationTagBackfillResponse
Request a cost allocation tag backfill. This will backfill the
activation status (either active
or inactive
) for all tag keys
from para:BackfillFrom
up to the when this request is made.
You can request a backfill once every 24 hours.
4803 4804 4805 4806 |
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/client.rb', line 4803 def start_cost_allocation_tag_backfill(params = {}, = {}) req = build_request(:start_cost_allocation_tag_backfill, params) req.send_request() end |
#start_savings_plans_purchase_recommendation_generation(params = {}) ⇒ Types::StartSavingsPlansPurchaseRecommendationGenerationResponse
Requests a Savings Plans recommendation generation. This enables you to calculate a fresh set of Savings Plans recommendations that takes your latest usage data and current Savings Plans inventory into account. You can refresh Savings Plans recommendations up to three times daily for a consolidated billing family.
StartSavingsPlansPurchaseRecommendationGeneration
has no request
syntax because no input parameters are needed to support this
operation.
4836 4837 4838 4839 |
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/client.rb', line 4836 def start_savings_plans_purchase_recommendation_generation(params = {}, = {}) req = build_request(:start_savings_plans_purchase_recommendation_generation, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
An API operation for adding one or more tags (key-value pairs) to a resource.
You can use the TagResource
operation with a resource that already
has tags. If you specify a new tag key for the resource, this tag is
appended to the list of tags associated with the resource. If you
specify a tag key that is already associated with the resource, the
new tag value you specify replaces the previous value for that tag.
Although the maximum number of array members is 200, user-tag maximum is 50. The remaining are reserved for Amazon Web Services use.
4903 4904 4905 4906 |
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/client.rb', line 4903 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes one or more tags from a resource. Specify only tag keys in your request. Don't specify the value.
4938 4939 4940 4941 |
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/client.rb', line 4938 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_anomaly_monitor(params = {}) ⇒ Types::UpdateAnomalyMonitorResponse
Updates an existing cost anomaly monitor. The changes made are applied going forward, and doesn't change anomalies detected in the past.
4971 4972 4973 4974 |
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/client.rb', line 4971 def update_anomaly_monitor(params = {}, = {}) req = build_request(:update_anomaly_monitor, params) req.send_request() end |
#update_anomaly_subscription(params = {}) ⇒ Types::UpdateAnomalySubscriptionResponse
Updates an existing cost anomaly subscription. Specify the fields that you want to update. Omitted fields are unchanged.
AnomalySubscription
.
5117 5118 5119 5120 |
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/client.rb', line 5117 def update_anomaly_subscription(params = {}, = {}) req = build_request(:update_anomaly_subscription, params) req.send_request() end |
#update_cost_allocation_tags_status(params = {}) ⇒ Types::UpdateCostAllocationTagsStatusResponse
Updates status for cost allocation tags in bulk, with maximum batch size of 20. If the tag status that's updated is the same as the existing tag status, the request doesn't fail. Instead, it doesn't have any effect on the tag status (for example, activating the active tag).
5158 5159 5160 5161 |
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/client.rb', line 5158 def (params = {}, = {}) req = build_request(:update_cost_allocation_tags_status, params) req.send_request() end |
#update_cost_category_definition(params = {}) ⇒ Types::UpdateCostCategoryDefinitionResponse
Updates an existing Cost Category. Changes made to the Cost Category rules will be used to categorize the current month’s expenses and future expenses. This won’t change categorization for the previous months.
5271 5272 5273 5274 |
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/client.rb', line 5271 def update_cost_category_definition(params = {}, = {}) req = build_request(:update_cost_category_definition, params) req.send_request() end |