aws-sdk-glacier 1.26.0 → 1.31.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: 8b1a34ce0557362251e81d5c40e56bd82f88f9fb
4
- data.tar.gz: a82a6a1393d38461263dd9b1dce7c98e69976fec
2
+ SHA256:
3
+ metadata.gz: 1243a66d38961202798d6ec698cf89923db0b6ad1e97f9bbe2c0a41a6bdbc324
4
+ data.tar.gz: 56ab24f37377087091d744e2bf031f63e3cc8d67e9130b8cbce2d477aec73d90
5
5
  SHA512:
6
- metadata.gz: f180c785206f04f08a8c3e0e10489201f735dfd8c9134a4a284f0920d203f96ee5021f614059d7f373dd2570dba497f8cfa175e670abe6c5bdc02207793d13c5
7
- data.tar.gz: 3fedd4d23221c1953b30f0ae631b678d77bf92dd91a482bbf5de02abd78c0437159fa67e892a3a2dd9eae6065898debf5c7e058824f1e385579a0a47e96b4f59
6
+ metadata.gz: 2f8ee190637997937eb6eac8886295d620169243883deaf45b1c8d06ef36f78506452f2621c830dc0b0ed684e88fb7e70133274ae704005985584c3427c3c867
7
+ data.tar.gz: 331d152eb22229bb8aa12981f87cee912747aee8884355c4ca96994da2bcf3f5f7c8e647bed07089351b4fab3f17fa645314395fefc99b6d0be7d63437068f16
@@ -1,3 +1,5 @@
1
+ # frozen_string_literal: true
2
+
1
3
  # WARNING ABOUT GENERATED CODE
2
4
  #
3
5
  # This file is generated. See the contributing guide for more information:
@@ -31,17 +33,20 @@ require_relative 'aws-sdk-glacier/customizations'
31
33
  # methods each accept a hash of request parameters and return a response
32
34
  # structure.
33
35
  #
36
+ # glacier = Aws::Glacier::Client.new
37
+ # resp = glacier.abort_multipart_upload(params)
38
+ #
34
39
  # See {Client} for more information.
35
40
  #
36
41
  # # Errors
37
42
  #
38
- # Errors returned from Amazon Glacier all
39
- # extend {Errors::ServiceError}.
43
+ # Errors returned from Amazon Glacier are defined in the
44
+ # {Errors} module and all extend {Errors::ServiceError}.
40
45
  #
41
46
  # begin
42
47
  # # do stuff
43
48
  # rescue Aws::Glacier::Errors::ServiceError
44
- # # rescues all service API errors
49
+ # # rescues all Amazon Glacier API errors
45
50
  # end
46
51
  #
47
52
  # See {Errors} for more information.
@@ -49,6 +54,6 @@ require_relative 'aws-sdk-glacier/customizations'
49
54
  # @service
50
55
  module Aws::Glacier
51
56
 
52
- GEM_VERSION = '1.26.0'
57
+ GEM_VERSION = '1.31.0'
53
58
 
54
59
  end
@@ -1,3 +1,5 @@
1
+ # frozen_string_literal: true
2
+
1
3
  # WARNING ABOUT GENERATED CODE
2
4
  #
3
5
  # This file is generated. See the contributing guide for more information:
@@ -6,6 +8,7 @@
6
8
  # WARNING ABOUT GENERATED CODE
7
9
 
8
10
  module Aws::Glacier
11
+
9
12
  class Account
10
13
 
11
14
  extend Aws::Deprecations
@@ -21,6 +24,7 @@ module Aws::Glacier
21
24
  @id = extract_id(args, options)
22
25
  @data = Aws::EmptyStructure.new
23
26
  @client = options.delete(:client) || Client.new(options)
27
+ @waiter_block_warned = false
24
28
  end
25
29
 
26
30
  # @!group Read-Only Attributes
@@ -63,7 +67,8 @@ module Aws::Glacier
63
67
  # Waiter polls an API operation until a resource enters a desired
64
68
  # state.
65
69
  #
66
- # @note The waiting operation is performed on a copy. The original resource remains unchanged
70
+ # @note The waiting operation is performed on a copy. The original resource
71
+ # remains unchanged.
67
72
  #
68
73
  # ## Basic Usage
69
74
  #
@@ -76,13 +81,15 @@ module Aws::Glacier
76
81
  #
77
82
  # ## Example
78
83
  #
79
- # instance.wait_until(max_attempts:10, delay:5) {|instance| instance.state.name == 'running' }
84
+ # instance.wait_until(max_attempts:10, delay:5) do |instance|
85
+ # instance.state.name == 'running'
86
+ # end
80
87
  #
