aws-sdk-billing 1.27.0 → 1.28.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 +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-billing/client.rb +293 -1
- data/lib/aws-sdk-billing/client_api.rb +237 -0
- data/lib/aws-sdk-billing/types.rb +508 -0
- data/lib/aws-sdk-billing.rb +1 -1
- data/sig/client.rbs +74 -0
- data/sig/types.rbs +131 -0
- metadata +1 -1
|
@@ -42,6 +42,27 @@ module Aws::Billing
|
|
|
42
42
|
include Aws::Structure
|
|
43
43
|
end
|
|
44
44
|
|
|
45
|
+
# A monetary amount with a currency code. Used throughout the Billing
|
|
46
|
+
# API to represent credit balances, allocations, and adjustments.
|
|
47
|
+
#
|
|
48
|
+
# @!attribute [rw] currency_code
|
|
49
|
+
# The ISO 4217 currency code for the amount (for example, `USD`).
|
|
50
|
+
# @return [String]
|
|
51
|
+
#
|
|
52
|
+
# @!attribute [rw] currency_amount
|
|
53
|
+
# The amount as a decimal string (for example, `"743.21"`). Negative
|
|
54
|
+
# values represent credits that reduce a bill.
|
|
55
|
+
# @return [String]
|
|
56
|
+
#
|
|
57
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/billing-2023-09-07/Amount AWS API Documentation
|
|
58
|
+
#
|
|
59
|
+
class Amount < Struct.new(
|
|
60
|
+
:currency_code,
|
|
61
|
+
:currency_amount)
|
|
62
|
+
SENSITIVE = []
|
|
63
|
+
include Aws::Structure
|
|
64
|
+
end
|
|
65
|
+
|
|
45
66
|
# @!attribute [rw] arn
|
|
46
67
|
# The Amazon Resource Name (ARN) of the billing view to associate
|
|
47
68
|
# source views with.
|
|
@@ -73,6 +94,109 @@ module Aws::Billing
|
|
|
73
94
|
include Aws::Structure
|
|
74
95
|
end
|
|
75
96
|
|
|
97
|
+
# A filter that narrows the set of preferences returned by
|
|
98
|
+
# `GetBillingPreferences`.
|
|
99
|
+
#
|
|
100
|
+
# @!attribute [rw] name
|
|
101
|
+
# The filter name. Currently the only supported value is
|
|
102
|
+
# `PREFERENCE_KEY`.
|
|
103
|
+
# @return [String]
|
|
104
|
+
#
|
|
105
|
+
# @!attribute [rw] value
|
|
106
|
+
# The filter values to match. For `PREFERENCE_KEY`, supply 1 to 10
|
|
107
|
+
# preference key values to match.
|
|
108
|
+
# @return [Array<String>]
|
|
109
|
+
#
|
|
110
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/billing-2023-09-07/BillingFeatureFilter AWS API Documentation
|
|
111
|
+
#
|
|
112
|
+
class BillingFeatureFilter < Struct.new(
|
|
113
|
+
:name,
|
|
114
|
+
:value)
|
|
115
|
+
SENSITIVE = []
|
|
116
|
+
include Aws::Structure
|
|
117
|
+
end
|
|
118
|
+
|
|
119
|
+
# A specific billing period identified by year and month.
|
|
120
|
+
#
|
|
121
|
+
# @!attribute [rw] year
|
|
122
|
+
# The four-digit year of the billing period.
|
|
123
|
+
# @return [Integer]
|
|
124
|
+
#
|
|
125
|
+
# @!attribute [rw] month
|
|
126
|
+
# The month of the billing period as an integer between 1 and 12.
|
|
127
|
+
# @return [Integer]
|
|
128
|
+
#
|
|
129
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/billing-2023-09-07/BillingPeriod AWS API Documentation
|
|
130
|
+
#
|
|
131
|
+
class BillingPeriod < Struct.new(
|
|
132
|
+
:year,
|
|
133
|
+
:month)
|
|
134
|
+
SENSITIVE = []
|
|
135
|
+
include Aws::Structure
|
|
136
|
+
end
|
|
137
|
+
|
|
138
|
+
# A single key/value entry used to update a billing preference.
|
|
139
|
+
#
|
|
140
|
+
# @!attribute [rw] key
|
|
141
|
+
# The preference key. Format depends on the feature being updated.
|
|
142
|
+
# @return [String]
|
|
143
|
+
#
|
|
144
|
+
# @!attribute [rw] value
|
|
145
|
+
# The preference value. Valid values: `ENABLED` or `DISABLED`.
|
|
146
|
+
# @return [String]
|
|
147
|
+
#
|
|
148
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/billing-2023-09-07/BillingPreferenceForKey AWS API Documentation
|
|
149
|
+
#
|
|
150
|
+
class BillingPreferenceForKey < Struct.new(
|
|
151
|
+
:key,
|
|
152
|
+
:value)
|
|
153
|
+
SENSITIVE = []
|
|
154
|
+
include Aws::Structure
|
|
155
|
+
end
|
|
156
|
+
|
|
157
|
+
# A single billing preference entry returned by `GetBillingPreferences`.
|
|
158
|
+
#
|
|
159
|
+
# @!attribute [rw] feature
|
|
160
|
+
# The feature this preference belongs to.
|
|
161
|
+
# @return [String]
|
|
162
|
+
#
|
|
163
|
+
# @!attribute [rw] key
|
|
164
|
+
# The preference key. Format depends on the feature.
|
|
165
|
+
# @return [String]
|
|
166
|
+
#
|
|
167
|
+
# @!attribute [rw] value
|
|
168
|
+
# The preference value. Valid values: `ENABLED` or `DISABLED`.
|
|
169
|
+
# @return [String]
|
|
170
|
+
#
|
|
171
|
+
# @!attribute [rw] account_name
|
|
172
|
+
# The display name of the account. Populated together with
|
|
173
|
+
# `accountId`; `null` otherwise.
|
|
174
|
+
# @return [String]
|
|
175
|
+
#
|
|
176
|
+
# @!attribute [rw] account_id
|
|
177
|
+
# The associated Amazon Web Services account ID. Populated for
|
|
178
|
+
# account-list keys; `null` otherwise.
|
|
179
|
+
# @return [String]
|
|
180
|
+
#
|
|
181
|
+
# @!attribute [rw] billing_period
|
|
182
|
+
# The billing period associated with the preference change. Populated
|
|
183
|
+
# only for the history features `RI_SHARING_HISTORY` and
|
|
184
|
+
# `CREDIT_SHARING_HISTORY`.
|
|
185
|
+
# @return [Types::BillingPeriod]
|
|
186
|
+
#
|
|
187
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/billing-2023-09-07/BillingPreferenceSummary AWS API Documentation
|
|
188
|
+
#
|
|
189
|
+
class BillingPreferenceSummary < Struct.new(
|
|
190
|
+
:feature,
|
|
191
|
+
:key,
|
|
192
|
+
:value,
|
|
193
|
+
:account_name,
|
|
194
|
+
:account_id,
|
|
195
|
+
:billing_period)
|
|
196
|
+
SENSITIVE = []
|
|
197
|
+
include Aws::Structure
|
|
198
|
+
end
|
|
199
|
+
|
|
76
200
|
# The metadata associated to the billing view.
|
|
77
201
|
#
|
|
78
202
|
# @!attribute [rw] arn
|
|
@@ -349,6 +473,174 @@ module Aws::Billing
|
|
|
349
473
|
include Aws::Structure
|
|
350
474
|
end
|
|
351
475
|
|
|
476
|
+
# A single entry in the credit allocation history, representing how a
|
|
477
|
+
# credit was applied to a specific service during a billing month.
|
|
478
|
+
#
|
|
479
|
+
# @!attribute [rw] credit_id
|
|
480
|
+
# The identifier of the credit that was applied.
|
|
481
|
+
# @return [String]
|
|
482
|
+
#
|
|
483
|
+
# @!attribute [rw] credit_amount
|
|
484
|
+
# The amount of credit applied. Negative values represent credits that
|
|
485
|
+
# reduced the bill.
|
|
486
|
+
# @return [Types::Amount]
|
|
487
|
+
#
|
|
488
|
+
# @!attribute [rw] description
|
|
489
|
+
# A human-readable description of the credit allocation.
|
|
490
|
+
# @return [String]
|
|
491
|
+
#
|
|
492
|
+
# @!attribute [rw] account_id
|
|
493
|
+
# The Amazon Web Services account the credit was applied to.
|
|
494
|
+
# @return [String]
|
|
495
|
+
#
|
|
496
|
+
# @!attribute [rw] applied_service_name
|
|
497
|
+
# The Amazon Web Services service the credit was applied to.
|
|
498
|
+
# @return [String]
|
|
499
|
+
#
|
|
500
|
+
# @!attribute [rw] billing_month
|
|
501
|
+
# The billing month of the application in `YYYY-MM` format.
|
|
502
|
+
# @return [String]
|
|
503
|
+
#
|
|
504
|
+
# @!attribute [rw] is_estimated_bill
|
|
505
|
+
# `true` when the entry was applied to an in-flight bill that has not
|
|
506
|
+
# yet been finalized.
|
|
507
|
+
# @return [Boolean]
|
|
508
|
+
#
|
|
509
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/billing-2023-09-07/CreditAllocationHistoryEntry AWS API Documentation
|
|
510
|
+
#
|
|
511
|
+
class CreditAllocationHistoryEntry < Struct.new(
|
|
512
|
+
:credit_id,
|
|
513
|
+
:credit_amount,
|
|
514
|
+
:description,
|
|
515
|
+
:account_id,
|
|
516
|
+
:applied_service_name,
|
|
517
|
+
:billing_month,
|
|
518
|
+
:is_estimated_bill)
|
|
519
|
+
SENSITIVE = []
|
|
520
|
+
include Aws::Structure
|
|
521
|
+
end
|
|
522
|
+
|
|
523
|
+
# Detailed information about an Amazon Web Services credit, including
|
|
524
|
+
# its identifier, type, monetary amounts, applicable products, sharing
|
|
525
|
+
# configuration, and current enabled status.
|
|
526
|
+
#
|
|
527
|
+
# @!attribute [rw] credit_id
|
|
528
|
+
# The unique identifier for the credit.
|
|
529
|
+
# @return [String]
|
|
530
|
+
#
|
|
531
|
+
# @!attribute [rw] account_id
|
|
532
|
+
# The Amazon Web Services account ID that owns the credit.
|
|
533
|
+
# @return [String]
|
|
534
|
+
#
|
|
535
|
+
# @!attribute [rw] credit_type
|
|
536
|
+
# The type of credit. Examples: `Promotion`, `Refund`, `TrueUp`.
|
|
537
|
+
# @return [String]
|
|
538
|
+
#
|
|
539
|
+
# @!attribute [rw] initial_amount
|
|
540
|
+
# The initial amount of the credit when it was issued.
|
|
541
|
+
# @return [Types::Amount]
|
|
542
|
+
#
|
|
543
|
+
# @!attribute [rw] remaining_amount
|
|
544
|
+
# The unused balance of the credit.
|
|
545
|
+
# @return [Types::Amount]
|
|
546
|
+
#
|
|
547
|
+
# @!attribute [rw] estimated_amount
|
|
548
|
+
# The estimated remaining balance, including in-flight (open) bills
|
|
549
|
+
# that have not yet been finalized.
|
|
550
|
+
# @return [Types::Amount]
|
|
551
|
+
#
|
|
552
|
+
# @!attribute [rw] applicable_product_names
|
|
553
|
+
# The names of Amazon Web Services services this credit applies to.
|
|
554
|
+
# @return [Array<String>]
|
|
555
|
+
#
|
|
556
|
+
# @!attribute [rw] description
|
|
557
|
+
# A human-readable description of the credit.
|
|
558
|
+
# @return [String]
|
|
559
|
+
#
|
|
560
|
+
# @!attribute [rw] start_date
|
|
561
|
+
# The date the credit becomes valid, as Unix epoch seconds.
|
|
562
|
+
# @return [Time]
|
|
563
|
+
#
|
|
564
|
+
# @!attribute [rw] end_date
|
|
565
|
+
# The date the credit expires, as Unix epoch seconds.
|
|
566
|
+
# @return [Time]
|
|
567
|
+
#
|
|
568
|
+
# @!attribute [rw] exhaust_date
|
|
569
|
+
# The date the credit balance reached zero, as Unix epoch seconds.
|
|
570
|
+
# @return [Time]
|
|
571
|
+
#
|
|
572
|
+
# @!attribute [rw] application_type
|
|
573
|
+
# When the credit is applied during bill computation. Valid values:
|
|
574
|
+
# `BEFORE_CROSS_SERVICE_DISCOUNTS`, `AFTER_DISCOUNTS`.
|
|
575
|
+
# @return [String]
|
|
576
|
+
#
|
|
577
|
+
# @!attribute [rw] shareable_accounts
|
|
578
|
+
# The Amazon Web Services account IDs entitled to apply this credit.
|
|
579
|
+
# @return [Array<String>]
|
|
580
|
+
#
|
|
581
|
+
# @!attribute [rw] account_has_credit_sharing_enabled
|
|
582
|
+
# Whether the owning account has account-level credit sharing turned
|
|
583
|
+
# on.
|
|
584
|
+
# @return [Boolean]
|
|
585
|
+
#
|
|
586
|
+
# @!attribute [rw] credit_console_visibility
|
|
587
|
+
# The display configuration for the credit in the Amazon Web Services
|
|
588
|
+
# Billing console.
|
|
589
|
+
# @return [String]
|
|
590
|
+
#
|
|
591
|
+
# @!attribute [rw] credit_sharing_type
|
|
592
|
+
# The sharing configuration for the credit. Valid values: `DEFAULT`,
|
|
593
|
+
# `DISABLED`, `CUSTOM`, `COST_CATEGORY_RULE`.
|
|
594
|
+
# @return [String]
|
|
595
|
+
#
|
|
596
|
+
# @!attribute [rw] cost_category_arn
|
|
597
|
+
# The Amazon Resource Name (ARN) of the Cost Category controlling the
|
|
598
|
+
# credit's sharing scope. Present only when `creditSharingType` is
|
|
599
|
+
# `COST_CATEGORY_RULE`.
|
|
600
|
+
# @return [String]
|
|
601
|
+
#
|
|
602
|
+
# @!attribute [rw] rule_name
|
|
603
|
+
# The rule name within the Cost Category. Present only when
|
|
604
|
+
# `creditSharingType` is `COST_CATEGORY_RULE`.
|
|
605
|
+
# @return [String]
|
|
606
|
+
#
|
|
607
|
+
# @!attribute [rw] credit_status
|
|
608
|
+
# Whether the credit participates in billing runs. Valid values:
|
|
609
|
+
# `ENABLED`, `DISABLED`.
|
|
610
|
+
# @return [String]
|
|
611
|
+
#
|
|
612
|
+
# @!attribute [rw] purchase_type_applications
|
|
613
|
+
# Restricts which purchase types this credit applies to. When `null`
|
|
614
|
+
# or omitted, the credit applies to all purchase types.
|
|
615
|
+
# @return [Array<String>]
|
|
616
|
+
#
|
|
617
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/billing-2023-09-07/CreditData AWS API Documentation
|
|
618
|
+
#
|
|
619
|
+
class CreditData < Struct.new(
|
|
620
|
+
:credit_id,
|
|
621
|
+
:account_id,
|
|
622
|
+
:credit_type,
|
|
623
|
+
:initial_amount,
|
|
624
|
+
:remaining_amount,
|
|
625
|
+
:estimated_amount,
|
|
626
|
+
:applicable_product_names,
|
|
627
|
+
:description,
|
|
628
|
+
:start_date,
|
|
629
|
+
:end_date,
|
|
630
|
+
:exhaust_date,
|
|
631
|
+
:application_type,
|
|
632
|
+
:shareable_accounts,
|
|
633
|
+
:account_has_credit_sharing_enabled,
|
|
634
|
+
:credit_console_visibility,
|
|
635
|
+
:credit_sharing_type,
|
|
636
|
+
:cost_category_arn,
|
|
637
|
+
:rule_name,
|
|
638
|
+
:credit_status,
|
|
639
|
+
:purchase_type_applications)
|
|
640
|
+
SENSITIVE = []
|
|
641
|
+
include Aws::Structure
|
|
642
|
+
end
|
|
643
|
+
|
|
352
644
|
# @!attribute [rw] arn
|
|
353
645
|
# The Amazon Resource Name (ARN) that can be used to uniquely identify
|
|
354
646
|
# the billing view.
|
|
@@ -468,6 +760,58 @@ module Aws::Billing
|
|
|
468
760
|
include Aws::Structure
|
|
469
761
|
end
|
|
470
762
|
|
|
763
|
+
# @!attribute [rw] next_token
|
|
764
|
+
# Pagination token from a previous response. Pass the value returned
|
|
765
|
+
# in `nextToken` to retrieve the next page of results.
|
|
766
|
+
# @return [String]
|
|
767
|
+
#
|
|
768
|
+
# @!attribute [rw] max_results
|
|
769
|
+
# The maximum number of records to return per page. Range: 1 to 50.
|
|
770
|
+
# Default: 50.
|
|
771
|
+
# @return [Integer]
|
|
772
|
+
#
|
|
773
|
+
# @!attribute [rw] features
|
|
774
|
+
# The feature to retrieve. Specify exactly one value. Valid values:
|
|
775
|
+
# `BILLING_ALERTS`, `RI_SHARING`, `RI_SHARING_HISTORY`,
|
|
776
|
+
# `CREDIT_SHARING`, `CREDIT_SHARING_HISTORY`, `CREDIT_LEVEL_SHARING`,
|
|
777
|
+
# `CREDIT_PREFERENCE_OPTIONS`.
|
|
778
|
+
# @return [Array<String>]
|
|
779
|
+
#
|
|
780
|
+
# @!attribute [rw] filters
|
|
781
|
+
# Filters to narrow results. Specify exactly one filter when supplied.
|
|
782
|
+
# The supported filter name is `PREFERENCE_KEY`, which accepts 1 to 10
|
|
783
|
+
# values to match preference keys.
|
|
784
|
+
# @return [Array<Types::BillingFeatureFilter>]
|
|
785
|
+
#
|
|
786
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/billing-2023-09-07/GetBillingPreferencesRequest AWS API Documentation
|
|
787
|
+
#
|
|
788
|
+
class GetBillingPreferencesRequest < Struct.new(
|
|
789
|
+
:next_token,
|
|
790
|
+
:max_results,
|
|
791
|
+
:features,
|
|
792
|
+
:filters)
|
|
793
|
+
SENSITIVE = []
|
|
794
|
+
include Aws::Structure
|
|
795
|
+
end
|
|
796
|
+
|
|
797
|
+
# @!attribute [rw] billing_preferences
|
|
798
|
+
# The list of preference entries matching the request.
|
|
799
|
+
# @return [Array<Types::BillingPreferenceSummary>]
|
|
800
|
+
#
|
|
801
|
+
# @!attribute [rw] next_token
|
|
802
|
+
# Pagination token. Present when more pages are available; `null` when
|
|
803
|
+
# there are no more results.
|
|
804
|
+
# @return [String]
|
|
805
|
+
#
|
|
806
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/billing-2023-09-07/GetBillingPreferencesResponse AWS API Documentation
|
|
807
|
+
#
|
|
808
|
+
class GetBillingPreferencesResponse < Struct.new(
|
|
809
|
+
:billing_preferences,
|
|
810
|
+
:next_token)
|
|
811
|
+
SENSITIVE = []
|
|
812
|
+
include Aws::Structure
|
|
813
|
+
end
|
|
814
|
+
|
|
471
815
|
# @!attribute [rw] arn
|
|
472
816
|
# The Amazon Resource Name (ARN) that can be used to uniquely identify
|
|
473
817
|
# the billing view.
|
|
@@ -493,6 +837,126 @@ module Aws::Billing
|
|
|
493
837
|
include Aws::Structure
|
|
494
838
|
end
|
|
495
839
|
|
|
840
|
+
# @!attribute [rw] account_id
|
|
841
|
+
# The Amazon Web Services account ID whose allocation history to
|
|
842
|
+
# retrieve. Must be a 12-digit numeric string.
|
|
843
|
+
# @return [String]
|
|
844
|
+
#
|
|
845
|
+
# @!attribute [rw] credit_id
|
|
846
|
+
# Filters the result to a single credit. When omitted, returns
|
|
847
|
+
# allocation entries for all credits.
|
|
848
|
+
# @return [Integer]
|
|
849
|
+
#
|
|
850
|
+
# @!attribute [rw] start_date
|
|
851
|
+
# Inclusive start date as Unix epoch seconds. Must be on or before
|
|
852
|
+
# `endDate`. The range from `startDate` to `endDate` cannot exceed 24
|
|
853
|
+
# billing months.
|
|
854
|
+
# @return [Time]
|
|
855
|
+
#
|
|
856
|
+
# @!attribute [rw] end_date
|
|
857
|
+
# Inclusive end date as Unix epoch seconds.
|
|
858
|
+
# @return [Time]
|
|
859
|
+
#
|
|
860
|
+
# @!attribute [rw] next_token
|
|
861
|
+
# Pagination token from a previous response. Pass the value returned
|
|
862
|
+
# in `nextToken` to retrieve the next page of results.
|
|
863
|
+
# @return [String]
|
|
864
|
+
#
|
|
865
|
+
# @!attribute [rw] max_results
|
|
866
|
+
# The maximum number of records to return per page. Range: 1 to 1000.
|
|
867
|
+
# Default: 100.
|
|
868
|
+
# @return [Integer]
|
|
869
|
+
#
|
|
870
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/billing-2023-09-07/GetCreditAllocationHistoryRequest AWS API Documentation
|
|
871
|
+
#
|
|
872
|
+
class GetCreditAllocationHistoryRequest < Struct.new(
|
|
873
|
+
:account_id,
|
|
874
|
+
:credit_id,
|
|
875
|
+
:start_date,
|
|
876
|
+
:end_date,
|
|
877
|
+
:next_token,
|
|
878
|
+
:max_results)
|
|
879
|
+
SENSITIVE = []
|
|
880
|
+
include Aws::Structure
|
|
881
|
+
end
|
|
882
|
+
|
|
883
|
+
# @!attribute [rw] credit_allocation_history_list
|
|
884
|
+
# Allocation entries sorted by `billingMonth` in descending order.
|
|
885
|
+
# @return [Array<Types::CreditAllocationHistoryEntry>]
|
|
886
|
+
#
|
|
887
|
+
# @!attribute [rw] partial_results
|
|
888
|
+
# `true` when data could not be retrieved for one or more billing
|
|
889
|
+
# months. The `failedMonths` field lists which months are missing.
|
|
890
|
+
# @return [Boolean]
|
|
891
|
+
#
|
|
892
|
+
# @!attribute [rw] failed_months
|
|
893
|
+
# Billing months in `YYYY-MM` format that failed to return data.
|
|
894
|
+
# Non-empty only when `partialResults` is `true`.
|
|
895
|
+
# @return [Array<String>]
|
|
896
|
+
#
|
|
897
|
+
# @!attribute [rw] next_token
|
|
898
|
+
# Pagination token. Present when more pages are available; `null` when
|
|
899
|
+
# there are no more results.
|
|
900
|
+
# @return [String]
|
|
901
|
+
#
|
|
902
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/billing-2023-09-07/GetCreditAllocationHistoryResponse AWS API Documentation
|
|
903
|
+
#
|
|
904
|
+
class GetCreditAllocationHistoryResponse < Struct.new(
|
|
905
|
+
:credit_allocation_history_list,
|
|
906
|
+
:partial_results,
|
|
907
|
+
:failed_months,
|
|
908
|
+
:next_token)
|
|
909
|
+
SENSITIVE = []
|
|
910
|
+
include Aws::Structure
|
|
911
|
+
end
|
|
912
|
+
|
|
913
|
+
# @!attribute [rw] account_id
|
|
914
|
+
# The Amazon Web Services account ID. Must be a 12-digit numeric
|
|
915
|
+
# string.
|
|
916
|
+
# @return [String]
|
|
917
|
+
#
|
|
918
|
+
# @!attribute [rw] start_date
|
|
919
|
+
# The start date for the credit period as Unix epoch seconds. Must be
|
|
920
|
+
# a past date that is not more than one year before the current date.
|
|
921
|
+
# @return [Time]
|
|
922
|
+
#
|
|
923
|
+
# @!attribute [rw] end_date
|
|
924
|
+
# The end date for the credit period as Unix epoch seconds. Must not
|
|
925
|
+
# be a future date and must be on or after `startDate`. Defaults to
|
|
926
|
+
# the current date when omitted.
|
|
927
|
+
# @return [Time]
|
|
928
|
+
#
|
|
929
|
+
# @!attribute [rw] payer_account_flag
|
|
930
|
+
# When `true` and the caller is the management account, the response
|
|
931
|
+
# aggregates credits across the entire consolidated billing family.
|
|
932
|
+
# When `false` or omitted, returns only credits for the specified
|
|
933
|
+
# `accountId`.
|
|
934
|
+
# @return [Boolean]
|
|
935
|
+
#
|
|
936
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/billing-2023-09-07/GetCreditsRequest AWS API Documentation
|
|
937
|
+
#
|
|
938
|
+
class GetCreditsRequest < Struct.new(
|
|
939
|
+
:account_id,
|
|
940
|
+
:start_date,
|
|
941
|
+
:end_date,
|
|
942
|
+
:payer_account_flag)
|
|
943
|
+
SENSITIVE = []
|
|
944
|
+
include Aws::Structure
|
|
945
|
+
end
|
|
946
|
+
|
|
947
|
+
# @!attribute [rw] credits
|
|
948
|
+
# The list of credits matching the request. Returns an empty list when
|
|
949
|
+
# no credits exist.
|
|
950
|
+
# @return [Array<Types::CreditData>]
|
|
951
|
+
#
|
|
952
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/billing-2023-09-07/GetCreditsResponse AWS API Documentation
|
|
953
|
+
#
|
|
954
|
+
class GetCreditsResponse < Struct.new(
|
|
955
|
+
:credits)
|
|
956
|
+
SENSITIVE = []
|
|
957
|
+
include Aws::Structure
|
|
958
|
+
end
|
|
959
|
+
|
|
496
960
|
# @!attribute [rw] resource_arn
|
|
497
961
|
# The Amazon Resource Name (ARN) of the billing view resource to which
|
|
498
962
|
# the policy is attached to.
|
|
@@ -680,6 +1144,22 @@ module Aws::Billing
|
|
|
680
1144
|
include Aws::Structure
|
|
681
1145
|
end
|
|
682
1146
|
|
|
1147
|
+
# @!attribute [rw] promo_code
|
|
1148
|
+
# The promotional credit code to redeem.
|
|
1149
|
+
# @return [String]
|
|
1150
|
+
#
|
|
1151
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/billing-2023-09-07/RedeemCreditsRequest AWS API Documentation
|
|
1152
|
+
#
|
|
1153
|
+
class RedeemCreditsRequest < Struct.new(
|
|
1154
|
+
:promo_code)
|
|
1155
|
+
SENSITIVE = []
|
|
1156
|
+
include Aws::Structure
|
|
1157
|
+
end
|
|
1158
|
+
|
|
1159
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/billing-2023-09-07/RedeemCreditsResponse AWS API Documentation
|
|
1160
|
+
#
|
|
1161
|
+
class RedeemCreditsResponse < Aws::EmptyStructure; end
|
|
1162
|
+
|
|
683
1163
|
# The specified ARN in the request doesn't exist.
|
|
684
1164
|
#
|
|
685
1165
|
# @!attribute [rw] message
|
|
@@ -871,6 +1351,34 @@ module Aws::Billing
|
|
|
871
1351
|
#
|
|
872
1352
|
class UntagResourceResponse < Aws::EmptyStructure; end
|
|
873
1353
|
|
|
1354
|
+
# @!attribute [rw] feature
|
|
1355
|
+
# The feature to update. Valid values: `BILLING_ALERTS`, `RI_SHARING`,
|
|
1356
|
+
# `CREDIT_SHARING`, `CREDIT_LEVEL_SHARING`,
|
|
1357
|
+
# `CREDIT_PREFERENCE_OPTIONS`. The history features
|
|
1358
|
+
# (`RI_SHARING_HISTORY` and `CREDIT_SHARING_HISTORY`) are read-only
|
|
1359
|
+
# and cannot be updated.
|
|
1360
|
+
# @return [String]
|
|
1361
|
+
#
|
|
1362
|
+
# @!attribute [rw] billing_preferences_per_key
|
|
1363
|
+
# Key/value pairs to apply. All keys in a single request must be valid
|
|
1364
|
+
# for the specified `feature` and must not be duplicated. For
|
|
1365
|
+
# `CREDIT_PREFERENCE_OPTIONS`, all keys must reference the same
|
|
1366
|
+
# `creditId`.
|
|
1367
|
+
# @return [Array<Types::BillingPreferenceForKey>]
|
|
1368
|
+
#
|
|
1369
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/billing-2023-09-07/UpdateBillingPreferencesRequest AWS API Documentation
|
|
1370
|
+
#
|
|
1371
|
+
class UpdateBillingPreferencesRequest < Struct.new(
|
|
1372
|
+
:feature,
|
|
1373
|
+
:billing_preferences_per_key)
|
|
1374
|
+
SENSITIVE = []
|
|
1375
|
+
include Aws::Structure
|
|
1376
|
+
end
|
|
1377
|
+
|
|
1378
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/billing-2023-09-07/UpdateBillingPreferencesResponse AWS API Documentation
|
|
1379
|
+
#
|
|
1380
|
+
class UpdateBillingPreferencesResponse < Aws::EmptyStructure; end
|
|
1381
|
+
|
|
874
1382
|
# @!attribute [rw] arn
|
|
875
1383
|
# The Amazon Resource Name (ARN) that can be used to uniquely identify
|
|
876
1384
|
# the billing view.
|
data/lib/aws-sdk-billing.rb
CHANGED
data/sig/client.rbs
CHANGED
|
@@ -133,6 +133,25 @@ module Aws
|
|
|
133
133
|
) -> _DisassociateSourceViewsResponseSuccess
|
|
134
134
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DisassociateSourceViewsResponseSuccess
|
|
135
135
|
|
|
136
|
+
interface _GetBillingPreferencesResponseSuccess
|
|
137
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GetBillingPreferencesResponse]
|
|
138
|
+
def billing_preferences: () -> ::Array[Types::BillingPreferenceSummary]
|
|
139
|
+
def next_token: () -> ::String
|
|
140
|
+
end
|
|
141
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Billing/Client.html#get_billing_preferences-instance_method
|
|
142
|
+
def get_billing_preferences: (
|
|
143
|
+
?next_token: ::String,
|
|
144
|
+
?max_results: ::Integer,
|
|
145
|
+
features: Array[("RI_SHARING" | "RI_SHARING_HISTORY" | "CREDIT_SHARING" | "CREDIT_SHARING_HISTORY" | "CREDIT_LEVEL_SHARING" | "BILLING_ALERTS" | "CREDIT_PREFERENCE_OPTIONS")],
|
|
146
|
+
?filters: Array[
|
|
147
|
+
{
|
|
148
|
+
name: ("PREFERENCE_KEY")?,
|
|
149
|
+
value: Array[::String]?
|
|
150
|
+
}
|
|
151
|
+
]
|
|
152
|
+
) -> _GetBillingPreferencesResponseSuccess
|
|
153
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetBillingPreferencesResponseSuccess
|
|
154
|
+
|
|
136
155
|
interface _GetBillingViewResponseSuccess
|
|
137
156
|
include ::Seahorse::Client::_ResponseSuccess[Types::GetBillingViewResponse]
|
|
138
157
|
def billing_view: () -> Types::BillingViewElement
|
|
@@ -143,6 +162,37 @@ module Aws
|
|
|
143
162
|
) -> _GetBillingViewResponseSuccess
|
|
144
163
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetBillingViewResponseSuccess
|
|
145
164
|
|
|
165
|
+
interface _GetCreditAllocationHistoryResponseSuccess
|
|
166
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GetCreditAllocationHistoryResponse]
|
|
167
|
+
def credit_allocation_history_list: () -> ::Array[Types::CreditAllocationHistoryEntry]
|
|
168
|
+
def partial_results: () -> bool
|
|
169
|
+
def failed_months: () -> ::Array[::String]
|
|
170
|
+
def next_token: () -> ::String
|
|
171
|
+
end
|
|
172
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Billing/Client.html#get_credit_allocation_history-instance_method
|
|
173
|
+
def get_credit_allocation_history: (
|
|
174
|
+
account_id: ::String,
|
|
175
|
+
?credit_id: ::Integer,
|
|
176
|
+
start_date: ::Time,
|
|
177
|
+
end_date: ::Time,
|
|
178
|
+
?next_token: ::String,
|
|
179
|
+
?max_results: ::Integer
|
|
180
|
+
) -> _GetCreditAllocationHistoryResponseSuccess
|
|
181
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetCreditAllocationHistoryResponseSuccess
|
|
182
|
+
|
|
183
|
+
interface _GetCreditsResponseSuccess
|
|
184
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GetCreditsResponse]
|
|
185
|
+
def credits: () -> ::Array[Types::CreditData]
|
|
186
|
+
end
|
|
187
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Billing/Client.html#get_credits-instance_method
|
|
188
|
+
def get_credits: (
|
|
189
|
+
account_id: ::String,
|
|
190
|
+
start_date: ::Time,
|
|
191
|
+
?end_date: ::Time,
|
|
192
|
+
?payer_account_flag: bool
|
|
193
|
+
) -> _GetCreditsResponseSuccess
|
|
194
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetCreditsResponseSuccess
|
|
195
|
+
|
|
146
196
|
interface _GetResourcePolicyResponseSuccess
|
|
147
197
|
include ::Seahorse::Client::_ResponseSuccess[Types::GetResourcePolicyResponse]
|
|
148
198
|
def resource_arn: () -> ::String
|
|
@@ -203,6 +253,15 @@ module Aws
|
|
|
203
253
|
) -> _ListTagsForResourceResponseSuccess
|
|
204
254
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListTagsForResourceResponseSuccess
|
|
205
255
|
|
|
256
|
+
interface _RedeemCreditsResponseSuccess
|
|
257
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::RedeemCreditsResponse]
|
|
258
|
+
end
|
|
259
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Billing/Client.html#redeem_credits-instance_method
|
|
260
|
+
def redeem_credits: (
|
|
261
|
+
promo_code: ::String
|
|
262
|
+
) -> _RedeemCreditsResponseSuccess
|
|
263
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _RedeemCreditsResponseSuccess
|
|
264
|
+
|
|
206
265
|
interface _TagResourceResponseSuccess
|
|
207
266
|
include ::Seahorse::Client::_ResponseSuccess[Types::TagResourceResponse]
|
|
208
267
|
end
|
|
@@ -228,6 +287,21 @@ module Aws
|
|
|
228
287
|
) -> _UntagResourceResponseSuccess
|
|
229
288
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UntagResourceResponseSuccess
|
|
230
289
|
|
|
290
|
+
interface _UpdateBillingPreferencesResponseSuccess
|
|
291
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::UpdateBillingPreferencesResponse]
|
|
292
|
+
end
|
|
293
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Billing/Client.html#update_billing_preferences-instance_method
|
|
294
|
+
def update_billing_preferences: (
|
|
295
|
+
feature: ("RI_SHARING" | "RI_SHARING_HISTORY" | "CREDIT_SHARING" | "CREDIT_SHARING_HISTORY" | "CREDIT_LEVEL_SHARING" | "BILLING_ALERTS" | "CREDIT_PREFERENCE_OPTIONS"),
|
|
296
|
+
billing_preferences_per_key: Array[
|
|
297
|
+
{
|
|
298
|
+
key: ::String,
|
|
299
|
+
value: ("ENABLED" | "DISABLED")
|
|
300
|
+
}
|
|
301
|
+
]
|
|
302
|
+
) -> _UpdateBillingPreferencesResponseSuccess
|
|
303
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateBillingPreferencesResponseSuccess
|
|
304
|
+
|
|
231
305
|
interface _UpdateBillingViewResponseSuccess
|
|
232
306
|
include ::Seahorse::Client::_ResponseSuccess[Types::UpdateBillingViewResponse]
|
|
233
307
|
def arn: () -> ::String
|