aws-sdk-costexplorer 1.76.0 → 1.78.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 +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-costexplorer/client.rb +257 -131
- data/lib/aws-sdk-costexplorer/client_api.rb +80 -0
- data/lib/aws-sdk-costexplorer/types.rb +419 -182
- data/lib/aws-sdk-costexplorer.rb +1 -1
- metadata +2 -2
@@ -26,8 +26,8 @@ module Aws::CostExplorer
|
|
26
26
|
# @return [String]
|
27
27
|
#
|
28
28
|
# @!attribute [rw] dimension_value
|
29
|
-
# The dimension for the anomaly (for example, an Amazon Web
|
30
|
-
#
|
29
|
+
# The dimension for the anomaly (for example, an Amazon Web Service in
|
30
|
+
# a service monitor).
|
31
31
|
# @return [String]
|
32
32
|
#
|
33
33
|
# @!attribute [rw] root_causes
|
@@ -346,6 +346,63 @@ module Aws::CostExplorer
|
|
346
346
|
include Aws::Structure
|
347
347
|
end
|
348
348
|
|
349
|
+
# The cost allocation tag structure. This includes detailed metadata for
|
350
|
+
# the `CostAllocationTag` object.
|
351
|
+
#
|
352
|
+
# @!attribute [rw] tag_key
|
353
|
+
# The key for the cost allocation tag.
|
354
|
+
# @return [String]
|
355
|
+
#
|
356
|
+
# @!attribute [rw] type
|
357
|
+
# The type of cost allocation tag. You can use `AWSGenerated` or
|
358
|
+
# `UserDefined` type tags. `AWSGenerated` type tags are tags that
|
359
|
+
# Amazon Web Services defines and applies to support Amazon Web
|
360
|
+
# Services resources for cost allocation purposes. `UserDefined` type
|
361
|
+
# tags are tags that you define, create, and apply to resources.
|
362
|
+
# @return [String]
|
363
|
+
#
|
364
|
+
# @!attribute [rw] status
|
365
|
+
# The status of a cost allocation tag.
|
366
|
+
# @return [String]
|
367
|
+
#
|
368
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ce-2017-10-25/CostAllocationTag AWS API Documentation
|
369
|
+
#
|
370
|
+
class CostAllocationTag < Struct.new(
|
371
|
+
:tag_key,
|
372
|
+
:type,
|
373
|
+
:status)
|
374
|
+
SENSITIVE = []
|
375
|
+
include Aws::Structure
|
376
|
+
end
|
377
|
+
|
378
|
+
# The cost allocation tag status. The status of a key can either be
|
379
|
+
# active or inactive.
|
380
|
+
#
|
381
|
+
# @note When making an API call, you may pass CostAllocationTagStatusEntry
|
382
|
+
# data as a hash:
|
383
|
+
#
|
384
|
+
# {
|
385
|
+
# tag_key: "TagKey", # required
|
386
|
+
# status: "Active", # required, accepts Active, Inactive
|
387
|
+
# }
|
388
|
+
#
|
389
|
+
# @!attribute [rw] tag_key
|
390
|
+
# The key for the cost allocation tag.
|
391
|
+
# @return [String]
|
392
|
+
#
|
393
|
+
# @!attribute [rw] status
|
394
|
+
# The status of a cost allocation tag.
|
395
|
+
# @return [String]
|
396
|
+
#
|
397
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ce-2017-10-25/CostAllocationTagStatusEntry AWS API Documentation
|
398
|
+
#
|
399
|
+
class CostAllocationTagStatusEntry < Struct.new(
|
400
|
+
:tag_key,
|
401
|
+
:status)
|
402
|
+
SENSITIVE = []
|
403
|
+
include Aws::Structure
|
404
|
+
end
|
405
|
+
|
349
406
|
# The structure of Cost Categories. This includes detailed metadata and
|
350
407
|
# the set of rules for the `CostCategory` object.
|
351
408
|
#
|
@@ -354,11 +411,11 @@ module Aws::CostExplorer
|
|
354
411
|
# @return [String]
|
355
412
|
#
|
356
413
|
# @!attribute [rw] effective_start
|
357
|
-
# The effective
|
414
|
+
# The effective start date of your Cost Category.
|
358
415
|
# @return [String]
|
359
416
|
#
|
360
417
|
# @!attribute [rw] effective_end
|
361
|
-
# The effective end
|
418
|
+
# The effective end date of your Cost Category.
|
362
419
|
# @return [String]
|
363
420
|
#
|
364
421
|
# @!attribute [rw] name
|
@@ -405,14 +462,14 @@ module Aws::CostExplorer
|
|
405
462
|
include Aws::Structure
|
406
463
|
end
|
407
464
|
|
408
|
-
# When
|
465
|
+
# When you create or update a cost category, you can define the
|
409
466
|
# `CostCategoryRule` rule type as `INHERITED_VALUE`. This rule type adds
|
410
|
-
# the flexibility
|
411
|
-
# category value from the dimension value defined by
|
412
|
-
# `CostCategoryInheritedValueDimension`. For example,
|
413
|
-
# dynamically group costs that are based on the value of a
|
414
|
-
# key,
|
415
|
-
# dimension and specify the tag key to use.
|
467
|
+
# the flexibility to define a rule that dynamically inherits the cost
|
468
|
+
# category value from the dimension value that's defined by
|
469
|
+
# `CostCategoryInheritedValueDimension`. For example, suppose that you
|
470
|
+
# want to dynamically group costs that are based on the value of a
|
471
|
+
# specific tag key. First, choose an inherited value rule type, and then
|
472
|
+
# choose the tag dimension and specify the tag key to use.
|
416
473
|
#
|
417
474
|
# @note When making an API call, you may pass CostCategoryInheritedValueDimension
|
418
475
|
# data as a hash:
|
@@ -427,7 +484,7 @@ module Aws::CostExplorer
|
|
427
484
|
#
|
428
485
|
# If you specify `LINKED_ACCOUNT_NAME`, the cost category value is
|
429
486
|
# based on account name. If you specify `TAG`, the cost category value
|
430
|
-
#
|
487
|
+
# is based on the value of the specified tag key.
|
431
488
|
# @return [String]
|
432
489
|
#
|
433
490
|
# @!attribute [rw] dimension_key
|
@@ -597,12 +654,13 @@ module Aws::CostExplorer
|
|
597
654
|
# @!attribute [rw] type
|
598
655
|
# You can define the `CostCategoryRule` rule type as either `REGULAR`
|
599
656
|
# or `INHERITED_VALUE`. The `INHERITED_VALUE` rule type adds the
|
600
|
-
# flexibility
|
601
|
-
# category value from the dimension value
|
602
|
-
# `CostCategoryInheritedValueDimension`. For example,
|
603
|
-
#
|
604
|
-
#
|
605
|
-
# dimension and specify the tag key
|
657
|
+
# flexibility to define a rule that dynamically inherits the cost
|
658
|
+
# category value. This value is from the dimension value that's
|
659
|
+
# defined by `CostCategoryInheritedValueDimension`. For example,
|
660
|
+
# suppose that you want to costs to be dynamically grouped based on
|
661
|
+
# the value of a specific tag key. First, choose an inherited value
|
662
|
+
# rule type, and then choose the tag dimension and specify the tag key
|
663
|
+
# to use.
|
606
664
|
# @return [String]
|
607
665
|
#
|
608
666
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ce-2017-10-25/CostCategoryRule AWS API Documentation
|
@@ -945,7 +1003,7 @@ module Aws::CostExplorer
|
|
945
1003
|
# @!attribute [rw] resource_tags
|
946
1004
|
# An optional list of tags to associate with the specified [
|
947
1005
|
# `AnomalyMonitor` ][1]. You can use resource tags to control access
|
948
|
-
# to your monitor using IAM policies.
|
1006
|
+
# to your `monitor` using IAM policies.
|
949
1007
|
#
|
950
1008
|
# Each tag consists of a key and a value, and each key must be unique
|
951
1009
|
# for the resource. The following restrictions apply to resource tags:
|
@@ -958,8 +1016,8 @@ module Aws::CostExplorer
|
|
958
1016
|
#
|
959
1017
|
# * The maximum length of a value is 256 characters
|
960
1018
|
#
|
961
|
-
# *
|
962
|
-
# `_
|
1019
|
+
# * Keys and values can only contain alphanumeric characters, spaces,
|
1020
|
+
# and any of the following: `_.:/=+@-`
|
963
1021
|
#
|
964
1022
|
# * Keys and values are case sensitive
|
965
1023
|
#
|
@@ -1043,8 +1101,8 @@ module Aws::CostExplorer
|
|
1043
1101
|
#
|
1044
1102
|
# * The maximum length of a value is 256 characters
|
1045
1103
|
#
|
1046
|
-
# *
|
1047
|
-
# `_
|
1104
|
+
# * Keys and values can only contain alphanumeric characters, spaces,
|
1105
|
+
# and any of the following: `_.:/=+@-`
|
1048
1106
|
#
|
1049
1107
|
# * Keys and values are case sensitive
|
1050
1108
|
#
|
@@ -1086,6 +1144,7 @@ module Aws::CostExplorer
|
|
1086
1144
|
#
|
1087
1145
|
# {
|
1088
1146
|
# name: "CostCategoryName", # required
|
1147
|
+
# effective_start: "ZonedDateTime",
|
1089
1148
|
# rule_version: "CostCategoryExpression.v1", # required, accepts CostCategoryExpression.v1
|
1090
1149
|
# rules: [ # required
|
1091
1150
|
# {
|
@@ -1153,6 +1212,13 @@ module Aws::CostExplorer
|
|
1153
1212
|
# The unique name of the Cost Category.
|
1154
1213
|
# @return [String]
|
1155
1214
|
#
|
1215
|
+
# @!attribute [rw] effective_start
|
1216
|
+
# The Cost Category's effective start date. It can only be a billing
|
1217
|
+
# start date (first day of the month). If the date isn't provided,
|
1218
|
+
# it's the first day of the current month. Dates can't be before the
|
1219
|
+
# previous twelve months, or in the future.
|
1220
|
+
# @return [String]
|
1221
|
+
#
|
1156
1222
|
# @!attribute [rw] rule_version
|
1157
1223
|
# The rule schema version in this particular Cost Category.
|
1158
1224
|
# @return [String]
|
@@ -1191,8 +1257,8 @@ module Aws::CostExplorer
|
|
1191
1257
|
#
|
1192
1258
|
# * The maximum length of a value is 256 characters
|
1193
1259
|
#
|
1194
|
-
# *
|
1195
|
-
# `_
|
1260
|
+
# * Keys and values can only contain alphanumeric characters, spaces,
|
1261
|
+
# and any of the following: `_.:/=+@-`
|
1196
1262
|
#
|
1197
1263
|
# * Keys and values are case sensitive
|
1198
1264
|
#
|
@@ -1211,6 +1277,7 @@ module Aws::CostExplorer
|
|
1211
1277
|
#
|
1212
1278
|
class CreateCostCategoryDefinitionRequest < Struct.new(
|
1213
1279
|
:name,
|
1280
|
+
:effective_start,
|
1214
1281
|
:rule_version,
|
1215
1282
|
:rules,
|
1216
1283
|
:default_value,
|
@@ -1225,7 +1292,8 @@ module Aws::CostExplorer
|
|
1225
1292
|
# @return [String]
|
1226
1293
|
#
|
1227
1294
|
# @!attribute [rw] effective_start
|
1228
|
-
# The Cost Category's effective start date.
|
1295
|
+
# The Cost Category's effective start date. It can only be a billing
|
1296
|
+
# start date (first day of the month).
|
1229
1297
|
# @return [String]
|
1230
1298
|
#
|
1231
1299
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ce-2017-10-25/CreateCostCategoryDefinitionResponse AWS API Documentation
|
@@ -1429,7 +1497,7 @@ module Aws::CostExplorer
|
|
1429
1497
|
#
|
1430
1498
|
# @!attribute [rw] effective_end
|
1431
1499
|
# The effective end date of the Cost Category as a result of deleting
|
1432
|
-
# it. No costs after this date
|
1500
|
+
# it. No costs after this date is categorized by the deleted Cost
|
1433
1501
|
# Category.
|
1434
1502
|
# @return [String]
|
1435
1503
|
#
|
@@ -1495,7 +1563,12 @@ module Aws::CostExplorer
|
|
1495
1563
|
# @!attribute [rw] key
|
1496
1564
|
# The names of the metadata types that you can use to filter and group
|
1497
1565
|
# your results. For example, `AZ` returns a list of Availability
|
1498
|
-
# Zones.
|
1566
|
+
# Zones. `LINK_ACCOUNT_NAME` and `SERVICE_CODE` can only be used in
|
1567
|
+
# [CostCategoryRule][1].
|
1568
|
+
#
|
1569
|
+
#
|
1570
|
+
#
|
1571
|
+
# [1]: https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/AAPI_CostCategoryRule.html
|
1499
1572
|
# @return [String]
|
1500
1573
|
#
|
1501
1574
|
# @!attribute [rw] values
|
@@ -1713,7 +1786,7 @@ module Aws::CostExplorer
|
|
1713
1786
|
include Aws::Structure
|
1714
1787
|
end
|
1715
1788
|
|
1716
|
-
# Utilization metrics
|
1789
|
+
# Utilization metrics for the instance.
|
1717
1790
|
#
|
1718
1791
|
# @!attribute [rw] max_cpu_utilization_percentage
|
1719
1792
|
# The maximum observed or expected CPU utilization of the instance.
|
@@ -2552,8 +2625,8 @@ module Aws::CostExplorer
|
|
2552
2625
|
# usage numbers without taking the units into account. For example, if
|
2553
2626
|
# you aggregate `usageQuantity` across all of Amazon EC2, the results
|
2554
2627
|
# aren't meaningful because Amazon EC2 compute hours and data
|
2555
|
-
# transfer are measured in different units (for example,
|
2556
|
-
#
|
2628
|
+
# transfer are measured in different units (for example, hour or GB).
|
2629
|
+
# To get more meaningful `UsageQuantity` metrics, filter by
|
2557
2630
|
# `UsageType` or `UsageTypeGroups`.
|
2558
2631
|
#
|
2559
2632
|
# </note>
|
@@ -2601,7 +2674,7 @@ module Aws::CostExplorer
|
|
2601
2674
|
# @return [Array<Types::GroupDefinition>]
|
2602
2675
|
#
|
2603
2676
|
# @!attribute [rw] results_by_time
|
2604
|
-
# The time period that
|
2677
|
+
# The time period that's covered by the results in the response.
|
2605
2678
|
# @return [Array<Types::ResultByTime>]
|
2606
2679
|
#
|
2607
2680
|
# @!attribute [rw] dimension_value_attributes
|
@@ -2674,11 +2747,10 @@ module Aws::CostExplorer
|
|
2674
2747
|
# @!attribute [rw] search_string
|
2675
2748
|
# The value that you want to search the filter values for.
|
2676
2749
|
#
|
2677
|
-
# If you
|
2678
|
-
#
|
2679
|
-
#
|
2680
|
-
#
|
2681
|
-
# `SearchString` pattern.
|
2750
|
+
# If you don't specify a `CostCategoryName`, `SearchString` is used
|
2751
|
+
# to filter Cost Category names that match the `SearchString` pattern.
|
2752
|
+
# If you specify a `CostCategoryName`, `SearchString` is used to
|
2753
|
+
# filter Cost Category values that match the `SearchString` pattern.
|
2682
2754
|
# @return [String]
|
2683
2755
|
#
|
2684
2756
|
# @!attribute [rw] time_period
|
@@ -2745,10 +2817,10 @@ module Aws::CostExplorer
|
|
2745
2817
|
# @return [Types::Expression]
|
2746
2818
|
#
|
2747
2819
|
# @!attribute [rw] sort_by
|
2748
|
-
# The value
|
2820
|
+
# The value that you sort the data by.
|
2749
2821
|
#
|
2750
|
-
# The key represents cost and usage metrics. The following values
|
2751
|
-
# supported:
|
2822
|
+
# The key represents the cost and usage metrics. The following values
|
2823
|
+
# are supported:
|
2752
2824
|
#
|
2753
2825
|
# * `BlendedCost`
|
2754
2826
|
#
|
@@ -2764,27 +2836,29 @@ module Aws::CostExplorer
|
|
2764
2836
|
#
|
2765
2837
|
# * `NormalizedUsageAmount`
|
2766
2838
|
#
|
2767
|
-
#
|
2839
|
+
# The supported key values for the `SortOrder` value are `ASCENDING`
|
2840
|
+
# and `DESCENDING`.
|
2768
2841
|
#
|
2769
|
-
# When
|
2770
|
-
# supported.
|
2842
|
+
# When you use the `SortBy` value, the `NextPageToken` and
|
2843
|
+
# `SearchString` key values aren't supported.
|
2771
2844
|
# @return [Array<Types::SortDefinition>]
|
2772
2845
|
#
|
2773
2846
|
# @!attribute [rw] max_results
|
2774
|
-
# This field is only used when `SortBy` is provided in the
|
2847
|
+
# This field is only used when the `SortBy` value is provided in the
|
2848
|
+
# request.
|
2775
2849
|
#
|
2776
|
-
# The maximum number of objects that
|
2777
|
-
#
|
2778
|
-
#
|
2850
|
+
# The maximum number of objects that are returned for this request. If
|
2851
|
+
# `MaxResults` isn't specified with the `SortBy` value, the request
|
2852
|
+
# returns 1000 results as the default value for this parameter.
|
2779
2853
|
#
|
2780
|
-
# For `GetCostCategories`, MaxResults has an upper
|
2854
|
+
# For `GetCostCategories`, MaxResults has an upper quota of 1000.
|
2781
2855
|
# @return [Integer]
|
2782
2856
|
#
|
2783
2857
|
# @!attribute [rw] next_page_token
|
2784
2858
|
# If the number of objects that are still available for retrieval
|
2785
|
-
# exceeds the
|
2859
|
+
# exceeds the quota, Amazon Web Services returns a NextPageToken value
|
2786
2860
|
# in the response. To retrieve the next batch of objects, provide the
|
2787
|
-
# NextPageToken from the
|
2861
|
+
# NextPageToken from the previous call in your next request.
|
2788
2862
|
# @return [String]
|
2789
2863
|
#
|
2790
2864
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ce-2017-10-25/GetCostCategoriesRequest AWS API Documentation
|
@@ -2803,7 +2877,7 @@ module Aws::CostExplorer
|
|
2803
2877
|
|
2804
2878
|
# @!attribute [rw] next_page_token
|
2805
2879
|
# If the number of objects that are still available for retrieval
|
2806
|
-
# exceeds the
|
2880
|
+
# exceeds the quota, Amazon Web Services returns a NextPageToken value
|
2807
2881
|
# in the response. To retrieve the next batch of objects, provide the
|
2808
2882
|
# marker from the prior call in your next request.
|
2809
2883
|
# @return [String]
|
@@ -2815,12 +2889,12 @@ module Aws::CostExplorer
|
|
2815
2889
|
# @!attribute [rw] cost_category_values
|
2816
2890
|
# The Cost Category values.
|
2817
2891
|
#
|
2818
|
-
# `
|
2819
|
-
#
|
2892
|
+
# If the `CostCategoryName` key isn't specified in the request, the
|
2893
|
+
# `CostCategoryValues` fields aren't returned.
|
2820
2894
|
# @return [Array<String>]
|
2821
2895
|
#
|
2822
2896
|
# @!attribute [rw] return_size
|
2823
|
-
# The number of objects returned.
|
2897
|
+
# The number of objects that are returned.
|
2824
2898
|
# @return [Integer]
|
2825
2899
|
#
|
2826
2900
|
# @!attribute [rw] total_size
|
@@ -3077,6 +3151,12 @@ module Aws::CostExplorer
|
|
3077
3151
|
# @!attribute [rw] dimension
|
3078
3152
|
# The name of the dimension. Each `Dimension` is available for a
|
3079
3153
|
# different `Context`. For more information, see `Context`.
|
3154
|
+
# `LINK_ACCOUNT_NAME` and `SERVICE_CODE` can only be used in
|
3155
|
+
# [CostCategoryRule][1].
|
3156
|
+
#
|
3157
|
+
#
|
3158
|
+
#
|
3159
|
+
# [1]: https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/AAPI_CostCategoryRule.html
|
3080
3160
|
# @return [String]
|
3081
3161
|
#
|
3082
3162
|
# @!attribute [rw] context
|
@@ -3097,15 +3177,15 @@ module Aws::CostExplorer
|
|
3097
3177
|
# is with. Possible values are the following:
|
3098
3178
|
#
|
3099
3179
|
# \- Amazon Web Services(Amazon Web Services): The entity that sells
|
3100
|
-
# Amazon Web Services
|
3180
|
+
# Amazon Web Services.
|
3101
3181
|
#
|
3102
3182
|
# \- AISPL (Amazon Internet Services Pvt. Ltd.): The local Indian
|
3103
|
-
# entity that
|
3104
|
-
#
|
3183
|
+
# entity that's an acting reseller for Amazon Web Services in
|
3184
|
+
# India.
|
3105
3185
|
#
|
3106
3186
|
# \- Amazon Web Services Marketplace: The entity that supports the
|
3107
|
-
# sale of solutions built on Amazon Web Services by
|
3108
|
-
# software providers.
|
3187
|
+
# sale of solutions that are built on Amazon Web Services by
|
3188
|
+
# third-party software providers.
|
3109
3189
|
#
|
3110
3190
|
# * CACHE\_ENGINE - The Amazon ElastiCache operating system. Examples
|
3111
3191
|
# are Windows or Linux.
|
@@ -3120,12 +3200,12 @@ module Aws::CostExplorer
|
|
3120
3200
|
# `m4.xlarge`.
|
3121
3201
|
#
|
3122
3202
|
# * INSTANCE\_TYPE\_FAMILY - A family of instance types optimized to
|
3123
|
-
# fit different use cases. Examples are `Compute Optimized` (
|
3124
|
-
# `C5`, `C6g`, `C7g`
|
3125
|
-
# `R5b`, `R6g`
|
3203
|
+
# fit different use cases. Examples are `Compute Optimized` (for
|
3204
|
+
# example, `C4`, `C5`, `C6g`, and `C7g`), `Memory Optimization` (for
|
3205
|
+
# example, `R4`, `R5n`, `R5b`, and `R6g`).
|
3126
3206
|
#
|
3127
|
-
# * INVOICING\_ENTITY - The name of the entity
|
3128
|
-
# Services invoice.
|
3207
|
+
# * INVOICING\_ENTITY - The name of the entity that issues the Amazon
|
3208
|
+
# Web Services invoice.
|
3129
3209
|
#
|
3130
3210
|
# * LEGAL\_ENTITY\_NAME - The name of the organization that sells you
|
3131
3211
|
# Amazon Web Services services, such as Amazon Web Services.
|
@@ -3143,8 +3223,8 @@ module Aws::CostExplorer
|
|
3143
3223
|
# * PLATFORM - The Amazon EC2 operating system. Examples are Windows
|
3144
3224
|
# or Linux.
|
3145
3225
|
#
|
3146
|
-
# * PURCHASE\_TYPE - The reservation type of the purchase
|
3147
|
-
#
|
3226
|
+
# * PURCHASE\_TYPE - The reservation type of the purchase that this
|
3227
|
+
# usage is related to. Examples include On-Demand Instances and
|
3148
3228
|
# Standard Reserved Instances.
|
3149
3229
|
#
|
3150
3230
|
# * RESERVATION\_ID - The unique identifier for an Amazon Web Services
|
@@ -3170,8 +3250,8 @@ module Aws::CostExplorer
|
|
3170
3250
|
#
|
3171
3251
|
# * REGION - The Amazon Web Services Region.
|
3172
3252
|
#
|
3173
|
-
# * RECORD\_TYPE - The different types of charges such as
|
3174
|
-
# usage costs, tax refunds, and credits.
|
3253
|
+
# * RECORD\_TYPE - The different types of charges such as Reserved
|
3254
|
+
# Instance (RI) fees, usage costs, tax refunds, and credits.
|
3175
3255
|
#
|
3176
3256
|
# * RESOURCE\_ID - The unique identifier of the resource. ResourceId
|
3177
3257
|
# is an opt-in feature only available for last 14 days for
|
@@ -3215,8 +3295,8 @@ module Aws::CostExplorer
|
|
3215
3295
|
# * SAVINGS\_PLANS\_TYPE - Type of Savings Plans (EC2 Instance or
|
3216
3296
|
# Compute)
|
3217
3297
|
#
|
3218
|
-
# * PAYMENT\_OPTION -
|
3219
|
-
# example, All Upfront)
|
3298
|
+
# * PAYMENT\_OPTION - The payment option for the given Savings Plans
|
3299
|
+
# (for example, All Upfront)
|
3220
3300
|
#
|
3221
3301
|
# * REGION - The Amazon Web Services Region.
|
3222
3302
|
#
|
@@ -3286,7 +3366,7 @@ module Aws::CostExplorer
|
|
3286
3366
|
# @return [Types::Expression]
|
3287
3367
|
#
|
3288
3368
|
# @!attribute [rw] sort_by
|
3289
|
-
# The value
|
3369
|
+
# The value that you want to sort the data by.
|
3290
3370
|
#
|
3291
3371
|
# The key represents cost and usage metrics. The following values are
|
3292
3372
|
# supported:
|
@@ -3305,18 +3385,19 @@ module Aws::CostExplorer
|
|
3305
3385
|
#
|
3306
3386
|
# * `NormalizedUsageAmount`
|
3307
3387
|
#
|
3308
|
-
#
|
3388
|
+
# The supported values for the `SortOrder` key are `ASCENDING` or
|
3389
|
+
# `DESCENDING`.
|
3309
3390
|
#
|
3310
3391
|
# When you specify a `SortBy` paramater, the context must be
|
3311
3392
|
# `COST_AND_USAGE`. Further, when using `SortBy`, `NextPageToken` and
|
3312
|
-
# `SearchString`
|
3393
|
+
# `SearchString` aren't supported.
|
3313
3394
|
# @return [Array<Types::SortDefinition>]
|
3314
3395
|
#
|
3315
3396
|
# @!attribute [rw] max_results
|
3316
3397
|
# This field is only used when SortBy is provided in the request. The
|
3317
|
-
# maximum number of objects that
|
3318
|
-
# MaxResults
|
3319
|
-
#
|
3398
|
+
# maximum number of objects that are returned for this request. If
|
3399
|
+
# MaxResults isn't specified with SortBy, the request returns 1000
|
3400
|
+
# results as the default value for this parameter.
|
3320
3401
|
#
|
3321
3402
|
# For `GetDimensionValues`, MaxResults has an upper limit of 1000.
|
3322
3403
|
# @return [Integer]
|
@@ -3392,7 +3473,8 @@ module Aws::CostExplorer
|
|
3392
3473
|
#
|
3393
3474
|
# * RESOURCE\_ID - The unique identifier of the resource. ResourceId
|
3394
3475
|
# is an opt-in feature only available for last 14 days for
|
3395
|
-
# EC2-Compute Service.
|
3476
|
+
# EC2-Compute Service. You can opt-in by enabling `Hourly` and
|
3477
|
+
# `Resource Level Data` in Cost Management Console preferences.
|
3396
3478
|
#
|
3397
3479
|
# If you set the context to `RESERVATIONS`, you can use the following
|
3398
3480
|
# dimensions for searching:
|
@@ -3757,7 +3839,7 @@ module Aws::CostExplorer
|
|
3757
3839
|
# }
|
3758
3840
|
#
|
3759
3841
|
# @!attribute [rw] account_id
|
3760
|
-
# The account ID that
|
3842
|
+
# The account ID that's associated with the recommendation.
|
3761
3843
|
# @return [String]
|
3762
3844
|
#
|
3763
3845
|
# @!attribute [rw] service
|
@@ -3950,11 +4032,12 @@ module Aws::CostExplorer
|
|
3950
4032
|
# }
|
3951
4033
|
#
|
3952
4034
|
# @!attribute [rw] time_period
|
3953
|
-
# Sets the start and end dates for retrieving
|
3954
|
-
# start date is inclusive, but the end date is
|
3955
|
-
# if `start` is `2017-01-01` and `end` is
|
3956
|
-
# and usage data is retrieved from
|
3957
|
-
# `2017-
|
4035
|
+
# Sets the start and end dates for retrieving Reserved Instance (RI)
|
4036
|
+
# utilization. The start date is inclusive, but the end date is
|
4037
|
+
# exclusive. For example, if `start` is `2017-01-01` and `end` is
|
4038
|
+
# `2017-05-01`, then the cost and usage data is retrieved from
|
4039
|
+
# `2017-01-01` up to and including `2017-04-30` but not including
|
4040
|
+
# `2017-05-01`.
|
3958
4041
|
# @return [Types::DateInterval]
|
3959
4042
|
#
|
3960
4043
|
# @!attribute [rw] group_by
|
@@ -4008,7 +4091,7 @@ module Aws::CostExplorer
|
|
4008
4091
|
# @return [Types::Expression]
|
4009
4092
|
#
|
4010
4093
|
# @!attribute [rw] sort_by
|
4011
|
-
# The value
|
4094
|
+
# The value that you want to sort the data by.
|
4012
4095
|
#
|
4013
4096
|
# The following values are supported for `Key`\:
|
4014
4097
|
#
|
@@ -4046,7 +4129,8 @@ module Aws::CostExplorer
|
|
4046
4129
|
#
|
4047
4130
|
# * `UnrealizedSavings`
|
4048
4131
|
#
|
4049
|
-
#
|
4132
|
+
# The supported values for `SortOrder` are `ASCENDING` and
|
4133
|
+
# `DESCENDING`.
|
4050
4134
|
# @return [Types::SortDefinition]
|
4051
4135
|
#
|
4052
4136
|
# @!attribute [rw] next_page_token
|
@@ -4077,11 +4161,12 @@ module Aws::CostExplorer
|
|
4077
4161
|
end
|
4078
4162
|
|
4079
4163
|
# @!attribute [rw] utilizations_by_time
|
4080
|
-
# The amount of time that you used your RIs.
|
4164
|
+
# The amount of time that you used your Reserved Instances (RIs).
|
4081
4165
|
# @return [Array<Types::UtilizationByTime>]
|
4082
4166
|
#
|
4083
4167
|
# @!attribute [rw] total
|
4084
|
-
# The total amount of time that you used your
|
4168
|
+
# The total amount of time that you used your Reserved Instances
|
4169
|
+
# (RIs).
|
4085
4170
|
# @return [Types::ReservationAggregates]
|
4086
4171
|
#
|
4087
4172
|
# @!attribute [rw] next_page_token
|
@@ -4199,12 +4284,12 @@ module Aws::CostExplorer
|
|
4199
4284
|
# @return [Types::Expression]
|
4200
4285
|
#
|
4201
4286
|
# @!attribute [rw] configuration
|
4202
|
-
#
|
4203
|
-
# can choose to view recommendations for instances
|
4204
|
-
# instance families or across different instance
|
4205
|
-
# also choose to view your estimated savings
|
4206
|
-
# recommendations with consideration of existing
|
4207
|
-
# benefits, or neither.
|
4287
|
+
# You can use Configuration to customize recommendations across two
|
4288
|
+
# attributes. You can choose to view recommendations for instances
|
4289
|
+
# within the same instance families or across different instance
|
4290
|
+
# families. You can also choose to view your estimated savings that
|
4291
|
+
# are associated with recommendations with consideration of existing
|
4292
|
+
# Savings Plans or RI benefits, or neither.
|
4208
4293
|
# @return [Types::RightsizingRecommendationConfiguration]
|
4209
4294
|
#
|
4210
4295
|
# @!attribute [rw] service
|
@@ -4251,12 +4336,12 @@ module Aws::CostExplorer
|
|
4251
4336
|
# @return [String]
|
4252
4337
|
#
|
4253
4338
|
# @!attribute [rw] configuration
|
4254
|
-
#
|
4255
|
-
# can choose to view recommendations for instances
|
4256
|
-
# instance families or across different instance
|
4257
|
-
# also choose to view your estimated savings
|
4258
|
-
# recommendations with consideration of existing
|
4259
|
-
# benefits, or neither.
|
4339
|
+
# You can use Configuration to customize recommendations across two
|
4340
|
+
# attributes. You can choose to view recommendations for instances
|
4341
|
+
# within the same instance families or across different instance
|
4342
|
+
# families. You can also choose to view your estimated savings that
|
4343
|
+
# are associated with recommendations with consideration of existing
|
4344
|
+
# Savings Plans or RI benefits, or neither.
|
4260
4345
|
# @return [Types::RightsizingRecommendationConfiguration]
|
4261
4346
|
#
|
4262
4347
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ce-2017-10-25/GetRightsizingRecommendationResponse AWS API Documentation
|
@@ -4386,7 +4471,7 @@ module Aws::CostExplorer
|
|
4386
4471
|
# @return [Integer]
|
4387
4472
|
#
|
4388
4473
|
# @!attribute [rw] sort_by
|
4389
|
-
# The value
|
4474
|
+
# The value that you want to sort the data by.
|
4390
4475
|
#
|
4391
4476
|
# The following values are supported for `Key`\:
|
4392
4477
|
#
|
@@ -4404,7 +4489,8 @@ module Aws::CostExplorer
|
|
4404
4489
|
#
|
4405
4490
|
# * `Service`
|
4406
4491
|
#
|
4407
|
-
#
|
4492
|
+
# The supported values for `SortOrder` are `ASCENDING` and
|
4493
|
+
# `DESCENDING`.
|
4408
4494
|
# @return [Types::SortDefinition]
|
4409
4495
|
#
|
4410
4496
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ce-2017-10-25/GetSavingsPlansCoverageRequest AWS API Documentation
|
@@ -4485,16 +4571,16 @@ module Aws::CostExplorer
|
|
4485
4571
|
# }
|
4486
4572
|
#
|
4487
4573
|
# @!attribute [rw] savings_plans_type
|
4488
|
-
# The Savings Plans recommendation type requested.
|
4574
|
+
# The Savings Plans recommendation type that's requested.
|
4489
4575
|
# @return [String]
|
4490
4576
|
#
|
4491
4577
|
# @!attribute [rw] term_in_years
|
4492
|
-
# The savings plan recommendation term used to generate these
|
4578
|
+
# The savings plan recommendation term that's used to generate these
|
4493
4579
|
# recommendations.
|
4494
4580
|
# @return [String]
|
4495
4581
|
#
|
4496
4582
|
# @!attribute [rw] payment_option
|
4497
|
-
# The payment option used to generate these recommendations.
|
4583
|
+
# The payment option that's used to generate these recommendations.
|
4498
4584
|
# @return [String]
|
4499
4585
|
#
|
4500
4586
|
# @!attribute [rw] account_scope
|
@@ -4517,22 +4603,22 @@ module Aws::CostExplorer
|
|
4517
4603
|
# @return [Integer]
|
4518
4604
|
#
|
4519
4605
|
# @!attribute [rw] lookback_period_in_days
|
4520
|
-
# The lookback period used to generate the recommendation.
|
4606
|
+
# The lookback period that's used to generate the recommendation.
|
4521
4607
|
# @return [String]
|
4522
4608
|
#
|
4523
4609
|
# @!attribute [rw] filter
|
4524
4610
|
# You can filter your recommendations by Account ID with the
|
4525
4611
|
# `LINKED_ACCOUNT` dimension. To filter your recommendations by
|
4526
4612
|
# Account ID, specify `Key` as `LINKED_ACCOUNT` and `Value` as the
|
4527
|
-
# comma-separated Acount ID(s)
|
4528
|
-
# purchase recommendations.
|
4613
|
+
# comma-separated Acount ID(s) that you want to see Savings Plans
|
4614
|
+
# purchase recommendations for.
|
4529
4615
|
#
|
4530
|
-
# For GetSavingsPlansPurchaseRecommendation, the `Filter`
|
4616
|
+
# For GetSavingsPlansPurchaseRecommendation, the `Filter` doesn't
|
4531
4617
|
# include `CostCategories` or `Tags`. It only includes `Dimensions`.
|
4532
4618
|
# With `Dimensions`, `Key` must be `LINKED_ACCOUNT` and `Value` can be
|
4533
|
-
# a single Account ID or multiple comma-separated Account IDs
|
4534
|
-
#
|
4535
|
-
#
|
4619
|
+
# a single Account ID or multiple comma-separated Account IDs that you
|
4620
|
+
# want to see Savings Plans Purchase Recommendations for. `AND` and
|
4621
|
+
# `OR` operators are not supported.
|
4536
4622
|
# @return [Types::Expression]
|
4537
4623
|
#
|
4538
4624
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ce-2017-10-25/GetSavingsPlansPurchaseRecommendationRequest AWS API Documentation
|
@@ -4551,7 +4637,7 @@ module Aws::CostExplorer
|
|
4551
4637
|
end
|
4552
4638
|
|
4553
4639
|
# @!attribute [rw] metadata
|
4554
|
-
# Information
|
4640
|
+
# Information that regards this specific recommendation set.
|
4555
4641
|
# @return [Types::SavingsPlansPurchaseRecommendationMetadata]
|
4556
4642
|
#
|
4557
4643
|
# @!attribute [rw] savings_plans_purchase_recommendation
|
@@ -4668,7 +4754,7 @@ module Aws::CostExplorer
|
|
4668
4754
|
# @return [Integer]
|
4669
4755
|
#
|
4670
4756
|
# @!attribute [rw] sort_by
|
4671
|
-
# The value
|
4757
|
+
# The value that you want to sort the data by.
|
4672
4758
|
#
|
4673
4759
|
# The following values are supported for `Key`\:
|
4674
4760
|
#
|
@@ -4686,7 +4772,8 @@ module Aws::CostExplorer
|
|
4686
4772
|
#
|
4687
4773
|
# * `AmortizedUpfrontCommitment`
|
4688
4774
|
#
|
4689
|
-
#
|
4775
|
+
# The supported values for `SortOrder` are `ASCENDING` and
|
4776
|
+
# `DESCENDING`.
|
4690
4777
|
# @return [Types::SortDefinition]
|
4691
4778
|
#
|
4692
4779
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ce-2017-10-25/GetSavingsPlansUtilizationDetailsRequest AWS API Documentation
|
@@ -4818,7 +4905,7 @@ module Aws::CostExplorer
|
|
4818
4905
|
# @return [Types::Expression]
|
4819
4906
|
#
|
4820
4907
|
# @!attribute [rw] sort_by
|
4821
|
-
# The value
|
4908
|
+
# The value that you want to sort the data by.
|
4822
4909
|
#
|
4823
4910
|
# The following values are supported for `Key`\:
|
4824
4911
|
#
|
@@ -4832,7 +4919,8 @@ module Aws::CostExplorer
|
|
4832
4919
|
#
|
4833
4920
|
# * `NetSavings`
|
4834
4921
|
#
|
4835
|
-
#
|
4922
|
+
# The supported values for `SortOrder` are `ASCENDING` and
|
4923
|
+
# `DESCENDING`.
|
4836
4924
|
# @return [Types::SortDefinition]
|
4837
4925
|
#
|
4838
4926
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ce-2017-10-25/GetSavingsPlansUtilizationRequest AWS API Documentation
|
@@ -4847,8 +4935,8 @@ module Aws::CostExplorer
|
|
4847
4935
|
end
|
4848
4936
|
|
4849
4937
|
# @!attribute [rw] savings_plans_utilizations_by_time
|
4850
|
-
# The amount of cost/commitment you used your Savings Plans.
|
4851
|
-
#
|
4938
|
+
# The amount of cost/commitment that you used your Savings Plans. You
|
4939
|
+
# can use it to specify date ranges.
|
4852
4940
|
# @return [Array<Types::SavingsPlansUtilizationByTime>]
|
4853
4941
|
#
|
4854
4942
|
# @!attribute [rw] total
|
@@ -4987,7 +5075,7 @@ module Aws::CostExplorer
|
|
4987
5075
|
# @return [Types::Expression]
|
4988
5076
|
#
|
4989
5077
|
# @!attribute [rw] sort_by
|
4990
|
-
# The value
|
5078
|
+
# The value that you want to sort the data by.
|
4991
5079
|
#
|
4992
5080
|
# The key represents cost and usage metrics. The following values are
|
4993
5081
|
# supported:
|
@@ -5006,19 +5094,20 @@ module Aws::CostExplorer
|
|
5006
5094
|
#
|
5007
5095
|
# * `NormalizedUsageAmount`
|
5008
5096
|
#
|
5009
|
-
#
|
5097
|
+
# The supported values for `SortOrder` are `ASCENDING` and
|
5098
|
+
# `DESCENDING`.
|
5010
5099
|
#
|
5011
|
-
# When
|
5100
|
+
# When you use `SortBy`, `NextPageToken` and `SearchString` aren't
|
5012
5101
|
# supported.
|
5013
5102
|
# @return [Array<Types::SortDefinition>]
|
5014
5103
|
#
|
5015
5104
|
# @!attribute [rw] max_results
|
5016
5105
|
# This field is only used when SortBy is provided in the request. The
|
5017
|
-
# maximum number of objects that
|
5018
|
-
# MaxResults
|
5019
|
-
#
|
5106
|
+
# maximum number of objects that are returned for this request. If
|
5107
|
+
# MaxResults isn't specified with SortBy, the request returns 1000
|
5108
|
+
# results as the default value for this parameter.
|
5020
5109
|
#
|
5021
|
-
# For `GetTags`, MaxResults has an upper
|
5110
|
+
# For `GetTags`, MaxResults has an upper quota of 1000.
|
5022
5111
|
# @return [Integer]
|
5023
5112
|
#
|
5024
5113
|
# @!attribute [rw] next_page_token
|
@@ -5116,12 +5205,12 @@ module Aws::CostExplorer
|
|
5116
5205
|
#
|
5117
5206
|
# @!attribute [rw] time_period
|
5118
5207
|
# The start and end dates of the period that you want to retrieve
|
5119
|
-
# usage forecast for. The start date is
|
5120
|
-
#
|
5121
|
-
# `2017-05-01`, then the cost and usage
|
5122
|
-
# `2017-01-01` up to and including `2017-04-30`
|
5123
|
-
# `2017-05-01`. The start date must be equal to or
|
5124
|
-
# current date to avoid a validation error.
|
5208
|
+
# usage forecast for. The start date is included in the period, but
|
5209
|
+
# the end date isn't included in the period. For example, if `start`
|
5210
|
+
# is `2017-01-01` and `end` is `2017-05-01`, then the cost and usage
|
5211
|
+
# data is retrieved from `2017-01-01` up to and including `2017-04-30`
|
5212
|
+
# but not including `2017-05-01`. The start date must be equal to or
|
5213
|
+
# later than the current date to avoid a validation error.
|
5125
5214
|
# @return [Types::DateInterval]
|
5126
5215
|
#
|
5127
5216
|
# @!attribute [rw] metric
|
@@ -5195,12 +5284,12 @@ module Aws::CostExplorer
|
|
5195
5284
|
# @return [Types::Expression]
|
5196
5285
|
#
|
5197
5286
|
# @!attribute [rw] prediction_interval_level
|
5198
|
-
# Cost Explorer always returns the mean forecast
|
5199
|
-
# You can request a prediction interval around the
|
5200
|
-
# a confidence level. The higher the confidence
|
5201
|
-
# confident Cost Explorer is about the actual value
|
5202
|
-
# prediction interval. Higher confidence levels result
|
5203
|
-
# prediction intervals.
|
5287
|
+
# Amazon Web Services Cost Explorer always returns the mean forecast
|
5288
|
+
# as a single point. You can request a prediction interval around the
|
5289
|
+
# mean by specifying a confidence level. The higher the confidence
|
5290
|
+
# level, the more confident Cost Explorer is about the actual value
|
5291
|
+
# falling in the prediction interval. Higher confidence levels result
|
5292
|
+
# in wider prediction intervals.
|
5204
5293
|
# @return [Integer]
|
5205
5294
|
#
|
5206
5295
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ce-2017-10-25/GetUsageForecastRequest AWS API Documentation
|
@@ -5366,6 +5455,78 @@ module Aws::CostExplorer
|
|
5366
5455
|
include Aws::Structure
|
5367
5456
|
end
|
5368
5457
|
|
5458
|
+
# @note When making an API call, you may pass ListCostAllocationTagsRequest
|
5459
|
+
# data as a hash:
|
5460
|
+
#
|
5461
|
+
# {
|
5462
|
+
# status: "Active", # accepts Active, Inactive
|
5463
|
+
# tag_keys: ["TagKey"],
|
5464
|
+
# type: "AWSGenerated", # accepts AWSGenerated, UserDefined
|
5465
|
+
# next_token: "NextPageToken",
|
5466
|
+
# max_results: 1,
|
5467
|
+
# }
|
5468
|
+
#
|
5469
|
+
# @!attribute [rw] status
|
5470
|
+
# The status of cost allocation tag keys that are returned for this
|
5471
|
+
# request.
|
5472
|
+
# @return [String]
|
5473
|
+
#
|
5474
|
+
# @!attribute [rw] tag_keys
|
5475
|
+
# The list of cost allocation tag keys that are returned for this
|
5476
|
+
# request.
|
5477
|
+
# @return [Array<String>]
|
5478
|
+
#
|
5479
|
+
# @!attribute [rw] type
|
5480
|
+
# The type of `CostAllocationTag` object that are returned for this
|
5481
|
+
# request. The `AWSGenerated` type tags are tags that Amazon Web
|
5482
|
+
# Services defines and applies to support Amazon Web Services
|
5483
|
+
# resources for cost allocation purposes. The `UserDefined` type tags
|
5484
|
+
# are tags that you define, create, and apply to resources.
|
5485
|
+
# @return [String]
|
5486
|
+
#
|
5487
|
+
# @!attribute [rw] next_token
|
5488
|
+
# The token to retrieve the next set of results. Amazon Web Services
|
5489
|
+
# provides the token when the response from a previous call has more
|
5490
|
+
# results than the maximum page size.
|
5491
|
+
# @return [String]
|
5492
|
+
#
|
5493
|
+
# @!attribute [rw] max_results
|
5494
|
+
# The maximum number of objects that are returned for this request. By
|
5495
|
+
# default, the request returns 100 results.
|
5496
|
+
# @return [Integer]
|
5497
|
+
#
|
5498
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ce-2017-10-25/ListCostAllocationTagsRequest AWS API Documentation
|
5499
|
+
#
|
5500
|
+
class ListCostAllocationTagsRequest < Struct.new(
|
5501
|
+
:status,
|
5502
|
+
:tag_keys,
|
5503
|
+
:type,
|
5504
|
+
:next_token,
|
5505
|
+
:max_results)
|
5506
|
+
SENSITIVE = []
|
5507
|
+
include Aws::Structure
|
5508
|
+
end
|
5509
|
+
|
5510
|
+
# @!attribute [rw] cost_allocation_tags
|
5511
|
+
# A list of cost allocation tags that includes the detailed metadata
|
5512
|
+
# for each one.
|
5513
|
+
# @return [Array<Types::CostAllocationTag>]
|
5514
|
+
#
|
5515
|
+
# @!attribute [rw] next_token
|
5516
|
+
# The token to retrieve the next set of results. Amazon Web Services
|
5517
|
+
# provides the token when the response from a previous call has more
|
5518
|
+
# results than the maximum page size.
|
5519
|
+
# @return [String]
|
5520
|
+
#
|
5521
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ce-2017-10-25/ListCostAllocationTagsResponse AWS API Documentation
|
5522
|
+
#
|
5523
|
+
class ListCostAllocationTagsResponse < Struct.new(
|
5524
|
+
:cost_allocation_tags,
|
5525
|
+
:next_token)
|
5526
|
+
SENSITIVE = []
|
5527
|
+
include Aws::Structure
|
5528
|
+
end
|
5529
|
+
|
5369
5530
|
# @note When making an API call, you may pass ListCostCategoryDefinitionsRequest
|
5370
5531
|
# data as a hash:
|
5371
5532
|
#
|
@@ -5400,7 +5561,7 @@ module Aws::CostExplorer
|
|
5400
5561
|
end
|
5401
5562
|
|
5402
5563
|
# @!attribute [rw] cost_category_references
|
5403
|
-
# A reference to a Cost Category
|
5564
|
+
# A reference to a Cost Category that contains enough information to
|
5404
5565
|
# identify the Cost Category.
|
5405
5566
|
# @return [Array<Types::CostCategoryReference>]
|
5406
5567
|
#
|
@@ -5444,7 +5605,7 @@ module Aws::CostExplorer
|
|
5444
5605
|
end
|
5445
5606
|
|
5446
5607
|
# @!attribute [rw] resource_tags
|
5447
|
-
# A list of tag key value pairs that are associated with the
|
5608
|
+
# A list of tag key value pairs that are associated with the resource.
|
5448
5609
|
# @return [Array<Types::ResourceTag>]
|
5449
5610
|
#
|
5450
5611
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ce-2017-10-25/ListTagsForResourceResponse AWS API Documentation
|
@@ -5474,7 +5635,7 @@ module Aws::CostExplorer
|
|
5474
5635
|
include Aws::Structure
|
5475
5636
|
end
|
5476
5637
|
|
5477
|
-
# Details
|
5638
|
+
# Details for the modification recommendation.
|
5478
5639
|
#
|
5479
5640
|
# @!attribute [rw] target_instances
|
5480
5641
|
# Determines whether this instance type is the Amazon Web Services
|
@@ -5494,20 +5655,20 @@ module Aws::CostExplorer
|
|
5494
5655
|
#
|
5495
5656
|
# @!attribute [rw] network_in_bytes_per_second
|
5496
5657
|
# The network inbound throughput utilization measured in Bytes per
|
5497
|
-
# second.
|
5658
|
+
# second (Bps).
|
5498
5659
|
# @return [String]
|
5499
5660
|
#
|
5500
5661
|
# @!attribute [rw] network_out_bytes_per_second
|
5501
5662
|
# The network outbound throughput utilization measured in Bytes per
|
5502
|
-
# second.
|
5663
|
+
# second (Bps).
|
5503
5664
|
# @return [String]
|
5504
5665
|
#
|
5505
5666
|
# @!attribute [rw] network_packets_in_per_second
|
5506
|
-
# The network
|
5667
|
+
# The network inbound packets that are measured in packets per second.
|
5507
5668
|
# @return [String]
|
5508
5669
|
#
|
5509
5670
|
# @!attribute [rw] network_packets_out_per_second
|
5510
|
-
# The network
|
5671
|
+
# The network outbound packets that are measured in packets per
|
5511
5672
|
# second.
|
5512
5673
|
# @return [String]
|
5513
5674
|
#
|
@@ -5850,7 +6011,7 @@ module Aws::CostExplorer
|
|
5850
6011
|
# Details about your recommended reservation purchase.
|
5851
6012
|
#
|
5852
6013
|
# @!attribute [rw] account_id
|
5853
|
-
# The account that this RI recommendation is for.
|
6014
|
+
# The account that this Reserved Instance (RI) recommendation is for.
|
5854
6015
|
# @return [String]
|
5855
6016
|
#
|
5856
6017
|
# @!attribute [rw] instance_details
|
@@ -5921,12 +6082,12 @@ module Aws::CostExplorer
|
|
5921
6082
|
#
|
5922
6083
|
# @!attribute [rw] estimated_monthly_savings_amount
|
5923
6084
|
# How much Amazon Web Services estimates that this specific
|
5924
|
-
# recommendation
|
6085
|
+
# recommendation might save you in a month.
|
5925
6086
|
# @return [String]
|
5926
6087
|
#
|
5927
6088
|
# @!attribute [rw] estimated_monthly_savings_percentage
|
5928
6089
|
# How much Amazon Web Services estimates that this specific
|
5929
|
-
# recommendation
|
6090
|
+
# recommendation might save you in a month, as a percentage of your
|
5930
6091
|
# overall costs.
|
5931
6092
|
# @return [String]
|
5932
6093
|
#
|
@@ -5936,8 +6097,8 @@ module Aws::CostExplorer
|
|
5936
6097
|
# @return [String]
|
5937
6098
|
#
|
5938
6099
|
# @!attribute [rw] estimated_reservation_cost_for_lookback_period
|
5939
|
-
# How much Amazon Web Services estimates that you
|
5940
|
-
#
|
6100
|
+
# How much Amazon Web Services estimates that you might spend for all
|
6101
|
+
# usage during the specified historical period if you had a
|
5941
6102
|
# reservation.
|
5942
6103
|
# @return [String]
|
5943
6104
|
#
|
@@ -6053,10 +6214,10 @@ module Aws::CostExplorer
|
|
6053
6214
|
include Aws::Structure
|
6054
6215
|
end
|
6055
6216
|
|
6056
|
-
# Details
|
6217
|
+
# Details for the resource.
|
6057
6218
|
#
|
6058
6219
|
# @!attribute [rw] ec2_resource_details
|
6059
|
-
# Details
|
6220
|
+
# Details for the Amazon EC2 resource.
|
6060
6221
|
# @return [Types::EC2ResourceDetails]
|
6061
6222
|
#
|
6062
6223
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ce-2017-10-25/ResourceDetails AWS API Documentation
|
@@ -6107,11 +6268,11 @@ module Aws::CostExplorer
|
|
6107
6268
|
# }
|
6108
6269
|
#
|
6109
6270
|
# @!attribute [rw] key
|
6110
|
-
# The key that
|
6271
|
+
# The key that's associated with the tag.
|
6111
6272
|
# @return [String]
|
6112
6273
|
#
|
6113
6274
|
# @!attribute [rw] value
|
6114
|
-
# The value that
|
6275
|
+
# The value that's associated with the tag.
|
6115
6276
|
# @return [String]
|
6116
6277
|
#
|
6117
6278
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ce-2017-10-25/ResourceTag AWS API Documentation
|
@@ -6189,8 +6350,8 @@ module Aws::CostExplorer
|
|
6189
6350
|
# @return [Types::TerminateRecommendationDetail]
|
6190
6351
|
#
|
6191
6352
|
# @!attribute [rw] finding_reason_codes
|
6192
|
-
# The list of possible reasons why the recommendation is generated
|
6193
|
-
# such as under or over
|
6353
|
+
# The list of possible reasons why the recommendation is generated,
|
6354
|
+
# such as under- or over-utilization of specific metrics (for example,
|
6194
6355
|
# CPU, Memory, Network).
|
6195
6356
|
# @return [Array<String>]
|
6196
6357
|
#
|
@@ -6212,7 +6373,8 @@ module Aws::CostExplorer
|
|
6212
6373
|
# recommendations for instances within the same instance families or
|
6213
6374
|
# across different instance families. You can also choose to view your
|
6214
6375
|
# estimated savings that are associated with recommendations with
|
6215
|
-
# consideration of existing Savings Plans or
|
6376
|
+
# consideration of existing Savings Plans or Reserved Instance (RI)
|
6377
|
+
# benefits, or neither.
|
6216
6378
|
#
|
6217
6379
|
# @note When making an API call, you may pass RightsizingRecommendationConfiguration
|
6218
6380
|
# data as a hash:
|
@@ -6305,12 +6467,12 @@ module Aws::CostExplorer
|
|
6305
6467
|
include Aws::Structure
|
6306
6468
|
end
|
6307
6469
|
|
6308
|
-
# The combination of Amazon Web
|
6309
|
-
#
|
6470
|
+
# The combination of Amazon Web Service, linked account, Region, and
|
6471
|
+
# usage type where a cost anomaly is observed.
|
6310
6472
|
#
|
6311
6473
|
# @!attribute [rw] service
|
6312
|
-
# The Amazon Web
|
6313
|
-
#
|
6474
|
+
# The Amazon Web Service name that's associated with the cost
|
6475
|
+
# anomaly.
|
6314
6476
|
# @return [String]
|
6315
6477
|
#
|
6316
6478
|
# @!attribute [rw] region
|
@@ -6365,7 +6527,7 @@ module Aws::CostExplorer
|
|
6365
6527
|
include Aws::Structure
|
6366
6528
|
end
|
6367
6529
|
|
6368
|
-
# The amount of Savings Plans eligible usage that
|
6530
|
+
# The amount of Savings Plans eligible usage that's covered by Savings
|
6369
6531
|
# Plans. All calculations consider the On-Demand equivalent of your
|
6370
6532
|
# Savings Plans usage.
|
6371
6533
|
#
|
@@ -6396,7 +6558,7 @@ module Aws::CostExplorer
|
|
6396
6558
|
# Savings Plans, and total Savings Plans costs for an account.
|
6397
6559
|
#
|
6398
6560
|
# @!attribute [rw] spend_covered_by_savings_plans
|
6399
|
-
# The amount of your Amazon Web Services usage that
|
6561
|
+
# The amount of your Amazon Web Services usage that's covered by a
|
6400
6562
|
# Savings Plans.
|
6401
6563
|
# @return [String]
|
6402
6564
|
#
|
@@ -6475,15 +6637,16 @@ module Aws::CostExplorer
|
|
6475
6637
|
# @return [String]
|
6476
6638
|
#
|
6477
6639
|
# @!attribute [rw] payment_option
|
6478
|
-
# The payment option used to generate the recommendation.
|
6640
|
+
# The payment option that's used to generate the recommendation.
|
6479
6641
|
# @return [String]
|
6480
6642
|
#
|
6481
6643
|
# @!attribute [rw] lookback_period_in_days
|
6482
|
-
# The lookback period in days
|
6644
|
+
# The lookback period in days that's used to generate the
|
6645
|
+
# recommendation.
|
6483
6646
|
# @return [String]
|
6484
6647
|
#
|
6485
6648
|
# @!attribute [rw] savings_plans_purchase_recommendation_details
|
6486
|
-
# Details for the Savings Plans we recommend that you purchase to
|
6649
|
+
# Details for the Savings Plans that we recommend that you purchase to
|
6487
6650
|
# cover existing Savings Plans eligible workloads.
|
6488
6651
|
# @return [Array<Types::SavingsPlansPurchaseRecommendationDetail>]
|
6489
6652
|
#
|
@@ -6542,7 +6705,7 @@ module Aws::CostExplorer
|
|
6542
6705
|
# @return [String]
|
6543
6706
|
#
|
6544
6707
|
# @!attribute [rw] estimated_on_demand_cost_with_current_commitment
|
6545
|
-
# The estimated On-Demand costs you
|
6708
|
+
# The estimated On-Demand costs you expect with no additional
|
6546
6709
|
# commitment, based on your usage of the selected time period and the
|
6547
6710
|
# Savings Plans you own.
|
6548
6711
|
# @return [String]
|
@@ -6617,7 +6780,7 @@ module Aws::CostExplorer
|
|
6617
6780
|
# @return [String]
|
6618
6781
|
#
|
6619
6782
|
# @!attribute [rw] generation_timestamp
|
6620
|
-
# The timestamp
|
6783
|
+
# The timestamp that shows when the recommendations were generated.
|
6621
6784
|
# @return [String]
|
6622
6785
|
#
|
6623
6786
|
# @!attribute [rw] additional_metadata
|
@@ -6688,7 +6851,7 @@ module Aws::CostExplorer
|
|
6688
6851
|
# @return [String]
|
6689
6852
|
#
|
6690
6853
|
# @!attribute [rw] estimated_on_demand_cost_with_current_commitment
|
6691
|
-
# The estimated On-Demand costs you
|
6854
|
+
# The estimated On-Demand costs you expect with no additional
|
6692
6855
|
# commitment. It's based on your usage of the selected time period
|
6693
6856
|
# and the Savings Plans you own.
|
6694
6857
|
# @return [String]
|
@@ -6775,8 +6938,8 @@ module Aws::CostExplorer
|
|
6775
6938
|
# @return [Types::SavingsPlansUtilization]
|
6776
6939
|
#
|
6777
6940
|
# @!attribute [rw] savings
|
6778
|
-
# The amount saved by using existing Savings Plans. Savings
|
6779
|
-
# both net savings from Savings Plans
|
6941
|
+
# The amount that's saved by using existing Savings Plans. Savings
|
6942
|
+
# returns both net savings from Savings Plans and also the
|
6780
6943
|
# `onDemandCostEquivalent` of the Savings Plans when considering the
|
6781
6944
|
# utilization rate.
|
6782
6945
|
# @return [Types::SavingsPlansSavings]
|
@@ -6796,7 +6959,7 @@ module Aws::CostExplorer
|
|
6796
6959
|
include Aws::Structure
|
6797
6960
|
end
|
6798
6961
|
|
6799
|
-
# The amount of Savings Plans utilization
|
6962
|
+
# The amount of Savings Plans utilization (in hours).
|
6800
6963
|
#
|
6801
6964
|
# @!attribute [rw] time_period
|
6802
6965
|
# The time period of the request.
|
@@ -6808,8 +6971,8 @@ module Aws::CostExplorer
|
|
6808
6971
|
# @return [Types::SavingsPlansUtilization]
|
6809
6972
|
#
|
6810
6973
|
# @!attribute [rw] savings
|
6811
|
-
# The amount saved by using existing Savings Plans. Savings
|
6812
|
-
# both net savings from Savings Plans
|
6974
|
+
# The amount that's saved by using existing Savings Plans. Savings
|
6975
|
+
# returns both net savings from Savings Plans and also the
|
6813
6976
|
# `onDemandCostEquivalent` of the Savings Plans when considering the
|
6814
6977
|
# utilization rate.
|
6815
6978
|
# @return [Types::SavingsPlansSavings]
|
@@ -6830,7 +6993,7 @@ module Aws::CostExplorer
|
|
6830
6993
|
include Aws::Structure
|
6831
6994
|
end
|
6832
6995
|
|
6833
|
-
# A single daily or monthly Savings Plans utilization rate
|
6996
|
+
# A single daily or monthly Savings Plans utilization rate and details
|
6834
6997
|
# for your account. A management account in an organization have access
|
6835
6998
|
# to member accounts. You can use `GetDimensionValues` to determine the
|
6836
6999
|
# possible dimension values.
|
@@ -6850,7 +7013,7 @@ module Aws::CostExplorer
|
|
6850
7013
|
#
|
6851
7014
|
# @!attribute [rw] savings
|
6852
7015
|
# The amount saved by using existing Savings Plans. Savings returns
|
6853
|
-
# both net savings from savings plans
|
7016
|
+
# both net savings from savings plans and also the
|
6854
7017
|
# `onDemandCostEquivalent` of the Savings Plans when considering the
|
6855
7018
|
# utilization rate.
|
6856
7019
|
# @return [Types::SavingsPlansSavings]
|
@@ -6911,7 +7074,7 @@ module Aws::CostExplorer
|
|
6911
7074
|
include Aws::Structure
|
6912
7075
|
end
|
6913
7076
|
|
6914
|
-
# The details
|
7077
|
+
# The details for how to sort the data.
|
6915
7078
|
#
|
6916
7079
|
# @note When making an API call, you may pass SortDefinition
|
6917
7080
|
# data as a hash:
|
@@ -7008,8 +7171,8 @@ module Aws::CostExplorer
|
|
7008
7171
|
#
|
7009
7172
|
# * The maximum length of a value is 256 characters
|
7010
7173
|
#
|
7011
|
-
# *
|
7012
|
-
# `_
|
7174
|
+
# * Keys and values can only contain alphanumeric characters, spaces,
|
7175
|
+
# and any of the following: `_.:/=+@-`
|
7013
7176
|
#
|
7014
7177
|
# * Keys and values are case sensitive
|
7015
7178
|
#
|
@@ -7039,7 +7202,7 @@ module Aws::CostExplorer
|
|
7039
7202
|
# applied to all tags. That is, it's filtered on resources with no
|
7040
7203
|
# tags.
|
7041
7204
|
#
|
7042
|
-
# If `
|
7205
|
+
# If `Key` is provided and `Values` isn't specified, the `ABSENT`
|
7043
7206
|
# `MatchOption` is applied to the tag `Key` only. That is, it's
|
7044
7207
|
# filtered on resources without the given tag key.
|
7045
7208
|
#
|
@@ -7107,7 +7270,7 @@ module Aws::CostExplorer
|
|
7107
7270
|
# @return [Types::ResourceUtilization]
|
7108
7271
|
#
|
7109
7272
|
# @!attribute [rw] platform_differences
|
7110
|
-
# Explains the actions you might need to take
|
7273
|
+
# Explains the actions that you might need to take to successfully
|
7111
7274
|
# migrate your workloads from the current instance type to the
|
7112
7275
|
# recommended instance type.
|
7113
7276
|
# @return [Array<String>]
|
@@ -7258,7 +7421,7 @@ module Aws::CostExplorer
|
|
7258
7421
|
#
|
7259
7422
|
# @!attribute [rw] resource_tag_keys
|
7260
7423
|
# A list of tag keys associated with tags that need to be removed from
|
7261
|
-
# the resource. If you specify a tag key that
|
7424
|
+
# the resource. If you specify a tag key that doesn't exist, it's
|
7262
7425
|
# ignored. Although the maximum number of array members is 200,
|
7263
7426
|
# user-tag maximum is 50. The remaining are reserved for Amazon Web
|
7264
7427
|
# Services use.
|
@@ -7382,11 +7545,76 @@ module Aws::CostExplorer
|
|
7382
7545
|
include Aws::Structure
|
7383
7546
|
end
|
7384
7547
|
|
7548
|
+
# Gives a detailed description of the result of an action. It's on each
|
7549
|
+
# cost allocation tag entry in the request.
|
7550
|
+
#
|
7551
|
+
# @!attribute [rw] tag_key
|
7552
|
+
# The key for the cost allocation tag.
|
7553
|
+
# @return [String]
|
7554
|
+
#
|
7555
|
+
# @!attribute [rw] code
|
7556
|
+
# An error code representing why the action failed on this entry.
|
7557
|
+
# @return [String]
|
7558
|
+
#
|
7559
|
+
# @!attribute [rw] message
|
7560
|
+
# A message explaining why the action failed on this entry.
|
7561
|
+
# @return [String]
|
7562
|
+
#
|
7563
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ce-2017-10-25/UpdateCostAllocationTagsStatusError AWS API Documentation
|
7564
|
+
#
|
7565
|
+
class UpdateCostAllocationTagsStatusError < Struct.new(
|
7566
|
+
:tag_key,
|
7567
|
+
:code,
|
7568
|
+
:message)
|
7569
|
+
SENSITIVE = []
|
7570
|
+
include Aws::Structure
|
7571
|
+
end
|
7572
|
+
|
7573
|
+
# @note When making an API call, you may pass UpdateCostAllocationTagsStatusRequest
|
7574
|
+
# data as a hash:
|
7575
|
+
#
|
7576
|
+
# {
|
7577
|
+
# cost_allocation_tags_status: [ # required
|
7578
|
+
# {
|
7579
|
+
# tag_key: "TagKey", # required
|
7580
|
+
# status: "Active", # required, accepts Active, Inactive
|
7581
|
+
# },
|
7582
|
+
# ],
|
7583
|
+
# }
|
7584
|
+
#
|
7585
|
+
# @!attribute [rw] cost_allocation_tags_status
|
7586
|
+
# The list of `CostAllocationTagStatusEntry` objects that are used to
|
7587
|
+
# update cost allocation tags status for this request.
|
7588
|
+
# @return [Array<Types::CostAllocationTagStatusEntry>]
|
7589
|
+
#
|
7590
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ce-2017-10-25/UpdateCostAllocationTagsStatusRequest AWS API Documentation
|
7591
|
+
#
|
7592
|
+
class UpdateCostAllocationTagsStatusRequest < Struct.new(
|
7593
|
+
:cost_allocation_tags_status)
|
7594
|
+
SENSITIVE = []
|
7595
|
+
include Aws::Structure
|
7596
|
+
end
|
7597
|
+
|
7598
|
+
# @!attribute [rw] errors
|
7599
|
+
# A list of `UpdateCostAllocationTagsStatusError` objects with error
|
7600
|
+
# details about each cost allocation tag that can't be updated. If
|
7601
|
+
# there's no failure, an empty array returns.
|
7602
|
+
# @return [Array<Types::UpdateCostAllocationTagsStatusError>]
|
7603
|
+
#
|
7604
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ce-2017-10-25/UpdateCostAllocationTagsStatusResponse AWS API Documentation
|
7605
|
+
#
|
7606
|
+
class UpdateCostAllocationTagsStatusResponse < Struct.new(
|
7607
|
+
:errors)
|
7608
|
+
SENSITIVE = []
|
7609
|
+
include Aws::Structure
|
7610
|
+
end
|
7611
|
+
|
7385
7612
|
# @note When making an API call, you may pass UpdateCostCategoryDefinitionRequest
|
7386
7613
|
# data as a hash:
|
7387
7614
|
#
|
7388
7615
|
# {
|
7389
7616
|
# cost_category_arn: "Arn", # required
|
7617
|
+
# effective_start: "ZonedDateTime",
|
7390
7618
|
# rule_version: "CostCategoryExpression.v1", # required, accepts CostCategoryExpression.v1
|
7391
7619
|
# rules: [ # required
|
7392
7620
|
# {
|
@@ -7448,6 +7676,13 @@ module Aws::CostExplorer
|
|
7448
7676
|
# The unique identifier for your Cost Category.
|
7449
7677
|
# @return [String]
|
7450
7678
|
#
|
7679
|
+
# @!attribute [rw] effective_start
|
7680
|
+
# The Cost Category's effective start date. It can only be a billing
|
7681
|
+
# start date (first day of the month). If the date isn't provided,
|
7682
|
+
# it's the first day of the current month. Dates can't be before the
|
7683
|
+
# previous twelve months, or in the future.
|
7684
|
+
# @return [String]
|
7685
|
+
#
|
7451
7686
|
# @!attribute [rw] rule_version
|
7452
7687
|
# The rule schema version in this particular Cost Category.
|
7453
7688
|
# @return [String]
|
@@ -7474,6 +7709,7 @@ module Aws::CostExplorer
|
|
7474
7709
|
#
|
7475
7710
|
class UpdateCostCategoryDefinitionRequest < Struct.new(
|
7476
7711
|
:cost_category_arn,
|
7712
|
+
:effective_start,
|
7477
7713
|
:rule_version,
|
7478
7714
|
:rules,
|
7479
7715
|
:default_value,
|
@@ -7487,7 +7723,8 @@ module Aws::CostExplorer
|
|
7487
7723
|
# @return [String]
|
7488
7724
|
#
|
7489
7725
|
# @!attribute [rw] effective_start
|
7490
|
-
# The Cost Category's effective start date.
|
7726
|
+
# The Cost Category's effective start date. It can only be a billing
|
7727
|
+
# start date (first day of the month).
|
7491
7728
|
# @return [String]
|
7492
7729
|
#
|
7493
7730
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ce-2017-10-25/UpdateCostCategoryDefinitionResponse AWS API Documentation
|