aws-sdk-acmpca 1.21.0 → 1.22.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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 49697f0918aaa2da699a8fc2ce2e3d0f34cb55ed
4
- data.tar.gz: a7186f55a46d578500e963112c8ea8a20bc55224
3
+ metadata.gz: aa2980e530b18e404e5a14352b8dfd635362fb2d
4
+ data.tar.gz: 1f4e685556868c14566a5ce3d5fcde59f169d552
5
5
  SHA512:
6
- metadata.gz: e5469d60f1d2826da2686419d19d6960e842e55e52a9ca96458f509c3afecf0f185255dc11bac6790b8eeb9cf9141b4c746bd2a72756af759932a6c2b908b2d4
7
- data.tar.gz: 79f8c59be7ca44c33787396f37f2837451840876d4219ba7eadc8175fdf2bd18a78567903d25acbce02b1748a277b1b536c6b16d5e6dd33bd34b218a382a8f4a
6
+ metadata.gz: 7a60edee8f9065d0aa94be18ac3ed6d9849e6173cc60fd05615254356da2ddd78800842a6433f618fcf5d2290944f90d147dc0ee603bbbff92e529a9832c06ac
7
+ data.tar.gz: bc0994540500e634a26ea6e14b2234dfe5aa3f6c0d4f083f984db32511a3f58dea8b8f1f7a9eafbac995c13459c072693abf3b23dcfa2a6f983940f7dc82d2f6
@@ -25,17 +25,20 @@ require_relative 'aws-sdk-acmpca/customizations'
25
25
  # methods each accept a hash of request parameters and return a response
26
26
  # structure.
27
27
  #
28
+ # acmpca = Aws::ACMPCA::Client.new
29
+ # resp = acmpca.create_certificate_authority(params)
30
+ #
28
31
  # See {Client} for more information.
29
32
  #
30
33
  # # Errors
31
34
  #
32
- # Errors returned from AWS Certificate Manager Private Certificate Authority all
33
- # extend {Errors::ServiceError}.
35
+ # Errors returned from AWS Certificate Manager Private Certificate Authority are defined in the
36
+ # {Errors} module and all extend {Errors::ServiceError}.
34
37
  #
35
38
  # begin
36
39
  # # do stuff
37
40
  # rescue Aws::ACMPCA::Errors::ServiceError
38
- # # rescues all service API errors
41
+ # # rescues all AWS Certificate Manager Private Certificate Authority API errors
39
42
  # end
40
43
  #
41
44
  # See {Errors} for more information.
@@ -43,6 +46,6 @@ require_relative 'aws-sdk-acmpca/customizations'
43
46
  # @service
44
47
  module Aws::ACMPCA
45
48
 
46
- GEM_VERSION = '1.21.0'
49
+ GEM_VERSION = '1.22.0'
47
50
 
48
51
  end
@@ -30,6 +30,18 @@ require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
30
30
  Aws::Plugins::GlobalConfiguration.add_identifier(:acmpca)
31
31
 
32
32
  module Aws::ACMPCA
33
+ # An API client for ACMPCA. To construct a client, you need to configure a `:region` and `:credentials`.
34
+ #
35
+ # client = Aws::ACMPCA::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::ACMPCA
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::ACMPCA
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::ACMPCA
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,26 @@ module Aws::ACMPCA
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
+ # * `legacy` - The pre-existing retry behavior. This is default value if
233
+ # no retry mode is provided.
234
+ # * `standard` - A standardized set of retry rules across the AWS SDKs.
235
+ # This includes support for retry quotas, which limit the number of
236
+ # unsuccessful retries a client can make.
237
+ # * `adaptive` - An experimental retry mode that includes all the
238
+ # functionality of `standard` mode along with automatic client side
239
+ # throttling. This is a provisional mode that may change behavior
240
+ # in the future.
190
241
  #
191
242
  # @option options [String] :secret_access_key
192
243
  #
@@ -219,16 +270,16 @@ module Aws::ACMPCA
219
270
  # requests through. Formatted like 'http://proxy.com:123'.
220
271
  #
221
272
  # @option options [Float] :http_open_timeout (15) The number of
