aws-sdk-costexplorer 1.36.0 → 1.37.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
- SHA1:
3
- metadata.gz: 3111002a074ce32db299c6dbdaa67c11d8309222
4
- data.tar.gz: 4e2f8bf9636ad9a46cdbfbc3721222a721ce348c
2
+ SHA256:
3
+ metadata.gz: 2b9ed73e6465e9953bf49ffe783c4484fb64e3e389e614c41b54fe5c5a89a998
4
+ data.tar.gz: f4202e1392fb96a8c03d04e1b698214cb5a77d4502f0491b9ea6feefd0e6ad3d
5
5
  SHA512:
6
- metadata.gz: b4762a81011d0fb1a1cd02099f6551ddb9148456619ee3e74ff3b27841437d3f8e272e2a12fb605ec7a3b63edc99bf707fe59e70aac1e68693f999cb063ada14
7
- data.tar.gz: 2af35cbb1ca6986c5a59214634fb2523774f19982566cabe7178168c2cf7f87e7ed0e14c461e08f927f216bdb5e4c1a7d032b82b0e2d874ac79f45a984d6f743
6
+ metadata.gz: e31c7be554203a1301c1720561d565a0ed6f7bc3a53a5c2ece0780c010f06e496874abc77d396d90b7b0051cdbcffd9e17a47f7af60c932a08e2b975aee70cbc
7
+ data.tar.gz: 22ff2c7c127340494655500e360f37d7fc13adbb4a25e545cbe95464efe60563f8312effc4c3d20bf269ae0f40e0098d6e5b8ffedec5715139c85dff8e52a7c7
@@ -24,17 +24,20 @@ require_relative 'aws-sdk-costexplorer/customizations'
24
24
  # methods each accept a hash of request parameters and return a response
25
25
  # structure.
26
26
  #
27
+ # cost_explorer = Aws::CostExplorer::Client.new
28
+ # resp = cost_explorer.create_cost_category_definition(params)
29
+ #
27
30
  # See {Client} for more information.
28
31
  #
29
32
  # # Errors
30
33
  #
31
- # Errors returned from AWS Cost Explorer Service all
32
- # extend {Errors::ServiceError}.
34
+ # Errors returned from AWS Cost Explorer Service are defined in the
35
+ # {Errors} module and all extend {Errors::ServiceError}.
33
36
  #
34
37
  # begin
35
38
  # # do stuff
36
39
  # rescue Aws::CostExplorer::Errors::ServiceError
37
- # # rescues all service API errors
40
+ # # rescues all AWS Cost Explorer Service API errors
38
41
  # end
39
42
  #
40
43
  # See {Errors} for more information.
@@ -42,6 +45,6 @@ require_relative 'aws-sdk-costexplorer/customizations'
42
45
  # @service
43
46
  module Aws::CostExplorer
44
47
 
45
- GEM_VERSION = '1.36.0'
48
+ GEM_VERSION = '1.37.0'
46
49
 
47
50
  end
@@ -30,6 +30,18 @@ require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
30
30
  Aws::Plugins::GlobalConfiguration.add_identifier(:costexplorer)
31
31
 
32
32
  module Aws::CostExplorer
33
+ # An API client for CostExplorer. To construct a client, you need to configure a `:region` and `:credentials`.
34
+ #
35
+ # client = Aws::CostExplorer::Client.new(
36
+ # region: region_name,
37
+ # credentials: credentials,
38
+ # # ...
39
+ # )
40
+ #
41
+ # For details on configuring region and credentials see
42
+ # the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
43
+ #
44
+ # See {#initialize} for a full list of supported configuration options.
33
45
  class Client < Seahorse::Client::Base
34
46
 
35
47
  include Aws::ClientStubs
@@ -108,6 +120,12 @@ module Aws::CostExplorer
108
120
  # When set to `true`, a thread polling for endpoints will be running in
109
121
  # the background every 60 secs (default). Defaults to `false`.
110
122
  #
123
+ # @option options [Boolean] :adaptive_retry_wait_to_fill (true)
124
+ # Used only in `adaptive` retry mode. When true, the request will sleep
125
+ # until there is sufficent client side capacity to retry the request.
126
+ # When false, the request will raise a `RetryCapacityNotAvailableError` and will
127
+ # not retry instead of sleeping.
128
+ #
111
129
  # @option options [Boolean] :client_side_monitoring (false)
112
130
  # When `true`, client-side metrics will be collected for all API requests from
113
131
  # this client.
@@ -132,6 +150,10 @@ module Aws::CostExplorer
132
150
  # When `true`, an attempt is made to coerce request parameters into
133
151
  # the required types.
134
152
  #
153
+ # @option options [Boolean] :correct_clock_skew (true)
154
+ # Used only in `standard` and adaptive retry modes. Specifies whether to apply
155
+ # a clock skew correction and retry requests with skewed client clocks.
156
+ #
135
157
  # @option options [Boolean] :disable_host_prefix_injection (false)
136
158
  # Set to true to disable SDK automatically adding host prefix