81
88
  # ## Configuration
82
89
  #
83
90
  # You can configure the maximum number of polling attempts, and the
84
- # delay (in seconds) between each polling attempt. The waiting condition is set
85
- # by passing a block to {#wait_until}:
91
+ # delay (in seconds) between each polling attempt. The waiting condition is
92
+ # set by passing a block to {#wait_until}:
86
93
  #
87
94
  # # poll for ~25 seconds
88
95
  # resource.wait_until(max_attempts:5,delay:5) {|resource|...}
@@ -113,17 +120,16 @@ module Aws::Glacier
113
120
  # # resource did not enter the desired state in time
114
121
  # end
115
122
  #
123
+ # @yieldparam [Resource] resource to be used in the waiting condition.
116
124
  #
117
- # @yield param [Resource] resource to be used in the waiting condition
118
- #
119
- # @raise [Aws::Waiters::Errors::FailureStateError] Raised when the waiter terminates
120
- # because the waiter has entered a state that it will not transition
121
- # out of, preventing success.
125
+ # @raise [Aws::Waiters::Errors::FailureStateError] Raised when the waiter
126
+ # terminates because the waiter has entered a state that it will not
127
+ # transition out of, preventing success.
122
128
  #
123
129
  # yet successful.
124
130
  #
125
- # @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is encountered
126
- # while polling for a resource that is not expected.
131
+ # @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is
132
+ # encountered while polling for a resource that is not expected.
127
133
  #
128
134
  # @raise [NotImplementedError] Raised when the resource does not
129
135
  #
@@ -166,7 +172,7 @@ module Aws::Glacier
166
172
  # @return [Vault]
167
173
  def create_vault(options = {})
168
174
  options = options.merge(account_id: @id)
