aws-sdk-costexplorer 1.76.0 → 1.78.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-costexplorer/client.rb +257 -131
- data/lib/aws-sdk-costexplorer/client_api.rb +80 -0
- data/lib/aws-sdk-costexplorer/types.rb +419 -182
- data/lib/aws-sdk-costexplorer.rb +1 -1
- metadata +2 -2
@@ -370,7 +370,7 @@ module Aws::CostExplorer
|
|
370
370
|
# @option params [Array<Types::ResourceTag>] :resource_tags
|
371
371
|
# An optional list of tags to associate with the specified [
|
372
372
|
# `AnomalyMonitor` ][1]. You can use resource tags to control access to
|
373
|
-
# your monitor using IAM policies.
|
373
|
+
# your `monitor` using IAM policies.
|
374
374
|
#
|
375
375
|
# Each tag consists of a key and a value, and each key must be unique
|
376
376
|
# for the resource. The following restrictions apply to resource tags:
|
@@ -383,8 +383,8 @@ module Aws::CostExplorer
|
|
383
383
|
#
|
384
384
|
# * The maximum length of a value is 256 characters
|
385
385
|
#
|
386
|
-
# *
|
387
|
-
# `_
|
386
|
+
# * Keys and values can only contain alphanumeric characters, spaces,
|
387
|
+
# and any of the following: `_.:/=+@-`
|
388
388
|
#
|
389
389
|
# * Keys and values are case sensitive
|
390
390
|
#
|
@@ -489,8 +489,8 @@ module Aws::CostExplorer
|
|
489
489
|
#
|
490
490
|
# * The maximum length of a value is 256 characters
|
491
491
|
#
|
492
|
-
# *
|
493
|
-
# `_
|
492
|
+
# * Keys and values can only contain alphanumeric characters, spaces,
|
493
|
+
# and any of the following: `_.:/=+@-`
|
494
494
|
#
|
495
495
|
# * Keys and values are case sensitive
|
496
496
|
#
|
@@ -551,6 +551,12 @@ module Aws::CostExplorer
|
|
551
551
|
# @option params [required, String] :name
|
552
552
|
# The unique name of the Cost Category.
|
553
553
|
#
|
554
|
+
# @option params [String] :effective_start
|
555
|
+
# The Cost Category's effective start date. It can only be a billing
|
556
|
+
# start date (first day of the month). If the date isn't provided,
|
557
|
+
# it's the first day of the current month. Dates can't be before the
|
558
|
+
# previous twelve months, or in the future.
|
559
|
+
#
|
554
560
|
# @option params [required, String] :rule_version
|
555
561
|
# The rule schema version in this particular Cost Category.
|
556
562
|
#
|
@@ -585,8 +591,8 @@ module Aws::CostExplorer
|
|
585
591
|
#
|
586
592
|
# * The maximum length of a value is 256 characters
|
587
593
|
#
|
588
|
-
# *
|
589
|
-
# `_
|
594
|
+
# * Keys and values can only contain alphanumeric characters, spaces,
|
595
|
+
# and any of the following: `_.:/=+@-`
|
590
596
|
#
|
591
597
|
# * Keys and values are case sensitive
|
592
598
|
#
|
@@ -608,6 +614,7 @@ module Aws::CostExplorer
|
|
608
614
|
#
|
609
615
|
# resp = client.create_cost_category_definition({
|
610
616
|
# name: "CostCategoryName", # required
|
617
|
+
# effective_start: "ZonedDateTime",
|
611
618
|
# rule_version: "CostCategoryExpression.v1", # required, accepts CostCategoryExpression.v1
|
612
619
|
# rules: [ # required
|
613
620
|
# {
|
@@ -762,12 +769,12 @@ module Aws::CostExplorer
|
|
762
769
|
req.send_request(options)
|
763
770
|
end
|
764
771
|
|
765
|
-
# Returns the name, ARN, rules, definition, and
|
766
|
-
# Cost Category that's defined in the account.
|
772
|
+
# Returns the name, Amazon Resource Name (ARN), rules, definition, and
|
773
|
+
# effective dates of a Cost Category that's defined in the account.
|
767
774
|
#
|
768
775
|
# You have the option to use `EffectiveOn` to return a Cost Category
|
769
|
-
# that
|
770
|
-
# specified, you
|
776
|
+
# that's active on a specific date. If there's no `EffectiveOn`
|
777
|
+
# specified, you see a Cost Category that's effective on the current
|
771
778
|
# date. If Cost Category is still effective, `EffectiveEnd` is omitted
|
772
779
|
# in the response.
|
773
780
|
#
|
@@ -1239,7 +1246,7 @@ module Aws::CostExplorer
|
|
1239
1246
|
# Elastic Compute Cloud – Compute service only.
|
1240
1247
|
#
|
1241
1248
|
# <note markdown="1"> This is an opt-in only feature. You can enable this feature from the
|
1242
|
-
# Cost Explorer Settings page. For information
|
1249
|
+
# Cost Explorer Settings page. For information about how to access the
|
1243
1250
|
# Settings page, see [Controlling Access for Cost Explorer][2] in the
|
1244
1251
|
# *Billing and Cost Management User Guide*.
|
1245
1252
|
#
|
@@ -1299,8 +1306,8 @@ module Aws::CostExplorer
|
|
1299
1306
|
# usage numbers without taking the units into account. For example, if
|
1300
1307
|
# you aggregate `usageQuantity` across all of Amazon EC2, the results
|
1301
1308
|
# aren't meaningful because Amazon EC2 compute hours and data transfer
|
1302
|
-
# are measured in different units (for example,
|
1303
|
-
#
|
1309
|
+
# are measured in different units (for example, hour or GB). To get more
|
1310
|
+
# meaningful `UsageQuantity` metrics, filter by `UsageType` or
|
1304
1311
|
# `UsageTypeGroups`.
|
1305
1312
|
#
|
1306
1313
|
# </note>
|
@@ -1418,11 +1425,10 @@ module Aws::CostExplorer
|
|
1418
1425
|
# @option params [String] :search_string
|
1419
1426
|
# The value that you want to search the filter values for.
|
1420
1427
|
#
|
1421
|
-
# If you
|
1422
|
-
#
|
1423
|
-
#
|
1424
|
-
#
|
1425
|
-
# pattern.
|
1428
|
+
# If you don't specify a `CostCategoryName`, `SearchString` is used to
|
1429
|
+
# filter Cost Category names that match the `SearchString` pattern. If
|
1430
|
+
# you specify a `CostCategoryName`, `SearchString` is used to filter
|
1431
|
+
# Cost Category values that match the `SearchString` pattern.
|
1426
1432
|
#
|
1427
1433
|
# @option params [required, Types::DateInterval] :time_period
|
1428
1434
|
# The time period of the request.
|
@@ -1484,10 +1490,10 @@ module Aws::CostExplorer
|
|
1484
1490
|
# </note>
|
1485
1491
|
#
|
1486
1492
|
# @option params [Array<Types::SortDefinition>] :sort_by
|
1487
|
-
# The value
|
1493
|
+
# The value that you sort the data by.
|
1488
1494
|
#
|
1489
|
-
# The key represents cost and usage metrics. The following values
|
1490
|
-
# supported:
|
1495
|
+
# The key represents the cost and usage metrics. The following values
|
1496
|
+
# are supported:
|
1491
1497
|
#
|
1492
1498
|
# * `BlendedCost`
|
1493
1499
|
#
|
@@ -1503,25 +1509,27 @@ module Aws::CostExplorer
|
|
1503
1509
|
#
|
1504
1510
|
# * `NormalizedUsageAmount`
|
1505
1511
|
#
|
1506
|
-
#
|
1512
|
+
# The supported key values for the `SortOrder` value are `ASCENDING` and
|
1513
|
+
# `DESCENDING`.
|
1507
1514
|
#
|
1508
|
-
# When
|
1509
|
-
# supported.
|
1515
|
+
# When you use the `SortBy` value, the `NextPageToken` and
|
1516
|
+
# `SearchString` key values aren't supported.
|
1510
1517
|
#
|
1511
1518
|
# @option params [Integer] :max_results
|
1512
|
-
# This field is only used when `SortBy` is provided in the
|
1519
|
+
# This field is only used when the `SortBy` value is provided in the
|
1520
|
+
# request.
|
1513
1521
|
#
|
1514
|
-
# The maximum number of objects that
|
1515
|
-
# `MaxResults`
|
1516
|
-
# 1000 results as the default value for this parameter.
|
1522
|
+
# The maximum number of objects that are returned for this request. If
|
1523
|
+
# `MaxResults` isn't specified with the `SortBy` value, the request
|
1524
|
+
# returns 1000 results as the default value for this parameter.
|
1517
1525
|
#
|
1518
|
-
# For `GetCostCategories`, MaxResults has an upper
|
1526
|
+
# For `GetCostCategories`, MaxResults has an upper quota of 1000.
|
1519
1527
|
#
|
1520
1528
|
# @option params [String] :next_page_token
|
1521
1529
|
# If the number of objects that are still available for retrieval
|
1522
|
-
# exceeds the
|
1530
|
+
# exceeds the quota, Amazon Web Services returns a NextPageToken value
|
1523
1531
|
# in the response. To retrieve the next batch of objects, provide the
|
1524
|
-
# NextPageToken from the
|
1532
|
+
# NextPageToken from the previous call in your next request.
|
1525
1533
|
#
|
1526
1534
|
# @return [Types::GetCostCategoriesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1527
1535
|
#
|
@@ -1778,6 +1786,12 @@ module Aws::CostExplorer
|
|
1778
1786
|
# @option params [required, String] :dimension
|
1779
1787
|
# The name of the dimension. Each `Dimension` is available for a
|
1780
1788
|
# different `Context`. For more information, see `Context`.
|
1789
|
+
# `LINK_ACCOUNT_NAME` and `SERVICE_CODE` can only be used in
|
1790
|
+
# [CostCategoryRule][1].
|
1791
|
+
#
|
1792
|
+
#
|
1793
|
+
#
|
1794
|
+
# [1]: https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/AAPI_CostCategoryRule.html
|
1781
1795
|
#
|
1782
1796
|
# @option params [String] :context
|
1783
1797
|
# The context for the call to `GetDimensionValues`. This can be
|
@@ -1797,15 +1811,14 @@ module Aws::CostExplorer
|
|
1797
1811
|
# is with. Possible values are the following:
|
1798
1812
|
#
|
1799
1813
|
# \- Amazon Web Services(Amazon Web Services): The entity that sells
|
1800
|
-
# Amazon Web Services
|
1814
|
+
# Amazon Web Services.
|
1801
1815
|
#
|
1802
1816
|
# \- AISPL (Amazon Internet Services Pvt. Ltd.): The local Indian
|
1803
|
-
# entity that
|
1804
|
-
# in India.
|
1817
|
+
# entity that's an acting reseller for Amazon Web Services in India.
|
1805
1818
|
#
|
1806
1819
|
# \- Amazon Web Services Marketplace: The entity that supports the sale
|
1807
|
-
# of solutions built on Amazon Web Services by third-party
|
1808
|
-
# providers.
|
1820
|
+
# of solutions that are built on Amazon Web Services by third-party
|
1821
|
+
# software providers.
|
1809
1822
|
#
|
1810
1823
|
# * CACHE\_ENGINE - The Amazon ElastiCache operating system. Examples
|
1811
1824
|
# are Windows or Linux.
|
@@ -1820,12 +1833,12 @@ module Aws::CostExplorer
|
|
1820
1833
|
# `m4.xlarge`.
|
1821
1834
|
#
|
1822
1835
|
# * INSTANCE\_TYPE\_FAMILY - A family of instance types optimized to fit
|
1823
|
-
# different use cases. Examples are `Compute Optimized` (
|
1824
|
-
# `C6g`, `C7g`
|
1825
|
-
#
|
1836
|
+
# different use cases. Examples are `Compute Optimized` (for example,
|
1837
|
+
# `C4`, `C5`, `C6g`, and `C7g`), `Memory Optimization` (for example,
|
1838
|
+
# `R4`, `R5n`, `R5b`, and `R6g`).
|
1826
1839
|
#
|
1827
|
-
# * INVOICING\_ENTITY - The name of the entity
|
1828
|
-
# Services invoice.
|
1840
|
+
# * INVOICING\_ENTITY - The name of the entity that issues the Amazon
|
1841
|
+
# Web Services invoice.
|
1829
1842
|
#
|
1830
1843
|
# * LEGAL\_ENTITY\_NAME - The name of the organization that sells you
|
1831
1844
|
# Amazon Web Services services, such as Amazon Web Services.
|
@@ -1843,9 +1856,9 @@ module Aws::CostExplorer
|
|
1843
1856
|
# * PLATFORM - The Amazon EC2 operating system. Examples are Windows or
|
1844
1857
|
# Linux.
|
1845
1858
|
#
|
1846
|
-
# * PURCHASE\_TYPE - The reservation type of the purchase
|
1847
|
-
# usage is related. Examples include On-Demand Instances and
|
1848
|
-
# Reserved Instances.
|
1859
|
+
# * PURCHASE\_TYPE - The reservation type of the purchase that this
|
1860
|
+
# usage is related to. Examples include On-Demand Instances and
|
1861
|
+
# Standard Reserved Instances.
|
1849
1862
|
#
|
1850
1863
|
# * RESERVATION\_ID - The unique identifier for an Amazon Web Services
|
1851
1864
|
# Reservation Instance.
|
@@ -1870,8 +1883,8 @@ module Aws::CostExplorer
|
|
1870
1883
|
#
|
1871
1884
|
# * REGION - The Amazon Web Services Region.
|
1872
1885
|
#
|
1873
|
-
# * RECORD\_TYPE - The different types of charges such as
|
1874
|
-
# costs, tax refunds, and credits.
|
1886
|
+
# * RECORD\_TYPE - The different types of charges such as Reserved
|
1887
|
+
# Instance (RI) fees, usage costs, tax refunds, and credits.
|
1875
1888
|
#
|
1876
1889
|
# * RESOURCE\_ID - The unique identifier of the resource. ResourceId is
|
1877
1890
|
# an opt-in feature only available for last 14 days for EC2-Compute
|
@@ -1915,8 +1928,8 @@ module Aws::CostExplorer
|
|
1915
1928
|
# * SAVINGS\_PLANS\_TYPE - Type of Savings Plans (EC2 Instance or
|
1916
1929
|
# Compute)
|
1917
1930
|
#
|
1918
|
-
# * PAYMENT\_OPTION -
|
1919
|
-
# example, All Upfront)
|
1931
|
+
# * PAYMENT\_OPTION - The payment option for the given Savings Plans
|
1932
|
+
# (for example, All Upfront)
|
1920
1933
|
#
|
1921
1934
|
# * REGION - The Amazon Web Services Region.
|
1922
1935
|
#
|
@@ -1982,7 +1995,7 @@ module Aws::CostExplorer
|
|
1982
1995
|
# </note>
|
1983
1996
|
#
|
1984
1997
|
# @option params [Array<Types::SortDefinition>] :sort_by
|
1985
|
-
# The value
|
1998
|
+
# The value that you want to sort the data by.
|
1986
1999
|
#
|
1987
2000
|
# The key represents cost and usage metrics. The following values are
|
1988
2001
|
# supported:
|
@@ -2001,16 +2014,17 @@ module Aws::CostExplorer
|
|
2001
2014
|
#
|
2002
2015
|
# * `NormalizedUsageAmount`
|
2003
2016
|
#
|
2004
|
-
#
|
2017
|
+
# The supported values for the `SortOrder` key are `ASCENDING` or
|
2018
|
+
# `DESCENDING`.
|
2005
2019
|
#
|
2006
2020
|
# When you specify a `SortBy` paramater, the context must be
|
2007
2021
|
# `COST_AND_USAGE`. Further, when using `SortBy`, `NextPageToken` and
|
2008
|
-
# `SearchString`
|
2022
|
+
# `SearchString` aren't supported.
|
2009
2023
|
#
|
2010
2024
|
# @option params [Integer] :max_results
|
2011
2025
|
# This field is only used when SortBy is provided in the request. The
|
2012
|
-
# maximum number of objects that
|
2013
|
-
# MaxResults
|
2026
|
+
# maximum number of objects that are returned for this request. If
|
2027
|
+
# MaxResults isn't specified with SortBy, the request returns 1000
|
2014
2028
|
# results as the default value for this parameter.
|
2015
2029
|
#
|
2016
2030
|
# For `GetDimensionValues`, MaxResults has an upper limit of 1000.
|
@@ -2096,7 +2110,7 @@ module Aws::CostExplorer
|
|
2096
2110
|
req.send_request(options)
|
2097
2111
|
end
|
2098
2112
|
|
2099
|
-
# Retrieves the reservation coverage for your account
|
2113
|
+
# Retrieves the reservation coverage for your account, which you can use
|
2100
2114
|
# to see how much of your Amazon Elastic Compute Cloud, Amazon
|
2101
2115
|
# ElastiCache, Amazon Relational Database Service, or Amazon Redshift
|
2102
2116
|
# usage is covered by a reservation. An organization's management
|
@@ -2368,31 +2382,31 @@ module Aws::CostExplorer
|
|
2368
2382
|
req.send_request(options)
|
2369
2383
|
end
|
2370
2384
|
|
2371
|
-
# Gets recommendations for
|
2372
|
-
#
|
2373
|
-
#
|
2385
|
+
# Gets recommendations for reservation purchases. These recommendations
|
2386
|
+
# might help you to reduce your costs. Reservations provide a discounted
|
2387
|
+
# hourly rate (up to 75%) compared to On-Demand pricing.
|
2374
2388
|
#
|
2375
2389
|
# Amazon Web Services generates your recommendations by identifying your
|
2376
2390
|
# On-Demand usage during a specific time period and collecting your
|
2377
2391
|
# usage into categories that are eligible for a reservation. After
|
2378
2392
|
# Amazon Web Services has these categories, it simulates every
|
2379
2393
|
# combination of reservations in each category of usage to identify the
|
2380
|
-
# best number of each type of RI to purchase to
|
2381
|
-
# savings.
|
2394
|
+
# best number of each type of Reserved Instance (RI) to purchase to
|
2395
|
+
# maximize your estimated savings.
|
2382
2396
|
#
|
2383
2397
|
# For example, Amazon Web Services automatically aggregates your Amazon
|
2384
2398
|
# EC2 Linux, shared tenancy, and c4 family usage in the US West (Oregon)
|
2385
2399
|
# Region and recommends that you buy size-flexible regional reservations
|
2386
2400
|
# to apply to the c4 family usage. Amazon Web Services recommends the
|
2387
2401
|
# smallest size instance in an instance family. This makes it easier to
|
2388
|
-
# purchase a size-flexible RI. Amazon Web Services
|
2389
|
-
# number of normalized units
|
2390
|
-
# that you want. For this example, your RI
|
2391
|
-
# `c4.large` because that is the smallest size
|
2392
|
-
# instance family.
|
2402
|
+
# purchase a size-flexible Reserved Instance (RI). Amazon Web Services
|
2403
|
+
# also shows the equal number of normalized units. This way, you can
|
2404
|
+
# purchase any instance size that you want. For this example, your RI
|
2405
|
+
# recommendation is for `c4.large` because that is the smallest size
|
2406
|
+
# instance in the c4 instance family.
|
2393
2407
|
#
|
2394
2408
|
# @option params [String] :account_id
|
2395
|
-
# The account ID that
|
2409
|
+
# The account ID that's associated with the recommendation.
|
2396
2410
|
#
|
2397
2411
|
# @option params [required, String] :service
|
2398
2412
|
# The specific service that you want recommendations for.
|
@@ -2617,11 +2631,12 @@ module Aws::CostExplorer
|
|
2617
2631
|
# Currently, you can group only by `SUBSCRIPTION_ID`.
|
2618
2632
|
#
|
2619
2633
|
# @option params [required, Types::DateInterval] :time_period
|
2620
|
-
# Sets the start and end dates for retrieving
|
2621
|
-
# date is inclusive, but the end date is
|
2622
|
-
# `start` is `2017-01-01` and `end` is
|
2623
|
-
#
|
2624
|
-
# `2017-
|
2634
|
+
# Sets the start and end dates for retrieving Reserved Instance (RI)
|
2635
|
+
# utilization. The start date is inclusive, but the end date is
|
2636
|
+
# exclusive. For example, if `start` is `2017-01-01` and `end` is
|
2637
|
+
# `2017-05-01`, then the cost and usage data is retrieved from
|
2638
|
+
# `2017-01-01` up to and including `2017-04-30` but not including
|
2639
|
+
# `2017-05-01`.
|
2625
2640
|
#
|
2626
2641
|
# @option params [Array<Types::GroupDefinition>] :group_by
|
2627
2642
|
# Groups only by `SUBSCRIPTION_ID`. Metadata is included.
|
@@ -2671,7 +2686,7 @@ module Aws::CostExplorer
|
|
2671
2686
|
# [1]: https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Expression.html
|
2672
2687
|
#
|
2673
2688
|
# @option params [Types::SortDefinition] :sort_by
|
2674
|
-
# The value
|
2689
|
+
# The value that you want to sort the data by.
|
2675
2690
|
#
|
2676
2691
|
# The following values are supported for `Key`\:
|
2677
2692
|
#
|
@@ -2709,7 +2724,7 @@ module Aws::CostExplorer
|
|
2709
2724
|
#
|
2710
2725
|
# * `UnrealizedSavings`
|
2711
2726
|
#
|
2712
|
-
#
|
2727
|
+
# The supported values for `SortOrder` are `ASCENDING` and `DESCENDING`.
|
2713
2728
|
#
|
2714
2729
|
# @option params [String] :next_page_token
|
2715
2730
|
# The token to retrieve the next set of results. Amazon Web Services
|
@@ -2856,10 +2871,10 @@ module Aws::CostExplorer
|
|
2856
2871
|
# and underutilized Amazon EC2 instances.
|
2857
2872
|
#
|
2858
2873
|
# Recommendations are generated to either downsize or terminate
|
2859
|
-
# instances, along with providing savings detail and metrics. For
|
2860
|
-
#
|
2861
|
-
# Rightsizing Recommendations][1] in the *Billing and Cost
|
2862
|
-
# User Guide*.
|
2874
|
+
# instances, along with providing savings detail and metrics. For more
|
2875
|
+
# information about calculation and function, see [Optimizing Your Cost
|
2876
|
+
# with Rightsizing Recommendations][1] in the *Billing and Cost
|
2877
|
+
# Management User Guide*.
|
2863
2878
|
#
|
2864
2879
|
#
|
2865
2880
|
#
|
@@ -2919,12 +2934,12 @@ module Aws::CostExplorer
|
|
2919
2934
|
# </note>
|
2920
2935
|
#
|
2921
2936
|
# @option params [Types::RightsizingRecommendationConfiguration] :configuration
|
2922
|
-
#
|
2923
|
-
# can choose to view recommendations for instances
|
2924
|
-
# instance families or across different instance
|
2925
|
-
# choose to view your estimated savings
|
2926
|
-
# with consideration of existing Savings
|
2927
|
-
# neither.
|
2937
|
+
# You can use Configuration to customize recommendations across two
|
2938
|
+
# attributes. You can choose to view recommendations for instances
|
2939
|
+
# within the same instance families or across different instance
|
2940
|
+
# families. You can also choose to view your estimated savings that are
|
2941
|
+
# associated with recommendations with consideration of existing Savings
|
2942
|
+
# Plans or RI benefits, or neither.
|
2928
2943
|
#
|
2929
2944
|
# @option params [required, String] :service
|
2930
2945
|
# The specific service that you want recommendations for. The only valid
|
@@ -3158,7 +3173,7 @@ module Aws::CostExplorer
|
|
3158
3173
|
# with a minimum value of `1`.
|
3159
3174
|
#
|
3160
3175
|
# @option params [Types::SortDefinition] :sort_by
|
3161
|
-
# The value
|
3176
|
+
# The value that you want to sort the data by.
|
3162
3177
|
#
|
3163
3178
|
# The following values are supported for `Key`\:
|
3164
3179
|
#
|
@@ -3176,7 +3191,7 @@ module Aws::CostExplorer
|
|
3176
3191
|
#
|
3177
3192
|
# * `Service`
|
3178
3193
|
#
|
3179
|
-
#
|
3194
|
+
# The supported values for `SortOrder` are `ASCENDING` and `DESCENDING`.
|
3180
3195
|
#
|
3181
3196
|
# @return [Types::GetSavingsPlansCoverageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3182
3197
|
#
|
@@ -3264,14 +3279,14 @@ module Aws::CostExplorer
|
|
3264
3279
|
# Summary and Details.
|
3265
3280
|
#
|
3266
3281
|
# @option params [required, String] :savings_plans_type
|
3267
|
-
# The Savings Plans recommendation type requested.
|
3282
|
+
# The Savings Plans recommendation type that's requested.
|
3268
3283
|
#
|
3269
3284
|
# @option params [required, String] :term_in_years
|
3270
|
-
# The savings plan recommendation term used to generate these
|
3285
|
+
# The savings plan recommendation term that's used to generate these
|
3271
3286
|
# recommendations.
|
3272
3287
|
#
|
3273
3288
|
# @option params [required, String] :payment_option
|
3274
|
-
# The payment option used to generate these recommendations.
|
3289
|
+
# The payment option that's used to generate these recommendations.
|
3275
3290
|
#
|
3276
3291
|
# @option params [String] :account_scope
|
3277
3292
|
# The account scope that you want your recommendations for. Amazon Web
|
@@ -3290,20 +3305,20 @@ module Aws::CostExplorer
|
|
3290
3305
|
# response object.
|
3291
3306
|
#
|
3292
3307
|
# @option params [required, String] :lookback_period_in_days
|
3293
|
-
# The lookback period used to generate the recommendation.
|
3308
|
+
# The lookback period that's used to generate the recommendation.
|
3294
3309
|
#
|
3295
3310
|
# @option params [Types::Expression] :filter
|
3296
3311
|
# You can filter your recommendations by Account ID with the
|
3297
3312
|
# `LINKED_ACCOUNT` dimension. To filter your recommendations by Account
|
3298
3313
|
# ID, specify `Key` as `LINKED_ACCOUNT` and `Value` as the
|
3299
|
-
# comma-separated Acount ID(s)
|
3300
|
-
# purchase recommendations.
|
3314
|
+
# comma-separated Acount ID(s) that you want to see Savings Plans
|
3315
|
+
# purchase recommendations for.
|
3301
3316
|
#
|
3302
|
-
# For GetSavingsPlansPurchaseRecommendation, the `Filter`
|
3317
|
+
# For GetSavingsPlansPurchaseRecommendation, the `Filter` doesn't
|
3303
3318
|
# include `CostCategories` or `Tags`. It only includes `Dimensions`.
|
3304
3319
|
# With `Dimensions`, `Key` must be `LINKED_ACCOUNT` and `Value` can be a
|
3305
|
-
# single Account ID or multiple comma-separated Account IDs
|
3306
|
-
#
|
3320
|
+
# single Account ID or multiple comma-separated Account IDs that you
|
3321
|
+
# want to see Savings Plans Purchase Recommendations for. `AND` and `OR`
|
3307
3322
|
# operators are not supported.
|
3308
3323
|
#
|
3309
3324
|
# @return [Types::GetSavingsPlansPurchaseRecommendationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
@@ -3411,7 +3426,7 @@ module Aws::CostExplorer
|
|
3411
3426
|
# `GetDimensionValues` in `SAVINGS_PLANS` to determine the possible
|
3412
3427
|
# dimension values.
|
3413
3428
|
#
|
3414
|
-
# <note markdown="1"> You
|
3429
|
+
# <note markdown="1"> You can't group by any dimension values for
|
3415
3430
|
# `GetSavingsPlansUtilization`.
|
3416
3431
|
#
|
3417
3432
|
# </note>
|
@@ -3454,7 +3469,7 @@ module Aws::CostExplorer
|
|
3454
3469
|
# [1]: https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Expression.html
|
3455
3470
|
#
|
3456
3471
|
# @option params [Types::SortDefinition] :sort_by
|
3457
|
-
# The value
|
3472
|
+
# The value that you want to sort the data by.
|
3458
3473
|
#
|
3459
3474
|
# The following values are supported for `Key`\:
|
3460
3475
|
#
|
@@ -3468,7 +3483,7 @@ module Aws::CostExplorer
|
|
3468
3483
|
#
|
3469
3484
|
# * `NetSavings`
|
3470
3485
|
#
|
3471
|
-
#
|
3486
|
+
# The supported values for `SortOrder` are `ASCENDING` and `DESCENDING`.
|
3472
3487
|
#
|
3473
3488
|
# @return [Types::GetSavingsPlansUtilizationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3474
3489
|
#
|
@@ -3607,7 +3622,7 @@ module Aws::CostExplorer
|
|
3607
3622
|
# with a minimum value of `1`.
|
3608
3623
|
#
|
3609
3624
|
# @option params [Types::SortDefinition] :sort_by
|
3610
|
-
# The value
|
3625
|
+
# The value that you want to sort the data by.
|
3611
3626
|
#
|
3612
3627
|
# The following values are supported for `Key`\:
|
3613
3628
|
#
|
@@ -3625,7 +3640,7 @@ module Aws::CostExplorer
|
|
3625
3640
|
#
|
3626
3641
|
# * `AmortizedUpfrontCommitment`
|
3627
3642
|
#
|
3628
|
-
#
|
3643
|
+
# The supported values for `SortOrder` are `ASCENDING` and `DESCENDING`.
|
3629
3644
|
#
|
3630
3645
|
# @return [Types::GetSavingsPlansUtilizationDetailsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3631
3646
|
#
|
@@ -3789,7 +3804,7 @@ module Aws::CostExplorer
|
|
3789
3804
|
# </note>
|
3790
3805
|
#
|
3791
3806
|
# @option params [Array<Types::SortDefinition>] :sort_by
|
3792
|
-
# The value
|
3807
|
+
# The value that you want to sort the data by.
|
3793
3808
|
#
|
3794
3809
|
# The key represents cost and usage metrics. The following values are
|
3795
3810
|
# supported:
|
@@ -3808,18 +3823,18 @@ module Aws::CostExplorer
|
|
3808
3823
|
#
|
3809
3824
|
# * `NormalizedUsageAmount`
|
3810
3825
|
#
|
3811
|
-
#
|
3826
|
+
# The supported values for `SortOrder` are `ASCENDING` and `DESCENDING`.
|
3812
3827
|
#
|
3813
|
-
# When
|
3828
|
+
# When you use `SortBy`, `NextPageToken` and `SearchString` aren't
|
3814
3829
|
# supported.
|
3815
3830
|
#
|
3816
3831
|
# @option params [Integer] :max_results
|
3817
3832
|
# This field is only used when SortBy is provided in the request. The
|
3818
|
-
# maximum number of objects that
|
3819
|
-
# MaxResults
|
3833
|
+
# maximum number of objects that are returned for this request. If
|
3834
|
+
# MaxResults isn't specified with SortBy, the request returns 1000
|
3820
3835
|
# results as the default value for this parameter.
|
3821
3836
|
#
|
3822
|
-
# For `GetTags`, MaxResults has an upper
|
3837
|
+
# For `GetTags`, MaxResults has an upper quota of 1000.
|
3823
3838
|
#
|
3824
3839
|
# @option params [String] :next_page_token
|
3825
3840
|
# The token to retrieve the next set of results. Amazon Web Services
|
@@ -3905,12 +3920,12 @@ module Aws::CostExplorer
|
|
3905
3920
|
#
|
3906
3921
|
# @option params [required, Types::DateInterval] :time_period
|
3907
3922
|
# The start and end dates of the period that you want to retrieve usage
|
3908
|
-
# forecast for. The start date is
|
3909
|
-
#
|
3910
|
-
# `2017-05-01`, then the cost and usage data
|
3911
|
-
# `2017-01-01` up to and including `2017-04-30` but
|
3912
|
-
# `2017-05-01`. The start date must be equal to or later
|
3913
|
-
# current date to avoid a validation error.
|
3923
|
+
# forecast for. The start date is included in the period, but the end
|
3924
|
+
# date isn't included in the period. For example, if `start` is
|
3925
|
+
# `2017-01-01` and `end` is `2017-05-01`, then the cost and usage data
|
3926
|
+
# is retrieved from `2017-01-01` up to and including `2017-04-30` but
|
3927
|
+
# not including `2017-05-01`. The start date must be equal to or later
|
3928
|
+
# than the current date to avoid a validation error.
|
3914
3929
|
#
|
3915
3930
|
# @option params [required, String] :metric
|
3916
3931
|
# Which metric Cost Explorer uses to create your forecast.
|
@@ -3979,12 +3994,12 @@ module Aws::CostExplorer
|
|
3979
3994
|
# * `SAVINGS_PLAN_ARN`
|
3980
3995
|
#
|
3981
3996
|
# @option params [Integer] :prediction_interval_level
|
3982
|
-
# Cost Explorer always returns the mean forecast as
|
3983
|
-
# can request a prediction interval around the mean
|
3984
|
-
# confidence level. The higher the confidence level, the
|
3985
|
-
# Cost Explorer is about the actual value falling in the
|
3986
|
-
# interval. Higher confidence levels result in wider
|
3987
|
-
# intervals.
|
3997
|
+
# Amazon Web Services Cost Explorer always returns the mean forecast as
|
3998
|
+
# a single point. You can request a prediction interval around the mean
|
3999
|
+
# by specifying a confidence level. The higher the confidence level, the
|
4000
|
+
# more confident Cost Explorer is about the actual value falling in the
|
4001
|
+
# prediction interval. Higher confidence levels result in wider
|
4002
|
+
# prediction intervals.
|
3988
4003
|
#
|
3989
4004
|
# @return [Types::GetUsageForecastResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3990
4005
|
#
|
@@ -4053,14 +4068,77 @@ module Aws::CostExplorer
|
|
4053
4068
|
req.send_request(options)
|
4054
4069
|
end
|
4055
4070
|
|
4056
|
-
#
|
4057
|
-
#
|
4058
|
-
#
|
4059
|
-
#
|
4060
|
-
#
|
4061
|
-
#
|
4062
|
-
#
|
4063
|
-
#
|
4071
|
+
# Get a list of cost allocation tags. All inputs in the API are optional
|
4072
|
+
# and serve as filters. By default, all cost allocation tags are
|
4073
|
+
# returned.
|
4074
|
+
#
|
4075
|
+
# @option params [String] :status
|
4076
|
+
# The status of cost allocation tag keys that are returned for this
|
4077
|
+
# request.
|
4078
|
+
#
|
4079
|
+
# @option params [Array<String>] :tag_keys
|
4080
|
+
# The list of cost allocation tag keys that are returned for this
|
4081
|
+
# request.
|
4082
|
+
#
|
4083
|
+
# @option params [String] :type
|
4084
|
+
# The type of `CostAllocationTag` object that are returned for this
|
4085
|
+
# request. The `AWSGenerated` type tags are tags that Amazon Web
|
4086
|
+
# Services defines and applies to support Amazon Web Services resources
|
4087
|
+
# for cost allocation purposes. The `UserDefined` type tags are tags
|
4088
|
+
# that you define, create, and apply to resources.
|
4089
|
+
#
|
4090
|
+
# @option params [String] :next_token
|
4091
|
+
# The token to retrieve the next set of results. Amazon Web Services
|
4092
|
+
# provides the token when the response from a previous call has more
|
4093
|
+
# results than the maximum page size.
|
4094
|
+
#
|
4095
|
+
# @option params [Integer] :max_results
|
4096
|
+
# The maximum number of objects that are returned for this request. By
|
4097
|
+
# default, the request returns 100 results.
|
4098
|
+
#
|
4099
|
+
# @return [Types::ListCostAllocationTagsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4100
|
+
#
|
4101
|
+
# * {Types::ListCostAllocationTagsResponse#cost_allocation_tags #cost_allocation_tags} => Array<Types::CostAllocationTag>
|
4102
|
+
# * {Types::ListCostAllocationTagsResponse#next_token #next_token} => String
|
4103
|
+
#
|
4104
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
4105
|
+
#
|
4106
|
+
# @example Request syntax with placeholder values
|
4107
|
+
#
|
4108
|
+
# resp = client.list_cost_allocation_tags({
|
4109
|
+
# status: "Active", # accepts Active, Inactive
|
4110
|
+
# tag_keys: ["TagKey"],
|
4111
|
+
# type: "AWSGenerated", # accepts AWSGenerated, UserDefined
|
4112
|
+
# next_token: "NextPageToken",
|
4113
|
+
# max_results: 1,
|
4114
|
+
# })
|
4115
|
+
#
|
4116
|
+
# @example Response structure
|
4117
|
+
#
|
4118
|
+
# resp.cost_allocation_tags #=> Array
|
4119
|
+
# resp.cost_allocation_tags[0].tag_key #=> String
|
4120
|
+
# resp.cost_allocation_tags[0].type #=> String, one of "AWSGenerated", "UserDefined"
|
4121
|
+
# resp.cost_allocation_tags[0].status #=> String, one of "Active", "Inactive"
|
4122
|
+
# resp.next_token #=> String
|
4123
|
+
#
|
4124
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ce-2017-10-25/ListCostAllocationTags AWS API Documentation
|
4125
|
+
#
|
4126
|
+
# @overload list_cost_allocation_tags(params = {})
|
4127
|
+
# @param [Hash] params ({})
|
4128
|
+
def list_cost_allocation_tags(params = {}, options = {})
|
4129
|
+
req = build_request(:list_cost_allocation_tags, params)
|
4130
|
+
req.send_request(options)
|
4131
|
+
end
|
4132
|
+
|
4133
|
+
# Returns the name, Amazon Resource Name (ARN), `NumberOfRules` and
|
4134
|
+
# effective dates of all Cost Categories defined in the account. You
|
4135
|
+
# have the option to use `EffectiveOn` to return a list of Cost
|
4136
|
+
# Categories that were active on a specific date. If there is no
|
4137
|
+
# `EffectiveOn` specified, you’ll see Cost Categories that are effective
|
4138
|
+
# on the current date. If Cost Category is still effective,
|
4139
|
+
# `EffectiveEnd` is omitted in the response.
|
4140
|
+
# `ListCostCategoryDefinitions` supports pagination. The request can
|
4141
|
+
# have a `MaxResults` range up to 100.
|
4064
4142
|
#
|
4065
4143
|
# @option params [String] :effective_on
|
4066
4144
|
# The date when the Cost Category was effective.
|
@@ -4216,8 +4294,8 @@ module Aws::CostExplorer
|
|
4216
4294
|
#
|
4217
4295
|
# * The maximum length of a value is 256 characters
|
4218
4296
|
#
|
4219
|
-
# *
|
4220
|
-
# `_
|
4297
|
+
# * Keys and values can only contain alphanumeric characters, spaces,
|
4298
|
+
# and any of the following: `_.:/=+@-`
|
4221
4299
|
#
|
4222
4300
|
# * Keys and values are case sensitive
|
4223
4301
|
#
|
@@ -4249,8 +4327,8 @@ module Aws::CostExplorer
|
|
4249
4327
|
req.send_request(options)
|
4250
4328
|
end
|
4251
4329
|
|
4252
|
-
# Removes one or more tags from a resource. Specify only tag
|
4253
|
-
# your request.
|
4330
|
+
# Removes one or more tags from a resource. Specify only tag keys in
|
4331
|
+
# your request. Don't specify the value.
|
4254
4332
|
#
|
4255
4333
|
# @option params [required, String] :resource_arn
|
4256
4334
|
# The Amazon Resource Name (ARN) of the resource. For a list of
|
@@ -4262,7 +4340,7 @@ module Aws::CostExplorer
|
|
4262
4340
|
#
|
4263
4341
|
# @option params [required, Array<String>] :resource_tag_keys
|
4264
4342
|
# A list of tag keys associated with tags that need to be removed from
|
4265
|
-
# the resource. If you specify a tag key that
|
4343
|
+
# the resource. If you specify a tag key that doesn't exist, it's
|
4266
4344
|
# ignored. Although the maximum number of array members is 200, user-tag
|
4267
4345
|
# maximum is 50. The remaining are reserved for Amazon Web Services use.
|
4268
4346
|
#
|
@@ -4372,6 +4450,47 @@ module Aws::CostExplorer
|
|
4372
4450
|
req.send_request(options)
|
4373
4451
|
end
|
4374
4452
|
|
4453
|
+
# Updates status for cost allocation tags in bulk, with maximum batch
|
4454
|
+
# size of 20. If the tag status that's updated is the same as the
|
4455
|
+
# existing tag status, the request doesn't fail. Instead, it doesn't
|
4456
|
+
# have any effect on the tag status (for example, activating the active
|
4457
|
+
# tag).
|
4458
|
+
#
|
4459
|
+
# @option params [required, Array<Types::CostAllocationTagStatusEntry>] :cost_allocation_tags_status
|
4460
|
+
# The list of `CostAllocationTagStatusEntry` objects that are used to
|
4461
|
+
# update cost allocation tags status for this request.
|
4462
|
+
#
|
4463
|
+
# @return [Types::UpdateCostAllocationTagsStatusResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4464
|
+
#
|
4465
|
+
# * {Types::UpdateCostAllocationTagsStatusResponse#errors #errors} => Array<Types::UpdateCostAllocationTagsStatusError>
|
4466
|
+
#
|
4467
|
+
# @example Request syntax with placeholder values
|
4468
|
+
#
|
4469
|
+
# resp = client.update_cost_allocation_tags_status({
|
4470
|
+
# cost_allocation_tags_status: [ # required
|
4471
|
+
# {
|
4472
|
+
# tag_key: "TagKey", # required
|
4473
|
+
# status: "Active", # required, accepts Active, Inactive
|
4474
|
+
# },
|
4475
|
+
# ],
|
4476
|
+
# })
|
4477
|
+
#
|
4478
|
+
# @example Response structure
|
4479
|
+
#
|
4480
|
+
# resp.errors #=> Array
|
4481
|
+
# resp.errors[0].tag_key #=> String
|
4482
|
+
# resp.errors[0].code #=> String
|
4483
|
+
# resp.errors[0].message #=> String
|
4484
|
+
#
|
4485
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ce-2017-10-25/UpdateCostAllocationTagsStatus AWS API Documentation
|
4486
|
+
#
|
4487
|
+
# @overload update_cost_allocation_tags_status(params = {})
|
4488
|
+
# @param [Hash] params ({})
|
4489
|
+
def update_cost_allocation_tags_status(params = {}, options = {})
|
4490
|
+
req = build_request(:update_cost_allocation_tags_status, params)
|
4491
|
+
req.send_request(options)
|
4492
|
+
end
|
4493
|
+
|
4375
4494
|
# Updates an existing Cost Category. Changes made to the Cost Category
|
4376
4495
|
# rules will be used to categorize the current month’s expenses and
|
4377
4496
|
# future expenses. This won’t change categorization for the previous
|
@@ -4380,6 +4499,12 @@ module Aws::CostExplorer
|
|
4380
4499
|
# @option params [required, String] :cost_category_arn
|
4381
4500
|
# The unique identifier for your Cost Category.
|
4382
4501
|
#
|
4502
|
+
# @option params [String] :effective_start
|
4503
|
+
# The Cost Category's effective start date. It can only be a billing
|
4504
|
+
# start date (first day of the month). If the date isn't provided,
|
4505
|
+
# it's the first day of the current month. Dates can't be before the
|
4506
|
+
# previous twelve months, or in the future.
|
4507
|
+
#
|
4383
4508
|
# @option params [required, String] :rule_version
|
4384
4509
|
# The rule schema version in this particular Cost Category.
|
4385
4510
|
#
|
@@ -4407,6 +4532,7 @@ module Aws::CostExplorer
|
|
4407
4532
|
#
|
4408
4533
|
# resp = client.update_cost_category_definition({
|
4409
4534
|
# cost_category_arn: "Arn", # required
|
4535
|
+
# effective_start: "ZonedDateTime",
|
4410
4536
|
# rule_version: "CostCategoryExpression.v1", # required, accepts CostCategoryExpression.v1
|
4411
4537
|
# rules: [ # required
|
4412
4538
|
# {
|
@@ -4491,7 +4617,7 @@ module Aws::CostExplorer
|
|
4491
4617
|
params: params,
|
4492
4618
|
config: config)
|
4493
4619
|
context[:gem_name] = 'aws-sdk-costexplorer'
|
4494
|
-
context[:gem_version] = '1.
|
4620
|
+
context[:gem_version] = '1.78.0'
|
4495
4621
|
Seahorse::Client::Request.new(handlers, context)
|
4496
4622
|
end
|
4497
4623
|
|