aws-sdk-acmpca 1.22.0 → 1.23.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
- SHA1:
3
- metadata.gz: aa2980e530b18e404e5a14352b8dfd635362fb2d
4
- data.tar.gz: 1f4e685556868c14566a5ce3d5fcde59f169d552
2
+ SHA256:
3
+ metadata.gz: 96bf9124c470f2e12df5e965c22a0f2f6b7c153da97223aa8a207c0c2675e9dc
4
+ data.tar.gz: 6c4adf43abe38b03f28f3f101ae4daee37c2a9bb6be5c65e8d65b7e72a6fc9e3
5
5
  SHA512:
6
- metadata.gz: 7a60edee8f9065d0aa94be18ac3ed6d9849e6173cc60fd05615254356da2ddd78800842a6433f618fcf5d2290944f90d147dc0ee603bbbff92e529a9832c06ac
7
- data.tar.gz: bc0994540500e634a26ea6e14b2234dfe5aa3f6c0d4f083f984db32511a3f58dea8b8f1f7a9eafbac995c13459c072693abf3b23dcfa2a6f983940f7dc82d2f6
6
+ metadata.gz: de40d07c0fb2b7f33732b7015b072a7718503be52746f12a063676dd81865db6327d1bdd321e8faf0b3f3c4fd2bc7b3ec77f7d1efe367666391b026474a84b18
7
+ data.tar.gz: d553fcdb8a4f85a5ba19fae916f1d8d7bead9634bfa7b3996cdfbb18ac02ab331c1809bf61148258614768603c303784ff248fc95641f0e2d9dec344dc64e42f
@@ -46,6 +46,6 @@ require_relative 'aws-sdk-acmpca/customizations'
46
46
  # @service
47
47
  module Aws::ACMPCA
48
48
 
49
- GEM_VERSION = '1.22.0'
49
+ GEM_VERSION = '1.23.0'
50
50
 
51
51
  end
@@ -32,11 +32,11 @@ Aws::Plugins::GlobalConfiguration.add_identifier(:acmpca)
32
32
  module Aws::ACMPCA
33
33
  # An API client for ACMPCA. To construct a client, you need to configure a `:region` and `:credentials`.
34
34
  #
35
- # client = Aws::ACMPCA::Client.new(
36
- # region: region_name,
37
- # credentials: credentials,
38
- # # ...
39
- # )
35
+ # client = Aws::ACMPCA::Client.new(
36
+ # region: region_name,
37
+ # credentials: credentials,
38
+ # # ...
39
+ # )
40
40
  #
41
41
  # For details on configuring region and credentials see
42
42
  # the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
@@ -105,7 +105,7 @@ module Aws::ACMPCA
105
105
  # @option options [required, String] :region
106
106
  # The AWS region to connect to. The configured `:region` is
107
107
  # used to determine the service `:endpoint`. When not passed,
108
- # a default `:region` is search for in the following locations:
108
+ # a default `:region` is searched for in the following locations:
109
109
  #
110
110
  # * `Aws.config[:region]`
111
111
  # * `ENV['AWS_REGION']`
@@ -161,7 +161,7 @@ module Aws::ACMPCA
161
161
  # @option options [String] :endpoint
162
162
  # The client endpoint is normally constructed from the `:region`
163
163
  # option. You should only configure an `:endpoint` when connecting
164
- # to test endpoints. This should be avalid HTTP(S) URI.
164
+ # to test endpoints. This should be a valid HTTP(S) URI.
165
165
  #
166
166
  # @option options [Integer] :endpoint_cache_max_entries (1000)
167
167
  # Used for the maximum size limit of the LRU cache storing endpoints data
@@ -229,15 +229,19 @@ module Aws::ACMPCA
229
229
  #
230
230
  # @option options [String] :retry_mode ("legacy")
231
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.
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
+ #
241
245
  #
242
246
  # @option options [String] :secret_access_key
243
247
  #
@@ -275,8 +279,7 @@ module Aws::ACMPCA
275
279
  #
276
280
  # @option options [Integer] :http_read_timeout (60) The default
277
281
  # number of seconds to wait for response data. This value can
278
- # safely be set
279
- # per-request on the session yielded by {#session_for}.
282
+ # safely be set per-request on the session.
280
283
  #
281
284
  # @option options [Float] :http_idle_timeout (5) The number of
282
285
  # seconds a connection is allowed to sit idle before it is
