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 a 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, 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 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_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.
-
#get_reservation_purchase_recommendation(params = {}) ⇒ Types::GetReservationPurchaseRecommendationResponse
Gets recommendations for which reservations to purchase.
-
#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_plans_coverage(params = {}) ⇒ Types::GetSavingsPlansCoverageResponse
Retrieves the Savings Plans covered for your account.
-
#get_savings_plans_purchase_recommendation(params = {}) ⇒ Types::GetSavingsPlansPurchaseRecommendationResponse
Retrieves your request parameters, Savings Plan Recommendations Summary and Details.
-
#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_category_definitions(params = {}) ⇒ Types::ListCostCategoryDefinitionsResponse
Returns the name, ARN,
NumberOfRules
and effective dates of all Cost Categories defined in the account. -
#provide_anomaly_feedback(params = {}) ⇒ Types::ProvideAnomalyFeedbackResponse
Modifies the feedback property of a given cost anomaly.
-
#update_anomaly_monitor(params = {}) ⇒ Types::UpdateAnomalyMonitorResponse
Updates an existing cost anomaly monitor.
-
#update_anomaly_subscription(params = {}) ⇒ Types::UpdateAnomalySubscriptionResponse
Updates an existing cost anomaly monitor subscription.
-
#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.
334 335 336 |
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/client.rb', line 334 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.
403 404 405 406 |
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/client.rb', line 403 def create_anomaly_monitor(params = {}, = {}) req = build_request(:create_anomaly_monitor, params) req.send_request() end |
#create_anomaly_subscription(params = {}) ⇒ Types::CreateAnomalySubscriptionResponse
Adds a subscription to a cost anomaly detection monitor. You can use each subscription to define subscribers with email or SNS notifications. Email subscribers can set a dollar threshold and a time frequency for receiving notifications.
448 449 450 451 |
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/client.rb', line 448 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.
525 526 527 528 |
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/client.rb', line 525 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.
548 549 550 551 |
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/client.rb', line 548 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.
571 572 573 574 |
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/client.rb', line 571 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.
602 603 604 605 |
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/client.rb', line 602 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, 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 is active on a specific date. If there is no EffectiveOn
specified, you’ll see a Cost Category that is effective on the current
date. If Cost Category is still effective, EffectiveEnd
is omitted
in the response.
670 671 672 673 |
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/client.rb', line 670 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 specified by the DateInterval
object.
750 751 752 753 |
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/client.rb', line 750 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).
820 821 822 823 |
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/client.rb', line 820 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).
877 878 879 880 |
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/client.rb', line 877 def get_anomaly_subscriptions(params = {}, = {}) req = build_request(:get_anomaly_subscriptions, 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, 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 AWS Organizations have access to all
member accounts.
For information about filter limitations, see Quotas and restrictions in the Billing and Cost Management User Guide.
1046 1047 1048 1049 |
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/client.rb', line 1046 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 AWS Organizations have access
to all member accounts. This API is currently available for the Amazon
Elastic Compute Cloud – Compute service only.
1219 1220 1221 1222 |
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/client.rb', line 1219 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.
1408 1409 1410 1411 |
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/client.rb', line 1408 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.
1524 1525 1526 1527 |
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/client.rb', line 1524 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.
1818 1819 1820 1821 |
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/client.rb', line 1818 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. This enables you 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.
2088 2089 2090 2091 |
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/client.rb', line 2088 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 which reservations to purchase. These recommendations could help you reduce your costs. Reservations provide a discounted hourly rate (up to 75%) compared to On-Demand pricing.
AWS 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 AWS has these categories, it simulates every combination of reservations in each category of usage to identify the best number of each type of RI to purchase to maximize your estimated savings.
For example, AWS 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. AWS recommends the smallest size instance in
an instance family. This makes it easier to purchase a size-flexible
RI. AWS also shows the equal number of normalized units so that you
can purchase any instance size that you want. For this example, your
RI recommendation would be for c4.large
because that is the smallest
size instance in the c4 instance family.
2328 2329 2330 2331 |
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/client.rb', line 2328 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
.
2570 2571 2572 2573 |
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/client.rb', line 2570 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 details on calculation and function, see Optimizing Your Cost with Rightsizing Recommendations in the AWS Billing and Cost Management User Guide.
2785 2786 2787 2788 |
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/client.rb', line 2785 def get_rightsizing_recommendation(params = {}, = {}) req = build_request(:get_rightsizing_recommendation, 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.
2958 2959 2960 2961 |
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/client.rb', line 2958 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 your request parameters, Savings Plan Recommendations Summary and Details.
3103 3104 3105 3106 |
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/client.rb', line 3103 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
.
3250 3251 3252 3253 |
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/client.rb', line 3250 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.
3417 3418 3419 3420 |
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/client.rb', line 3417 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.
3595 3596 3597 3598 |
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/client.rb', line 3595 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.
3703 3704 3705 3706 |
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/client.rb', line 3703 def get_usage_forecast(params = {}, = {}) req = build_request(:get_usage_forecast, params) req.send_request() end |
#list_cost_category_definitions(params = {}) ⇒ Types::ListCostCategoryDefinitionsResponse
Returns the 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.
3762 3763 3764 3765 |
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/client.rb', line 3762 def list_cost_category_definitions(params = {}, = {}) req = build_request(:list_cost_category_definitions, params) req.send_request() end |
#provide_anomaly_feedback(params = {}) ⇒ Types::ProvideAnomalyFeedbackResponse
Modifies the feedback property of a given cost anomaly.
3795 3796 3797 3798 |
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/client.rb', line 3795 def provide_anomaly_feedback(params = {}, = {}) req = build_request(:provide_anomaly_feedback, 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 does not change anomalies detected in the past.
3828 3829 3830 3831 |
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/client.rb', line 3828 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 monitor subscription.
3883 3884 3885 3886 |
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/client.rb', line 3883 def update_anomaly_subscription(params = {}, = {}) req = build_request(:update_anomaly_subscription, 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.
3963 3964 3965 3966 |
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/client.rb', line 3963 def update_cost_category_definition(params = {}, = {}) req = build_request(:update_cost_category_definition, params) req.send_request() end |