169
- resp = @client.create_vault(options)
175
+ @client.create_vault(options)
170
176
  Vault.new(
171
177
  account_id: @id,
172
178
  name: options[:vault_name],
@@ -1,3 +1,5 @@
1
+ # frozen_string_literal: true
2
+
1
3
  # WARNING ABOUT GENERATED CODE
2
4
  #
3
5
  # This file is generated. See the contributing guide for more information:
@@ -6,6 +8,7 @@
6
8
  # WARNING ABOUT GENERATED CODE
7
9
 
8
10
  module Aws::Glacier
11
+
9
12
  class Archive
10
13
 
11
14
  extend Aws::Deprecations
@@ -27,6 +30,7 @@ module Aws::Glacier
27
30
  @id = extract_id(args, options)
28
31
  @data = Aws::EmptyStructure.new
29
32
  @client = options.delete(:client) || Client.new(options)
33
+ @waiter_block_warned = false
30
34
  end
31
35
 
32
36
  # @!group Read-Only Attributes
@@ -79,7 +83,8 @@ module Aws::Glacier
79
83
  # Waiter polls an API operation until a resource enters a desired
80
84
  # state.
81
85
  #
82
- # @note The waiting operation is performed on a copy. The original resource remains unchanged
86
+ # @note The waiting operation is performed on a copy. The original resource
87
+ # remains unchanged.
83
88
  #
84
89
  # ## Basic Usage
85
90
  #
@@ -92,13 +97,15 @@ module Aws::Glacier
92
97
  #
93
98
  # ## Example
94
99
  #
95
- # instance.wait_until(max_attempts:10, delay:5) {|instance| instance.state.name == 'running' }
100
+ # instance.wait_until(max_attempts:10, delay:5) do |instance|
101
+ # instance.state.name == 'running'
102
+ # end
96
103
  #
97
104
  # ## Configuration
98
105
  #
99
106
  # You can configure the maximum number of polling attempts, and the
100
- # delay (in seconds) between each polling attempt. The waiting condition is set
101
- # by passing a block to {#wait_until}:
107
+ # delay (in seconds) between each polling attempt. The waiting condition is
108
+ # set by passing a block to {#wait_until}:
102
109
  #
103
110
  # # poll for ~25 seconds
104
111
  # resource.wait_until(max_attempts:5,delay:5) {|resource|...}
@@ -129,17 +136,16 @@ module Aws::Glacier
129
136
  # # resource did not enter the desired state in time
130
137
  # end
131
138
  #
139
+ # @yieldparam [Resource] resource to be used in the waiting condition.
132
140
  #
133
- # @yield param [Resource] resource to be used in the waiting condition
134
- #
135
- # @raise [Aws::Waiters::Errors::FailureStateError] Raised when the waiter terminates
136
- # because the waiter has entered a state that it will not transition
137
- # out of, preventing success.
141
+ # @raise [Aws::Waiters::Errors::FailureStateError] Raised when the waiter
142
+ # terminates because the waiter has entered a state that it will not
143
+ # transition out of, preventing success.
138
144
  #
139
145
  # yet successful.
140
146
  #
141
- # @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is encountered
142
- # while polling for a resource that is not expected.
147
+ # @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is
148
+ # encountered while polling for a resource that is not expected.
143
149
  #
144
150
  # @raise [NotImplementedError] Raised when the resource does not
145
151
  #
@@ -1,3 +1,5 @@
1
+ # frozen_string_literal: true
2
+
1
3
  # WARNING ABOUT GENERATED CODE
2
4
  #
3
5
  # This file is generated. See the contributing guide for more information:
@@ -24,6 +26,7 @@ require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
24
26
  require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
25
27
  require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
26
28
  require 'aws-sdk-core/plugins/transfer_encoding.rb'
29
+ require 'aws-sdk-core/plugins/http_checksum.rb'
27
30
  require 'aws-sdk-core/plugins/signature_v4.rb'
28
31
  require 'aws-sdk-core/plugins/protocols/rest_json.rb'
29
32
  require 'aws-sdk-glacier/plugins/account_id.rb'
@@ -33,6 +36,18 @@ require 'aws-sdk-glacier/plugins/checksums.rb'
33
36
  Aws::Plugins::GlobalConfiguration.add_identifier(:glacier)
34
37
 
35
38
  module Aws::Glacier
39
+ # An API client for Glacier. To construct a client, you need to configure a `:region` and `:credentials`.
40
+ #
41
+ # client = Aws::Glacier::Client.new(
42
+ # region: region_name,
43
+ # credentials: credentials,
44
+ # # ...
45
+ # )
46
+ #
47
+ # For details on configuring region and credentials see
48
+ # the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
49
+ #
50
+ # See {#initialize} for a full list of supported configuration options.
36
51
  class Client < Seahorse::Client::Base
37
52
 
38
53
  include Aws::ClientStubs
@@ -60,6 +75,7 @@ module Aws::Glacier
60
75
  add_plugin(Aws::Plugins::ClientMetricsPlugin)
61
76
  add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
62
77
  add_plugin(Aws::Plugins::TransferEncoding)
78
+ add_plugin(Aws::Plugins::HttpChecksum)
63
79
  add_plugin(Aws::Plugins::SignatureV4)
64
80
  add_plugin(Aws::Plugins::Protocols::RestJson)
65
81
  add_plugin(Aws::Glacier::Plugins::AccountId)
@@ -99,7 +115,7 @@ module Aws::Glacier
99
115
  # @option options [required, String] :region
100
116
  # The AWS region to connect to. The configured `:region` is
101
117
  # used to determine the service `:endpoint`. When not passed,
102
- # a default `:region` is search for in the following locations:
118
+ # a default `:region` is searched for in the following locations:
103
119
  #
104
120
  # * `Aws.config[:region]`
105
121
  # * `ENV['AWS_REGION']`
@@ -119,6 +135,12 @@ module Aws::Glacier
119
135
  # When set to `true`, a thread polling for endpoints will be running in
120
136
  # the background every 60 secs (default). Defaults to `false`.
121
137
  #
138
+ # @option options [Boolean] :adaptive_retry_wait_to_fill (true)
139
+ # Used only in `adaptive` retry mode. When true, the request will sleep
140
+ # until there is sufficent client side capacity to retry the request.
141
+ # When false, the request will raise a `RetryCapacityNotAvailableError` and will
142
+ # not retry instead of sleeping.
143
+ #
122
144
  # @option options [Boolean] :client_side_monitoring (false)
123
145
  # When `true`, client-side metrics will be collected for all API requests from
124
146
  # this client.
@@ -143,6 +165,10 @@ module Aws::Glacier
143
165
  # When `true`, an attempt is made to coerce request parameters into
144
166
  # the required types.
145
167
  #
168
+ # @option options [Boolean] :correct_clock_skew (true)
169
+ # Used only in `standard` and adaptive retry modes. Specifies whether to apply
170
+ # a clock skew correction and retry requests with skewed client clocks.
171
+ #
146
172
  # @option options [Boolean] :disable_host_prefix_injection (false)
147
173
  # Set to true to disable SDK automatically adding host prefix
148
174
  # to default service endpoint when available.
@@ -150,7 +176,7 @@ module Aws::Glacier
150
176
  # @option options [String] :endpoint
151
177
  # The client endpoint is normally constructed from the `:region`
152
178
  # option. You should only configure an `:endpoint` when connecting
153
- # to test endpoints. This should be avalid HTTP(S) URI.
179
+ # to test or custom endpoints. This should be a valid HTTP(S) URI.
154
180
  #
155
181
  # @option options [Integer] :endpoint_cache_max_entries (1000)
156
182
  # Used for the maximum size limit of the LRU cache storing endpoints data
@@ -165,7 +191,7 @@ module Aws::Glacier
165
191
  # requests fetching endpoints information. Defaults to 60 sec.
166
192
  #
167
193
  # @option options [Boolean] :endpoint_discovery (false)
168
- # When set to `true`, endpoint discovery will be enabled for operations when available. Defaults to `false`.
194
+ # When set to `true`, endpoint discovery will be enabled for operations when available.
169
195
  #
170
196
  # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
171
197
  # The log formatter.
@@ -177,15 +203,29 @@ module Aws::Glacier
177
203
  # The Logger instance to send log messages to. If this option
178
204
  # is not set, logging will be disabled.
179
205
  #
206
+ # @option options [Integer] :max_attempts (3)
207
+ # An integer representing the maximum number attempts that will be made for
208
+ # a single request, including the initial attempt. For example,
209
+ # setting this value to 5 will result in a request being retried up to
210
+ # 4 times. Used in `standard` and `adaptive` retry modes.
211
+ #
180
212
  # @option options [String] :profile ("default")
181
213
  # Used when loading credentials from the shared credentials file
182
214
  # at HOME/.aws/credentials. When not specified, 'default' is used.
183
215
  #
216
+ # @option options [Proc] :retry_backoff
217
+ # A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
218
+ # This option is only used in the `legacy` retry mode.
219
+ #
184
220
  # @option options [Float] :retry_base_delay (0.3)
185
- # The base delay in seconds used by the default backoff function.
221
+ # The base delay in seconds used by the default backoff function. This option
222
+ # is only used in the `legacy` retry mode.
186
223
  #
187
224
  # @option options [Symbol] :retry_jitter (:none)
188
- # 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.
225
+ # A delay randomiser function used by the default backoff function.
226
+ # Some predefined functions can be referenced by name - :none, :equal, :full,
227
+ # otherwise a Proc that takes and returns a number. This option is only used
228
+ # in the `legacy` retry mode.
189
229
  #
190
230
  # @see https://www.awsarchitectureblog.com/2015/03/backoff.html
191
231
  #
@@ -193,11 +233,30 @@ module Aws::Glacier
193
233
  # The maximum number of times to retry failed requests. Only
194
234
  # ~ 500 level server errors and certain ~ 400 level client errors
195
235
  # are retried. Generally, these are throttling errors, data
196
- # checksum errors, networking errors, timeout errors and auth
197
- # errors from expired credentials.
236
+ # checksum errors, networking errors, timeout errors, auth errors,
237
+ # endpoint discovery, and errors from expired credentials.
238
+ # This option is only used in the `legacy` retry mode.
198
239
  #
199
240
  # @option options [Integer] :retry_max_delay (0)
200
- # The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function.
241
+ # The maximum number of seconds to delay between retries (0 for no limit)
242
+ # used by the default backoff function. This option is only used in the
243
+ # `legacy` retry mode.
244
+ #
245
+ # @option options [String] :retry_mode ("legacy")
246
+ # Specifies which retry algorithm to use. Values are:
247
+ #
248
+ # * `legacy` - The pre-existing retry behavior. This is default value if
249
+ # no retry mode is provided.
250
+ #
251
+ # * `standard` - A standardized set of retry rules across the AWS SDKs.
252
+ # This includes support for retry quotas, which limit the number of
253
+ # unsuccessful retries a client can make.
254
+ #
255
+ # * `adaptive` - An experimental retry mode that includes all the
256
+ # functionality of `standard` mode along with automatic client side
257
+ # throttling. This is a provisional mode that may change behavior
258
+ # in the future.
259
+ #
201
260
  #
202
261
  # @option options [String] :secret_access_key
203
262
  #
@@ -220,16 +279,15 @@ module Aws::Glacier
220
279
  # requests through. Formatted like 'http://proxy.com:123'.
221
280
  #
222
281
  # @option options [Float] :http_open_timeout (15) The number of
223
- # seconds to wait when opening a HTTP session before rasing a
282
+ # seconds to wait when opening a HTTP session before raising a
224
283
  # `Timeout::Error`.
225
284
  #
226
285
  # @option options [Integer] :http_read_timeout (60) The default
227
286
  # number of seconds to wait for response data. This value can
228
- # safely be set
229
- # per-request on the session yeidled by {#session_for}.
287
+ # safely be set per-request on the session.
230
288
  #
231
289
  # @option options [Float] :http_idle_timeout (5) The number of
232
- # seconds a connection is allowed to sit idble before it is
290
+ # seconds a connection is allowed to sit idle before it is
233
291
  # considered stale. Stale connections are closed and removed
234
292
  # from the pool before making a request.
235
293
  #
@@ -238,7 +296,7 @@ module Aws::Glacier
238
296
  # request body. This option has no effect unless the request has
239
297
  # "Expect" header set to "100-continue". Defaults to `nil` which
240
298
  # disables this behaviour. This value can safely be set per
241
- # request on the session yeidled by {#session_for}.
299
+ # request on the session.
242
300
  #
243
301
  # @option options [Boolean] :http_wire_trace (false) When `true`,
244
302
  # HTTP debug output will be sent to the `:logger`.
@@ -1232,6 +1290,12 @@ module Aws::Glacier
1232
1290
  # resp.number_of_archives #=> Integer
1233
1291
  # resp.size_in_bytes #=> Integer
1234
1292
  #
1293
+ #
1294
+ # The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
1295
+ #
1296
+ # * vault_exists
1297
+ # * vault_not_exists
1298
+ #
1235
1299
  # @overload describe_vault(params = {})
1236
1300
  # @param [Hash] params ({})
1237
1301
  def describe_vault(params = {}, options = {})
@@ -2119,6 +2183,8 @@ module Aws::Glacier
2119
2183
  # * {Types::ListJobsOutput#job_list #job_list} => Array&lt;Types::GlacierJobDescription&gt;
2120
2184
  # * {Types::ListJobsOutput#marker #marker} => String
2121
2185
  #
2186
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2187
+ #
2122
2188
  #
2123
2189
  # @example Example: To list jobs for a vault
2124
2190
  #
@@ -2304,6 +2370,8 @@ module Aws::Glacier
2304
2370
  # * {Types::ListMultipartUploadsOutput#uploads_list #uploads_list} => Array&lt;Types::UploadListElement&gt;
2305
2371
  # * {Types::ListMultipartUploadsOutput#marker #marker} => String
2306
2372
  #
2373
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2374
+ #
2307
2375
  #
2308
2376
  # @example Example: To list all the in-progress multipart uploads for a vault
2309
2377
  #
@@ -2436,6 +2504,8 @@ module Aws::Glacier
2436
2504
  # * {Types::ListPartsOutput#parts #parts} => Array&lt;Types::PartListElement&gt;
2437
2505
  # * {Types::ListPartsOutput#marker #marker} => String
2438
2506
  #
2507
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2508
+ #
2439
2509
  #
2440
2510
  # @example Example: To list the parts of an archive that have been uploaded in a multipart upload
2441
2511
  #
@@ -2666,6 +2736,8 @@ module Aws::Glacier
2666
2736
  # * {Types::ListVaultsOutput#vault_list #vault_list} => Array&lt;Types::DescribeVaultOutput&gt;
2667
2737
  # * {Types::ListVaultsOutput#marker #marker} => String
2668
2738
  #
2739
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2740
+ #
2669
2741
  #
2670
2742
  # @example Example: To list all vaults owned by the calling user's account
2671
2743
  #
@@ -3291,7 +3363,7 @@ module Aws::Glacier
3291
3363
  params: params,
3292
3364
  config: config)