@@ -288,7 +291,7 @@ module Aws::ACMPCA
288
291
  # request body. This option has no effect unless the request has
289
292
  # "Expect" header set to "100-continue". Defaults to `nil` which
290
293
  # disables this behaviour. This value can safely be set per
291
- # request on the session yielded by {#session_for}.
294
+ # request on the session.
292
295
  #
293
296
  # @option options [Boolean] :http_wire_trace (false) When `true`,
294
297
  # HTTP debug output will be sent to the `:logger`.
@@ -739,6 +742,11 @@ module Aws::ACMPCA
739
742
  # resp.s3_key #=> String
740
743
  # resp.created_at #=> Time
741
744
  #
745
+ #
746
+ # The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
747
+ #
748
+ # * audit_report_created
749
+ #
742
750
  # @see http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/DescribeCertificateAuthorityAuditReport AWS API Documentation
743
751
  #
744
752
  # @overload describe_certificate_authority_audit_report(params = {})
@@ -788,6 +796,11 @@ module Aws::ACMPCA
788
796
  # resp.certificate #=> String
789
797
  # resp.certificate_chain #=> String
790
798
  #
799
+ #
800
+ # The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
801
+ #
802
+ # * certificate_issued
803
+ #
791
804
  # @see http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/GetCertificate AWS API Documentation
792
805
  #
793
806
  # @overload get_certificate(params = {})
@@ -863,6 +876,11 @@ module Aws::ACMPCA
863
876
  #
864
877
  # resp.csr #=> String
865
878
  #
879
+ #
880
+ # The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
881
+ #
882
+ # * certificate_authority_csr_created
883
+ #
866
884
  # @see http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/GetCertificateAuthorityCsr AWS API Documentation
867
885
  #
868
886
  # @overload get_certificate_authority_csr(params = {})
@@ -1077,6 +1095,8 @@ module Aws::ACMPCA
1077
1095
  # * {Types::ListCertificateAuthoritiesResponse#certificate_authorities #certificate_authorities} => Array<Types::CertificateAuthority>
1078
1096
  # * {Types::ListCertificateAuthoritiesResponse#next_token #next_token} => String
1079
1097
  #
1098
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1099
+ #
1080
1100
  # @example Request syntax with placeholder values
1081
1101
  #
1082
1102
  # resp = client.list_certificate_authorities({
@@ -1157,6 +1177,8 @@ module Aws::ACMPCA
1157
1177
  # * {Types::ListPermissionsResponse#permissions #permissions} => Array<Types::Permission>
1158
1178
  # * {Types::ListPermissionsResponse#next_token #next_token} => String
1159
1179
  #
1180
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1181
+ #
1160
1182
  # @example Request syntax with placeholder values
1161
1183
  #
1162
1184
  # resp = client.list_permissions({
@@ -1216,6 +1238,8 @@ module Aws::ACMPCA
1216
1238
  # * {Types::ListTagsResponse#tags #tags} => Array<Types::Tag>
1217
1239
  # * {Types::ListTagsResponse#next_token #next_token} => String
1218
1240
  #
1241
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1242
+ #
1219
1243
  # @example Request syntax with placeholder values
1220
1244
  #
1221
1245
  # resp = client.list_tags({
@@ -1485,7 +1509,7 @@ module Aws::ACMPCA
1485
1509
  params: params,
1486
1510
  config: config)
1487
1511
  context[:gem_name] = 'aws-sdk-acmpca'
1488
- context[:gem_version] = '1.22.0'
1512
+ context[:gem_version] = '1.23.0'
1489
1513
  Seahorse::Client::Request.new(handlers, context)
1490
1514
  end
1491
1515
 
@@ -1551,11 +1575,11 @@ module Aws::ACMPCA
1551
1575
  # The following table lists the valid waiter names, the operations they call,
1552
1576
  # and the default `:delay` and `:max_attempts` values.
1553
1577
  #
