aws-sdk-costexplorer 1.64.0 → 1.68.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 +20 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-costexplorer/client.rb +197 -141
- data/lib/aws-sdk-costexplorer/client_api.rb +29 -0
- data/lib/aws-sdk-costexplorer/types.rb +642 -469
- data/lib/aws-sdk-costexplorer.rb +1 -1
- metadata +5 -5
@@ -285,6 +285,15 @@ module Aws::CostExplorer
|
|
285
285
|
# ** Please note ** When response stubbing is enabled, no HTTP
|
286
286
|
# requests are made, and retries are disabled.
|
287
287
|
#
|
288
|
+
# @option options [Boolean] :use_dualstack_endpoint
|
289
|
+
# When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
|
290
|
+
# will be used if available.
|
291
|
+
#
|
292
|
+
# @option options [Boolean] :use_fips_endpoint
|
293
|
+
# When set to `true`, fips compatible endpoints will be used if available.
|
294
|
+
# When a `fips` region is used, the region is normalized and this config
|
295
|
+
# is set to `true`.
|
296
|
+
#
|
288
297
|
# @option options [Boolean] :validate_params (true)
|
289
298
|
# When `true`, request parameters are validated before
|
290
299
|
# sending the request.
|
@@ -469,6 +478,10 @@ module Aws::CostExplorer
|
|
469
478
|
# @option params [String] :default_value
|
470
479
|
# The default value for the cost category.
|
471
480
|
#
|
481
|
+
# @option params [Array<Types::CostCategorySplitChargeRule>] :split_charge_rules
|
482
|
+
# The split charge rules used to allocate your charges between your Cost
|
483
|
+
# Category values.
|
484
|
+
#
|
472
485
|
# @return [Types::CreateCostCategoryDefinitionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
473
486
|
#
|
474
487
|
# * {Types::CreateCostCategoryDefinitionResponse#cost_category_arn #cost_category_arn} => String
|
@@ -520,6 +533,19 @@ module Aws::CostExplorer
|
|
520
533
|
# },
|
521
534
|
# ],
|
522
535
|
# default_value: "CostCategoryValue",
|
536
|
+
# split_charge_rules: [
|
537
|
+
# {
|
538
|
+
# source: "GenericString", # required
|
539
|
+
# targets: ["GenericString"], # required
|
540
|
+
# method: "FIXED", # required, accepts FIXED, PROPORTIONAL, EVEN
|
541
|
+
# parameters: [
|
542
|
+
# {
|
543
|
+
# type: "ALLOCATION_PERCENTAGES", # required, accepts ALLOCATION_PERCENTAGES
|
544
|
+
# values: ["GenericString"], # required
|
545
|
+
# },
|
546
|
+
# ],
|
547
|
+
# },
|
548
|
+
# ],
|
523
549
|
# })
|
524
550
|
#
|
525
551
|
# @example Response structure
|
@@ -671,6 +697,15 @@ module Aws::CostExplorer
|
|
671
697
|
# resp.cost_category.rules[0].inherited_value.dimension_name #=> String, one of "LINKED_ACCOUNT_NAME", "TAG"
|
672
698
|
# resp.cost_category.rules[0].inherited_value.dimension_key #=> String
|
673
699
|
# resp.cost_category.rules[0].type #=> String, one of "REGULAR", "INHERITED_VALUE"
|
700
|
+
# resp.cost_category.split_charge_rules #=> Array
|
701
|
+
# resp.cost_category.split_charge_rules[0].source #=> String
|
702
|
+
# resp.cost_category.split_charge_rules[0].targets #=> Array
|
703
|
+
# resp.cost_category.split_charge_rules[0].targets[0] #=> String
|
704
|
+
# resp.cost_category.split_charge_rules[0].method #=> String, one of "FIXED", "PROPORTIONAL", "EVEN"
|
705
|
+
# resp.cost_category.split_charge_rules[0].parameters #=> Array
|
706
|
+
# resp.cost_category.split_charge_rules[0].parameters[0].type #=> String, one of "ALLOCATION_PERCENTAGES"
|
707
|
+
# resp.cost_category.split_charge_rules[0].parameters[0].values #=> Array
|
708
|
+
# resp.cost_category.split_charge_rules[0].parameters[0].values[0] #=> String
|
674
709
|
# resp.cost_category.processing_status #=> Array
|
675
710
|
# resp.cost_category.processing_status[0].component #=> String, one of "COST_EXPLORER"
|
676
711
|
# resp.cost_category.processing_status[0].status #=> String, one of "PROCESSING", "APPLIED"
|
@@ -685,8 +720,8 @@ module Aws::CostExplorer
|
|
685
720
|
req.send_request(options)
|
686
721
|
end
|
687
722
|
|
688
|
-
# Retrieves all of the cost anomalies detected on your account
|
689
|
-
# the time period specified by the `DateInterval` object.
|
723
|
+
# Retrieves all of the cost anomalies detected on your account during
|
724
|
+
# the time period that's specified by the `DateInterval` object.
|
690
725
|
#
|
691
726
|
# @option params [String] :monitor_arn
|
692
727
|
# Retrieves all of the cost anomalies detected for a specific cost
|
@@ -706,9 +741,9 @@ module Aws::CostExplorer
|
|
706
741
|
# retrieve anomalies, with an estimated dollar impact greater than 200.
|
707
742
|
#
|
708
743
|
# @option params [String] :next_page_token
|
709
|
-
# The token to retrieve the next set of results.
|
710
|
-
# when the response from a previous call has more
|
711
|
-
# maximum page size.
|
744
|
+
# The token to retrieve the next set of results. Amazon Web Services
|
745
|
+
# provides the token when the response from a previous call has more
|
746
|
+
# results than the maximum page size.
|
712
747
|
#
|
713
748
|
# @option params [Integer] :max_results
|
714
749
|
# The number of entries a paginated response contains.
|
@@ -773,12 +808,12 @@ module Aws::CostExplorer
|
|
773
808
|
# A list of cost anomaly monitor ARNs.
|
774
809
|
#
|
775
810
|
# @option params [String] :next_page_token
|
776
|
-
# The token to retrieve the next set of results.
|
777
|
-
# when the response from a previous call has more
|
778
|
-
# maximum page size.
|
811
|
+
# The token to retrieve the next set of results. Amazon Web Services
|
812
|
+
# provides the token when the response from a previous call has more
|
813
|
+
# results than the maximum page size.
|
779
814
|
#
|
780
815
|
# @option params [Integer] :max_results
|
781
|
-
# The number of entries a paginated response contains.
|
816
|
+
# The number of entries that a paginated response contains.
|
782
817
|
#
|
783
818
|
# @return [Types::GetAnomalyMonitorsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
784
819
|
#
|
@@ -846,9 +881,9 @@ module Aws::CostExplorer
|
|
846
881
|
# Cost anomaly monitor ARNs.
|
847
882
|
#
|
848
883
|
# @option params [String] :next_page_token
|
849
|
-
# The token to retrieve the next set of results.
|
850
|
-
# when the response from a previous call has more
|
851
|
-
# maximum page size.
|
884
|
+
# The token to retrieve the next set of results. Amazon Web Services
|
885
|
+
# provides the token when the response from a previous call has more
|
886
|
+
# results than the maximum page size.
|
852
887
|
#
|
853
888
|
# @option params [Integer] :max_results
|
854
889
|
# The number of entries a paginated response contains.
|
@@ -893,13 +928,13 @@ module Aws::CostExplorer
|
|
893
928
|
end
|
894
929
|
|
895
930
|
# Retrieves cost and usage metrics for your account. You can specify
|
896
|
-
# which cost and usage-related metric
|
897
|
-
#
|
898
|
-
# filter and group your data by various
|
899
|
-
# `AZ`, in a specific time range. For a
|
900
|
-
# dimensions, see the [GetDimensionValues][1]
|
901
|
-
# account in an organization in
|
902
|
-
# member accounts.
|
931
|
+
# which cost and usage-related metric that you want the request to
|
932
|
+
# return. For example, you can specify `BlendedCosts` or
|
933
|
+
# `UsageQuantity`. You can also filter and group your data by various
|
934
|
+
# dimensions, such as `SERVICE` or `AZ`, in a specific time range. For a
|
935
|
+
# complete list of valid dimensions, see the [GetDimensionValues][1]
|
936
|
+
# operation. Management account in an organization in Organizations have
|
937
|
+
# access to all member accounts.
|
903
938
|
#
|
904
939
|
# For information about filter limitations, see [Quotas and
|
905
940
|
# restrictions][2] in the *Billing and Cost Management User Guide*.
|
@@ -910,23 +945,23 @@ module Aws::CostExplorer
|
|
910
945
|
# [2]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/billing-limits.html
|
911
946
|
#
|
912
947
|
# @option params [required, Types::DateInterval] :time_period
|
913
|
-
# Sets the start and end
|
914
|
-
# is inclusive, but the end date is exclusive. For
|
915
|
-
# is `2017-01-01` and `end` is `2017-05-01`, then
|
916
|
-
# data is retrieved from `2017-01-01` up to and
|
917
|
-
# but not including `2017-05-01`.
|
948
|
+
# Sets the start date and end date for retrieving Amazon Web Services
|
949
|
+
# costs. The start date is inclusive, but the end date is exclusive. For
|
950
|
+
# example, if `start` is `2017-01-01` and `end` is `2017-05-01`, then
|
951
|
+
# the cost and usage data is retrieved from `2017-01-01` up to and
|
952
|
+
# including `2017-04-30` but not including `2017-05-01`.
|
918
953
|
#
|
919
954
|
# @option params [required, String] :granularity
|
920
|
-
# Sets the
|
921
|
-
# `Granularity` isn't set, the response object doesn't
|
922
|
-
# `Granularity`, either `MONTHLY` or `DAILY`, or `HOURLY`.
|
955
|
+
# Sets the Amazon Web Services cost granularity to `MONTHLY` or `DAILY`,
|
956
|
+
# or `HOURLY`. If `Granularity` isn't set, the response object doesn't
|
957
|
+
# include the `Granularity`, either `MONTHLY` or `DAILY`, or `HOURLY`.
|
923
958
|
#
|
924
959
|
# @option params [Types::Expression] :filter
|
925
|
-
# Filters
|
926
|
-
# specify `SERVICE` and `LINKED_ACCOUNT` and get the
|
927
|
-
# associated with that account's usage of that service.
|
928
|
-
# `Expression` objects to define any combination of
|
929
|
-
# For more information, see [Expression][1].
|
960
|
+
# Filters Amazon Web Services costs by different dimensions. For
|
961
|
+
# example, you can specify `SERVICE` and `LINKED_ACCOUNT` and get the
|
962
|
+
# costs that are associated with that account's usage of that service.
|
963
|
+
# You can nest `Expression` objects to define any combination of
|
964
|
+
# dimension filters. For more information, see [Expression][1].
|
930
965
|
#
|
931
966
|
#
|
932
967
|
#
|
@@ -945,7 +980,7 @@ module Aws::CostExplorer
|
|
945
980
|
# usage numbers without taking into account the units. For example, if
|
946
981
|
# you aggregate `usageQuantity` across all of Amazon EC2, the results
|
947
982
|
# aren't meaningful because Amazon EC2 compute hours and data transfer
|
948
|
-
# are measured in different units (for example, hours
|
983
|
+
# are measured in different units (for example, hours and GB). To get
|
949
984
|
# more meaningful `UsageQuantity` metrics, filter by `UsageType` or
|
950
985
|
# `UsageTypeGroups`.
|
951
986
|
#
|
@@ -958,20 +993,22 @@ module Aws::CostExplorer
|
|
958
993
|
# [1]: http://aws.amazon.com/premiumsupport/knowledge-center/blended-rates-intro/
|
959
994
|
#
|
960
995
|
# @option params [Array<Types::GroupDefinition>] :group_by
|
961
|
-
# You can group
|
962
|
-
# dimensions, tag keys, cost categories, or any two group
|
996
|
+
# You can group Amazon Web Services costs using up to two different
|
997
|
+
# groups, either dimensions, tag keys, cost categories, or any two group
|
998
|
+
# by types.
|
963
999
|
#
|
964
|
-
#
|
965
|
-
#
|
1000
|
+
# Valid values for the `DIMENSION` type are `AZ`, `INSTANCE_TYPE`,
|
1001
|
+
# `LEGAL_ENTITY_NAME`, `LINKED_ACCOUNT`, `OPERATION`, `PLATFORM`,
|
1002
|
+
# `PURCHASE_TYPE`, `SERVICE`, `TENANCY`, `RECORD_TYPE`, and
|
1003
|
+
# `USAGE_TYPE`.
|
966
1004
|
#
|
967
|
-
#
|
968
|
-
#
|
969
|
-
# `TAGS`, `TENANCY`, `RECORD_TYPE`, and `USAGE_TYPE`.
|
1005
|
+
# When you group by the `TAG` type and include a valid tag key, you get
|
1006
|
+
# all tag values, including empty strings.
|
970
1007
|
#
|
971
1008
|
# @option params [String] :next_page_token
|
972
|
-
# The token to retrieve the next set of results.
|
973
|
-
# when the response from a previous call has more
|
974
|
-
# maximum page size.
|
1009
|
+
# The token to retrieve the next set of results. Amazon Web Services
|
1010
|
+
# provides the token when the response from a previous call has more
|
1011
|
+
# results than the maximum page size.
|
975
1012
|
#
|
976
1013
|
# @return [Types::GetCostAndUsageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
977
1014
|
#
|
@@ -1067,14 +1104,14 @@ module Aws::CostExplorer
|
|
1067
1104
|
# return. You can also filter and group your data by various dimensions,
|
1068
1105
|
# such as `SERVICE` or `AZ`, in a specific time range. For a complete
|
1069
1106
|
# list of valid dimensions, see the [GetDimensionValues][1] operation.
|
1070
|
-
# Management account in an organization in
|
1071
|
-
#
|
1107
|
+
# Management account in an organization in Organizations have access to
|
1108
|
+
# all member accounts. This API is currently available for the Amazon
|
1072
1109
|
# Elastic Compute Cloud – Compute service only.
|
1073
1110
|
#
|
1074
1111
|
# <note markdown="1"> This is an opt-in only feature. You can enable this feature from the
|
1075
1112
|
# Cost Explorer Settings page. For information on how to access the
|
1076
1113
|
# Settings page, see [Controlling Access for Cost Explorer][2] in the
|
1077
|
-
# *
|
1114
|
+
# *Billing and Cost Management User Guide*.
|
1078
1115
|
#
|
1079
1116
|
# </note>
|
1080
1117
|
#
|
@@ -1093,9 +1130,9 @@ module Aws::CostExplorer
|
|
1093
1130
|
# `2017-05-01`.
|
1094
1131
|
#
|
1095
1132
|
# @option params [required, String] :granularity
|
1096
|
-
# Sets the
|
1097
|
-
# `Granularity` isn't set, the response object doesn't
|
1098
|
-
# `Granularity`, `MONTHLY`, `DAILY`, or `HOURLY`.
|
1133
|
+
# Sets the Amazon Web Services cost granularity to `MONTHLY`, `DAILY`,
|
1134
|
+
# or `HOURLY`. If `Granularity` isn't set, the response object doesn't
|
1135
|
+
# include the `Granularity`, `MONTHLY`, `DAILY`, or `HOURLY`.
|
1099
1136
|
#
|
1100
1137
|
# @option params [required, Types::Expression] :filter
|
1101
1138
|
# Filters Amazon Web Services costs by different dimensions. For
|
@@ -1142,9 +1179,9 @@ module Aws::CostExplorer
|
|
1142
1179
|
# groups: `DIMENSION`, `TAG`, `COST_CATEGORY`.
|
1143
1180
|
#
|
1144
1181
|
# @option params [String] :next_page_token
|
1145
|
-
# The token to retrieve the next set of results.
|
1146
|
-
# when the response from a previous call has more
|
1147
|
-
# maximum page size.
|
1182
|
+
# The token to retrieve the next set of results. Amazon Web Services
|
1183
|
+
# provides the token when the response from a previous call has more
|
1184
|
+
# results than the maximum page size.
|
1148
1185
|
#
|
1149
1186
|
# @return [Types::GetCostAndUsageWithResourcesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1150
1187
|
#
|
@@ -1265,7 +1302,7 @@ module Aws::CostExplorer
|
|
1265
1302
|
# for `REGION==us-east-1 OR REGION==us-west-1`. For
|
1266
1303
|
# `GetRightsizingRecommendation`, the Region is a full name (for
|
1267
1304
|
# example, `REGION==US East (N. Virginia)`. The `Expression` example
|
1268
|
-
#
|
1305
|
+
# is as follows:
|
1269
1306
|
#
|
1270
1307
|
# `\{ "Dimensions": \{ "Key": "REGION", "Values": [ "us-east-1",
|
1271
1308
|
# “us-west-1” ] \} \}`
|
@@ -1277,11 +1314,11 @@ module Aws::CostExplorer
|
|
1277
1314
|
#
|
1278
1315
|
# * Compound dimension values with logical operations - You can use
|
1279
1316
|
# multiple `Expression` types and the logical operators `AND/OR/NOT`
|
1280
|
-
# to create a list of one or more `Expression` objects.
|
1281
|
-
# you
|
1317
|
+
# to create a list of one or more `Expression` objects. By doing this,
|
1318
|
+
# you can filter on more advanced options. For example, you can filter
|
1282
1319
|
# on `((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type ==
|
1283
1320
|
# Type1)) AND (USAGE_TYPE != DataTransfer)`. The `Expression` for that
|
1284
|
-
#
|
1321
|
+
# is as follows:
|
1285
1322
|
#
|
1286
1323
|
# `\{ "And": [ \{"Or": [ \{"Dimensions": \{ "Key": "REGION", "Values":
|
1287
1324
|
# [ "us-east-1", "us-west-1" ] \}\}, \{"Tags": \{ "Key": "TagName",
|
@@ -1298,13 +1335,13 @@ module Aws::CostExplorer
|
|
1298
1335
|
# "USAGE_TYPE", "Values": [ "DataTransfer" ] \} \} `
|
1299
1336
|
#
|
1300
1337
|
# <note markdown="1"> For the `GetRightsizingRecommendation` action, a combination of OR and
|
1301
|
-
# NOT
|
1338
|
+
# NOT isn't supported. OR isn't supported between different
|
1302
1339
|
# dimensions, or dimensions and tags. NOT operators aren't supported.
|
1303
1340
|
# Dimensions are also limited to `LINKED_ACCOUNT`, `REGION`, or
|
1304
1341
|
# `RIGHTSIZING_TYPE`.
|
1305
1342
|
#
|
1306
1343
|
# For the `GetReservationPurchaseRecommendation` action, only NOT is
|
1307
|
-
# supported. AND and OR
|
1344
|
+
# supported. AND and OR aren't supported. Dimensions are limited to
|
1308
1345
|
# `LINKED_ACCOUNT`.
|
1309
1346
|
#
|
1310
1347
|
# </note>
|
@@ -1345,9 +1382,9 @@ module Aws::CostExplorer
|
|
1345
1382
|
#
|
1346
1383
|
# @option params [String] :next_page_token
|
1347
1384
|
# If the number of objects that are still available for retrieval
|
1348
|
-
# exceeds the limit,
|
1349
|
-
# To retrieve the next batch of objects, provide the
|
1350
|
-
# the prior call in your next request.
|
1385
|
+
# exceeds the limit, Amazon Web Services returns a NextPageToken value
|
1386
|
+
# in the response. To retrieve the next batch of objects, provide the
|
1387
|
+
# NextPageToken from the prior call in your next request.
|
1351
1388
|
#
|
1352
1389
|
# @return [Types::GetCostCategoriesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1353
1390
|
#
|
@@ -1595,10 +1632,10 @@ module Aws::CostExplorer
|
|
1595
1632
|
# The value that you want to search the filter values for.
|
1596
1633
|
#
|
1597
1634
|
# @option params [required, Types::DateInterval] :time_period
|
1598
|
-
# The start and end
|
1599
|
-
# date is inclusive, but the end date is exclusive. For example,
|
1600
|
-
# `start` is `2017-01-01` and `end` is `2017-05-01`, then the cost
|
1601
|
-
# usage data is retrieved from `2017-01-01` up to and including
|
1635
|
+
# The start date and end date for retrieving the dimension values. The
|
1636
|
+
# start date is inclusive, but the end date is exclusive. For example,
|
1637
|
+
# if `start` is `2017-01-01` and `end` is `2017-05-01`, then the cost
|
1638
|
+
# and usage data is retrieved from `2017-01-01` up to and including
|
1602
1639
|
# `2017-04-30` but not including `2017-05-01`.
|
1603
1640
|
#
|
1604
1641
|
# @option params [required, String] :dimension
|
@@ -1626,11 +1663,11 @@ module Aws::CostExplorer
|
|
1626
1663
|
# `m4.xlarge`.
|
1627
1664
|
#
|
1628
1665
|
# * LEGAL\_ENTITY\_NAME - The name of the organization that sells you
|
1629
|
-
#
|
1666
|
+
# Amazon Web Services services, such as Amazon Web Services.
|
1630
1667
|
#
|
1631
1668
|
# * LINKED\_ACCOUNT - The description in the attribute map that includes
|
1632
1669
|
# the full name of the member account. The value field contains the
|
1633
|
-
#
|
1670
|
+
# Amazon Web Services ID of the member account.
|
1634
1671
|
#
|
1635
1672
|
# * OPERATING\_SYSTEM - The operating system. Examples are Windows or
|
1636
1673
|
# Linux.
|
@@ -1645,7 +1682,7 @@ module Aws::CostExplorer
|
|
1645
1682
|
# usage is related. Examples include On-Demand Instances and Standard
|
1646
1683
|
# Reserved Instances.
|
1647
1684
|
#
|
1648
|
-
# * SERVICE - The
|
1685
|
+
# * SERVICE - The Amazon Web Services service such as Amazon DynamoDB.
|
1649
1686
|
#
|
1650
1687
|
# * USAGE\_TYPE - The type of usage. An example is
|
1651
1688
|
# DataTransfer-In-Bytes. The response for the `GetDimensionValues`
|
@@ -1655,7 +1692,7 @@ module Aws::CostExplorer
|
|
1655
1692
|
# is Amazon EC2: CloudWatch – Alarms. The response for this operation
|
1656
1693
|
# includes a unit attribute.
|
1657
1694
|
#
|
1658
|
-
# * REGION - The
|
1695
|
+
# * REGION - The Amazon Web Services Region.
|
1659
1696
|
#
|
1660
1697
|
# * RECORD\_TYPE - The different types of charges such as RI fees, usage
|
1661
1698
|
# costs, tax refunds, and credits.
|
@@ -1680,12 +1717,12 @@ module Aws::CostExplorer
|
|
1680
1717
|
#
|
1681
1718
|
# * LINKED\_ACCOUNT - The description in the attribute map that includes
|
1682
1719
|
# the full name of the member account. The value field contains the
|
1683
|
-
#
|
1720
|
+
# Amazon Web Services ID of the member account.
|
1684
1721
|
#
|
1685
1722
|
# * PLATFORM - The Amazon EC2 operating system. Examples are Windows or
|
1686
1723
|
# Linux.
|
1687
1724
|
#
|
1688
|
-
# * REGION - The
|
1725
|
+
# * REGION - The Amazon Web Services Region.
|
1689
1726
|
#
|
1690
1727
|
# * SCOPE (Utilization only) - The scope of a Reserved Instance (RI).
|
1691
1728
|
# Values are regional or a single Availability Zone.
|
@@ -1705,13 +1742,13 @@ module Aws::CostExplorer
|
|
1705
1742
|
# * PAYMENT\_OPTION - Payment option for the given Savings Plans (for
|
1706
1743
|
# example, All Upfront)
|
1707
1744
|
#
|
1708
|
-
# * REGION - The
|
1745
|
+
# * REGION - The Amazon Web Services Region.
|
1709
1746
|
#
|
1710
1747
|
# * INSTANCE\_TYPE\_FAMILY - The family of instances (For example, `m5`)
|
1711
1748
|
#
|
1712
1749
|
# * LINKED\_ACCOUNT - The description in the attribute map that includes
|
1713
1750
|
# the full name of the member account. The value field contains the
|
1714
|
-
#
|
1751
|
+
# Amazon Web Services ID of the member account.
|
1715
1752
|
#
|
1716
1753
|
# * SAVINGS\_PLAN\_ARN - The unique identifier for your Savings Plan
|
1717
1754
|
#
|
@@ -1724,7 +1761,7 @@ module Aws::CostExplorer
|
|
1724
1761
|
# for `REGION==us-east-1 OR REGION==us-west-1`. For
|
1725
1762
|
# `GetRightsizingRecommendation`, the Region is a full name (for
|
1726
1763
|
# example, `REGION==US East (N. Virginia)`. The `Expression` example
|
1727
|
-
#
|
1764
|
+
# is as follows:
|
1728
1765
|
#
|
1729
1766
|
# `\{ "Dimensions": \{ "Key": "REGION", "Values": [ "us-east-1",
|
1730
1767
|
# “us-west-1” ] \} \}`
|
@@ -1736,11 +1773,11 @@ module Aws::CostExplorer
|
|
1736
1773
|
#
|
1737
1774
|
# * Compound dimension values with logical operations - You can use
|
1738
1775
|
# multiple `Expression` types and the logical operators `AND/OR/NOT`
|
1739
|
-
# to create a list of one or more `Expression` objects.
|
1740
|
-
# you
|
1776
|
+
# to create a list of one or more `Expression` objects. By doing this,
|
1777
|
+
# you can filter on more advanced options. For example, you can filter
|
1741
1778
|
# on `((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type ==
|
1742
1779
|
# Type1)) AND (USAGE_TYPE != DataTransfer)`. The `Expression` for that
|
1743
|
-
#
|
1780
|
+
# is as follows:
|
1744
1781
|
#
|
1745
1782
|
# `\{ "And": [ \{"Or": [ \{"Dimensions": \{ "Key": "REGION", "Values":
|
1746
1783
|
# [ "us-east-1", "us-west-1" ] \}\}, \{"Tags": \{ "Key": "TagName",
|
@@ -1757,13 +1794,13 @@ module Aws::CostExplorer
|
|
1757
1794
|
# "USAGE_TYPE", "Values": [ "DataTransfer" ] \} \} `
|
1758
1795
|
#
|
1759
1796
|
# <note markdown="1"> For the `GetRightsizingRecommendation` action, a combination of OR and
|
1760
|
-
# NOT
|
1797
|
+
# NOT isn't supported. OR isn't supported between different
|
1761
1798
|
# dimensions, or dimensions and tags. NOT operators aren't supported.
|
1762
1799
|
# Dimensions are also limited to `LINKED_ACCOUNT`, `REGION`, or
|
1763
1800
|
# `RIGHTSIZING_TYPE`.
|
1764
1801
|
#
|
1765
1802
|
# For the `GetReservationPurchaseRecommendation` action, only NOT is
|
1766
|
-
# supported. AND and OR
|
1803
|
+
# supported. AND and OR aren't supported. Dimensions are limited to
|
1767
1804
|
# `LINKED_ACCOUNT`.
|
1768
1805
|
#
|
1769
1806
|
# </note>
|
@@ -1803,9 +1840,9 @@ module Aws::CostExplorer
|
|
1803
1840
|
# For `GetDimensionValues`, MaxResults has an upper limit of 1000.
|
1804
1841
|
#
|
1805
1842
|
# @option params [String] :next_page_token
|
1806
|
-
# The token to retrieve the next set of results.
|
1807
|
-
# when the response from a previous call has more
|
1808
|
-
# maximum page size.
|
1843
|
+
# The token to retrieve the next set of results. Amazon Web Services
|
1844
|
+
# provides the token when the response from a previous call has more
|
1845
|
+
# results than the maximum page size.
|
1809
1846
|
#
|
1810
1847
|
# @return [Types::GetDimensionValuesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1811
1848
|
#
|
@@ -1952,8 +1989,8 @@ module Aws::CostExplorer
|
|
1952
1989
|
# * TENANCY
|
1953
1990
|
#
|
1954
1991
|
# @option params [String] :granularity
|
1955
|
-
# The granularity of the
|
1956
|
-
# are `MONTHLY` and `DAILY`.
|
1992
|
+
# The granularity of the Amazon Web Services cost data for the
|
1993
|
+
# reservation. Valid values are `MONTHLY` and `DAILY`.
|
1957
1994
|
#
|
1958
1995
|
# If `GroupBy` is set, `Granularity` can't be set. If `Granularity`
|
1959
1996
|
# isn't set, the response object doesn't include `Granularity`, either
|
@@ -2011,9 +2048,9 @@ module Aws::CostExplorer
|
|
2011
2048
|
# values in a request.
|
2012
2049
|
#
|
2013
2050
|
# @option params [String] :next_page_token
|
2014
|
-
# The token to retrieve the next set of results.
|
2015
|
-
# when the response from a previous call has more
|
2016
|
-
# maximum page size.
|
2051
|
+
# The token to retrieve the next set of results. Amazon Web Services
|
2052
|
+
# provides the token when the response from a previous call has more
|
2053
|
+
# results than the maximum page size.
|
2017
2054
|
#
|
2018
2055
|
# @option params [Types::SortDefinition] :sort_by
|
2019
2056
|
# The value by which you want to sort the data.
|
@@ -2044,9 +2081,9 @@ module Aws::CostExplorer
|
|
2044
2081
|
#
|
2045
2082
|
# @option params [Integer] :max_results
|
2046
2083
|
# The maximum number of objects that you returned for this request. If
|
2047
|
-
# more objects are available, in the response,
|
2048
|
-
# NextPageToken value that you can use in a subsequent call
|
2049
|
-
# next batch of objects.
|
2084
|
+
# more objects are available, in the response, Amazon Web Services
|
2085
|
+
# provides a NextPageToken value that you can use in a subsequent call
|
2086
|
+
# to get the next batch of objects.
|
2050
2087
|
#
|
2051
2088
|
# @return [Types::GetReservationCoverageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2052
2089
|
#
|
@@ -2157,22 +2194,24 @@ module Aws::CostExplorer
|
|
2157
2194
|
# recommendations could help you reduce your costs. Reservations provide
|
2158
2195
|
# a discounted hourly rate (up to 75%) compared to On-Demand pricing.
|
2159
2196
|
#
|
2160
|
-
#
|
2161
|
-
# during a specific time period and collecting your
|
2162
|
-
# categories that are eligible for a reservation. After
|
2163
|
-
# categories, it simulates every
|
2164
|
-
#
|
2165
|
-
# purchase to maximize your estimated
|
2166
|
-
#
|
2167
|
-
#
|
2168
|
-
#
|
2169
|
-
#
|
2170
|
-
#
|
2171
|
-
#
|
2172
|
-
#
|
2173
|
-
#
|
2174
|
-
#
|
2175
|
-
#
|
2197
|
+
# Amazon Web Services generates your recommendations by identifying your
|
2198
|
+
# On-Demand usage during a specific time period and collecting your
|
2199
|
+
# usage into categories that are eligible for a reservation. After
|
2200
|
+
# Amazon Web Services has these categories, it simulates every
|
2201
|
+
# combination of reservations in each category of usage to identify the
|
2202
|
+
# best number of each type of RI to purchase to maximize your estimated
|
2203
|
+
# savings.
|
2204
|
+
#
|
2205
|
+
# For example, Amazon Web Services automatically aggregates your Amazon
|
2206
|
+
# EC2 Linux, shared tenancy, and c4 family usage in the US West (Oregon)
|
2207
|
+
# Region and recommends that you buy size-flexible regional reservations
|
2208
|
+
# to apply to the c4 family usage. Amazon Web Services recommends the
|
2209
|
+
# smallest size instance in an instance family. This makes it easier to
|
2210
|
+
# purchase a size-flexible RI. Amazon Web Services also shows the equal
|
2211
|
+
# number of normalized units so that you can purchase any instance size
|
2212
|
+
# that you want. For this example, your RI recommendation would be for
|
2213
|
+
# `c4.large` because that is the smallest size instance in the c4
|
2214
|
+
# instance family.
|
2176
2215
|
#
|
2177
2216
|
# @option params [String] :account_id
|
2178
2217
|
# The account ID that is associated with the recommendation.
|
@@ -2189,7 +2228,7 @@ module Aws::CostExplorer
|
|
2189
2228
|
# for `REGION==us-east-1 OR REGION==us-west-1`. For
|
2190
2229
|
# `GetRightsizingRecommendation`, the Region is a full name (for
|
2191
2230
|
# example, `REGION==US East (N. Virginia)`. The `Expression` example
|
2192
|
-
#
|
2231
|
+
# is as follows:
|
2193
2232
|
#
|
2194
2233
|
# `\{ "Dimensions": \{ "Key": "REGION", "Values": [ "us-east-1",
|
2195
2234
|
# “us-west-1” ] \} \}`
|
@@ -2201,11 +2240,11 @@ module Aws::CostExplorer
|
|
2201
2240
|
#
|
2202
2241
|
# * Compound dimension values with logical operations - You can use
|
2203
2242
|
# multiple `Expression` types and the logical operators `AND/OR/NOT`
|
2204
|
-
# to create a list of one or more `Expression` objects.
|
2205
|
-
# you
|
2243
|
+
# to create a list of one or more `Expression` objects. By doing this,
|
2244
|
+
# you can filter on more advanced options. For example, you can filter
|
2206
2245
|
# on `((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type ==
|
2207
2246
|
# Type1)) AND (USAGE_TYPE != DataTransfer)`. The `Expression` for that
|
2208
|
-
#
|
2247
|
+
# is as follows:
|
2209
2248
|
#
|
2210
2249
|
# `\{ "And": [ \{"Or": [ \{"Dimensions": \{ "Key": "REGION", "Values":
|
2211
2250
|
# [ "us-east-1", "us-west-1" ] \}\}, \{"Tags": \{ "Key": "TagName",
|
@@ -2222,13 +2261,13 @@ module Aws::CostExplorer
|
|
2222
2261
|
# "USAGE_TYPE", "Values": [ "DataTransfer" ] \} \} `
|
2223
2262
|
#
|
2224
2263
|
# <note markdown="1"> For the `GetRightsizingRecommendation` action, a combination of OR and
|
2225
|
-
# NOT
|
2264
|
+
# NOT isn't supported. OR isn't supported between different
|
2226
2265
|
# dimensions, or dimensions and tags. NOT operators aren't supported.
|
2227
2266
|
# Dimensions are also limited to `LINKED_ACCOUNT`, `REGION`, or
|
2228
2267
|
# `RIGHTSIZING_TYPE`.
|
2229
2268
|
#
|
2230
2269
|
# For the `GetReservationPurchaseRecommendation` action, only NOT is
|
2231
|
-
# supported. AND and OR
|
2270
|
+
# supported. AND and OR aren't supported. Dimensions are limited to
|
2232
2271
|
# `LINKED_ACCOUNT`.
|
2233
2272
|
#
|
2234
2273
|
# </note>
|
@@ -2241,8 +2280,8 @@ module Aws::CostExplorer
|
|
2241
2280
|
# accounts only.
|
2242
2281
|
#
|
2243
2282
|
# @option params [String] :lookback_period_in_days
|
2244
|
-
# The number of previous days that you want
|
2245
|
-
# calculates your recommendations.
|
2283
|
+
# The number of previous days that you want Amazon Web Services to
|
2284
|
+
# consider when it calculates your recommendations.
|
2246
2285
|
#
|
2247
2286
|
# @option params [String] :term_in_years
|
2248
2287
|
# The reservation term that you want recommendations for.
|
@@ -2495,15 +2534,15 @@ module Aws::CostExplorer
|
|
2495
2534
|
# Supported values for `SortOrder` are `ASCENDING` or `DESCENDING`.
|
2496
2535
|
#
|
2497
2536
|
# @option params [String] :next_page_token
|
2498
|
-
# The token to retrieve the next set of results.
|
2499
|
-
# when the response from a previous call has more
|
2500
|
-
# maximum page size.
|
2537
|
+
# The token to retrieve the next set of results. Amazon Web Services
|
2538
|
+
# provides the token when the response from a previous call has more
|
2539
|
+
# results than the maximum page size.
|
2501
2540
|
#
|
2502
2541
|
# @option params [Integer] :max_results
|
2503
2542
|
# The maximum number of objects that you returned for this request. If
|
2504
|
-
# more objects are available, in the response,
|
2505
|
-
# NextPageToken value that you can use in a subsequent call
|
2506
|
-
# next batch of objects.
|
2543
|
+
# more objects are available, in the response, Amazon Web Services
|
2544
|
+
# provides a NextPageToken value that you can use in a subsequent call
|
2545
|
+
# to get the next batch of objects.
|
2507
2546
|
#
|
2508
2547
|
# @return [Types::GetReservationUtilizationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2509
2548
|
#
|
@@ -2641,8 +2680,8 @@ module Aws::CostExplorer
|
|
2641
2680
|
# Recommendations are generated to either downsize or terminate
|
2642
2681
|
# instances, along with providing savings detail and metrics. For
|
2643
2682
|
# details on calculation and function, see [Optimizing Your Cost with
|
2644
|
-
# Rightsizing Recommendations][1] in the *
|
2645
|
-
#
|
2683
|
+
# Rightsizing Recommendations][1] in the *Billing and Cost Management
|
2684
|
+
# User Guide*.
|
2646
2685
|
#
|
2647
2686
|
#
|
2648
2687
|
#
|
@@ -2657,7 +2696,7 @@ module Aws::CostExplorer
|
|
2657
2696
|
# for `REGION==us-east-1 OR REGION==us-west-1`. For
|
2658
2697
|
# `GetRightsizingRecommendation`, the Region is a full name (for
|
2659
2698
|
# example, `REGION==US East (N. Virginia)`. The `Expression` example
|
2660
|
-
#
|
2699
|
+
# is as follows:
|
2661
2700
|
#
|
2662
2701
|
# `\{ "Dimensions": \{ "Key": "REGION", "Values": [ "us-east-1",
|
2663
2702
|
# “us-west-1” ] \} \}`
|
@@ -2669,11 +2708,11 @@ module Aws::CostExplorer
|
|
2669
2708
|
#
|
2670
2709
|
# * Compound dimension values with logical operations - You can use
|
2671
2710
|
# multiple `Expression` types and the logical operators `AND/OR/NOT`
|
2672
|
-
# to create a list of one or more `Expression` objects.
|
2673
|
-
# you
|
2711
|
+
# to create a list of one or more `Expression` objects. By doing this,
|
2712
|
+
# you can filter on more advanced options. For example, you can filter
|
2674
2713
|
# on `((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type ==
|
2675
2714
|
# Type1)) AND (USAGE_TYPE != DataTransfer)`. The `Expression` for that
|
2676
|
-
#
|
2715
|
+
# is as follows:
|
2677
2716
|
#
|
2678
2717
|
# `\{ "And": [ \{"Or": [ \{"Dimensions": \{ "Key": "REGION", "Values":
|
2679
2718
|
# [ "us-east-1", "us-west-1" ] \}\}, \{"Tags": \{ "Key": "TagName",
|
@@ -2690,13 +2729,13 @@ module Aws::CostExplorer
|
|
2690
2729
|
# "USAGE_TYPE", "Values": [ "DataTransfer" ] \} \} `
|
2691
2730
|
#
|
2692
2731
|
# <note markdown="1"> For the `GetRightsizingRecommendation` action, a combination of OR and
|
2693
|
-
# NOT
|
2732
|
+
# NOT isn't supported. OR isn't supported between different
|
2694
2733
|
# dimensions, or dimensions and tags. NOT operators aren't supported.
|
2695
2734
|
# Dimensions are also limited to `LINKED_ACCOUNT`, `REGION`, or
|
2696
2735
|
# `RIGHTSIZING_TYPE`.
|
2697
2736
|
#
|
2698
2737
|
# For the `GetReservationPurchaseRecommendation` action, only NOT is
|
2699
|
-
# supported. AND and OR
|
2738
|
+
# supported. AND and OR aren't supported. Dimensions are limited to
|
2700
2739
|
# `LINKED_ACCOUNT`.
|
2701
2740
|
#
|
2702
2741
|
# </note>
|
@@ -3527,7 +3566,7 @@ module Aws::CostExplorer
|
|
3527
3566
|
# for `REGION==us-east-1 OR REGION==us-west-1`. For
|
3528
3567
|
# `GetRightsizingRecommendation`, the Region is a full name (for
|
3529
3568
|
# example, `REGION==US East (N. Virginia)`. The `Expression` example
|
3530
|
-
#
|
3569
|
+
# is as follows:
|
3531
3570
|
#
|
3532
3571
|
# `\{ "Dimensions": \{ "Key": "REGION", "Values": [ "us-east-1",
|
3533
3572
|
# “us-west-1” ] \} \}`
|
@@ -3539,11 +3578,11 @@ module Aws::CostExplorer
|
|
3539
3578
|
#
|
3540
3579
|
# * Compound dimension values with logical operations - You can use
|
3541
3580
|
# multiple `Expression` types and the logical operators `AND/OR/NOT`
|
3542
|
-
# to create a list of one or more `Expression` objects.
|
3543
|
-
# you
|
3581
|
+
# to create a list of one or more `Expression` objects. By doing this,
|
3582
|
+
# you can filter on more advanced options. For example, you can filter
|
3544
3583
|
# on `((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type ==
|
3545
3584
|
# Type1)) AND (USAGE_TYPE != DataTransfer)`. The `Expression` for that
|
3546
|
-
#
|
3585
|
+
# is as follows:
|
3547
3586
|
#
|
3548
3587
|
# `\{ "And": [ \{"Or": [ \{"Dimensions": \{ "Key": "REGION", "Values":
|
3549
3588
|
# [ "us-east-1", "us-west-1" ] \}\}, \{"Tags": \{ "Key": "TagName",
|
@@ -3560,13 +3599,13 @@ module Aws::CostExplorer
|
|
3560
3599
|
# "USAGE_TYPE", "Values": [ "DataTransfer" ] \} \} `
|
3561
3600
|
#
|
3562
3601
|
# <note markdown="1"> For the `GetRightsizingRecommendation` action, a combination of OR and
|
3563
|
-
# NOT
|
3602
|
+
# NOT isn't supported. OR isn't supported between different
|
3564
3603
|
# dimensions, or dimensions and tags. NOT operators aren't supported.
|
3565
3604
|
# Dimensions are also limited to `LINKED_ACCOUNT`, `REGION`, or
|
3566
3605
|
# `RIGHTSIZING_TYPE`.
|
3567
3606
|
#
|
3568
3607
|
# For the `GetReservationPurchaseRecommendation` action, only NOT is
|
3569
|
-
# supported. AND and OR
|
3608
|
+
# supported. AND and OR aren't supported. Dimensions are limited to
|
3570
3609
|
# `LINKED_ACCOUNT`.
|
3571
3610
|
#
|
3572
3611
|
# </note>
|
@@ -3605,9 +3644,9 @@ module Aws::CostExplorer
|
|
3605
3644
|
# For `GetTags`, MaxResults has an upper limit of 1000.
|
3606
3645
|
#
|
3607
3646
|
# @option params [String] :next_page_token
|
3608
|
-
# The token to retrieve the next set of results.
|
3609
|
-
# when the response from a previous call has more
|
3610
|
-
# maximum page size.
|
3647
|
+
# The token to retrieve the next set of results. Amazon Web Services
|
3648
|
+
# provides the token when the response from a previous call has more
|
3649
|
+
# results than the maximum page size.
|
3611
3650
|
#
|
3612
3651
|
# @return [Types::GetTagsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3613
3652
|
#
|
@@ -3930,7 +3969,7 @@ module Aws::CostExplorer
|
|
3930
3969
|
end
|
3931
3970
|
|
3932
3971
|
# Updates an existing cost anomaly monitor. The changes made are applied
|
3933
|
-
# going forward, and
|
3972
|
+
# going forward, and doesn'tt change anomalies detected in the past.
|
3934
3973
|
#
|
3935
3974
|
# @option params [required, String] :monitor_arn
|
3936
3975
|
# Cost anomaly monitor Amazon Resource Names (ARNs).
|
@@ -3971,7 +4010,7 @@ module Aws::CostExplorer
|
|
3971
4010
|
# The update to the threshold value for receiving notifications.
|
3972
4011
|
#
|
3973
4012
|
# @option params [String] :frequency
|
3974
|
-
# The update to the frequency value
|
4013
|
+
# The update to the frequency value that subscribers receive
|
3975
4014
|
# notifications.
|
3976
4015
|
#
|
3977
4016
|
# @option params [Array<String>] :monitor_arn_list
|
@@ -3981,7 +4020,7 @@ module Aws::CostExplorer
|
|
3981
4020
|
# The update to the subscriber list.
|
3982
4021
|
#
|
3983
4022
|
# @option params [String] :subscription_name
|
3984
|
-
# The
|
4023
|
+
# The new name of the subscription.
|
3985
4024
|
#
|
3986
4025
|
# @return [Types::UpdateAnomalySubscriptionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3987
4026
|
#
|
@@ -4039,6 +4078,10 @@ module Aws::CostExplorer
|
|
4039
4078
|
# @option params [String] :default_value
|
4040
4079
|
# The default value for the cost category.
|
4041
4080
|
#
|
4081
|
+
# @option params [Array<Types::CostCategorySplitChargeRule>] :split_charge_rules
|
4082
|
+
# The split charge rules used to allocate your charges between your Cost
|
4083
|
+
# Category values.
|
4084
|
+
#
|
4042
4085
|
# @return [Types::UpdateCostCategoryDefinitionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4043
4086
|
#
|
4044
4087
|
# * {Types::UpdateCostCategoryDefinitionResponse#cost_category_arn #cost_category_arn} => String
|
@@ -4090,6 +4133,19 @@ module Aws::CostExplorer
|
|
4090
4133
|
# },
|
4091
4134
|
# ],
|
4092
4135
|
# default_value: "CostCategoryValue",
|
4136
|
+
# split_charge_rules: [
|
4137
|
+
# {
|
4138
|
+
# source: "GenericString", # required
|
4139
|
+
# targets: ["GenericString"], # required
|
4140
|
+
# method: "FIXED", # required, accepts FIXED, PROPORTIONAL, EVEN
|
4141
|
+
# parameters: [
|
4142
|
+
# {
|
4143
|
+
# type: "ALLOCATION_PERCENTAGES", # required, accepts ALLOCATION_PERCENTAGES
|
4144
|
+
# values: ["GenericString"], # required
|
4145
|
+
# },
|
4146
|
+
# ],
|
4147
|
+
# },
|
4148
|
+
# ],
|
4093
4149
|
# })
|
4094
4150
|
#
|
4095
4151
|
# @example Response structure
|
@@ -4119,7 +4175,7 @@ module Aws::CostExplorer
|
|
4119
4175
|
params: params,
|
4120
4176
|
config: config)
|
4121
4177
|
context[:gem_name] = 'aws-sdk-costexplorer'
|
4122
|
-
context[:gem_version] = '1.
|
4178
|
+
context[:gem_version] = '1.68.0'
|
4123
4179
|
Seahorse::Client::Request.new(handlers, context)
|
4124
4180
|
end
|
4125
4181
|
|