aws-sdk-costexplorer 1.74.0 → 1.77.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +15 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-costexplorer/client.rb +484 -128
- data/lib/aws-sdk-costexplorer/client_api.rb +155 -0
- data/lib/aws-sdk-costexplorer/errors.rb +26 -0
- data/lib/aws-sdk-costexplorer/types.rb +694 -176
- data/lib/aws-sdk-costexplorer.rb +1 -1
- metadata +4 -4
|
@@ -27,6 +27,7 @@ require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
|
|
|
27
27
|
require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
|
|
28
28
|
require 'aws-sdk-core/plugins/transfer_encoding.rb'
|
|
29
29
|
require 'aws-sdk-core/plugins/http_checksum.rb'
|
|
30
|
+
require 'aws-sdk-core/plugins/checksum_algorithm.rb'
|
|
30
31
|
require 'aws-sdk-core/plugins/defaults_mode.rb'
|
|
31
32
|
require 'aws-sdk-core/plugins/recursion_detection.rb'
|
|
32
33
|
require 'aws-sdk-core/plugins/signature_v4.rb'
|
|
@@ -75,6 +76,7 @@ module Aws::CostExplorer
|
|
|
75
76
|
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
|
76
77
|
add_plugin(Aws::Plugins::TransferEncoding)
|
|
77
78
|
add_plugin(Aws::Plugins::HttpChecksum)
|
|
79
|
+
add_plugin(Aws::Plugins::ChecksumAlgorithm)
|
|
78
80
|
add_plugin(Aws::Plugins::DefaultsMode)
|
|
79
81
|
add_plugin(Aws::Plugins::RecursionDetection)
|
|
80
82
|
add_plugin(Aws::Plugins::SignatureV4)
|
|
@@ -365,6 +367,36 @@ module Aws::CostExplorer
|
|
|
365
367
|
# @option params [required, Types::AnomalyMonitor] :anomaly_monitor
|
|
366
368
|
# The cost anomaly detection monitor object that you want to create.
|
|
367
369
|
#
|
|
370
|
+
# @option params [Array<Types::ResourceTag>] :resource_tags
|
|
371
|
+
# An optional list of tags to associate with the specified [
|
|
372
|
+
# `AnomalyMonitor` ][1]. You can use resource tags to control access to
|
|
373
|
+
# your `monitor` using IAM policies.
|
|
374
|
+
#
|
|
375
|
+
# Each tag consists of a key and a value, and each key must be unique
|
|
376
|
+
# for the resource. The following restrictions apply to resource tags:
|
|
377
|
+
#
|
|
378
|
+
# * Although the maximum number of array members is 200, you can assign
|
|
379
|
+
# a maximum of 50 user-tags to one resource. The remaining are
|
|
380
|
+
# reserved for Amazon Web Services use
|
|
381
|
+
#
|
|
382
|
+
# * The maximum length of a key is 128 characters
|
|
383
|
+
#
|
|
384
|
+
# * The maximum length of a value is 256 characters
|
|
385
|
+
#
|
|
386
|
+
# * Keys and values can only contain alphanumeric characters, spaces,
|
|
387
|
+
# and any of the following: `_.:/=+@-`
|
|
388
|
+
#
|
|
389
|
+
# * Keys and values are case sensitive
|
|
390
|
+
#
|
|
391
|
+
# * Keys and values are trimmed for any leading or trailing whitespaces
|
|
392
|
+
#
|
|
393
|
+
# * Don’t use `aws:` as a prefix for your keys. This prefix is reserved
|
|
394
|
+
# for Amazon Web Services use
|
|
395
|
+
#
|
|
396
|
+
#
|
|
397
|
+
#
|
|
398
|
+
# [1]: https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_AnomalyMonitor.html
|
|
399
|
+
#
|
|
368
400
|
# @return [Types::CreateAnomalyMonitorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
369
401
|
#
|
|
370
402
|
# * {Types::CreateAnomalyMonitorResponse#monitor_arn #monitor_arn} => String
|
|
@@ -412,6 +444,12 @@ module Aws::CostExplorer
|
|
|
412
444
|
# },
|
|
413
445
|
# dimensional_value_count: 1,
|
|
414
446
|
# },
|
|
447
|
+
# resource_tags: [
|
|
448
|
+
# {
|
|
449
|
+
# key: "ResourceTagKey", # required
|
|
450
|
+
# value: "ResourceTagValue", # required
|
|
451
|
+
# },
|
|
452
|
+
# ],
|
|
415
453
|
# })
|
|
416
454
|
#
|
|
417
455
|
# @example Response structure
|
|
@@ -435,6 +473,36 @@ module Aws::CostExplorer
|
|
|
435
473
|
# @option params [required, Types::AnomalySubscription] :anomaly_subscription
|
|
436
474
|
# The cost anomaly subscription object that you want to create.
|
|
437
475
|
#
|
|
476
|
+
# @option params [Array<Types::ResourceTag>] :resource_tags
|
|
477
|
+
# An optional list of tags to associate with the specified [
|
|
478
|
+
# `AnomalySubscription` ][1]. You can use resource tags to control
|
|
479
|
+
# access to your `subscription` using IAM policies.
|
|
480
|
+
#
|
|
481
|
+
# Each tag consists of a key and a value, and each key must be unique
|
|
482
|
+
# for the resource. The following restrictions apply to resource tags:
|
|
483
|
+
#
|
|
484
|
+
# * Although the maximum number of array members is 200, you can assign
|
|
485
|
+
# a maximum of 50 user-tags to one resource. The remaining are
|
|
486
|
+
# reserved for Amazon Web Services use
|
|
487
|
+
#
|
|
488
|
+
# * The maximum length of a key is 128 characters
|
|
489
|
+
#
|
|
490
|
+
# * The maximum length of a value is 256 characters
|
|
491
|
+
#
|
|
492
|
+
# * Keys and values can only contain alphanumeric characters, spaces,
|
|
493
|
+
# and any of the following: `_.:/=+@-`
|
|
494
|
+
#
|
|
495
|
+
# * Keys and values are case sensitive
|
|
496
|
+
#
|
|
497
|
+
# * Keys and values are trimmed for any leading or trailing whitespaces
|
|
498
|
+
#
|
|
499
|
+
# * Don’t use `aws:` as a prefix for your keys. This prefix is reserved
|
|
500
|
+
# for Amazon Web Services use
|
|
501
|
+
#
|
|
502
|
+
#
|
|
503
|
+
#
|
|
504
|
+
# [1]: https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_AnomalySubscription.html
|
|
505
|
+
#
|
|
438
506
|
# @return [Types::CreateAnomalySubscriptionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
439
507
|
#
|
|
440
508
|
# * {Types::CreateAnomalySubscriptionResponse#subscription_arn #subscription_arn} => String
|
|
@@ -457,6 +525,12 @@ module Aws::CostExplorer
|
|
|
457
525
|
# frequency: "DAILY", # required, accepts DAILY, IMMEDIATE, WEEKLY
|
|
458
526
|
# subscription_name: "GenericString", # required
|
|
459
527
|
# },
|
|
528
|
+
# resource_tags: [
|
|
529
|
+
# {
|
|
530
|
+
# key: "ResourceTagKey", # required
|
|
531
|
+
# value: "ResourceTagValue", # required
|
|
532
|
+
# },
|
|
533
|
+
# ],
|
|
460
534
|
# })
|
|
461
535
|
#
|
|
462
536
|
# @example Response structure
|
|
@@ -495,6 +569,36 @@ module Aws::CostExplorer
|
|
|
495
569
|
# The split charge rules used to allocate your charges between your Cost
|
|
496
570
|
# Category values.
|
|
497
571
|
#
|
|
572
|
+
# @option params [Array<Types::ResourceTag>] :resource_tags
|
|
573
|
+
# An optional list of tags to associate with the specified [
|
|
574
|
+
# `CostCategory` ][1]. You can use resource tags to control access to
|
|
575
|
+
# your `cost category` using IAM policies.
|
|
576
|
+
#
|
|
577
|
+
# Each tag consists of a key and a value, and each key must be unique
|
|
578
|
+
# for the resource. The following restrictions apply to resource tags:
|
|
579
|
+
#
|
|
580
|
+
# * Although the maximum number of array members is 200, you can assign
|
|
581
|
+
# a maximum of 50 user-tags to one resource. The remaining are
|
|
582
|
+
# reserved for Amazon Web Services use
|
|
583
|
+
#
|
|
584
|
+
# * The maximum length of a key is 128 characters
|
|
585
|
+
#
|
|
586
|
+
# * The maximum length of a value is 256 characters
|
|
587
|
+
#
|
|
588
|
+
# * Keys and values can only contain alphanumeric characters, spaces,
|
|
589
|
+
# and any of the following: `_.:/=+@-`
|
|
590
|
+
#
|
|
591
|
+
# * Keys and values are case sensitive
|
|
592
|
+
#
|
|
593
|
+
# * Keys and values are trimmed for any leading or trailing whitespaces
|
|
594
|
+
#
|
|
595
|
+
# * Don’t use `aws:` as a prefix for your keys. This prefix is reserved
|
|
596
|
+
# for Amazon Web Services use
|
|
597
|
+
#
|
|
598
|
+
#
|
|
599
|
+
#
|
|
600
|
+
# [1]: https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_CostCategory.html
|
|
601
|
+
#
|
|
498
602
|
# @return [Types::CreateCostCategoryDefinitionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
499
603
|
#
|
|
500
604
|
# * {Types::CreateCostCategoryDefinitionResponse#cost_category_arn #cost_category_arn} => String
|
|
@@ -559,6 +663,12 @@ module Aws::CostExplorer
|
|
|
559
663
|
# ],
|
|
560
664
|
# },
|
|
561
665
|
# ],
|
|
666
|
+
# resource_tags: [
|
|
667
|
+
# {
|
|
668
|
+
# key: "ResourceTagKey", # required
|
|
669
|
+
# value: "ResourceTagValue", # required
|
|
670
|
+
# },
|
|
671
|
+
# ],
|
|
562
672
|
# })
|
|
563
673
|
#
|
|
564
674
|
# @example Response structure
|
|
@@ -652,12 +762,12 @@ module Aws::CostExplorer
|
|
|
652
762
|
req.send_request(options)
|
|
653
763
|
end
|
|
654
764
|
|
|
655
|
-
# Returns the name, ARN, rules, definition, and
|
|
656
|
-
# Cost Category that's defined in the account.
|
|
765
|
+
# Returns the name, Amazon Resource Name (ARN), rules, definition, and
|
|
766
|
+
# effective dates of a Cost Category that's defined in the account.
|
|
657
767
|
#
|
|
658
768
|
# You have the option to use `EffectiveOn` to return a Cost Category
|
|
659
|
-
# that
|
|
660
|
-
# specified, you
|
|
769
|
+
# that's active on a specific date. If there's no `EffectiveOn`
|
|
770
|
+
# specified, you see a Cost Category that's effective on the current
|
|
661
771
|
# date. If Cost Category is still effective, `EffectiveEnd` is omitted
|
|
662
772
|
# in the response.
|
|
663
773
|
#
|
|
@@ -976,11 +1086,12 @@ module Aws::CostExplorer
|
|
|
976
1086
|
# You can nest `Expression` objects to define any combination of
|
|
977
1087
|
# dimension filters. For more information, see [Expression][1].
|
|
978
1088
|
#
|
|
979
|
-
# Valid values for `MatchOptions` for `
|
|
980
|
-
# `
|
|
1089
|
+
# Valid values for `MatchOptions` for `Dimensions` are `EQUALS` and
|
|
1090
|
+
# `CASE_SENSITIVE`.
|
|
981
1091
|
#
|
|
982
|
-
#
|
|
983
|
-
# `
|
|
1092
|
+
# Valid values for `MatchOptions` for `CostCategories` and `Tags` are
|
|
1093
|
+
# `EQUALS`, `ABSENT`, and `CASE_SENSITIVE`. Default values are `EQUALS`
|
|
1094
|
+
# and `CASE_SENSITIVE`.
|
|
984
1095
|
#
|
|
985
1096
|
#
|
|
986
1097
|
#
|
|
@@ -1128,7 +1239,7 @@ module Aws::CostExplorer
|
|
|
1128
1239
|
# Elastic Compute Cloud – Compute service only.
|
|
1129
1240
|
#
|
|
1130
1241
|
# <note markdown="1"> This is an opt-in only feature. You can enable this feature from the
|
|
1131
|
-
# Cost Explorer Settings page. For information
|
|
1242
|
+
# Cost Explorer Settings page. For information about how to access the
|
|
1132
1243
|
# Settings page, see [Controlling Access for Cost Explorer][2] in the
|
|
1133
1244
|
# *Billing and Cost Management User Guide*.
|
|
1134
1245
|
#
|
|
@@ -1164,11 +1275,12 @@ module Aws::CostExplorer
|
|
|
1164
1275
|
# group by or filter by a `ResourceId`. It requires the [Expression][1]
|
|
1165
1276
|
# `"SERVICE = Amazon Elastic Compute Cloud - Compute"` in the filter.
|
|
1166
1277
|
#
|
|
1167
|
-
# Valid values for `MatchOptions` for `
|
|
1168
|
-
# `
|
|
1278
|
+
# Valid values for `MatchOptions` for `Dimensions` are `EQUALS` and
|
|
1279
|
+
# `CASE_SENSITIVE`.
|
|
1169
1280
|
#
|
|
1170
|
-
#
|
|
1171
|
-
# `
|
|
1281
|
+
# Valid values for `MatchOptions` for `CostCategories` and `Tags` are
|
|
1282
|
+
# `EQUALS`, `ABSENT`, and `CASE_SENSITIVE`. Default values are `EQUALS`
|
|
1283
|
+
# and `CASE_SENSITIVE`.
|
|
1172
1284
|
#
|
|
1173
1285
|
#
|
|
1174
1286
|
#
|
|
@@ -1187,8 +1299,8 @@ module Aws::CostExplorer
|
|
|
1187
1299
|
# usage numbers without taking the units into account. For example, if
|
|
1188
1300
|
# you aggregate `usageQuantity` across all of Amazon EC2, the results
|
|
1189
1301
|
# aren't meaningful because Amazon EC2 compute hours and data transfer
|
|
1190
|
-
# are measured in different units (for example,
|
|
1191
|
-
#
|
|
1302
|
+
# are measured in different units (for example, hour or GB). To get more
|
|
1303
|
+
# meaningful `UsageQuantity` metrics, filter by `UsageType` or
|
|
1192
1304
|
# `UsageTypeGroups`.
|
|
1193
1305
|
#
|
|
1194
1306
|
# </note>
|
|
@@ -1306,11 +1418,10 @@ module Aws::CostExplorer
|
|
|
1306
1418
|
# @option params [String] :search_string
|
|
1307
1419
|
# The value that you want to search the filter values for.
|
|
1308
1420
|
#
|
|
1309
|
-
# If you
|
|
1310
|
-
#
|
|
1311
|
-
#
|
|
1312
|
-
#
|
|
1313
|
-
# pattern.
|
|
1421
|
+
# If you don't specify a `CostCategoryName`, `SearchString` is used to
|
|
1422
|
+
# filter Cost Category names that match the `SearchString` pattern. If
|
|
1423
|
+
# you specify a `CostCategoryName`, `SearchString` is used to filter
|
|
1424
|
+
# Cost Category values that match the `SearchString` pattern.
|
|
1314
1425
|
#
|
|
1315
1426
|
# @option params [required, Types::DateInterval] :time_period
|
|
1316
1427
|
# The time period of the request.
|
|
@@ -1372,10 +1483,10 @@ module Aws::CostExplorer
|
|
|
1372
1483
|
# </note>
|
|
1373
1484
|
#
|
|
1374
1485
|
# @option params [Array<Types::SortDefinition>] :sort_by
|
|
1375
|
-
# The value
|
|
1486
|
+
# The value that you sort the data by.
|
|
1376
1487
|
#
|
|
1377
|
-
# The key represents cost and usage metrics. The following values
|
|
1378
|
-
# supported:
|
|
1488
|
+
# The key represents the cost and usage metrics. The following values
|
|
1489
|
+
# are supported:
|
|
1379
1490
|
#
|
|
1380
1491
|
# * `BlendedCost`
|
|
1381
1492
|
#
|
|
@@ -1391,25 +1502,27 @@ module Aws::CostExplorer
|
|
|
1391
1502
|
#
|
|
1392
1503
|
# * `NormalizedUsageAmount`
|
|
1393
1504
|
#
|
|
1394
|
-
#
|
|
1505
|
+
# The supported key values for the `SortOrder` value are `ASCENDING` and
|
|
1506
|
+
# `DESCENDING`.
|
|
1395
1507
|
#
|
|
1396
|
-
# When
|
|
1397
|
-
# supported.
|
|
1508
|
+
# When you use the `SortBy` value, the `NextPageToken` and
|
|
1509
|
+
# `SearchString` key values aren't supported.
|
|
1398
1510
|
#
|
|
1399
1511
|
# @option params [Integer] :max_results
|
|
1400
|
-
# This field is only used when `SortBy` is provided in the
|
|
1512
|
+
# This field is only used when the `SortBy` value is provided in the
|
|
1513
|
+
# request.
|
|
1401
1514
|
#
|
|
1402
|
-
# The maximum number of objects that
|
|
1403
|
-
# `MaxResults`
|
|
1404
|
-
# 1000 results as the default value for this parameter.
|
|
1515
|
+
# The maximum number of objects that are returned for this request. If
|
|
1516
|
+
# `MaxResults` isn't specified with the `SortBy` value, the request
|
|
1517
|
+
# returns 1000 results as the default value for this parameter.
|
|
1405
1518
|
#
|
|
1406
|
-
# For `GetCostCategories`, MaxResults has an upper
|
|
1519
|
+
# For `GetCostCategories`, MaxResults has an upper quota of 1000.
|
|
1407
1520
|
#
|
|
1408
1521
|
# @option params [String] :next_page_token
|
|
1409
1522
|
# If the number of objects that are still available for retrieval
|
|
1410
|
-
# exceeds the
|
|
1523
|
+
# exceeds the quota, Amazon Web Services returns a NextPageToken value
|
|
1411
1524
|
# in the response. To retrieve the next batch of objects, provide the
|
|
1412
|
-
# NextPageToken from the
|
|
1525
|
+
# NextPageToken from the previous call in your next request.
|
|
1413
1526
|
#
|
|
1414
1527
|
# @return [Types::GetCostCategoriesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1415
1528
|
#
|
|
@@ -1685,15 +1798,14 @@ module Aws::CostExplorer
|
|
|
1685
1798
|
# is with. Possible values are the following:
|
|
1686
1799
|
#
|
|
1687
1800
|
# \- Amazon Web Services(Amazon Web Services): The entity that sells
|
|
1688
|
-
# Amazon Web Services
|
|
1801
|
+
# Amazon Web Services.
|
|
1689
1802
|
#
|
|
1690
1803
|
# \- AISPL (Amazon Internet Services Pvt. Ltd.): The local Indian
|
|
1691
|
-
# entity that
|
|
1692
|
-
# in India.
|
|
1804
|
+
# entity that's an acting reseller for Amazon Web Services in India.
|
|
1693
1805
|
#
|
|
1694
1806
|
# \- Amazon Web Services Marketplace: The entity that supports the sale
|
|
1695
|
-
# of solutions built on Amazon Web Services by third-party
|
|
1696
|
-
# providers.
|
|
1807
|
+
# of solutions that are built on Amazon Web Services by third-party
|
|
1808
|
+
# software providers.
|
|
1697
1809
|
#
|
|
1698
1810
|
# * CACHE\_ENGINE - The Amazon ElastiCache operating system. Examples
|
|
1699
1811
|
# are Windows or Linux.
|
|
@@ -1708,12 +1820,12 @@ module Aws::CostExplorer
|
|
|
1708
1820
|
# `m4.xlarge`.
|
|
1709
1821
|
#
|
|
1710
1822
|
# * INSTANCE\_TYPE\_FAMILY - A family of instance types optimized to fit
|
|
1711
|
-
# different use cases. Examples are `Compute Optimized` (
|
|
1712
|
-
# `C6g`, `C7g`
|
|
1713
|
-
#
|
|
1823
|
+
# different use cases. Examples are `Compute Optimized` (for example,
|
|
1824
|
+
# `C4`, `C5`, `C6g`, and `C7g`), `Memory Optimization` (for example,
|
|
1825
|
+
# `R4`, `R5n`, `R5b`, and `R6g`).
|
|
1714
1826
|
#
|
|
1715
|
-
# * INVOICING\_ENTITY - The name of the entity
|
|
1716
|
-
# Services invoice.
|
|
1827
|
+
# * INVOICING\_ENTITY - The name of the entity that issues the Amazon
|
|
1828
|
+
# Web Services invoice.
|
|
1717
1829
|
#
|
|
1718
1830
|
# * LEGAL\_ENTITY\_NAME - The name of the organization that sells you
|
|
1719
1831
|
# Amazon Web Services services, such as Amazon Web Services.
|
|
@@ -1731,9 +1843,9 @@ module Aws::CostExplorer
|
|
|
1731
1843
|
# * PLATFORM - The Amazon EC2 operating system. Examples are Windows or
|
|
1732
1844
|
# Linux.
|
|
1733
1845
|
#
|
|
1734
|
-
# * PURCHASE\_TYPE - The reservation type of the purchase
|
|
1735
|
-
# usage is related. Examples include On-Demand Instances and
|
|
1736
|
-
# Reserved Instances.
|
|
1846
|
+
# * PURCHASE\_TYPE - The reservation type of the purchase that this
|
|
1847
|
+
# usage is related to. Examples include On-Demand Instances and
|
|
1848
|
+
# Standard Reserved Instances.
|
|
1737
1849
|
#
|
|
1738
1850
|
# * RESERVATION\_ID - The unique identifier for an Amazon Web Services
|
|
1739
1851
|
# Reservation Instance.
|
|
@@ -1758,8 +1870,8 @@ module Aws::CostExplorer
|
|
|
1758
1870
|
#
|
|
1759
1871
|
# * REGION - The Amazon Web Services Region.
|
|
1760
1872
|
#
|
|
1761
|
-
# * RECORD\_TYPE - The different types of charges such as
|
|
1762
|
-
# costs, tax refunds, and credits.
|
|
1873
|
+
# * RECORD\_TYPE - The different types of charges such as Reserved
|
|
1874
|
+
# Instance (RI) fees, usage costs, tax refunds, and credits.
|
|
1763
1875
|
#
|
|
1764
1876
|
# * RESOURCE\_ID - The unique identifier of the resource. ResourceId is
|
|
1765
1877
|
# an opt-in feature only available for last 14 days for EC2-Compute
|
|
@@ -1803,8 +1915,8 @@ module Aws::CostExplorer
|
|
|
1803
1915
|
# * SAVINGS\_PLANS\_TYPE - Type of Savings Plans (EC2 Instance or
|
|
1804
1916
|
# Compute)
|
|
1805
1917
|
#
|
|
1806
|
-
# * PAYMENT\_OPTION -
|
|
1807
|
-
# example, All Upfront)
|
|
1918
|
+
# * PAYMENT\_OPTION - The payment option for the given Savings Plans
|
|
1919
|
+
# (for example, All Upfront)
|
|
1808
1920
|
#
|
|
1809
1921
|
# * REGION - The Amazon Web Services Region.
|
|
1810
1922
|
#
|
|
@@ -1870,7 +1982,7 @@ module Aws::CostExplorer
|
|
|
1870
1982
|
# </note>
|
|
1871
1983
|
#
|
|
1872
1984
|
# @option params [Array<Types::SortDefinition>] :sort_by
|
|
1873
|
-
# The value
|
|
1985
|
+
# The value that you want to sort the data by.
|
|
1874
1986
|
#
|
|
1875
1987
|
# The key represents cost and usage metrics. The following values are
|
|
1876
1988
|
# supported:
|
|
@@ -1889,16 +2001,17 @@ module Aws::CostExplorer
|
|
|
1889
2001
|
#
|
|
1890
2002
|
# * `NormalizedUsageAmount`
|
|
1891
2003
|
#
|
|
1892
|
-
#
|
|
2004
|
+
# The supported values for the `SortOrder` key are `ASCENDING` or
|
|
2005
|
+
# `DESCENDING`.
|
|
1893
2006
|
#
|
|
1894
2007
|
# When you specify a `SortBy` paramater, the context must be
|
|
1895
2008
|
# `COST_AND_USAGE`. Further, when using `SortBy`, `NextPageToken` and
|
|
1896
|
-
# `SearchString`
|
|
2009
|
+
# `SearchString` aren't supported.
|
|
1897
2010
|
#
|
|
1898
2011
|
# @option params [Integer] :max_results
|
|
1899
2012
|
# This field is only used when SortBy is provided in the request. The
|
|
1900
|
-
# maximum number of objects that
|
|
1901
|
-
# MaxResults
|
|
2013
|
+
# maximum number of objects that are returned for this request. If
|
|
2014
|
+
# MaxResults isn't specified with SortBy, the request returns 1000
|
|
1902
2015
|
# results as the default value for this parameter.
|
|
1903
2016
|
#
|
|
1904
2017
|
# For `GetDimensionValues`, MaxResults has an upper limit of 1000.
|
|
@@ -1984,7 +2097,7 @@ module Aws::CostExplorer
|
|
|
1984
2097
|
req.send_request(options)
|
|
1985
2098
|
end
|
|
1986
2099
|
|
|
1987
|
-
# Retrieves the reservation coverage for your account
|
|
2100
|
+
# Retrieves the reservation coverage for your account, which you can use
|
|
1988
2101
|
# to see how much of your Amazon Elastic Compute Cloud, Amazon
|
|
1989
2102
|
# ElastiCache, Amazon Relational Database Service, or Amazon Redshift
|
|
1990
2103
|
# usage is covered by a reservation. An organization's management
|
|
@@ -2256,31 +2369,31 @@ module Aws::CostExplorer
|
|
|
2256
2369
|
req.send_request(options)
|
|
2257
2370
|
end
|
|
2258
2371
|
|
|
2259
|
-
# Gets recommendations for
|
|
2260
|
-
#
|
|
2261
|
-
#
|
|
2372
|
+
# Gets recommendations for reservation purchases. These recommendations
|
|
2373
|
+
# might help you to reduce your costs. Reservations provide a discounted
|
|
2374
|
+
# hourly rate (up to 75%) compared to On-Demand pricing.
|
|
2262
2375
|
#
|
|
2263
2376
|
# Amazon Web Services generates your recommendations by identifying your
|
|
2264
2377
|
# On-Demand usage during a specific time period and collecting your
|
|
2265
2378
|
# usage into categories that are eligible for a reservation. After
|
|
2266
2379
|
# Amazon Web Services has these categories, it simulates every
|
|
2267
2380
|
# combination of reservations in each category of usage to identify the
|
|
2268
|
-
# best number of each type of RI to purchase to
|
|
2269
|
-
# savings.
|
|
2381
|
+
# best number of each type of Reserved Instance (RI) to purchase to
|
|
2382
|
+
# maximize your estimated savings.
|
|
2270
2383
|
#
|
|
2271
2384
|
# For example, Amazon Web Services automatically aggregates your Amazon
|
|
2272
2385
|
# EC2 Linux, shared tenancy, and c4 family usage in the US West (Oregon)
|
|
2273
2386
|
# Region and recommends that you buy size-flexible regional reservations
|
|
2274
2387
|
# to apply to the c4 family usage. Amazon Web Services recommends the
|
|
2275
2388
|
# smallest size instance in an instance family. This makes it easier to
|
|
2276
|
-
# purchase a size-flexible RI. Amazon Web Services
|
|
2277
|
-
# number of normalized units
|
|
2278
|
-
# that you want. For this example, your RI
|
|
2279
|
-
# `c4.large` because that is the smallest size
|
|
2280
|
-
# instance family.
|
|
2389
|
+
# purchase a size-flexible Reserved Instance (RI). Amazon Web Services
|
|
2390
|
+
# also shows the equal number of normalized units. This way, you can
|
|
2391
|
+
# purchase any instance size that you want. For this example, your RI
|
|
2392
|
+
# recommendation is for `c4.large` because that is the smallest size
|
|
2393
|
+
# instance in the c4 instance family.
|
|
2281
2394
|
#
|
|
2282
2395
|
# @option params [String] :account_id
|
|
2283
|
-
# The account ID that
|
|
2396
|
+
# The account ID that's associated with the recommendation.
|
|
2284
2397
|
#
|
|
2285
2398
|
# @option params [required, String] :service
|
|
2286
2399
|
# The specific service that you want recommendations for.
|
|
@@ -2505,11 +2618,12 @@ module Aws::CostExplorer
|
|
|
2505
2618
|
# Currently, you can group only by `SUBSCRIPTION_ID`.
|
|
2506
2619
|
#
|
|
2507
2620
|
# @option params [required, Types::DateInterval] :time_period
|
|
2508
|
-
# Sets the start and end dates for retrieving
|
|
2509
|
-
# date is inclusive, but the end date is
|
|
2510
|
-
# `start` is `2017-01-01` and `end` is
|
|
2511
|
-
#
|
|
2512
|
-
# `2017-
|
|
2621
|
+
# Sets the start and end dates for retrieving Reserved Instance (RI)
|
|
2622
|
+
# utilization. The start date is inclusive, but the end date is
|
|
2623
|
+
# exclusive. For example, if `start` is `2017-01-01` and `end` is
|
|
2624
|
+
# `2017-05-01`, then the cost and usage data is retrieved from
|
|
2625
|
+
# `2017-01-01` up to and including `2017-04-30` but not including
|
|
2626
|
+
# `2017-05-01`.
|
|
2513
2627
|
#
|
|
2514
2628
|
# @option params [Array<Types::GroupDefinition>] :group_by
|
|
2515
2629
|
# Groups only by `SUBSCRIPTION_ID`. Metadata is included.
|
|
@@ -2559,7 +2673,7 @@ module Aws::CostExplorer
|
|
|
2559
2673
|
# [1]: https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Expression.html
|
|
2560
2674
|
#
|
|
2561
2675
|
# @option params [Types::SortDefinition] :sort_by
|
|
2562
|
-
# The value
|
|
2676
|
+
# The value that you want to sort the data by.
|
|
2563
2677
|
#
|
|
2564
2678
|
# The following values are supported for `Key`\:
|
|
2565
2679
|
#
|
|
@@ -2597,7 +2711,7 @@ module Aws::CostExplorer
|
|
|
2597
2711
|
#
|
|
2598
2712
|
# * `UnrealizedSavings`
|
|
2599
2713
|
#
|
|
2600
|
-
#
|
|
2714
|
+
# The supported values for `SortOrder` are `ASCENDING` and `DESCENDING`.
|
|
2601
2715
|
#
|
|
2602
2716
|
# @option params [String] :next_page_token
|
|
2603
2717
|
# The token to retrieve the next set of results. Amazon Web Services
|
|
@@ -2744,10 +2858,10 @@ module Aws::CostExplorer
|
|
|
2744
2858
|
# and underutilized Amazon EC2 instances.
|
|
2745
2859
|
#
|
|
2746
2860
|
# Recommendations are generated to either downsize or terminate
|
|
2747
|
-
# instances, along with providing savings detail and metrics. For
|
|
2748
|
-
#
|
|
2749
|
-
# Rightsizing Recommendations][1] in the *Billing and Cost
|
|
2750
|
-
# User Guide*.
|
|
2861
|
+
# instances, along with providing savings detail and metrics. For more
|
|
2862
|
+
# information about calculation and function, see [Optimizing Your Cost
|
|
2863
|
+
# with Rightsizing Recommendations][1] in the *Billing and Cost
|
|
2864
|
+
# Management User Guide*.
|
|
2751
2865
|
#
|
|
2752
2866
|
#
|
|
2753
2867
|
#
|
|
@@ -2807,12 +2921,12 @@ module Aws::CostExplorer
|
|
|
2807
2921
|
# </note>
|
|
2808
2922
|
#
|
|
2809
2923
|
# @option params [Types::RightsizingRecommendationConfiguration] :configuration
|
|
2810
|
-
#
|
|
2811
|
-
# can choose to view recommendations for instances
|
|
2812
|
-
# instance families or across different instance
|
|
2813
|
-
# choose to view your estimated savings
|
|
2814
|
-
# with consideration of existing Savings
|
|
2815
|
-
# neither.
|
|
2924
|
+
# You can use Configuration to customize recommendations across two
|
|
2925
|
+
# attributes. You can choose to view recommendations for instances
|
|
2926
|
+
# within the same instance families or across different instance
|
|
2927
|
+
# families. You can also choose to view your estimated savings that are
|
|
2928
|
+
# associated with recommendations with consideration of existing Savings
|
|
2929
|
+
# Plans or RI benefits, or neither.
|
|
2816
2930
|
#
|
|
2817
2931
|
# @option params [required, String] :service
|
|
2818
2932
|
# The specific service that you want recommendations for. The only valid
|
|
@@ -3046,7 +3160,7 @@ module Aws::CostExplorer
|
|
|
3046
3160
|
# with a minimum value of `1`.
|
|
3047
3161
|
#
|
|
3048
3162
|
# @option params [Types::SortDefinition] :sort_by
|
|
3049
|
-
# The value
|
|
3163
|
+
# The value that you want to sort the data by.
|
|
3050
3164
|
#
|
|
3051
3165
|
# The following values are supported for `Key`\:
|
|
3052
3166
|
#
|
|
@@ -3064,7 +3178,7 @@ module Aws::CostExplorer
|
|
|
3064
3178
|
#
|
|
3065
3179
|
# * `Service`
|
|
3066
3180
|
#
|
|
3067
|
-
#
|
|
3181
|
+
# The supported values for `SortOrder` are `ASCENDING` and `DESCENDING`.
|
|
3068
3182
|
#
|
|
3069
3183
|
# @return [Types::GetSavingsPlansCoverageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
3070
3184
|
#
|
|
@@ -3152,14 +3266,14 @@ module Aws::CostExplorer
|
|
|
3152
3266
|
# Summary and Details.
|
|
3153
3267
|
#
|
|
3154
3268
|
# @option params [required, String] :savings_plans_type
|
|
3155
|
-
# The Savings Plans recommendation type requested.
|
|
3269
|
+
# The Savings Plans recommendation type that's requested.
|
|
3156
3270
|
#
|
|
3157
3271
|
# @option params [required, String] :term_in_years
|
|
3158
|
-
# The savings plan recommendation term used to generate these
|
|
3272
|
+
# The savings plan recommendation term that's used to generate these
|
|
3159
3273
|
# recommendations.
|
|
3160
3274
|
#
|
|
3161
3275
|
# @option params [required, String] :payment_option
|
|
3162
|
-
# The payment option used to generate these recommendations.
|
|
3276
|
+
# The payment option that's used to generate these recommendations.
|
|
3163
3277
|
#
|
|
3164
3278
|
# @option params [String] :account_scope
|
|
3165
3279
|
# The account scope that you want your recommendations for. Amazon Web
|
|
@@ -3178,20 +3292,20 @@ module Aws::CostExplorer
|
|
|
3178
3292
|
# response object.
|
|
3179
3293
|
#
|
|
3180
3294
|
# @option params [required, String] :lookback_period_in_days
|
|
3181
|
-
# The lookback period used to generate the recommendation.
|
|
3295
|
+
# The lookback period that's used to generate the recommendation.
|
|
3182
3296
|
#
|
|
3183
3297
|
# @option params [Types::Expression] :filter
|
|
3184
3298
|
# You can filter your recommendations by Account ID with the
|
|
3185
3299
|
# `LINKED_ACCOUNT` dimension. To filter your recommendations by Account
|
|
3186
3300
|
# ID, specify `Key` as `LINKED_ACCOUNT` and `Value` as the
|
|
3187
|
-
# comma-separated Acount ID(s)
|
|
3188
|
-
# purchase recommendations.
|
|
3301
|
+
# comma-separated Acount ID(s) that you want to see Savings Plans
|
|
3302
|
+
# purchase recommendations for.
|
|
3189
3303
|
#
|
|
3190
|
-
# For GetSavingsPlansPurchaseRecommendation, the `Filter`
|
|
3304
|
+
# For GetSavingsPlansPurchaseRecommendation, the `Filter` doesn't
|
|
3191
3305
|
# include `CostCategories` or `Tags`. It only includes `Dimensions`.
|
|
3192
3306
|
# With `Dimensions`, `Key` must be `LINKED_ACCOUNT` and `Value` can be a
|
|
3193
|
-
# single Account ID or multiple comma-separated Account IDs
|
|
3194
|
-
#
|
|
3307
|
+
# single Account ID or multiple comma-separated Account IDs that you
|
|
3308
|
+
# want to see Savings Plans Purchase Recommendations for. `AND` and `OR`
|
|
3195
3309
|
# operators are not supported.
|
|
3196
3310
|
#
|
|
3197
3311
|
# @return [Types::GetSavingsPlansPurchaseRecommendationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
@@ -3299,7 +3413,7 @@ module Aws::CostExplorer
|
|
|
3299
3413
|
# `GetDimensionValues` in `SAVINGS_PLANS` to determine the possible
|
|
3300
3414
|
# dimension values.
|
|
3301
3415
|
#
|
|
3302
|
-
# <note markdown="1"> You
|
|
3416
|
+
# <note markdown="1"> You can't group by any dimension values for
|
|
3303
3417
|
# `GetSavingsPlansUtilization`.
|
|
3304
3418
|
#
|
|
3305
3419
|
# </note>
|
|
@@ -3342,7 +3456,7 @@ module Aws::CostExplorer
|
|
|
3342
3456
|
# [1]: https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Expression.html
|
|
3343
3457
|
#
|
|
3344
3458
|
# @option params [Types::SortDefinition] :sort_by
|
|
3345
|
-
# The value
|
|
3459
|
+
# The value that you want to sort the data by.
|
|
3346
3460
|
#
|
|
3347
3461
|
# The following values are supported for `Key`\:
|
|
3348
3462
|
#
|
|
@@ -3356,7 +3470,7 @@ module Aws::CostExplorer
|
|
|
3356
3470
|
#
|
|
3357
3471
|
# * `NetSavings`
|
|
3358
3472
|
#
|
|
3359
|
-
#
|
|
3473
|
+
# The supported values for `SortOrder` are `ASCENDING` and `DESCENDING`.
|
|
3360
3474
|
#
|
|
3361
3475
|
# @return [Types::GetSavingsPlansUtilizationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
3362
3476
|
#
|
|
@@ -3495,7 +3609,7 @@ module Aws::CostExplorer
|
|
|
3495
3609
|
# with a minimum value of `1`.
|
|
3496
3610
|
#
|
|
3497
3611
|
# @option params [Types::SortDefinition] :sort_by
|
|
3498
|
-
# The value
|
|
3612
|
+
# The value that you want to sort the data by.
|
|
3499
3613
|
#
|
|
3500
3614
|
# The following values are supported for `Key`\:
|
|
3501
3615
|
#
|
|
@@ -3513,7 +3627,7 @@ module Aws::CostExplorer
|
|
|
3513
3627
|
#
|
|
3514
3628
|
# * `AmortizedUpfrontCommitment`
|
|
3515
3629
|
#
|
|
3516
|
-
#
|
|
3630
|
+
# The supported values for `SortOrder` are `ASCENDING` and `DESCENDING`.
|
|
3517
3631
|
#
|
|
3518
3632
|
# @return [Types::GetSavingsPlansUtilizationDetailsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
3519
3633
|
#
|
|
@@ -3677,7 +3791,7 @@ module Aws::CostExplorer
|
|
|
3677
3791
|
# </note>
|
|
3678
3792
|
#
|
|
3679
3793
|
# @option params [Array<Types::SortDefinition>] :sort_by
|
|
3680
|
-
# The value
|
|
3794
|
+
# The value that you want to sort the data by.
|
|
3681
3795
|
#
|
|
3682
3796
|
# The key represents cost and usage metrics. The following values are
|
|
3683
3797
|
# supported:
|
|
@@ -3696,18 +3810,18 @@ module Aws::CostExplorer
|
|
|
3696
3810
|
#
|
|
3697
3811
|
# * `NormalizedUsageAmount`
|
|
3698
3812
|
#
|
|
3699
|
-
#
|
|
3813
|
+
# The supported values for `SortOrder` are `ASCENDING` and `DESCENDING`.
|
|
3700
3814
|
#
|
|
3701
|
-
# When
|
|
3815
|
+
# When you use `SortBy`, `NextPageToken` and `SearchString` aren't
|
|
3702
3816
|
# supported.
|
|
3703
3817
|
#
|
|
3704
3818
|
# @option params [Integer] :max_results
|
|
3705
3819
|
# This field is only used when SortBy is provided in the request. The
|
|
3706
|
-
# maximum number of objects that
|
|
3707
|
-
# MaxResults
|
|
3820
|
+
# maximum number of objects that are returned for this request. If
|
|
3821
|
+
# MaxResults isn't specified with SortBy, the request returns 1000
|
|
3708
3822
|
# results as the default value for this parameter.
|
|
3709
3823
|
#
|
|
3710
|
-
# For `GetTags`, MaxResults has an upper
|
|
3824
|
+
# For `GetTags`, MaxResults has an upper quota of 1000.
|
|
3711
3825
|
#
|
|
3712
3826
|
# @option params [String] :next_page_token
|
|
3713
3827
|
# The token to retrieve the next set of results. Amazon Web Services
|
|
@@ -3793,12 +3907,12 @@ module Aws::CostExplorer
|
|
|
3793
3907
|
#
|
|
3794
3908
|
# @option params [required, Types::DateInterval] :time_period
|
|
3795
3909
|
# The start and end dates of the period that you want to retrieve usage
|
|
3796
|
-
# forecast for. The start date is
|
|
3797
|
-
#
|
|
3798
|
-
# `2017-05-01`, then the cost and usage data
|
|
3799
|
-
# `2017-01-01` up to and including `2017-04-30` but
|
|
3800
|
-
# `2017-05-01`. The start date must be equal to or later
|
|
3801
|
-
# current date to avoid a validation error.
|
|
3910
|
+
# forecast for. The start date is included in the period, but the end
|
|
3911
|
+
# date isn't included in the period. For example, if `start` is
|
|
3912
|
+
# `2017-01-01` and `end` is `2017-05-01`, then the cost and usage data
|
|
3913
|
+
# is retrieved from `2017-01-01` up to and including `2017-04-30` but
|
|
3914
|
+
# not including `2017-05-01`. The start date must be equal to or later
|
|
3915
|
+
# than the current date to avoid a validation error.
|
|
3802
3916
|
#
|
|
3803
3917
|
# @option params [required, String] :metric
|
|
3804
3918
|
# Which metric Cost Explorer uses to create your forecast.
|
|
@@ -3867,12 +3981,12 @@ module Aws::CostExplorer
|
|
|
3867
3981
|
# * `SAVINGS_PLAN_ARN`
|
|
3868
3982
|
#
|
|
3869
3983
|
# @option params [Integer] :prediction_interval_level
|
|
3870
|
-
# Cost Explorer always returns the mean forecast as
|
|
3871
|
-
# can request a prediction interval around the mean
|
|
3872
|
-
# confidence level. The higher the confidence level, the
|
|
3873
|
-
# Cost Explorer is about the actual value falling in the
|
|
3874
|
-
# interval. Higher confidence levels result in wider
|
|
3875
|
-
# intervals.
|
|
3984
|
+
# Amazon Web Services Cost Explorer always returns the mean forecast as
|
|
3985
|
+
# a single point. You can request a prediction interval around the mean
|
|
3986
|
+
# by specifying a confidence level. The higher the confidence level, the
|
|
3987
|
+
# more confident Cost Explorer is about the actual value falling in the
|
|
3988
|
+
# prediction interval. Higher confidence levels result in wider
|
|
3989
|
+
# prediction intervals.
|
|
3876
3990
|
#
|
|
3877
3991
|
# @return [Types::GetUsageForecastResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
3878
3992
|
#
|
|
@@ -3941,14 +4055,77 @@ module Aws::CostExplorer
|
|
|
3941
4055
|
req.send_request(options)
|
|
3942
4056
|
end
|
|
3943
4057
|
|
|
3944
|
-
#
|
|
3945
|
-
#
|
|
3946
|
-
#
|
|
3947
|
-
#
|
|
3948
|
-
#
|
|
3949
|
-
#
|
|
3950
|
-
#
|
|
3951
|
-
#
|
|
4058
|
+
# Get a list of cost allocation tags. All inputs in the API are optional
|
|
4059
|
+
# and serve as filters. By default, all cost allocation tags are
|
|
4060
|
+
# returned.
|
|
4061
|
+
#
|
|
4062
|
+
# @option params [String] :status
|
|
4063
|
+
# The status of cost allocation tag keys that are returned for this
|
|
4064
|
+
# request.
|
|
4065
|
+
#
|
|
4066
|
+
# @option params [Array<String>] :tag_keys
|
|
4067
|
+
# The list of cost allocation tag keys that are returned for this
|
|
4068
|
+
# request.
|
|
4069
|
+
#
|
|
4070
|
+
# @option params [String] :type
|
|
4071
|
+
# The type of `CostAllocationTag` object that are returned for this
|
|
4072
|
+
# request. The `AWSGenerated` type tags are tags that Amazon Web
|
|
4073
|
+
# Services defines and applies to support Amazon Web Services resources
|
|
4074
|
+
# for cost allocation purposes. The `UserDefined` type tags are tags
|
|
4075
|
+
# that you define, create, and apply to resources.
|
|
4076
|
+
#
|
|
4077
|
+
# @option params [String] :next_token
|
|
4078
|
+
# The token to retrieve the next set of results. Amazon Web Services
|
|
4079
|
+
# provides the token when the response from a previous call has more
|
|
4080
|
+
# results than the maximum page size.
|
|
4081
|
+
#
|
|
4082
|
+
# @option params [Integer] :max_results
|
|
4083
|
+
# The maximum number of objects that are returned for this request. By
|
|
4084
|
+
# default, the request returns 100 results.
|
|
4085
|
+
#
|
|
4086
|
+
# @return [Types::ListCostAllocationTagsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
4087
|
+
#
|
|
4088
|
+
# * {Types::ListCostAllocationTagsResponse#cost_allocation_tags #cost_allocation_tags} => Array<Types::CostAllocationTag>
|
|
4089
|
+
# * {Types::ListCostAllocationTagsResponse#next_token #next_token} => String
|
|
4090
|
+
#
|
|
4091
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
4092
|
+
#
|
|
4093
|
+
# @example Request syntax with placeholder values
|
|
4094
|
+
#
|
|
4095
|
+
# resp = client.list_cost_allocation_tags({
|
|
4096
|
+
# status: "Active", # accepts Active, Inactive
|
|
4097
|
+
# tag_keys: ["TagKey"],
|
|
4098
|
+
# type: "AWSGenerated", # accepts AWSGenerated, UserDefined
|
|
4099
|
+
# next_token: "NextPageToken",
|
|
4100
|
+
# max_results: 1,
|
|
4101
|
+
# })
|
|
4102
|
+
#
|
|
4103
|
+
# @example Response structure
|
|
4104
|
+
#
|
|
4105
|
+
# resp.cost_allocation_tags #=> Array
|
|
4106
|
+
# resp.cost_allocation_tags[0].tag_key #=> String
|
|
4107
|
+
# resp.cost_allocation_tags[0].type #=> String, one of "AWSGenerated", "UserDefined"
|
|
4108
|
+
# resp.cost_allocation_tags[0].status #=> String, one of "Active", "Inactive"
|
|
4109
|
+
# resp.next_token #=> String
|
|
4110
|
+
#
|
|
4111
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ce-2017-10-25/ListCostAllocationTags AWS API Documentation
|
|
4112
|
+
#
|
|
4113
|
+
# @overload list_cost_allocation_tags(params = {})
|
|
4114
|
+
# @param [Hash] params ({})
|
|
4115
|
+
def list_cost_allocation_tags(params = {}, options = {})
|
|
4116
|
+
req = build_request(:list_cost_allocation_tags, params)
|
|
4117
|
+
req.send_request(options)
|
|
4118
|
+
end
|
|
4119
|
+
|
|
4120
|
+
# Returns the name, Amazon Resource Name (ARN), `NumberOfRules` and
|
|
4121
|
+
# effective dates of all Cost Categories defined in the account. You
|
|
4122
|
+
# have the option to use `EffectiveOn` to return a list of Cost
|
|
4123
|
+
# Categories that were active on a specific date. If there is no
|
|
4124
|
+
# `EffectiveOn` specified, you’ll see Cost Categories that are effective
|
|
4125
|
+
# on the current date. If Cost Category is still effective,
|
|
4126
|
+
# `EffectiveEnd` is omitted in the response.
|
|
4127
|
+
# `ListCostCategoryDefinitions` supports pagination. The request can
|
|
4128
|
+
# have a `MaxResults` range up to 100.
|
|
3952
4129
|
#
|
|
3953
4130
|
# @option params [String] :effective_on
|
|
3954
4131
|
# The date when the Cost Category was effective.
|
|
@@ -4001,6 +4178,42 @@ module Aws::CostExplorer
|
|
|
4001
4178
|
req.send_request(options)
|
|
4002
4179
|
end
|
|
4003
4180
|
|
|
4181
|
+
# Returns a list of resource tags associated with the resource specified
|
|
4182
|
+
# by the Amazon Resource Name (ARN).
|
|
4183
|
+
#
|
|
4184
|
+
# @option params [required, String] :resource_arn
|
|
4185
|
+
# The Amazon Resource Name (ARN) of the resource. For a list of
|
|
4186
|
+
# supported resources, see [ResourceTag][1].
|
|
4187
|
+
#
|
|
4188
|
+
#
|
|
4189
|
+
#
|
|
4190
|
+
# [1]: https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_ResourceTag.html
|
|
4191
|
+
#
|
|
4192
|
+
# @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
4193
|
+
#
|
|
4194
|
+
# * {Types::ListTagsForResourceResponse#resource_tags #resource_tags} => Array<Types::ResourceTag>
|
|
4195
|
+
#
|
|
4196
|
+
# @example Request syntax with placeholder values
|
|
4197
|
+
#
|
|
4198
|
+
# resp = client.list_tags_for_resource({
|
|
4199
|
+
# resource_arn: "Arn", # required
|
|
4200
|
+
# })
|
|
4201
|
+
#
|
|
4202
|
+
# @example Response structure
|
|
4203
|
+
#
|
|
4204
|
+
# resp.resource_tags #=> Array
|
|
4205
|
+
# resp.resource_tags[0].key #=> String
|
|
4206
|
+
# resp.resource_tags[0].value #=> String
|
|
4207
|
+
#
|
|
4208
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ce-2017-10-25/ListTagsForResource AWS API Documentation
|
|
4209
|
+
#
|
|
4210
|
+
# @overload list_tags_for_resource(params = {})
|
|
4211
|
+
# @param [Hash] params ({})
|
|
4212
|
+
def list_tags_for_resource(params = {}, options = {})
|
|
4213
|
+
req = build_request(:list_tags_for_resource, params)
|
|
4214
|
+
req.send_request(options)
|
|
4215
|
+
end
|
|
4216
|
+
|
|
4004
4217
|
# Modifies the feedback property of a given cost anomaly.
|
|
4005
4218
|
#
|
|
4006
4219
|
# @option params [required, String] :anomaly_id
|
|
@@ -4034,8 +4247,110 @@ module Aws::CostExplorer
|
|
|
4034
4247
|
req.send_request(options)
|
|
4035
4248
|
end
|
|
4036
4249
|
|
|
4250
|
+
# An API operation for adding one or more tags (key-value pairs) to a
|
|
4251
|
+
# resource.
|
|
4252
|
+
#
|
|
4253
|
+
# You can use the `TagResource` operation with a resource that already
|
|
4254
|
+
# has tags. If you specify a new tag key for the resource, this tag is
|
|
4255
|
+
# appended to the list of tags associated with the resource. If you
|
|
4256
|
+
# specify a tag key that is already associated with the resource, the
|
|
4257
|
+
# new tag value you specify replaces the previous value for that tag.
|
|
4258
|
+
#
|
|
4259
|
+
# Although the maximum number of array members is 200, user-tag maximum
|
|
4260
|
+
# is 50. The remaining are reserved for Amazon Web Services use.
|
|
4261
|
+
#
|
|
4262
|
+
# @option params [required, String] :resource_arn
|
|
4263
|
+
# The Amazon Resource Name (ARN) of the resource. For a list of
|
|
4264
|
+
# supported resources, see [ResourceTag][1].
|
|
4265
|
+
#
|
|
4266
|
+
#
|
|
4267
|
+
#
|
|
4268
|
+
# [1]: https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_ResourceTag.html
|
|
4269
|
+
#
|
|
4270
|
+
# @option params [required, Array<Types::ResourceTag>] :resource_tags
|
|
4271
|
+
# A list of tag key-value pairs to be added to the resource.
|
|
4272
|
+
#
|
|
4273
|
+
# Each tag consists of a key and a value, and each key must be unique
|
|
4274
|
+
# for the resource. The following restrictions apply to resource tags:
|
|
4275
|
+
#
|
|
4276
|
+
# * Although the maximum number of array members is 200, you can assign
|
|
4277
|
+
# a maximum of 50 user-tags to one resource. The remaining are
|
|
4278
|
+
# reserved for Amazon Web Services use
|
|
4279
|
+
#
|
|
4280
|
+
# * The maximum length of a key is 128 characters
|
|
4281
|
+
#
|
|
4282
|
+
# * The maximum length of a value is 256 characters
|
|
4283
|
+
#
|
|
4284
|
+
# * Keys and values can only contain alphanumeric characters, spaces,
|
|
4285
|
+
# and any of the following: `_.:/=+@-`
|
|
4286
|
+
#
|
|
4287
|
+
# * Keys and values are case sensitive
|
|
4288
|
+
#
|
|
4289
|
+
# * Keys and values are trimmed for any leading or trailing whitespaces
|
|
4290
|
+
#
|
|
4291
|
+
# * Don’t use `aws:` as a prefix for your keys. This prefix is reserved
|
|
4292
|
+
# for Amazon Web Services use
|
|
4293
|
+
#
|
|
4294
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
4295
|
+
#
|
|
4296
|
+
# @example Request syntax with placeholder values
|
|
4297
|
+
#
|
|
4298
|
+
# resp = client.tag_resource({
|
|
4299
|
+
# resource_arn: "Arn", # required
|
|
4300
|
+
# resource_tags: [ # required
|
|
4301
|
+
# {
|
|
4302
|
+
# key: "ResourceTagKey", # required
|
|
4303
|
+
# value: "ResourceTagValue", # required
|
|
4304
|
+
# },
|
|
4305
|
+
# ],
|
|
4306
|
+
# })
|
|
4307
|
+
#
|
|
4308
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ce-2017-10-25/TagResource AWS API Documentation
|
|
4309
|
+
#
|
|
4310
|
+
# @overload tag_resource(params = {})
|
|
4311
|
+
# @param [Hash] params ({})
|
|
4312
|
+
def tag_resource(params = {}, options = {})
|
|
4313
|
+
req = build_request(:tag_resource, params)
|
|
4314
|
+
req.send_request(options)
|
|
4315
|
+
end
|
|
4316
|
+
|
|
4317
|
+
# Removes one or more tags from a resource. Specify only tag keys in
|
|
4318
|
+
# your request. Don't specify the value.
|
|
4319
|
+
#
|
|
4320
|
+
# @option params [required, String] :resource_arn
|
|
4321
|
+
# The Amazon Resource Name (ARN) of the resource. For a list of
|
|
4322
|
+
# supported resources, see [ResourceTag][1].
|
|
4323
|
+
#
|
|
4324
|
+
#
|
|
4325
|
+
#
|
|
4326
|
+
# [1]: https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_ResourceTag.html
|
|
4327
|
+
#
|
|
4328
|
+
# @option params [required, Array<String>] :resource_tag_keys
|
|
4329
|
+
# A list of tag keys associated with tags that need to be removed from
|
|
4330
|
+
# the resource. If you specify a tag key that doesn't exist, it's
|
|
4331
|
+
# ignored. Although the maximum number of array members is 200, user-tag
|
|
4332
|
+
# maximum is 50. The remaining are reserved for Amazon Web Services use.
|
|
4333
|
+
#
|
|
4334
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
4335
|
+
#
|
|
4336
|
+
# @example Request syntax with placeholder values
|
|
4337
|
+
#
|
|
4338
|
+
# resp = client.untag_resource({
|
|
4339
|
+
# resource_arn: "Arn", # required
|
|
4340
|
+
# resource_tag_keys: ["ResourceTagKey"], # required
|
|
4341
|
+
# })
|
|
4342
|
+
#
|
|
4343
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ce-2017-10-25/UntagResource AWS API Documentation
|
|
4344
|
+
#
|
|
4345
|
+
# @overload untag_resource(params = {})
|
|
4346
|
+
# @param [Hash] params ({})
|
|
4347
|
+
def untag_resource(params = {}, options = {})
|
|
4348
|
+
req = build_request(:untag_resource, params)
|
|
4349
|
+
req.send_request(options)
|
|
4350
|
+
end
|
|
4351
|
+
|
|
4037
4352
|
# Updates an existing cost anomaly monitor. The changes made are applied
|
|
4038
|
-
# going forward, and doesn'
|
|
4353
|
+
# going forward, and doesn't change anomalies detected in the past.
|
|
4039
4354
|
#
|
|
4040
4355
|
# @option params [required, String] :monitor_arn
|
|
4041
4356
|
# Cost anomaly monitor Amazon Resource Names (ARNs).
|
|
@@ -4122,6 +4437,47 @@ module Aws::CostExplorer
|
|
|
4122
4437
|
req.send_request(options)
|
|
4123
4438
|
end
|
|
4124
4439
|
|
|
4440
|
+
# Updates status for cost allocation tags in bulk, with maximum batch
|
|
4441
|
+
# size of 20. If the tag status that's updated is the same as the
|
|
4442
|
+
# existing tag status, the request doesn't fail. Instead, it doesn't
|
|
4443
|
+
# have any effect on the tag status (for example, activating the active
|
|
4444
|
+
# tag).
|
|
4445
|
+
#
|
|
4446
|
+
# @option params [required, Array<Types::CostAllocationTagStatusEntry>] :cost_allocation_tags_status
|
|
4447
|
+
# The list of `CostAllocationTagStatusEntry` objects that are used to
|
|
4448
|
+
# update cost allocation tags status for this request.
|
|
4449
|
+
#
|
|
4450
|
+
# @return [Types::UpdateCostAllocationTagsStatusResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
4451
|
+
#
|
|
4452
|
+
# * {Types::UpdateCostAllocationTagsStatusResponse#errors #errors} => Array<Types::UpdateCostAllocationTagsStatusError>
|
|
4453
|
+
#
|
|
4454
|
+
# @example Request syntax with placeholder values
|
|
4455
|
+
#
|
|
4456
|
+
# resp = client.update_cost_allocation_tags_status({
|
|
4457
|
+
# cost_allocation_tags_status: [ # required
|
|
4458
|
+
# {
|
|
4459
|
+
# tag_key: "TagKey", # required
|
|
4460
|
+
# status: "Active", # required, accepts Active, Inactive
|
|
4461
|
+
# },
|
|
4462
|
+
# ],
|
|
4463
|
+
# })
|
|
4464
|
+
#
|
|
4465
|
+
# @example Response structure
|
|
4466
|
+
#
|
|
4467
|
+
# resp.errors #=> Array
|
|
4468
|
+
# resp.errors[0].tag_key #=> String
|
|
4469
|
+
# resp.errors[0].code #=> String
|
|
4470
|
+
# resp.errors[0].message #=> String
|
|
4471
|
+
#
|
|
4472
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ce-2017-10-25/UpdateCostAllocationTagsStatus AWS API Documentation
|
|
4473
|
+
#
|
|
4474
|
+
# @overload update_cost_allocation_tags_status(params = {})
|
|
4475
|
+
# @param [Hash] params ({})
|
|
4476
|
+
def update_cost_allocation_tags_status(params = {}, options = {})
|
|
4477
|
+
req = build_request(:update_cost_allocation_tags_status, params)
|
|
4478
|
+
req.send_request(options)
|
|
4479
|
+
end
|
|
4480
|
+
|
|
4125
4481
|
# Updates an existing Cost Category. Changes made to the Cost Category
|
|
4126
4482
|
# rules will be used to categorize the current month’s expenses and
|
|
4127
4483
|
# future expenses. This won’t change categorization for the previous
|
|
@@ -4241,7 +4597,7 @@ module Aws::CostExplorer
|
|
|
4241
4597
|
params: params,
|
|
4242
4598
|
config: config)
|
|
4243
4599
|
context[:gem_name] = 'aws-sdk-costexplorer'
|
|
4244
|
-
context[:gem_version] = '1.
|
|
4600
|
+
context[:gem_version] = '1.77.0'
|
|
4245
4601
|
Seahorse::Client::Request.new(handlers, context)
|
|
4246
4602
|
end
|
|
4247
4603
|
|