3293
3365
  context[:gem_name] = 'aws-sdk-glacier'
3294
- context[:gem_version] = '1.26.0'
3366
+ context[:gem_version] = '1.31.0'
3295
3367
  Seahorse::Client::Request.new(handlers, context)
3296
3368
  end
3297
3369
 
@@ -3357,10 +3429,10 @@ module Aws::Glacier
3357
3429
  # The following table lists the valid waiter names, the operations they call,
3358
3430
  # and the default `:delay` and `:max_attempts` values.
3359
3431
  #
3360
- # | waiter_name | params | :delay | :max_attempts |
3361
- # | ---------------- | ----------------- | -------- | ------------- |
3362
- # | vault_exists | {#describe_vault} | 3 | 15 |
3363
- # | vault_not_exists | {#describe_vault} | 3 | 15 |
3432
+ # | waiter_name | params | :delay | :max_attempts |
3433
+ # | ---------------- | ----------------------- | -------- | ------------- |
3434
+ # | vault_exists | {Client#describe_vault} | 3 | 15 |
3435
+ # | vault_not_exists | {Client#describe_vault} | 3 | 15 |
3364
3436
  #
3365
3437
  # @raise [Errors::FailureStateError] Raised when the waiter terminates
3366
3438
  # because the waiter has entered a state that it will not transition