137
159
  # to default service endpoint when available.
@@ -166,15 +188,29 @@ module Aws::CostExplorer
166
188
  # The Logger instance to send log messages to. If this option
167
189
  # is not set, logging will be disabled.
168
190
  #
191
+ # @option options [Integer] :max_attempts (3)
192
+ # An integer representing the maximum number attempts that will be made for
193
+ # a single request, including the initial attempt. For example,
194
+ # setting this value to 5 will result in a request being retried up to
195
+ # 4 times. Used in `standard` and `adaptive` retry modes.
196
+ #
169
197
  # @option options [String] :profile ("default")
170
198
  # Used when loading credentials from the shared credentials file
171
199
  # at HOME/.aws/credentials. When not specified, 'default' is used.
172
200
  #
201
+ # @option options [Proc] :retry_backoff
202
+ # A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
203
+ # This option is only used in the `legacy` retry mode.
204
+ #
173
205
  # @option options [Float] :retry_base_delay (0.3)
174
- # The base delay in seconds used by the default backoff function.
206
+ # The base delay in seconds used by the default backoff function. This option
207
+ # is only used in the `legacy` retry mode.
175
208
  #
176
209
  # @option options [Symbol] :retry_jitter (:none)
177
- # A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number.
210
+ # A delay randomiser function used by the default backoff function.
211
+ # Some predefined functions can be referenced by name - :none, :equal, :full,
212
+ # otherwise a Proc that takes and returns a number. This option is only used
213
+ # in the `legacy` retry mode.
178
214
  #
179
215
  # @see https://www.awsarchitectureblog.com/2015/03/backoff.html
180
216
  #
@@ -182,11 +218,30 @@ module Aws::CostExplorer
182
218
  # The maximum number of times to retry failed requests. Only
183
219
  # ~ 500 level server errors and certain ~ 400 level client errors
184
220
  # are retried. Generally, these are throttling errors, data
185
- # checksum errors, networking errors, timeout errors and auth
186
- # errors from expired credentials.
221
+ # checksum errors, networking errors, timeout errors, auth errors,
222
+ # endpoint discovery, and errors from expired credentials.
223
+ # This option is only used in the `legacy` retry mode.
187
224
  #
188
225
  # @option options [Integer] :retry_max_delay (0)
189
- # The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function.
226
+ # The maximum number of seconds to delay between retries (0 for no limit)
227
+ # used by the default backoff function. This option is only used in the
228
+ # `legacy` retry mode.
229
+ #
230
+ # @option options [String] :retry_mode ("legacy")
231
+ # Specifies which retry algorithm to use. Values are:
232
+ #
233
+ # * `legacy` - The pre-existing retry behavior. This is default value if
234
+ # no retry mode is provided.
235
+ #
236
+ # * `standard` - A standardized set of retry rules across the AWS SDKs.
237
+ # This includes support for retry quotas, which limit the number of
238
+ # unsuccessful retries a client can make.
239
+ #
240
+ # * `adaptive` - An experimental retry mode that includes all the
241
+ # functionality of `standard` mode along with automatic client side
242
+ # throttling. This is a provisional mode that may change behavior
243
+ # in the future.
244
+ #
190
245
  #
191
246
  # @option options [String] :secret_access_key
192
247
  #
@@ -219,16 +274,16 @@ module Aws::CostExplorer
219
274
  # requests through. Formatted like 'http://proxy.com:123'.
220
275
  #
221
276
  # @option options [Float] :http_open_timeout (15) The number of
222
- # seconds to wait when opening a HTTP session before rasing a
277
+ # seconds to wait when opening a HTTP session before raising a
223
278
  # `Timeout::Error`.
224
279
  #
225
280
  # @option options [Integer] :http_read_timeout (60) The default
226
281
  # number of seconds to wait for response data. This value can
227
282
  # safely be set
228
- # per-request on the session yeidled by {#session_for}.
283
+ # per-request on the session yielded by {#session_for}.
229
284
  #
230
285
  # @option options [Float] :http_idle_timeout (5) The number of
231
- # seconds a connection is allowed to sit idble before it is
286
+ # seconds a connection is allowed to sit idle before it is
232
287
  # considered stale. Stale connections are closed and removed
233
288
  # from the pool before making a request.
234
289
  #
@@ -237,7 +292,7 @@ module Aws::CostExplorer
237
292
  # request body. This option has no effect unless the request has
238
293
  # "Expect" header set to "100-continue". Defaults to `nil` which
239
294
  # disables this behaviour. This value can safely be set per
240
- # request on the session yeidled by {#session_for}.
295
+ # request on the session yielded by {#session_for}.
241
296
  #
242
297
  # @option options [Boolean] :http_wire_trace (false) When `true`,
243
298
  # HTTP debug output will be sent to the `:logger`.
@@ -2593,7 +2648,7 @@ module Aws::CostExplorer
2593
2648
  params: params,
2594
2649
  config: config)
2595
2650
  context[:gem_name] = 'aws-sdk-costexplorer'