222
- # seconds to wait when opening a HTTP session before rasing a
273
+ # seconds to wait when opening a HTTP session before raising a
223
274
  # `Timeout::Error`.
224
275
  #
225
276
  # @option options [Integer] :http_read_timeout (60) The default
226
277
  # number of seconds to wait for response data. This value can
227
278
  # safely be set
228
- # per-request on the session yeidled by {#session_for}.
279
+ # per-request on the session yielded by {#session_for}.
229
280
  #
230
281
  # @option options [Float] :http_idle_timeout (5) The number of
231
- # seconds a connection is allowed to sit idble before it is
282
+ # seconds a connection is allowed to sit idle before it is
232
283
  # considered stale. Stale connections are closed and removed
233
284
  # from the pool before making a request.
234
285
  #
@@ -237,7 +288,7 @@ module Aws::ACMPCA
237
288
  # request body. This option has no effect unless the request has
238
289
  # "Expect" header set to "100-continue". Defaults to `nil` which
239
290
  # disables this behaviour. This value can safely be set per
240
- # request on the session yeidled by {#session_for}.
291
+ # request on the session yielded by {#session_for}.
241
292
  #
242
293
  # @option options [Boolean] :http_wire_trace (false) When `true`,
243
294
  # HTTP debug output will be sent to the `:logger`.
@@ -1434,7 +1485,7 @@ module Aws::ACMPCA
1434
1485
  params: params,
1435
1486
  config: config)
1436
1487
  context[:gem_name] = 'aws-sdk-acmpca'
1437
- context[:gem_version] = '1.21.0'
1488
+ context[:gem_version] = '1.22.0'
1438
1489
  Seahorse::Client::Request.new(handlers, context)
1439
1490
  end
1440
1491
 
@@ -6,6 +6,46 @@
6
6
  # WARNING ABOUT GENERATED CODE
7
7
 
8
8
  module Aws::ACMPCA
9
+
10
+ # When ACMPCA returns an error response, the Ruby SDK constructs and raises an error.
11
+ # These errors all extend Aws::ACMPCA::Errors::ServiceError < {Aws::Errors::ServiceError}
12
+ #
13
+ # You can rescue all ACMPCA errors using ServiceError:
14
+ #
15
+ # begin
16
+ # # do stuff
17
+ # rescue Aws::ACMPCA::Errors::ServiceError
18
+ # # rescues all ACMPCA 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
+ # * {CertificateMismatchException}
29
+ # * {ConcurrentModificationException}
30
+ # * {InvalidArgsException}
31
+ # * {InvalidArnException}
32
+ # * {InvalidNextTokenException}
33
+ # * {InvalidPolicyException}
34
+ # * {InvalidRequestException}
35
+ # * {InvalidStateException}
36
+ # * {InvalidTagException}
37
+ # * {LimitExceededException}
38
+ # * {MalformedCSRException}
39
+ # * {MalformedCertificateException}
40
+ # * {PermissionAlreadyExistsException}
41
+ # * {RequestAlreadyProcessedException}
42
+ # * {RequestFailedException}
43
+ # * {RequestInProgressException}
44
+ # * {ResourceNotFoundException}
45
+ # * {TooManyTagsException}
46
+ #
47
+ # Additionally, error classes are dynamically generated for service errors based on the error code
48
+ # if they are not defined above.
9
49
  module Errors
10
50
 
11
51
  extend Aws::Errors::DynamicErrors
@@ -23,7 +63,6 @@ module Aws::ACMPCA
23
63
  def message
24
64
  @message || @data[:message]
25
65
  end
26
-
27
66
  end
28
67
 
29
68
  class ConcurrentModificationException < ServiceError
@@ -39,7 +78,6 @@ module Aws::ACMPCA
39
78
  def message
40
79
  @message || @data[:message]
41
80
  end
42
-
43
81
  end
44
82
 
45
83
  class InvalidArgsException < ServiceError
@@ -55,7 +93,6 @@ module Aws::ACMPCA
55
93
  def message
56
94
  @message || @data[:message]
57
95
  end
58
-
59
96
  end
60
97
 
61
98
  class InvalidArnException < ServiceError
