aws-sdk-costexplorer 1.115.0 → 1.116.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-costexplorer/client.rb +218 -4
- data/lib/aws-sdk-costexplorer/client_api.rb +156 -0
- data/lib/aws-sdk-costexplorer/errors.rb +16 -0
- data/lib/aws-sdk-costexplorer/types.rb +459 -8
- data/lib/aws-sdk-costexplorer.rb +1 -1
- data/sig/client.rbs +65 -0
- data/sig/errors.rbs +3 -0
- data/sig/types.rbs +116 -0
- metadata +2 -2
@@ -10,6 +10,77 @@
|
|
10
10
|
module Aws::CostExplorer
|
11
11
|
module Types
|
12
12
|
|
13
|
+
# Details about the analysis.
|
14
|
+
#
|
15
|
+
# @!attribute [rw] savings_plans_purchase_analysis_details
|
16
|
+
# Details about the Savings Plans purchase analysis.
|
17
|
+
# @return [Types::SavingsPlansPurchaseAnalysisDetails]
|
18
|
+
#
|
19
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ce-2017-10-25/AnalysisDetails AWS API Documentation
|
20
|
+
#
|
21
|
+
class AnalysisDetails < Struct.new(
|
22
|
+
:savings_plans_purchase_analysis_details)
|
23
|
+
SENSITIVE = []
|
24
|
+
include Aws::Structure
|
25
|
+
end
|
26
|
+
|
27
|
+
# The requested analysis can't be found.
|
28
|
+
#
|
29
|
+
# @!attribute [rw] message
|
30
|
+
# @return [String]
|
31
|
+
#
|
32
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ce-2017-10-25/AnalysisNotFoundException AWS API Documentation
|
33
|
+
#
|
34
|
+
class AnalysisNotFoundException < Struct.new(
|
35
|
+
:message)
|
36
|
+
SENSITIVE = []
|
37
|
+
include Aws::Structure
|
38
|
+
end
|
39
|
+
|
40
|
+
# A summary of the analysis.
|
41
|
+
#
|
42
|
+
# @!attribute [rw] estimated_completion_time
|
43
|
+
# The estimated time for when the analysis will complete.
|
44
|
+
# @return [String]
|
45
|
+
#
|
46
|
+
# @!attribute [rw] analysis_completion_time
|
47
|
+
# The completion time of the analysis.
|
48
|
+
# @return [String]
|
49
|
+
#
|
50
|
+
# @!attribute [rw] analysis_started_time
|
51
|
+
# The start time of the analysis.
|
52
|
+
# @return [String]
|
53
|
+
#
|
54
|
+
# @!attribute [rw] analysis_status
|
55
|
+
# The status of the analysis.
|
56
|
+
# @return [String]
|
57
|
+
#
|
58
|
+
# @!attribute [rw] error_code
|
59
|
+
# The error code used for the analysis.
|
60
|
+
# @return [String]
|
61
|
+
#
|
62
|
+
# @!attribute [rw] analysis_id
|
63
|
+
# The analysis ID that's associated with the commitment purchase.
|
64
|
+
# @return [String]
|
65
|
+
#
|
66
|
+
# @!attribute [rw] commitment_purchase_analysis_configuration
|
67
|
+
# The analysis configuration for the commitment purchase analysis.
|
68
|
+
# @return [Types::CommitmentPurchaseAnalysisConfiguration]
|
69
|
+
#
|
70
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ce-2017-10-25/AnalysisSummary AWS API Documentation
|
71
|
+
#
|
72
|
+
class AnalysisSummary < Struct.new(
|
73
|
+
:estimated_completion_time,
|
74
|
+
:analysis_completion_time,
|
75
|
+
:analysis_started_time,
|
76
|
+
:analysis_status,
|
77
|
+
:error_code,
|
78
|
+
:analysis_id,
|
79
|
+
:commitment_purchase_analysis_configuration)
|
80
|
+
SENSITIVE = []
|
81
|
+
include Aws::Structure
|
82
|
+
end
|
83
|
+
|
13
84
|
# An unusual cost pattern. This consists of the detailed metadata and
|
14
85
|
# the current status of the anomaly object.
|
15
86
|
#
|
@@ -26,8 +97,8 @@ module Aws::CostExplorer
|
|
26
97
|
# @return [String]
|
27
98
|
#
|
28
99
|
# @!attribute [rw] dimension_value
|
29
|
-
# The dimension for the anomaly (for example, an Amazon Web
|
30
|
-
#
|
100
|
+
# The dimension for the anomaly (for example, an Amazon Web Services
|
101
|
+
# service in a service monitor).
|
31
102
|
# @return [String]
|
32
103
|
#
|
33
104
|
# @!attribute [rw] root_causes
|
@@ -410,6 +481,20 @@ module Aws::CostExplorer
|
|
410
481
|
include Aws::Structure
|
411
482
|
end
|
412
483
|
|
484
|
+
# The configuration for the commitment purchase analysis.
|
485
|
+
#
|
486
|
+
# @!attribute [rw] savings_plans_purchase_analysis_configuration
|
487
|
+
# The configuration for the Savings Plans purchase analysis.
|
488
|
+
# @return [Types::SavingsPlansPurchaseAnalysisConfiguration]
|
489
|
+
#
|
490
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ce-2017-10-25/CommitmentPurchaseAnalysisConfiguration AWS API Documentation
|
491
|
+
#
|
492
|
+
class CommitmentPurchaseAnalysisConfiguration < Struct.new(
|
493
|
+
:savings_plans_purchase_analysis_configuration)
|
494
|
+
SENSITIVE = []
|
495
|
+
include Aws::Structure
|
496
|
+
end
|
497
|
+
|
413
498
|
# The cost allocation tag structure. This includes detailed metadata for
|
414
499
|
# the `CostAllocationTag` object.
|
415
500
|
#
|
@@ -681,7 +766,8 @@ module Aws::CostExplorer
|
|
681
766
|
# An [Expression][1] object used to categorize costs. This supports
|
682
767
|
# dimensions, tags, and nested expressions. Currently the only
|
683
768
|
# dimensions supported are `LINKED_ACCOUNT`, `SERVICE_CODE`,
|
684
|
-
# `RECORD_TYPE`, `LINKED_ACCOUNT_NAME`, `REGION`,
|
769
|
+
# `RECORD_TYPE`, `LINKED_ACCOUNT_NAME`, `REGION`, `USAGE_TYPE`, and
|
770
|
+
# `BILLING_ENTITY`.
|
685
771
|
#
|
686
772
|
# `RECORD_TYPE` is a dimension used for Cost Explorer APIs, and is
|
687
773
|
# also supported for Cost Category expressions. This dimension uses
|
@@ -2188,6 +2274,67 @@ module Aws::CostExplorer
|
|
2188
2274
|
include Aws::Structure
|
2189
2275
|
end
|
2190
2276
|
|
2277
|
+
# @!attribute [rw] analysis_id
|
2278
|
+
# The analysis ID that's associated with the commitment purchase
|
2279
|
+
# analysis.
|
2280
|
+
# @return [String]
|
2281
|
+
#
|
2282
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ce-2017-10-25/GetCommitmentPurchaseAnalysisRequest AWS API Documentation
|
2283
|
+
#
|
2284
|
+
class GetCommitmentPurchaseAnalysisRequest < Struct.new(
|
2285
|
+
:analysis_id)
|
2286
|
+
SENSITIVE = []
|
2287
|
+
include Aws::Structure
|
2288
|
+
end
|
2289
|
+
|
2290
|
+
# @!attribute [rw] estimated_completion_time
|
2291
|
+
# The estimated time for when the analysis will complete.
|
2292
|
+
# @return [String]
|
2293
|
+
#
|
2294
|
+
# @!attribute [rw] analysis_completion_time
|
2295
|
+
# The completion time of the analysis.
|
2296
|
+
# @return [String]
|
2297
|
+
#
|
2298
|
+
# @!attribute [rw] analysis_started_time
|
2299
|
+
# The start time of the analysis.
|
2300
|
+
# @return [String]
|
2301
|
+
#
|
2302
|
+
# @!attribute [rw] analysis_id
|
2303
|
+
# The analysis ID that's associated with the commitment purchase
|
2304
|
+
# analysis.
|
2305
|
+
# @return [String]
|
2306
|
+
#
|
2307
|
+
# @!attribute [rw] analysis_status
|
2308
|
+
# The status of the analysis.
|
2309
|
+
# @return [String]
|
2310
|
+
#
|
2311
|
+
# @!attribute [rw] error_code
|
2312
|
+
# The error code used for the analysis.
|
2313
|
+
# @return [String]
|
2314
|
+
#
|
2315
|
+
# @!attribute [rw] analysis_details
|
2316
|
+
# Details about the analysis.
|
2317
|
+
# @return [Types::AnalysisDetails]
|
2318
|
+
#
|
2319
|
+
# @!attribute [rw] commitment_purchase_analysis_configuration
|
2320
|
+
# The configuration for the commitment purchase analysis.
|
2321
|
+
# @return [Types::CommitmentPurchaseAnalysisConfiguration]
|
2322
|
+
#
|
2323
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ce-2017-10-25/GetCommitmentPurchaseAnalysisResponse AWS API Documentation
|
2324
|
+
#
|
2325
|
+
class GetCommitmentPurchaseAnalysisResponse < Struct.new(
|
2326
|
+
:estimated_completion_time,
|
2327
|
+
:analysis_completion_time,
|
2328
|
+
:analysis_started_time,
|
2329
|
+
:analysis_id,
|
2330
|
+
:analysis_status,
|
2331
|
+
:error_code,
|
2332
|
+
:analysis_details,
|
2333
|
+
:commitment_purchase_analysis_configuration)
|
2334
|
+
SENSITIVE = []
|
2335
|
+
include Aws::Structure
|
2336
|
+
end
|
2337
|
+
|
2191
2338
|
# @!attribute [rw] time_period
|
2192
2339
|
# Sets the start date and end date for retrieving Amazon Web Services
|
2193
2340
|
# costs. The start date is inclusive, but the end date is exclusive.
|
@@ -2811,10 +2958,10 @@ module Aws::CostExplorer
|
|
2811
2958
|
# is with. Possible values are the following:
|
2812
2959
|
#
|
2813
2960
|
# \- Amazon Web Services(Amazon Web Services): The entity that sells
|
2814
|
-
# Amazon Web
|
2961
|
+
# Amazon Web Services services.
|
2815
2962
|
#
|
2816
2963
|
# \- AISPL (Amazon Internet Services Pvt. Ltd.): The local Indian
|
2817
|
-
# entity that's an acting reseller for Amazon Web
|
2964
|
+
# entity that's an acting reseller for Amazon Web Services services
|
2818
2965
|
# in India.
|
2819
2966
|
#
|
2820
2967
|
# \- Amazon Web Services Marketplace: The entity that supports the
|
@@ -3628,6 +3775,15 @@ module Aws::CostExplorer
|
|
3628
3775
|
#
|
3629
3776
|
# * SERVICE
|
3630
3777
|
#
|
3778
|
+
# <note markdown="1"> If not specified, the `SERVICE` filter defaults to Amazon Elastic
|
3779
|
+
# Compute Cloud - Compute. Supported values for `SERVICE` are Amazon
|
3780
|
+
# Elastic Compute Cloud - Compute, Amazon Relational Database
|
3781
|
+
# Service, Amazon ElastiCache, Amazon Redshift, and Amazon
|
3782
|
+
# Elasticsearch Service. The value for the `SERVICE` filter should
|
3783
|
+
# not exceed "1".
|
3784
|
+
#
|
3785
|
+
# </note>
|
3786
|
+
#
|
3631
3787
|
# * SCOPE
|
3632
3788
|
#
|
3633
3789
|
# * TENANCY
|
@@ -4809,6 +4965,51 @@ module Aws::CostExplorer
|
|
4809
4965
|
include Aws::Structure
|
4810
4966
|
end
|
4811
4967
|
|
4968
|
+
# @!attribute [rw] analysis_status
|
4969
|
+
# The status of the analysis.
|
4970
|
+
# @return [String]
|
4971
|
+
#
|
4972
|
+
# @!attribute [rw] next_page_token
|
4973
|
+
# The token to retrieve the next set of results.
|
4974
|
+
# @return [String]
|
4975
|
+
#
|
4976
|
+
# @!attribute [rw] page_size
|
4977
|
+
# The number of analyses that you want returned in a single response
|
4978
|
+
# object.
|
4979
|
+
# @return [Integer]
|
4980
|
+
#
|
4981
|
+
# @!attribute [rw] analysis_ids
|
4982
|
+
# The analysis IDs associated with the commitment purchase analyses.
|
4983
|
+
# @return [Array<String>]
|
4984
|
+
#
|
4985
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ce-2017-10-25/ListCommitmentPurchaseAnalysesRequest AWS API Documentation
|
4986
|
+
#
|
4987
|
+
class ListCommitmentPurchaseAnalysesRequest < Struct.new(
|
4988
|
+
:analysis_status,
|
4989
|
+
:next_page_token,
|
4990
|
+
:page_size,
|
4991
|
+
:analysis_ids)
|
4992
|
+
SENSITIVE = []
|
4993
|
+
include Aws::Structure
|
4994
|
+
end
|
4995
|
+
|
4996
|
+
# @!attribute [rw] analysis_summary_list
|
4997
|
+
# The list of analyses.
|
4998
|
+
# @return [Array<Types::AnalysisSummary>]
|
4999
|
+
#
|
5000
|
+
# @!attribute [rw] next_page_token
|
5001
|
+
# The token to retrieve the next set of results.
|
5002
|
+
# @return [String]
|
5003
|
+
#
|
5004
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ce-2017-10-25/ListCommitmentPurchaseAnalysesResponse AWS API Documentation
|
5005
|
+
#
|
5006
|
+
class ListCommitmentPurchaseAnalysesResponse < Struct.new(
|
5007
|
+
:analysis_summary_list,
|
5008
|
+
:next_page_token)
|
5009
|
+
SENSITIVE = []
|
5010
|
+
include Aws::Structure
|
5011
|
+
end
|
5012
|
+
|
4812
5013
|
# @!attribute [rw] next_token
|
4813
5014
|
# The token to retrieve the next set of results. Amazon Web Services
|
4814
5015
|
# provides the token when the response from a previous call has more
|
@@ -6159,14 +6360,14 @@ module Aws::CostExplorer
|
|
6159
6360
|
include Aws::Structure
|
6160
6361
|
end
|
6161
6362
|
|
6162
|
-
# The combination of Amazon Web
|
6363
|
+
# The combination of Amazon Web Services service, linked account, linked
|
6163
6364
|
# account name, Region, and usage type where a cost anomaly is observed.
|
6164
6365
|
# The linked account name will only be available when the account name
|
6165
6366
|
# can be identified.
|
6166
6367
|
#
|
6167
6368
|
# @!attribute [rw] service
|
6168
|
-
# The Amazon Web
|
6169
|
-
# anomaly.
|
6369
|
+
# The Amazon Web Services service name that's associated with the
|
6370
|
+
# cost anomaly.
|
6170
6371
|
# @return [String]
|
6171
6372
|
#
|
6172
6373
|
# @!attribute [rw] region
|
@@ -6199,6 +6400,51 @@ module Aws::CostExplorer
|
|
6199
6400
|
include Aws::Structure
|
6200
6401
|
end
|
6201
6402
|
|
6403
|
+
# The Savings Plans commitment details.
|
6404
|
+
#
|
6405
|
+
# @!attribute [rw] payment_option
|
6406
|
+
# The payment option for the Savings Plans commitment.
|
6407
|
+
# @return [String]
|
6408
|
+
#
|
6409
|
+
# @!attribute [rw] savings_plans_type
|
6410
|
+
# The Savings Plans type.
|
6411
|
+
# @return [String]
|
6412
|
+
#
|
6413
|
+
# @!attribute [rw] region
|
6414
|
+
# The Region associated with the Savings Plans commitment.
|
6415
|
+
# @return [String]
|
6416
|
+
#
|
6417
|
+
# @!attribute [rw] instance_family
|
6418
|
+
# The instance family of the Savings Plans commitment.
|
6419
|
+
# @return [String]
|
6420
|
+
#
|
6421
|
+
# @!attribute [rw] term_in_years
|
6422
|
+
# The term that you want the Savings Plans commitment for.
|
6423
|
+
# @return [String]
|
6424
|
+
#
|
6425
|
+
# @!attribute [rw] savings_plans_commitment
|
6426
|
+
# The Savings Plans commitment.
|
6427
|
+
# @return [Float]
|
6428
|
+
#
|
6429
|
+
# @!attribute [rw] offering_id
|
6430
|
+
# The unique ID that's used to distinguish commitments from one
|
6431
|
+
# another.
|
6432
|
+
# @return [String]
|
6433
|
+
#
|
6434
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ce-2017-10-25/SavingsPlans AWS API Documentation
|
6435
|
+
#
|
6436
|
+
class SavingsPlans < Struct.new(
|
6437
|
+
:payment_option,
|
6438
|
+
:savings_plans_type,
|
6439
|
+
:region,
|
6440
|
+
:instance_family,
|
6441
|
+
:term_in_years,
|
6442
|
+
:savings_plans_commitment,
|
6443
|
+
:offering_id)
|
6444
|
+
SENSITIVE = []
|
6445
|
+
include Aws::Structure
|
6446
|
+
end
|
6447
|
+
|
6202
6448
|
# The amortized amount of Savings Plans purchased in a specific account
|
6203
6449
|
# during a specific time interval.
|
6204
6450
|
#
|
@@ -6316,6 +6562,176 @@ module Aws::CostExplorer
|
|
6316
6562
|
include Aws::Structure
|
6317
6563
|
end
|
6318
6564
|
|
6565
|
+
# The configuration for the Savings Plans purchase analysis.
|
6566
|
+
#
|
6567
|
+
# @!attribute [rw] account_scope
|
6568
|
+
# The account scope that you want your analysis for.
|
6569
|
+
# @return [String]
|
6570
|
+
#
|
6571
|
+
# @!attribute [rw] account_id
|
6572
|
+
# The account that the analysis is for.
|
6573
|
+
# @return [String]
|
6574
|
+
#
|
6575
|
+
# @!attribute [rw] analysis_type
|
6576
|
+
# The type of analysis.
|
6577
|
+
# @return [String]
|
6578
|
+
#
|
6579
|
+
# @!attribute [rw] savings_plans_to_add
|
6580
|
+
# Savings Plans to include in the analysis.
|
6581
|
+
# @return [Array<Types::SavingsPlans>]
|
6582
|
+
#
|
6583
|
+
# @!attribute [rw] savings_plans_to_exclude
|
6584
|
+
# Savings Plans to exclude from the analysis.
|
6585
|
+
# @return [Array<String>]
|
6586
|
+
#
|
6587
|
+
# @!attribute [rw] look_back_time_period
|
6588
|
+
# The time period associated with the analysis.
|
6589
|
+
# @return [Types::DateInterval]
|
6590
|
+
#
|
6591
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ce-2017-10-25/SavingsPlansPurchaseAnalysisConfiguration AWS API Documentation
|
6592
|
+
#
|
6593
|
+
class SavingsPlansPurchaseAnalysisConfiguration < Struct.new(
|
6594
|
+
:account_scope,
|
6595
|
+
:account_id,
|
6596
|
+
:analysis_type,
|
6597
|
+
:savings_plans_to_add,
|
6598
|
+
:savings_plans_to_exclude,
|
6599
|
+
:look_back_time_period)
|
6600
|
+
SENSITIVE = []
|
6601
|
+
include Aws::Structure
|
6602
|
+
end
|
6603
|
+
|
6604
|
+
# Details about the Savings Plans purchase analysis.
|
6605
|
+
#
|
6606
|
+
# @!attribute [rw] currency_code
|
6607
|
+
# The currency code used for the analysis.
|
6608
|
+
# @return [String]
|
6609
|
+
#
|
6610
|
+
# @!attribute [rw] lookback_period_in_hours
|
6611
|
+
# The lookback period in hours that's used to generate the analysis.
|
6612
|
+
# @return [String]
|
6613
|
+
#
|
6614
|
+
# @!attribute [rw] current_average_coverage
|
6615
|
+
# The average value of hourly coverage over the lookback period.
|
6616
|
+
# @return [String]
|
6617
|
+
#
|
6618
|
+
# @!attribute [rw] current_average_hourly_on_demand_spend
|
6619
|
+
# The average value of hourly On-Demand spend over the lookback
|
6620
|
+
# period.
|
6621
|
+
# @return [String]
|
6622
|
+
#
|
6623
|
+
# @!attribute [rw] current_maximum_hourly_on_demand_spend
|
6624
|
+
# The highest value of hourly On-Demand spend over the lookback
|
6625
|
+
# period.
|
6626
|
+
# @return [String]
|
6627
|
+
#
|
6628
|
+
# @!attribute [rw] current_minimum_hourly_on_demand_spend
|
6629
|
+
# The lowest value of hourly On-Demand spend over the lookback period.
|
6630
|
+
# @return [String]
|
6631
|
+
#
|
6632
|
+
# @!attribute [rw] current_on_demand_spend
|
6633
|
+
# The current total On-Demand spend over the lookback period.
|
6634
|
+
# @return [String]
|
6635
|
+
#
|
6636
|
+
# @!attribute [rw] existing_hourly_commitment
|
6637
|
+
# The existing hourly commitment for the Savings Plan type.
|
6638
|
+
# @return [String]
|
6639
|
+
#
|
6640
|
+
# @!attribute [rw] hourly_commitment_to_purchase
|
6641
|
+
# The recommended or custom hourly commitment.
|
6642
|
+
# @return [String]
|
6643
|
+
#
|
6644
|
+
# @!attribute [rw] estimated_average_coverage
|
6645
|
+
# The estimated coverage of the Savings Plan.
|
6646
|
+
# @return [String]
|
6647
|
+
#
|
6648
|
+
# @!attribute [rw] estimated_average_utilization
|
6649
|
+
# The estimated utilization of the Savings Plan.
|
6650
|
+
# @return [String]
|
6651
|
+
#
|
6652
|
+
# @!attribute [rw] estimated_monthly_savings_amount
|
6653
|
+
# The estimated monthly savings amount based on the Savings Plan.
|
6654
|
+
# @return [String]
|
6655
|
+
#
|
6656
|
+
# @!attribute [rw] estimated_on_demand_cost
|
6657
|
+
# The remaining On-Demand cost estimated to not be covered by the
|
6658
|
+
# commitment, over the length of the lookback period.
|
6659
|
+
# @return [String]
|
6660
|
+
#
|
6661
|
+
# @!attribute [rw] estimated_on_demand_cost_with_current_commitment
|
6662
|
+
# The estimated On-Demand cost you expect with no additional
|
6663
|
+
# commitment, based on your usage of the selected time period and the
|
6664
|
+
# Savings Plan you own.
|
6665
|
+
# @return [String]
|
6666
|
+
#
|
6667
|
+
# @!attribute [rw] estimated_roi
|
6668
|
+
# The estimated return on investment that's based on the purchase
|
6669
|
+
# commitment and estimated savings. This is calculated as
|
6670
|
+
# estimatedSavingsAmount/estimatedSPCost*100.
|
6671
|
+
# @return [String]
|
6672
|
+
#
|
6673
|
+
# @!attribute [rw] estimated_savings_amount
|
6674
|
+
# The estimated savings amount that's based on the purchase
|
6675
|
+
# commitment over the length of the lookback period.
|
6676
|
+
# @return [String]
|
6677
|
+
#
|
6678
|
+
# @!attribute [rw] estimated_savings_percentage
|
6679
|
+
# The estimated savings percentage relative to the total cost over the
|
6680
|
+
# cost calculation lookback period.
|
6681
|
+
# @return [String]
|
6682
|
+
#
|
6683
|
+
# @!attribute [rw] estimated_commitment_cost
|
6684
|
+
# The estimated cost of the purchase commitment over the length of the
|
6685
|
+
# lookback period.
|
6686
|
+
# @return [String]
|
6687
|
+
#
|
6688
|
+
# @!attribute [rw] latest_usage_timestamp
|
6689
|
+
# The date and time of the last hour that went into the analysis.
|
6690
|
+
# @return [String]
|
6691
|
+
#
|
6692
|
+
# @!attribute [rw] upfront_cost
|
6693
|
+
# The upfront cost of the Savings Plan, based on the selected payment
|
6694
|
+
# option.
|
6695
|
+
# @return [String]
|
6696
|
+
#
|
6697
|
+
# @!attribute [rw] additional_metadata
|
6698
|
+
# Additional metadata that might be applicable to the commitment.
|
6699
|
+
# @return [String]
|
6700
|
+
#
|
6701
|
+
# @!attribute [rw] metrics_over_lookback_period
|
6702
|
+
# The related hourly cost, coverage, and utilization metrics over the
|
6703
|
+
# lookback period.
|
6704
|
+
# @return [Array<Types::RecommendationDetailHourlyMetrics>]
|
6705
|
+
#
|
6706
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ce-2017-10-25/SavingsPlansPurchaseAnalysisDetails AWS API Documentation
|
6707
|
+
#
|
6708
|
+
class SavingsPlansPurchaseAnalysisDetails < Struct.new(
|
6709
|
+
:currency_code,
|
6710
|
+
:lookback_period_in_hours,
|
6711
|
+
:current_average_coverage,
|
6712
|
+
:current_average_hourly_on_demand_spend,
|
6713
|
+
:current_maximum_hourly_on_demand_spend,
|
6714
|
+
:current_minimum_hourly_on_demand_spend,
|
6715
|
+
:current_on_demand_spend,
|
6716
|
+
:existing_hourly_commitment,
|
6717
|
+
:hourly_commitment_to_purchase,
|
6718
|
+
:estimated_average_coverage,
|
6719
|
+
:estimated_average_utilization,
|
6720
|
+
:estimated_monthly_savings_amount,
|
6721
|
+
:estimated_on_demand_cost,
|
6722
|
+
:estimated_on_demand_cost_with_current_commitment,
|
6723
|
+
:estimated_roi,
|
6724
|
+
:estimated_savings_amount,
|
6725
|
+
:estimated_savings_percentage,
|
6726
|
+
:estimated_commitment_cost,
|
6727
|
+
:latest_usage_timestamp,
|
6728
|
+
:upfront_cost,
|
6729
|
+
:additional_metadata,
|
6730
|
+
:metrics_over_lookback_period)
|
6731
|
+
SENSITIVE = []
|
6732
|
+
include Aws::Structure
|
6733
|
+
end
|
6734
|
+
|
6319
6735
|
# Contains your request parameters, Savings Plan Recommendations
|
6320
6736
|
# Summary, and Details.
|
6321
6737
|
#
|
@@ -6790,6 +7206,41 @@ module Aws::CostExplorer
|
|
6790
7206
|
include Aws::Structure
|
6791
7207
|
end
|
6792
7208
|
|
7209
|
+
# @!attribute [rw] commitment_purchase_analysis_configuration
|
7210
|
+
# The configuration for the commitment purchase analysis.
|
7211
|
+
# @return [Types::CommitmentPurchaseAnalysisConfiguration]
|
7212
|
+
#
|
7213
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ce-2017-10-25/StartCommitmentPurchaseAnalysisRequest AWS API Documentation
|
7214
|
+
#
|
7215
|
+
class StartCommitmentPurchaseAnalysisRequest < Struct.new(
|
7216
|
+
:commitment_purchase_analysis_configuration)
|
7217
|
+
SENSITIVE = []
|
7218
|
+
include Aws::Structure
|
7219
|
+
end
|
7220
|
+
|
7221
|
+
# @!attribute [rw] analysis_id
|
7222
|
+
# The analysis ID that's associated with the commitment purchase
|
7223
|
+
# analysis.
|
7224
|
+
# @return [String]
|
7225
|
+
#
|
7226
|
+
# @!attribute [rw] analysis_started_time
|
7227
|
+
# The start time of the analysis.
|
7228
|
+
# @return [String]
|
7229
|
+
#
|
7230
|
+
# @!attribute [rw] estimated_completion_time
|
7231
|
+
# The estimated time for when the analysis will complete.
|
7232
|
+
# @return [String]
|
7233
|
+
#
|
7234
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ce-2017-10-25/StartCommitmentPurchaseAnalysisResponse AWS API Documentation
|
7235
|
+
#
|
7236
|
+
class StartCommitmentPurchaseAnalysisResponse < Struct.new(
|
7237
|
+
:analysis_id,
|
7238
|
+
:analysis_started_time,
|
7239
|
+
:estimated_completion_time)
|
7240
|
+
SENSITIVE = []
|
7241
|
+
include Aws::Structure
|
7242
|
+
end
|
7243
|
+
|
6793
7244
|
# @!attribute [rw] backfill_from
|
6794
7245
|
# The date you want the backfill to start from. The date can only be a
|
6795
7246
|
# first day of the month (a billing start date). Dates can't precede
|
data/lib/aws-sdk-costexplorer.rb
CHANGED
data/sig/client.rbs
CHANGED
@@ -350,6 +350,23 @@ module Aws
|
|
350
350
|
) -> _GetApproximateUsageRecordsResponseSuccess
|
351
351
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetApproximateUsageRecordsResponseSuccess
|
352
352
|
|
353
|
+
interface _GetCommitmentPurchaseAnalysisResponseSuccess
|
354
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GetCommitmentPurchaseAnalysisResponse]
|
355
|
+
def estimated_completion_time: () -> ::String
|
356
|
+
def analysis_completion_time: () -> ::String
|
357
|
+
def analysis_started_time: () -> ::String
|
358
|
+
def analysis_id: () -> ::String
|
359
|
+
def analysis_status: () -> ("SUCCEEDED" | "PROCESSING" | "FAILED")
|
360
|
+
def error_code: () -> ("NO_USAGE_FOUND" | "INTERNAL_FAILURE" | "INVALID_SAVINGS_PLANS_TO_ADD" | "INVALID_SAVINGS_PLANS_TO_EXCLUDE" | "INVALID_ACCOUNT_ID")
|
361
|
+
def analysis_details: () -> Types::AnalysisDetails
|
362
|
+
def commitment_purchase_analysis_configuration: () -> Types::CommitmentPurchaseAnalysisConfiguration
|
363
|
+
end
|
364
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CostExplorer/Client.html#get_commitment_purchase_analysis-instance_method
|
365
|
+
def get_commitment_purchase_analysis: (
|
366
|
+
analysis_id: ::String
|
367
|
+
) -> _GetCommitmentPurchaseAnalysisResponseSuccess
|
368
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetCommitmentPurchaseAnalysisResponseSuccess
|
369
|
+
|
353
370
|
interface _GetCostAndUsageResponseSuccess
|
354
371
|
include ::Seahorse::Client::_ResponseSuccess[Types::GetCostAndUsageResponse]
|
355
372
|
def next_page_token: () -> ::String
|
@@ -1074,6 +1091,20 @@ module Aws
|
|
1074
1091
|
) -> _GetUsageForecastResponseSuccess
|
1075
1092
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetUsageForecastResponseSuccess
|
1076
1093
|
|
1094
|
+
interface _ListCommitmentPurchaseAnalysesResponseSuccess
|
1095
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListCommitmentPurchaseAnalysesResponse]
|
1096
|
+
def analysis_summary_list: () -> ::Array[Types::AnalysisSummary]
|
1097
|
+
def next_page_token: () -> ::String
|
1098
|
+
end
|
1099
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CostExplorer/Client.html#list_commitment_purchase_analyses-instance_method
|
1100
|
+
def list_commitment_purchase_analyses: (
|
1101
|
+
?analysis_status: ("SUCCEEDED" | "PROCESSING" | "FAILED"),
|
1102
|
+
?next_page_token: ::String,
|
1103
|
+
?page_size: ::Integer,
|
1104
|
+
?analysis_ids: Array[::String]
|
1105
|
+
) -> _ListCommitmentPurchaseAnalysesResponseSuccess
|
1106
|
+
| (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListCommitmentPurchaseAnalysesResponseSuccess
|
1107
|
+
|
1077
1108
|
interface _ListCostAllocationTagBackfillHistoryResponseSuccess
|
1078
1109
|
include ::Seahorse::Client::_ResponseSuccess[Types::ListCostAllocationTagBackfillHistoryResponse]
|
1079
1110
|
def backfill_requests: () -> ::Array[Types::CostAllocationTagBackfillRequest]
|
@@ -1149,6 +1180,40 @@ module Aws
|
|
1149
1180
|
) -> _ProvideAnomalyFeedbackResponseSuccess
|
1150
1181
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ProvideAnomalyFeedbackResponseSuccess
|
1151
1182
|
|
1183
|
+
interface _StartCommitmentPurchaseAnalysisResponseSuccess
|
1184
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::StartCommitmentPurchaseAnalysisResponse]
|
1185
|
+
def analysis_id: () -> ::String
|
1186
|
+
def analysis_started_time: () -> ::String
|
1187
|
+
def estimated_completion_time: () -> ::String
|
1188
|
+
end
|
1189
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CostExplorer/Client.html#start_commitment_purchase_analysis-instance_method
|
1190
|
+
def start_commitment_purchase_analysis: (
|
1191
|
+
commitment_purchase_analysis_configuration: {
|
1192
|
+
savings_plans_purchase_analysis_configuration: {
|
1193
|
+
account_scope: ("PAYER" | "LINKED")?,
|
1194
|
+
account_id: ::String?,
|
1195
|
+
analysis_type: ("MAX_SAVINGS" | "CUSTOM_COMMITMENT"),
|
1196
|
+
savings_plans_to_add: Array[
|
1197
|
+
{
|
1198
|
+
payment_option: ("NO_UPFRONT" | "PARTIAL_UPFRONT" | "ALL_UPFRONT" | "LIGHT_UTILIZATION" | "MEDIUM_UTILIZATION" | "HEAVY_UTILIZATION")?,
|
1199
|
+
savings_plans_type: ("COMPUTE_SP" | "EC2_INSTANCE_SP" | "SAGEMAKER_SP")?,
|
1200
|
+
region: ::String?,
|
1201
|
+
instance_family: ::String?,
|
1202
|
+
term_in_years: ("ONE_YEAR" | "THREE_YEARS")?,
|
1203
|
+
savings_plans_commitment: ::Float?,
|
1204
|
+
offering_id: ::String?
|
1205
|
+
},
|
1206
|
+
],
|
1207
|
+
savings_plans_to_exclude: Array[::String]?,
|
1208
|
+
look_back_time_period: {
|
1209
|
+
start: ::String,
|
1210
|
+
end: ::String
|
1211
|
+
}
|
1212
|
+
}?
|
1213
|
+
}
|
1214
|
+
) -> _StartCommitmentPurchaseAnalysisResponseSuccess
|
1215
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _StartCommitmentPurchaseAnalysisResponseSuccess
|
1216
|
+
|
1152
1217
|
interface _StartCostAllocationTagBackfillResponseSuccess
|
1153
1218
|
include ::Seahorse::Client::_ResponseSuccess[Types::StartCostAllocationTagBackfillResponse]
|
1154
1219
|
def backfill_request: () -> Types::CostAllocationTagBackfillRequest
|
data/sig/errors.rbs
CHANGED
@@ -11,6 +11,9 @@ module Aws
|
|
11
11
|
class ServiceError < ::Aws::Errors::ServiceError
|
12
12
|
end
|
13
13
|
|
14
|
+
class AnalysisNotFoundException < ::Aws::Errors::ServiceError
|
15
|
+
def message: () -> ::String
|
16
|
+
end
|
14
17
|
class BackfillLimitExceededException < ::Aws::Errors::ServiceError
|
15
18
|
def message: () -> ::String
|
16
19
|
end
|