2596
- context[:gem_version] = '1.36.0'
2651
+ context[:gem_version] = '1.37.0'
2597
2652
  Seahorse::Client::Request.new(handlers, context)
2598
2653
  end
2599
2654
 
@@ -6,6 +6,36 @@
6
6
  # WARNING ABOUT GENERATED CODE
7
7
 
8
8
  module Aws::CostExplorer
9
+
10
+ # When CostExplorer returns an error response, the Ruby SDK constructs and raises an error.
11
+ # These errors all extend Aws::CostExplorer::Errors::ServiceError < {Aws::Errors::ServiceError}
12
+ #
13
+ # You can rescue all CostExplorer errors using ServiceError:
14
+ #
15
+ # begin
16
+ # # do stuff
17
+ # rescue Aws::CostExplorer::Errors::ServiceError
18
+ # # rescues all CostExplorer API errors
19
+ # end
20
+ #
21
+ #
22
+ # ## Request Context
23
+ # ServiceError objects have a {Aws::Errors::ServiceError#context #context} method that returns
24
+ # information about the request that generated the error.
25
+ # See {Seahorse::Client::RequestContext} for more information.
26
+ #
27
+ # ## Error Classes
28
+ # * {BillExpirationException}
29
+ # * {DataUnavailableException}
30
+ # * {InvalidNextTokenException}
31
+ # * {LimitExceededException}
32
+ # * {RequestChangedException}
33
+ # * {ResourceNotFoundException}
34
+ # * {ServiceQuotaExceededException}
35
+ # * {UnresolvableUsageUnitException}
36
+ #
37
+ # Additionally, error classes are dynamically generated for service errors based on the error code
38
+ # if they are not defined above.
9
39
  module Errors
10
40
 
11
41
  extend Aws::Errors::DynamicErrors
@@ -23,7 +53,6 @@ module Aws::CostExplorer
23
53
  def message
24
54
  @message || @data[:message]
25
55
  end
26
-
27
56
  end
28
57
 
29
58
  class DataUnavailableException < ServiceError
@@ -39,7 +68,6 @@ module Aws::CostExplorer
39
68
  def message
40
69
  @message || @data[:message]
41
70
  end
42
-
43
71
  end
44
72
 
45
73
  class InvalidNextTokenException < ServiceError
@@ -55,7 +83,6 @@ module Aws::CostExplorer
55
83
  def message
56
84
  @message || @data[:message]
57
85
  end
58
-
59
86
  end
60
87
 
61
88
  class LimitExceededException < ServiceError
@@ -71,7 +98,6 @@ module Aws::CostExplorer
71
98
  def message
72
99
  @message || @data[:message]
73
100
  end
74
-
75
101
  end
76
102
 
77
103
  class RequestChangedException < ServiceError
@@ -87,7 +113,6 @@ module Aws::CostExplorer
87
113
  def message
88
114
  @message || @data[:message]
89
115
  end
90
-
91
116
  end
92
117
 
93
118
  class ResourceNotFoundException < ServiceError
@@ -103,7 +128,6 @@ module Aws::CostExplorer
103
128
  def message
104
129
  @message || @data[:message]
105
130
  end
106
-
107
131
  end
108
132
 
109
133
  class ServiceQuotaExceededException < ServiceError
@@ -119,7 +143,6 @@ module Aws::CostExplorer
119
143
  def message
120
144
  @message || @data[:message]
121
145
  end
122
-
123
146
  end
124
147
 
125
148
  class UnresolvableUsageUnitException < ServiceError
@@ -135,7 +158,6 @@ module Aws::CostExplorer
135
158
  def message
136
159
  @message || @data[:message]
137
160
  end
138
-
139
161
  end
140
162
 
141
163
  end
@@ -6,6 +6,13 @@
6
6
  # WARNING ABOUT GENERATED CODE
7
7
 
8
8
  module Aws::CostExplorer
9
+ # This class provides a resource oriented interface for CostExplorer.
10
+ # To create a resource object:
11
+ # resource = Aws::CostExplorer::Resource.new(region: 'us-west-2')
12
+ # You can supply a client object with custom configuration that will be used for all resource operations.
13
+ # If you do not pass +:client+, a default client will be constructed.
14
+ # client = Aws::CostExplorer::Client.new(region: 'us-west-2')
15
+ # resource = Aws::CostExplorer::Resource.new(client: client)
9
16
  class Resource
10
17
 
11
18
  # @param options ({})
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-costexplorer
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.36.0
4
+ version: 1.37.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Amazon Web Services
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2020-01-08 00:00:00.000000000 Z
11
+ date: 2020-03-16 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core
@@ -80,8 +80,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
80
80
  - !ruby/object:Gem::Version
81
81
  version: '0'
82
82
  requirements: []
83
- rubyforge_project:
84
- rubygems_version: 2.5.2.3
83
+ rubygems_version: 3.0.3
85
84
  signing_key:
86
85
  specification_version: 4
87
86
  summary: AWS SDK for Ruby - AWS Cost Explorer