@@ -71,7 +108,6 @@ module Aws::ACMPCA
71
108
  def message
72
109
  @message || @data[:message]
73
110
  end
74
-
75
111
  end
76
112
 
77
113
  class InvalidNextTokenException < ServiceError
@@ -87,7 +123,6 @@ module Aws::ACMPCA
87
123
  def message
88
124
  @message || @data[:message]
89
125
  end
90
-
91
126
  end
92
127
 
93
128
  class InvalidPolicyException < ServiceError
@@ -103,7 +138,6 @@ module Aws::ACMPCA
103
138
  def message
104
139
  @message || @data[:message]
105
140
  end
106
-
107
141
  end
108
142
 
109
143
  class InvalidRequestException < ServiceError
@@ -119,7 +153,6 @@ module Aws::ACMPCA
119
153
  def message
120
154
  @message || @data[:message]
121
155
  end
122
-
123
156
  end
124
157
 
125
158
  class InvalidStateException < ServiceError
@@ -135,7 +168,6 @@ module Aws::ACMPCA
135
168
  def message
136
169
  @message || @data[:message]
137
170
  end
138
-
139
171
  end
140
172
 
141
173
  class InvalidTagException < ServiceError
@@ -151,7 +183,6 @@ module Aws::ACMPCA
151
183
  def message
152
184
  @message || @data[:message]
153
185
  end
154
-
155
186
  end
156
187
 
157
188
  class LimitExceededException < ServiceError
@@ -167,7 +198,6 @@ module Aws::ACMPCA
167
198
  def message
168
199
  @message || @data[:message]
169
200
  end
170
-
171
201
  end
172
202
 
173
203
  class MalformedCSRException < ServiceError
@@ -183,7 +213,6 @@ module Aws::ACMPCA
183
213
  def message
184
214
  @message || @data[:message]
185
215
  end
186
-
187
216
  end
188
217
 
189
218
  class MalformedCertificateException < ServiceError
@@ -199,7 +228,6 @@ module Aws::ACMPCA
199
228
  def message
200
229
  @message || @data[:message]
201
230
  end
202
-
203
231
  end
204
232
 
205
233
  class PermissionAlreadyExistsException < ServiceError
@@ -215,7 +243,6 @@ module Aws::ACMPCA
215
243
  def message
216
244
  @message || @data[:message]
217
245
  end
218
-
219
246
  end
220
247
 
221
248
  class RequestAlreadyProcessedException < ServiceError
@@ -231,7 +258,6 @@ module Aws::ACMPCA
231
258
  def message
232
259
  @message || @data[:message]
233
260
  end
234
-
235
261
  end
236
262
 
237
263
  class RequestFailedException < ServiceError
@@ -247,7 +273,6 @@ module Aws::ACMPCA
247
273
  def message
248
274
  @message || @data[:message]
249
275
  end
250
-
251
276
  end
252
277
 
253
278
  class RequestInProgressException < ServiceError
@@ -263,7 +288,6 @@ module Aws::ACMPCA
263
288
  def message
264
289
  @message || @data[:message]
265
290
  end
266
-
267
291
  end
268
292
 
269
293
  class ResourceNotFoundException < ServiceError
@@ -279,7 +303,6 @@ module Aws::ACMPCA
279
303
  def message
280
304
  @message || @data[:message]
281
305
  end
282
-
283
306
  end
284
307
 
285
308
  class TooManyTagsException < ServiceError
@@ -295,7 +318,6 @@ module Aws::ACMPCA
295
318
  def message
296
319
  @message || @data[:message]
297
320
  end
298
-
299
321
  end
300
322
 
301
323
  end
@@ -6,6 +6,13 @@
6
6
  # WARNING ABOUT GENERATED CODE
7
7
 
8
8
  module Aws::ACMPCA
9
+ # This class provides a resource oriented interface for ACMPCA.
10
+ # To create a resource object:
11
+ # resource = Aws::ACMPCA::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::ACMPCA::Client.new(region: 'us-west-2')
15
+ # resource = Aws::ACMPCA::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-acmpca
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.21.0
4
+ version: 1.22.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: 2019-10-23 00:00:00.000000000 Z
11
+ date: 2020-03-09 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core