Class: Aws::CostExplorer::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::CostExplorer::Client
- Includes:
- Aws::ClientStubs
- Defined in:
- 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](/sdk-for-ruby/v3/developer-guide/setup-config.html).
See #initialize for a full list of supported configuration options.
Class Attribute Summary collapse
- .identifier ⇒ Object readonly private
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_commitment_purchase_analysis(params = {}) ⇒ Types::GetCommitmentPurchaseAnalysisResponse
Retrieves a commitment purchase analysis result based on the ‘AnalysisId`.
-
#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_commitment_purchase_analyses(params = {}) ⇒ Types::ListCommitmentPurchaseAnalysesResponse
Lists the commitment purchase analyses for your account.
-
#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_commitment_purchase_analysis(params = {}) ⇒ Types::StartCommitmentPurchaseAnalysisResponse
Specifies the parameters of a planned commitment purchase and starts the generation of the analysis.
-
#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.
Class Method Summary collapse
- .errors_module ⇒ Object private
Instance Method Summary collapse
- #build_request(operation_name, params = {}) ⇒ Object private
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
- #waiter_names ⇒ Object deprecated private Deprecated.
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
451 452 453 |
# File 'lib/aws-sdk-costexplorer/client.rb', line 451 def initialize(*args) super end |
Class Attribute Details
.identifier ⇒ Object (readonly)
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
5628 5629 5630 |
# File 'lib/aws-sdk-costexplorer/client.rb', line 5628 def identifier @identifier end |
Class Method Details
.errors_module ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
5631 5632 5633 |
# File 'lib/aws-sdk-costexplorer/client.rb', line 5631 def errors_module Errors end |
Instance Method Details
#build_request(operation_name, params = {}) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
5601 5602 5603 5604 5605 5606 5607 5608 5609 5610 5611 5612 5613 5614 5615 5616 5617 |
# File 'lib/aws-sdk-costexplorer/client.rb', line 5601 def build_request(operation_name, params = {}) handlers = @handlers.for(operation_name) tracer = config.telemetry_provider.tracer_provider.tracer( Aws::Telemetry.module_to_tracer_name('Aws::CostExplorer') ) context = Seahorse::Client::RequestContext.new( operation_name: operation_name, operation: config.api.operation(operation_name), client: self, params: params, config: config, tracer: tracer ) context[:gem_name] = 'aws-sdk-costexplorer' context[:gem_version] = '1.118.0' Seahorse::Client::Request.new(handlers, context) end |
#create_anomaly_monitor(params = {}) ⇒ Types::CreateAnomalyMonitorResponse
Creates a new cost anomaly detection monitor with the requested type and monitor specification.
556 557 558 559 |
# File 'lib/aws-sdk-costexplorer/client.rb', line 556 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.
667 668 669 670 |
# File 'lib/aws-sdk-costexplorer/client.rb', line 667 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.
813 814 815 816 |
# File 'lib/aws-sdk-costexplorer/client.rb', line 813 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.
836 837 838 839 |
# File 'lib/aws-sdk-costexplorer/client.rb', line 836 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.
859 860 861 862 |
# File 'lib/aws-sdk-costexplorer/client.rb', line 859 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.
890 891 892 893 |
# File 'lib/aws-sdk-costexplorer/client.rb', line 890 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.
971 972 973 974 |
# File 'lib/aws-sdk-costexplorer/client.rb', line 971 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.
1057 1058 1059 1060 |
# File 'lib/aws-sdk-costexplorer/client.rb', line 1057 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).
1127 1128 1129 1130 |
# File 'lib/aws-sdk-costexplorer/client.rb', line 1127 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).
1204 1205 1206 1207 |
# File 'lib/aws-sdk-costexplorer/client.rb', line 1204 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.
1251 1252 1253 1254 |
# File 'lib/aws-sdk-costexplorer/client.rb', line 1251 def get_approximate_usage_records(params = {}, = {}) req = build_request(:get_approximate_usage_records, params) req.send_request() end |
#get_commitment_purchase_analysis(params = {}) ⇒ Types::GetCommitmentPurchaseAnalysisResponse
Retrieves a commitment purchase analysis result based on the ‘AnalysisId`.
1335 1336 1337 1338 |
# File 'lib/aws-sdk-costexplorer/client.rb', line 1335 def get_commitment_purchase_analysis(params = {}, = {}) req = build_request(:get_commitment_purchase_analysis, 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*.
[1]: docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_GetDimensionValues.html [2]: docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/billing-limits.html
1522 1523 1524 1525 |
# File 'lib/aws-sdk-costexplorer/client.rb', line 1522 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.
Hourly granularity is only available for EC2-Instances (Elastic Compute Cloud) resource-level data. All other resource-level data is available at daily granularity.
<note markdown=“1”> This is an opt-in only feature. You can enable this feature from the Cost Explorer Settings page. For information about how to access the Settings page, see [Controlling Access for Cost Explorer] in the *Billing and Cost Management User Guide*.
</note>
[1]: docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_GetDimensionValues.html [2]: docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/ce-access.html
1714 1715 1716 1717 |
# File 'lib/aws-sdk-costexplorer/client.rb', line 1714 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.
<note markdown=“1”> If some Cost Category names and values are not associated with any cost, they will not be returned by this API.
</note>
1951 1952 1953 1954 |
# File 'lib/aws-sdk-costexplorer/client.rb', line 1951 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.
2122 2123 2124 2125 |
# File 'lib/aws-sdk-costexplorer/client.rb', line 2122 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.
2509 2510 2511 2512 |
# File 'lib/aws-sdk-costexplorer/client.rb', line 2509 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.
2781 2782 2783 2784 |
# File 'lib/aws-sdk-costexplorer/client.rb', line 2781 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.
3071 3072 3073 3074 |
# File 'lib/aws-sdk-costexplorer/client.rb', line 3071 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`.
3322 3323 3324 3325 |
# File 'lib/aws-sdk-costexplorer/client.rb', line 3322 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*.
[1]: docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/ce-rightsizing.html
3593 3594 3595 3596 |
# File 'lib/aws-sdk-costexplorer/client.rb', line 3593 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.
3658 3659 3660 3661 |
# File 'lib/aws-sdk-costexplorer/client.rb', line 3658 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.
3831 3832 3833 3834 |
# File 'lib/aws-sdk-costexplorer/client.rb', line 3831 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.
3979 3980 3981 3982 |
# File 'lib/aws-sdk-costexplorer/client.rb', line 3979 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.
<note markdown=“1”> You can’t group by any dimension values for ‘GetSavingsPlansUtilization`.
</note>
4126 4127 4128 4129 |
# File 'lib/aws-sdk-costexplorer/client.rb', line 4126 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.
<note markdown=“1”> ‘GetSavingsPlanUtilizationDetails` internally groups data by `SavingsPlansArn`.
</note>
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4293 4294 4295 4296 |
# File 'lib/aws-sdk-costexplorer/client.rb', line 4293 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.
4518 4519 4520 4521 |
# File 'lib/aws-sdk-costexplorer/client.rb', line 4518 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.
4681 4682 4683 4684 |
# File 'lib/aws-sdk-costexplorer/client.rb', line 4681 def get_usage_forecast(params = {}, = {}) req = build_request(:get_usage_forecast, params) req.send_request() end |
#list_commitment_purchase_analyses(params = {}) ⇒ Types::ListCommitmentPurchaseAnalysesResponse
Lists the commitment purchase analyses for your account.
4745 4746 4747 4748 |
# File 'lib/aws-sdk-costexplorer/client.rb', line 4745 def list_commitment_purchase_analyses(params = {}, = {}) req = build_request(:list_commitment_purchase_analyses, 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.
4789 4790 4791 4792 |
# File 'lib/aws-sdk-costexplorer/client.rb', line 4789 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.
4853 4854 4855 4856 |
# File 'lib/aws-sdk-costexplorer/client.rb', line 4853 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.
4914 4915 4916 4917 |
# File 'lib/aws-sdk-costexplorer/client.rb', line 4914 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.
4963 4964 4965 4966 |
# File 'lib/aws-sdk-costexplorer/client.rb', line 4963 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).
4999 5000 5001 5002 |
# File 'lib/aws-sdk-costexplorer/client.rb', line 4999 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.
5032 5033 5034 5035 |
# File 'lib/aws-sdk-costexplorer/client.rb', line 5032 def provide_anomaly_feedback(params = {}, = {}) req = build_request(:provide_anomaly_feedback, params) req.send_request() end |
#start_commitment_purchase_analysis(params = {}) ⇒ Types::StartCommitmentPurchaseAnalysisResponse
Specifies the parameters of a planned commitment purchase and starts the generation of the analysis. This enables you to estimate the cost, coverage, and utilization impact of your planned commitment purchases.
5088 5089 5090 5091 |
# File 'lib/aws-sdk-costexplorer/client.rb', line 5088 def start_commitment_purchase_analysis(params = {}, = {}) req = build_request(:start_commitment_purchase_analysis, 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.
5126 5127 5128 5129 |
# File 'lib/aws-sdk-costexplorer/client.rb', line 5126 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.
<note markdown=“1”> ‘StartSavingsPlansPurchaseRecommendationGeneration` has no request syntax because no input parameters are needed to support this operation.
</note>
5159 5160 5161 5162 |
# File 'lib/aws-sdk-costexplorer/client.rb', line 5159 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.
5226 5227 5228 5229 |
# File 'lib/aws-sdk-costexplorer/client.rb', line 5226 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.
5261 5262 5263 5264 |
# File 'lib/aws-sdk-costexplorer/client.rb', line 5261 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.
5294 5295 5296 5297 |
# File 'lib/aws-sdk-costexplorer/client.rb', line 5294 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.
<note markdown=“1”> The JSON below describes the generic construct for each type. See
- Request Parameters][1
-
for possible values as they apply to
‘AnomalySubscription`.
</note>
5438 5439 5440 5441 |
# File 'lib/aws-sdk-costexplorer/client.rb', line 5438 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).
5479 5480 5481 5482 |
# File 'lib/aws-sdk-costexplorer/client.rb', line 5479 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.
5592 5593 5594 5595 |
# File 'lib/aws-sdk-costexplorer/client.rb', line 5592 def update_cost_category_definition(params = {}, = {}) req = build_request(:update_cost_category_definition, params) req.send_request() end |
#waiter_names ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
5621 5622 5623 |
# File 'lib/aws-sdk-costexplorer/client.rb', line 5621 def waiter_names [] end |