1554
- # | waiter_name | params | :delay | :max_attempts |
1555
- # | --------------------------------- | ---------------------------------------------- | -------- | ------------- |
1556
- # | audit_report_created | {#describe_certificate_authority_audit_report} | 3 | 60 |
1557
- # | certificate_authority_csr_created | {#get_certificate_authority_csr} | 3 | 60 |
1558
- # | certificate_issued | {#get_certificate} | 3 | 60 |
1578
+ # | waiter_name | params | :delay | :max_attempts |
1579
+ # | --------------------------------- | ---------------------------------------------------- | -------- | ------------- |
1580
+ # | audit_report_created | {Client#describe_certificate_authority_audit_report} | 3 | 60 |
1581
+ # | certificate_authority_csr_created | {Client#get_certificate_authority_csr} | 3 | 60 |
1582
+ # | certificate_issued | {Client#get_certificate} | 3 | 60 |
1559
1583
  #
1560
1584
  # @raise [Errors::FailureStateError] Raised when the waiter terminates
1561
1585
  # because the waiter has entered a state that it will not transition
@@ -6,13 +6,7 @@
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
10
  class Resource
17
11
 
18
12
  # @param options ({})
@@ -8,6 +8,69 @@
8
8
  require 'aws-sdk-core/waiters'
9
9
 
10
10
  module Aws::ACMPCA
11
+ # Waiters are utility methods that poll for a particular state to occur
12
+ # on a client. Waiters can fail after a number of attempts at a polling
13
+ # interval defined for the service client.
14
+ #
15
+ # For a list of operations that can be waited for and the
16
+ # client methods called for each operation, see the table below or the
17
+ # {Client#wait_until} field documentation for the {Client}.
18
+ #
19
+ # # Invoking a Waiter
20
+ # To invoke a waiter, call #wait_until on a {Client}. The first parameter
21
+ # is the waiter name, which is specific to the service client and indicates
22
+ # which operation is being waited for. The second parameter is a hash of
23
+ # parameters that are passed to the client method called by the waiter,
24
+ # which varies according to the waiter name.
25
+ #
26
+ # # Wait Failures
27
+ # To catch errors in a waiter, use WaiterFailed,
28
+ # as shown in the following example.
29
+ #
30
+ # rescue rescue Aws::Waiters::Errors::WaiterFailed => error
31
+ # puts "failed waiting for instance running: #{error.message}
32
+ # end
33
+ #
34
+ # # Configuring a Waiter
35
+ # Each waiter has a default polling interval and a maximum number of
36
+ # attempts it will make before returning control to your program.
37
+ # To set these values, use the `max_attempts` and `delay` parameters
38
+ # in your `#wait_until` call.
39
+ # The following example waits for up to 25 seconds, polling every five seconds.
40
+ #
41
+ # client.wait_until(...) do |w|
42
+ # w.max_attempts = 5
43
+ # w.delay = 5
44
+ # end
45
+ #
46
+ # To disable wait failures, set the value of either of these parameters
47
+ # to `nil`.
48
+ #
49
+ # # Extending a Waiter
50
+ # To modify the behavior of waiters, you can register callbacks that are
51
+ # triggered before each polling attempt and before waiting.
52
+ #
53
+ # The following example implements an exponential backoff in a waiter
54
+ # by doubling the amount of time to wait on every attempt.
55
+ #
56
+ # client.wait_until(...) do |w|
57
+ # w.interval = 0 # disable normal sleep
58
+ # w.before_wait do |n, resp|
59
+ # sleep(n ** 2)
60
+ # end
61
+ # end
62
+ #
63
+ # # Available Waiters
64
+ #
65
+ # The following table lists the valid waiter names, the operations they call,
66
+ # and the default `:delay` and `:max_attempts` values.
67
+ #
68
+ # | waiter_name | params | :delay | :max_attempts |
69
+ # | --------------------------------- | ---------------------------------------------------- | -------- | ------------- |
70
+ # | audit_report_created | {Client#describe_certificate_authority_audit_report} | 3 | 60 |
71
+ # | certificate_authority_csr_created | {Client#get_certificate_authority_csr} | 3 | 60 |
72
+ # | certificate_issued | {Client#get_certificate} | 3 | 60 |
73
+ #
11
74
  module Waiters
12
75
 
13
76
  # Wait until a Audit Report is created
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.22.0
4
+ version: 1.23.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-03-09 00:00:00.000000000 Z
11
+ date: 2020-05-07 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core
@@ -82,7 +82,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
82
82
  version: '0'
83
83
  requirements: []
84
84
  rubyforge_project:
85
- rubygems_version: 2.5.2.3
85
+ rubygems_version: 2.7.6.2
86
86
  signing_key:
87
87
  specification_version: 4
88
88
  summary: AWS SDK for Ruby - ACM-PCA